pharrell 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c591314692d9690e8940b3f0b72b8dc1cc3926c
-  data.tar.gz: e7e948670a4f517771e7bdcf4207579e1557706f
+  metadata.gz: 215dcc88ee3de7ae14a1eeddedc53c20107eff12
+  data.tar.gz: 3c764dea55c0a016897d48aebf45dcda94d36ab1
 SHA512:
-  metadata.gz: e893aea8b98ef7bf417db1006d2879ff3d567fe9f4dd4ebbd0d9361cdf5a2663c9db3e976d1be745e8ca07a5552291d83fd51afc2f169f95732fbb453c85b390
-  data.tar.gz: 658f2f56202b8e1a2b277ed37e075ee59763cd0d9d9456e47085b87c2d0dc7a41a5db24e054bedd6bca6fc895e243dae87d35d99bce83d4add5ef9baccb55840
+  metadata.gz: 5fdb941ba17003b0d38ece0bce1afeb6badef92813bda177b9488ecf4c3813c3a339e5217f8035560b20d3b0ae4c89fa39dff7fa1569acb3947fe69ba288c866
+  data.tar.gz: 9aa73f0950dfe32bccfb8879ef3a4ad2a88feaf388947f0e77103cbc6268aa50a9585f20de63510024690595e4000141bcf21348ab34af4de36257a8adbeeabf

data/.gitignore

