rails-ioc 0.1.0 → 0.1.1

data/README.markdown

@@ -1,155 +1,143 @@
 ## Quickstart
 
-Gemfile:
-
-    ```ruby
-    gem 'rails-ioc'
-    ```
-
-config/dependencies/development.rb:
-
-    ```ruby
-    RailsIOC::Dependencies.define do     
-      prototype :ccv, CreditCardValidator, "Visa", "Mastercard"
-      prototype :payment_gateway, DummyPaymentGateway, ref(:ccv)
-
-      controller PaymentsController, {
-        payment_gateway: ref(:payment_gateway),
-      }
-    end   
-    ```
-    
-app/controllers/payments_controller.rb:
-
   ```ruby
+  # Gemfile:
+  gem 'rails-ioc'
+
+  # config/dependencies/development.rb:
+  RailsIOC::Dependencies.define do     
+    prototype :card_validator,  CreditCardValidator, "Visa", "Mastercard"
+    prototype :payment_gateway, DummyPaymentGateway, ref(:card_validator)
+  
+    controller PaymentsController, {
+      payment_gateway: ref(:payment_gateway),
+    }
+  end   
+
+  # app/controllers/payments_controller.rb:
   class PaymentsController < ApplicationController
     def accept_payment
       @payment_gateway.process(params[:credit_card])
     end
   end
+
+  # spec/controllers/payments_controller_spec.rb
+  it "processes a succesful payment" do
+    controller_dependencies(payment_gateway: mock(PaymentGateway))
+    controller.payment_gateway.should_receive(:process).with("4111").and_return(true)
+    post :accept_payment, credit_card: "4111"
+    response.status.should == 200
+  end
   ```
 
 ## Background
 
-Inversion of control by dependency injection is widely used in large software systems and is generally accepted as being a "good idea". If the terms are unfamiliar, do some research before going any further. These are good places to start: 
+Inversion of control via dependency injection is widely used in large software systems and is generally accepted to be a "Good Thing". If the terms are unfamiliar these are good places to start reading: 
 
 - http://en.wikipedia.org/wiki/Inversion_of_control
 - http://martinfowler.com/articles/injection.html
 
-The practice as described in the articles above is not particularly common in Ruby applications. Jamis Buck, author of the erstwhile DI framework [Copland](http://copland.rubyforge.org) makes a [compelling argument](http://weblog.jamisbuck.org/2008/11/9/legos-play-doh-and-programming) against it. If you have to ask the question "will I need IOC for my next Rails app", the answer is almost certainly "No". The core components of a standard Rails app usually interact politely  and can generally be tested reasonably easily in most apps.
+The practice as described in the articles above is not particularly common in Ruby applications. Jamis Buck, author of the erstwhile DI framework [Copland](http://copland.rubyforge.org) makes a [compelling argument](http://weblog.jamisbuck.org/2008/11/9/legos-play-doh-and-programming) against it. If you have to ask the question "Will I need IOC for my next Rails app", the answer is almost certainly "No". The core components of a standard Rails app usually interact politely and can generally be easily tested.
 
-Still, having run into several Rails projects which dealt with dependencies beyond a simple ActiveRecord database connection (payment gateways, email services, version control systems, image processing services and more) I realised that I was reminiscing fondly about Java and .NET's various containers for two reasons:
+Still, having run into several Rails projects which dealt with dependencies beyond an ActiveRecord database connection (payment gateways, email services, version control systems, image processing services and more) I realised that I was reminiscing fondly about Java and .NET's various containers for two reasons:
 
-1. I really hate mocking calls to MyService#new to force a controller to use a stub implementation in a unit test.
-2. There is no clean way to switch dependencies out on a per-environment basis (to use the testable version of a payment gateway in the staging environment, for example).
+1. **I really despise mocking calls to MyService#new to force a controller to use a stub implementation in a unit test.**
+2. **There is no clean way to switch dependencies out on a per-environment basis (to use the testable version of a payment gateway in the staging environment, for example).**
 
-RailsIOC attempts to make these problems less painful for applications with complex interactions with external services by providing a very lightweight way to define dependencies and inject them into ActionController. The patterns will be familiar to anyone who has used [Spring](http://www.springsource.org/documentation) or [Unity](http://msdn.microsoft.com/en-us/library/dd203319.aspx). Where possible, RailsIOC enforces constructor injection. The exception to this rule is the creation of controllers, where it avoids interfering with Rails' own instantiation and injects dependencies as local @variables.
+RailsIOC attempts to make these problems less painful for applications with complex interactions with external services by providing a lightweight way to define dependencies and inject them into ActionController. The patterns will be familiar to anyone who has used [Spring](http://www.springsource.org/documentation) or [Unity](http://msdn.microsoft.com/en-us/library/dd203319.aspx). Dependencies are defined in pure Ruby using a simple internal DSL. Where possible, RailsIOC enforces constructor injection. The exception to this rule is the creation of controllers, where it avoids interfering with Rails' own instantiation and injects dependencies as @local_variables.
 
 ## Cleaner Testing
 ### Before
     
-    ```ruby
-    #Controller
-    @gateway = Gateway.new(ServiceA.new, ServiceB.new)
-    @gateway.do_something!
-
-    #RSpec
-    @svc_a = mock(ServiceA)
-    @svc_b = mock(ServiceB)
-    ServiceA.stub(:new).and_return(@svc_a)
-    ServiceB.stub(:new).and_return(@svc_b)
-    @gateway = mock(Gateway)
-    @gateway.should_receive(:do_something!).and_return(12345)
-    Gateway.stub(:new).with(@svc_a, @svc_b).and_return(@gateway)
-    ```
+  ```ruby
+  # Controller:
+  @gateway = Gateway.new(ServiceA.new, ServiceB.new)
+  @gateway.do_something!
+  
+  # RSpec:
+  @svc_a = mock(ServiceA)
+  @svc_b = mock(ServiceB)
+  ServiceA.stub(:new).and_return(@svc_a)
+  ServiceB.stub(:new).and_return(@svc_b)
+  @gateway = mock(Gateway)
+  @gateway.should_receive(:do_something!).and_return(12345)
+  Gateway.stub(:new).with(@svc_a, @svc_b).and_return(@gateway)
+  ```
 
 ### After
 
-    ```ruby
-    #Controller
-    @gateway.do_something!
-
-    #RSpec
-    @gateway = mock(Gateway)
-    @gateway.should_receive(:do_something!).and_return(12345)
-    controller_dependencies(gateway: @gateway)
-    ```
+  ```ruby
+  # Controller:
+  @gateway.do_something!
+  
+  # RSpec:
+  controller_dependencies(gateway: mock(Gateway))
+  controller.gateway.should_receive(:do_something!).and_return(12345)
+  ```
 
-## Customise Dependencies Per-Environment
+## Customise and Override Dependencies Per-Environment
 ### Before
-
-PaymentController:
     
-    ```ruby
-    class PaymentsController < ApplicationController
-      def accept_payment
-        if Rails.env.development? || Rails.env.test?
-          @credit_card_validator = BogusCardValidator.new
-        else
-          @credit_card_validator = RealCardValidator.new
-        end
-        if Rails.env.production? 
-          @gateway = RealPaymentGateway.new
-        elsif Rails.env.staging? 
-          @gateway = RealPaymentGateway.new(:use_testing_url)
-        else
-          @gateway = BogusPaymentGateway.new
-        end
-        card = @credit_card_validator.validate(params[:card])
-        @gateway.process(card)
+  ```ruby
+  # app/controllers/payments_controller.rb:
+  class PaymentsController < ApplicationController
+    def accept_payment
+      if Rails.env.development? || Rails.env.test?
+        @credit_card_validator = BogusCardValidator.new
+      else
+        @credit_card_validator = RealCardValidator.new
       end
+      if Rails.env.production? 
+        @gateway = RealPaymentGateway.new
+      elsif Rails.env.staging? 
+        @gateway = RealPaymentGateway.new(use_testing_url: true)
+      else
+        @gateway = BogusPaymentGateway.new
+      end
+      card = @credit_card_validator.validate(params[:card])
+      @gateway.process(card)
     end
-    ```
+  end
+  ```
 
 ### After
 
-
-app/controllers/payments_controller:
-
-    ```ruby
-    class PaymentsController < ApplicationController
-      def accept_payment    
-        card = @credit_card_validator.validate(params[:card])
-        @gateway.process(card)
-      end
+  ```ruby
+  # app/controllers/payments_controller:
+  class PaymentsController < ApplicationController
+    def accept_payment    
+      card = @credit_card_validator.validate(params[:card])
+      @gateway.process(card)
     end
-    ```
+  end
     
-config/dependencies/production.rb:
-
-    ```ruby
-    RailsIOC::Dependencies.define do
-      prototype :payment_gateway, RealPaymentGateway
-      prototype :credit_card_validator, RealCardValidator
-      
-      controller MyController, {
-        gateway: ref(:payment_gateway)
-        credit_card_validator: ref(:credit_card_validator)
-      }
-    end
-    ```
-        
-config/dependencies/staging.rb:
-
-    ```ruby
-    RailsIOC::Dependencies.define do
-      inherit_environment(:production)
-      
-      controller MyController, {
-        gateway: prototype(:payment_gateway, RealPaymentGateway, :use_test_url)
-      }
-    end
-    ```
+  # config/dependencies/production.rb:
+  RailsIOC::Dependencies.define do
+    prototype :payment_gateway,       RealPaymentGateway
+    prototype :credit_card_validator, RealCardValidator
     
-config/dependencies/development.rb:
+    controller PaymentsController, {
+      gateway:               ref(:payment_gateway)
+      credit_card_validator: ref(:credit_card_validator)
+    }
+  end
 
-    ```ruby
-    RailsIOC::Dependencies.define do
-      inherit_environment(:production)
+  # config/dependencies/staging.rb:
+  RailsIOC::Dependencies.define do
+    inherit_environment(:production)
+    
+    controller PaymentsController, {
+      gateway: prototype(RealPaymentGateway, use_testing_url: true)
+    }
+  end
 
-      controller MyController, {
-        gateway: singleton(BogusPaymentGateway),
-        credit_card_validator: singleton(BogusCardValidator)
-      }
-    end
-    ```
+  # config/dependencies/development.rb:
+  RailsIOC::Dependencies.define do
+    inherit_environment(:production)
+  
+    controller PaymentsController, {
+      gateway:               singleton(BogusPaymentGateway),
+      credit_card_validator: singleton(BogusCardValidator)
+    }
+  end
+  ```

data/lib/rails-ioc/dependencies.rb

@@ -3,7 +3,7 @@ module RailsIOC
     def self.reset!
       @dependencies = {}
       @controllers = {}
-      @loaded = false      
+      @loaded = false 
     end
     self.reset!
     

data/lib/rails-ioc/rspec_extension.rb

@@ -11,6 +11,7 @@ module RailsIOC
       Dependencies.define do
         controller klass, dependencies
       end
+      dependencies.keys.each { |field| controller.class.send(:attr_reader, field) }
     end
   end
 end

data/lib/rails-ioc/version.rb

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

data/spec/rails-ioc/controller_extension_spec.rb

@@ -1,18 +1,6 @@
 require File.expand_path("../../spec_helper.rb", __FILE__)
 
-describe RailsIOC::ControllerExtension do
-  class ExtendedController    
-    def self.before_filter(method_name)
-      @@before_filter_method = method_name
-    end
-    
-    def trigger_before_filter!
-      self.send(@@before_filter_method)
-    end
-    
-    include RailsIOC::ControllerExtension
-  end
-  
+describe RailsIOC::ControllerExtension do  
   it "injects pre-defined dependencies" do        
     Rails.application.config.cache_classes = true
     RailsIOC::Dependencies.instance_variable_set :@loaded, true

data/spec/rails-ioc/dependencies_spec.rb

@@ -99,8 +99,7 @@ describe RailsIOC::Dependencies do
   describe "controllers" do
     it "stores controller dependencies for later injection by Rails' before_filter" do      
       RailsIOC::Dependencies.define do
-        prototype :second_node, TestListNode
-        singleton :first_node, TestListNode, ref(:second_node)
+        singleton :first_node, TestListNode
         
         controller TestController, {
            foo: ref(:first_node),
@@ -115,13 +114,27 @@ describe RailsIOC::Dependencies do
       controller.foo.should === RailsIOC::Dependencies.ref(:first_node)
       controller.bar.should == "The Sheep Says Bar"
     end
+    
+    it "merges overriden controller dependencies" do
+      RailsIOC::Dependencies.define do
+        controller TestController, {
+           foo: "original foo",
+           bar: "original bar"
+        }
+      end
+      
+      RailsIOC::Dependencies.define do
+        controller TestController, {
+           bar: "override bar"
+        }
+      end
+      
+      RailsIOC::Dependencies.controllers[TestController][:foo].should == "original foo"
+      RailsIOC::Dependencies.controllers[TestController][:bar].should == "override bar"
+    end
   end
   
-  describe "loading dependencies file" do
-    before(:each) do
-      GlobalCounter.zero!
-    end
-    
+  describe "loading dependencies file" do    
     it "reloads the file if cache_classes is false" do
       Rails.env = "incrementing_test"
       Rails.application.config.cache_classes = false

data/spec/rails-ioc/rspec_extension_spec.rb

@@ -1,8 +1,9 @@
 require File.expand_path("../../spec_helper.rb", __FILE__)
 
 describe RailsIOC::RSpecExtension do
-  class MyController; end
-  def controller; MyController.new; end
+  def controller
+    @controller ||= ExtendedController.new
+  end
   
   describe "resetting dependencies between tests" do
     after(:each) do
@@ -18,8 +19,12 @@ describe RailsIOC::RSpecExtension do
     end
   end
   
-  it "provides a shorthand way to define controller dependencies" do
+  it "provides a shorthand way to define and expose controller dependencies" do    
+    Rails.application.config.cache_classes = true
+    RailsIOC::Dependencies.instance_variable_set :@loaded, true
+    
     controller_dependencies(who_am_i: "The Walrus")
-    RailsIOC::Dependencies.controllers[MyController][:who_am_i].should == "The Walrus"
+    controller.trigger_before_filter!
+    controller.who_am_i.should == "The Walrus"
   end
 end

data/spec/spec_helper.rb

@@ -1,25 +1,17 @@
-def ignoring_warnings
-  verbosity = $VERBOSE
-  $VERBOSE = nil
-  yield
-ensure
-  $VERBOSE = verbosity
-end
-
-class GlobalCounter
-  def self.zero!
-    @count = 0
-  end
-  
-  def self.increment!
-    @count += 1
-  end
-  
-  def self.count
-    @count
+module ActionController
+  class Base
+    def self.before_filter(method_name)
+      @@before_filter_method = method_name
+    end
+    
+    def trigger_before_filter!
+      self.send(@@before_filter_method)
+    end
   end
 end
 
+class ExtendedController < ActionController::Base; end
+
 class AdHocObject  
   def initialize
     @store = {}
@@ -34,29 +26,30 @@ class AdHocObject
   end
 end
 
-module FakeActionController
-  class Base
-    def self.before_filter(method_name); end 
-  end
-end
+Rails = AdHocObject.new
+Rails.application = AdHocObject.new
+Rails.application.config = AdHocObject.new
+Rails.root = File.expand_path("../fixtures", __FILE__)
 
-def reset_fake_dependencies!
-  ignoring_warnings do
-    Object.send(:const_set, :Rails, AdHocObject.new)
-    Rails.application = AdHocObject.new
-    Rails.application.config = AdHocObject.new
-    Rails.root = File.expand_path("../fixtures", __FILE__)
 
-    Object.send(:const_set, :ActionController, FakeActionController)
+class GlobalCounter
+  def self.zero!
+    @count = 0
+  end
+  
+  def self.increment!
+    @count += 1
+  end
+  
+  def self.count
+    @count
   end
 end
 
 RSpec.configure do |config|
   config.before(:each) do
     GlobalCounter.zero!
-    reset_fake_dependencies!
   end
 end
 
-reset_fake_dependencies!
 require File.expand_path("../../lib/rails-ioc.rb", __FILE__)

data/spec/spec_helper_spec_spec_spec_spec.rb

@@ -24,23 +24,4 @@ describe "Spec Helper" do
     Rails.application.config.kittens = "Small Cats"
     Rails.application.config.kittens.should == "Small Cats"
   end
-  
-  describe "resetting fake Rails environment between tests" do
-    after(:each) do
-      ignoring_warnings do
-        Rails = nil
-        ActionController = nil
-      end
-    end
-    
-    it "resets Rails before this test" do
-      ActionController.should_not be_nil
-      Rails.application.should_not be_nil
-    end    
-    
-    it "resets Rails before this test too" do
-      ActionController.should_not be_nil
-      Rails.application.should_not be_nil
-    end
-  end
 end

metadata

@@ -1,39 +1,34 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rails-ioc
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.1
   prerelease: 
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Rick Grundy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-29 00:00:00 +10:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70311518245340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *70311518245340
 description: Simple dependency injection for Rails.
-email: 
+email:
 - rick@rickgrundy.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.markdown
@@ -57,35 +52,31 @@ files:
 - spec/rails-ioc/rspec_extension_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper_spec_spec_spec_spec.rb
-has_rdoc: true
 homepage: http://www.github.com/rickgrundy/rails-ioc
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: rails-ioc
-rubygems_version: 1.5.0
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Simple dependency injection for Rails.
-test_files: 
+test_files:
 - spec/fixtures/config/dependencies/incrementing_test.rb
 - spec/fixtures/config/dependencies/production.rb
 - spec/fixtures/config/dependencies/test.rb