scorpion-ioc 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9f9e729630d83f9132e46118f0a74a9bcc9946f
-  data.tar.gz: 40a34e024069aaf348ce03b37065d83098920e40
+  metadata.gz: 93ebd370c4020bf58ad8fb775368a16a8949ebca
+  data.tar.gz: 5d3d644a4688b8f310f065e8d3431574c7fe142c
 SHA512:
-  metadata.gz: 32a04845861b9ea89cd5dcd19c667a0a339a424513c7b610f9909c3995e37d45707f837f3b10c8ce2d844ef12698268ffaa50c2afde083f54cd3161c4877d792
-  data.tar.gz: 435e3fbc679d5ad65fc7f5d2cce00adb802b5c73b91d1995f15c9012f6b0a8a99cee97c70cf7907b391d71fe831b8f8b38958249ef89ced063a9b0654a5f2f2e
+  metadata.gz: 2fb8f746aaf8ec843dc91ce3ea468c89d04c8cf1f442aebe65facb4a73a3a71c25f2f2204f3438f389a0c3323781b9565f32f5ef854936774047ffd8a8625847
+  data.tar.gz: 49fca90cccdcba2f232709c08a1f703371fbf293c53ee0fd5652eae969cf6a653f3d12a2f347b387b93bdd2070911cded579b867c6699b78c96adfa092160395

data/.rspec

@@ -1,3 +1,2 @@
 --color
 --format Fuubar
-

data/Gemfile

@@ -15,7 +15,6 @@ group :test do
   gem 'simplecov', github: "colszowka/simplecov"
   gem 'ruby_gntp', '~> 0.3.4'
   gem 'awesome_print'
-  gem 'sqlite3'
 
   gem "codeclimate-test-reporter", group: :test, require: nil
 end

data/README.md

@@ -8,6 +8,8 @@
 
 Add IoC to rails with minimal fuss and ceremony.
 
