vcontainer 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "activesupport", ">= 3.0.0"
+gem "i18n"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.1.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rcov (0.9.9-java)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0.0)
+  bundler (~> 1.0.0)
+  i18n
+  jeweler (~> 1.5.1)
+  rcov
+  rspec (~> 2.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 guilherme silveira & david paniz
+
+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.rdoc

@@ -0,0 +1,81 @@
+= vcontainer
+
+VContainer is a simple dependency injection framework for Ruby.
+Dependency injection should be as simple as possible. Whenever you can use the most
+effective dependecy injection library: "new".
+
+	BasicComponent.new(EmailSender.new)
+
+Otherwise you can always stick to VContainer as a PicoContainer based implementation for Ruby.
+The acceptance tests show several different ways to use VContainer.
+
+Creating a container and requesting an instance:
+
+	class MyComponent
+	end
+	container = VContainer::ContainerDsl.new.register(MyComponent)
+	component = container.provide :my_component
+
+You can use included modules or type based requests:
+
+	class MyComponent < Component
+		include BasicInfo
+	end
+	container = VContainer::ContainerDsl.new.register(MyComponent)
+	component = container.provide :component
+	component = container.provide :basic_info
+	
+Dependecy injection plays nicely:
+
+	class Dao
+	end
+	class Clients
+		def initialize(dao)
+			@dao = dao
+		end
+		def all
+			@dao.find(:all)
+		end
+	end
+	container = VContainer::ContainerDsl.new.register(Dao, Clients)
+	clients = container.provide :clients
+
+You can compose containers in order to create different layers of control:
+
+	base = VContainer::ContainerDsl.new.register(dao)
+	container = VContainer::ContainerDsl.new(base).register(Clients)
+	clients = container.provide :clients
+
+There is also a singleton provider, that instantiates a type only once.
+
+	base = VContainer::ContainerDsl.new
+	base.use VContainer::SingletonProvider.new(Dao)
+	base.provide(:dao)==base.provide(:dao)
+
+As with any decent container, you can register your own "Adapter/Provider":
+
+	base = VContainer::ContainerDsl.new
+	base.use YourAdapterProviderWhatever.new
+	base.provide(:dao) # will invoke your adapter
+	
+Just check the SimpleProvider, ParentProvider and SingletonProvider examples to roll out your own provider.
+
+== Team ==
+
+VContainer was created by Guilherme Silveira and has been developed together with Eric Torti.
+
+== Contributing to vcontainer
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 guilherme silveira. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "vcontainer"
+  gem.homepage = "http://github.com/caelum/vcontainer"
+  gem.license = "MIT"
+  gem.summary = %Q{A dependency injection framework.}
+  gem.description = %Q{A dependency injection framework based in PicoContainer.}
+  gem.email = "guilherme.silveira@caelum.com.br"
+  gem.authors = ["guilherme silveira & david paniz & eric torti"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "vcontainer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/vcontainer.rb

@@ -0,0 +1,6 @@
+require 'vcontainer/nil_container.rb'
+require 'vcontainer/singleton_provider.rb'
+require 'vcontainer/simple_provider.rb'
+require 'vcontainer/container.rb'
+require 'vcontainer/parent_provider.rb'
+require 'vcontainer/container_dsl.rb'

data/lib/vcontainer/container.rb

@@ -0,0 +1,48 @@
+require 'active_support/inflector'
+
+module VContainer
+  
+  # A basic container implementation
+  class Container
+    
+    def use(provider)
+      providers << provider
+    end
+    
+    def provide(what)
+      provider_for(what).build(what, self)
+    end
+    
+    def can_provide?(what)
+      provider_for(what) != nil
+    end
+    
+    def provide_for_method(method)
+      params = method.parameters
+      has_parameters = params[0]!=[:rest]
+      if has_parameters
+        provide_instances_for(params)
+      else
+        []
+      end
+    end
+    
+    private
+    def provide_instances_for(params)
+      params.collect do |param|
+        provide(param[1])
+      end
+    end
+    
+    def provider_for(what)
+      providers.find {|p| p.can_handle?(what)}
+    end
+    
+    private
+    def providers
+      @providers ||= []
+    end
+    
+  end
+  
+end

data/lib/vcontainer/container_dsl.rb

@@ -0,0 +1,22 @@
+module VContainer
+  
+  # A basic container implementation
+  class ContainerDsl < Container
+    
+    def initialize(parent = NilContainer.new)
+      register ParentProvider.new(parent)
+    end
+    
+    def register(*provider)
+      provider.each do |p|
+        if p.kind_of? Class
+          p = VContainer::SimpleProvider.new(p)
+        end
+        use(p)
+      end
+      self
+    end
+ 
+  end
+  
+end

data/lib/vcontainer/nil_container.rb

@@ -0,0 +1,15 @@
+module VContainer
+  
+  class NilContainer
+    
+    def provide_for_method(method)
+      []
+    end
+    
+    def can_provide?(what)
+      false
+    end
+    
+  end
+  
+end

data/lib/vcontainer/parent_provider.rb

@@ -0,0 +1,20 @@
+module VContainer
+  
+  # A simple provider that looks up into a parent to provide something
+  class ParentProvider
+    
+    def initialize(parent)
+      @parent = parent
+    end
+  
+    def build(what, container = NilContainer.new)
+      @parent.provide(what)
+    end
+    
+    def can_handle?(what)
+      @parent.can_provide?(what)
+    end
+    
+  end
+  
+end

data/lib/vcontainer/simple_provider.rb

@@ -0,0 +1,22 @@
+module VContainer
+  
+  # A simple provider will instantiate a type everytime its required
+  class SimpleProvider
+    
+    def initialize(build_type)
+      @type = build_type
+    end
+  
+    def build(what, container = NilContainer.new)
+      values = container.provide_for_method(@type.instance_method(:initialize))
+      @type.new *values
+    end
+    
+    def can_handle?(what)
+      expected = what.to_s.camelize.constantize
+      @type.ancestors.include?(expected)
+    end
+    
+  end
+  
+end

data/lib/vcontainer/singleton_provider.rb

@@ -0,0 +1,27 @@
+module VContainer
+  
+  # A singleton provider will only instantiate a type once
+  class SingletonProvider
+    
+    def initialize(build_type)
+      @type = build_type
+    end
+    
+    def build(what, container = NilContainer.new)
+      @cached_instance ||= instantiate(container)
+    end
+
+    def can_handle?(what)
+      expected = what.to_s.camelize.constantize
+      @type.ancestors.include?(expected)
+    end
+    
+    private
+    def instantiate(container)
+      values = container.provide_for_method(@type.instance_method(:initialize))
+      @type.new *values
+    end
+
+  end
+  
+end

data/spec/acceptance/access_parent_container_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe VContainer::ParentProvider do
+  
+  before do
+    @container = VContainer::ContainerDsl.new
+  end
+  
+  it "looks up on its parents prior to providing something" do
+    @container.register SimpleEmailSender
+    
+    basic_container = VContainer::ContainerDsl.new(@container)
+    basic_container.register BasicComponent
+    
+    email_cc = VContainer::ContainerDsl.new(@container)
+    email_cc.register EmailComponent
+    
+    basic_container.provide(:component).should be_kind_of(BasicComponent)
+    basic_container.provide(:component).sender.class.should == SimpleEmailSender
+    
+    email_cc.provide(:component).should be_kind_of(EmailComponent)
+    email_cc.provide(:component).sender.class.should == SimpleEmailSender
+  end
+
+  it "looks up on its parents prior to providing something" do
+    @container.use VContainer::SingletonProvider.new(SimpleEmailSender)
+    
+    basic_container = VContainer::ContainerDsl.new(@container).register(BasicComponent)
+    email_cc = VContainer::ContainerDsl.new(@container).register(EmailComponent)
+    
+    basic_container.provide(:component).sender == email_cc.provide(:component).sender
+  end
+
+end

data/spec/acceptance/basic_usage_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe VContainer::SimpleProvider do
+  
+  before do
+    @container = VContainer::Container.new
+  end
+  
+  it "support provider registration and so on" do
+    @container.use VContainer::SimpleProvider.new(SimpleEmailSender)
+    @container.provide(SimpleEmailSender).class.should == SimpleEmailSender
+  end
+
+  it "lets us know whether it can handle something" do
+    @container.use VContainer::SimpleProvider.new(SimpleEmailSender)
+    @container.can_provide?(SimpleEmailSender).should be_true
+  end
+  
+  it "support provider registration with symbol" do
+    @container.use VContainer::SimpleProvider.new(SimpleEmailSender)
+    @container.provide(:simpleEmailSender).class.should == SimpleEmailSender
+  end
+
+  it "lets us know whether it can handle some symbol" do
+    @container.use VContainer::SimpleProvider.new(SimpleEmailSender)
+    @container.can_provide?(:simpleEmailSender).should be_true
+  end
+end

data/spec/acceptance/container_building_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe VContainer::SimpleProvider do
+  
+  before do
+    @container = VContainer::ContainerDsl.new
+  end
+  
+  it "support straight class registering" do
+    @container.register BasicComponent, SimpleEmailSender
+    basic = @container.provide(:basicComponent)
+    basic.sender.class.should == SimpleEmailSender
+  end
+
+end

data/spec/acceptance/injection_usage_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe VContainer::SimpleProvider do
+  
+  before do
+    @container = VContainer::Container.new
+  end
+  
+  it "support dependency injection when providing a service" do
+    @container.use VContainer::SimpleProvider.new(BasicComponent)
+    @container.use VContainer::SimpleProvider.new(SimpleEmailSender)
+    basic = @container.provide(BasicComponent)
+    basic.sender.class.should == SimpleEmailSender
+  end
+
+  it "support dependency injection based on a module" do
+    @container.use VContainer::SimpleProvider.new(EmailComponent)
+    @container.use VContainer::SimpleProvider.new(SimpleEmailSender)
+    basic = @container.provide(EmailComponent)
+    basic.sender.class.should == SimpleEmailSender
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'vcontainer'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end
+
+module EmailSender
+end
+
+class EmailTemplate
+end
+
+class SimpleEmailSender < EmailTemplate
+  include EmailSender
+end
+
+class Component
+end
+
+class BasicComponent < Component
+  attr_reader :sender
+  def initialize(simpleEmailSender)
+    @sender = simpleEmailSender
+  end
+end
+
+
+class EmailComponent < Component
+  attr_reader :sender
+  def initialize(emailSender)
+    @sender = emailSender
+  end
+end

data/spec/vcontainer/simple_provider_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe VContainer::SimpleProvider do
+  it "always return different instances" do
+    provider = VContainer::SimpleProvider.new(SimpleEmailSender)
+    provider.build(:simpleEmailSender).should_not == provider.build(:simpleEmailSender)
+  end
+  
+  it "can handle a type's module" do
+    provider = VContainer::SimpleProvider.new(SimpleEmailSender)
+    provider.can_handle?(:emailSender).should be_true
+  end
+
+  it "can handle a type's superclass" do
+    provider = VContainer::SimpleProvider.new(SimpleEmailSender)
+    provider.can_handle?(:emailTemplate).should be_true
+  end
+end

data/spec/vcontainer/singleton_provider_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe VContainer::SingletonProvider do
+  it "always return the same singleton instance" do
+    provider = VContainer::SingletonProvider.new(SimpleEmailSender)
+    provider.build(:simpleEmailSender).should == provider.build(:simpleEmailSender)
+  end
+
+  it "can handle a type's module" do
+    provider = VContainer::SingletonProvider.new(SimpleEmailSender)
+    provider.can_handle?(:emailSender).should be_true
+  end
+
+  it "can handle a type's superclass" do
+    provider = VContainer::SingletonProvider.new(SimpleEmailSender)
+    provider.can_handle?(:emailTemplate).should be_true
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification 
+name: vcontainer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- guilherme silveira & david paniz & eric torti
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-07 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: A dependency injection framework based in PicoContainer.
+email: guilherme.silveira@caelum.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/vcontainer.rb
+- lib/vcontainer/container.rb
+- lib/vcontainer/container_dsl.rb
+- lib/vcontainer/nil_container.rb
+- lib/vcontainer/parent_provider.rb
+- lib/vcontainer/simple_provider.rb
+- lib/vcontainer/singleton_provider.rb
+- spec/acceptance/access_parent_container_spec.rb
+- spec/acceptance/basic_usage_spec.rb
+- spec/acceptance/container_building_spec.rb
+- spec/acceptance/injection_usage_spec.rb
+- spec/spec_helper.rb
+- spec/vcontainer/simple_provider_spec.rb
+- spec/vcontainer/singleton_provider_spec.rb
+has_rdoc: true
+homepage: http://github.com/caelum/vcontainer
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -248008717
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A dependency injection framework.
+test_files: 
+- spec/acceptance/access_parent_container_spec.rb
+- spec/acceptance/basic_usage_spec.rb
+- spec/acceptance/container_building_spec.rb
+- spec/acceptance/injection_usage_spec.rb
+- spec/spec_helper.rb
+- spec/vcontainer/simple_provider_spec.rb
+- spec/vcontainer/singleton_provider_spec.rb