spank 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3ad3f44fbf8bd01849891acc1cfde2bf1362cf8
-  data.tar.gz: 5becabf3cc3fa7942f94992085a63b20022b4000
+  metadata.gz: c8b671e694e2f9a62cab98cfcf48ba66ec7eb2b8
+  data.tar.gz: 5b0e709269ed25ae1adc33190b27aa5a1ea0e7e7
 SHA512:
-  metadata.gz: cae9beacbbeac865f02a72e6781bb61b9d4d21b75c104945cb5913b6832563027c1dc09e54e107bbc0a12321eee67ece062c6409bdf209ad752068cde63b0828
-  data.tar.gz: e4b59eda7db01c0de19138c0acc44a5fd224ed4ad68c96c19ed8f519849ff72dee2f0cf0142da2edb023463966486aa43d18caece52d6c3ca6c8931a99eba7ee
+  metadata.gz: 59e85d5e83e8e493026c6c7407eb3d7df57841634cf3ce855052e71797d037582076e279551e3d9acf104323ef7217cc3bf3d4892194b155ccc3a335caa7278e
+  data.tar.gz: 98bd5e90dba0c47663a4b88a709040cbd8ed6023d2e03087d2e0c1fc445623c3806a2ae32e6e7fda55b5415dd0cdacb116dc95adca3db65410e563c3503499ea

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+pkg/*

data/.ruby-gemset

@@ -0,0 +1 @@
+spank

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p195

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    spank (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  spank!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 mo khan
+
+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 @@
+# Spank
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spank'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spank
+
+## 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,15 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+
+task :spec do
+  system 'rspec'
+end
+
+task :build do
+  system 'gem build spank.gemspec'
+end
+
+task :publish => :build do
+  system 'gem push *.gem'
+end

data/lib/spank.rb

@@ -0,0 +1,8 @@
+require 'spank/lambda_behaviours.rb'
+require 'spank/component.rb'
+require 'spank/container.rb'
+require 'spank/interceptor_registration.rb'
+require 'spank/invocation.rb'
+require 'spank/ioc.rb'
+require 'spank/proxy.rb'
+require "spank/version"

data/lib/spank/component.rb

@@ -0,0 +1,28 @@
+module Spank
+  class Component
+    include LambdaBehaviours
+
+    def initialize(class_key, &block)
+      @factory_method = block
+      @interceptors = []
+    end
+
+    def create(container)
+      instance = @factory_method.call(container)
+      @interceptors.each do |interceptor|
+        instance = interceptor.intercept(instance)
+      end
+      instance
+    end
+
+    def as_singleton
+      @factory_method = memoize(@factory_method)
+    end
+
+    def intercept(method)
+      interceptor = InterceptorRegistration.new(method)
+      @interceptors.push(interceptor)
+      interceptor
+    end
+  end
+end

data/lib/spank/container.rb

@@ -0,0 +1,52 @@
+module Spank
+  class ContainerError < Exception
+    def intialize(message)
+      @message = message
+    end
+  end
+  class Container
+    def initialize
+      @items = {}
+      register(:container) { self }
+    end
+    def register(key, &block)
+      component = Component.new(key, &block)
+      components_for(key).push(component)
+      component
+    end
+    def resolve(key)
+      instantiate(components_for(key).first, key)
+    end
+    def resolve_all(key)
+      components_for(key).map {|item| instantiate(item, key) }
+    end
+    def build(type)
+      try("I could not create: #{type}"){ build!(type) }
+    end
+    def build!(type)
+      constructor = type.instance_method('initialize')
+      parameters = constructor.parameters.map do |req, parameter|
+        resolve(parameter.to_sym)
+      end
+      type.send(:new, *parameters)
+    end
+
+    private
+
+    def components_for(key)
+      @items[key] = [] unless @items[key]
+      @items[key]
+    end
+    def instantiate(component, key)
+      raise ContainerError.new("#{key} is not a registered component.") unless component
+      component.create(self)
+    end
+    def try(error = nil, &lambda)
+      begin
+        lambda.call
+      rescue => e
+        raise Spank::ContainerError.new(error ||= "Oops: #{e}")
+      end
+    end
+  end
+end

data/lib/spank/interceptor_registration.rb

@@ -0,0 +1,17 @@
+module Spank
+  class InterceptorRegistration
+    def initialize(method_symbol)
+      @method = method_symbol
+    end
+
+    def with(interceptor)
+      @interceptor = interceptor
+    end
+
+    def intercept(instance)
+      proxy= Proxy.new(instance)
+      proxy.add_interceptor(@method, @interceptor)
+      proxy
+    end
+  end
+end

data/lib/spank/invocation.rb

@@ -0,0 +1,20 @@
+module Spank
+  class Invocation
+    attr_reader :instance, :method, :arguments, :result
+
+    def initialize(instance, method, args, block)
+      @instance = instance
+      @method = method
+      @arguments = args
+      @block = block
+    end
+
+    def proceed
+      if @block
+        @result = @instance.public_send(@method, @arguments, @block)
+      else
+        @result = @instance.public_send(@method, @arguments)
+      end
+    end
+  end
+end

data/lib/spank/ioc.rb

@@ -0,0 +1,10 @@
+module Spank
+  class IOC
+    def self.bind_to(container)
+      @@container = container
+    end
+    def self.resolve(symbol)
+      @@container.resolve(symbol)
+    end
+  end
+end

data/lib/spank/lambda_behaviours.rb

@@ -0,0 +1,7 @@
+module Spank
+  module LambdaBehaviours
+    def memoize(lambda_method)
+      lambda { |container| @cache ||= lambda_method.call(container) }
+    end
+  end
+end

data/lib/spank/proxy.rb

@@ -0,0 +1,36 @@
+module Spank
+  class Proxy
+    def initialize(target)
+      @target = target
+    end
+
+    def add_interceptor(method, interceptor)
+      self.extend(create_module_for(method, interceptor))
+      self
+    end
+
+    private
+
+    def create_invocation_for(method, args, block)
+      Invocation.new(@target, method, args, block)
+    end
+
+    def method_missing(method, *args, &block)
+      if block
+        @target.public_send(method, *args, block)
+      else
+        @target.public_send(method, *args)
+      end
+    end
+
+    def create_module_for(method, interceptor)
+      Module.new do
+        define_method(method.to_sym) do |*args, &block|
+          invocation = create_invocation_for(method, args, block)
+          interceptor.intercept(invocation)
+          invocation.result
+        end
+      end
+    end
+  end
+end

data/lib/spank/version.rb

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

data/spank.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spank/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spank"
+  spec.version       = Spank::VERSION
+  spec.authors       = ["mo khan"]
+  spec.email         = ["mo@mokhan.ca"]
+  spec.description   = %q{A simple ruby container}
+  spec.summary       = %q{spank!}
+  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"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-fakes"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'fakes-rspec'
+require 'spank'

data/spec/unit/container_spec.rb

@@ -0,0 +1,131 @@
+require "spec_helper"
+
+module Spank
+  describe Container do
+    let(:sut) { Container.new }
+
+    describe "when resolving an item that has been registered" do
+      let(:registered_item) { Object.new }
+      before :each do
+        sut.register(:item) do
+          registered_item
+        end
+      end
+      before :each do
+        @result = sut.resolve(:item) 
+      end
+      it "should return the registered item" do
+        @result.should == registered_item
+      end
+    end
+    describe "when resolving the container" do
+      it "should return itself" do
+        sut.resolve(:container).should == sut
+      end
+    end
+    describe "when multiple items are registered with the same key" do
+      let(:jeans) { fake }
+      let(:dress_pants) { fake }
+      before :each do
+        sut.register(:pants) { jeans }
+        sut.register(:pants) { dress_pants }
+      end
+      context "when resolving a single item" do
+        before :each do
+          @result = sut.resolve(:pants)
+        end
+        it "should return the first one registered" do
+          @result.should == jeans
+        end
+      end
+      context "when resolving all items" do
+        before :each do
+          @results = sut.resolve_all(:pants)
+        end
+        it "should return them all" do
+          @results.should == [jeans, dress_pants]
+        end
+      end
+      context "when resolving all items for an unknown key" do
+        it "should return an empty array" do
+          sut.resolve_all(:shirts).should be_empty
+        end
+      end
+    end
+    context "when a component is registered as a singleton" do
+      before :each do
+        sut.register(:singleton) { fake }.as_singleton
+      end
+      it "should return the same instance of that component each time it is resolved" do
+        sut.resolve(:singleton).should == sut.resolve(:singleton)
+      end
+    end
+    context "when invoking the factory method" do
+      before :each do
+        sut.register(:item){ |item| @result = item }
+        sut.resolve(:item)
+      end
+      it "should pass the container through to the block" do
+        @result.should == sut
+      end
+    end
+    context "when automatically resolving dependencies" do
+      class Child
+        def initialize(mom,dad)
+        end
+        def greeting(message)
+        end
+      end
+
+      context "when the dependencies have been registered" do
+        let(:mom) { fake }
+        let(:dad) { fake }
+        before :each do
+          sut.register(:mom) { mom }
+          sut.register(:dad) { dad }
+        end
+        it "should be able to glue the pieces together automatically" do
+          sut.build(Child).should be_a_kind_of(Child)
+        end
+      end
+      context "when a component cannot automatically be constructed" do
+        it "should raise an error" do
+          expect { sut.build(Child) }.to raise_error(ContainerError)
+        end
+      end
+    end
+    context "when registering an interceptor" do
+      class TestInterceptor
+        attr_reader :called
+        def intercept(invocation)
+          @called = true
+          invocation.proceed
+        end
+      end
+      class TestCommand
+        attr_reader :called, :received
+        def run(input)
+          @called = true
+          @received = input
+        end
+      end
+      let(:command) { TestCommand.new }
+      let(:interceptor) { TestInterceptor.new }
+
+      before :each do
+        sut.register(:command) { command }.intercept(:run).with(interceptor)
+        sut.resolve(:command).run("hi")
+      end
+
+      it "should allow the interceptor to intercept calls to the target" do
+        interceptor.called.should be_true
+      end
+
+      it "should forward the args to the command" do
+        #command.should have_received(:run, 'hi')
+        command.called.should be_true
+        command.received.should == ['hi']
+      end
+    end
+  end
+end

data/spec/unit/proxy_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+module Spank
+  describe Proxy do
+    let(:sut) { Proxy.new(target) }
+    let(:target) { fake }
+
+    context "when invoking a method" do
+      before { sut.greet('blah') }
+
+      it "should send the message to the target" do
+        target.should have_received(:greet, 'blah')
+      end
+    end
+
+    context "when an interceptor is registered" do
+      context "when invoking a method" do
+        let(:interceptor) { fake }
+
+        before :each do
+          sut.add_interceptor(:greet, interceptor)
+          sut.greet("blah")
+        end
+        it "should allow the interceptor to intercept the call" do
+          interceptor.should have_received(:intercept)
+        end
+      end
+      context "when invoking a method with a block" do
+        it "should pass the block to the target" do
+          proxy = Proxy.new([])
+          expect do
+            proxy.each do |x|
+              raise StandardError
+            end
+          end.to raise_error
+        end
+      end
+    end
+
+    context "when invoking a method that is not defined on the target" do
+      it "should raise an error" do
+        expect { Proxy.new("blah").goodbye }.to raise_error
+      end
+    end
+  end
+end

metadata

@@ -1,24 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: spank
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - mo khan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
-dependencies: []
+date: 2013-05-18 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
+  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-fakes
+  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: A simple ruby container
-email: mo@mokhan.ca
+email:
+- mo@mokhan.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
 - lib/spank.rb
-homepage: http://rubygems.org/gems/spank
-licenses: []
+- lib/spank/component.rb
+- lib/spank/container.rb
+- lib/spank/interceptor_registration.rb
+- lib/spank/invocation.rb
+- lib/spank/ioc.rb
+- lib/spank/lambda_behaviours.rb
+- lib/spank/proxy.rb
+- lib/spank/version.rb
+- spank.gemspec
+- spec/spec_helper.rb
+- spec/unit/container_spec.rb
+- spec/unit/proxy_spec.rb
+homepage: ''
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -40,4 +118,7 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: spank!
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/unit/container_spec.rb
+- spec/unit/proxy_spec.rb