+(Also check out [shog](http://github.com/phallguy/shog) for better rails logs)
+
 <!-- MarkdownTOC depth=4 -->
 
 - [Dependency Injection](#dependency-injection)
@@ -519,6 +521,7 @@ class SessionsController < ActionController::Base
 
   def create
     user = User.with_scorpion( scorpion ).find params[:id]
+    user = scorpion( User ).find params[:id]
     sign_in if user.check_password( params[:password] )
   end
 end
@@ -538,4 +541,4 @@ end
 
 [The MIT License (MIT)](http://opensource.org/licenses/MIT)
 
-Copyright (c) 2015 Paul Alexander
+Copyright (c) 2015 Paul Alexander

data/lib/scorpion.rb

@@ -6,10 +6,12 @@ module Scorpion
 
   require 'scorpion/version'
   require 'scorpion/error'
+  require 'scorpion/method'
   require 'scorpion/object'
   require 'scorpion/object_constructor'
   require 'scorpion/attribute_set'
   require 'scorpion/hunter'
+  require 'scorpion/chain_hunter'
   require 'scorpion/dependency_map'
   require 'scorpion/hunt'
   require 'scorpion/dependency'
@@ -20,18 +22,19 @@ module Scorpion
   # Hunts for an object that satisfies the requested `contract` and `traits`.
   # @param [Class,Module,Symbol] contract describing the desired behavior of the dependency.
   # @param [Array<Symbol>] traits required of the dependency
+  # @param [Hash<Symbol,Object>] dependencies to inject into the object.
   # @return [Object] an object that satisfies the contract and traits.
   # @raise [UnsuccessfulHunt] if a matching object cannot be found.
-  def fetch_by_traits( contract, traits, *args, &block )
-    hunt = Hunt.new( self, contract, traits, *args, &block )
+  def fetch_by_traits( contract, traits, *arguments, **dependencies, &block )
+    hunt = Hunt.new( self, contract, traits, *arguments, **dependencies, &block )
     execute hunt
   end
 
   # Hunts for an object that satisfies the requested `contract` regardless of
   # traits.
   # @see #fetch_by_traits
-  def fetch( contract, *args, &block )
-    fetch_by_traits( contract, nil, *args, &block )
+  def fetch( contract, *arguments, **dependencies, &block )
+    fetch_by_traits( contract, nil, *arguments, **dependencies, &block )
   end
 
   # Creates a new object and feeds it it's dependencies.
@@ -39,14 +42,33 @@ module Scorpion
   # @param [Array<Object>] args to pass to the constructor.
   # @param [#call] block to pass to the constructor.
   # @return [Scorpion::Object] the spawned object.
-  def spawn( hunt, object_class, *args, &block )
+  def spawn( hunt, object_class, *arguments, **dependencies, &block )
     if object_class < Scorpion::Object
-      object_class.spawn hunt, *args, &block
+      object_class.spawn hunt, *arguments, **dependencies, &block
     else
-      object_class.new *args, &block
+      object_class.new *arguments, &block
     end
   end
 
+  # Inject the {#target} with all non-lazy dependencies.
+  # @param [Scorpion::Object] target to inject.
+  # @return [target]
+  def inject( target )
+    hunt = Scorpion::Hunt.new self, nil, nil
+    hunt.inject target
+
+    target
+  end
+
+  # Explicitly spawn an instance of {#object_class} and inject it's dependencies.
+  # @param [Array<Object>] args to pass to the constructor.
+  # @param [#call] block to pass to the constructor.
+  # @return [Scorpion::Object] the spawned object.
+  def new( object_class, *arguments, **dependencies, &block )
+    hunt = Hunt.new( self, object_class, nil, *arguments, **dependencies, &block )
+    Scorpion::Dependency::ClassDependency.new( object_class ).fetch( hunt )
+  end
+
   # Execute the `hunt` returning the desired dependency.
   # @param [Hunt] hunt to execute.
   # @return [Object] an object that satisfies the hunt contract and traits.
@@ -63,6 +85,11 @@ module Scorpion
 
   # Free up any captured dependency and release any long-held resources.
   def destroy
+    reset
+  end
+
+  # Reset the hunting map and clear all dependencies.
+  def reset
   end
 
   # @return [Scorpion::Nest] a nest that uses this scorpion as the mother.
@@ -106,14 +133,14 @@ module Scorpion
 
   # Hunt for dependency from the primary Scorpion {#instance}.
   # @see #fetch
-  def self.fetch( *args, &block )
-    instance.fetch *args, &block
+  def self.fetch( dependencies, &block )
+    instance.fetch dependencies, &block
   end
 
   # Hunt for dependency from the primary Scorpion {#instance}.
   # @see #fetch_by_traits
-  def self.fetch_by_traits( *args, &block )
-    instance.fetch_by_traits *args, &block
+  def self.fetch_by_traits( dependencies, &block )
+    instance.fetch_by_traits dependencies, &block
   end
 
   # @!attribute logger

data/lib/scorpion/attribute.rb

@@ -13,7 +13,10 @@ module Scorpion
     # @!attribute
     # @return [Class,Module,Symbol] contract that describes the desired behavior
     #   of the injected object.
-      attr_reader :contract
+      def contract
+        @contract = @contract.constantize if @contract.is_a? String
+        @contract
+      end
 
     # @!attribute
     # @return [Array<Symbol>] traits that must match on instances of the {#contract}

data/lib/scorpion/chain_hunter.rb

@@ -0,0 +1,58 @@
+module Scorpion
+
+  # Chains hunting calls to one or more managed scorpions.
+  class ChainHunter
+    include Scorpion
+
+    # ============================================================================
+    # @!group Attributes
+    #
+
+    # @!attribute
+    # @return [Array<Scorpion>] scorpions to chain hunting calls to.
+    attr_reader :scorpions
+
+    #
+    # @!endgroup Attributes
+
+
+    def initialize( *scorpions )
+      @scorpions = scorpions
+    end
+
+    # Prepare the scorpion for hunting.
+    # @see DependencyMap#chart
+    def prepare( &block )
+      if top = scorpions.first
+        top.prepare &block
+      end
+    end
+
+    # @see Scorpion#replicate
+    def replicate
+      self.class.new scorpions
+    end
+
+    # @see Scorpion#hunt
+    def execute( hunt )
+      # Try explicitly defined dependencies first
+      scorpions.each do |hunter|
+        begin
+          return hunter.execute( hunt, true )
+        rescue UnsuccessfulHunt
+        end
+      end
+
+      # Then allow implicit
+      scorpions.each do |hunter|
+        begin
+          return hunter.execute( hunt )
+        rescue UnsuccessfulHunt
+        end
+      end
+
+      unsuccessful_hunt hunt.contract, hunt.traits
+    end
+
+  end
+end

data/lib/scorpion/dependency.rb

@@ -92,7 +92,7 @@ module Scorpion
 
       # Define dependency based on the desired contract and traits.
       # @return [Dependency] the defined dependency.
-      def define( contract, traits = nil , &builder )
+      def define( contract, traits = nil, &builder )
         options, traits = extract_options!( traits )
 
         if options.key?( :return )
@@ -104,8 +104,12 @@ module Scorpion
         elsif block_given?
           Scorpion::Dependency::BuilderDependency.new( contract, traits, builder )
         elsif contract.respond_to?( :create )
-          Scorpion::Dependency::BuilderDependency.new( contract, traits ) do |scorpion,*args,&block|
-            contract.create scorpion, *args, &block
+          Scorpion::Dependency::BuilderDependency.new( contract, traits ) do |hunt,*args,**dependencies,&block|
+            if dependencies.present?
+              contract.create hunt, *args, **dependencies, &block
+            else
+              contract.create hunt, *args, &block
+            end
           end
         else
           dependency_class( contract ).new( contract, traits, &builder )

data/lib/scorpion/dependency/builder_dependency.rb

@@ -24,7 +24,11 @@ module Scorpion
 
       # @see Scorpion::Dependency#fetch
       def fetch( hunt )
-        builder.call( hunt, *hunt.arguments, &hunt.block )
+        if hunt.dependencies.any?
+          builder.call( hunt, *hunt.arguments, **hunt.dependencies, &hunt.block )
+        else
+          builder.call( hunt, *hunt.arguments, &hunt.block )
+        end
       end
 
     end

data/lib/scorpion/dependency/class_dependency.rb

@@ -6,20 +6,23 @@ module Scorpion
     class ClassDependency < Scorpion::Dependency
 
       def fetch( hunt )
-        hunt.scorpion.spawn hunt, hunt.contract, *resolve_arguments( hunt ), &hunt.block
+        resolved = resolve_dependencies( hunt )
+        hunt.scorpion.spawn hunt, hunt.contract, *hunt.arguments, **resolved, &hunt.block
       end
 
       private
 
-        def resolve_arguments( hunt )
-          arguments = hunt.arguments
-          return arguments unless arguments.blank? && hunt.contract < Scorpion::Object
+        def resolve_dependencies( hunt )
+          dependencies = hunt.dependencies
+          return dependencies unless hunt.contract.respond_to? :initializer_injections
 
-          hunt.contract.initializer_injections.each_with_object([]) do |attr,args|
-            args << hunt.fetch_by_traits( attr.contract, attr.traits )
-          end
+          hunt.contract.initializer_injections.each_with_object(dependencies.dup) do |attr,deps|
+            next if attr.lazy?
 
+            deps[attr.name] ||= hunt.fetch_by_traits( attr.contract, attr.traits )
+          end
         end
+
     end
   end
 end

data/lib/scorpion/dependency_map.rb

@@ -30,8 +30,7 @@ module Scorpion
 
     def initialize( scorpion )
       @scorpion              = scorpion
-      @dependency_set        = @active_dependency_set = []
-      @shared_dependency_set = []
+      reset
     end
 
     # Find {Dependency} that matches the requested `contract` and `traits`.
@@ -126,6 +125,16 @@ module Scorpion
       self
     end
 
+    # Remove all dependency mappings.
+    def reset
+
+      @dependency_set.each &:release        if @dependency_set
+      @shared_dependency_set.each &:release if @shared_dependency_set
+
+      @dependency_set        = @active_dependency_set = []
+      @shared_dependency_set = []
+    end
+
     private
 
       def define_dependency( contract, traits, &builder )

data/lib/scorpion/error.rb

@@ -21,6 +21,12 @@ module Scorpion
     end
   end
 
+  class ArityMismatch < Error
+    def initialize( block, expected_count )
+      super translate( :arity_mismatch, expected: expected_count, actual: block.arity )
+    end
+  end
+
   class BuilderRequiredError < Error
     def initialize( message = nil )
       super ( message || translate( :builder_required ) )

data/lib/scorpion/hunt.rb

@@ -1,5 +1,5 @@
 module Scorpion
-  # Captures state for a specific hunt so that constructor arguments can be
+  # Captures state for a specific hunt so that constructor dependencies can be
   # shared with child dependencies.
   #
   # @example
@@ -45,7 +45,7 @@ module Scorpion
       attr_reader :trip
       private :trip
 
-      delegate [:contract, :traits, :arguments, :block] => :trip
+      delegate [:contract, :traits, :dependencies, :arguments, :block] => :trip
 
     # @!attribute contract
     # @return [Class,Module,Symbol] contract being hunted for.
@@ -53,8 +53,11 @@ module Scorpion
     # @!attribute traits
     # @return [Array<Symbol>] traits being hunted for.
 
+    # @!attribute [r] dependencies
+    # @return [Hash<Symbol,Dependency>] hash of dependencies to pass to initializer of {#contract} when found.
+
     # @!attribute [r] arguments
-    # @return [Array<Dependency>] dependency to pass to initializer of contract when found.
+    # @return [Array<Object>] positional arguments to pass to the initializer of {#contract} when found.
 
     # @!attribute block
     # @return [#call] block to pass to constructor of contract when found.
@@ -62,22 +65,22 @@ module Scorpion
     #
     # @!endgroup Attributes
 
-    def initialize( scorpion, contract, traits, *arguments, &block )
+    def initialize( scorpion, contract, traits, *arguments, **dependencies, &block )
       @scorpion  = scorpion
       @trips     = []
-      @trip      = Trip.new contract, traits, arguments, block
+      @trip      = Trip.new contract, traits, arguments, dependencies, block
     end
 
     # Hunt for additional dependency to satisfy the main hunt's contract and traits.
     # @see Scorpion#hunt
-    def fetch( contract, *arguments, &block )
-      fetch_by_traits( contract, nil, *arguments, &block )
+    def fetch( contract, *arguments, **dependencies, &block )
+      fetch_by_traits( contract, nil, *arguments, **dependencies, &block )
     end
 
     # Hunt for additional dependency to satisfy the main hunt's contract and traits.
     # @see Scorpion#hunt
-    def fetch_by_traits( contract, traits, *arguments, &block )
-      push contract, traits, arguments, block
+    def fetch_by_traits( contract, traits, *arguments, **dependencies, &block )
+      push contract, traits, arguments, dependencies, block
       execute
     ensure
       pop
@@ -88,6 +91,7 @@ module Scorpion
     # @return [Scorpion::Object] the injected object.
     def inject( object )
       trip.object = object
+
       object.injected_attributes.each do |attr|
         next if object.send "#{ attr.name }?"
         next if attr.lazy?
@@ -95,14 +99,17 @@ module Scorpion
         object.send :inject, attr, fetch_by_traits( attr.contract, attr.traits )
       end
 
+      object.send :on_injected
+
       object
     end
 
     # Allow the hunt to spawn objects.
     # @see Scorpion#spawn
-    def spawn( klass, *arguments, &block )
-      scorpion.spawn( self, klass, *arguments, &block )
+    def spawn( klass, *arguments, **dependencies, &block )
+      scorpion.spawn( self, klass, *arguments, **dependencies, &block )
     end
+    alias_method :new, :spawn
 
     private
 
@@ -111,12 +118,12 @@ module Scorpion
       end
 
       def execute_from_trips
-        return if arguments.any?
+        return if dependencies.any?
 
         trips.each do |trip|
           return trip.object if contract === trip.object
-          trip.arguments.each do |arg|
-            return arg if contract === arg
+          trip.dependencies.each do |key,value|
+            return value if contract === value
           end
         end
 
@@ -127,10 +134,10 @@ module Scorpion
         scorpion.execute self
       end
 
-      def push( contract, traits, arguments, block )
+      def push( contract, traits, arguments, dependencies, block )
         trips.push trip
 
-        @trip = Trip.new contract, traits, arguments, block
+        @trip = Trip.new contract, traits, arguments, dependencies, block
       end
 
       def pop
@@ -141,15 +148,19 @@ module Scorpion
         attr_reader :contract
         attr_reader :traits
         attr_reader :arguments
+        attr_reader :dependencies
         attr_reader :block
 
         attr_accessor :object
 
-        def initialize( contract, traits, arguments, block )
-          @contract  = contract
-          @traits    = traits
-          @arguments = arguments
-          @block     = block
+        def initialize( contract, traits, arguments, dependencies, block )
+          @contract     = contract
+          @traits       = traits
+          @arguments    = arguments
+          @dependencies = dependencies
+          @block        = block
+
+          @caller = caller
         end
       end