vidibus-versioning 0.3.0 → 0.3.3

data/README.md

@@ -7,12 +7,12 @@ This gem is part of [Vidibus](http://vidibus.org), an open source toolset for bu
 
 ## Installation
 
-Add `gem "vidibus-versioning"` to your Gemfile. Then call `bundle install` on your console.
+Add `gem 'vidibus-versioning'` to your Gemfile. Then call `bundle install` on your console.
 
 
 ## Usage
 
-To apply versioning to your model is easy. An example:
+Applying versioning to your model is easy. An example:
 
 ```ruby
 class Article
@@ -20,17 +20,17 @@ class Article
   include Vidibus::Uuid::Mongoid
   include Vidibus::Versioning::Mongoid # this is mandatory
 
-  field :title, :type => String
-  field :text, :type => String
+  field :title, type: String
+  field :text, type: String
 
-  versioned :title, :text, :editing_time => 300 # this is optional
+  versioned :title, :text, editing_time: 300 # this is optional
 end
 ```
 
 ### Versioned attributes
 
 Including the versioning engine by adding `include Vidibus::Versioning::Mongoid` will set all fields of your model as
-versioned ones, except those contained in `Article.unversioned_attributes`, which are `_id`, `_type`, `uuid`,
+versioned ones, except those contained in `<Class>.unversioned_attributes`, which are `_id`, `_type`, `uuid`,
 `updated_at`, `created_at`, and `version_number`.
 
 An optional `versioned` call lets you specify the versioned attributes precisely by providing a list. For example, to
@@ -39,14 +39,14 @@ set the title as only attribute to be versioned, call `versioned :title`.
 
 ### Combined versioning
 
-`versioned` also takes options to tweak versioning behaviour. By calling `versioned :editing_time => 300` you set a
+`versioned` also takes options to tweak versioning behaviour. By calling `versioned editing_time: 300` you set a
 timespan for the version to accept changes so all changes within 300 seconds will be treated as one version.
 That behaviour is especially useful if your model's UI allows changing attributes separately, like in-place editing.
 
 
 ### Migrating
 
-The basic methods for migrating a versioned object - an article in this case - are:
+The basic methods for migrating a versioned object – an article in this case – are:
 
 ```ruby
 article.migrate!(32) # migrates to version 32
@@ -83,7 +83,7 @@ article.version?(3) # returns false if version 3 does not exist
 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
@@ -93,10 +93,10 @@ that can be scheduled by [Vidibus::VersionScheduler](https://github.com/vidibus/
 A workflow example:
 
 ```ruby
-article = Article.create(:title => "Old shit")
+article = Article.create(title: 'Old stuff')
 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.title = 'New stuff'      # set the new title
 future_article.save                     # save the version
 ```
 
@@ -120,4 +120,4 @@ article.version_object            # => nil
 
 ## Copyright
 
-Copyright (c) 2011-2013 Andre Pankratz. See LICENSE for details.
+Copyright (c) 2011-2015 Andre Pankratz. See LICENSE for details.

data/lib/vidibus/versioning/_version.rb

@@ -1,5 +1,5 @@
 module Vidibus
   module Versioning
-    VERSION = '0.3.0'
+    VERSION = '0.3.3'
   end
 end

data/lib/vidibus/versioning/mongoid.rb

@@ -14,13 +14,15 @@ module Vidibus
 
         after_initialize :original_attributes
         after_initialize :set_version_updated_at, :unless => :version_updated_at
-        before_update :reset_version_cache
+        before_save :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 version_updated_at]
         self.versioning_options = {}
 
+        define_model_callbacks :version_save
+
         # Returns the attributes that should be versioned.
         # If no versioned attributes have been defined on class level,
         # all attributes will be returned except the unversioned ones.
@@ -52,8 +54,10 @@ module Vidibus
       #   48         returns version 48 of self
       #
       def version(*args)
-        self.class.find(_id).tap do |copy|
-          copy.apply_version!(*args)
+        ::Mongoid.unit_of_work(disable: :current) do
+          self.class.find(_id).tap do |copy|
+            copy.apply_version!(*args)
+          end
         end
       end
 
@@ -76,6 +80,20 @@ module Vidibus
         end
       end
 
+      # Returns version at given time.
+      #
+      def version_at(input)
+        input = Time.parse(input) unless input.is_a?(Time)
+        match = versions.
+          where(:created_at.lte => input).
+          desc(:created_at).first
+        if match
+          version(match.number)
+        else
+          raise VersionNotFoundError.new("no version at #{input}")
+        end
+      end
+
       # Applies attributes of wanted version on self.
       # Stores current attributes in a new version.
       def migrate!(number = nil)
@@ -91,6 +109,10 @@ module Vidibus
 
         set_original_version_obj
 
+        if version_object.future?
+          version_object.update_attributes(:created_at => Time.now)
+        end
+
         self.attributes = version_attributes
         self.version_number = version_cache.wanted_version_number
         save!
@@ -110,9 +132,16 @@ module Vidibus
 
       # Saves the record and handles version persistence.
       def save(*args)
-        return false if invalid?
-        saved = persist_version
-        (saved == nil) ? super(*args) : saved
+        saved = false
+        if valid?
+          run_callbacks(:version_save) do
+            saved = persist_version
+            if saved == nil
+              saved = super(*args)
+            end
+          end
+        end
+        saved
       end
 
       # Raises a validation error if saving fails.
@@ -144,7 +173,30 @@ module Vidibus
 
       # Returns true if version requested is a new one.
       def new_version?
-        version_obj and version_obj.new_record?
+        !!(version_obj && version_obj.new_record?)
+      end
+
+      # Returns true if versioned attributes have changed.
+      def versioned_attributes_changed?
+        versioned_attributes != original_attributes
+      end
+
+      # Returns changes to unversioned attributes.
+      # "Unversioned attributes" are attributes that are not versioned and
+      # should be applied to all versions, but are not included in
+      # #unversioned_attributes either.
+      def unversioned_changes
+        changes.except(versioned_attributes.keys + unversioned_attributes)
+      end
+
+      # Returns true if unversioned attributes have changed.
+      def unversioned_attributes_changed?
+        unversioned_changes.any?
+      end
+
+      # Returns version number of original (unversioned) instance.
+      def original_version_number
+        version_cache.original_version_number || version_number
       end
 
       protected
@@ -161,7 +213,7 @@ module Vidibus
         unless version_obj
           raise VersionNotFoundError.new("version #{version_cache.wanted_version_number} does not exist")
         end
-
+        version_cache.original_version_number ||= version_number
         self.attributes = version_attributes
         self.version_number = version_cache.wanted_version_number
         if time = version_obj.created_at
@@ -177,11 +229,6 @@ module Vidibus
         @original_attributes ||= versioned_attributes
       end
 
-      # Returns true if versioned attributes were changed.
-      def versioned_attributes_changed?
-        versioned_attributes != original_attributes
-      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
@@ -287,6 +334,7 @@ module Vidibus
       def version_cache
         @version_cache ||= Struct.new(
           :wanted_version_number,
+          :original_version_number,
           :existing_version_wanted,
           :wanted_attributes,
           :new_version_number,
@@ -305,7 +353,14 @@ module Vidibus
       #
       def persist_version
         return if new_record?
-        return unless versioned_attributes_changed?
+        if !versioned_attributes_changed?
+          # Reset version number if new version won't be persisted.
+          if version_cache.new_version_number
+            self.version_number = version_number_was
+          end
+          return
+        end
+
         if version_cache.original_version_obj
           version_cache.original_version_obj.save!
         elsif version_cache.wanted_version_number
@@ -315,7 +370,13 @@ module Vidibus
               :created_at => updated_at
             })
           end
-          return saved unless version_cache.self_version
+          unless version_cache.self_version
+            if saved == false
+              return false
+            elsif !unversioned_attributes_changed?
+              return true
+            end
+          end
         elsif version_obj
           version_obj.update_attributes!({
             :versioned_attributes => original_attributes

data/lib/vidibus/versioning/version.rb

@@ -21,11 +21,11 @@ module Vidibus
       scope :timeline, desc(:created_at)
 
       def past?
-        created_at && created_at < Time.now
+        !!(created_at && created_at < Time.now)
       end
 
       def future?
-        created_at && created_at >= Time.now
+        !!(created_at && created_at >= Time.now)
       end
 
       protected

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vidibus-versioning
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -185,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2214928841731694107
+      hash: -472131419390018978
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: