ruby-hooks 0.0.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ODYxMWI5M2UwZTAzMDQxNzVhYThkMWVhMGIzNzU2ZDdkMjAxMzkxNQ==
-  data.tar.gz: !binary |-
-    MWVjYTA2ZDI4ODY2YWVmNDY2NGNjNDQ5MjJkMDZjN2I3NjgzYjE3OQ==
+SHA1:
+  metadata.gz: faf3e81331151394f1e31790f945f67194a4477d
+  data.tar.gz: 76c02d07f7f8bbe97b04fb29b2f03bab744dd827
 SHA512:
-  metadata.gz: !binary |-
-    YjY4NWYzOTc3NDc5N2Q0N2RjNTdkNmFmZDQyYTMwYTFkZTZlMmM2MTljNzYw
-    ZmVjNzljMjg3NGY3YjFjYjZjNTZlOTFmOGE1NTAyMzVlOWNmNWVkYzIyY2Zi
-    M2YwMjY2MTRhZTI1Y2Q2Y2FlOGViMGMzMDJmZmI2NjVjMWFlZGM=
-  data.tar.gz: !binary |-
-    YWI1NmQzYzJmZTk5N2IxNWIyODQ5NWYzZmJiY2IxMmI1YzdlNTgzMDI4MWQ3
-    ODdlMjFjNDE0YTBiOGMzODE3NTE1ZjllMWJjMWFjNzY2MTc1NGQ3OTcwNzFi
-    NDQwNTUxNzIxMjY5MmEwODdiNGI5M2MwNDIyNGQwNDE3NzJkNzI=
+  metadata.gz: 42d819cf30ef2957b783dfb9fb1a7b29e5c0c66ac3cfabe7bc7810f506d613f56c00e8da885b27db437f73635ed77292a461b4656470f336612e371df23072c0
+  data.tar.gz: 06ec442741c9e8d95221724f2af93dccc9b5b56e4a9579ff35054db4be822ce1c0c6258d0ad64c506582576d782cd79edff49222081b8432206a5206fe5ecd08

data/lib/ruby/hooks.rb

@@ -0,0 +1,8 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require "ruby/hooks/version"
+require "ruby/hooks/instance_hooks"

data/lib/ruby/hooks/extensible.rb

@@ -0,0 +1,23 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+# Allow extending object with plugins(modules)
+module Ruby::Hooks::Extensible
+
+  # handle single parameters as well as arrays of params
+  # @param method  [Symbol] name of the method to call
+  # @param plugins [Array]  call method for every element of array
+  # @param plugins [Object] call method for the object
+  # @returns :nodoc: - unperdictable
+  def add_plugins(method, plugins = nil)
+    case plugins
+    when Array then plugins.each { |plugin| send(method, plugin) }
+    when nil   then true
+    else            send(method, plugins)
+    end
+  end
+
+end

data/lib/ruby/hooks/hook.rb

@@ -0,0 +1,28 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require "observer"
+require "ruby/hooks/extensible"
+
+# Wrapper for Observable module
+class Ruby::Hooks::Hook
+  include Observable
+  include ::Ruby::Hooks::Extensible
+
+  # automatically extends Hook instance with given modules
+  # @option options [Array]  :extend array of modules to extend hook instance
+  # @option options [Module] :extend module to extend hook instance
+  def initialize(options = {})
+    @options = options
+    add_plugins( :extend, options[:extends])
+  end
+
+  # allow writign code independent of the internals of Observable
+  def observers
+    @observer_peers
+  end
+
+end

data/lib/ruby/hooks/instance_hooks.rb

@@ -0,0 +1,30 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require "ruby/hooks/hook"
+
+# Helper to add multiple instance hooks
+module Ruby::Hooks::InstanceHooks
+
+  # define instance hook method, it gives easy acces to Hook and
+  # it's methods
+  #
+  # @param  name    [Symbol] name of the hook handling method to define
+  # @param  options [Hash]   optional settigns for hook
+  # @option options [Module] :extends - the module to extend hook instance
+  # @return [Method or Symbol] exactly what method definition would return
+  def define_hook(name, options = {})
+    define_method(name) do
+      if hook = instance_variable_get(:"@#{name}")
+      then return hook
+      end
+      hook = Ruby::Hooks::Hook.new(options)
+      instance_variable_set(:"@#{name}", hook)
+      hook
+    end
+  end
+
+end

data/lib/ruby/hooks/version.rb

@@ -1,6 +1,14 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
 module Ruby
-  class Hooks
-    VERSION = '0.0.1'
+  # Helpers for multiple publish/subscribe hooks
+  module Hooks
+    # Rubygems version of Ruby::Hooks
+    VERSION = '1.0.0'
   end
 end
 

data/test/example1_test.rb

@@ -0,0 +1,48 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require 'test_helper'
+require 'ruby/hooks'
+
+class Test1
+  extend Ruby::Hooks::InstanceHooks
+  define_hook(:my_event_one)
+end
+
+class Observer1
+  attr_accessor :result
+  def update(x)
+    @result = x
+  end
+end
+
+class Observer2
+  attr_accessor :result
+  def log(x)
+    @result = x
+  end
+end
+
+describe Ruby::Hooks::Extensible do
+  subject do
+    Test1.new
+  end
+
+  before do
+    @object1 = Observer1.new
+    @object2 = Observer2.new
+  end
+
+  it "uses extended method to find single observer" do
+    subject.my_event_one.add_observer(@object1)
+    subject.my_event_one.add_observer(@object2, :log)
+    subject.my_event_one.changed
+    subject.my_event_one.notify_observers("msg")
+    @object1.result.must_equal("msg")
+    @object2.result.must_equal("msg")
+  end
+
+end

data/test/example2_test.rb

@@ -0,0 +1,63 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require 'test_helper'
+require 'ruby/hooks'
+
+module FindObserver
+  def find_observer(*arg)
+    result = nil
+    if changed?
+      if observers
+        result =
+        observers.find do |k, v|
+          k.send v, *arg
+        end
+      end
+      changed(false)
+    end
+    result and result.first
+  end
+end
+
+class Test2
+  extend Ruby::Hooks::InstanceHooks
+  define_hook(:my_event_two, :extends => FindObserver)
+end
+
+class Observer3
+  def test_me(x)
+    x == 3
+  end
+end
+
+class Observer4
+  def test_me(x)
+    x == 4
+  end
+end
+
+describe Ruby::Hooks::Extensible do
+  subject do
+    Test2.new
+  end
+
+  it "uses extended method to find single observer" do
+    subject.my_event_two.add_observer(Observer3.new, :test_me)
+    subject.my_event_two.add_observer(Observer4.new, :test_me)
+    subject.my_event_two.methods.map(&:to_sym).must_include :find_observer
+    subject.my_event_two.changed
+    subject.my_event_two.changed?.must_equal true
+    subject.my_event_two.find_observer(1).must_be_nil
+    subject.my_event_two.changed?.must_equal false
+    subject.my_event_two.changed
+    subject.my_event_two.find_observer(3).must_be_instance_of(Observer3)
+    subject.my_event_two.changed
+    subject.my_event_two.find_observer(4).must_be_instance_of(Observer4)
+    subject.my_event_two.find_observer(4).must_be_nil
+  end
+
+end

data/test/ruby/hooks/extensible_test.rb

@@ -0,0 +1,58 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require 'test_helper'
+require 'ruby/hooks/extensible'
+
+class ExtensibleTestClass
+  include Ruby::Hooks::Extensible
+  attr_reader :calls
+  def initialize
+    @calls = []
+  end
+  def count(name)
+    @calls << name
+  end
+  module Extra
+    def method_1
+    end
+  end
+  module Test1
+  end
+  module Test2
+  end
+  module Test3
+  end
+end
+
+describe Ruby::Hooks::Extensible do
+  subject do
+    ExtensibleTestClass.new
+  end
+
+  it "extends self" do
+    subject.methods.map(&:to_sym).wont_include :method_1
+    subject.add_plugins :extend, ExtensibleTestClass::Extra
+    subject.methods.map(&:to_sym).must_include :method_1
+    subject.calls.must_be_empty
+  end
+
+  it "calls single element" do
+    subject.add_plugins :count, ExtensibleTestClass::Test1
+    subject.calls.must_equal [ExtensibleTestClass::Test1]
+  end
+
+  it "calls each element" do
+    subject.add_plugins :count, [ExtensibleTestClass::Test1, ExtensibleTestClass::Test2, ExtensibleTestClass::Test3]
+    subject.calls.must_equal [ExtensibleTestClass::Test1, ExtensibleTestClass::Test2, ExtensibleTestClass::Test3]
+  end
+
+  it "calls nothing" do
+    subject.add_plugins :count
+    subject.calls.must_equal []
+  end
+
+end

data/test/ruby/hooks/hook_test.rb

@@ -0,0 +1,29 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require 'test_helper'
+require 'ruby/hooks/hook'
+
+class HookTestClass
+  module Extra
+    def method_2
+    end
+  end
+end
+
+describe Ruby::Hooks::Hook do
+  subject do
+    Ruby::Hooks::Hook.allocate
+  end
+
+  it "extends self" do
+    subject.must_be_kind_of(Observable)
+    subject.methods.map(&:to_sym).wont_include :method_2
+    subject.send :initialize, :extends => HookTestClass::Extra
+    subject.methods.map(&:to_sym).must_include :method_2
+  end
+
+end

data/test/ruby/hooks/instance_hooks_test.rb

@@ -0,0 +1,35 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require 'test_helper'
+require 'ruby/hooks/instance_hooks'
+
+class InstanceHooksTestClass
+  module Extra
+    def method3
+    end
+  end
+  extend Ruby::Hooks::InstanceHooks
+  define_hook(:test1)
+  define_hook(:test2, :extends => Extra)
+end
+
+describe Ruby::Hooks::Extensible do
+  subject do
+    InstanceHooksTestClass.new
+  end
+
+  it "defines and extends hooks" do
+    subject.methods.map(&:to_sym).must_include :test1
+    subject.methods.map(&:to_sym).must_include :test2
+    subject.test2.methods.map(&:to_sym).must_include :method3
+  end
+
+  it "reuses existing hook" do
+    subject.test2.must_equal subject.test2
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require 'rubygems'
+
+if
+  RUBY_VERSION == "2.0.0" && # check Gemfile
+  $0 != "-e" # do not do that in guard
+then
+  require "coveralls"
+  require "simplecov"
+
+  SimpleCov.start do
+    formatter SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      Coveralls::SimpleCov::Formatter,
+    ]
+    command_name "Unit Tests"
+    add_filter "/test/"
+  end
+
+  Coveralls.noisy = true unless ENV['CI']
+end
+
+# Autoload all lib/**/*.rb files so simplecov does not misses anything
+Dir[File.expand_path("../../lib/**/*.rb", __FILE__)].each{|f| require f }
+
+require 'minitest/autorun' unless $0=="-e" # skip in guard
+require 'minitest/unit'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-hooks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Michal Papis
@@ -14,14 +14,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Helpers for multiple publish/subscribe hooks
@@ -31,7 +45,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/ruby/hooks.rb
+- lib/ruby/hooks/extensible.rb
+- lib/ruby/hooks/hook.rb
+- lib/ruby/hooks/instance_hooks.rb
 - lib/ruby/hooks/version.rb
+- test/example1_test.rb
+- test/example2_test.rb
+- test/ruby/hooks/extensible_test.rb
+- test/ruby/hooks/hook_test.rb
+- test/ruby/hooks/instance_hooks_test.rb
+- test/test_helper.rb
 homepage: https://github.com/remote-exec/ruby-hooks
 licenses:
 - MIT
@@ -42,18 +66,25 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Helpers for multiple publish/subscribe hooks
-test_files: []
+test_files:
+- test/ruby/hooks/extensible_test.rb
+- test/ruby/hooks/hook_test.rb
+- test/ruby/hooks/instance_hooks_test.rb
+- test/test_helper.rb
+- test/example2_test.rb
+- test/example1_test.rb
+has_rdoc: