hooks 0.3.1 → 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17924e6e39cc1e9257eb89343e4b714bc617c1e3
+  data.tar.gz: c5f79d3aec15fc0ae9a6e36f11b7db3c1c35455c
+SHA512:
+  metadata.gz: 55f49769f6dd5bb4cce4dfcea66546d6681580479be431409eff36d884417898bfcf5d903d0ebed765d20fa32ca772880bc7463805ed8c55428b60b28ef97501
+  data.tar.gz: c216a9b2d5f1b841b91c83a8cee5a20cc0425789dd95d147ef9474af389234e990d13f46e1694966a39c1eaaa9441d86aa46f1f3f1a6cce908e05f3abe3fda30

data/CHANGES.md

@@ -1,3 +1,7 @@
+## 0.3.2
+
+* Added `Hooks::InstanceHooks` to add hooks and/or callbacks on instance level. Thanks to @mpapis for that suggestion.
+
 ## 0.3.1
 
 * Fix a bug, string hook names are now treated as symbols.

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011-2013 Nick Sutterer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -138,12 +138,49 @@ This will only run the first two callbacks. Note that the result doesn't contain
 result.halted? #=> true
 ```
 
+## 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.
+
+```ruby
+class Cat
+  include Hooks
+  include Hooks::InstanceHooks
+
+  define_hook :after_dark
+
+  after_dark { "Chase mice" }
+end
+```
+
+Note that you have to include `Hooks::InstanceHooks` to get this additional functionality.
+
+See how callbacks can be added to a separate object, now.
+
+```ruby
+garfield = Cat.new
+
+garfield.after_dark :sleep
+garfield.run_hook(:after_dark) # => invoke "Chase mice" hook and #sleep
+```
+
+This will copy all callbacks from the `after_dark` hook to the instance and add a second hook. This all happens on the `garfield` instance, only, and leaves the class untouched.
+
+Naturally, adding new hooks works like-wise.
+
+```ruby
+garfield.define_hook :before_six
+garfield.before_six { .. }
+```
+This feature was added in 0.3.2.
+
+
 ## Installation
 
 In your Gemfile, do
 
 ```ruby
