matterful_attributes 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab5c548e45b69263103845a1625c849bd03ce30a
-  data.tar.gz: 20b3d880f2911cd653f321d5ea0747e0b0bccc64
+  metadata.gz: c917cbd924d618b2e066d3025690bad096794c24
+  data.tar.gz: 120c19f87f9b7446b71b1643db84dfd29a6d5727
 SHA512:
-  metadata.gz: 637c48c60453952b52c801563f1ac45926aac456d0d88b5c1bcb2dd1b30f5d4e31a596e93e09b5397ee593583f646462e065cbb84c419bee4a3897e4ab9188e8
-  data.tar.gz: e2095a1958f80956e6d3d8f608ece71c36dbb70e0b859def9de1bfdf5f05fc161c3c033573e3928e7cda57249dae86d9cf43db47be437f0b5892a8358cd65818
+  metadata.gz: 9f7287fd99ed3b119589f898690c9d900fa0d554ec435639c3b0f79038d1ff4e7dbdc8ac378b6456a5d077c950d008ae10b82928e254234b4f5f85aba22dcd0a
+  data.tar.gz: 205d9ca712d84a24862965543197a7f919bd3170bbbd027883dc96b01cbe4a32e810f5f559bf4b6dbe3de3d8fcac1aee74db1c9273c9ab6c3de5f0671361516f

data/lib/matterful_attributes/version.rb

@@ -1,3 +1,3 @@
 module MatterfulAttributes
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/matterful_attributes.rb

@@ -4,34 +4,44 @@ module MatterfulAttributes
   module ActiveRecord
     class Base
 
-      def matterful_attributes(options={})
-        options = options.dup
-        default     = options[:default].nil?        ? true : options[:default]
-        foreign_key = options[:foreign_key].nil?    ? true : options[:foreign_key]
-        sti         = options[:sti].nil?            ? true : options[:sti]
-        polymorphic = options[:polymorphic].nil?    ? true : options[:polymorphic]
-        # extra keys supplied as array of strings to ignore in comparison
-        attributes_to_ignore = options[:extra].nil? ? []   : options[:extra]
-
-        # Let's check for and add typical attributes that sti & polymorphic models have, override this by sti: false, polymorphic: false, :foreign_key: false
-        # by default when looking to compare two objects Customer.find(1).shipping_address.same_as? Address.new(city: 'Chicago')
-        # we really only want to see if any of the 'matterfule information changed', like address_line_1 or city.
-        # TODO: I guess I could do some smart checking on the model to see what kind of attributes it has. For now we'll just check for all that we want to remove
-        if default
-          attributes_to_ignore += ['id', 'created_at', 'updated_at']
-        end
-        if foreign_key
-          attributes_to_ignore += attributes.keys.keep_if{|k| k.match(/_id\z/) && !k.match(/able_id\z/) }  # This will skipp polymorphic style foreign keys
-        end
-        if sti
-          attributes_to_ignore += ['type']
-        end
-        if polymorphic
-          attributes_to_ignore += attributes.keys.keep_if{|k| k.match(/able_id\z/) }
-          attributes_to_ignore += attributes.keys.keep_if{|k| k.match(/able_type\z/) }
-        end
-        attributes.except(*attributes_to_ignore)
+    def matterful_attributes(options={})
+      options = options.dup
+      default     = options[:default].nil?        ? true : options[:default]
+      foreign_key = options[:foreign_key].nil?    ? true : options[:foreign_key]
+      sti         = options[:sti].nil?            ? true : options[:sti]
+      polymorphic = options[:polymorphic].nil?    ? true : options[:polymorphic]
+      # extra keys supplied as array of strings to ignore in comparison
+      attributes_to_ignore = options[:extra].nil? ? []   : options[:extra]
+
+      # Let's check for and add typical attributes that sti & polymorphic models have, override
+      # this by sti: false, polymorphic: false, :foreign_key: false
+      # by default when looking to compare two objects
+      # Customer.find(1).shipping_address.same_as? Address.new(city: 'Chicago')
+      # we really only want to see if any of the 'matterfule information changed', like address_line_1 or city.
+      # TODO: I guess I could do some smart checking on the model to see what kind of attributes it has.
+      # For now we'll just check for all that we want to remove
+      if default
+        attributes_to_ignore += ['id', 'created_at', 'updated_at']
       end
+      # By default we want foreign keys like caegory_id as they provide useful information about current record.
+      # Let's say you import a bunch of addresses
+      # and they ony matterful change was from shipping to billing category.
+      unless foreign_key
+        # This will skip polymorphic style foreign keys and only deal with belongs_to style keys
+        attributes_to_ignore += attributes.keys.keep_if{|k| k.match(/_id\z/) && !k.match(/able_id\z/) }
+      end
+      if sti
+        attributes_to_ignore += ['type']
+      end
+      # If you are looking at a model that is polymorphic than most like you want to update something
+      # like city for an Address , not addressable_id or addresable_type
+      # That is more likely type of information to be updated on external import.
+      if polymorphic
+        attributes_to_ignore += attributes.keys.keep_if{|k| k.match(/able_id\z/) }
+        attributes_to_ignore += attributes.keys.keep_if{|k| k.match(/able_type\z/) }
+      end
+      attributes.except(*attributes_to_ignore)
+    end
 
       def same_as?(source,options={})
         matterful_attributes(options) == source.matterful_attributes(options)
@@ -41,9 +51,11 @@ module MatterfulAttributes
         matterful_attributes(options).diff(source.matterful_attributes(options))
       end
 
+      # Update self if source object has new data but DO NOT save. Let's say you want to do
+      # futer processing on the new data. Validation, upcasing, concatination
       def matterful_update(source,options={})
-        # Update self if source object has new data but DO NOT save. Let's say you want to do futer processing on the new data. Validation, upcasing, concatination
-        if !(target_attributes = source.matterful_diff(self, options={})).empty?  # Pay attention to this! Reversing comparison to get expected results
+        # Pay attention to this! Reversing comparison to get expected results
+        if !(target_attributes = source.matterful_diff(self, options={})).empty?
           target_attributes.each_pair do |k,v|
             self[k] = v
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: matterful_attributes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nick Gorbikoff