@@ -1 +0,0 @@
-coverage/*

data/.travis.yml

@@ -2,4 +2,5 @@ language: ruby
 rvm:
     - 1.9.3
     - 2.0.0
+    - 2.1.0
     - jruby-19mode

data/Gemfile

@@ -4,5 +4,4 @@ gemspec
 
 group :test do
   gem 'rake'
-  gem 'coveralls'
 end

data/Gemfile.lock

@@ -1,37 +1,16 @@
 PATH
   remote: .
   specs:
-    pharrell (0.8.0)
+    pharrell (0.8.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coveralls (0.7.0)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
-    docile (1.1.3)
-    mime-types (2.2)
-    multi_json (1.9.2)
     rake (10.1.1)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    simplecov (0.8.2)
-      docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    term-ansicolor (1.3.0)
-      tins (~> 1.0)
-    thor (0.18.1)
-    tins (1.0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  coveralls
   pharrell!
   rake

data/README.md

@@ -25,7 +25,7 @@ You can inject dependencies into classes like so:
 
 ```ruby
 class BlackBox
-  include Pharrell::Injectible
+  include Pharrell::Injectable
 
   injected :current_time, Time
 
@@ -36,7 +36,7 @@ class BlackBox
 end
 ```
 
-The values injected are dependent on the current conifguration:
+The values injected are dependent on the current configuration:
 
 ```ruby
 Pharrell.config(:base) do |config|
@@ -47,7 +47,7 @@ Pharrell.use_config(:base)
 ```
 
 You can use configurations to change the injected values in different
-scenarios. For instance, we can use Pharrell to help us test `CurrentTime` class
+scenarios. For instance, we can use Pharrell to help us test the `BlackBox` class
 defined above:
 
 ```ruby
@@ -71,12 +71,12 @@ end
 ### Constructor Injection
 
 When you're working with objects that have to be a black box
-(like a Rails controller for instance) you will need to inject dependencies
+(like a Rails controller for instance) you will need to inject dependencies artificially
 like in the basic example before. It's a lot nicer to be able to design your
 other objects so their dependencies are injected directly into their constructor i.e.
-they do not cheat. This will make your components easier reason about and easier to test.
+they do not cheat. This will make your components easier to reason about and easier to test.
 
-We can break the previous time code into into its object to achieve this:
+We can break the previous example into its object to achieve this:
 
 ```ruby
 class PrettyTime
@@ -91,8 +91,8 @@ class PrettyTime
 end
 ```
 
-This is great but what if we want to construct `PrettyTime` of these in the
-`BlackBox` class?
+This is great but what if we want to construct a `PrettyTime` instance in the
+`BlackBox` class without having to inject `Time`?
 
 For this we can use constructor injection:
 
@@ -117,7 +117,7 @@ We can then inject `PrettyTime` straight into `BlackBox`:
 
 ```ruby
 class BlackBox
-  include Pharrell::Injectible
+  include Pharrell::Injectable
 
   injected :pretty_time, PrettyTime
 
@@ -145,8 +145,8 @@ magic dependency injection (DI frameworks, stubbing factories etc) anywhere but
 
 ### Bindings
 
-When building configurations in pharrell you can bind instances to
-produce to classes in three different ways:
+When building configurations in pharrell you can bind instances in three different
+ways:
 
 ```ruby
 Pharrell.config(:example) do |config|
@@ -219,3 +219,11 @@ end
 
 Pharrell should be configured in the Rails Application's `#to_prepare` method as this runs at startup
 in production and before each request in development.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/pharrell.rb

@@ -4,60 +4,90 @@ require 'pharrell/constructor'
 require 'pharrell/errors'
 
 module Pharrell
-  @@configs = {}
-  @@config = nil
+  @@environment = nil
 
   def self.config(name, opts = {}, &blk)
-    check_options([:extends], opts)
-
-    if opts[:extends]
-      @@configs[name] = fetch_config(opts[:extends]).extend(blk)
-    else
-      @@configs[name] = Config.new(blk)
-    end
+    environment.config(name, opts, &blk)
   end
 
   def self.use_config(name)
-    @@config = name
-    rebuild!
+    environment.use_config(name)
   end
 
   def self.instance_for(klass)
-    current_config.instance_for(klass)
+    environment.instance_for(klass)
   end
 
   def self.rebuild!
-    current_config.rebuild!
+    environment.rebuild!
   end
 
   def self.reset!
-    @@configs = {}
-    @@config = nil
+    environment.reset!
   end
 
   private
 
-  def self.current_config
-    fetch_config(@@config)
+  def self.environment
+    @@enironment ||= Environment.new
   end
 
-  def self.fetch_config(name)
-    config = @@configs[name]
+  class Environment
+    @configs = {}
+    @config = nil
+
+    def config(name, opts = {}, &blk)
+      check_options([:extends], opts)
 
-    if config
-      config
-    else
-      raise ConfigNotDefinedError
+      if opts[:extends]
+        @configs[name] = fetch_config(opts[:extends]).extend(blk)
+      else
+        @configs[name] = Config.new(blk)
+      end
+    end
+
+    def use_config(name)
+      @config = name
+      rebuild!
+    end
+
+    def instance_for(klass)
+      current_config.instance_for(klass)
+    end
+
+    def rebuild!
+      current_config.rebuild!
+    end
+
+    def reset!
+      @configs = {}
+      @config = nil
+    end
+
+    private
+
+    def current_config
+      fetch_config(@config)
+    end
+
+    def fetch_config(name)
+      config = @configs[name]
+
+      if config
+        config
+      else
+        raise ConfigNotDefinedError.new(name)
+      end
     end
-  end
 
-  def self.check_options(opts, opt_hash)
-    extra_keys = opt_hash.keys.reject { |key| opts.include?(key) }
+    def check_options(opts, opt_hash)
+      extra_keys = opt_hash.keys.reject { |key| opts.include?(key) }
 
-    if extra_keys.empty?
-      true
-    else
-      raise InvalidOptionsError.new(extra_keys)
+      if extra_keys.empty?
+        true
+      else
+        raise InvalidOptionsError.new(extra_keys)
+      end
     end
   end
 end

data/lib/pharrell/config.rb

@@ -6,26 +6,26 @@ module Pharrell
 
     def instance_for(klass)
       binding = @bindings[klass]
-      
+
       if binding
         binding.call(self)
       else
-        raise BindingNotFoundError
+        raise BindingNotFoundError.new(klass)
       end
     end
 
     def rebuild!
-      @bindings =  Binder.new.tap { |b|
+      @bindings = Binder.new.tap { |b|
         @definition.call(b)
       }.bindings
     end
 
     def extend(definition)
-      agg_definition = proc { |binder| 
+      agg_definition = proc { |binder|
         @definition.call(binder)
-        definition.call(binder) 
+        definition.call(binder)
       }
-      
+
       Config.new(agg_definition)
     end
 
@@ -51,15 +51,15 @@ module Pharrell
           @bindings[klass] = obj_block
         end
       end
-      
+
       private
-      
+
       def build_instance(target_klass, config)
         if target_klass.respond_to?(:__pharrell_constructor_classes)
           args = target_klass.__pharrell_constructor_classes.map do |arg_klass|
             config.instance_for(arg_klass)
           end
-        
+
           target_klass.new(*args)
         else
           target_klass.new
@@ -68,4 +68,3 @@ module Pharrell
     end
   end
 end
-

data/lib/pharrell/errors.rb

@@ -1,13 +1,21 @@
 module Pharrell
   class BindingNotFoundError < Exception
+    def initialize(klass)
+      @klass = klass
+    end
+
     def message
-      "Binding could not be found!"
+      "Binding for #{@klass} could not be found!"
     end
   end
 
   class ConfigNotDefinedError < Exception
+    def initialize(config)
+      @config = config
+    end
+
     def message
-      "Config has not been defined!"
+      "Config '#{@config}' has not been defined!"
     end
   end
 

data/lib/pharrell/injectable.rb

@@ -5,6 +5,8 @@ module Pharrell
     end
 
     module ClassMethods
+      @@cache = {}
+
       def injected(name, klass=nil)
         if klass.nil?
           klass_name = name.to_s.split("_").map(&:capitalize).join
@@ -12,8 +14,8 @@ module Pharrell
         end
 
         define_method(name) do
-          @__pharrell_cache__ ||= {}
-          @__pharrell_cache__[klass] ||= Pharrell.instance_for(klass)
+          @@cache[self] ||= {}
+          @@cache[self][klass] ||= Pharrell.instance_for(klass)
         end
       end
     end

data/lib/pharrell/integration/rspec.rb

@@ -0,0 +1,26 @@
+module Pharrell
+  module Integration
+    module RSpec
+      def self.configure(config_name, rspec_config)
+        rspec_config.include(Pharrell::Injectable)
+        rspec_config.include(Pharrell::Integration::RSpec)
+
+        rspec_config.before(:each) do
+          Pharrell.use_config(config_name)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def use_config(config)
+          before(:each) do
+            Pharrell.use_config(config)
+          end
+        end
+      end
+    end
+  end
+end

data/pharrell.gemspec

@@ -3,11 +3,12 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name = "pharrell"
-  s.version = "0.8.0"
+  s.version = "0.8.1"
   s.platform = Gem::Platform::RUBY
   s.authors = ["Callum Stott"]
   s.email = ["callum@seadowg.com"]
   s.summary = "I'm a provider gurl. Basic but powerful dependency injection for Ruby."
+  s.description = "A dependency injection framework for Ruby. Allows Guice like functionality with both field and constructor injection."
   s.license = 'MIT'
   s.homepage = "http://github.com/seadowg/pharrell"
 

data/spec/injectable_spec.rb

@@ -57,6 +57,7 @@ describe "Injectable" do
 
       object = klass.new
       assert_equal(object.send(:injected_ob), object.send(:injected_ob))
+      refute_equal(object.send(:injected_ob), klass.new.send(:injected_ob))
     end
   end
 end

data/spec/integration_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'minitest/autorun'
+require 'pharrell'
+require 'pharrell/integration/rspec'
+
+describe "Integration" do
+  before do
+    Pharrell.reset!
+    FakeRSpec.reset!
+  end
+
+  describe "RSpec" do
+    describe ".use_config" do
+      it "sets the Pharrell config using before each" do
+        fake_spec = Class.new(FakeRSpec) do
+          include Pharrell::Integration::RSpec
+          use_config(:test)
+        end
+
+        Pharrell.config(:base) do |config|
+          config.bind(String, "Base")
+        end
+
+        Pharrell.config(:test) do |config|
+          config.bind(String, "Test")
+        end
+
+        Pharrell.use_config(:base)
+
+        fake_spec.new
+        befores = fake_spec.befores
+
+        assert_equal(1, befores[:each].length)
+        assert_equal("Base", Pharrell.instance_for(String))
+
+        befores[:each].first.call
+        assert_equal("Test", Pharrell.instance_for(String))
+      end
+    end
+
+    describe ".configure" do
+      it "sets up RSpec for use with Pharrell with theh passed config" do
+        fake_rspec = Class.new(FakeRSpec)
+        Pharrell::Integration::RSpec.configure(:test, fake_rspec)
+
+        Pharrell.config(:base) do |config|
+          config.bind(String, "Base")
+        end
+
+        Pharrell.config(:test) do |config|
+          config.bind(String, "Test")
+        end
+
+        Pharrell.use_config(:base)
+
+        fake_rspec.new
+        befores = fake_rspec.befores
+
+        assert_equal(1, befores[:each].length)
+        assert_equal("Base", Pharrell.instance_for(String))
+
+        befores[:each].first.call
+        assert_equal("Test", Pharrell.instance_for(String))
+      end
+    end
+  end
+end

data/spec/pharrell_spec.rb

@@ -6,7 +6,7 @@ describe "Pharrell" do
   before do
     Pharrell.reset!
   end
-  
+
   describe ".use_config" do
     it "switches Pharrell to use the specified config" do
       Pharrell.config(:test) do |config|
@@ -37,13 +37,13 @@ describe "Pharrell" do
 
       assert(first_instance != second_instance)
     end
-    
+
     it "raises a ConfigNotDefinedError if the config does not exist" do
       begin
         Pharrell.use_config(:main)
         flunk(".use_config did not raise an error!")
       rescue Pharrell::ConfigNotDefinedError => e
-        assert_equal("Config has not been defined!", e.message)
+        assert_equal("Config 'main' has not been defined!", e.message)
       end
     end
   end
@@ -63,16 +63,16 @@ describe "Pharrell" do
       assert_equal(Pharrell.instance_for(Object), "Object")
       assert_equal(Pharrell.instance_for(String), "Hello, Test")
     end
-    
+
     it "raises a ConfigNotDefinedError if the extended config does not exist" do
       begin
         Pharrell.config(:sub, :extends => :base)
         flunk(".config did not raise an error!")
       rescue Pharrell::ConfigNotDefinedError => e
-        assert_equal("Config has not been defined!", e.message)
+        assert_equal("Config 'base' has not been defined!", e.message)
       end
     end
-    
+
     it "raises an InvalidOptionsError for invalid options" do
       begin
         Pharrell.config(:base, :wrong_opt => "Value", :other_opt => "Value") { |config| }
@@ -96,18 +96,18 @@ describe "Pharrell" do
       assert(Pharrell.instance_for(Object) != original)
     end
   end
-  
+
   describe ".instance_for" do
     it "raises a BindingNotFoundError if there is no binding for the instance" do
       Pharrell.config(:main) { |config| }
       Pharrell.use_config(:main)
-      
+
       begin
         Pharrell.instance_for(Object)
         flunk(".instance_for did not raise an error!")
       rescue Pharrell::BindingNotFoundError => e
-        assert_equal("Binding could not be found!", e.message)
-      end 
+        assert_equal("Binding for Object could not be found!", e.message)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1 @@
-require 'simplecov'
-SimpleCov.start do
-  add_filter do |source_file|
-    source_file.filename =~ /spec/
-  end
-end
-
-require 'coveralls'
-Coveralls.wear!
+require_relative "support/fake_rspec"

data/spec/support/fake_rspec.rb

@@ -0,0 +1,19 @@
+class FakeRSpec
+  @@befores = Hash.new([])
+
+  def self.before(scope, &blk)
+    @@befores[scope] << blk
+  end
+
+  def self.befores
+    @@befores
+  end
+
+  def self.include(modjewel)
+    super(modjewel)
+  end
+
+  def self.reset!
+    @@befores = Hash.new([])
+  end
+end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: pharrell
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Callum Stott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-21 00:00:00.000000000 Z
+date: 2014-04-29 00:00:00.000000000 Z
 dependencies: []
-description: 
+description: A dependency injection framework for Ruby. Allows Guice like functionality
+  with both field and constructor injection.
 email:
 - callum@seadowg.com
 executables: []
@@ -29,13 +30,16 @@ files:
 - lib/pharrell/constructor.rb
 - lib/pharrell/errors.rb
 - lib/pharrell/injectable.rb
+- lib/pharrell/integration/rspec.rb
 - media/pharrell.jpg
 - pharrell.gemspec
 - spec/config_spec.rb
 - spec/constructor_spec.rb
 - spec/injectable_spec.rb
+- spec/integration_spec.rb
 - spec/pharrell_spec.rb
 - spec/spec_helper.rb
+- spec/support/fake_rspec.rb
 homepage: http://github.com/seadowg/pharrell
 licenses:
 - MIT