-gem hooks
+gem "hooks"
 ```
 
 ## Anybody using it?

data/hooks.gemspec

@@ -1,7 +1,7 @@
 lib = File.expand_path('../lib/', __FILE__)
 $:.unshift lib unless $:.include?(lib)
 
-require 'hooks'
+require 'hooks/version'
 
 Gem::Specification.new do |s|
   s.name        = "hooks"
@@ -12,10 +12,12 @@ 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.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_development_dependency "minitest", ">= 5.0.0"
   s.add_development_dependency "rake"

data/lib/hooks.rb

@@ -18,8 +18,6 @@ require "hooks/hook"
 #
 #   cat.run_hook :after_dinner
 module Hooks
-  VERSION = "0.3.1"
-
   def self.included(base)
     base.class_eval do
       extend InheritableAttribute
@@ -122,3 +120,5 @@ module Hooks
     end
   end
 end
+
+require "hooks/instance_hooks"

data/lib/hooks/instance_hooks.rb

@@ -0,0 +1,13 @@
+module Hooks
+  module InstanceHooks
+    include ClassMethods
+
+    def _hooks
+      @_hooks ||= self.class._hooks.clone # TODO: generify that with representable_attrs.
+    end
+
+    def run_hook(name, *args)
+      run_hook_for(name, self, *args)
+    end
+  end
+end

data/lib/hooks/version.rb

@@ -0,0 +1,3 @@
+module Hooks
+  VERSION = "0.3.2"
+end

data/test/hooks_test.rb

@@ -10,7 +10,7 @@ class HooksTest < MiniTest::Spec
   end
 
 
-  describe "Hooks.define_hook" do
+  describe "::define_hook" do
     let(:klass) do
       Class.new(TestClass) do
         define_hook :after_eight
@@ -73,6 +73,10 @@ class HooksTest < MiniTest::Spec
         assert_equal [:b, :a], subject.executed
       end
 
+      it "returns empty Results when no callbacks defined" do
+        subject.run_hook(:after_eight).must_equal Hooks::Hook::Results.new
+      end
+
       it "accept arbitrary parameters" do
         subject.instance_eval do
           def a(me, arg); executed << arg+1; end
@@ -145,17 +149,17 @@ class HooksTest < MiniTest::Spec
     end
 
     describe "in class context" do
-      it "run a callback block" do
+      it "runs callback block" do
         executed = []
         klass.after_eight do
           executed << :klass
         end
         klass.run_hook(:after_eight)
 
-        assert_equal [:klass], executed
+        executed.must_equal([:klass])
       end
 
-      it "run a class methods" do
+      it "runs instance methods" do
         executed = []
         klass.instance_eval do
           after_eight :have_dinner
@@ -166,7 +170,7 @@ class HooksTest < MiniTest::Spec
         end
         klass.run_hook(:after_eight, executed)
 
-        assert_equal [:have_dinner], executed
+        executed.must_equal([:have_dinner])
       end
     end
   end
@@ -195,11 +199,18 @@ end
 class HookSetTest < MiniTest::Spec
   subject { Hooks::HookSet.new }
 
+  let (:first_hook)   { Hooks::Hook.new(:halts_on_falsey => true) }
+  let (:second_hook)  { Hooks::Hook.new(:halts_on_falsey => false) }
+
   it "responds to #clone" do
-    subject[:after_eight] = [:drink_beer]
+    subject[:after_eight] = [first_hook]
+
     clone = subject.clone
-    clone[:after_eight] << :open_fridge
 
-    subject.must_equal(:after_eight => [:drink_beer])
+    clone[:after_eight] << second_hook
+
+    subject.must_equal(:after_eight => [first_hook])
+    clone.must_equal(:after_eight => [first_hook, second_hook])
   end
+  # TODO: test if options get cloned.
 end

data/test/instance_hooks_test.rb

@@ -0,0 +1,44 @@
+require "test_helper"
+
+class InstanceHooksTest < HooksTest
+  describe "#define_hook" do
+    let(:klass) { Class.new(TestClass) do
+      include Hooks::InstanceHooks
+    end }
+
+    subject { klass.new }
+
+    it "adds hook to instance" do
+      subject.define_hook :after_eight
+
+      assert_equal [], subject.callbacks_for_hook(:after_eight)
+    end
+
+    it "copies existing class hook" do
+      klass.define_hook :after_eight
+      klass.after_eight :dine
+
+      assert_equal [:dine], subject.callbacks_for_hook(:after_eight)
+    end
+
+    describe "#after_eight (adding callbacks)" do
+      before do
+        subject.define_hook :after_eight
+        subject.after_eight :dine
+      end
+
+      it "adds #after_eight hook" do
+        assert_equal [:dine], subject.callbacks_for_hook(:after_eight)
+      end
+
+      it "responds to #run_hook" do
+        subject.instance_eval do
+          def dine; executed << :dine; end
+        end
+
+        subject.run_hook :after_eight
+        subject.executed.must_equal [:dine]
+      end
+    end
+  end
+end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: hooks
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.3.2
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Declaratively define hooks, add callbacks and run them with the options
@@ -71,38 +64,42 @@ files:
 - .travis.yml
 - CHANGES.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - hooks.gemspec
 - lib/hooks.rb
 - lib/hooks/hook.rb
 - lib/hooks/inheritable_attribute.rb
+- lib/hooks/instance_hooks.rb
+- lib/hooks/version.rb
 - test/hook_test.rb
 - test/hooks_test.rb
 - test/inheritable_attribute_test.rb
+- test/instance_hooks_test.rb
 - test/test_helper.rb
 homepage: http://nicksda.apotomo.de/2010/09/hooks-and-callbacks-for-ruby-but-simple/
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Generic hooks with callbacks for Ruby.
 test_files: []