scorpion-ioc 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c95b03306b50c7e49688d4736c3287ec3ebab9d0
-  data.tar.gz: 6011ea65e623df92f421ad2037ca3a6aa02e0a0c
+  metadata.gz: 5ec2ff4bcf7bacc05263624d567a42ffa57d614c
+  data.tar.gz: 1f52f7c0031504a0b0e926ff507d49af659fa717
 SHA512:
-  metadata.gz: c3de90e129024ce65ee4591d49e821877d0854c8c0f6abebf85f6237cb4558cc905bf9961ae59530fb10884c0f890f33ccb733fe802afb01245417c761d52118
-  data.tar.gz: b9f9feb46528c3f66ab2a4c835bb88b309b0e6f017bf138ef841633a5e71b3e141a6476a170181f26590fc9914162de976cbf3ff5cf784c6aabf2adfe087028b
+  metadata.gz: 6b6e3b77742c496ff2b3ceee4484bcd8e8eb69d63029e1d232453c34775135c1c0088a144df31528724866c2e84209cd17f2bcb3cf47cbf90b2840315aa99c12
+  data.tar.gz: b55c22cd4c397caf6c9ea10bfde2f892dc083f6eae906c54b7b724103f6b88fb627ee2ff8638667df68f538fbb503b4bd7a5a1a5048062c77ebab0e978e7475b

data/README.md

@@ -14,9 +14,16 @@ Add IoC to rails with minimal fuss and ceremony.
 
 - [Dependency Injection](#dependency-injection)
   - [Why might you _Want_ a DI FRamework?](#why-might-you-_want_-a-di-framework)
+    - [Using a Framework...like Scorpion](#using-a-frameworklike-scorpion)
 - [Using Scorpion](#using-scorpion)
   - [Kings](#kings)
   - [Configuration](#configuration)
+    - [Classes](#classes)
+    - [Modules](#modules)
+    - [Traits](#traits)
+    - [Builders](#builders)
+    - [Hunting Delegates](#hunting-delegates)
+    - [Singletons](#singletons)
   - [Nests](#nests)
   - [Rails](#rails)
 - [Contributing](#contributing)
@@ -138,7 +145,7 @@ and setting the weapon. When a Hunter is created it's dependencies are also
 created - and any of their dependencies and so on. Usage is equally simple
 
 ```ruby
-hunter = scorpion.hunt! Hunter
+hunter = scorpion.hunt Hunter
 hunter.weapon   # => a Weapon
 ```
 
@@ -151,7 +158,7 @@ scorpion.prepare do
   hunt_for Axe
 end
 
-hunter = scorpion.hunt! Hunter
+hunter = scorpion.hunt Hunter
 hunter.weapon # => an Axe
 ```
 
@@ -166,7 +173,7 @@ Overriding hunters!
     hunt_for Axe
   end
 
-  hunter = scorpion.hunt! Hunter
+  hunter = scorpion.hunt Hunter
   hunter        # => Predator
   hunter.weapon # => an Axe
 ```
@@ -178,7 +185,7 @@ Out of the box Scorpion does not need any configuration and will work
 immediately. You can hunt for any Class even if it hasn't been configured.
 
 ```ruby
-  hash = Scorpion.instance.hunt! Hash
+  hash = Scorpion.instance.hunt Hash
   hash # => {}
 ```
 
@@ -206,7 +213,7 @@ class Zoo
   end
 end
 
-zoo = scorpion.hunt! Zoo
+zoo = scorpion.hunt Zoo
 zoo.keeper       # => an instance of a Zoo::Keeper
 zoo.vet?         # => false it hasn't been hunted down yet
 zoo.vet          # => an instnace of a Zoo::Vet
@@ -235,13 +242,13 @@ derived class). In the absence of any configuration, Scorpion will simply create
 an instance of the specific class requested.
 
 ```ruby
-scorpion.hunt! Hash   # => Hash.new
+scorpion.hunt Hash   # => Hash.new
 
 scorpion.prepare do
   hunt_for Object::HashWithIndifferentAccess
 end
 
-scorpion.hunt! Hash   # => Object::HashWithIndifferentAccess.new
+scorpion.hunt Hash   # => Object::HashWithIndifferentAccess.new
 ```
 
 #### Modules
@@ -262,14 +269,14 @@ class Sword
   include Sharp
 end
 
-poker = scorpion.hunt! Sharp
+poker = scorpion.hunt Sharp
 poker.poke     # => "Module"
 
 scorpion.prepare do
   hunt_for Sword
 end
 
-poker = scorpion.hunt! Sharp
+poker = scorpion.hunt Sharp
 poker.poke     # => "Sword"
 ```
 
@@ -291,9 +298,9 @@ scorpion.prepare do
   hunt_for Mace, :blunt, :sharp
 end
 
-scorpion.hunt! Weapon, :blunt # => Hammer.new
-scorpion.hunt! Weapon, :sharp # => Sword.new
-scorpion.hunt! Weapon, :sharp, :blunt # => Mace.new
+scorpion.hunt Weapon, :blunt # => Hammer.new
+scorpion.hunt Weapon, :sharp # => Sword.new
+scorpion.hunt Weapon, :sharp, :blunt # => Mace.new
 ```
 
 Modules can also be used to identify specific traits desired from the hunted
@@ -315,8 +322,8 @@ scorpion.prepare do
   hunt_for SysLog
 end
 
-scorpion.hunt! Logger, Color      # => Console.new
-scorpion.hunt! Logger, Streaming  # => SysLog.new
+scorpion.hunt Logger, Color      # => Console.new
+scorpion.hunt Logger, Streaming  # => SysLog.new
 ```
 
 #### Builders
@@ -335,6 +342,35 @@ scorpion.prepare do
 end
 ```
 
+#### Hunting Delegates
+
+For really complex dependencies you may want to delegate the effort to retrieve
+the dependencies to another type - a factory module for example. Scorpion
+allows you to delegate hunting prey using the `:with` option.
+
+```ruby
+module ChocolateFactory
+    module_function
+
+    def call( scorpion, *args, &block )
+      case args.first
+      when Nuget        then scorpion.spawn Snickers, *args, &block
+      when Butterscotch then scorpion.spawn Butterfinger, *args, &block
+      when Coconut      then scorpion.spawn Garbage, *args, &block
+      end
+    end
+end
+
+scorpion.prepare do
+  hunt_for Candy, with: ChocolateFactory
+end
+
+scorpion.hunt Candy, Nuget.new  #=> Snickers.new Nugget.new
+```
+
+Any object that responds to `#call( scorpion, *args, &block )` can be used as
+a hunting delegate.
+
 #### Singletons
 
 Scorpion allows you to capture prey and feed the same instance to everyone that
@@ -353,8 +389,8 @@ scorpion.prepare do
   capture Logger
 end
 
-scorpion.hunt! Logger  # => Logger.new
-scorpion.hunt! Logger  # => Previously captured logger
+scorpion.hunt Logger  # => Logger.new
+scorpion.hunt Logger  # => Previously captured logger
 ```
 
 Captured dependencies are not shared with child scorpions (for example when
@@ -376,7 +412,7 @@ nest.prepare do
 end
 
 scorpion = nest.conceive
-scorpion.hunt! Logger  # => Logger.new
+scorpion.hunt Logger  # => Logger.new
 ```
 
 ### Rails

data/lib/scorpion/hunting_map.rb

@@ -66,7 +66,7 @@ module Scorpion
     # @param [Array<Symbol>] traits found on the {Prey}.
     # @return [Scorpion::Prey] the prey to be hunted for.
     def hunt_for( contract, traits = nil, &builder )
-      active_prey_set.unshift prey_class( contract, &builder ).new( contract, traits, &builder )
+      active_prey_set.unshift define_prey( contract, traits, &builder )
     end
     alias_method :offer, :hunt_for
 
@@ -74,7 +74,7 @@ module Scorpion
     # for the resource.
     # @see #hunt_for
     def capture( contract, traits = nil, &builder )
-      active_prey_set.unshift Scorpion::Prey::CapturedPrey.new( prey_class( contract, &builder ).new( contract, traits, &builder ) )
+      active_prey_set.unshift Scorpion::Prey::CapturedPrey.new( define_prey( contract, traits, &builder ) )
     end
     alias_method :singleton, :capture
 
@@ -103,8 +103,32 @@ module Scorpion
     end
 
     private
+
+      def define_prey( contract, traits, &builder )
+        options, traits = extract_options!( traits )
+
+        if with = options[:with]
+          Scorpion::Prey::BuilderPrey.new( contract, traits, with )
+        elsif block_given?
+          Scorpion::Prey::BuilderPrey.new( contract, traits, builder)
+        else
+          prey_class( contract ).new( contract, traits, &builder )
+        end
+      end
+
+      def extract_options!( traits )
+        case traits
+        when Hash then return [ traits, nil ]
+        when Array then
+          if traits.last.is_a? Hash
+            return [ traits.pop, traits ]
+          end
+        end
+
+        [ {}, traits]
+      end
+
       def prey_class( contract, &builder )
-        return Scorpion::Prey::BuilderPrey if block_given?
         return Scorpion::Prey::HuntedPrey  if contract.respond_to? :hunt
         return Scorpion::Prey::ClassPrey   if contract.is_a? Class
         return Scorpion::Prey::ClassPrey   if contract.is_a? Module

data/lib/scorpion/prey/builder_prey.rb

@@ -2,7 +2,8 @@ require 'scorpion/prey'
 
 module Scorpion
   class Prey
-    # {Prey} for an explicit builder block
+    # {Prey} that delegates to another object that implements
+    # #call( scorpion, *args, &block ).
     class BuilderPrey < Scorpion::Prey
 
       # ============================================================================
@@ -10,16 +11,15 @@ module Scorpion
       #
 
       # @!attribute
-      # @return [#call(scorpion)] the builder to use to fetch instances of the prey.
+      # @return [#call(scorpion,*args,&block)] the builder to use to fetch instances of the prey.
         attr_reader :builder
 
       #
       # @!endgroup Attributes
 
-
-      def initialize( contract, traits = nil, &builder )
-        @builder = builder
-        super
+      def initialize( contract, traits = nil, builder = nil, &block )
+        @builder = block_given? ? block : builder
+        super contract, traits
       end
 
       # @see Scorpion::Prey#fetch

data/lib/scorpion/version.rb

@@ -1,5 +1,5 @@
 module Scorpion
-  VERSION_NUMBER  = "0.3.0"
+  VERSION_NUMBER  = "0.3.1"
   VERSION_SUFFIX  = ""
   VERSION         = "#{VERSION_NUMBER}#{VERSION_SUFFIX}"
 end

data/spec/lib/scorpion/hunting_map_spec.rb

@@ -88,6 +88,14 @@ describe Scorpion::HuntingMap do
 
       expect( map.first ).to be_a Scorpion::Prey::BuilderPrey
     end
+
+    it "adds a BuilderPrey for with: option" do
+      map.chart do
+        hunt_for String, with: ->(scorpion,*args,&block){ "YASSS" }
+      end
+
+      expect( map.first ).to be_a Scorpion::Prey::BuilderPrey
+    end
   end
 
   describe "#replicate_from" do

data/spec/lib/scorpion/prey/builder_prey_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Test
+  module BuilderPrey
+    class ClassDelegate
+      def call( scorpion, *args, &block )
+        Test
+      end
+    end
+
+    module ModDelegate
+      module_function
+
+      def call( scorpion, *args, &block )
+        Test
+      end
+    end
+  end
+end
+
+describe Scorpion::Prey::BuilderPrey do
+  let( :scorpion ){ double }
+
+  it "supports class hunting delegates" do
+    prey = Scorpion::Prey::BuilderPrey.new( String, nil, Test::BuilderPrey::ClassDelegate.new )
+    expect( prey.fetch( scorpion ) ).to be Test
+  end
+
+  it "supports module hunting delegates" do
+    prey = Scorpion::Prey::BuilderPrey.new( String, nil, Test::BuilderPrey::ModDelegate )
+    expect( prey.fetch( scorpion ) ).to be Test
+  end
+
+  it "supports block hunting delegates" do
+    prey = Scorpion::Prey::BuilderPrey.new( String, nil ) do
+      Test
+    end
+    expect( prey.fetch( scorpion ) ).to be Test
+  end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scorpion-ioc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Paul Alexander
@@ -149,6 +149,7 @@ files:
 - spec/lib/scorpion/hunting_map_spec.rb
 - spec/lib/scorpion/instance_spec.rb
 - spec/lib/scorpion/king_spec.rb
+- spec/lib/scorpion/prey/builder_prey_spec.rb
 - spec/lib/scorpion/prey/module_prey_spec.rb
 - spec/lib/scorpion/prey_spec.rb
 - spec/lib/scorpion/rails/controller_spec.rb
@@ -174,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Add IoC to rails with minimal fuss and ceremony
@@ -192,6 +193,7 @@ test_files:
 - spec/lib/scorpion/hunting_map_spec.rb
 - spec/lib/scorpion/instance_spec.rb
 - spec/lib/scorpion/king_spec.rb
+- spec/lib/scorpion/prey/builder_prey_spec.rb
 - spec/lib/scorpion/prey/module_prey_spec.rb
 - spec/lib/scorpion/prey_spec.rb
 - spec/lib/scorpion/rails/controller_spec.rb