tree_diff 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36d4d811a88254040e9ccd3693b1e4c5e667cdf83c5cfa14b3ec1fa94a52f23f
-  data.tar.gz: 4e6ab356040d07e5db26f5f828456e4b52196e4202e39c32dfb3c17f8d23ef9d
+  metadata.gz: 275453852f6c76b905b0f39363e622763473bbaf81ad6ff527d49a0a03711a9d
+  data.tar.gz: daf3a58eaf867ec2c308747b04bffec7befe7df8336ca9f49b4d49e472ad3caa
 SHA512:
-  metadata.gz: 6c067170e623ee334dea672c92f28ec2dc8692facc9d8a139353b541fc7ce67e0faef09dea321ea49465b31ff3b086f7e0f33c1970b43b6d7a8632fab1493ad4
-  data.tar.gz: 72c485c7563360466b9f82210c2ba7505a90d663a7569877597e9813c3ffdfeddca95e3cd017520d7b0319533f3895cda76bd02d938338a23fd2942c81fee7e9
+  metadata.gz: feacaeada2e4d4b0298bace2d3441835f0cac924bec321a50c228edcd4e746ff0fed1d50ee59eef091864e2619915395cc5c05e04ea6fc3c0be91aa362e730ac
+  data.tar.gz: 0dc668bad79c7a76b2fab3d19da7fbf532b384188e0023b55f594f19bcdf9f14d000b5179583fc4bc381717f0168b316246b78b81cdc753c824ec3a5b0869c17

data/README.md

@@ -1,6 +1,8 @@
 # Tree Diff
 
-Compare large object trees. Like a generic and standalone ActiveModel::Dirty, though completely ORM agnostic.
+Compare large object trees. Like a generic and standalone ActiveModel::Dirty, but completely ORM agnostic.
+
+The gem is still new and I'm still adding features, but it's stable and released.
 
 ## Installation
 
@@ -41,3 +43,58 @@ gem install tree_diff
     end
     ```
 
+3. `handle_stuff` will only be executed if any of the observed attributes changed -- `my_diff.saw_any_change?`. To see what the actual changes were, use `my_diff.changes`.
+
+## Defining conditions
+
+Sometimes you don't want to make attribute comparisons if the object receiving the method is in a certain state:
+
+```ruby
+class MyDiffClass < TreeDiff
+  observe :reference_code
+
+  condition [:reference_code] do |thing|
+    thing.status == 'enabled'
+  end
+end
+```
+
+This will only call and compare `:reference_code` if Thing's status is `"enabled"`. This works as expected for associations:
+
+```ruby
+class MyDiffClass < TreeDiff
+  observe items: [:id, tags: [{categories: [:name, :is_active]}]]
+
+  condition [:tags, :categories, :name] do |category|
+    category.is_active
+  end
+end
+```
+
+The object passed to the block is always the receiver of the attribute method. It's an instance of the second to the last segment of the call chain.
+
+Bear in mind the condition is called on both the mold of the object in its "old" state and the current full object. Because TreeDiff works off of call chains only, the "old" object is nothing but a mock, meaning you can only use other attributes you've observed in your conditions. Otherwise, you can add a virtual attribute.
+
+## Virtual Attributes
+
+*NOTE*: Not implemented yet, work in progress.
+
+If you want to create conditions using attributes that are not observed, you can add them as virtual attributes. That will define the method on the Mold (mock) object so it can be safely called.
+
+```ruby
+class MyDiffClass < TreeDiff
+  observe items: [:id, tags: [{categories: [:name]}]]
+
+  virtual_attributes [:tags, :categories, :is_active],
+                     [:tags, :categories, :created_at]
+
+
+  condition [:tags, :categories, :name] do |category|
+    category.is_active && category.created_at > 1.year.ago
+  end
+end
+```
+
+## Documentation / Reference
+
+**[RubyDoc](https://www.rubydoc.info/gems/tree_diff)**

data/lib/tree_diff.rb

@@ -47,8 +47,10 @@ class TreeDiff
   #
   # @return [void]
   def self.condition(path, &condition)
-    class_variable_set(:@@conditions, []) unless conditions
-    conditions << [path, condition]
+    class_variable_set(:@@conditions, []) unless class_variable_defined?(:@@conditions)
+    c = class_variable_get(:@@conditions)
+    c << [path, condition]
+    class_variable_set(:@@conditions, c)
   end
 
   # Holds the original object tree definitions passed to `.observe`.
@@ -69,7 +71,7 @@ class TreeDiff
   # All conditions defined via `.condition`.
   # @return [Array]
   def self.conditions
-    class_variable_set(:@@conditions, nil) unless class_variable_defined?(:@@conditions)
+    class_variable_set(:@@conditions, []) unless class_variable_defined?(:@@conditions)
     class_variable_get(:@@conditions)
   end
 
@@ -99,7 +101,6 @@ class TreeDiff
   def initialize(original_object)
     check_observations
 
-    self.class.class_variable_set(:@@conditions, [])
     @old_object_as_mold = create_mold Mold.new, original_object, self.class.observations
     @current_object = original_object
   end

data/test/tree_diff_test.rb

@@ -7,6 +7,14 @@ class TreeDiffTest < Minitest::Test
     observe :at, :quantity
   end
 
+  class ConditionalDiff < TreeDiff
+    observe :number, line_items: [:description, :price_usd_cents, item_categories: [:short_name, :description]]
+
+    condition [:line_items, :item_categories, :short_name] do |category|
+      category.description == 'foo'
+    end
+  end
+
   class OrderDiff < TreeDiff
     observe :number, line_items: [:description, :price_usd_cents, item_categories: [:description]]
   end
@@ -140,6 +148,25 @@ class TreeDiffTest < Minitest::Test
                    :new => ["not_that_bad"]}], diff.changes
   end
 
+  def test_honors_conditions
+    foo_category = ItemCategory.new(description: 'foo', short_name: 'Cool category')
+    bar_category = ItemCategory.new(description: 'bar', short_name: 'Not very cool category')
+
+    line_item = LineItem.new(item_categories: [foo_category, bar_category])
+    order = Order.create!(line_items: [line_item])
+
+    diff = ConditionalDiff.new(order)
+    assert_empty diff.changes
+
+    order.update!(line_items_attributes: [{id: line_item.id,
+                                           item_categories_attributes: [{id: foo_category.id, description: 'foo',
+                                                                         short_name: 'Cool category'},
+                                                                         {id: bar_category.id, description: 'bar',
+                                                                          short_name: 'another value'}]}])
+
+    assert_equal false, diff.changed_paths.include?([:line_items, :item_categories, :short_name])
+  end
+
   def test_abstract_class
     e = assert_raises RuntimeError do
       TreeDiff.new(Object.new)

data/tree_diff.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'tree_diff'
-  s.version     = '1.1.1'
-  s.date        = '2019-07-13'
+  s.version     = '1.1.2'
+  s.date        = '2019-08-23'
   s.summary     = "Observe attribute changes in big complex object trees, like a generic & standalone ActiveModel::Dirty"
   s.description = "Given a tree of relationships in a similar format to strong params, analyzes attribute changes by " \
                   "call chain. Call just before and after you make a change. Completely ORM and framework agnostic."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tree_diff
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Michael Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-13 00:00:00.000000000 Z
+date: 2019-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest