disposable 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78adbe70c077a4e207d4cd692e4478a61184e1bf
-  data.tar.gz: 64ab6c7d7881a7c075e845ee09cf33363a78bd58
+  metadata.gz: 31d57820d95d0f0c679a690f4f5571fecbe972d4
+  data.tar.gz: 9ca35177d6953ebdc3fc2d3b8d7f2040177586ef
 SHA512:
-  metadata.gz: 2580b1e00e75d27ff341b987b36662f162f45b5c6510be8043021f69f028f0dc9502727d9bc56fcfbc26ebdf8af7b26b3efafff7ab37953ba9077de06fdfd873
-  data.tar.gz: c8a0b0502156538666b9d811ec185818ea2bde1a13274483c2bc514b872cf0112319f188ae3865fe7f48eae81458ec27bf1fb7885a8705a96175d0f32bb086df
+  metadata.gz: 56f4d3c54f0c4515da447474ab3618cd218eafe534377a0e7d0be4b4ac34e1d9d611c94874b44167fb176aea725b6f1dcabe5f1c26df4e05fde5e877cf4d5467
+  data.tar.gz: 38dce808bde55025f706c3900290569410a7fce94ce13882489fa4dabf93f36c4d4c10930f7ddddb847238c43bcbac12c522c46c04594f9909a3c93618a9e3a3

data/CHANGES.md

