scorpion-ioc 0.6.2 → 1.0.0

data/lib/scorpion/error.rb

@@ -1,23 +1,23 @@
-require 'i18n'
+require "i18n"
 
 module Scorpion
   class Error < StandardError
 
     private
-      def translate( key, args = {} )
-        I18n.translate key, args.merge( scope: [:scorpion,:errors,:messages] )
+
+      def translate( key, **args )
+        I18n.translate key, args.merge( scope: [:scorpion, :errors, :messages] )
       end
+
   end
 
   class UnsuccessfulHunt < Error
     attr_reader :contract
-    attr_reader :traits
 
-    def initialize( contract, traits = nil )
+    def initialize( contract )
       @contract = contract
-      @traits   = traits
 
-      super translate( :unsuccessful_hunt, contract: contract, traits: traits )
+      super translate( :unsuccessful_hunt, contract: contract )
     end
   end
 
@@ -36,10 +36,13 @@ module Scorpion
   class ContractMismatchError < Error
     def initialize( message_or_module = nil, initializer_attr = nil, injected_attr = nil )
       if message_or_module.is_a?( Module )
-        super translate( :contract_mismatch, module: message_or_module, name: initializer_attr.name, from: initializer_attr.contract, to: injected_attr.contract )
+        super translate( :contract_mismatch, module: message_or_module,
+                                             name: initializer_attr.name,
+                                             from: initializer_attr.contract,
+                                             to: injected_attr.contract )
       else
         super ( message || translate( :contract_mismatch ) )
       end
     end
   end
-end
+end

data/lib/scorpion/hunt.rb

@@ -45,17 +45,11 @@ module Scorpion
       attr_reader :trip
       private :trip
 
-      delegate [:contract, :traits, :dependencies, :arguments, :block] => :trip
+      delegate [:contract, :arguments, :block] => :trip
 
     # @!attribute contract
     # @return [Class,Module,Symbol] contract being hunted for.
 
-    # @!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<Object>] positional arguments to pass to the initializer of {#contract} when found.
 
@@ -65,22 +59,16 @@ module Scorpion
     #
     # @!endgroup Attributes
 
-    def initialize( scorpion, contract, traits, *arguments, **dependencies, &block )
+    def initialize( scorpion, contract, *arguments, &block )
       @scorpion  = scorpion
       @trips     = []
-      @trip      = Trip.new contract, traits, arguments, dependencies, block
+      @trip      = Trip.new contract, arguments, block
     end
 
-    # Hunt for additional dependency to satisfy the main hunt's contract and traits.
+    # Hunt for additional dependency to satisfy the main hunt's contract.
     # @see Scorpion#hunt
-    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, **dependencies, &block )
-      push contract, traits, arguments, dependencies, block
+    def fetch( contract, *arguments, &block )
+      push contract, arguments, block
       execute
     ensure
       pop
@@ -91,12 +79,13 @@ module Scorpion
     # @return [Scorpion::Object] the injected object.
     def inject( object )
       trip.object = object
+      object.send :scorpion_hunt=, self
 
       object.injected_attributes.each do |attr|
         next if object.send "#{ attr.name }?"
         next if attr.lazy?
 
-        object.send :inject_dependency, attr, fetch_by_traits( attr.contract, attr.traits )
+        object.send :inject_dependency, attr, fetch( attr.contract )
       end
 
       object.send :on_injected
@@ -106,8 +95,8 @@ module Scorpion
 
     # Allow the hunt to spawn objects.
     # @see Scorpion#spawn
-    def spawn( klass, *arguments, **dependencies, &block )
-      scorpion.spawn( self, klass, *arguments, **dependencies, &block )
+    def spawn( klass, *arguments, &block )
+      scorpion.spawn( self, klass, *arguments, &block )
     end
     alias_method :new, :spawn
 
@@ -118,12 +107,26 @@ module Scorpion
       end
 
       def execute_from_trips
-        return if dependencies.any?
-
         trips.each do |trip|
-          return trip.object if contract === trip.object
-          trip.dependencies.each do |key,value|
-            return value if contract === value
+          if resolved = execute_from_trip( trip )
+            return resolved
+          end
+        end
+
+        nil
+      end
+
+      def execute_from_trip( trip )
+        return unless obj = trip.object
+        return obj if contract === obj
+
+        # If we have already resolved an instance of this contract in this
+        # hunt, then return that same object.
+        if obj.is_a? Scorpion::Object
+          obj.injected_attributes.each do |attr|
+            next unless attr.contract == contract
+
+            return obj.send( attr.name ) if obj.send( :"#{ attr.name }?" )
           end
         end
 
@@ -134,10 +137,10 @@ module Scorpion
         scorpion.execute self
       end
 
-      def push( contract, traits, arguments, dependencies, block )
+      def push( contract, arguments, block )
         trips.push trip
 
-        @trip = Trip.new contract, traits, arguments, dependencies, block
+        @trip = Trip.new contract, arguments, block
       end
 
       def pop
@@ -146,22 +149,18 @@ module Scorpion
 
       class Trip
         attr_reader :contract
-        attr_reader :traits
         attr_reader :arguments
-        attr_reader :dependencies
         attr_reader :block
 
         attr_accessor :object
 
-        def initialize( contract, traits, arguments, dependencies, block )
+        def initialize( contract, arguments, block )
           @contract     = contract
-          @traits       = traits
           @arguments    = arguments
-          @dependencies = dependencies
           @block        = block
         end
       end
 
       class InitializerTrip < Trip; end
   end
-end
+end

data/lib/scorpion/hunter.rb

@@ -33,8 +33,8 @@ module Scorpion
     end
 
     # Expose dependency injection definitions as top-level methods.
-    [:hunt_for,:capture,:share].each do |delegate|
-      define_method delegate do |*args,&block|
+    [:hunt_for, :capture, :share].each do |delegate|
+      define_method delegate do |*args, &block|
         prepare do |hunter|
           hunter.send delegate, *args, &block
         end
@@ -51,9 +51,9 @@ module Scorpion
     # @see Scorpion#execute
     def execute( hunt, explicit_only = false )
       dependency   = find_dependency( hunt )
-      dependency ||= Dependency.define( hunt.contract ) if hunt.traits.blank? && !explicit_only
+      dependency ||= Dependency.define( hunt.contract ) unless explicit_only
 
-      unsuccessful_hunt( hunt.contract, hunt.traits ) unless dependency
+      unsuccessful_hunt( hunt.contract ) unless dependency
 
       dependency.fetch hunt
     end
@@ -62,7 +62,7 @@ module Scorpion
     # @param [Hunt] hunt being resolved.
     # @return [Dependency] the matching dependency if found
     def find_dependency( hunt )
-      dependency   = dependency_map.find( hunt.contract, hunt.traits )
+      dependency   = dependency_map.find( hunt.contract )
       dependency ||= parent.find_dependency( hunt ) if parent
 
       dependency
@@ -83,4 +83,4 @@ module Scorpion
     end
 
   end
-end
+end

data/lib/scorpion/locale/en.yml

@@ -2,11 +2,11 @@ en:
   scorpion:
     errors:
       messages:
-        unsuccessful_hunt: "Couldn't find a %{contract} builder with traits '%{traits}'"
+        unsuccessful_hunt: "Couldn't find a %{contract} builder"
         builder_required: A custom builder must be provided to resolve this dependency
         arity_mismatch: The block must accept %{expected} arguments, but actually expects %{actual}
         rack_missing_scorpion: Scorpion not set. Add Scorpion::Rack::Middleware before %{middleware}.
         contract_mismatch: "%{module} changed the contract for `%{name}` from `%{from}` to `%{to}` but did not update `initialize` block."
     warnings:
       messages:
-        mixed_scorpions: A scorpion has already been assigned. Mixing scorpions can result in unexpected results.
+        mixed_scorpions: A scorpion has already been assigned. Mixing scorpions can result in unexpected results.

