pharrell 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a03c1e8f8cd9196d0a71b9068554a24d088d47dd
-  data.tar.gz: fce0a06653f61e7fde4a1387e3eb944a76d08547
+  metadata.gz: 3c591314692d9690e8940b3f0b72b8dc1cc3926c
+  data.tar.gz: e7e948670a4f517771e7bdcf4207579e1557706f
 SHA512:
-  metadata.gz: 93ebb87549b3c51756a79c5ce31b8f4bd42c8aeb6000d195214089f041e7f356734b696e9d09bba599fc1ede330bae3dda21bdbca5516db704f3f6e02e76fae4
-  data.tar.gz: a9b6b448c29fc48fa1600b4b13c5a7ec99343d7e8cec8cdb3c70dc7f35ee5948aeedddbb66df3ce080577f99a2defc04ef0af3a50e4e2f329d7c83ecd87ba5d5
+  metadata.gz: e893aea8b98ef7bf417db1006d2879ff3d567fe9f4dd4ebbd0d9361cdf5a2663c9db3e976d1be745e8ca07a5552291d83fd51afc2f169f95732fbb453c85b390
+  data.tar.gz: 658f2f56202b8e1a2b277ed37e075ee59763cd0d9d9456e47085b87c2d0dc7a41a5db24e054bedd6bca6fc895e243dae87d35d99bce83d4add5ef9baccb55840

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pharrell (0.7.0)
+    pharrell (0.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -12,10 +12,10 @@ GEM
       simplecov (>= 0.7)
       term-ansicolor
       thor
-    docile (1.1.0)
-    mime-types (2.0)
-    multi_json (1.8.2)
-    rake (10.1.0)
+    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)
@@ -23,10 +23,10 @@ GEM
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
     thor (0.18.1)
-    tins (0.13.1)
+    tins (1.0.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -24,7 +24,7 @@ Or, install for your system:
 You can inject dependencies into classes like so:
 
 ```ruby
-class CurrentTime
+class BlackBox
   include Pharrell::Injectible
 
   injected :current_time, Time
@@ -57,17 +57,92 @@ Pharrell.config(:test) do |config|
   config.bind(Time, Time.at(0))
 end
 
-describe "CurrentTime" do
+describe BlackBox do
   before do
     Pharrell.use_config(:test)
   end
 
   it "displays the time of day" do
-    assert_equal(CurrentTime.new.to_s, "The time is 12 o'clock")
+    assert_equal(BlackBox.new.to_s, "The time is 12 o'clock")
   end
 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 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.
+
+We can break the previous time code into into its object to achieve this:
+
+```ruby
+class PrettyTime
+  def initialize(current_time)
+    @current_time = current_time
+  end
+
+  def to_s
+    hour = @current_time.hour % 12
+    "The time is #{hour == 0 ? 12 : hour} o'clock"
+  end
+end
+```
+
+This is great but what if we want to construct `PrettyTime` of these in the
+`BlackBox` class?
+
+For this we can use constructor injection:
+
+```ruby
+class PrettyTime
+  include Pharrell::Constructor
+
+  constructor Time
+
+  def initialize(current_time)
+    @current_time = current_time
+  end
+
+  def to_s
+    hour = @current_time.hour % 12
+    "The time is #{hour == 0 ? 12 : hour} o'clock"
+  end
+end
+```
+
+We can then inject `PrettyTime` straight into `BlackBox`:
+
+```ruby
+class BlackBox
+  include Pharrell::Injectible
+
+  injected :pretty_time, PrettyTime
+
+  def to_s
+    pretty_time.to_s
+  end
+end
+```
+
+Our binding would then look like this:
+
+```ruby
+Pharrell.config(:base) do |config|
+  config.bind(Time) { Time.now }
+  config.bind(PrettyTime, PrettyTime)
+end
+```
+
+Because we marked `PrettyTime` as having constructor injection
+pharrell will build `PrettyTime` with the bound instance of `Time`.
+
+This approach may seem more complex but it allows you to move most of your application's logic
+into more responsible components and should free you from using
+magic dependency injection (DI frameworks, stubbing factories etc) anywhere but at the top level.
+
 ### Bindings
 
 When building configurations in pharrell you can bind instances to
@@ -113,15 +188,34 @@ Pharrell is really easy to set up with Rails. Here's an example similar to the `
 ```ruby
 class Application < Rails::Application
   config.to_prepare do
-    Pharrell.config do |config|
+    Pharrell.config(:base) do |config|
       config.bind(Time, Time)
     end
-    
-    Pharrell.use_config(:base)
+
+    # make sure you have one config for each of your environments!
+    Pharrell.config(:development, :extends => :base) {}
+    Pharrell.config(:production, :extends => :base) {}
+
+    Pharrell.use_config(:test, :extends => :base) do
+      config.bind(Time, FakeTime.new)
+    end
+
+    Pharrell.use_config(Rails.env.to_sym)
+  end
+end
+```
+
+**spec/spec_helper.rb**
+
+```ruby
+RSpec.configure do |config|
+  config.include Pharrell::Injectable
+
+  config.before(:each) do
+    Pharrell.use_config(:test)
   end
 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. You can then attach your test configuration for Pharrell to
-whatever test framework you use (exactly as in the first example).
+in production and before each request in development.

data/lib/pharrell.rb

@@ -1,36 +1,15 @@
 require 'pharrell/config'
 require 'pharrell/injectable'
 require 'pharrell/constructor'
+require 'pharrell/errors'
 
 module Pharrell
-  class BindingNotFoundError < Exception
-    def message
-      "Binding could not be found!"
-    end
-  end
-  
-  class ConfigNotDefinedError < Exception
-    def message
-      "Config has not been defined!"
-    end
-  end
-  
-  class InvalidOptionsError < Exception
-    def initialize(opts)
-      @opts = opts
-    end
-    
-    def message
-      "Invalid options: #{@opts.join(" ")}"
-    end
-  end
-  
   @@configs = {}
   @@config = nil
 
   def self.config(name, opts = {}, &blk)
     check_options([:extends], opts)
-    
+
     if opts[:extends]
       @@configs[name] = fetch_config(opts[:extends]).extend(blk)
     else
@@ -50,7 +29,7 @@ module Pharrell
   def self.rebuild!
     current_config.rebuild!
   end
-  
+
   def self.reset!
     @@configs = {}
     @@config = nil
@@ -61,20 +40,20 @@ module Pharrell
   def self.current_config
     fetch_config(@@config)
   end
-  
+
   def self.fetch_config(name)
     config = @@configs[name]
-    
+
     if config
       config
     else
       raise ConfigNotDefinedError
     end
   end
-  
+
   def self.check_options(opts, opt_hash)
     extra_keys = opt_hash.keys.reject { |key| opts.include?(key) }
-    
+
     if extra_keys.empty?
       true
     else

data/lib/pharrell/errors.rb

@@ -0,0 +1,23 @@
+module Pharrell
+  class BindingNotFoundError < Exception
+    def message
+      "Binding could not be found!"
+    end
+  end
+
+  class ConfigNotDefinedError < Exception
+    def message
+      "Config has not been defined!"
+    end
+  end
+
+  class InvalidOptionsError < Exception
+    def initialize(opts)
+      @opts = opts
+    end
+
+    def message
+      "Invalid options: #{@opts.join(" ")}"
+    end
+  end
+end

data/lib/pharrell/injectable.rb

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

data/pharrell.gemspec

@@ -3,7 +3,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name = "pharrell"
-  s.version = "0.7.0"
+  s.version = "0.8.0"
   s.platform = Gem::Platform::RUBY
   s.authors = ["Callum Stott"]
   s.email = ["callum@seadowg.com"]

data/spec/injectable_spec.rb

@@ -6,7 +6,7 @@ describe "Injectable" do
   before do
     Pharrell.reset!
   end
-  
+
   describe ".injected" do
     it "defines a method to retrieve that class from Pharrell" do
       Pharrell.config(:base) { |c| c.bind(String, "Injected") }
@@ -14,13 +14,36 @@ describe "Injectable" do
 
       klass = Class.new {
         include Pharrell::Injectable
-
         injected :string, String
       }
 
       assert_equal(klass.new.send(:string), "Injected")
     end
-    
+
+    describe 'simpler injection' do
+      before do
+        Pharrell.config(:base) do |c|
+          c.bind(String, "Injected")
+          c.bind(SecureRandom, "Also Injected")
+        end
+        Pharrell.use_config(:base)
+
+        @klass = Class.new {
+          include Pharrell::Injectable
+          injected :string
+          injected :secure_random
+        }
+      end
+
+      it "allows simpler injection with a symbol" do
+        assert_equal(@klass.new.send(:string), "Injected")
+      end
+
+      it 'allows more complex binding' do
+        assert_equal(@klass.new.send(:secure_random), "Also Injected")
+      end
+    end
+
     it "caches lazy bindings on the instance" do
       i = 0
       Pharrell.config(:base) { |c| c.bind(Object) { i = i + 1 } }
@@ -31,7 +54,7 @@ describe "Injectable" do
 
         injected :injected_ob, Object
       }
-      
+
       object = klass.new
       assert_equal(object.send(:injected_ob), object.send(:injected_ob))
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pharrell
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Callum Stott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-18 00:00:00.000000000 Z
+date: 2014-03-21 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -27,6 +27,7 @@ files:
 - lib/pharrell.rb
 - lib/pharrell/config.rb
 - lib/pharrell/constructor.rb
+- lib/pharrell/errors.rb
 - lib/pharrell/injectable.rb
 - media/pharrell.jpg
 - pharrell.gemspec