abstractivator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a6548a23dbbb3727663ad80929bb8a10f30abe2
-  data.tar.gz: 739a8d584e2c49765477507abfdbae0f1060c16a
+  metadata.gz: f0f97f449a6f91eaac8ae39f200348648279e81e
+  data.tar.gz: 13f4f30033ab6cd63d57d837cbea7250ae5e183d
 SHA512:
-  metadata.gz: 0e621bd42c5d2d7d6a3607ba27e1ffdc76f5889408d48cc4f43b20db5bc6c5f929b810a4cb658fb897ebb4d475dc42112c8e93f0b48a6920d5347f68f26259f0
-  data.tar.gz: d39b5ed89186aa413261018dace9671357abd4a01a2e423322191868682da45f5a74fd830343fac56f29590a0ef064ecc7c3ee017747febd23738ba261303728
+  metadata.gz: 3b9565dcf535296a0c0434e3fadc2409a82ca5b8991193b6f5dfec81d3e0c17bb420c59546bedbb6df1ded02ba731e310eaefdcfdd49bb9d5c331c5435d42293
+  data.tar.gz: 642b58f09048ce0c2897c8b6a43dd4ed28db10380e6d9754c1cbf14792351f78e7ae536e459d82aa7c707385713bfd3268a960046bb35f74ec493eddde624047

data/README.md

@@ -1,6 +1,6 @@
 # Abstractivator
 
-TODO: Write a gem description
+A collection of useful ruby code
 
 ## Installation
 
@@ -18,12 +18,4 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/abstractivator/fork )
-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 a new Pull Request
+See specs for examples.

data/Rakefile

@@ -1,2 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/abstractivator/event.rb

@@ -0,0 +1,31 @@
+module Abstractivator
+  module Event
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    module ClassMethods
+      def event(*names)
+        names.each do |name|
+          define_method("on_#{name}") do |&block|
+            __event_hooks[name] << block
+            proc { __event_hooks[name].delete(block) }
+          end
+
+          define_method("do_#{name}") do |*args, **kws, &block|
+            __event_hooks[name].each do |hook|
+              if hook.parameters.map(&:first).include?(:key)
+                hook.call(*args, **kws, &block)
+              else
+                hook.call(*args, &block)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def __event_hooks
+      @__event_hooks ||= Hash.new { |h, k| h[k] = [] }
+    end
+  end
+end

data/lib/abstractivator/version.rb

@@ -1,3 +1,3 @@
 module Abstractivator
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/lib/abstractivator/event_spec.rb

@@ -0,0 +1,95 @@
+require 'rspec'
+require 'abstractivator/event'
+
+describe Abstractivator::Event do
+
+  class EventedObject
+    include Abstractivator::Event
+    event :arrived, :departed
+  end
+
+  subject { EventedObject.new }
+
+  describe 'the "do" method' do
+    context 'when there are no hooks' do
+      it 'does nothing' do
+        subject.do_arrived
+      end
+    end
+    it 'calls the hooks in the order in which they were added' do
+      log = []
+      subject.on_arrived { log << 'hello' }
+      subject.on_arrived { log << 'hello again'}
+      expect(log).to eql []
+      subject.do_arrived
+      expect(log).to eql ['hello', 'hello again']
+    end
+    it 'passes arguments to the hooks' do
+      observed_args = nil
+      subject.on_arrived { |*args| observed_args = args }
+      subject.do_arrived(2, 3)
+      expect(observed_args).to eql [2, 3]
+    end
+    it 'passes keyword arguments to the hooks' do
+      observed_keywords = nil
+      subject.on_arrived { |a: nil, b: nil| observed_keywords = [a, b] }
+      subject.do_arrived(a: 2, b: 3)
+      expect(observed_keywords).to eql [2, 3]
+    end
+    it 'passes the block to the hooks' do
+      manifest = {1 => 'Bob', 2 => 'Fred'}
+      greeting = nil
+      subject.on_arrived { |id, &greet| greet.call(manifest[id]) }
+      subject.do_arrived(1) { |name| greeting = "Hello, #{name}" }
+      expect(greeting).to eql 'Hello, Bob'
+    end
+  end
+
+  describe 'the "on" method' do
+    it 'returns an unhook procedure' do
+      log = []
+      unhook = subject.on_arrived { log << 'hello' }
+      subject.do_arrived
+      expect(log).to eql %w(hello)
+
+      unhook.call
+      subject.do_arrived
+      expect(log).to eql %w(hello)
+    end
+  end
+
+  describe 'the unhook procedure' do
+    it 'returns the initial hook procedure' do
+      log = []
+      unhook = subject.on_arrived { log << 'hello' }
+      subject.do_arrived
+      expect(log).to eql %w(hello)
+
+      hook = unhook.call
+      subject.on_arrived(&hook)
+      subject.do_arrived
+      expect(log).to eql %w(hello hello)
+    end
+    it 'returns nil if called more than once' do
+      unhook = subject.on_arrived { log << 'hello' }
+      expect(unhook.call).to be_a Proc
+      expect(unhook.call).to be nil
+    end
+  end
+
+  it 'hooks are independent' do
+    arrived_list = []
+    departed_list = []
+    subject.on_arrived { |who| arrived_list << who }
+    subject.on_departed { |who| departed_list << who }
+
+    subject.do_arrived('Fred')
+    expect(arrived_list).to eql %w(Fred)
+    expect(departed_list).to eql []
+
+    subject.do_departed('Bob')
+    expect(arrived_list).to eql %w(Fred)
+    expect(departed_list).to eql %w(Bob)
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstractivator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Peter Winton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,7 @@ files:
 - lib/abstractivator/cons.rb
 - lib/abstractivator/enum.rb
 - lib/abstractivator/enumerable_ext.rb
+- lib/abstractivator/event.rb
 - lib/abstractivator/proc_ext.rb
 - lib/abstractivator/schedule.rb
 - lib/abstractivator/schedule/schedule.rb
@@ -116,6 +117,7 @@ files:
 - spec/lib/abstractivator/cons_spec.rb
 - spec/lib/abstractivator/enum_spec.rb
 - spec/lib/abstractivator/enumerable_ext_spec.rb
+- spec/lib/abstractivator/event_spec.rb
 - spec/lib/abstractivator/proc_ext_spec.rb
 - spec/lib/abstractivator/schedule/em_util.rb
 - spec/lib/abstractivator/schedule/schedule_runner_spec.rb
@@ -154,6 +156,7 @@ test_files:
 - spec/lib/abstractivator/cons_spec.rb
 - spec/lib/abstractivator/enum_spec.rb
 - spec/lib/abstractivator/enumerable_ext_spec.rb
+- spec/lib/abstractivator/event_spec.rb
 - spec/lib/abstractivator/proc_ext_spec.rb
 - spec/lib/abstractivator/schedule/em_util.rb
 - spec/lib/abstractivator/schedule/schedule_runner_spec.rb