pharrell 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d7ddc117eb0a25d90d07260f0513d189d7d5a17
-  data.tar.gz: a55df73b6d261a3dca3132678a866fe62c9478de
+  metadata.gz: 7eed3d692ced9756edd084b008e2d43df2f12f08
+  data.tar.gz: f01316c10483a6bb8adbe4c942bee5361db51a5f
 SHA512:
-  metadata.gz: b64c018da3a1953b85300cc06b03fff0d1f45b05028c6cb88a133de2c1fcd4abb6d4065d81fb5348f6a2d0fa633ddc8b67670803166aea5273de593cf2fd9337
-  data.tar.gz: d05f135ab295b4d237dbf4b527158dfbdc06b926d8c3f2cdab31543f54d1782f09529c1f56a5a78461987a1f525fb6374834e6ebddfeb7d3045b3cbf09736ef9
+  metadata.gz: 5b95f8ac13597c151284ab8927e058fa6244a7368b0dfdfdd8845f7046f1478fb15880177a4aa0628745bc5e16208995a4f0229a77f2b1433df6bbb3c4618e2c
+  data.tar.gz: 3e722194ea21d0c2c1988902a21f9b48094f8a5354eb2c46c267f19f82a44e8888ada834806a9882fc24941a40a64cb4e3bfd623de9bf60ee37c531b68aba717

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -1,16 +1,37 @@
 PATH
   remote: .
   specs:
-    pharrell (0.5.2)
+    pharrell (0.6.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.0)
+    mime-types (2.0)
+    multi_json (1.8.2)
     rake (10.1.0)
+    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.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls
   pharrell!
   rake

data/README.md

@@ -1,6 +1,7 @@
 # pharrell
 
 [![Build Status](https://travis-ci.org/seadowg/pharrell.png?branch=master)](https://travis-ci.org/seadowg/pharrell)
+[![Coverage Status](https://coveralls.io/repos/seadowg/pharrell/badge.png?branch=master)](https://coveralls.io/r/seadowg/pharrell?branch=master)
 
 ![Pharrell](media/pharrell.jpg)
 
@@ -99,7 +100,28 @@ Pharrell.use_config(:base) do |config|
   config.bind(Hash, { :key => "value" })
 end
 
-Pharrell.use_config(:more, :extend => :base) do |config|
+Pharrell.use_config(:more, :extends => :base) do |config|
   config.bind(String, "This string instead")
 end
 ```
+### Using with Rails
+
+Pharrell is really easy to set up with Rails. Here's an example similar to the `Time` example we used before:
+
+**config/application.rb**
+
+```ruby
+class Application < Rails::Application
+  config.to_prepare do
+    Pharrell.config do |config|
+      config.bind(Time, Time)
+    end
+    
+    Pharrell.use_config(:base)
+  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).

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake/testtask'
 task :default => :test
 
 Rake::TestTask.new do |t|
-  t.libs.push "lib"
+  t.libs << 'spec'
   t.test_files = FileList['spec/*_spec.rb']
   t.verbose = true
 end

data/lib/pharrell/config.rb

@@ -2,11 +2,16 @@ module Pharrell
   class Config
     def initialize(definition)
       @definition = definition
-      rebuild!
     end
 
     def instance_for(klass)
-      @bindings[klass].call
+      binding = @bindings[klass]
+      
+      if binding
+        binding.call(self)
+      else
+        raise BindingNotFoundError
+      end
     end
 
     def rebuild!
@@ -38,7 +43,7 @@ module Pharrell
           @bindings[klass] = blk
         else
           obj_block = if arg.kind_of?(Class)
-            Proc.new { arg.new }
+            Proc.new { |config| build_instance(arg, config)}
           else
             Proc.new { arg }
           end
@@ -46,6 +51,20 @@ 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
+        end
+      end
     end
   end
 end

data/lib/pharrell/constructor.rb

@@ -0,0 +1,19 @@
+module Pharrell
+  module Constructor
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      @@constructor = []
+      
+      def constructor(*klasses)
+        @@constructor = klasses
+      end
+      
+      def __pharrell_constructor_classes
+        @@constructor
+      end
+    end
+  end
+end

data/lib/pharrell.rb

@@ -1,13 +1,38 @@
 require 'pharrell/config'
 require 'pharrell/injectable'
+require 'pharrell/constructor'
 
 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] = @@configs[opts[:extends]].extend(blk)
+      @@configs[name] = fetch_config(opts[:extends]).extend(blk)
     else
       @@configs[name] = Config.new(blk)
     end
@@ -25,10 +50,35 @@ module Pharrell
   def self.rebuild!
     current_config.rebuild!
   end
+  
+  def self.reset!
+    @@configs = {}
+    @@config = nil
+  end
 
   private
 
   def self.current_config
-    @@configs[@@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
+      raise InvalidOptionsError.new(extra_keys)
+    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.5.2"
+  s.version = "0.6.1"
   s.platform = Gem::Platform::RUBY
   s.authors = ["Callum Stott"]
   s.email = ["callum@seadowg.com"]

data/spec/config_spec.rb

@@ -1,13 +1,19 @@
+require 'spec_helper'
 require 'minitest/autorun'
 require 'pharrell'
 
 describe "Pharrell::Config" do
+  before do
+    Pharrell.reset!
+  end
+  
   describe "#instance_for" do
     it "returns an instance bound to a class" do
       config = Pharrell::Config.new(Proc.new { |c|
         c.bind(Time, Time.at(0))
       })
-
+      
+      config.rebuild!
       assert_equal(config.instance_for(Time), Time.at(0))
     end
 
@@ -17,6 +23,7 @@ describe "Pharrell::Config" do
         c.bind(String, my_class)
       })
 
+      config.rebuild!
       assert_equal(config.instance_for(String).class, my_class)
     end
 
@@ -25,6 +32,7 @@ describe "Pharrell::Config" do
         c.bind(Object) { Object.new }
       })
 
+      config.rebuild!
       assert(config.instance_for(Object) != config.instance_for(Object))
     end
   end

data/spec/constructor_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'minitest/autorun'
+require 'pharrell'
+
+describe "Constructor" do
+  before do
+    Pharrell.reset!
+  end
+  
+  describe ".contructor" do
+    it "allows a class to be lazily created by Pharrell with the defined types" do
+      klass = Class.new {
+        include Pharrell::Constructor
+        
+        attr_reader :object, :string
+        constructor Object, String
+        
+        def initialize(object, string)
+          @object = object
+          @string = string
+        end
+      }
+      
+      Pharrell.config(:base) { |c| 
+        c.bind(String, "Hello")
+        c.bind(Object, 5)
+        c.bind(klass, klass)
+      }
+      
+      Pharrell.use_config(:base)
+
+      assert_equal(Pharrell.instance_for(klass).object, 5)
+      assert_equal(Pharrell.instance_for(klass).string, "Hello")
+    end
+  end
+end

data/spec/injectable_spec.rb

@@ -1,7 +1,12 @@
+require 'spec_helper'
 require 'minitest/autorun'
 require 'pharrell'
 
 describe "Injectable" do
+  before do
+    Pharrell.reset!
+  end
+  
   describe ".inject" do
     it "defines a method to retrieve that class from Pharrell" do
       Pharrell.config(:base) { |c| c.bind(String, "Injected") }

data/spec/pharrell_spec.rb

@@ -1,7 +1,12 @@
+require 'spec_helper'
 require 'minitest/autorun'
 require 'pharrell'
 
 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|
@@ -32,6 +37,15 @@ 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)
+      end
+    end
   end
 
   describe ".config" do
@@ -49,6 +63,24 @@ 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)
+      end
+    end
+    
+    it "raises an InvalidOptionsError for invalid options" do
+      begin
+        Pharrell.config(:base, :wrong_opt => "Value", :other_opt => "Value") { |config| }
+        flunk(".config did not raise an error!")
+      rescue Pharrell::InvalidOptionsError => e
+        assert_equal("Invalid options: wrong_opt other_opt", e.message)
+      end
+    end
   end
 
   describe ".rebuild!" do
@@ -64,4 +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 
+    end
+  end
 end

data/spec/spec_helper.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pharrell
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Callum Stott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-13 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .travis.yml
 - Gemfile
 - Gemfile.lock
@@ -25,12 +26,15 @@ files:
 - Rakefile
 - lib/pharrell.rb
 - lib/pharrell/config.rb
+- lib/pharrell/constructor.rb
 - lib/pharrell/injectable.rb
 - media/pharrell.jpg
 - pharrell.gemspec
 - spec/config_spec.rb
+- spec/constructor_spec.rb
 - spec/injectable_spec.rb
 - spec/pharrell_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/seadowg/pharrell
 licenses:
 - MIT