interchange 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a484f8b2614fe9877352ed14caa807a673da3aae
+  data.tar.gz: 69469458f495d8f19e28fdda45c9c36610b1c628
+SHA512:
+  metadata.gz: 95a63d557d7abdee3e718906c8d691c396e3694f363af90ef27fe675fe2457699b80bf4e56063791d2c91014aeaa8a33cc7e6de3b60b9a9a7e03465128bdfbb7
+  data.tar.gz: bb85bf52e17436c6d6ddbb353c752c676e0c07abbd017e7ebd3d7b84082dcda5d28ccc6326d3395a8cc0c0c9c4aa04b813ec9fa089f88a7b04196fb2611f11b9

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/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+  - "jruby-19mode"
+  - "rbx-19mode"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in interchange.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ahawkins
+
+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,100 @@
+# Interchange
+
+`Interchange` is a way to define boundary objects. The class
+defines the all required methods, then delegates the work to an
+implementation. Implementations are be registered and used. A null
+implementation is automatically generated and set as the
+default implementation. This is useful in a few use cases:
+
+* SOA setups where clients must be isolated from services (EX:
+  different implementations in dev/test/production)
+* Isolating different sub-systems
+
+Here are some examples.
+
+```ruby
+class Mailer
+  include Interchange.new(:deliver, :deliveries)
+end
+
+class SMTPDelivery
+  def deliver(mail)
+    # send w/SMTP
+  end
+
+  def deliveries
+    # check the email account
+  end
+end
+
+class SnailMail
+  def deliver(mail)
+    # print the mail and go to the post office
+  end
+
+  def deliveries
+    # go outside and check the mailbox
+  end
+end
+
+mailer = Mailer.new
+mailer.register :smtp, SMTPDelivery.new
+mailer.register :snail_mail, SnailMail.new
+
+mail.use :smtp
+mail.deliver some_message
+
+mail.use :null # switch back to the null implementation.
+```
+
+These objects are useful when you have an interaction that needs
+to happen but implementations can vary widely. You can also use this
+as class if you don't like the instance flavor.
+
+```ruby
+class Mailer
+  extend Interchange.new(:foo, :bar, :bar)
+end
+
+Mailer.register, :smtp, SomeSmtpClass
+```
+
+Since `Interchange.new` returns a new module, you can call define
+methods and call `super` just like normal.
+
+```ruby
+class Mailer
+  include Interchange.new(:deliver)
+
+  def deliver(mail)
+    raise "No address" unless mail.to
+    super
+  end
+end
+```
+
+This is great when you have some shared logic at the boundary but not
+across implementations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'interchange'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interchange
+
+
+## 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,8 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+task default: :test

data/interchange.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interchange/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interchange"
+  spec.version       = Interchange::VERSION
+  spec.authors       = ["ahawkins"]
+  spec.email         = ["adam@hawkins.io"]
+  spec.description   = %q{Define interfaces for interchangable objects & interfaces}
+  spec.summary       = %q{}
+  spec.homepage      = ""
+  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"
+end

data/lib/interchange.rb

@@ -0,0 +1,117 @@
+require "interchange/version"
+
+class Interchange < Module
+  class UnregisteredError < StandardError
+    def initialize(name)
+      super "#{name} is not a registered implementation"
+    end
+  end
+
+  class ImplementationMissingError < StandardError
+    def initialize(object, method)
+      super "The #{object.class} does not respond to #{method}"
+    end
+  end
+
+  class NotAvailableError < StandardError
+    def initialize(implementation)
+      super "#{implementation} currently down"
+    end
+  end
+
+  class NullImplementation
+    def up?
+      true
+    end
+
+    def respond_to?(*args)
+      true
+    end
+
+    def method_missing(name, *args, &block)
+      args
+    end
+  end
+
+  class DownImplementation < NullImplementation
+    def up?
+      false
+    end
+  end
+
+  module Methods
+    def register(name, implementation)
+      implementations[name] = implementation
+    end
+
+    def use(name)
+      @implementation = implementations.fetch name do
+        raise UnregisteredError, name
+      end
+    end
+
+    def with(name)
+      original = implementation
+      use name
+      result = yield self
+      @implementation = original
+
+      result
+    end
+
+    def down?
+      !up?
+    end
+
+    def check
+      fail NotAvailableError, implementation unless up?
+      true
+    end
+
+    def implementations
+      @implementations ||= { }
+    end
+
+    def implementation
+      @implementation
+    end
+  end
+
+  module DefaultImplementationsForInstances
+    def initialize(*args)
+      super
+      register :null, NullImplementation.new
+      register :down, DownImplementation.new
+      use :null
+    end
+  end
+
+  def included(base)
+    base.send :include, DefaultImplementationsForInstances
+  end
+
+  def extended(klass)
+    klass.register :null, NullImplementation.new
+    klass.register :down, DownImplementation.new
+    klass.use :null
+  end
+
+  def initialize(*methods)
+    module_eval do
+      include Methods
+    end
+
+    define_delegate_method :up?
+
+    methods.each do |method|
+      define_delegate_method method
+    end
+  end
+
+  def define_delegate_method(method)
+    define_method method do |*args, &block|
+      raise ImplementationMissingError.new(implementation, method) unless implementation.respond_to? method
+      implementation.send method, *args, &block
+    end
+  end
+end

data/lib/interchange/version.rb

@@ -0,0 +1,3 @@
+class Interchange < Module
+  VERSION = "0.1.0"
+end

data/test/acceptance_test.rb

@@ -0,0 +1,166 @@
+require_relative 'test_helper'
+
+class AcceptanceTest < MiniTest::Unit::TestCase
+  def build(&block)
+    Class.new &block
+  end
+
+  def test_use_raises_an_error_if_unknown_implementation
+    service = build do
+      include Interchange.new
+    end.new
+
+    assert_raises Interchange::UnregisteredError do
+      service.use :foo
+    end
+  end
+
+  def test_raises_an_error_if_method_not_implemented
+    service = build do
+      include Interchange.new(:add)
+    end.new
+
+    implementation = Class.new
+
+    service.register :test, implementation.new
+    service.use :test
+
+    assert_raises Interchange::ImplementationMissingError do
+      service.add 1, 2
+    end
+  end
+
+  def test_delegates_work_to_selected_implementation
+    service = build do
+      include Interchange.new(:add)
+    end.new
+
+    implementation = Class.new do
+      def add(*numbers)
+        numbers.inject(&:+)
+      end
+    end
+
+    service.register :test, implementation.new
+    service.use :test
+
+    assert_equal 3, service.add(1, 2)
+  end
+
+  def test_defines_an_up_query_method
+    service = build do
+      include Interchange.new(:add)
+    end.new
+
+    implementation = Class.new do
+      def up?
+        true
+      end
+    end
+
+    service.register :test, implementation.new
+    service.use :test
+
+    assert service.up?
+    refute service.down?
+  end
+
+  def test_generates_a_null_implementation_that_returns_the_arguments_by_default
+    service = build do
+      include Interchange.new(:add)
+    end.new
+
+    assert_equal [1,2], service.add(1,2)
+  end
+
+  def test_generates_a_down_implementation
+    service = build do
+      include Interchange.new(:add)
+    end.new
+
+    service.use :down
+    assert service.down?
+  end
+
+  def test_down_implementation_works_with_extend
+    service = build do
+      extend Interchange.new(:add)
+    end
+
+    service.use :down
+    assert service.down?
+  end
+
+  def test_can_check_to_see_if_services_are_up
+    service = build do
+      include Interchange.new(:foo)
+    end.new
+
+    service.use :down
+
+    assert_raises Interchange::NotAvailableError do
+      service.check
+    end
+  end
+
+  def test_can_implement_multiple_methods_at_once
+    service = build do
+      include Interchange.new(:foo, :bar)
+    end.new
+
+    implementation = Class.new do
+      def foo
+        :foo
+      end
+
+      def bar
+        :bar
+      end
+    end
+
+    service.register :test, implementation.new
+    service.use :test
+
+    assert_equal :foo, service.foo
+    assert_equal :bar, service.bar
+  end
+
+  def test_null_implementation_works_with_extend
+    service = build do
+      extend Interchange.new(:add)
+    end
+
+    assert_equal [1,2], service.add(1,2)
+  end
+
+  def test_can_use_one_implementation_temporarily
+    implementation_a = Class.new do
+      def number
+        5
+      end
+    end.new
+
+    implementation_b = Class.new do
+      def number
+        1
+      end
+    end.new
+
+    service = build do
+      include Interchange.new(:number)
+    end.new
+
+    service.register :five, implementation_a
+    service.register :one, implementation_b
+    service.use :one
+
+    assert_equal 1, service.number
+
+    number = service.with(:five) do |service|
+      service.number
+    end
+
+    assert_equal 5, number
+    assert_equal 1, service.number
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+require 'interchange'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: interchange
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ahawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-05 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'
+description: Define interfaces for interchangable objects & interfaces
+email:
+- adam@hawkins.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- interchange.gemspec
+- lib/interchange.rb
+- lib/interchange/version.rb
+- test/acceptance_test.rb
+- test/test_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- test/acceptance_test.rb
+- test/test_helper.rb