callbacks_attachable 2.3.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7091bf08cc2a80db2eeb18a8f79e183a0d994dad
-  data.tar.gz: 6d2ae70d5b6dcbe5c884eeecec9aa9144d90f616
+  metadata.gz: b74554af0366433cb7bcecddc081c5e906e0ab91
+  data.tar.gz: 5c86c645b70577ea1fd03982f0aa4151245f40d0
 SHA512:
-  metadata.gz: 94f3810baf82fc729a726b66cc301a9b5161d98801efe4331414844d98d922c0a619fcd759110af154ad19928350dbddc8675b4e3f4d6d12a45edfcac86635f0
-  data.tar.gz: 98278e8fb7e882e48829a1328b4f83a0bb05ac739203fed142b4bc972d8d81e36efaefe8913d874c801cc2cb81640c577991cba512274da347aaa946483641b3
+  metadata.gz: 45b1e71f8b7b91c38977e9f3acd9d0e404cd12c05ee4dbba63b9a45331319acea6cf0d6ad572fe030a0523603fc23a735e5ec2be432c142a368f0ce71502899a
+  data.tar.gz: 362bdae78978be2933f04696e7515229b4ce7988c95e2b280d06c6ddb626d0e0e19278e6c16a2319c302f3d6448e8231e58cc7fa0903c6ac4de9282cc9eb847e

data/README.md

@@ -34,15 +34,15 @@ end
 Attach callbacks for an event for all instances of a class with:
 
 ```ruby
-callback = AClass.on(:event) do |method|
+AClass.on(:event) do |method|
   puts __send__(method)
 end
 
 instance0 = AClass.new(value: 0)
 instance1 = AClass.new(value: 1)
 
-AClass.trigger(:event, :value) # => 0
-                               #    1
+instance0.trigger(:event, :value) # => 0
+instance1.trigger(:event, :value) # => 1
 ```
 
 Callbacks attached to a class are evaluated in the context of the instance they
@@ -68,34 +68,17 @@ If you want to execute a callback just a single time attach it with `.once_on`:
 
 ```ruby
 AClass.once_on(:singular) { puts 'callback called!' }
-AClass.trigger(:singular) # => puts 'callback called!' and immediately
+AClass.new.trigger(:singular) # => puts 'callback called!' and immediately
                           #    detaches the callback
-AClass.trigger(:singular) # => does nothing
+AClass.new.trigger(:singular) # => does nothing
 ```
 
-To filter the instances to call the callback for, use the `:if` option:
-
-```ruby
-instance0 = AClass.new(value: 0)
-instance1 = AClass.new(value: 1)
-instance2 = AClass.new(value: 2)
-AClass.on(:even, if: proc{ |inst| inst.value.even? }) do |instance|
-    puts instance.value
-end
-
-AClass.trigger(:even) # => 0
-                      #    2
-```
-
-This is especially useful in combination with `.once_on` to execute the
-callback just for the first instance meeting certain criteria.
-
 ### Callbacks attached to an instance
 
 All above mentioned methods on the class level also exist for each instance of
-the class. With one exception: Callbacks are executed bound to the context its
-block was defined, just like normal blocks are. `self` inside a callback is the
-same as outside of it.
+the class. They behave the same with the one exception that callbacks are
+executed bound to the context its block was defined, just like normal blocks
+are: `self` inside a callback is the same as outside of it.
 
 Callbacks for an individual instance are executed by calling `#trigger` on it.
 This also executes callbacks attached to the class.

data/lib/all/callback.rb

@@ -3,21 +3,19 @@ module CallbacksAttachable
     def initialize(registry, events, opts, instance_scope, callback)
       @registry = registry
       @events = events
-      @call_condition = opts.fetch(:if, false)
-      @cancel_condition = opts.fetch(:until, false)
+      @once = opts.fetch(:once?, false)
       @instance_scope = instance_scope
       @callback = callback
-      @canceled = false
+      @cancelled = false
     end
 
     def call(instance, args)
-      return if @call_condition and not @call_condition.call instance, *args
       if @instance_scope
         instance.instance_exec(*args, &@callback)
       else
         @callback.call(*args)
       end
-      cancel if @cancel_condition and @cancel_condition.call instance, *args
+      cancel if @once
     end
 
     def on_cancel(&on_cancel)
@@ -25,17 +23,17 @@ module CallbacksAttachable
     end
 
     def cancel
-      if @canceled
-        raise Error, 'already canceled'
+      if @cancelled
+        raise Error, 'already cancelled'
       else
         @events.each{ |event| @registry.deregister event, self }
         @on_cancel.call if @on_cancel
-        @canceled = true
+        @cancelled = true
       end
     end
 
-    def canceled?
-      @canceled
+    def cancelled?
+      @cancelled
     end
   end
 end

data/lib/all/callback_registry.rb

@@ -6,10 +6,6 @@ module CallbacksAttachable
     end
 
     def register(*events, opts, callback)
-      unless opts.is_a? Hash
-        events << opts
-        opts = {}
-      end
       callback = Callback.new(self, events, opts, !@singleton_owner, callback)
       events.each do |event|
         @callbacks[event] ||= {}

data/lib/all/callbacks_attachable.rb

@@ -8,26 +8,21 @@ module CallbacksAttachable
       CallbacksAttachable.included klass
     end
 
-    def on(event, *more_events_and_opts, &callback)
-      __callbacks__.register(event, *more_events_and_opts, callback)
+    def on(*events, &callback)
+      __callbacks__.register(*events, @on_opts ? @on_opts : {}, callback)
     end
 
-    def once_on(event, *more_events_and_opts, &callback)
-      opts = (more_events_and_opts.last.is_a? Hash) ? more_events_and_opts.pop : {}
-      opts[:until] = proc{ true }
-      on event, *more_events_and_opts, opts, &callback
+    def once_on(*events, &callback)
+      @on_opts = {once?: true}
+      on *events, &callback
+    ensure
+      @on_opts = nil
     end
 
     def on?(event)
       @__callbacks__ ? (@__callbacks__.registered? event) : false
     end
 
-    def trigger(event, *args)
-      ObjectSpace.each_object(self).each do |inst|
-        trigger_for_instance(inst, event, args)
-      end
-    end
-
     def trigger_for_instance(inst, event, args)
       if superclass.respond_to? :trigger_for_instance
         superclass.trigger_for_instance(inst, event, args)
@@ -49,14 +44,15 @@ module CallbacksAttachable
     klass.extend RegistryOwnable
   end
 
-  def on(event, *more_events_and_opts, &callback)
-    singleton_class.on event, *more_events_and_opts, &callback
+  def on(*events, &callback)
+    singleton_class.on *events, &callback
   end
 
-  def once_on(event, *more_events_and_opts, &callback)
-    opts = (more_events_and_opts.last.is_a? Hash) ? more_events_and_opts.pop : {}
-    opts[:until] = proc{ true }
-    on event, *more_events_and_opts, opts, &callback
+  def once_on(*events, &callback)
+    singleton_class.instance_variable_set :@on_opts, {once?: true}
+    on *events, &callback
+  ensure
+    singleton_class.remove_instance_variable :@on_opts
   end
 
   def on?(event)

data/lib/all/version.rb

@@ -1,3 +1,3 @@
 module CallbacksAttachable
-  VERSION = "2.3.1"
+  VERSION = "3.0.0"
 end

data/mrbgem.rake

@@ -12,7 +12,6 @@ DESC
   spec.license      = 'MIT'
   spec.authors      = ['Christopher Aue']
 
-  spec.add_dependency 'mruby-objectspace', :core => 'mruby-objectspace'
   spec.add_dependency 'mruby-object-ext', :core => 'mruby-object-ext'
 
   spec.objs = Dir["#{spec.dir}/ext/mruby/**/*.c"].sort.map do |f|
@@ -21,4 +20,11 @@ DESC
   spec.rbfiles =
     Dir["#{spec.dir}/lib/all/**/*.rb"].sort +
     Dir["#{spec.dir}/lib/mruby/**/*.rb"].sort
+
+  unless system("git merge-base --is-ancestor 5a9eedf5417266b82e3695ae0c29797182a5d04e HEAD")
+    # mruby commit 5a9eedf fixed the usage of spec.rbfiles. mruby 1.3.0
+    # did not have that commit, yet. Add the patch for this case:
+    @generate_functions = true
+    @objs << objfile("#{build_dir}/gem_init")
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callbacks_attachable
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Christopher Aue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-10-22 00:00:00.000000000 Z
 dependencies: []
 description: |
   Attach callbacks to classes to be triggered for all instances or attach them