pharrell 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f574e1ba4e6bbec95f013b9cb5bc11d28c7a330
-  data.tar.gz: 0b64c6fd5912373b0ff3815609e8430c715871f4
+  metadata.gz: cb4bf66bc2f1c6dc17040e0b81c9bbed25ad9341
+  data.tar.gz: e363140c7471601cb9ae3b608266bb18abc8c4f6
 SHA512:
-  metadata.gz: e24bbe057e2a1722b81d4481f250fa3eb0f30f077f18fa82e5b5696038f01765a7f829fbffa1e7c248f4c2d784d6e262eea043ef756365b45510cb97491477d5
-  data.tar.gz: 45482427f1dda47e6911736e58bea8c1954bcf1391fcf9bf8d544c93e5113f228e5be58a664a1be9964ce03592116054e5844acddb8d8fc4383d71dad3f60fbb
+  metadata.gz: 95ee5a87bbad1cceab0c63b0e7ab4cb9597ba42d9230b4a948eb111d4252323f7c628511c9e69051436f07901c01809a5880923bd08529c1ee15c71312789dc7
+  data.tar.gz: 78b2c79462d36dd6961f07f9df22f06367f1258069016d839446d16e9e68a3e309941933f0edee60e7a9b19a82550c2d8248b35a3a10ce6caf4c051844e0b7c8

data/README.md

@@ -1,7 +1,66 @@
-# Pharrell
+# pharrell
+
+[![Build Status](https://travis-ci.org/seadowg/pharrell.png?branch=master)](https://travis-ci.org/seadowg/pharrell)
 
 ![Pharrell](media/pharrell.jpg)
 
-## Description
+## Installation
+
+Either include in your Gemfile:
+
+```ruby
+gem 'pharrell'
+```
+
+Or, install for your system:
+
+    > gem install pharrell
+
+## Usage
+
+You can inject dependencies into classes like so:
+
+```ruby
+class CurrentTime
+  include Pharrell::Injectible
+
+  inject :current_time, Time
+
+  def to_s
+    hour = current_time.hour % 12
+    "The time is #{hour == 0 ? 12 : hour} o'clock"
+  end
+end
+```
+
+The values injected are dependent on the current conifguration:
+
+```ruby
+Pharrell.config(:base) do |config|
+  config.bind(Time) { Time.now }
+end
+
+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
+defined above:
+
+```ruby
+require 'minitest/autorun'
+
+Pharrell.config(:test) do |config|
+  config.bind(Time, Time.at(0))
+end
+
+describe "CurrentTime" do
+  before do
+    Pharrell.use_config(:test)
+  end
 
-I'm a provider gurl.
+  it "displays the time of day" do
+    assert_equal(CurrentTime.new.to_s, "The time is 12 o'clock")
+  end
+end
+```

data/lib/pharrell.rb

@@ -5,20 +5,25 @@ module Pharrell
   @@configs = {}
   @@config = nil
 
-  def self.instance_for(klass)
-    @@configs[@@config].instance_for(klass)
-  end
-
   def self.config(name, &blk)
-    @@configs[name] = Config.new
-    blk.call(@@configs[name])
+    @@configs[name] = Config.new(blk)
   end
 
   def self.use_config(name)
     @@config = name
   end
 
+  def self.instance_for(klass)
+    current_config.instance_for(klass)
+  end
+
   def self.rebuild!
-    @@configs[@@config].rebuild!
+    current_config.rebuild!
+  end
+
+  private
+
+  def self.current_config
+    @@configs[@@config]
   end
 end

data/lib/pharrell/config.rb

@@ -1,56 +1,42 @@
 module Pharrell
   class Config
-    def initialize
-      @map = {}
-    end
-
-    def bind(klass, arg = nil, &blk)
-      if blk
-        options = arg.kind_of?(Hash) ? arg : {}
-        @map[klass] = ObjectGenerator.new(options, &blk)
-      else
-        @map[klass] = arg
-      end
+    def initialize(definition)
+      @definition = definition
+      rebuild!
     end
 
     def instance_for(klass)
-      instance_or_class = @map[klass]
-
-      if instance_or_class.is_a? Class
-        instance_or_class.new
-      elsif instance_or_class.is_a? ObjectGenerator
-        instance_or_class.fetch
-      else
-        instance_or_class
-      end
+      @bindings[klass].call
     end
 
     def rebuild!
-      @map.each do |key, value|
-        if value.is_a? ObjectGenerator
-          value.invalidate!
-        end
-      end
+      @bindings =  Binder.new.tap { |b|
+        @definition.call(b)
+      }.bindings
     end
 
     private
 
-    class ObjectGenerator
-      def initialize(options = {}, &blk)
-        @blk = blk
-        @options = options
+    class Binder
+      attr_reader :bindings
+
+      def initialize
+        @bindings = {}
       end
 
-      def fetch
-        if @options[:cache]
-          @value ||= @blk.call
+      def bind(klass, arg = nil, &blk)
+        if blk
+          options = arg.kind_of?(Hash) ? arg : {}
+          @bindings[klass] = blk
         else
-          @blk.call
-        end
-      end
+          obj_block = if arg.kind_of?(Class)
+            Proc.new { arg.new }
+          else
+            Proc.new { arg }
+          end
 
-      def invalidate!
-        @value = nil
+          @bindings[klass] = obj_block
+        end
       end
     end
   end

data/pharrell.gemspec

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

data/spec/config_spec.rb

@@ -4,29 +4,28 @@ require 'pharrell'
 describe "Pharrell::Config" do
   describe "#instance_for" do
     it "returns an instance bound to a class" do
-      config = Pharrell::Config.new
-      config.bind(Time, Time.at(0))
+      config = Pharrell::Config.new(Proc.new { |c|
+        c.bind(Time, Time.at(0))
+      })
+
       assert_equal(config.instance_for(Time), Time.at(0))
     end
 
     it "returns an instance created from a class bound to a class" do
-      config = Pharrell::Config.new
       my_class = Class.new
+      config = Pharrell::Config.new(Proc.new { |c|
+        c.bind(String, my_class)
+      })
 
-      config.bind(String, my_class)
       assert_equal(config.instance_for(String).class, my_class)
     end
 
     it "allows a lazy instance to be passed as a block" do
-      config = Pharrell::Config.new
-      config.bind(Object) { Object.new }
-      assert(config.instance_for(Object) != config.instance_for(Object))
-    end
+      config = Pharrell::Config.new(Proc.new { |c|
+        c.bind(Object) { Object.new }
+      })
 
-    it "can cache block generated instances" do
-      config = Pharrell::Config.new
-      config.bind(Object, :cache => true) { Object.new }
-      assert_equal(config.instance_for(Object), config.instance_for(Object))
+      assert(config.instance_for(Object) != config.instance_for(Object))
     end
   end
 end

data/spec/pharrell_spec.rb

@@ -21,9 +21,9 @@ describe "Pharrell" do
   end
 
   describe ".rebuild!" do
-    it "forces all lazy values to be rebuilt" do
+    it "forces all bound values to be rebuilt" do
       Pharrell.config(:main) do |config|
-        config.bind(Object, :cache => true) { Object.new }
+        config.bind(Object, Object.new)
       end
 
       Pharrell.use_config(:main)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pharrell
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Callum Stott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-02 00:00:00.000000000 Z
+date: 2013-08-07 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: