hooks 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a443efe3e8187d217fc45ebb0dfa46ec5ebfab70
-  data.tar.gz: 6eef3c4bc347fdc56b8f4ffc4a9586bf25f4ae5a
+  metadata.gz: 9fad249f87b5002ed27f3174c9268cad5f00be86
+  data.tar.gz: 5beade083dcdc44fb292bfef06018e9fec522a50
 SHA512:
-  metadata.gz: 4f99392b4f3de07d945061ec605de9152f635589a140898c9e45df368395c8b7ffb025964c4c59dd211d2dace142a00abf792f308ff63ee2e7f6b14d03ec968b
-  data.tar.gz: d2e0920e00253fbe2ba687f530c3ea223a9f467465fab6ad9ef852a27f6e863e2bc3fa4c0bf25d58cc417a124faa3199d81cf70a149c99cbadc731a6dc9ba976
+  metadata.gz: c883e89e33556a57c0df0e375d0be763edad476b7a9b0ef013397c1a7990d36d7d82a50549944d9818778969745e6d069da8af7ab1661f2c6b5e2e343f3cf4ef
+  data.tar.gz: f61d4bddc22992f25d705332bb8ad729f2c32d5ba3fd46af901501510b53b7a85a40fe02c588c66d36753cdabb7506bcea29ce393f5d3e6562c0fef3b797955c

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
+  - 2.2.0

data/CHANGES.md

@@ -1,3 +1,7 @@
+## 0.4.1
+
+* Introduce `define_hook .., scope: ->{}` option. This allows changing the callback execution context per callback. Many thanks to @doudou for pushing this.
+
 ## 0.4.0
 
 * Same as 0.3.6 but we wanna indicate an internal change (using uber).

data/README.md

@@ -138,6 +138,26 @@ This will only run the first two callbacks. Note that the result doesn't contain
 result.halted? #=> true
 ```
 
+## Execution Scope
+
+Normally, callbacks are executed in object context. You're free to provide your own context object using `:scope`.
+
+```ruby
+define_hook :before_lunch, scope: lambda { |callback, scope| Logger }
+```
+
+This will evaluate the lambda in `Logger` class context.
+
+Return `nil` to execute the lambda in the original context.
+
+```ruby
+define_hook :before_lunch, scope: lambda { |*| nil }
+what = "hands"
+before_lunch << lambda { puts "wash #{what}" } # executed in original context.
+```
+
+The `:scope` lambda is executed for every added callback per run, hence the block options.
+
 ## Instance Hooks
 
 You can also define hooks and/or add callbacks per instance. This is helpful if your class should define a basic set of hooks and callbacks that are then extended by instances.
@@ -197,6 +217,6 @@ gem "hooks"
 
 ## License
 
-Copyright (c) 2013, Nick Sutterer
+Copyright (c) 2013-2015, Nick Sutterer
 
 Released under the MIT License.

data/hooks.gemspec

@@ -12,15 +12,14 @@ Gem::Specification.new do |s|
   s.homepage    = "http://nicksda.apotomo.de/2010/09/hooks-and-callbacks-for-ruby-but-simple/"
   s.summary     = %q{Generic hooks with callbacks for Ruby.}
   s.description = %q{Declaratively define hooks, add callbacks and run them with the options you like.}
-  s.license = "MIT"
+  s.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
-  s.license       = 'MIT'
 
-  s.add_dependency "uber", "~> 0.0.4"
+  s.add_dependency "uber", "~> 0.0.14"
 
-  s.add_development_dependency "minitest", ">= 5.0.0"
+  s.add_development_dependency "minitest", ">= 5.4.1"
   s.add_development_dependency "rake"
 end

data/lib/hooks.rb

@@ -58,14 +58,18 @@ module Hooks
     # Returns the callbacks for +name+. Handy if you want to run the callbacks yourself, say when
     # they should be executed in another context.
     #
+    # As callbacks can be static values, lambdas or methods, they're wrapped by Uber::Option::Value
+    # which gives you a very convenient way to execute the callback without knowing its type using
+    # <tt>Value#evaluate</tt>.
+    #
     # Example:
     #
     #   def initialize
     #     self.class.callbacks_for_hook(:after_eight).each do |callback|
-    #       instance_exec(self, &callback)
+    #       callback.evaluate(self, "create")
     #     end
     #
-    # would run callbacks in the object _instance_ context, passing +self+ as block parameter.
+    # Runs callbacks in the object _instance_ context and pass "create" as the only argument.
     def callbacks_for_hook(name)
       _hooks[name]
     end

data/lib/hooks/hook.rb

@@ -50,6 +50,12 @@ module Hooks
 
   private
     def execute_callback(scope, callback, *args)
+      scope = @options[:scope].(callback, scope) if @options[:scope]
+
+      evaluate_callback(scope, callback, *args)
+    end
+
+    def evaluate_callback(scope, callback, *args)
       callback.evaluate(scope, *args) # from Uber::Options::Value.
     end
 

data/lib/hooks/version.rb

@@ -1,3 +1,3 @@
 module Hooks
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/test/hook_test.rb

@@ -9,6 +9,12 @@ class HookTest < MiniTest::Spec
 
     subject.to_a.map(&:to_sym).must_equal [:play_music, :drink_beer]
   end
+
+  it "evals the procs in the context of its argument" do
+    subject << proc { self }
+    obj = Object.new
+    subject.run(obj).must_equal [obj]
+  end
 end
 
 class ResultsTest < MiniTest::Spec
@@ -28,4 +34,4 @@ class ResultsTest < MiniTest::Spec
       subject.not_halted?.must_equal true
     end
   end
-end
+end

data/test/hooks_test.rb

@@ -89,10 +89,26 @@ class HooksTest < MiniTest::Spec
         assert_equal [2, 0], subject.executed
       end
 
-      it "execute block callbacks in instance context" do
-        subject.class.after_eight { executed << :c }
-        subject.run_hook(:after_eight)
-        assert_equal [:c], subject.executed
+      describe "the define-time scope option" do
+        it "execute block callbacks in instance context when not defined with a scope option" do
+          subject.class.after_eight { executed << :c }
+          subject.run_hook(:after_eight)
+          assert_equal [:c], subject.executed
+        end
+
+        it ":scope receives callback and original scope" do
+          subject.class.define_hook(:scoped_hook, scope: lambda { |callback, scope| [[callback], [scope]] })
+          hook = subject.class._hooks[:scoped_hook]
+          subject.class.scoped_hook :flatten # call [[callback], [scope]].flatten
+          subject.run_hook(:scoped_hook).must_equal [[hook.last, subject]]
+        end
+
+        it "evaluates procs in their original context when :scope returns nil" do
+          subject.class.define_hook(
+            :scoped_hook, scope: lambda { |callback, scope| nil })
+          subject.class.scoped_hook(lambda { self })
+          subject.run_hook(:scoped_hook).must_equal [self]
+        end
       end
 
       it "returns all callbacks in order" do
@@ -213,4 +229,4 @@ class HookSetTest < MiniTest::Spec
     clone.must_equal(:after_eight => [first_hook, second_hook])
   end
   # TODO: test if options get cloned.
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hooks
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-11 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.14
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.4.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -97,12 +97,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Generic hooks with callbacks for Ruby.
-test_files:
-- test/hook_test.rb
-- test/hooks_test.rb
-- test/instance_hooks_test.rb
-- test/test_helper.rb
+test_files: []
+has_rdoc: