Changeset 218

Timestamp:

10/11/07 09:49:28 (6 years ago)

Author:

ged

Message:

• Applied patch from Stou Sandalski to add an "ignore" option to the
  versioning ext.
  
• Minor improvements to the versioning ext.
  
• updated TODO
  

Location:

elixir/trunk

Files:

• TODO (modified) (2 diffs)
• elixir/ext/versioned.py (modified) (5 diffs)
• tests/test_versioning.py (modified) (4 diffs)

elixir/trunk/TODO

@@ -97 +97 @@
     Entity) defines a property will probably fail because of line 16.
 
-- Make the session context extension/assign_mapper optional
-
 - I'm not sure it would be worth it but we might want to put a section
   "contributing" on the website. In that case it might be a good idea to point
   to this file so that people know what can be done.
-
-- get rid of the assign_mapper stuff. This means we have to add all methods on
-  the entity base class.
-
-- integrate the association proxy plugin
-  see ML thread about this
 
 - add __revision__ (+ svn property) to all elixir files?
@@ -151 +143 @@
     cfr http://www.sqlalchemy.org/trac/ticket/502
 
+- better support from strange relation, or even other properties (like
+  column_property, and so on)
+  see http://www.sqlalchemy.org/trac/ticket/198
+
 - somehow support things like described at:
   http://spyced.blogspot.com/2007/01/why-sqlalchemy-impresses-me.html

elixir/trunk/elixir/ext/versioned.py

@@ -2 +2 @@
 A versioning plugin for Elixir.
 
-Entities that are marked as versioned will automatically have a history table
-created and a timestamp and version column added to their tables. In addition,
-versioned entities are provided with four new methods: revert, revert_to, and
-compare_with, get_as_of, and one new attribute: versions.  Entities with 
-compound primary keys are supported.
+Entities that are marked as versioned with the `acts_as_versioned` statement 
+will automatically have a history table created and a timestamp and version
+column added to their tables. In addition, versioned entities are provided 
+with four new methods: revert, revert_to, compare_with and get_as_of, and one 
+new attribute: versions.  Entities with compound primary keys are supported.
 
 The `versions` attribute will contain a list of previous versions of the
@@ -34 +34 @@
 decorate methods on the versioned entity that will be called following that 
 instance being reverted.
+
+The acts_as_versioned statement also accepts an optional `ignore` argument 
+that consists of a list of strings, specifying names of fields.  Changes in 
+those fields will not result in a version increment.
 
 Note that relationships that are stored in mapping tables will not be included
@@ -107 +111 @@
         # to ensure we really should save this version and update the version
         # data.
+        ignored = instance.__class__.__ignored_fields__
         for key in instance.c.keys():
-            if key in ['version', 'timestamp']:
+            if key in ignored:
                 continue
             if getattr(instance, key) != values[key]:
@@ -135 +140 @@
 class ActsAsVersioned(object):
         
-    def __init__(self, entity):
+    def __init__(self, entity, ignore=[]):
         entity._descriptor.add_mapper_extension(versioned_mapper_extension)
         
@@ -144 +149 @@
         entity._descriptor.add_field(timestampField)
         self.entity = entity
+        
+        # Changes in these fields 
+        entity.__ignored_fields__ = ignore
+        entity.__ignored_fields__.extend(['version', 'timestamp'])
     
     def after_table(self):

elixir/trunk/tests/test_versioning.py

@@ -20 +20 @@
         has_field('description', Unicode(512))
         has_field('releasedate', DateTime)
+        has_field('ignoreme', Integer, default=0)
         belongs_to('director', of_kind='Director', inverse='movies')
         has_and_belongs_to_many('actors', of_kind='Actor', inverse='movies', tablename='movie_casting')
         using_options(tablename='movies')
-        acts_as_versioned()
+        acts_as_versioned(ignore=['ignoreme'])
 
 
@@ -71 +72 @@
         objectstore.flush(); objectstore.clear()
     
+        # Edit the ignored field, this shouldn't change the version
+        monkeys = Movie.get_by(title='12 Monkeys')
+        monkeys.ignoreme = 1
+        objectstore.flush(); objectstore.clear()
+    
         time.sleep(1)
         after_update_two = datetime.now()
@@ -84 +90 @@
         assert oldest_version.version == 1
         assert oldest_version.description == 'draft description'
+        assert oldest_version.ignoreme == 0
     
         assert middle_version.version == 2
@@ -90 +97 @@
         assert latest_version.version == 3
         assert latest_version.description == 'description three'
+        assert latest_version.ignoreme == 1
     
         differences = latest_version.compare_with(oldest_version)