callbacks_attachable 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d107585e18c31fa65029de71abfe920461083fb
-  data.tar.gz: dbcea68a454e67c3aa6c500729d10d027afca3ea
+  metadata.gz: 12ec8224c4c44dbd6b2f911c85dfdee057523d61
+  data.tar.gz: b73d81ff789dc2ba7db11bf0fc7fbc022f79623b
 SHA512:
-  metadata.gz: 3ddf6d868a2aa06a7b378458bc8711ecfeb80303c5c9022b5b1d972653ebb989f8684e41ce1ff183e59ced231e7f2c622b28f6e5eb2717481fa8ecf6f54fe61f
-  data.tar.gz: ab01d260af78b5f0c46c51582fe45a5675a5edbce9b8c7dbb7f5fd64a8c9db900d74effcc0bbc5f456a17ee09da62b350d8c19f8067ea4b83a6fc73b0b71737b
+  metadata.gz: 5bf6762f10eb1429d222a696e125f7e724ff589c8f4f49a457725471d20931261d35874518cceb336223d54cbe89c7bc6505a2bfcddcb81325af4596f46ba4c4
+  data.tar.gz: ced69ccc31423f7fd0d3255e503890c40043ae313a046babf154561fa931978940dc1c73a3a624b94445a4df62f3b8d2f4ea6b978cdc157aeb0a8b12636964ce

data/README.md

@@ -34,8 +34,8 @@ end
 Attach callbacks for an event for all instances of a class with:
 
 ```ruby
-callback = AClass.on(:event) do |instance, method|
-    puts instance.__send__(method)
+callback = AClass.on(:event) do |method|
+  puts __send__(method)
 end
 
 instance0 = AClass.new(value: 0)
@@ -45,9 +45,10 @@ AClass.trigger(:event, :value) # => 0
                                #    1
 ```
 
-The first argument of the callback is the instance the callback is executed
-for. The second and further arguments given to `.trigger` are passed to the
-callback as additional arguments.
+Callbacks attached to a class are evaluated in the context of the instance they
+are triggered for with `#instance_exec`. This means `self` inside the callback
+is the instance the callback is evaluated for. The arguments given to
+`.trigger` are passed to the callback as additional arguments.
 
 Registering a callback returns a `Callback` object. To cancel the callback use
 `#cancel` on that object.
@@ -86,7 +87,9 @@ 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.
+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.
 
 Callbacks for an individual instance are executed by calling `#trigger` on it.
 This also executes callbacks attached to the class.

data/lib/callbacks_attachable.rb

@@ -1,5 +1,2 @@
-require_relative "../mrblib/callbacks_attachable"
-require_relative "../mrblib/version"
-require_relative "../mrblib/callback_registry"
-require_relative "../mrblib/callback"
-require_relative "../mrblib/error"
+dir = File.dirname File.dirname __FILE__
+Dir[File.join(dir, 'mrblib', '*.rb')].reject{ |f| f.end_with? '_m.rb' }.sort.each{ |f| require f }

data/mrbgem.rake

@@ -13,4 +13,5 @@ DESC
   spec.authors      = ['Christopher Aue']
 
   spec.add_dependency 'mruby-objectspace', :core => 'mruby-objectspace'
+  spec.add_dependency 'mruby-object-ext', :core => 'mruby-object-ext'
 end

data/mrblib/_ext_module_m.rb

@@ -0,0 +1,12 @@
+Module.class_eval do
+  def singleton_class?
+    # The object id of a module is its pointer address shifted 5 to the left
+    # and adding its type id:
+    # https://github.com/mruby/mruby/blob/2e8ed9514feb74f4137e5835e74f256d52d6f191/src/etc.c#L108
+    #
+    # The type id of a singleton class is 0xc
+    # https://github.com/mruby/mruby/blob/a0fbc46ccd3e129532b05a9fe4f13f42a3c349b2/include/mruby/value.h#L107
+
+    __id__ & 0x1f == 0xc
+  end
+end

data/mrblib/callback.rb

@@ -1,17 +1,22 @@
 module CallbacksAttachable
   class Callback
-    def initialize(registry, event, opts = {}, callback)
+    def initialize(registry, event, opts, instance_scope, callback)
       @registry = registry
       @event = event
       @call_condition = opts.fetch(:if, false)
       @cancel_condition = opts.fetch(:until, false)
+      @instance_scope = instance_scope
       @callback = callback
       @canceled = false
     end
 
     def call(instance, args)
       return if @call_condition and not @call_condition.call instance, *args
-      @callback.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
     end
 

data/mrblib/callback_registry.rb

@@ -1,13 +1,13 @@
 module CallbacksAttachable
   class CallbackRegistry
-    def initialize(owner)
-      @owner = owner
+    def initialize(owner_class)
+      @singleton_owner = owner_class.singleton_class?
       @callbacks = {}
     end
 
     def register(event, opts, callback)
       @callbacks[event] ||= {}
-      callback = Callback.new(self, event, opts, callback)
+      callback = Callback.new(self, event, opts, !@singleton_owner, callback)
       @callbacks[event][callback] = true
       callback
     end

data/mrblib/version.rb

@@ -1,3 +1,3 @@
 module CallbacksAttachable
-  VERSION = "2.1.2"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callbacks_attachable
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Christopher Aue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,6 +69,7 @@ files:
 - callbacks_attachable.gemspec
 - lib/callbacks_attachable.rb
 - mrbgem.rake
+- mrblib/_ext_module_m.rb
 - mrblib/callback.rb
 - mrblib/callback_registry.rb
 - mrblib/callbacks_attachable.rb
@@ -94,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Attach callbacks to classes or individual instances.
 test_files: []
-has_rdoc: