chickadee 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bcb4cef05aca78538224ff2212092ab72bea7ca
+  data.tar.gz: e93f3c823ccf6911931b6ccf3dcf314a584bcd34
+SHA512:
+  metadata.gz: b73a763034b866983accad6d7b8b4873bf75a4d623f75d024289afc81d6fc8f39f134a2fa8e26d4df18c0333f0ba3c23de67ce7ddd6070a8ae3aa2422a04f17a
+  data.tar.gz: 5c305b328b9855a187ddaa68927630775e900fe131dcfcad1bf27e929474a1d1e7dd2d93451255999e31864febe58e49c5b502b7ee531f34b98c3ba88d94e2a2

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 chickadee.gemspec
+gemspec

data/Guardfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Erik Lott
+
+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 @@
+# Chickadee
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chickadee'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chickadee
+
+## 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/chickadee.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chickadee/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chickadee"
+  spec.version       = Chickadee::VERSION
+  spec.authors       = ["Erik Lott"]
+  spec.email         = ["erik.lott@evrium.com"]
+  spec.description   = %q{Lightweight domain driven design library}
+  spec.summary       = %q{Lightweight domain driven design library}
+  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_dependency "ioc", "~> 0.5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha", "~> 0.14.0"
+end

data/lib/chickadee/application.rb

@@ -0,0 +1,27 @@
+module Chickadee
+  class Application
+    def self.routes
+      @router ||= Router.new
+    end
+
+    def self.registry
+      @internal_registry ||= Registry.new
+    end
+
+    def initialize
+      @external_registry = Registry.new
+    end
+ 
+    def call(request)
+      container = Container.new
+      self.class.registry.update_container(container)
+      @external_registry.update_container(container)
+      output = self.class.routes.call(request.class).map{|handler| container[handler].handle(request)}.last
+      output if request.query?
+    end
+
+    def register(name, service)
+      @external_registry.register(name, service, :as => :instance)
+    end
+  end
+end

data/lib/chickadee/command.rb

@@ -0,0 +1,10 @@
+module Chickadee
+  class Command < Request
+
+    private
+
+    def request_type
+      :command
+    end
+  end
+end

data/lib/chickadee/container.rb

@@ -0,0 +1,3 @@
+module Chickadee
+  class Container < ::IOC::Container; end
+end

data/lib/chickadee/exceptions.rb

@@ -0,0 +1,4 @@
+module Chickadee
+  class ChickadeeError < StandardError; end
+  class RoutingError < ChickadeeError; end
+end

data/lib/chickadee/handler.rb

@@ -0,0 +1,7 @@
+module Chickadee
+  class Handler
+    def handle(request)
+      raise(NotImplementedError)
+    end
+  end
+end

data/lib/chickadee/query.rb

@@ -0,0 +1,10 @@
+module Chickadee
+  class Query < Request
+
+    private
+
+    def request_type
+      :query
+    end
+  end
+end

data/lib/chickadee/registry.rb

@@ -0,0 +1,19 @@
+module Chickadee
+  class Registry
+    def initialize
+      @registrants = []
+    end
+
+    def draw(&block)
+      instance_eval(&block) if block_given?
+    end
+
+    def register(*args)
+      @registrants << args
+    end
+
+    def update_container(container)
+      @registrants.each{|args| container.register(*args)}
+    end
+  end
+end

data/lib/chickadee/request.rb

@@ -0,0 +1,17 @@
+module Chickadee
+  class Request
+    def command?
+      request_type == :command
+    end
+
+    def query?
+      request_type == :query
+    end
+
+    private
+
+    def request_type
+      raise(NotImplementedError)
+    end
+  end
+end

data/lib/chickadee/router.rb

@@ -0,0 +1,78 @@
+module Chickadee
+  class Router
+    class RequestMap
+      def initialize(map = {})
+        @map = map
+      end
+
+      def call(request)
+        if @map.key?(request)
+          @map.fetch(request).call(request)
+        else
+          app = @map[:app]
+          raise(RoutingError, 'missing run statement') unless app
+          app.call(request)
+        end
+      end
+    end
+
+    class Middleware
+      def initialize(app, handler)
+        @app = app
+        @handler = handler
+      end
+
+      def call(request)
+        @app.call(request).unshift(@handler)
+      end
+    end
+    
+    def initialize(default_app = nil, &block)
+      @run = default_app
+      @use = []
+      @map = nil
+      instance_eval(&block) if block_given?
+    end
+
+    def draw(&block)
+      instance_eval(&block) if block_given?
+    end
+
+    def use(handler, &block)
+      if @map
+        mapping = @map
+        @map = nil
+        @use << proc { |app| generate_map(app, mapping) }
+      end
+      @use << proc { |app| Middleware.new(app, handler, &block) }
+    end
+
+    def run(handler)
+      @run = proc{|request| [handler]}
+    end
+
+    def map(method_name, &block)
+      @map ||= {}
+      @map[method_name] = block
+    end
+
+    def to_app
+      app = @map ? generate_map(@run, @map) : @run
+      raise(RoutingError, 'missing run or map statement') unless app
+      app = @use.reverse.inject(app) { |a,e| e[a] }
+      app
+    end
+
+    def call(request)
+      to_app.call(request)
+    end
+
+    private
+
+    def generate_map(default_app, mapping)
+      mapped = default_app ? {:app => default_app} : {}
+      mapping.each { |r,b| mapped[r] = self.class.new(default_app, &b) }
+      RequestMap.new(mapped)
+    end
+  end
+end

data/lib/chickadee/version.rb

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

data/lib/chickadee.rb

@@ -0,0 +1,14 @@
+require 'ioc'
+require 'chickadee/version'
+require 'chickadee/exceptions'
+require 'chickadee/container'
+require 'chickadee/router'
+require 'chickadee/request'
+require 'chickadee/query'
+require 'chickadee/command'
+require 'chickadee/handler'
+require 'chickadee/registry'
+require 'chickadee/application'
+
+module Chickadee
+end

data/spec/chickadee_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+require 'chickadee'
+
+describe Chickadee do
+
+  class TestCommand1 < Chickadee::Command
+    attr_accessor :name
+  end
+
+  class TestQuery1 < Chickadee::Query
+    attr_accessor :name
+  end
+
+  class TestHandler1 < Chickadee::Handler
+    def handle(command)
+      "hander1 says: #{command.name}"
+    end
+  end
+
+  class TestHandler2 < Chickadee::Handler
+    def handle(command)
+      "hander2 says: #{command.name}"
+    end
+  end
+
+  context 'when command request' do
+    it 'returns nil from command' do
+      app_class = new_app_class
+      app_class.routes.draw do
+        map(TestCommand1) do
+          run :handler1
+        end
+      end
+      app_class.registry.draw do
+        register(:handler1, TestHandler1)
+      end
+
+      app = app_class.new
+      command = TestCommand1.new
+      command.name = 'Chuck Norris'
+      app.call(command).must_be_nil
+    end
+
+    it 'executes handler chain' do
+      app_class = new_app_class
+
+      handler1 = TestHandler1.new
+      handler2 = TestHandler2.new
+
+      app_class.routes.draw do
+        map(TestCommand1) do
+          use :handler1
+          run :handler2
+        end
+      end
+
+      app_class.registry.draw do
+        register(:handler1, handler1, :as => :instance)
+        register(:handler2, handler2, :as => :instance)
+      end
+
+      app = app_class.new
+      command = TestCommand1.new
+
+      handler1.expects(:handle).with(command)
+      handler2.expects(:handle).with(command)
+
+      app.call(command)
+    end
+  end
+
+  context 'when query request' do
+    it 'returns output from last handler in handler chain' do
+      app_class = new_app_class
+
+      handler1 = TestHandler1.new
+      handler2 = TestHandler2.new
+
+      app_class.routes.draw do
+        map(TestQuery1) do
+          use :handler1
+          run :handler2
+        end
+      end
+
+      app_class.registry.draw do
+        register(:handler1, handler1, :as => :instance)
+        register(:handler2, handler2, :as => :instance)
+      end
+
+      app = app_class.new
+      query = TestQuery1.new
+      query.name = 'Chuck Norris'
+      app.call(query).must_equal('hander2 says: Chuck Norris')
+    end
+
+    it 'executes handler chain' do
+      app_class = new_app_class
+
+      handler1 = TestHandler1.new
+      handler2 = TestHandler2.new
+
+      app_class.routes.draw do
+        map(TestQuery1) do
+          use :handler1
+          run :handler2
+        end
+      end
+
+      app_class.registry.draw do
+        register(:handler1, handler1, :as => :instance)
+        register(:handler2, handler2, :as => :instance)
+      end
+
+      app = app_class.new
+      query = TestQuery1.new
+
+      handler1.expects(:handle).with(query)
+      handler2.expects(:handle).with(query)
+
+      app.call(query)
+    end
+  end
+
+  def new_app_class
+    Class.new(Chickadee::Application)
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'chickadee'
+
+describe Chickadee::Command do
+  it { new_query.query?.must_equal(false) }
+  it { new_query.command?.must_equal(true) }
+
+  def new_query
+    Chickadee::Command.new
+  end
+end

