rails-ioc 0.1.1 → 0.2.0

data/README.markdown

@@ -115,7 +115,7 @@ RailsIOC attempts to make these problems less painful for applications with comp
   RailsIOC::Dependencies.define do
     prototype :payment_gateway,       RealPaymentGateway
     prototype :credit_card_validator, RealCardValidator
-    
+
     controller PaymentsController, {
       gateway:               ref(:payment_gateway)
       credit_card_validator: ref(:credit_card_validator)
@@ -126,18 +126,14 @@ RailsIOC attempts to make these problems less painful for applications with comp
   RailsIOC::Dependencies.define do
     inherit_environment(:production)
     
-    controller PaymentsController, {
-      gateway: prototype(RealPaymentGateway, use_testing_url: true)
-    }
+    prototype :payment_gateway, RealPaymentGateway, {use_testing_url: true}
   end
 
   # config/dependencies/development.rb:
   RailsIOC::Dependencies.define do
     inherit_environment(:production)
   
-    controller PaymentsController, {
-      gateway:               singleton(BogusPaymentGateway),
-      credit_card_validator: singleton(BogusCardValidator)
-    }
+    singleton :payment_gateway, BogusPaymentGateway),
+    singleton :credit_card_validator, BogusCardValidator
   end
   ```

data/lib/rails-ioc.rb

@@ -3,6 +3,9 @@ require "rails-ioc/errors"
 require "rails-ioc/dependencies"
 require "rails-ioc/dependency_constructor"
 require "rails-ioc/dependency_injector"
+require "rails-ioc/singleton"
+require "rails-ioc/prototype"
+require "rails-ioc/reference"
       
 raise RailsIOC::NoRailsError.new(:Rails) unless defined?(Rails)
 raise RailsIOC::NoRailsError.new(:ActionController) unless defined?(ActionController)

data/lib/rails-ioc/Reference.rb

@@ -0,0 +1,18 @@
+module RailsIOC
+  class Reference
+    def initialize(name, defined_dependencies)
+      @name = name
+      @defined_dependencies = defined_dependencies
+    end
+    
+    def build
+      dependency = @defined_dependencies[@name]
+      raise MissingReferenceError.new(@name) if dependency.nil?
+      if dependency.respond_to?(:build)
+        dependency.build
+      else
+        dependency
+      end
+    end
+  end
+end

data/lib/rails-ioc/dependencies.rb

@@ -29,24 +29,23 @@ module RailsIOC
     end
   
     def self.singleton(*args)
-      store_dependency(args) do |klass, constructor_args|
-        if klass.instance_of?(Class)
-          DependencyConstructor.new(klass, caller).construct(constructor_args)
+      store_dependency(args) do |klass_or_value, constructor_args|
+        if klass_or_value.instance_of?(Class)
+          RailsIOC::Singleton.new(klass_or_value, constructor_args)
         else
-          klass
+          klass_or_value
         end
       end
     end
   
     def self.prototype(*args)
       store_dependency(args) do |klass, constructor_args|
-        definition_backtrace = caller
-        -> { DependencyConstructor.new(klass, definition_backtrace).construct(constructor_args) }
+        RailsIOC::Prototype.new(klass, constructor_args)
       end
     end
   
     def self.ref(name)
-      @dependencies[name] || raise(MissingReferenceError.new(name))
+      RailsIOC::Reference.new(name, @dependencies)
     end
     
     def self.controllers

data/lib/rails-ioc/dependency_constructor.rb

@@ -7,11 +7,21 @@ module RailsIOC
     
     def construct(dependencies)
       begin
-        @klass.new(*dependencies.map { |x| x.is_a?(Proc) ? x.call : x })
+        @klass.new(*dependencies.map { |dependency| call_lazy_initializers(dependency) })
       rescue ArgumentError => e
         e.set_backtrace(@definition_backtrace)
         raise e
       end
     end
+    
+    private
+    
+    def call_lazy_initializers(dependency)
+      if dependency.respond_to?(:build)
+        call_lazy_initializers(dependency.build)
+      else
+        dependency
+      end
+    end
   end
 end

data/lib/rails-ioc/dependency_injector.rb

@@ -5,11 +5,20 @@ module RailsIOC
     end
     
     def inject(dependencies)
-      dependencies.each do |field, value|
-        value = value.call if value.is_a?(Proc)
-        @target.instance_variable_set("@#{field}", value)
+      dependencies.each do |field, dependency|
+        @target.instance_variable_set("@#{field}", call_lazy_initializers(dependency))
       end
       @target
     end
+    
+    private
+    
+    def call_lazy_initializers(dependency)
+      if dependency.respond_to?(:build)
+        call_lazy_initializers(dependency.build)
+      else
+        dependency
+      end
+    end
   end
 end

data/lib/rails-ioc/prototype.rb

@@ -0,0 +1,13 @@
+module RailsIOC
+  class Prototype
+    def initialize(klass, constructor_args)
+      @klass = klass
+      @constructor_args = constructor_args
+      @defining_stacktrace = caller
+    end
+    
+    def build
+      DependencyConstructor.new(@klass, @defining_stacktrace).construct(@constructor_args)
+    end
+  end
+end

data/lib/rails-ioc/singleton.rb

@@ -0,0 +1,13 @@
+module RailsIOC
+  class Singleton
+    def initialize(klass, constructor_args)
+      @klass = klass
+      @constructor_args = constructor_args
+      @defining_stacktrace = caller
+    end
+    
+    def build
+      @instance ||= DependencyConstructor.new(@klass, @defining_stacktrace).construct(@constructor_args)
+    end
+  end
+end

data/lib/rails-ioc/version.rb

@@ -1,3 +1,3 @@
 module RailsIOC
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/fixtures/config/dependencies/production.rb

@@ -2,4 +2,9 @@ RailsIOC::Dependencies.define do
   singleton :env_string, "Production"
   singleton :foo_string, "Foo"
   singleton :production_only_string, "This comes from production.rb"
+  
+  controller ExtendedController, {
+    env_string: ref(:env_string),
+    production_only_string: ref(:production_only_string)
+  }
 end

data/spec/rails-ioc/dependencies_spec.rb

@@ -19,20 +19,22 @@ describe RailsIOC::Dependencies do
         singleton :first_node, TestListNode, ref(:second_node)
       end
     
-      first_node = RailsIOC::Dependencies.ref(:first_node)
+      ref = RailsIOC::Dependencies.ref(:first_node)
+      first_node = ref.build
       first_node.should be_a TestListNode
-      first_node.should === RailsIOC::Dependencies.ref(:first_node)
-      first_node.next_node.should === RailsIOC::Dependencies.ref(:second_node)
+      first_node.should === ref.build
+      first_node.next_node.should === RailsIOC::Dependencies.ref(:second_node).build
     end
     
     it "creates unreferenced singletons from a class and constructor args" do
       RailsIOC::Dependencies.define do
-        singleton :first_node, TestListNode, singleton(TestListNode)
+        prototype :first_node, TestListNode, singleton(TestListNode)
       end
 
-      first_node = RailsIOC::Dependencies.ref(:first_node)
-      first_node.should be_a(TestListNode)
+      ref = RailsIOC::Dependencies.ref(:first_node)
+      first_node = ref.build
       first_node.next_node.should be_a TestListNode
+      first_node.next_node.should === ref.build.next_node
     end
     
     it "does not require a class for simple types" do
@@ -40,15 +42,17 @@ describe RailsIOC::Dependencies do
         singleton :a_number, 12345
       end
       
-      RailsIOC::Dependencies.ref(:a_number).should == 12345
+      RailsIOC::Dependencies.ref(:a_number).build.should == 12345
     end
     
     it "raises an error containing information about original definition if the wrong number of constructor args are defined" do
-      defining_line = __LINE__ + 3
+      defining_line = __LINE__ + 2
+      RailsIOC::Dependencies.define do
+        singleton :a_string, String, "Too", "many", "args"
+      end
+      
       -> {
-        RailsIOC::Dependencies.define do
-          singleton :a_string, String, "Too", "many", "args"
-        end
+        RailsIOC::Dependencies.ref(:a_string).build
       }.should raise_error(ArgumentError) { |e|
         e.backtrace.find { |l| l =~ /dependencies_spec.rb:#{defining_line}/ }.should_not be_nil
       }
@@ -63,13 +67,11 @@ describe RailsIOC::Dependencies do
       end
     
       ref = RailsIOC::Dependencies.ref(:first_node)
-      ref.should be_a Proc
-      first_node = ref.call
+      first_node = ref.build
       first_node.should be_a TestListNode
-      first_node.should_not === ref.call 
-      
       first_node.next_node.should be_a TestListNode
-      first_node.next_node.should_not === RailsIOC::Dependencies.ref(:second_node).call
+      
+      first_node.should_not === ref.build
     end
     
     it "creates unreferenced prototypes from a class and constructor args" do
@@ -78,10 +80,11 @@ describe RailsIOC::Dependencies do
       end
 
       ref = RailsIOC::Dependencies.ref(:first_node)
-      ref.should be_a Proc
-      first_node = ref.call
-      first_node.should be_a(TestListNode)
+      first_node = ref.build
+      first_node.should be_a TestListNode
       first_node.next_node.should be_a TestListNode
+      
+      first_node.next_node.should_not === ref.build.next_node
     end
     
     it "raises an error containing information about original definition if the wrong number of constructor args are defined" do
@@ -89,13 +92,22 @@ describe RailsIOC::Dependencies do
       RailsIOC::Dependencies.define do
         prototype :a_string, String, "Too", "many", "args"
       end
-            
-      -> { RailsIOC::Dependencies.ref(:a_string).call }.should raise_error(ArgumentError) { |e|
+      -> { RailsIOC::Dependencies.ref(:a_string).build }.should raise_error(ArgumentError) { |e|
         e.backtrace.find { |l| l =~ /dependencies_spec.rb:#{defining_line}/ }.should_not be_nil
       }
     end
   end
   
+  describe "lazy initialization" do
+    it "allows dependencies to be referenced before they are defined" do
+      RailsIOC::Dependencies.define do
+        singleton :first_node, TestListNode, ref(:second_node)
+        singleton :second_node, TestListNode
+      end
+      RailsIOC::Dependencies.ref(:first_node).build.next_node.should === RailsIOC::Dependencies.ref(:second_node).build
+    end
+  end
+  
   describe "controllers" do
     it "stores controller dependencies for later injection by Rails' before_filter" do      
       RailsIOC::Dependencies.define do
@@ -111,7 +123,7 @@ describe RailsIOC::Dependencies do
       dependencies = RailsIOC::Dependencies.controllers[TestController]
       RailsIOC::DependencyInjector.new(controller).inject(dependencies)
       
-      controller.foo.should === RailsIOC::Dependencies.ref(:first_node)
+      controller.foo.should === RailsIOC::Dependencies.ref(:first_node).build
       controller.bar.should == "The Sheep Says Bar"
     end
     
@@ -140,10 +152,10 @@ describe RailsIOC::Dependencies do
       Rails.application.config.cache_classes = false
       
       RailsIOC::Dependencies.load!
-      RailsIOC::Dependencies.ref(:counter).should == 1
+      RailsIOC::Dependencies.ref(:counter).build.should == 1
       
       RailsIOC::Dependencies.load!
-      RailsIOC::Dependencies.ref(:counter).should == 2
+      RailsIOC::Dependencies.ref(:counter).build.should == 2
     end
     
     it "does not reload the file if cache_classes is true" do
@@ -151,26 +163,36 @@ describe RailsIOC::Dependencies do
       Rails.application.config.cache_classes = true
 
       RailsIOC::Dependencies.load!
-      RailsIOC::Dependencies.ref(:counter).should == 1
+      RailsIOC::Dependencies.ref(:counter).build.should == 1
       
       RailsIOC::Dependencies.load!
-      RailsIOC::Dependencies.ref(:counter).should == 1
+      RailsIOC::Dependencies.ref(:counter).build.should == 1
     end
   end
   
   describe "inheriting environments" do
     it "loads the corresponding dependencies file" do
       RailsIOC::Dependencies.inherit_environment("production")
-      RailsIOC::Dependencies.ref(:env_string).should == "Production"
-      RailsIOC::Dependencies.ref(:foo_string).should == "Foo"
-      RailsIOC::Dependencies.ref(:production_only_string).should == "This comes from production.rb"
-      -> { RailsIOC::Dependencies.ref(:test_only_string) }.should raise_error RailsIOC::MissingReferenceError
+      RailsIOC::Dependencies.ref(:env_string).build.should == "Production"
+      RailsIOC::Dependencies.ref(:foo_string).build.should == "Foo"
+      RailsIOC::Dependencies.ref(:production_only_string).build.should == "This comes from production.rb"
+      -> { RailsIOC::Dependencies.ref(:test_only_string).build }.should raise_error RailsIOC::MissingReferenceError
+      
+      RailsIOC::Dependencies.inherit_environment("test")
+      RailsIOC::Dependencies.ref(:env_string).build.should == "Test"
+      RailsIOC::Dependencies.ref(:foo_string).build.should == "Foo"
+      RailsIOC::Dependencies.ref(:production_only_string).build.should == "This comes from production.rb"
+      RailsIOC::Dependencies.ref(:test_only_string).build.should == "This comes from test.rb"
+    end
+    
+    it "allows controller dependencies which use references to be overridden" do
+      RailsIOC::Dependencies.inherit_environment("production")
+      RailsIOC::Dependencies.controllers[ExtendedController][:env_string].build.should == "Production"
+      RailsIOC::Dependencies.controllers[ExtendedController][:production_only_string].build.should == "This comes from production.rb"
       
       RailsIOC::Dependencies.inherit_environment("test")
-      RailsIOC::Dependencies.ref(:env_string).should == "Test"
-      RailsIOC::Dependencies.ref(:foo_string).should == "Foo"
-      RailsIOC::Dependencies.ref(:production_only_string).should == "This comes from production.rb"
-      RailsIOC::Dependencies.ref(:test_only_string).should == "This comes from test.rb"
+      RailsIOC::Dependencies.controllers[ExtendedController][:production_only_string].build.should == "This comes from production.rb"
+      RailsIOC::Dependencies.controllers[ExtendedController][:env_string].build.should == "Test"
     end
   end
 end

data/spec/rails-ioc/dependency_constructor_spec.rb

@@ -14,10 +14,10 @@ describe RailsIOC::DependencyConstructor do
     instance.bar.should == :abc
   end
   
-  it "calls any procs which are provided in constructor args" do
-    returns_7 = -> { 3 + 4 }
+  it "builds any dependencies which are provided in constructor args" do
+    returns_7 = RailsIOC::Prototype.new(String, ["7"])
     instance = RailsIOC::DependencyConstructor.new(ConstructorTestClass, []).construct([returns_7, :abc])
-    instance.foo.should == 7
+    instance.foo.should == "7"
     instance.bar.should == :abc
   end
   

data/spec/rails-ioc/dependency_injector_spec.rb

@@ -12,9 +12,9 @@ describe RailsIOC::DependencyInjector do
   end
   
   it "calls any procs which are provided in constructor args" do
-    returns_7 = -> { 3 + 4 }
+    returns_7 = RailsIOC::Prototype.new(String, ["7"])
     instance = RailsIOC::DependencyInjector.new(InjectorTestClass.new).inject(foo: returns_7, bar: :abc)
-    instance.foo.should == 7
+    instance.foo.should == "7"
     instance.bar.should == :abc
   end
 end

data/spec/rails-ioc/prototype_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path("../../spec_helper.rb", __FILE__)
+
+describe RailsIOC::Prototype do
+  class TestClass
+    attr_reader :text
+    def initialize(text)
+      @text = text
+    end
+  end
+  
+  it "builds a new instance every time build is called" do
+    prototype = RailsIOC::Prototype.new(TestClass, ["I am a prototype"])
+    prototype.build.text.should == "I am a prototype"
+    prototype.build.should_not === prototype.build
+  end
+end

data/spec/rails-ioc/rspec_extension_spec.rb

@@ -11,15 +11,15 @@ describe RailsIOC::RSpecExtension do
     end
     
     it "resets before this test" do
-      -> { RailsIOC::Dependencies.ref(:defined?) }.should raise_error RailsIOC::MissingReferenceError
+      -> { RailsIOC::Dependencies.ref(:defined?).build }.should raise_error RailsIOC::MissingReferenceError
     end
     
     it "also resets before this test" do
-      -> { RailsIOC::Dependencies.ref(:defined?) }.should raise_error RailsIOC::MissingReferenceError
+      -> { RailsIOC::Dependencies.ref(:defined?).build }.should raise_error RailsIOC::MissingReferenceError
     end
   end
   
-  it "provides a shorthand way to define and expose controller dependencies" do    
+  it "provides a shorthand way to define and expose controller depend3encies" do    
     Rails.application.config.cache_classes = true
     RailsIOC::Dependencies.instance_variable_set :@loaded, true
     

data/spec/rails-ioc/singleton_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path("../../spec_helper.rb", __FILE__)
+
+describe RailsIOC::Singleton do
+  class TestClass
+    attr_reader :text
+    def initialize(text)
+      @text = text
+    end
+  end
+  
+  it "always returns the same instance once build has been called" do
+    singleton = RailsIOC::Singleton.new(TestClass, ["I am a singleton"])
+    singleton.build.text.should == "I am a singleton"
+    singleton.build.should === singleton.build
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-ioc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-29 00:00:00.000000000Z
+date: 2011-09-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70311518245340 !ruby/object:Gem::Requirement
+  requirement: &70174147087040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70311518245340
+  version_requirements: *70174147087040
 description: Simple dependency injection for Rails.
 email:
 - rick@rickgrundy.com
@@ -34,12 +34,15 @@ files:
 - README.markdown
 - Rakefile
 - lib/rails-ioc.rb
+- lib/rails-ioc/Reference.rb
 - lib/rails-ioc/controller_extension.rb
 - lib/rails-ioc/dependencies.rb
 - lib/rails-ioc/dependency_constructor.rb
 - lib/rails-ioc/dependency_injector.rb
 - lib/rails-ioc/errors.rb
+- lib/rails-ioc/prototype.rb
 - lib/rails-ioc/rspec_extension.rb
+- lib/rails-ioc/singleton.rb
 - lib/rails-ioc/version.rb
 - rails-ioc.gemspec
 - spec/fixtures/config/dependencies/incrementing_test.rb
@@ -49,7 +52,9 @@ files:
 - spec/rails-ioc/dependencies_spec.rb
 - spec/rails-ioc/dependency_constructor_spec.rb
 - spec/rails-ioc/dependency_injector_spec.rb
+- spec/rails-ioc/prototype_spec.rb
 - spec/rails-ioc/rspec_extension_spec.rb
+- spec/rails-ioc/singleton_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper_spec_spec_spec_spec.rb
 homepage: http://www.github.com/rickgrundy/rails-ioc
@@ -84,6 +89,8 @@ test_files:
 - spec/rails-ioc/dependencies_spec.rb
 - spec/rails-ioc/dependency_constructor_spec.rb
 - spec/rails-ioc/dependency_injector_spec.rb
+- spec/rails-ioc/prototype_spec.rb
 - spec/rails-ioc/rspec_extension_spec.rb
+- spec/rails-ioc/singleton_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper_spec_spec_spec_spec.rb