spank 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8b671e694e2f9a62cab98cfcf48ba66ec7eb2b8
-  data.tar.gz: 5b0e709269ed25ae1adc33190b27aa5a1ea0e7e7
+  metadata.gz: 304d66de564215dc7a9cbd7153f748de769a7615
+  data.tar.gz: c7b0c3cf438d75a656b73b4f519c13de9a498d19
 SHA512:
-  metadata.gz: 59e85d5e83e8e493026c6c7407eb3d7df57841634cf3ce855052e71797d037582076e279551e3d9acf104323ef7217cc3bf3d4892194b155ccc3a335caa7278e
-  data.tar.gz: 98bd5e90dba0c47663a4b88a709040cbd8ed6023d2e03087d2e0c1fc445623c3806a2ae32e6e7fda55b5415dd0cdacb116dc95adca3db65410e563c3503499ea
+  metadata.gz: 9fe5f5ee9ee2702e28854e508f5ad76fefcafcf2bc0afd28a1aa4d55d4c128a1c4dd0f4e8309c30656745fc773bbb218bcd934729a39f1d31fde6dcb62ee81b9
+  data.tar.gz: a490063b125cb26c2904575a9c74093277c61649c9e3472e82552d4731ff5db7354e406862a912aaa502c3bc05080f6879985bc31850b9226cc5339291b8fb8d

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
 pkg/*
+coverage

data/Gemfile.lock

@@ -1,12 +1,32 @@
 PATH
   remote: .
   specs:
-    spank (0.0.1)
+    spank (0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    developwithpassion_arrays (0.0.1)
+    developwithpassion_fakes (0.1.1)
+      developwithpassion_arrays
+    diff-lcs (1.2.4)
+    multi_json (1.7.3)
     rake (10.0.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-fakes (0.0.9)
+      developwithpassion_fakes
+      rspec
+    rspec-mocks (2.13.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
 
 PLATFORMS
   ruby
@@ -14,4 +34,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.3)
   rake
+  rspec
+  rspec-fakes
+  simplecov
   spank!

data/README.md

@@ -1,6 +1,6 @@
 # Spank
 
-TODO: Write a gem description
+A simple light weight inversion of control container written in ruby.
 
 ## Installation
 
@@ -18,7 +18,91 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Register a single component and resolve it.
+
+```ruby
+
+  container = Container.new
+  container.register(:item) do
+    "ITEM"
+  end
+  container.register(:pants) { jeans }
+  container.register(:pants) { dress_pants }
+  item = container.resolve(:item)
+  
+```
+
+Register multiple items, and resolve them.
+
+```ruby
+
+  container = Container.new
+  container.register(:pants) { jeans }
+  container.register(:pants) { dress_pants }
+  pants = container.resolve_all(:item)
+  
+```
+
+Register a singleton.
+
+```ruby
+
+  container = Container.new
+  container.register(:singleton) { fake }.as_singleton
+  single_instance = container.resolve(:singleton)
+  same_instance = container.resolve(:singleton)
+  
+```
+
+Automatic dependency resolution.
+
+```ruby
+
+  class Child
+    def initialize(mom,dad)
+    end
+  end
+  
+  container = Container.new
+  container.register(:mom) { mom }
+  container.register(:dad) { dad }
+  child = sut.build(Child)
+      
+```
+
+Register selective interceptors.
+
+```ruby
+
+  class Interceptor
+    def intercept(invocation)
+      invocation.proceed
+    end
+  end
+  
+  class Command
+    def run(input)
+    end
+  end
+  
+  container = Container.new
+  container.register(:command) { Command.new }.intercept(:run).with(Interceptor.new)
+  proxy = container.resolve(:command)
+  proxy.run("hi")
+      
+```
+
+[Static gateway](http://codebetter.com/jpboodhoo/2007/10/15/the-static-gateway-pattern/) to connect to the container.
+
+```ruby
+  
+  container = Container.new
+  Spank::IOC.bind_to(container)
+  Spank::IOC.resolve(:item)
+      
+```
+
+Enjoy!
 
 ## Contributing
 

data/Rakefile

@@ -6,7 +6,12 @@ task :spec do
   system 'rspec'
 end
 
-task :build do
+task :clean do
+  system 'rm *.gem'
+  system 'rm -fr pkg'
+end
+
+task :build => :clean do
   system 'gem build spank.gemspec'
 end
 

data/lib/spank/version.rb

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

data/spank.gemspec

@@ -10,16 +10,18 @@ Gem::Specification.new do |spec|
   spec.email         = ["mo@mokhan.ca"]
   spec.description   = %q{A simple ruby container}
   spec.summary       = %q{spank!}
-  spec.homepage      = ""
+  spec.homepage      = "http://github.com/mokhan/spank"
   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.required_ruby_version = '>= 1.9.3'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-fakes"
+  spec.add_development_dependency "simplecov"
 end

data/spec/spec_helper.rb

@@ -1,2 +1,4 @@
-require 'fakes-rspec'
+require 'simplecov'
+SimpleCov.start
+require 'rspec-fakes'
 require 'spank'

data/spec/unit/container_spec.rb

@@ -6,69 +6,79 @@ module Spank
 
     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
+
+      let(:result) { sut.resolve(:item) }
+
       it "should return the registered item" do
-        @result.should == registered_item
+        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
+        let(:result) { sut.resolve(:pants) }
+
         it "should return the first one registered" do
-          @result.should == jeans
+          result.should == jeans
         end
       end
+
       context "when resolving all items" do
-        before :each do
-          @results = sut.resolve_all(:pants)
-        end
+        let(:results) { sut.resolve_all(:pants)  }
+
         it "should return them all" do
-          @results.should == [jeans, dress_pants]
+          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)
@@ -80,20 +90,24 @@ module Spank
       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
@@ -102,6 +116,7 @@ module Spank
           invocation.proceed
         end
       end
+
       class TestCommand
         attr_reader :called, :received
         def run(input)
@@ -109,6 +124,7 @@ module Spank
           @received = input
         end
       end
+
       let(:command) { TestCommand.new }
       let(:interceptor) { TestInterceptor.new }
 
@@ -122,7 +138,6 @@ module Spank
       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

data/spec/unit/ioc_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe Spank::IOC do
+  context "when bound to a container" do
+    let(:container) { fake }
+    let(:component) { fake }
+
+    before :each do
+      container.stub(:resolve).with(:idbconnection).and_return(component)
+      Spank::IOC.bind_to(container)
+    end
+
+    let(:result) { Spank::IOC.resolve(:idbconnection) }
+
+    it "should resove items from that container" do
+      result.should == component
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spank
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - mo khan
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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
@@ -93,8 +107,9 @@ files:
 - spank.gemspec
 - spec/spec_helper.rb
 - spec/unit/container_spec.rb
+- spec/unit/ioc_spec.rb
 - spec/unit/proxy_spec.rb
-homepage: ''
+homepage: http://github.com/mokhan/spank
 licenses:
 - MIT
 metadata: {}
@@ -106,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -121,4 +136,5 @@ summary: spank!
 test_files:
 - spec/spec_helper.rb
 - spec/unit/container_spec.rb
+- spec/unit/ioc_spec.rb
 - spec/unit/proxy_spec.rb