active_metadata 0.2.3 → 0.2.4

data/lib/active_metadata/base.rb

@@ -19,7 +19,10 @@ module ActiveMetadata
     module Config
 
       def acts_as_metadata *args
+        before_update :manage_concurrency
         after_save :save_history
+        attr_accessor :conflicts
+        attr_accessor :active_metadata_timestamp
 
         class_variable_set("@@metadata_id_from", args.empty? ? nil : args[0][:metadata_id_from])
 
@@ -34,6 +37,11 @@ module ActiveMetadata
 
       include ActiveMetadata::Helpers
 
+      def attributes=(attributes)
+        attributes.delete(:active_metadata_timestamp) unless attributes[:active_metadata_timestamp].nil?
+        super
+      end
+
       def self.included(klass)
         [:notes, :attachments, :history].each do |item|
           klass.send(:define_method, "#{item.to_s}_cache_key".to_sym) do |field|
@@ -43,13 +51,11 @@ module ActiveMetadata
       end
 
       def metadata_id
-        metadata_id_from = self.class.class_variable_get("@@metadata_id_from")
-        return self.id if metadata_id_from.nil?
-        receiver = self
-        metadata_id_from.each do |item|
-          receiver = receiver.send item
-        end
-        receiver.id
+        metadata_root.id
+      end
+
+      def active_metadata_timestamp
+        metadata_root.active_metadata_timestamp || nil
       end
 
       def current_user_id
@@ -60,23 +66,45 @@ module ActiveMetadata
         end
       end
 
-      # Resolve concurrency using the passed timestamps and the active_metadata histories
-      # To be called from controller before updating the model. Params that contains a conflict are removed from the params list.
-      # Returns 2 values containing the the deleted params with the related history:
-      # [{:key => [passed_value,history]}]
+      def metadata_root
+        metadata_id_from = self.class.class_variable_get("@@metadata_id_from")
+        return self if metadata_id_from.nil?
+        receiver = self
+        metadata_id_from.each do |item|
+          receiver = receiver.send item
+        end
+        receiver
+      end
+
+      # Resolve concurrency using the provided timestamps and the active_metadata histories.
+      # Conflicts are stored into @conflicts instance variable
+      #
+      # Timestamp used for versioning can be passed both as :
+      # ====
+      # * @object.active_metadata_timestamp = ....
+      # * @object.update_attributes :active_metadata_timestamp => ...
       #
-      # first result is the WARNINGS array: conflict appears on a field not touched by the user that submit the value
-      # first result is the FATALS Array : if the conflict appears on a field modified by the user that submit the value
-      # an empty array is returned by default
-      def manage_concurrency(params, timestamp)
-        warnings = []
-        fatals = []
+      # Check is skipped if no timestamp exists. A check is made also for parents defined via acts_as_metadata method
+      #
+      # Conflicts
+      # ====
+      # * @conflicts[:warnings] contains any conflict that "apply cleanly" or where the submit value has not been modified by the user that is saving
+      #  the data
+      #
+      # * @conflicts[:fatals] contains any conflict that "do not apply cleanly" or where the passed value does not match the last history value and was modified
+      #   by the user that is submittig the data
+      #
+      def manage_concurrency
+        return if active_metadata_timestamp.nil? #if no timestamp no way to check concurrency so just skip
+
+        self.conflicts = { :warnings => [], :fatals => [] }
 
         # scan params
-        params.each do |key, val|
+        self.attributes.each do |key, val|
           # ensure the query order
           histories = history_for key.to_sym, "created_at DESC"
           latest_history = histories.first
+          timestamp = self.active_metadata_timestamp
 
           # if form timestamp is subsequent the history last change go on
           # if history does not exists yet go on
@@ -84,8 +112,11 @@ module ActiveMetadata
 
           #if the timestamp is previous of the last history change
           if timestamp < latest_history.created_at
-            #remove the key from the update process
-            params.delete key
+
+            begin
+              self[key.to_sym] = self.changes[key][0]
+            rescue
+            end  # there is a conflict so ensure the actual value if any change exists
 
             # We have a conflict.
             # Check if the actual submission has been modified
@@ -100,9 +131,9 @@ module ActiveMetadata
               end
 
               if [h.value, b_val].include? val
-                warnings << {key => [val, h]}
+                self.conflicts[:warnings] << {key.to_sym => [val, h]}
               else
-                fatals << {key => [val, h]}
+                self.conflicts[:fatals] << {key.to_sym => [val, h]}
               end
             end
 
@@ -110,7 +141,6 @@ module ActiveMetadata
 
         end
 
-        return warnings, fatals
       end
 
     end # InstanceMethods

data/lib/active_metadata/version.rb

@@ -1,3 +1,3 @@
 module ActiveMetadata
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/lib/model/active_record/watcher.rb

@@ -1,4 +1,4 @@
 class Watcher < ActiveRecord::Base  
   attr_reader :notifier
-    
+
 end

data/spec/concurrency_spec.rb

@@ -7,17 +7,29 @@ describe "Manage Concurrency" do
     @document.reload
   end
 
+  it "should assign the active_metadata_timestamp via mass assignment" do
+    ts = Time.now
+    params = {:name => "nuovo nome", :active_metadata_timestamp => ts}
+    @document.update_attributes params
+    @document.active_metadata_timestamp.should eq ts
+  end
+
+  it "should skip if no timestamp is provided" do
+    @document.update_attributes :name => "nuovo nome"
+    @document.conflicts.should be_nil
+  end
+
   describe "when a field is modified and the form ts is subsequent of the history ts" do
 
     it "should save the new value and history must be updated with the latest change" do
         sleep 0.2.seconds
 
-        params = {:name => "nuovo nome"}
-        warn,fatal = @document.manage_concurrency params,Time.now
+        params = {:name => "nuovo nome", :active_metadata_timestamp => Time.now}
         @document.update_attributes(params)
 
-        warn.should be_empty
-        fatal.should be_empty
+        @document.conflicts[:warnings].should be_empty
+        @document.conflicts[:fatals].should be_empty
+
         hs = @document.history_for(:name)
         hs.count.should eq 2
         hs.first.value.should eq "nuovo nome"
@@ -30,21 +42,20 @@ describe "Manage Concurrency" do
 
     it "should not change the model value and the history if the newest history value is equal to the submitted once, param should be retuned as warning" do
       form_timestamp = Time.now
-      params = {:name => "nuovo nome"}
 
       #someone change the field value
       sleep 0.2.seconds
-      warn,fatal = @document.manage_concurrency params,Time.now
-      @document.update_attributes(params)
+      @document.update_attributes({:name => "nuovo nome", :active_metadata_timestamp => Time.now})
 
       # user submit pushing the same value that was already saved by another user
       sleep 0.2.seconds
-      warn,fatal = @document.manage_concurrency params,form_timestamp
-      @document.update_attributes(params)
+      @document.update_attributes({:name => "nuovo nome", :active_metadata_timestamp => form_timestamp})
+
+      warnings = @document.conflicts[:warnings]
+      warnings.size.should eq 1
+      warnings[0][:name][0].should eq "nuovo nome"
 
-      warn.size.should eq 1
-      warn[0][:name][0].should eq "nuovo nome"
-      fatal.should be_empty
+      @document.conflicts[:fatals].should be_empty
       hs = @document.history_for(:name)
       #last change shoudl not be recorded in history
       hs.count.should eq 2
@@ -54,25 +65,25 @@ describe "Manage Concurrency" do
     end
 
     it "should reject the change if the history newest value is different from the submitted once, param should be returned as fatal" do
+      #fixtures
       form_timestamp = Time.now
       params = {:name => "nuovo nome"}
 
       #someone change the field value
       sleep 0.2.seconds
-      warn,fatal = @document.manage_concurrency params,Time.now
       @document.update_attributes(params)
 
       # user submit a new value
       sleep 0.2.seconds
-      different_params = {:name => "altro nome"}
-      warn,fatal = @document.manage_concurrency different_params,form_timestamp
+      different_params = {:name => "altro nome", :active_metadata_timestamp => form_timestamp}
       @document.update_attributes(different_params)
 
-      fatal.size.should eq 1
-      fatal[0][:name][0].should eq "altro nome"
-      warn.should be_empty
+      #assetions
+      fatals = @document.conflicts[:fatals]
+      fatals.size.should eq 1
+      fatals[0][:name][0].should eq "altro nome"
+      @document.conflicts[:warnings].should be_empty
       hs = @document.history_for(:name)
-      #last change shoudl not be recorded in history
       hs.count.should eq 2
       hs.first.value.should eq "nuovo nome"
       Document.last.name.should eq "nuovo nome"
@@ -85,19 +96,19 @@ describe "Manage Concurrency" do
 
       #someone change the field value
       sleep 0.2.seconds
-      warn,fatal = @document.manage_concurrency params,Time.now
-      @document.update_attributes(params)
+      @document.update_attributes params
 
       # user submit a new value
       sleep 0.2.seconds
-      different_params = {:name => "altro nome", :keep_alive => false}
-      warn,fatal = @document.manage_concurrency different_params,form_timestamp
+      different_params = {:name => "altro nome", :keep_alive => false, :active_metadata_timestamp => form_timestamp}
       @document.update_attributes(different_params)
 
-      fatal.size.should eq 1
-      fatal[0][:name][0].should eq "altro nome"
-      warn.size.should eq 1
-      warn[0][:keep_alive][0].should eq false
+      fatals = @document.conflicts[:fatals]
+      fatals.size.should eq 1
+      fatals[0][:name][0].should eq "altro nome"
+      warnings = @document.conflicts[:warnings]
+      warnings.size.should eq 1
+      warnings[0][:keep_alive][0].should eq false
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_metadata
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2011-10-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &2168675080 !ruby/object:Gem::Requirement
+  requirement: &2169354520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168675080
+  version_requirements: *2169354520
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2168674400 !ruby/object:Gem::Requirement
+  requirement: &2169353840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168674400
+  version_requirements: *2169353840
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &2168673660 !ruby/object:Gem::Requirement
+  requirement: &2169353240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168673660
+  version_requirements: *2169353240
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &2168672720 !ruby/object:Gem::Requirement
+  requirement: &2169352820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168672720
+  version_requirements: *2169352820
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2168672140 !ruby/object:Gem::Requirement
+  requirement: &2169352320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168672140
+  version_requirements: *2169352320
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2168671320 !ruby/object:Gem::Requirement
+  requirement: &2169351620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -77,10 +77,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2168671320
+  version_requirements: *2169351620
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2168670740 !ruby/object:Gem::Requirement
+  requirement: &2169350680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -88,10 +88,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2168670740
+  version_requirements: *2169350680
 - !ruby/object:Gem::Dependency
   name: paperclip
-  requirement: &2168670280 !ruby/object:Gem::Requirement
+  requirement: &2169350180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168670280
+  version_requirements: *2169350180
 - !ruby/object:Gem::Dependency
   name: to_xls
-  requirement: &2168669560 !ruby/object:Gem::Requirement
+  requirement: &2169349300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,7 +110,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168669560
+  version_requirements: *2169349300
 description: First implementation will write metadata on mongodb
 email:
 - acampolonghi@gmail.com
@@ -228,3 +228,4 @@ test_files:
 - spec/support/section.rb
 - spec/support/user.rb
 - spec/support/watcher_notifier.rb
+has_rdoc: