ianwhite-hark 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b71c62889085f5896f266c976ae49d855d550917
+  data.tar.gz: 9f69d753ec889c9cf354b1586c68313604cbeaf3
+SHA512:
+  metadata.gz: 7c690463f3539c9b835b3ed34b09cdcaa64d642f37a51eb63f441812274888b7ee93f8f1ce40b6afa1de957b3f9056de68b7cd2860b6181d10898eca851f7425
+  data.tar.gz: f79b3613750fc960271a57091f966ea02b6b17a35f6c9d19087b35715d3b6e4ac154efc53a1390adbe6b5a6a5692fa69970d98402da2c90466c2ec0a09ff3c41

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hark.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, all_on_start: true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ian White
+
+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,69 @@
+# Hark
+
+Create an ad-hoc listener object with hark.
+
+The idea behind hark is that the objects that receive listeners shouldn't need to perform any ceremony on
+them, just treat them as objects that respond to messages.  It's up to the caller to provide these lsitener objects,
+and to decide how they behave (re: lax), perhaps smushing together listeners (re: add).  If required, these ad-hoc
+listeners can easily be refactored into classes in their own right, as the recievers don't need to know anything about
+hark.
+
+    listener = hark success: ->{ "succeeded" }, failure: ->{ "failed" }
+    listener.success # => ["succeeded"]
+    listener.failure # => ["failed"]
+    listener.unknown # raises NoMethodError
+
+Listeners return an array of return values, but using return values is discouraged (tell don't ask)
+
+To create a listener that silently swallows unknown messages, send it the #lax method
+
+    listener = hark(success: ->{ "succeeded" }).lax
+    listener.success # => ["succeeded"]
+    listener.unknown # => []
+
+To make a lax listener strict again, send it the #strict method
+
+    listener = listener.strict
+
+To smush together listeners, use #hark
+
+    listener = listener.hark other_listener
+    listener = listener.hark emailer, logger
+    listener = hark(emailer, logger, twitter_notifier)
+
+To add new messages to a listener, use #hark
+
+    listener = listener.hark(:success) { "extra success" }
+    listener.success # => ["success", "extra success"]
+
+To decorate an object (of any sort) so that it becomes a hark listener (and therefore can be smushed etc)
+
+    listener = object.to_hark
+
+The listener is immutable, #strict, #lax, and #hark all return new listeners
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ianwhite-hark'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ianwhite-hark
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/hark.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hark/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ianwhite-hark"
+  spec.version       = Hark::VERSION
+  spec.authors       = ["Ian White"]
+  spec.email         = ["ian.w.white@gmail.com"]
+  spec.description   = %q{Create ad-hoc listener objects with impunity}
+  spec.summary       = %q{Hark is a gem that enables  writing code in a 'hexagonal architecture' style}
+  spec.homepage      = "http://github.com/ianwhite/hark"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-given"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/hark/ad_hoc.rb

@@ -0,0 +1,47 @@
+module Hark
+  # AdHoc is a tiny class to facilitate creating an ad-hoc object that from either a hash or proc.
+  #
+  # Eg. from a hash:
+  #
+  #   handler = AdHoc.new(success: (o)-> { o.great_success }, failure: (o)-> { o.failed } )
+  #
+  # Eg. from a 'response' style block:
+  #
+  #   handler = AdHoc.new do |on|
+  #     on.success {|o| o.great_success }
+  #     on.failure {|o| o.failed }
+  #   end
+  #
+  # Eg. adding methods after creation
+  #
+  #   obj = AdHoc.new
+  #   obj.add_method!(:foo) { "bar" }
+  #
+  # All blocks keep their original binding.  This makes AdHoc suitable for creating
+  # ad-hoc responses from controller type objects.
+  #
+  class AdHoc
+    def self.new hash = {}, &proc
+      super().tap do |ad_hoc|
+        AddMethodsFromProc.new(proc, ad_hoc) if block_given?
+        hash.each {|method, body| ad_hoc.add_method!(method, &body) }
+      end
+    end
+
+    def add_method!(method, &body)
+      singleton_class.send(:define_method, method) {|*args, &block| body.call(*args, &block) }
+    end
+
+    class AddMethodsFromProc
+      def initialize proc, ad_hoc
+        @ad_hoc = ad_hoc
+        proc.call(self)
+      end
+
+      def method_missing method, *, &body
+        @ad_hoc.add_method!(method, &body)
+      end
+    end
+  end
+end
+

data/lib/hark/core_ext.rb

@@ -0,0 +1,9 @@
+module Kernel
+  def hark *args, &block
+    Hark.from *args, &block
+  end
+
+  def to_hark *args, &block
+    Hark.from self, *args, &block
+  end
+end

data/lib/hark/dispatcher.rb

@@ -0,0 +1,53 @@
+module Hark
+  class Dispatcher
+    #  from(:success) do
+    #    "success"
+    #  end
+    #
+    #  from(success: ->{ "success" })
+    #
+    #  from do |on|
+    #    on.success { "success" }
+    #  end
+    #
+    def self.from(*args, &block)
+      if block
+        if args.last.is_a?(Symbol)
+          args << {args.pop => block}
+        elsif args.empty?
+          args << block
+        end
+      end
+
+      new args.map{|o| to_handler(o) }.flatten.freeze
+    end
+
+    def self.to_handler object
+      case object
+      when Listener then object.dispatcher.handlers
+      when Dispatcher then object.handlers
+      when Hash then AdHoc.new(object)
+      when Proc then AdHoc.new(&object)
+      when Array then object.map{|o| to_handler(o) }
+      else object
+      end
+    end
+
+    attr_reader :handlers
+
+    def initialize handlers
+      @handlers = handlers
+      freeze
+    end
+
+    def handles? method
+      handlers.any? {|handler| handler.respond_to?(method) }
+    end
+
+    def handle method, *args, &block
+      handlers.each_with_object([]) do |handler, results|
+        results << handler.send(method, *args, &block) if handler.respond_to?(method)
+      end
+    end
+  end
+end

data/lib/hark/listener.rb

@@ -0,0 +1,53 @@
+module Hark
+  # A Listener holds a dispatcher, which it dispatches messages to
+  #
+  # A listener is by default a 'strict' listener, it will raise NoMethodError if
+  # it is sent a message it doesn't know how to handle.
+  #
+  # A listener can be turned into a 'lax' listener, by sending it the #lax message.
+  # A lax listener will silently swallow any unknown messages.
+  class Listener
+    def self.new *args, &block
+      self == Listener ? StrictListener.new(*args, &block) : super(*args, &block)
+    end
+
+    attr_reader :dispatcher
+
+    def initialize(*args, &block)
+      @dispatcher = Dispatcher.from(*args, &block)
+      freeze
+    end
+
+    def strict
+      StrictListener.new dispatcher
+    end
+
+    def lax
+      LaxListener.new dispatcher
+    end
+
+    def hark *args, &block
+      self.class.new dispatcher, *args, &block
+    end
+  end
+
+  class StrictListener < Listener
+    def respond_to_missing? method, *args
+      dispatcher.handles?(method) || super
+    end
+
+    def method_missing *args, &block
+      (results = dispatcher.handle(*args, &block)).any? ? results : super
+    end
+  end
+
+  class LaxListener < Listener
+    def respond_to_missing? *args
+      true
+    end
+
+    def method_missing *args, &block
+      dispatcher.handle(*args, &block)
+    end
+  end
+end

data/lib/hark/version.rb

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

data/lib/hark.rb

@@ -0,0 +1,11 @@
+require "hark/version"
+require "hark/ad_hoc"
+require "hark/dispatcher"
+require "hark/listener"
+require "hark/core_ext"
+
+module Hark
+  def self.from(*args, &block)
+    Listener.new(*args, &block)
+  end
+end

data/spec/hark_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'hark'
+
+describe Hark do
+  Given(:transcript) { [] }
+
+  class PlainListener < Struct.new(:transcript)
+    def success(value)
+      transcript.push [:succeeded, value]
+    end
+
+    def failure(value)
+      transcript.push [:failed, value]
+    end
+  end
+
+  shared_examples_for "a success/failure listener" do
+    describe "success" do
+      When { listener.success(42) }
+      Then { transcript == [[:succeeded, 42]] }
+    end
+
+    describe "failure" do
+      When { listener.failure(54) }
+      Then { transcript == [[:failed, 54]] }
+    end
+  end
+
+  shared_examples_for "a strict listener" do
+    Then { ! strict_listener.respond_to?(:unknown) }
+    And  { (strict_listener.unknown rescue $!).is_a?(NoMethodError) }
+  end
+
+  shared_examples_for "a lax listener" do
+    Then { lax_listener.respond_to?(:unknown) }
+    And  { lax_listener.unknown == [] }
+  end
+
+  shared_examples_for "a success/failure hark listener" do
+    it_should_behave_like "a success/failure listener"
+    it_should_behave_like "a strict listener" do
+      Given(:strict_listener) { listener }
+    end
+
+    context "when made lax" do
+      Given(:lax_listener) { listener.lax }
+      it_should_behave_like "a lax listener"
+
+      context "and made strict again" do
+        Given(:strict_listener) { lax_listener.strict }
+        it_should_behave_like "a strict listener"
+      end
+    end
+  end
+
+  describe "A plain (non hark) listener object" do
+    Given(:listener) { PlainListener.new(transcript) }
+
+    it_should_behave_like "a success/failure listener"
+    it_should_behave_like "a strict listener" do
+      Given(:strict_listener) { listener }
+    end
+  end
+
+  describe "hark with respond_to style block" do
+    Given(:listener) do
+      hark do |on|
+        on.success {|v| transcript.push [:succeeded, v] }
+        on.failure {|v| transcript.push [:failed, v] }
+      end
+    end
+
+    it_should_behave_like "a success/failure hark listener"
+  end
+
+  describe "hark with callables" do
+    Given(:listener) do
+      hark success: ->(v){ transcript.push [:succeeded, v] }, failure: ->(v){ transcript.push [:failed, v] }
+    end
+
+    it_should_behave_like "a success/failure hark listener"
+  end
+
+  describe "hark built up in steps" do
+    Given(:listener) do
+      l = hark
+      l = l.hark(:success) {|v| transcript.push [:succeeded, v] }
+      l = l.hark(:failure) {|v| transcript.push [:failed, v] }
+    end
+
+    it_should_behave_like "a success/failure hark listener"
+  end
+
+  describe "object.to_hark" do
+    Given(:listener) { PlainListener.new(transcript).to_hark }
+
+    it_should_behave_like "a success/failure hark listener"
+  end
+
+  describe "combine two listeners together" do
+    Given(:logger) { hark(:signup_user) {|user| transcript << "User #{user} signed up" } }
+    Given(:emailer) { hark(:signup_user) {|user| transcript << "Emailed #{user}" } }
+
+    Given(:listener) { logger.hark(emailer) }
+
+    When { listener.signup_user("Fred") }
+
+    Then { transcript == ["User Fred signed up", "Emailed Fred"] }
+  end
+
+  describe "lax/strict is preserved on #hark" do
+    Then { hark.lax.hark.is_a? Hark::LaxListener }
+    Then { hark.strict.hark.is_a? Hark::StrictListener }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.dirname('../lib')
+
+require 'rspec/given'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: ianwhite-hark
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ian White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  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: rspec-given
+  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: guard-rspec
+  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: Create ad-hoc listener objects with impunity
+email:
+- ian.w.white@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hark.gemspec
+- lib/hark.rb
+- lib/hark/ad_hoc.rb
+- lib/hark/core_ext.rb
+- lib/hark/dispatcher.rb
+- lib/hark/listener.rb
+- lib/hark/version.rb
+- spec/hark_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ianwhite/hark
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Hark is a gem that enables  writing code in a 'hexagonal architecture' style
+test_files:
+- spec/hark_spec.rb
+- spec/spec_helper.rb