acts_as_elibri_product 0.1.6 → 0.2.0

data/README.md

@@ -36,6 +36,13 @@ Example:
 } 
 
 Important thing is that lambda need to take exactly one argument, and need to return final value of attribute to write into database.
+Also very important thing is that lambdas are now supported only on first level of vector (not in embedded hashes).
+
+If you want to use lambda, but don't write anything to database, you should use nil as first attribute in array. For example:
+```ruby
+{
+ :title => [nil, lambda {|x| Logger.info("changing title"); return "#{x}_test"}]
+}
 
 When dealing with embedded objects and relations, you should use embedded hashes:  
 
@@ -104,4 +111,48 @@ example vector:
    :name => :name
  }
 }
+```
+
+Also if you want to check for some particular changes in object - you can use policy chain.
+
+```
+policy_chain << PolicyObject
+policy_chain << lambda
+```
+
+PolicyObject must implement class method call, which take four arguments:
+
+* object is symbol of object that inside which attribute is changing - it should be our name, not elibri one, for example on main level it would :product, inside contributors it will be :contributors etc.
+
+* attribute is symbol of attribute that will change - it should be our name, not elibri one
+
+* pre - value of attribute before potential update
+
+* post - value of attribute after potential update
+
+Also policy must return one of two values - true (if allow of changing an attribute) or false (if attribute should remain unchanged). You can implement notification etc inside Policy, when attribute is discarded - it's up to you.
+
+example of Policy (stub):
+```ruby
+module Policy #module is optional - however it is good practice to keep all policies in Policy module, and in subdirectory inside lib
+  class Stub
+  
+    def self.call(object, attribute, pre, post)
+      ### Add policy body here
+      return true
+    end
+  
+  end
+end
+
+example of adding policy lambda:
+```ruby
+policy_chain << lambda do |object, attribute, pre, post|
+   if object == :product
+     if attribute == :price_amount
+       return false unless pre == post #won't allow change of product price
+     end
+   end
+   return true
+ end
 ```

data/lib/acts_as_elibri_product/version.rb

@@ -1,3 +1,3 @@
 module ActsAsElibriProduct
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/lib/acts_as_elibri_product.rb

@@ -19,6 +19,20 @@ module ActsAsElibriProduct
       @@traverse_vector = traverse_vector
     end
     
+    @@policy_chain = []
+    
+    def policy_chain
+      @@policy_chain
+      ### policy musi przyjmowac cztery argumenty -> nazwa obiektu (jesli main level to product po prostu), nazwa atrybutu, wartosc przed, wartosc po
+    end
+    
+    def validate_policy_chain
+      @@policy_chain.each do |policy|
+        raise "Policy #{policy} don't respond to call method" unless policy.respond_to? :call
+      end
+      return true
+    end
+    
     def create_from_elibri(xml_string)
       product = Elibri::ONIX::Release_3_0::ONIXMessage.from_xml(xml_string).products.first
       db_product = self.new
@@ -29,7 +43,11 @@ module ActsAsElibriProduct
           object = db_product.send(v.keys.first)
           ActsAsElibriProduct.set_objects_from_array(k, v.keys.first, v.values.first, product.send(k), db_product) if product.send(k)
         elsif v.is_a?(Array)
-          db_product.send(:write_attribute, v[0], v[1].call(product.send(k)))
+          if v[0].nil?
+            v[1].call(product.send(k))
+          else
+            db_product.send(:write_attribute, v[0], v[1].call(product.send(k)))
+          end
         end
       end
       db_product.old_xml = xml_string
@@ -76,7 +94,17 @@ module ActsAsElibriProduct
     details = elibri_xml_versions.diff
     details[:changes].each do |change|
       if change.is_a?(Symbol) && traverse_vector[change]
-        write_attribute(traverse_vector[change], product_updated.send(change))
+        if traverse_vector[change].is_a?(Array)
+          next unless check_policy_chain(self, :product, traverse_vector[change], self.send(traverse_vector[change][0]), product_updated.send(change))
+          if traverse_vector[change][0].nil?
+            traverse_vector[change][1].call(product_updated.send(change))
+          else
+            write_attribute(traverse_vector[change][0], traverse_vector[change][1].call(product_updated.send(change)))
+          end
+        else
+          next unless check_policy_chain(self, :product, traverse_vector[change], self.send(traverse_vector[change]), product_updated.send(change))
+          write_attribute(traverse_vector[change], product_updated.send(change))
+        end
       elsif change.is_a?(Hash) && traverse_vector[change.keys.first]        
         change.values.first.each do |elibri_attrib|
           if elibri_attrib.is_a? Hash
@@ -85,13 +113,24 @@ module ActsAsElibriProduct
               if db_attrib #found in mapping
                 object = self.send(traverse_vector[change.keys.first].keys.first).find { |x| x.import_id == k }
                 elibri_object = product_updated.send(change.keys.first).find { |x| x.id == k }
-                object.send(:write_attribute, db_attrib, elibri_object.send(v))
+                if v.is_a?(Array)
+                  next unless check_policy_chain(self, traverse_vector[change.keys.first].keys.first, db_attrib, object.send(db_attrib), elibri_object.send(v[0]))
+                  if v[0].nil?
+                    v[1].call(elibri_object.send(v[0]))
+                  else
+                    object.send(:write_attribute, db_attrib, v[1].call(elibri_object.send(v[0])))
+                  end
+                else
+                  next unless check_policy_chain(self, traverse_vector[change.keys.first].keys.first, db_attrib, object.send(db_attrib), elibri_object.send(v))
+                  object.send(:write_attribute, db_attrib, elibri_object.send(v))
+                end
               end
             end
           else
             db_attrib = traverse_vector[change.keys.first].values.first[elibri_attrib]
             object = self.send(traverse_vector[change.keys.first].keys.first)
             elibri_object = product_updated.send(change.keys.first)
+            next unless check_policy_chain(self, traverse_vector[change.keys.first].keys.first, db_attrib, object.send(db_attrib), elibri_object.send(elibri_attrib))            
             object.send(:write_attribute, db_attrib, elibri_object.send(elibri_attrib))
           end
         end
@@ -126,6 +165,10 @@ end
     ActsAsElibriProduct::ClassMethods.traverse_vector
   end
   
+  def check_policy_chain(product, object, attribute, pre, post)
+    product.class.policy_chain.all? { |policy| policy.call(object, attribute, pre, post) }
+  end
+  
   def self.set_objects_from_array(elibri_object_name, db_object_name, object_traverse_vector, elibri_objects, db_product)
     if elibri_objects.is_a?(Array)
       elibri_objects.each do |elibri_object|

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 6
-  version: 0.1.6
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Piotr Szmielew
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-09 00:00:00 Z
+date: 2012-05-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -46,7 +46,7 @@ dependencies:
   prerelease: false
   requirement: *id002
 - !ruby/object:Gem::Dependency 
-  name: elibri_onix_mocks
+  name: elibri_onix_generator
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -60,7 +60,7 @@ dependencies:
   prerelease: false
   requirement: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: elibri_onix_mocks
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -74,7 +74,7 @@ dependencies:
   prerelease: false
   requirement: *id004
 - !ruby/object:Gem::Dependency 
-  name: rspec-rails
+  name: rspec
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -88,7 +88,7 @@ dependencies:
   prerelease: false
   requirement: *id005
 - !ruby/object:Gem::Dependency 
-  name: sqlite3
+  name: rspec-rails
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -101,6 +101,20 @@ dependencies:
   type: :development
   prerelease: false
   requirement: *id006
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  requirement: *id007
 description: Gem designed to allow easy addition of eLibri based product to your application. Currently only tested under REE.
 email: 
 - p.szmielew@ava.waw.pl