@@ -1,3 +1,8 @@
+# 0.2.1
+
+* In `Callback::Group#call`, the `context` option now allows running callbacks in different contexts. Per default, the group instance is context.
+* Callback handler methods now receive two options: the twin and the options hash passed into `Group#call`. This allows injecting arbitrary objects into callbacks, which is pretty awesome!
+
 # 0.2.0
 
 * Internally, use [Declarative](https://github.com/apotonick/declarative) now for schema creation, resulting in the following internal changes.
@@ -7,6 +12,10 @@
 * Added `:exclude_properties` to `Rescheme`.
 * Runs with Representable 2.4 and 3.0.
 
+# 0.1.15
+
+* Restrict to Representable < 2.4.
+
 # 0.1.14
 
 * Allow to nil-out nested twins.

data/README.md

@@ -462,6 +462,8 @@ class AlbumTwin < Disposable::Twin
 
 ## Imperative Callbacks
 
+Please refer to the [full documentation](http://trailblazer.to/gems/disposable/callback.html).
+
 Note: [Chapter 8 of the Trailblazer](http://leanpub.com/trailblazer) book is dedicated to callbacks and discusses them in great detail.
 
 Callbacks use the fact that twins track state changes. This allows to execute callbacks on certain conditions.
@@ -529,6 +531,8 @@ AfterSave.new(twin).(context: self)
 
 Methods like `:sing!` will be invoked on the `:context` object. Likewise, nested properties will be retrieved by simply calling the getter on the twin, like `twin.songs`.
 
+An options hash is passed as the second argument. # TODO: document Group.(operation: Object.new).
+
 Again, only the events that match will be invoked. If the top level twin hasn't changed, `expire_cache!` won't be invoked. This works by simply using `Callback` under the hood.
 
 ## Callback Inheritance

data/lib/disposable/callback.rb

@@ -39,7 +39,7 @@ module Disposable::Callback
     end
 
     def self.remove!(event, callback)
-      hooks.delete hooks.find { |cfg| cfg[0] == event && cfg[1][0] == callback }
+      hooks.delete hooks.find { |cfg| cfg[0] == event && cfg[1] == callback }
     end
 
 
@@ -57,19 +57,19 @@ module Disposable::Callback
 
     class << self
       %w(on_add on_delete on_destroy on_update on_create on_change).each do |event|
-        define_method event do |*args|
-          heritage.record(event, *args)
+        define_method event do |method, options={}|
+          heritage.record(event, method, options)
 
-          hooks << [event.to_sym, args]
+          hooks << [event.to_sym, method, options] # DISCUSS: can't we simply instantiate Callables here?
         end
       end
     end
 
 
     def call(options={})
-      self.class.hooks.each do |event, args|
+      self.class.hooks.each do |event, method, property_options|
         if event == "property" # FIXME: make nicer.
-          definition = self.class.definitions.get(args)
+          definition = self.class.definitions.get(method)
           twin = @twin.send(definition[:name]) # album.songs
 
           # recursively call nested group.
@@ -77,22 +77,24 @@ module Disposable::Callback
           next
         end
 
-        invocations << callback!(event, options, args)
+        invocations << callback!(event, options, method, property_options)
       end
 
       self
     end
 
   private
-    # Runs one callback.
-    def callback!(event, options, args)
-      method      = args[0]
-      context     = options[:context] || self # TODO: test me.
-
-      options = args[1..-1]
+    # Runs one callback, e.g. for `on_change :smile!`.
+    def callback!(event, options, method, property_options) # TODO: remove args.
+      context = options[:context] || self # TODO: test me.
+
+      # TODO: Use Option::Value here. this could be created straight in the DSL with the twin being passed in.
+      if context.methods.include?(method) && context.method(method).arity == 1 # TODO: remove in 0.3.
+        warn "[Disposable] Callback handlers now receive two options: #{method}(twin, options)."
+        return Dispatch.new(@twin).(event, method, property_options) { |twin| context.send(method, twin) }
+      end
 
-      # TODO: Use Option::Value here.
-      Dispatch.new(@twin).(event, method, *options) { |twin| context.send(method, twin) }
+      Dispatch.new(@twin).(event, method, property_options) { |twin| context.send(method, twin, options) }
     end
   end
 
@@ -105,33 +107,33 @@ module Disposable::Callback
       @invocations = []
     end
 
-    def call(event, method, *args, &block) # FIXME: as long as we only support method, pass in here.
-      send(event, *args, &block)
+    def call(event, method, property_options, &block) # FIXME: as long as we only support method, pass in here.
+      send(event, property_options, &block)
       [event, method, @invocations]
     end
 
     def on_add(state=nil, &block) # how to call it once, for "all"?
       # @twins can only be Collection instance.
       @twins.added.each do |item|
-        run!(item, &block) if state.nil?
+        run!(item, &block) if ! state.is_a?(Symbol)
         run!(item, &block) if item.created? && state == :created # :created # DISCUSS: should we really keep that?
       end
     end
 
-    def on_delete(&block)
+    def on_delete(*, &block)
       # @twins can only be Collection instance.
       @twins.deleted.each do |item|
         run!(item, &block)
       end
     end
 
-    def on_destroy(&block)
+    def on_destroy(*, &block)
       @twins.destroyed.each do |item|
         run!(item, &block)
       end
     end
 
-    def on_update(&block)
+    def on_update(*, &block)
       @twins.each do |twin|
         next if twin.created?
         next unless twin.persisted? # only persisted can be updated.
@@ -140,15 +142,15 @@ module Disposable::Callback
       end
     end
 
-    def on_create(&block)
+    def on_create(*, &block)
       @twins.each do |twin|
         next unless twin.created?
         run!(twin, &block)
       end
     end
 
-    def on_change(options={}, &block)
-      name = options[:property]
+    def on_change(property_options={}, &block)
+      name = property_options[:property]
 
       @twins.each do |twin|
         if name

data/lib/disposable/version.rb

@@ -1,3 +1,3 @@
 module Disposable
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/callback_group_test.rb

@@ -14,12 +14,12 @@ class CallbackGroupTest < MiniTest::Spec
 
       # on_delete :notify_deleted_author! # in Update!
 
-      def notify_album!(twin)
-        @output = "added to songs"
+      def notify_album!(twin, options)
+        options[:content] << "notify_album!"
       end
 
-      def reset_song!(twin)
-        @output << "added to songs, reseting"
+      def reset_song!(twin, options)
+        options[:content] << "reset_song!"
       end
     end
 
@@ -29,7 +29,7 @@ class CallbackGroupTest < MiniTest::Spec
     on_create :expire_cache! # on_change
     on_update :expire_cache!
 
-    def change!(twin)
+    def change!(twin, options)
       @output = "Album has changed!"
     end
   end
@@ -66,6 +66,8 @@ class CallbackGroupTest < MiniTest::Spec
     ]
   end
 
+  # trigger songs:on_add, and on_change.
+  let (:content) { "" }
   it do
     twin = AlbumTwin.new(Album.new)
     twin.songs << Song.new(title: "Dead To Me")
@@ -73,10 +75,7 @@ class CallbackGroupTest < MiniTest::Spec
 
     twin.name = "Dear Landlord"
 
-    group = Group.new(twin).()
-    # Disposable::Callback::Dispatch.new(twin).on_change{ |twin| puts twin;puts }
-
-    # pp group.invocations
+    group = Group.new(twin).(content: content)
 
     group.invocations.must_equal [
       [:on_change, :change!, [twin]],
@@ -87,23 +86,36 @@ class CallbackGroupTest < MiniTest::Spec
       [:on_update, :expire_cache!, []],
     ]
 
+    content.must_equal "notify_album!notify_album!reset_song!reset_song!"
     group.output.must_equal "Album has changed!"
   end
 
+
+
+
+
   # context.
   class Operation
     attr_reader :output
 
-    def change!(twin)
-      @output = "changed!"
+    def change!(twin, options)
+      options[:content] << "Op: changed! [#{options[:context].class}]"
+    end
+
+    def notify_album!(twin, options)
+      options[:content] << "Op: notify_album! [#{options[:context].class}]"
+    end
+
+    def reset_song!(twin, options)
+      options[:content] << "Op: reset_song! [#{options[:context].class}]"
     end
 
-    def notify_album!(twin)
-      @output << "notify_album!"
+    def rehash_name!(twin, options)
+      options[:content] << "Op: rehash_name! [#{options[:context].class}]"
     end
 
-    def reset_song!(twin)
-      @output << "reset_song!"
+    def expire_cache!(twin, options)
+      options[:content] << "Op: expire_cache! [#{options[:context].class}]"
     end
   end
 
@@ -113,7 +125,7 @@ class CallbackGroupTest < MiniTest::Spec
 
     twin.name = "Dear Landlord"
 
-    group = Group.new(twin).(context: context = Operation.new)
+    group = Group.new(twin).(context: context = Operation.new, content: content)
     # Disposable::Callback::Dispatch.new(twin).on_change{ |twin| puts twin;puts }
 
     # pp group.invocations
@@ -127,7 +139,7 @@ class CallbackGroupTest < MiniTest::Spec
       [:on_update, :expire_cache!, []],
     ]
 
-    context.output.must_equal "changed!notify_album!reset_song!"
+    content.must_equal "Op: changed! [CallbackGroupTest::Operation]Op: notify_album! [CallbackGroupTest::Operation]Op: reset_song! [CallbackGroupTest::Operation]"
   end
 end
 
@@ -147,11 +159,11 @@ class CallbackGroupInheritanceTest < MiniTest::Spec
 
   it do
     Group.hooks.size.must_equal 4
-    Group.hooks[0].to_s.must_equal "[:on_change, [:change!]]"
+    Group.hooks[0].to_s.must_equal "[:on_change, :change!, {}]"
     # Group.hooks[1][1][:nested].hooks.to_s.must_equal "[[:on_add, [:notify_album!]],[:on_add, [:reset_song!]]]"
-    Group.hooks[2].to_s.must_equal "[:on_change, [:rehash_name!, {:property=>:title}]]"
+    Group.hooks[2].to_s.must_equal "[:on_change, :rehash_name!, {:property=>:title}]"
 
-    Group.definitions.get(Group.hooks[3][1])[:nested].hooks.to_s.must_equal "[[:on_change, [:sing!]]]"
+    Group.definitions.get(Group.hooks[3][1])[:nested].hooks.to_s.must_equal "[[:on_change, :sing!, {}]]"
   end
 
   class EmptyGroup < Group
@@ -175,7 +187,7 @@ class CallbackGroupInheritanceTest < MiniTest::Spec
     Group.hooks.size.must_equal 4
     pp EnhancedGroup.hooks
     EnhancedGroup.hooks.size.must_equal 6
-    EnhancedGroup.definitions.get(EnhancedGroup.hooks[5][1])[:nested].hooks.to_s.must_equal "[[:on_add, [:rewind!]]]"
+    EnhancedGroup.definitions.get(EnhancedGroup.hooks[5][1])[:nested].hooks.to_s.must_equal "[[:on_add, :rewind!, {}]]"
   end
 
   class EnhancedWithInheritGroup < EnhancedGroup
@@ -191,10 +203,10 @@ class CallbackGroupInheritanceTest < MiniTest::Spec
     Group.hooks.size.must_equal 4
     EnhancedGroup.hooks.size.must_equal 6
 
-    EnhancedGroup.definitions.get(EnhancedGroup.hooks[5][1])[:nested].hooks.to_s.must_equal "[[:on_add, [:rewind!]]]"
+    EnhancedGroup.definitions.get(EnhancedGroup.hooks[5][1])[:nested].hooks.to_s.must_equal "[[:on_add, :rewind!, {}]]"
     EnhancedWithInheritGroup.hooks.size.must_equal 6
-    EnhancedWithInheritGroup.definitions.get(EnhancedWithInheritGroup.hooks[1][1])[:nested].hooks.to_s.must_equal "[[:on_add, [:rewind!]], [:on_add, [:eat!]]]"
-    EnhancedWithInheritGroup.definitions.get(EnhancedWithInheritGroup.hooks[3][1])[:nested].hooks.to_s.must_equal "[[:on_change, [:sing!]], [:on_delete, [:yell!]]]"
+    EnhancedWithInheritGroup.definitions.get(EnhancedWithInheritGroup.hooks[1][1])[:nested].hooks.to_s.must_equal "[[:on_add, :rewind!, {}], [:on_add, :eat!, {}]]"
+    EnhancedWithInheritGroup.definitions.get(EnhancedWithInheritGroup.hooks[3][1])[:nested].hooks.to_s.must_equal "[[:on_change, :sing!, {}], [:on_delete, :yell!, {}]]"
   end
 
   class RemovingInheritGroup < Group
@@ -217,8 +229,8 @@ class CallbackGroupInheritanceTest < MiniTest::Spec
   it do
     Group.hooks.size.must_equal 4
     RemovingInheritGroup.hooks.size.must_equal 3
-    RemovingInheritGroup.definitions.get(RemovingInheritGroup.hooks[0][1])[:nested].hooks.to_s.must_equal "[[:on_add, [:reset_song!]]]"
-    RemovingInheritGroup.definitions.get(RemovingInheritGroup.hooks[2][1])[:nested].hooks.to_s.must_equal "[[:on_change, [:sing!]]]"
+    RemovingInheritGroup.definitions.get(RemovingInheritGroup.hooks[0][1])[:nested].hooks.to_s.must_equal "[[:on_add, :reset_song!, {}]]"
+    RemovingInheritGroup.definitions.get(RemovingInheritGroup.hooks[2][1])[:nested].hooks.to_s.must_equal "[[:on_change, :sing!, {}]]"
   end
 
   # Group::clone

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: disposable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2015-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber