vidibus-versioning 0.1.0 → 0.1.1

data/README.md

@@ -60,32 +60,36 @@ article.redo!        # restores next version
 There is also a method `version` that loads an exisiting version of the record or instantiates a new one:
 
 ```ruby
-article.version(3)            # returns version 3 of the article
-article.version(:previous)    # returns the previous version of the article
-article.version(:next)        # returns the next version of the article
-article.version(:new)         # returns a new version of the article
+article.version(3)         # returns version 3 of the article
+article.version(:previous) # returns the previous version of the article
+article.version(:next)     # returns the next version of the article
+article.version(:new)      # returns a new version of the article
 ```
 
 To apply a version on the current article itself, call `version` with a bang!:
 
 ```ruby
-  article.version!(3) # applies version 3 to the article and returns nil
+article.version!(3) # applies version 3 to the article and returns nil
 ```
 
-It is even possible to apply versioned attributes directly by adding it to the `version` call:
+It is even possible to apply versioned attributes directly by adding them to the `version` call:
 
 ```ruby
-  article.version(3, :title => "Wicked!") # returns version 3 with a new title applied
+article.version(3, :title => "Wicked!") # returns version 3 with a new title applied
 ```
 
 You may treat the article object with an applied version like the article itself. All changes will
-be applied to the loaded version instead of the current instance. An example:
+be applied to the loaded version instead of the current instance. This is useful for creating future versions
+that can be scheduled by [Vidibus::VersionScheduler](https://github.com/vidibus/vidibus-version_scheduler).
+
+A workflow example:
 
 ```ruby
-article.version!(3)         # applies version 3
-article.title = "Brand new" # sets a new title
-article.save                # saves version 3 of the article
-article.reload              # loads the current version of the article
+article = Article.create(:title => "Old shit")
+future_article = article.version(:new)  # initialize a new version
+future_article.updated_at = 1.day.since # set a date in the future
+future_article.title = "New shit"       # set the new title
+future_article.save                     # save the version
 ```
 
 

data/lib/vidibus/versioning/_version.rb

@@ -1,5 +1,5 @@
 module Vidibus
   module Versioning
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/vidibus/versioning/mongoid.rb

@@ -10,13 +10,14 @@ module Vidibus
         has_many :versions, :as => :versioned, :class_name => "Vidibus::Versioning::Version", :dependent => :destroy
 
         field :version_number, :type => Integer, :default => 1
+        field :version_updated_at, :type => Time
 
         after_initialize :original_attributes
         before_update :reset_version_cache
 
         mattr_accessor :versioned_attributes, :unversioned_attributes, :versioning_options
         self.versioned_attributes = []
-        self.unversioned_attributes = %w[_id _type uuid updated_at created_at version_number]
+        self.unversioned_attributes = %w[_id _type uuid updated_at created_at version_number version_updated_at]
         self.versioning_options = {}
 
         # Returns the attributes that should be versioned.
@@ -40,7 +41,6 @@ module Vidibus
         #
         def versioned(*args)
           options = args.extract_options!
-
           self.versioned_attributes = args.map {|a| a.to_s} if args.any?
           self.versioning_options = options if options.any?
         end
@@ -130,6 +130,11 @@ module Vidibus
         version_obj and version_obj.new_record?
       end
 
+      # Returns the time when versioned attributes have been updated.
+      def version_updated_at
+        read_attribute(:version_updated_at) || updated_at
+      end
+
       protected
 
       # Applies version on self. Returns nil
@@ -141,7 +146,10 @@ module Vidibus
 
         self.attributes = version_attributes
         self.version_number = version_cache.wanted_version_number
-        self.updated_at = version_obj.created_at if version_obj.created_at
+        if time = version_obj.created_at
+          self.updated_at = time
+          self.version_updated_at = time
+        end
         nil
       end
 
@@ -157,10 +165,15 @@ module Vidibus
       end
 
       # Returns original attributes with attributes of version object and wanted attributes merged in.
+      # TODO: Only return attributes that are present on the object. They may have changed.
       def version_attributes
         # TODO: Setting the following line will cause DelayedJob to loop endlessly. The same should happen if an embedded document is defined as versioned_attribute!
         # original_attributes.merge(version_obj.versioned_attributes).merge(version_cache.wanted_attributes.stringify_keys!)
-        version_obj.versioned_attributes.merge(version_cache.wanted_attributes.stringify_keys!)
+
+        Hash[*self.class.fields.keys.zip([]).flatten].             # ensure nil fields are included as well
+          merge(version_obj.versioned_attributes).                 # add version's attributes
+          merge(version_cache.wanted_attributes.stringify_keys!).  # add options provided with #version call
+          except(self.class.unversioned_attributes)                # remove unversioned attributes; they may have changed
       end
 
       # Sets instance variables used for versioning.
@@ -211,7 +224,7 @@ module Vidibus
             obj
           else
             editing_time = self.class.versioning_options[:editing_time]
-            if !editing_time or updated_at <= (Time.now-editing_time.to_i) or updated_at > Time.now # allow future versions
+            if !editing_time or version_updated_at <= (Time.now-editing_time.to_i) or version_updated_at > Time.now # allow future versions
               versions.build(:created_at => updated_at_was)
             end
           end
@@ -261,6 +274,7 @@ module Vidibus
         elsif version_obj
           version_obj.update_attributes!(:versioned_attributes => original_attributes)
           self.version_number = version_obj.number + 1
+          self.version_updated_at = Time.now
         end
         nil
       end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vidibus-versioning
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Andre Pankratz
@@ -21,9 +22,11 @@ dependencies:
   name: mongoid
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 2
         version: "2"
@@ -33,9 +36,11 @@ dependencies:
   name: vidibus-core_extensions
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -45,9 +50,11 @@ dependencies:
   name: vidibus-uuid
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -57,9 +64,11 @@ dependencies:
   name: bundler
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 0
@@ -71,9 +80,11 @@ dependencies:
   name: rake
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -83,9 +94,11 @@ dependencies:
   name: rdoc
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -95,9 +108,11 @@ dependencies:
   name: rcov
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -107,9 +122,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 2
         version: "2"
@@ -119,9 +136,11 @@ dependencies:
   name: rr
   prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -155,16 +174,20 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
       - 1
       - 3
@@ -173,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: vidibus-versioning
-rubygems_version: 1.3.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Advanced versioning for Mongoid models