data/lib/scorpion/method.rb

@@ -20,5 +20,15 @@ module Scorpion
       @scorpion = value
     end
 
+    # @!attribute
+    # @return [Hunt] the scorpion hunt that captured the object.
+    def scorpion_hunt
+      @scorpion_hunt
+    end
+
+    private def scorpion_hunt=( hunt )
+      @scorpion_hunt = hunt
+    end
+
   end
-end
+end

data/lib/scorpion/object.rb

@@ -1,4 +1,4 @@
-require 'scorpion/attribute_set'
+require "scorpion/attribute_set"
 
 module Scorpion
   # Identifies objects that are injected by {Scorpion scorpions} that inject
@@ -41,15 +41,8 @@ module Scorpion
           # Create a new instance of this class with all non-lazy dependencies
           # satisfied.
           # @param [Hunt] hunt that this instance will be used to satisfy.
-          def self.spawn( hunt, *args, **dependencies, &block )
-            object =
-              if dependencies.any?
-                new( *args, **dependencies, &block )
-              else
-                new( *args, &block )
-              end
-
-
+          def self.spawn( hunt, *args, &block )
+            object = new( *args, &block )
             object.send :scorpion=, hunt.scorpion
 
             # Go hunt for dependencies that are not lazy and initialize the
@@ -92,8 +85,8 @@ module Scorpion
         injected_attributes.each do |attr|
           next unless dependencies.key? attr.name
 
-          if overwrite || !self.send( "#{ attr.name }?" )
-            self.send( "#{ attr.name }=", dependencies[ attr.name ] )
+          if overwrite || !send( "#{ attr.name }?" )
+            send( "#{ attr.name }=", dependencies[ attr.name ] )
           end
         end
 
@@ -107,8 +100,8 @@ module Scorpion
           next unless dependencies.key? attr.name
           val = dependencies.delete( attr.name )
 
-          if overwrite || !self.send( "#{ attr.name }?" )
-            self.send( "#{ attr.name }=", val )
+          if overwrite || !send( "#{ attr.name }?" )
+            send( "#{ attr.name }=", val )
           end
         end
 
@@ -117,18 +110,10 @@ module Scorpion
 
     module ClassMethods
 
-      # Define an initializer that accepts injections.
-      # @param [Hash] arguments to accept in the initializer.
-      # @yield to initialize itself.
-      def initialize( arguments = {}, &block )
-        Scorpion::ObjectConstructor.new( self, arguments, &block ).define
-      end
-
       # Tells a {Scorpion} what to inject into the class when it is constructed
       # @return [nil]
       # @see AttributeSet#define
-      def depend_on( arguments = nil, &block )
-        Scorpion::ObjectConstructor.new( self, arguments ).define if arguments.present?
+      def depend_on( &block )
         injected_attributes.define &block
         build_injected_attributes
         validate_initializer_injections
@@ -137,11 +122,10 @@ module Scorpion
       # Define a single dependency and accessor.
       # @param [Symbol] name of the dependency.
       # @param [Class,Module,Symbol] contract describing the desired behavior of the dependency.
-      # @param [Array<Symbol>] traits found on the {Dependency}.
-      def attr_dependency( name, contract, *traits, &block )
-        attr = injected_attributes.define_attribute name, contract, *traits, &block
+      def attr_dependency( name, contract, &block )
+        attr = injected_attributes.define_attribute name, contract, &block
         build_injected_attribute attr
-        set_injected_attribute_visibility attr
+        adjust_injected_attribute_visibility attr
         validate_initializer_injections
         attr
       end
@@ -169,6 +153,7 @@ module Scorpion
       end
 
       private
+
         def validate_initializer_injections
           initializer_injections.each do |attr|
             injected = injected_attributes[ attr.name ]
@@ -181,7 +166,7 @@ module Scorpion
         def build_injected_attributes
           injected_attributes.each do |attr|
             build_injected_attribute attr