data/spec/query_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'chickadee'
+
+describe Chickadee::Query do
+  it { new_query.query?.must_equal(true) }
+  it { new_query.command?.must_equal(false) }
+
+  def new_query
+    Chickadee::Query.new
+  end
+end

data/spec/registry_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'chickadee'
+
+describe Chickadee::Registry do
+  describe '#update_container' do
+    it 'updates container with registered services' do
+      registry = new_registry
+      service = stub
+      container = new_container
+
+      registry.register(:myservice, service, :as => :instance)
+      registry.update_container(container)
+      container.resolve(:myservice).must_equal(service)
+    end
+  end
+
+  describe '#draw' do
+    it 'can register with block' do
+      registry = new_registry
+      service = stub
+
+      registry.draw do
+        register(:service, service)
+      end
+
+      registry.instance_variable_get(:@registrants).must_equal([[:service, service]])
+    end
+  end
+
+  def new_registry
+    Chickadee::Registry.new
+  end
+
+  def new_container
+    Chickadee::Container.new
+  end
+end

data/spec/router_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require 'chickadee'
+
+describe Chickadee::Router do
+  it 'chains handlers' do
+    request = stub
+
+    app = builder do
+      use :handler1
+      run :handler2
+    end
+
+    app.call(request).must_equal([:handler1, :handler2])
+  end
+
+  it 'supports use after run' do
+    request = stub
+    app = builder do
+      use :handler1
+      run :handler2
+      use :handler3
+    end
+    
+    app.call(request).must_equal([:handler1, :handler3, :handler2])
+  end
+
+  it 'complains when there is no run' do
+    request = stub
+    app = builder do
+      use :handler1
+    end
+    
+    proc { app.call(request) }.must_raise(Chickadee::RoutingError)
+  end
+
+  it 'supports mapping' do
+    request = stub
+    app = builder do
+      map(request) do
+        use :handler1
+        run :handler2
+      end
+    end
+
+    app.call(request).must_equal([:handler1, :handler2])
+  end
+
+  it 'complains when there is no run with mapping' do
+    request = stub
+    app = builder do
+      use :handler1
+      map(request) do
+        use :handler2
+      end
+    end
+
+    proc { app.call(request) }.must_raise(Chickadee::RoutingError)
+  end
+
+  it 'correctly maps complex senario' do
+    request1 = stub
+    request2 = stub
+    
+    app = builder do
+      use :handler1
+
+      map(request1) do
+        use :handler2
+        run :handler3
+      end
+
+      use :handler4
+
+      map(request2) do
+        use :handler5
+      end
+
+      run :handler6
+    end
+
+    app.call(request1).must_equal([:handler1, :handler2, :handler3])
+    app.call(request2).must_equal([:handler1, :handler4, :handler5, :handler6])
+    app.call(nil).must_equal([:handler1, :handler4, :handler6])
+  end
+
+  def builder(&block)
+    Chickadee::Router.new(&block)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'mocha/setup'
+
+def context *args, &block
+  describe *args, &block
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: chickadee
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Erik Lott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ioc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !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: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Lightweight domain driven design library
+email:
+- erik.lott@evrium.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- chickadee.gemspec
+- lib/chickadee.rb
+- lib/chickadee/application.rb
+- lib/chickadee/command.rb
+- lib/chickadee/container.rb
+- lib/chickadee/exceptions.rb
+- lib/chickadee/handler.rb
+- lib/chickadee/query.rb
+- lib/chickadee/registry.rb
+- lib/chickadee/request.rb
+- lib/chickadee/router.rb
+- lib/chickadee/version.rb
+- spec/chickadee_spec.rb
+- spec/command_spec.rb
+- spec/query_spec.rb
+- spec/registry_spec.rb
+- spec/router_spec.rb
+- spec/spec_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.0.7
+signing_key: 
+specification_version: 4
+summary: Lightweight domain driven design library
+test_files:
+- spec/chickadee_spec.rb
+- spec/command_spec.rb
+- spec/query_spec.rb
+- spec/registry_spec.rb
+- spec/router_spec.rb
+- spec/spec_helper.rb