hook 0.0.0 → 0.0.1

data/lib/hook.rb

@@ -0,0 +1,57 @@
+module Hook
+  def self.included(base)
+    base.extend ::Hook::ClassMethods
+  end
+
+  module ClassMethods
+    def hook(method)
+      self.instance_eval <<-HOOKS
+        def before_#{method}(&block)
+          before_hooks["#{method}"] << block
+        end
+
+        def after_#{method}(&block)
+          after_hooks["#{method}"] << block
+        end
+
+        def around_#{method}(&block)
+          around_hooks["#{method}"] << block
+        end
+      HOOKS
+    end
+
+    def before_hooks
+      @before_hooks ||= scoped_callbacks
+    end
+
+    def after_hooks
+      @after_hooks ||= scoped_callbacks
+    end
+
+    def around_hooks
+      @around_hooks ||= scoped_callbacks
+    end
+
+    private
+    def scoped_callbacks
+      Hash.new {|h,k| h[k] = []}
+    end
+  end
+
+  private
+  def with_hooks(method)
+    method = method.to_s
+
+    run_hooks self.class.around_hooks[method]
+    run_hooks self.class.before_hooks[method]
+    yield
+    run_hooks self.class.after_hooks[method]
+    run_hooks self.class.around_hooks[method]
+
+    nil
+  end
+
+  def run_hooks(hooks)
+    hooks.each {|hook| hook.call self}
+  end
+end

data/readme.markdown

@@ -0,0 +1,94 @@
+# Hook
+
+A simple API for adding before, after, and around callbacks to methods.
+
+Think of it as `ActiveSupport::Callbacks`Lite.
+
+## Installation
+
+It's a gem. Install it:
+    
+    $ gem install hook
+
+Or add it to your Gemfile:
+    
+    gem "hook"
+
+## Usage
+
+Imagine you've created a testing framework, and it includes a `Test`
+class with an `execute` method:
+
+```ruby
+class Test
+  #...
+  def execute
+    #...
+  end
+end
+```
+
+You'll likely want to offer hooks into the execution lifecycle of your
+tests. First, include `Hook` into your class, then call `hook :execute`:
+
+```ruby
+class Test
+  include ::Hook
+  hook :execute
+end
+```
+
+Next, you'll need to wrap the body of the `execute` method with a call
+to `with_hooks(:execute)`:
+
+```ruby
+class Test
+  include ::Hook
+  hook :execute
+
+  def execute
+    with_hooks :execute do
+      #...
+    end
+  end
+end
+```
+
+Now, **anyone can hook into the lifecycle of a test**:
+
+```ruby
+Test.before_execute do |test|
+  #...
+end
+
+Test.after_execute do |test|
+  #...
+end
+
+Test.around_execute do |test|
+  #...
+end 
+```
+
+Notice that our blocks accepted a `test` parameter. This is an instance
+of the `Test` object that `execute` was called on.
+
+Basically, whenever anyone calls the `execute` method on a test
+instance, here's what happens:
+
+    around execute hooks run
+    before execute hooks run
+    execute method runs
+    after execute hooks run
+    around execute hooks run
+
+
+##LICENSE
+
+This software is public domain. Since I've relinquished copyright, you can do anything with it. GO WILD.
+
+##Contributing
+
+Submit a pull request. Tests required. Also, by submitting a pull
+request, you are relinquishing your copyright over your contribution and
+submitting it to the public domain.

data/specdown/readme.specdown

@@ -0,0 +1,47 @@
+Hook Details
+============================================
+
+
+anyone can hook into the lifecycle of a test
+--------------------------------------------
+
+You can create before hooks that execute before a test is executed:
+    
+    before = false
+
+    Test.before_execute do |test|
+      before = true
+    end
+
+    Test.new.execute
+
+    before.should be(true)
+
+You can create after hooks that execute after a test is execute:
+
+    after = false
+
+    Test.after_execute do |test|
+      after = true
+    end
+
+    Test.new.execute
+
+    after.should be(true)
+
+And lastly, you can create around hooks that execute before _and_ after
+a test executes:
+
+    around = nil
+
+    Test.around_execute do |test|
+      if around.nil?
+        around = "before"
+      else
+        around = "after"
+      end
+    end
+
+    Test.new.execute
+
+    around.should == "after"

data/specdown/support/env.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift './lib'
+
+require 'hook'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hook
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 0
-  - 0
-  version: 0.0.0
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Matt Parker
@@ -15,10 +15,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-04 00:00:00 Z
-dependencies: []
-
-description: A system for creating view hooks.
+date: 2012-01-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: specdown
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: -726738688
+        segments: 
+        - 0
+        - 4
+        - 0
+        - beta
+        - 1
+        version: 0.4.0.beta.1
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: 
 email: moonmaster9000@gmail.com
 executables: []
 
@@ -26,8 +57,11 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- lib/hook.rb
+- readme.markdown
+- specdown/readme.specdown
+- specdown/support/env.rb
 homepage: http://github.com/moonmaster9000/hook
 licenses: []
 
@@ -60,6 +94,7 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Add view hooks to your engines.
-test_files: []
-
+summary: A simple, lightweight system for adding lifecycle callbacks to your objects.
+test_files: 
+- specdown/readme.specdown
+- specdown/support/env.rb