-            set_injected_attribute_visibility attr
+            adjust_injected_attribute_visibility attr
           end
         end
 
@@ -190,7 +175,7 @@ module Scorpion
             def #{ attr.name }
               @#{ attr.name } ||= begin
                 attr = injected_attributes[ :#{ attr.name } ]
-                scorpion.fetch_by_traits( attr.contract, attr.traits )
+                ( scorpion_hunt || scorpion ).fetch( attr.contract )
               end
             end
 
@@ -204,7 +189,7 @@ module Scorpion
           RUBY
         end
 
-        def set_injected_attribute_visibility( attr )
+        def adjust_injected_attribute_visibility( attr )
           unless attr.public?
             class_eval <<-RUBY, __FILE__, __LINE__ + 1
               private :#{ attr.name }=
@@ -220,4 +205,4 @@ module Scorpion
         end
     end
   end
-end
+end

data/lib/scorpion/rack.rb

@@ -5,7 +5,7 @@ module Scorpion
     private
 
       def scorpion( env )
-        env[ Middleware::ENV_KEY ] || fail( MissingScorpionError.new( self.class.name ) )
+        env[ Middleware::ENV_KEY ] || fail( MissingScorpionError, self.class.name )
       end
   end
 end

data/lib/scorpion/rack/middleware.rb

@@ -4,7 +4,7 @@ module Scorpion
   module Rack
     class Middleware
 
-      ENV_KEY = 'scorpion.rack.instance'.freeze
+      ENV_KEY = "scorpion.rack.instance".freeze
 
       def initialize( app, nest = nil )
         @app  = app
@@ -19,6 +19,7 @@ module Scorpion
       end
 
       private
+
         attr_reader :nest
 
         def prepare_scorpion( scorpion, env )

data/lib/scorpion/rails.rb

@@ -1,10 +1,10 @@
 module Scorpion
   module Rails
-    require 'scorpion/rails/nest'
-    require 'scorpion/rails/job'
-    require 'scorpion/rails/mailer'
-    require 'scorpion/rails/active_record'
-    require 'scorpion/rails/controller'
-    require 'scorpion/rails/railtie'
+    require "scorpion/rails/nest"
+    require "scorpion/rails/job"
+    require "scorpion/rails/mailer"
+    require "scorpion/rails/active_record"
+    require "scorpion/rails/controller"
+    require "scorpion/rails/railtie"
   end
 end

data/lib/scorpion/rails/active_record.rb

@@ -1,9 +1,9 @@
 module Scorpion
   module Rails
     module ActiveRecord
-      require 'scorpion/rails/active_record/model'
-      require 'scorpion/rails/active_record/relation'
-      require 'scorpion/rails/active_record/association'
+      require "scorpion/rails/active_record/model"
+      require "scorpion/rails/active_record/relation"
+      require "scorpion/rails/active_record/association"
 
       # Setup scorpion support for activerecord
       def self.install!
@@ -13,7 +13,7 @@ module Scorpion
         ::ActiveRecord::Relation.send :prepend, Scorpion::Rails::ActiveRecord::Relation
         ::ActiveRecord::Associations::Association.send :prepend, Scorpion::Rails::ActiveRecord::Association
 
-        # TODO extend Scorpion::Hunter to support AR
+        # TODO: extend Scorpion::Hunter to support AR
       end
     end
   end

data/lib/scorpion/rails/active_record/association.rb

@@ -46,11 +46,11 @@ module Scorpion
             next unless klass.instance_methods.include? method
 
             mod = Module.new do
-              module_eval <<-EOS, __FILE__, __LINE__ + 1
+              module_eval <<-RUBY, __FILE__, __LINE__ + 1
                 def #{ method }( *args, &block )
                   sting! super
                 end
-              EOS
+              RUBY
             end
 
             klass.prepend mod
@@ -61,4 +61,4 @@ module Scorpion
 
     end
   end
-end
+end