hookem 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-remote'
+  gem 'pry-doc'
+  gem 'pry-nav'
+  gem 'pry-buffers'
+  gem 'pry-syntax-hacks'
+  gem 'pry-git', :platform => :mri
+  gem 'jist'
+  gem 'ruby18_source_location', :platform => :mri_18
+
+  gem 'zeevex_concurrency', :path => '/Users/Shared/zeevex/src/github/zeevex_concurrency'
+end
+
+# Specify your gem's dependencies in hookem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Robert Sanders
+
+MIT License
+
+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

@@ -0,0 +1,29 @@
+# Hookem
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hookem'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hookem
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hookem.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hookem/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hookem"
+  gem.version       = Hookem::VERSION
+  gem.authors       = ["Robert Sanders"]
+  gem.email         = ["robert@zeevex.com"]
+  gem.description   = %q{An implementation of named callback hooks for objects}
+  gem.summary       = %q{Sort of like observable, only without the 'changed' semantics and supporting multiple named hooks}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec', '~> 2.9.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+
+end

data/lib/hookem.rb

@@ -0,0 +1,104 @@
+require 'hookem/version'
+
+module Hookem
+  HookCallable = Struct.new(:identifier, :callable, :eventloop, :preargs) do
+    def initialize(hash)
+      super(*hash.values_at(*self.class.members.map(&:to_sym)) )
+      self.preargs    ||= []
+      self.identifier ||= self.__id__
+    end
+
+    def call(*args)
+      if eventloop
+        eventloop.enqueue do
+          _execute(*args)
+        end
+      else
+        _execute(*args)
+      end
+    end
+
+    protected
+
+    def _execute(*args)
+      arglist = Array(preargs) + Array(args)
+      callable.call(*arglist)
+    end
+  end
+
+  def _initialize_hook_module
+    unless @_hook_module_initialized
+      @hooks          = {}
+      @hook_observers = []
+      @_hook_module_initialized = true
+    end
+  end
+
+  def self.logger
+    @_hookem_logger ||= HookemNullObject.new
+  end
+
+  def run_hook(hook_name, *args)
+    hook_name = hook_name.to_sym
+    Hookem.logger.debug "<running hook #{hook_name}(#{args.inspect})>"
+    if @hooks && @hooks[hook_name]
+      Array(@hooks[hook_name]).each do |hook|
+        hook.call(self, *args)
+      end
+    end
+    Array(@hook_observers).each do |observer|
+      observer.call(hook_name, self, *args)
+    end
+  end
+
+  #
+  # Takes a hash of hook_name_symbol => hooklist
+  # hooklist can be a single proc or array of procs
+  #
+  def add_hooks(hookmap, options = {})
+    hookmap.each do |(name, val)|
+      Array(val).each do |hook|
+        add_hook name.to_sym, hook, options
+      end
+    end
+  end
+
+  def add_hook(hook_name, observer = nil, options = {}, &block)
+    @hooks[hook_name] ||= []
+    hook = _make_observer(observer || block, options)
+    @hooks[hook_name] << hook
+    hook.identifier
+  end
+
+  def add_hook_observer(observer = nil, options={}, &block)
+    hook = _make_observer(observer || block, options)
+    @hook_observers << hook
+    hook.identifier
+  end
+
+  def remove_hook(hook_name, identifier)
+    return unless @hooks[hook_name]
+    @hooks[hook_name].reject! {|hook| hook.identifier == identifier }
+  end
+
+  def remove_hook_observer(identifier)
+    @hook_observers.reject! {|hook| hook.identifier == identifier }
+  end
+
+  def use_run_loop_for_hooks(runloop)
+    @hook_run_loop = runloop
+  end
+
+  def _make_observer(callable, options = {})
+    raise ArgumentError, "Must provide callable or block" if callable.nil?
+    HookCallable.new({:eventloop => @hook_run_loop}.
+                         merge(options).
+                         merge(:callable => callable)).freeze
+  end
+
+  class HookemNullObject
+    def method_missing(*args, &block)
+      nil
+    end
+  end
+end

data/lib/hookem/version.rb

@@ -0,0 +1,3 @@
+module Hookem
+  VERSION = "0.0.1"
+end

data/spec/hooks_spec.rb

@@ -0,0 +1,189 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'zeevex_concurrency/event_loop'
+
+describe Hookem do
+  class HookableClass
+    include Hookem
+
+    def initialize
+      _initialize_hook_module
+    end
+  end
+
+  let :loop do
+    ZeevexConcurrency::EventLoop.new
+  end
+  before do
+    loop.start
+  end
+
+  subject { HookableClass.new }
+
+  let :receiver do
+    Object.new
+  end
+
+  context 'argument checking' do
+    it 'should require a callable or block' do
+      expect { subject.add_hook(:foo, nil) }.
+        to raise_error(ArgumentError)
+    end
+
+    it 'should accept a proc' do
+      expect { subject.add_hook(:foo, Proc.new {}) }.
+        not_to raise_error(ArgumentError)
+    end
+
+    it 'should accept a block' do
+      expect {
+        subject.add_hook(:foo) do
+          1
+        end
+      }.not_to raise_error(ArgumentError)
+    end
+  end
+
+  context 'basic hook usage' do
+    it 'should call provided proc' do
+      receiver.should_receive(:process)
+      subject.add_hook(:foo, Proc.new {receiver.process})
+      subject.run_hook :foo
+    end
+
+    it 'should call provided block' do
+      receiver.should_receive(:process)
+      subject.add_hook(:foo) do |obj|
+        receiver.process
+      end
+      subject.run_hook :foo
+    end
+
+    it 'should invoke call if handed a non-Proc callable' do
+      receiver.should_receive(:call).with(subject, 50)
+      subject.add_hook(:foo, receiver)
+      subject.run_hook :foo, 50
+    end
+
+    it 'should allow hook to be removed' do
+      receiver.should_not_receive(:call)
+      identifier = subject.add_hook(:foo, receiver)
+      subject.remove_hook(:foo, identifier)
+      subject.run_hook :foo, 50
+    end
+
+    it 'should return identifier for a hook' do
+      subject.add_hook(:foo, receiver).should_not be_nil
+    end
+
+    it 'should return number identifier for an unnamed hook' do
+      subject.add_hook(:foo, receiver).should be_a(Numeric)
+    end
+
+    it 'should return unique identifier for each hook added' do
+      subject.add_hook(:foo, receiver).should_not ==
+          subject.add_hook(:foo, receiver)
+    end
+
+    it 'should return user-provided identifier' do
+      subject.add_hook(:foo, receiver, :identifier => "foobarbaz").should == "foobarbaz"
+    end
+
+    it 'should allow hook to be removed by user-provided identifier' do
+      receiver.should_not_receive(:call)
+      subject.add_hook(:foo, receiver, :identifier => "foobarbaz")
+      subject.remove_hook(:foo, "foobarbaz")
+      subject.run_hook :foo, 50
+    end
+
+    it 'should allow multiple hooks to be added and run with a given identifier' do
+      receiver.should_receive(:call).twice
+      subject.add_hook(:foo, receiver, :identifier => "foobarbaz")
+      subject.add_hook(:foo, receiver, :identifier => "foobarbaz")
+      subject.run_hook :foo, 50
+    end
+
+    it 'should allow all hooks with a given identifier to be removed at once' do
+      receiver.should_not_receive(:call)
+      subject.add_hook(:foo, receiver, :identifier => "foobarbaz")
+      subject.add_hook(:foo, receiver, :identifier => "foobarbaz")
+      subject.remove_hook(:foo, "foobarbaz")
+      subject.run_hook :foo, 50
+    end
+  end
+
+  context 'observers' do
+    it "should call provided proc" do
+      receiver.should_receive(:process).with(:foo, subject)
+      subject.add_hook_observer(Proc.new { |*args| receiver.process(*args) })
+      subject.run_hook :foo
+    end
+
+    it "should call provided block" do
+      receiver.should_receive(:process)
+      subject.add_hook_observer do |*args|
+        receiver.process(*args)
+      end
+      subject.run_hook :foo
+    end
+
+    it "should invoke call if handed a non-Proc callable" do
+      receiver.should_receive(:call).with(:foo, subject, 50)
+      subject.add_hook_observer(receiver)
+      subject.run_hook :foo, 50
+    end
+
+    it "should allow observer to be removed" do
+      receiver.should_not_receive(:call)
+      identifier = subject.add_hook_observer(receiver)
+      subject.remove_hook_observer(identifier)
+      subject.run_hook :foo, 50
+    end
+  end
+
+  context 'event loops' do
+    before do
+      loop.should_receive(:enqueue)
+    end
+
+    context 'single hook listeners' do
+      it 'should enqueue on object-wide loop if present' do
+        subject.use_run_loop_for_hooks(loop)
+        subject.add_hook(:foo, Proc.new {})
+        subject.run_hook :foo
+      end
+
+      it 'should enqueue on provided loop in options' do
+        subject.add_hook(:foo, Proc.new {}, :eventloop => loop)
+        subject.run_hook :foo
+      end
+
+      it 'should enqueue on provided loop in options even if object-wide loop provided' do
+        subject.use_run_loop_for_hooks(Object.new)
+        subject.add_hook(:foo, Proc.new {}, :eventloop => loop)
+        subject.run_hook :foo
+      end
+    end
+
+    context 'observers' do
+      it 'should enqueue on object-wide loop if present' do
+        subject.use_run_loop_for_hooks(loop)
+        subject.add_hook_observer(Proc.new {})
+        subject.run_hook :foo
+      end
+
+      it 'should enqueue on provided loop in options' do
+        subject.add_hook_observer(Proc.new {}, :eventloop => loop)
+        subject.run_hook :foo
+      end
+
+      it 'should enqueue on provided loop in options even if object-wide loop provided' do
+        subject.use_run_loop_for_hooks(Object.new)
+        subject.add_hook_observer(Proc.new {}, :eventloop => loop)
+        subject.run_hook :foo
+      end
+    end
+  end
+
+  context 'with pre-args'
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+
+$: << File.expand_path(File.dirname(__FILE__) + '../lib')
+require 'hookem'
+
+require 'pry'
+require 'timeout'
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: hookem
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Robert Sanders
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.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: An implementation of named callback hooks for objects
+email:
+- robert@zeevex.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hookem.gemspec
+- lib/hookem.rb
+- lib/hookem/version.rb
+- spec/hooks_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1179403147378795576
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1179403147378795576
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sort of like observable, only without the 'changed' semantics and supporting
+  multiple named hooks
+test_files:
+- spec/hooks_spec.rb
+- spec/spec_helper.rb
+has_rdoc: