deject 0.0.2 → 0.1.0

data/deject.gemspec

@@ -12,9 +12,9 @@ Gem::Specification.new do |s|
   s.description = %q{Provides a super simple API for dependency injection}
 
   s.rubyforge_project = "deject"
-  
+
   s.required_ruby_version = "~> 1.9.2"
-  
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -23,5 +23,4 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec"
   s.add_development_dependency "pry"
-  # s.add_runtime_dependency "rest-client"
 end

data/lib/deject.rb

@@ -1,8 +1,100 @@
-case ENV['deject_implementation']
-when 'object_oriented'
-  require 'deject/object_oriented'
-else
-  require 'deject/functional'
+require "deject/version"
+
+module Deject
+  UninitializedDependency = Class.new StandardError
+
+  class << self
+    def register(name, &initializer)
+      raise ArgumentError, "#{name} has been registered multiple times" if registered? name
+      raise ArgumentError, "#{name} has been registered with Deject without an initialization block" unless initializer
+      @registered[name.intern] = initializer
+    end
+
+    def registered(name)
+      @registered[name.intern]
+    end
+
+    def registered?(name)
+      @registered.has_key? name.intern
+    end
+
+    def reset
+      @registered = {}
+    end
+  end
+
+  reset
 end
 
-require "deject/version"
+# Not a common way of writing code in Ruby, I know.
+# But I tried out several implementations and found this was the easiest to
+# work with within the constraints of the gem (that it doesn't leave traces
+# of itself all over your objects)
+def Deject(klass)
+  uninitialized_error = lambda do |meth|
+    raise Deject::UninitializedDependency, "#{meth} invoked before being defined"
+  end
+
+  define_instance_methods = lambda do |meth, default_block|
+    # define the getter
+    define_method meth do
+      block = default_block || Deject.registered(meth)
+      uninitialized_error[meth] unless block
+      value = block.call self
+      define_singleton_method(meth) { value }
+      send meth
+    end
+
+    # define the override
+    define_method :"with_#{meth}" do |value=nil, &block|
+
+      # redefine getter if given a block
+      if block
+        define_singleton_method meth do
+          value = block.call self
+          define_singleton_method(meth) { value }
+          send meth
+        end
+
+      # always return value if given a value
+      else
+        define_singleton_method(meth) { value }
+      end
+
+      self
+    end
+    self
+  end
+
+  has_dependency = lambda do |meth|
+    instance_methods.include?(meth.intern) && instance_methods.include?(:"with_#{meth}")
+  end
+
+
+  # define klass.dependency
+  klass.define_singleton_method :dependency do |meth, &default_block|
+    if instance_exec meth, &has_dependency
+      warn "Deprecation: Use .override instead of .dependency to override a dependency"
+    end
+    instance_exec meth, default_block, &define_instance_methods
+  end
+
+  # define klass.override
+  klass.define_singleton_method :override do |meth, &override_block|
+    if !override_block
+      raise ArgumentError, "Cannot override #{meth} without an override block" unless override_block
+    elsif !instance_exec(meth, &has_dependency)
+      raise ArgumentError, "#{meth} is not a dependency of #{klass.inspect}"
+    else
+      instance_exec meth, override_block, &define_instance_methods
+    end
+  end
+
+  # override multiple dependencies
+  klass.send :define_method, :with_dependencies do |overrides|
+    overrides.each { |meth, value| send "with_#{meth}", value }
+    self
+  end
+
+  klass
+end

data/lib/deject/version.rb

@@ -1,3 +1,3 @@
 module Deject
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/spec/acceptance_spec.rb

@@ -1,4 +1,4 @@
-require 'deject'
+require 'spec_helper'
 
 describe Deject, 'acceptance tests' do
   example 'setting and overriding' do
@@ -22,13 +22,13 @@ describe Deject, 'acceptance tests' do
 
     class Service
       Deject self
-      dependency(:client) { Client.new credentials }
+      dependency(:client) { |service| Client.new service.credentials }
 
       attr_accessor :name
 
       def initialize(name)
         self.name = name
-      end        
+      end
 
       def login
         client.login name
@@ -51,7 +51,7 @@ describe Deject, 'acceptance tests' do
     Service.new('sally').with_client(client).login
 
     client_class, client = double, double
-    george = Service.new('george').with_client { client_class.new credentials }
+    george = Service.new('george').with_client { |service| client_class.new service.credentials }
     client_class.should_receive(:new).with(george.credentials).and_return(client)
     client.should_receive(:login).with('george')
     george.login

data/spec/class_methods_spec.rb

@@ -1,4 +1,4 @@
-require 'deject'
+require 'spec_helper'
 
 
 describe 'Klass.dependency' do
@@ -10,7 +10,7 @@ describe 'Klass.dependency' do
     meth   = 'meth'.freeze
     result = 100
     before { klass.dependency(meth) { result } }
-    
+
     it 'adds the instance method' do
       klass.new.should respond_to meth
     end
@@ -18,11 +18,20 @@ describe 'Klass.dependency' do
     specify 'the instance method defaults to the result of the init block' do
       klass.new.send(meth).should == result
     end
-    
-    specify 'the instance method is evaluated within the context of the instance' do
+
+    specify 'the instance method is evaluated within the context of the caller' do
       klass.dependency(:a) { b }
       instance = klass.new
       def instance.b() 10 end
+      def self.b() 20 end
+      instance.a.should == self.b
+    end
+
+    specify 'the instance method is passed the instance' do
+      klass.dependency(:a) { |instance| instance.b }
+      instance = klass.new
+      def instance.b() 10 end
+      def self.b() end
       instance.a.should == instance.b
     end
   end
@@ -37,5 +46,43 @@ describe 'Klass.dependency' do
       klass.dependency :jjjjj
       expect { klass.new.jjjjj }.to raise_error(Deject::UninitializedDependency, /jjjjj/)
     end
+
+    it 'uses the global block if provided, passing it the instance' do
+      Deject.register(:meth) { |instance| instance.value }
+      klass.dependency :meth
+      instance = klass.new
+      def instance.value() :value end
+      instance.meth.should == :value
+    end
+  end
+
+  it 'writes a deprecated warning when using dependency to override an existing dependency' do
+    catch_stderr { klass.dependency :dep }.should == ""
+    catch_stderr { klass.dependency :dep }.should =~ /deprecat/i
+  end
+end
+
+
+describe 'Klass.override' do
+  let(:klass) { Deject Class.new }
+
+  it "raises an ArgumentError if called for a dependency that doesn't exist" do
+    expect { klass.override(:dep) {} }.to raise_error ArgumentError, /dep/
+  end
+
+  it "raises an ArgumentError if called without a block" do
+    klass.dependency :dep
+    expect { klass.override :dep }.to raise_error ArgumentError, /block/
+  end
+
+  it 'overrides the dependency on the instance' do
+    klass.dependency :dep
+    klass.override(:dep) { 123 }
+    klass.new.dep.should == 123
+  end
+
+  it 'returns the class' do
+    klass.dependency :dep
+    klass.override(:dep) { 123 }.should equal klass
   end
 end

data/spec/deject_function_spec.rb

@@ -1,14 +1,20 @@
-require 'deject'
+require 'spec_helper'
 
 describe 'Deject()' do
   let(:klass) { Class.new }
-  
+
   it 'adds the dependency method to the class' do
     klass.should_not respond_to :dependency
     Deject klass
     klass.should respond_to :dependency
   end
 
+  it 'adds the override_dependency method to the class' do
+    klass.should_not respond_to :override
+    Deject klass
+    klass.should respond_to :override
+  end
+
   it 'returns the class' do
     Deject(klass).should be klass
   end

data/spec/global_registration_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Deject, '.register and registered' do
+  let(:value) { 12 }
+
+  after { Deject.reset }
+
+  it 'accepts a string' do
+    Deject.register("abc") { value }
+    Deject.registered("abc").call.should == value
+    Deject.registered(:abc).call.should == value
+  end
+
+  it 'accepts a symbol' do
+    Deject.register(:abc) { value }
+    Deject.registered("abc").call.should == value
+    Deject.registered(:abc).call.should == value
+  end
+
+  it 'register raises an ArgumentError if not provided with a block' do
+    expect { Deject.register :abc }.to raise_error ArgumentError, /block/i
+  end
+
+  it 'remembers what it was registered with' do
+    i = 0
+    Deject.register(:abc) { i += 1 }
+    Deject.registered(:abc).call.should == 1
+    i.should == 1
+  end
+
+  it 'returns nil when asked for something not registered' do
+    Deject.registered(:abc).should == nil
+  end
+
+  it 'raises an ArgumentError error if registration clobbers a previously set value' do
+    Deject.register(:abc){}
+    expect { Deject.register(:abc){} }.to raise_error ArgumentError, /abc/
+  end
+
+  it 'knows what has been registered' do
+    Deject.should_not be_registered :abc
+    Deject.should_not be_registered 'abc'
+    Deject.register(:abc) {}
+    Deject.should be_registered :abc
+    Deject.should be_registered 'abc'
+  end
+end

data/spec/instance_methods_spec.rb

@@ -1,4 +1,4 @@
-require 'deject'
+require 'spec_helper'
 
 describe 'after initializing a dependency' do
   let(:klass) { Deject Class.new }
@@ -27,7 +27,7 @@ describe 'after initializing a dependency' do
     klass.dependency(:number1) { 1 }
     klass.dependency(:number2) { 2 }
     i = 0
-    instance = klass.new.with_number2 { i += number1 }
+    instance = klass.new.with_number2 { |instance| i += instance.number1 }
     instance.number2.should == instance.number1
     instance.number2.should == instance.number1
     i.should == instance.number1
@@ -43,4 +43,11 @@ describe 'after initializing a dependency' do
     instance.a.should == 10
     instance.b.should == 20
   end
+
+  specify '#with_<dependency> is passed the instance' do
+    klass.dependency(:a) { |instance| instance.b }
+    instance = klass.new
+    def instance.b() 10 end
+    instance.a.should == instance.b
+  end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'deject'
+
+catch_stderr = Module.new do
+  require 'stringio'
+
+  def catch_stderr
+    old_stderr = $stderr
+    $stderr = StringIO.new
+    yield
+  ensure
+    to_return = $stderr.string
+    $stderr = old_stderr
+    return to_return
+  end
+end
+
+RSpec.configure do |config|
+  config.include catch_stderr
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deject
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-05 00:00:00.000000000Z
+date: 2012-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70212469081760 !ruby/object:Gem::Requirement
+  requirement: &70114295054960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70212469081760
+  version_requirements: *70114295054960
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70212469080980 !ruby/object:Gem::Requirement
+  requirement: &70114295054020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70212469080980
+  version_requirements: *70114295054020
 description: Provides a super simple API for dependency injection
 email:
 - josh.cheek@gmail.com
@@ -46,13 +46,13 @@ files:
 - Readme.md
 - deject.gemspec
 - lib/deject.rb
-- lib/deject/functional.rb
-- lib/deject/object_oriented.rb
 - lib/deject/version.rb
 - spec/acceptance_spec.rb
 - spec/class_methods_spec.rb
 - spec/deject_function_spec.rb
+- spec/global_registration_spec.rb
 - spec/instance_methods_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/JoshCheek/deject
 licenses: []
 post_install_message: 
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: deject
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Simple dependency injection
@@ -81,4 +81,7 @@ test_files:
 - spec/acceptance_spec.rb
 - spec/class_methods_spec.rb
 - spec/deject_function_spec.rb
+- spec/global_registration_spec.rb
 - spec/instance_methods_spec.rb
+- spec/spec_helper.rb
+has_rdoc: 

data/lib/deject/functional.rb

@@ -1,48 +0,0 @@
-module Deject
-  UninitializedDependency = Class.new StandardError
-end
-
-def Deject(klass)
-  uninitialized_error = lambda do |meth|
-    raise Deject::UninitializedDependency, "#{meth} invoked before being defined"
-  end
-
-  # define klass.dependency
-  klass.define_singleton_method :dependency do |meth, &default_block|
-
-    # define the getter
-    define_method meth do
-      uninitialized_error[meth] unless default_block
-      value = instance_eval &default_block
-      define_singleton_method(meth) { value }
-      send meth
-    end
-
-    # define the override
-    define_method :"with_#{meth}" do |value=nil, &block|
-
-      # redefine getter if given a block
-      if block
-        define_singleton_method meth do
-          value = instance_eval &block
-          define_singleton_method(meth) { value }
-          send meth
-        end
-
-      # always return value if given a value
-      else
-        define_singleton_method(meth) { value }
-      end
-
-      self
-    end      
-  end
-
-  # override multiple dependencies
-  klass.send :define_method, :with_dependencies do |overrides|
-    overrides.each { |meth, value| send "with_#{meth}", value }
-    self
-  end
-
-  klass
-end

data/lib/deject/object_oriented.rb

@@ -1,82 +0,0 @@
-def Deject(klass)
-  klass.extend Deject
-end
-
-module Deject
-  UninitializedDependency = Class.new StandardError
-
-  def dependency(meth, &block)
-    InstanceMethods.for self, meth, block
-  end
-
-
-  class InstanceMethods
-    attr_accessor :klass, :meth, :initializer, :ivar
-    
-    def self.for(klass, meth, initializer)
-      instance = new klass, meth, initializer
-      instance.define_getter
-      instance.define_override
-      instance.define_multi_override
-    end
-
-    def initialize(klass, meth, initializer)
-      self.klass, self.meth, self.initializer, self.ivar = klass, meth, initializer, "@#{meth}"
-    end
-
-    def define_getter
-      ivar, meth, initializer = self.ivar, self.meth, self.initializer
-      klass.send :define_method, meth do
-        unless instance_variable_defined? ivar
-          instance_variable_set ivar, Deject::Dependency.new(self, meth, initializer)
-        end
-        instance_variable_get(ivar).invoke
-      end
-    end
-
-    def define_override
-      ivar, meth = self.ivar, self.meth
-      klass.send :define_method, "with_#{meth}" do |value=nil, &initializer|
-        initializer ||= Proc.new { value }
-        instance_variable_set ivar, Deject::Dependency.new(self, meth, initializer)
-        self
-      end
-    end
-
-    def define_multi_override
-      klass.send :define_method, :with_dependencies do |overrides|
-        overrides.each { |meth, value| send "with_#{meth}", value }
-        self
-      end
-    end
-  end
-
-
-  class Dependency < Struct.new(:instance, :dependency, :initializer)
-    attr_accessor :result
-
-    def invoke
-      validate_initializer!
-      memoized_result
-    end
-
-    def validate_initializer!
-      return if initializer
-      raise UninitializedDependency, "#{dependency} invoked before being defined"
-    end
-
-    def memoized_result
-      memoize! unless memoized?
-      result
-    end
-
-    def memoized?
-      @memoized
-    end
-
-    def memoize!
-      @memoized = true
-      self.result = instance.instance_eval &initializer
-    end
-  end
-end