scorpion-ioc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19c5f928b91989643e0db1c9fef98016958d5813
-  data.tar.gz: 7e03d874e6714dae07b4da0fd3481404087df760
+  metadata.gz: e60f46d66df09f4c6f7615fd2710d4fe3527c965
+  data.tar.gz: 57c9523e72aa665056649295c6453c7ce255b724
 SHA512:
-  metadata.gz: 3e8b8889dafadd148472b73921eb1a1da3af9a0f006870c083abfb9bb600b2e9b21fdb24ab696f6f258621cd4ad3d6a497e0c143817399621f6dc0f2383758ad
-  data.tar.gz: bfee710c8d61409b0915dc98a206e0493d9c4b30a5406f41ab1817a0077c46418b27be3d960899b6bcb1904becde4978ab5ec9d1f34b6cff21af97f062fa38fb
+  metadata.gz: 09b2275087d17e93753be0d51c44306b8dc3c18586ab7120821eb5aac16fbdb82b1a9df4ae5a2c67bdb411fe4ea6c629524fdbc2b5bdfd3fdb2d2401552989aa
+  data.tar.gz: 6188ca0ac77ef49985acf0e5d044eec89210d243479ade15d63d6f51289b273ceab9c4ca5f5fe5969353f79082a9d4e4b913341ff8e3c3f04adb1c723d750703

data/README.md

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/scorpion-ioc.svg)](http://badge.fury.io/rb/scorpion-ioc)
 [![Code Climate](https://codeclimate.com/github/phallguy/scorpion.png)](https://codeclimate.com/github/phallguy/scorpion)
 [![Test Coverage](https://codeclimate.com/github/phallguy/scorpion/badges/coverage.svg)](https://codeclimate.com/github/phallguy/scorpion/coverage)
+[![Inch CI](https://inch-ci.org/github/phallguy/scorpion.svg?branch=master)](https://inch-ci.org/github/phallguy/scorpion)
 [![Circle CI](https://circleci.com/gh/phallguy/scorpion.svg?style=svg)](https://circleci.com/gh/phallguy/scorpion)
 
 Add IoC to rails with minimal fuss and ceremony.

data/lib/scorpion/hunter.rb

@@ -32,13 +32,13 @@ module Scorpion
       hunting_map.chart &block
     end
 
-    # @see Scorpion#hunt!
-    def hunt_by_traits!( contract, traits = nil, *args, &block  )
+    # @see Scorpion#hunt
+    def hunt_by_traits( contract, traits = nil, *args, &block  )
       unless prey = hunting_map.find( contract, traits )
-        return parent.hunt_by_traits! contract, traits if parent
+        return parent.hunt_by_traits contract, traits if parent
 
-        prey = Scorpion::Prey::ClassPrey.new( contract, nil ) if contract.is_a?( Class ) && traits.nil?
-        unsuccessful_hunt!( contract, traits ) unless prey
+        prey = Scorpion::Prey::ClassPrey.new( contract, nil ) if contract.is_a?( Class ) && traits.blank?
+        unsuccessful_hunt( contract, traits ) unless prey
       end
       prey.fetch self, *args, &block
     end

data/lib/scorpion/king.rb

@@ -2,7 +2,7 @@ require 'scorpion/attribute_set'
 
 module Scorpion
   # Identifies objects that are served by {Scorpion scorpions} that feed on
-  # {Scorpion#hunt! hunted} prey.
+  # {Scorpion#hunt hunted} prey.
   module King
 
     # ============================================================================
@@ -48,7 +48,7 @@ module Scorpion
               king.instance_variable_set :@scorpion, scorpion
               # Go hunt for dependencies that are not lazy and initialize the
               # references.
-              scorpion.feed! king
+              scorpion.feed king
               king.send :on_fed
             end
           end
@@ -76,17 +76,49 @@ module Scorpion
       end
 
       # Convenience method to ask the {#scorpion} to hunt for an object.
-      # @see Scorpion#hunt!
-      def hunt!( contract, *args, &block )
-        scorpion.hunt! contract, *args, &block
+      # @see Scorpion#hunt
+      def hunt( contract, *args, &block )
+        scorpion.hunt contract, *args, &block
       end
 
       # Convenience method to ask the {#scorpion} to hunt for an object.
-      # @see Scorpion#hunt_by_traits!
-      def hunt_by_traits!( contract, traits, *args, &block )
-        scorpion.hunt_by_traits! contract, *args, &block
+      # @see Scorpion#hunt_by_traits
+      def hunt_by_traits( contract, traits, *args, &block )
+        scorpion.hunt_by_traits contract, *args, &block
       end
 
+      # Feed dependencies from a hash into their associated attributes.
+      # @param [Hash] dependencies hash describing attributes to inject.
+      # @param [Boolean] overwrite existing attributes with values in in the hash.
+      def feast_on( dependencies, overwrite = false )
+        injected_attributes.each do |attr|
+          next unless dependencies.key? attr.name
+
+          if overwrite || !self.send( "#{ attr.name }?" )
+            self.send( "#{ attr.name }=", dependencies[ attr.name ] )
+          end
+        end
+
+        dependencies
+      end
+      alias_method :inject_from, :feast_on
+
+      # Injects dependenices from the hash and removes them from the hash.
+      # @see #feast_on
+      def feast_on!( dependencies, overwrite = false )
+        injected_attributes.each do |attr|
+          next unless dependencies.key? attr.name
+          val = dependencies.delete( attr.name )
+
+          if overwrite || !self.send( "#{ attr.name }?" )
+            self.send( "#{ attr.name }=", val )
+          end
+        end
+
+        dependencies
+      end
+      alias_method :inject_from!, :feast_on!
+
     module ClassMethods
 
       # Tells a {Scorpion} what to inject into the class when it is constructed
@@ -113,36 +145,42 @@ module Scorpion
 
         def build_injected_attributes
           injected_attributes.each do |attr|
-            class_eval <<-RUBY, __FILE__, __LINE__ + 1
-              def #{ attr.name }
-                @#{ attr.name } ||= begin
-                  attr = injected_attributes[ :#{ attr.name } ]
-                  scorpion.hunt!( attr.contract, attr.traits )
-                end
-              end
-
-              def #{ attr.name }=( value )
-                @#{ attr.name } = value
-              end
+            build_injected_attribute attr
+            set_injected_attribute_visibility attr
+          end
+        end
 
-              def #{ attr.name }?
-                !!@#{ attr.name }
+        def build_injected_attribute( attr )
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{ attr.name }
+              @#{ attr.name } ||= begin
+                attr = injected_attributes[ :#{ attr.name } ]
+                scorpion.hunt( attr.contract, attr.traits )
               end
-            RUBY
+            end
 
-            unless attr.public?
-              class_eval <<-RUBY, __FILE__, __LINE__ + 1
-                private :#{ attr.name }=
-                private :#{ attr.name }?
-              RUBY
+            def #{ attr.name }=( value )
+              @#{ attr.name } = value
             end
 
-            if attr.private?
-              class_eval <<-RUBY, __FILE__, __LINE__ + 1
-                private :#{ attr.name }
-              RUBY
+            def #{ attr.name }?
+              !!@#{ attr.name }
             end
+          RUBY
+        end
 
+        def set_injected_attribute_visibility( attr )
+          unless attr.public?
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              private :#{ attr.name }=
+              private :#{ attr.name }?
+            RUBY
+          end
+
+          if attr.private?
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              private :#{ attr.name }
+            RUBY
           end
         end
     end

data/lib/scorpion/rails/controller.rb

@@ -71,14 +71,14 @@ module Scorpion
             end
             # Allow dependencies to access the current request/response
             hunter.hunt_for ActionDispatch::Request do |hunter|
-              hunter.hunt!( AbstractController::Base ).request
+              hunter.hunt( AbstractController::Base ).request
             end
             hunter.hunt_for ActionDispatch::Response do |hunter|
-              hunter.hunt!( AbstractController::Base ).response
+              hunter.hunt( AbstractController::Base ).response
             end
           end
 
-          @scorpion.feed! self
+          @scorpion.feed self
 
           yield
         ensure

data/lib/scorpion/version.rb

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

data/lib/scorpion.rb

@@ -29,25 +29,27 @@ module Scorpion
   # @param [Array<Symbol>] traits required of the prey
   # @return [Object] an object that matches the requirements defined in `attribute`.
   # @raise [UnsuccessfulHunt] if a matching object cannot be found.
-  def hunt_by_traits!( contract, traits, *args, &block )
+  def hunt_by_traits( contract, traits, *args, &block )
     fail "Not implemented"
   end
-  alias_method :fetch_by_traits!, :hunt_by_traits!
+  alias_method :fetch_by_traits, :hunt_by_traits
 
   # Hunts for an object that satisfies the requested `contract` regardless of
   # traits.
-  # @see #hunt_by_traits!
-  def hunt!( contract, *args, &block )
-    hunt_by_traits!( contract, nil, *args, &block )
+  # @see #hunt_by_traits
+  def hunt( contract, *args, &block )
+    hunt_by_traits( contract, nil, *args, &block )
   end
-  alias_method :fetch!, :hunt!
+  alias_method :fetch, :hunt
 
   # Populate given `king` with its expected attributes.
   # @param [Scorpion::King] king to be fed.
   # @return [Scorpion::King] the populated king.
-  def feed!( king )
+  def feed( king )
     king.injected_attributes.each do |attr|
-      king.send :feed, attr, hunt_by_traits!( attr.contract, attr.traits )
+      next if king.send "#{ attr.name }?"
+
+      king.send :feed, attr, hunt_by_traits( attr.contract, attr.traits )
     end
   end
 
@@ -84,7 +86,7 @@ module Scorpion
 
     # Used by concrete scorpions to notify the caller that the hunt was
     # unsuccessful.
-    def unsuccessful_hunt!( contract, traits )
+    def unsuccessful_hunt( contract, traits )
       fail UnsuccessfulHunt.new contract, traits
     end
 

data/spec/lib/scorpion/hunter_spec.rb

@@ -39,31 +39,35 @@ describe Scorpion::Hunter do
   end
 
   it "spawns prey" do
-    expect( hunter.hunt! Test::Hunter::Beast ).to be_a Test::Hunter::Bear
+    expect( hunter.hunt Test::Hunter::Beast ).to be_a Test::Hunter::Bear
   end
 
   it "spawns a new instance for multiple requests" do
-    first = hunter.hunt! Test::Hunter::Beast
-    expect( hunter.hunt! Test::Hunter::Beast ).not_to eq first
+    first = hunter.hunt Test::Hunter::Beast
+    expect( hunter.hunt Test::Hunter::Beast ).not_to eq first
   end
 
   it "spawns the same instance for captured prey" do
-    first = hunter.hunt_by_traits! Test::Hunter::Beast, :tame
-    expect( hunter.hunt_by_traits! Test::Hunter::Beast, :tame ).to be first
+    first = hunter.hunt_by_traits Test::Hunter::Beast, :tame
+    expect( hunter.hunt_by_traits Test::Hunter::Beast, :tame ).to be first
   end
 
   it "injects nested kings" do
-    zoo = hunter.hunt! Test::Hunter::Zoo
+    zoo = hunter.hunt Test::Hunter::Zoo
     expect( zoo.bear ).to be_a Test::Hunter::Bear
   end
 
   it "accepts arguments that are passed to constructor" do
-    obj = hunter.hunt! Test::Hunter::Argumented, :awesome
+    obj = hunter.hunt Test::Hunter::Argumented, :awesome
     expect( obj.arg ).to eq :awesome
   end
 
   it "implicitly spawns Class contracts" do
-    expect( hunter.hunt! Test::Hunter::Implicit ).to be_a Test::Hunter::Implicit
+    expect( hunter.hunt Test::Hunter::Implicit ).to be_a Test::Hunter::Implicit
+  end
+
+  it "implicitly spawns Class contracts with empty traits" do
+    expect( hunter.hunt_by_traits Test::Hunter::Implicit, [] ).to be_a Test::Hunter::Implicit
   end
 
 end

data/spec/lib/scorpion/king_spec.rb

@@ -13,7 +13,8 @@ module Test
       def initialize( family, parent = nil, options={}, &block )
         @family    = family
         @parent    = parent
-        @options   = options
+        @options   = feast_on! options
+
 
         yield if block_given?
       end
@@ -55,7 +56,7 @@ describe Scorpion::King do
   let( :scorpion ){ double Scorpion }
 
   before( :each ) do
-    allow( scorpion ).to receive( :feed! )
+    allow( scorpion ).to receive( :feed )
   end
 
   describe ".spawn" do
@@ -65,6 +66,11 @@ describe Scorpion::King do
       expect( mamal ).to be_a Test::King::Mamal
     end
 
+    it "calls feed" do
+      expect( scorpion ).to receive( :feed )
+      Test::King::Mouse.spawn scorpion
+    end
+
     it "can inherit" do
       mouse = Test::King::Mouse.spawn scorpion, name: 'name'
       expect( mouse.family ).to eq 'mouse'
@@ -125,5 +131,68 @@ describe Scorpion::King do
 
   end
 
+  describe "feasting" do
+    let( :logger )  { Test::King::Logger.new }
+    let( :options ) { { manager: logger, color: :red } }
+    let( :king )    { Test::King::Mouse.new name: 'mighty' }
+
+
+    describe "#feast_on" do
+      it "assigns attributes" do
+        king.send :feast_on, options
+        expect( king.manager ).to be logger
+      end
+
+      it "doesn't overwrite" do
+        king.manager = Test::King::Logger.new
+        king.send :feast_on, options
+        expect( king.manager ).not_to be logger
+      end
+
+      it "overwrites when asked" do
+        king.manager = Test::King::Logger.new
+        king.send :feast_on, options, true
+        expect( king.manager ).to be logger
+      end
+    end
+
+    describe "feast_on!" do
+      it "assigns attributes" do
+        king.send :feast_on!, options
+        expect( king.manager ).to be logger
+      end
+
+      it "doesn't overwrite" do
+        king.manager = Test::King::Logger.new
+        king.send :feast_on!, options
+        expect( king.manager ).not_to be logger
+      end
+
+      it "overwrites when asked" do
+        king.manager = Test::King::Logger.new
+        king.send :feast_on!, options, true
+        expect( king.manager ).to be logger
+      end
+
+      it "removes injected attributes" do
+        expect( options ).to have_key :manager
+        king.send :feast_on!, options
+        expect( options ).not_to have_key :manager
+      end
+
+      it "removes injected attribute even if already set" do
+        expect( options ).to have_key :manager
+        king.manager = Test::King::Logger.new
+        king.send :feast_on!, options
+        expect( options ).not_to have_key :manager
+      end
+
+      it "doesn't remove other options" do
+        king.send :feast_on!, options
+        expect( options ).to have_key :color
+      end
+
+    end
+  end
 
 end

data/spec/lib/scorpion/rails/controller_spec.rb

@@ -18,8 +18,8 @@ describe Scorpion::Rails::Controller, type: :controller do
     end
 
     def index
-      @guard1 = scorpion.hunt! Test::Nest::Guard
-      @guard2 = scorpion.hunt! Test::Nest::Guard
+      @guard1 = scorpion.hunt Test::Nest::Guard
+      @guard2 = scorpion.hunt Test::Nest::Guard
       render nothing: true
     end
   end
@@ -62,8 +62,8 @@ describe Scorpion::Rails::Controller, type: :controller do
 
     it "spawns the same service during the same request" do
       allow( subject ).to receive( :index ) do
-        service = subject.service
-        expect( subject.scorpion.hunt! Test::Nest::Service ).to be service
+        service = subject.scorpion.hunt Test::Nest::Service
+        expect( subject.scorpion.hunt Test::Nest::Service ).to be service
         controller.render nothing: true
       end
 
@@ -74,7 +74,7 @@ describe Scorpion::Rails::Controller, type: :controller do
       service = subject.service
 
       allow( subject ).to receive( :index ) do
-        expect( subject.scorpion.hunt! Test::Nest::Service ).not_to be service
+        expect( subject.scorpion.hunt Test::Nest::Service ).not_to be service
         controller.render nothing: true
       end
 
@@ -83,7 +83,7 @@ describe Scorpion::Rails::Controller, type: :controller do
 
     it "hunts for controller" do
       allow( subject ).to receive( :index ) do
-        expect( subject.scorpion.hunt!( AbstractController::Base ) ).to be subject
+        expect( subject.scorpion.hunt( AbstractController::Base ) ).to be subject
         controller.render nothing: true
       end
 
@@ -92,7 +92,7 @@ describe Scorpion::Rails::Controller, type: :controller do
 
     it "hunts for response" do
       allow( subject ).to receive( :index ) do
-        expect( subject.scorpion.hunt!( ActionDispatch::Response ) ).to be subject.response
+        expect( subject.scorpion.hunt( ActionDispatch::Response ) ).to be subject.response
         controller.render nothing: true
       end
 
@@ -101,7 +101,7 @@ describe Scorpion::Rails::Controller, type: :controller do
 
     it "hunts for request" do
       allow( subject ).to receive( :index ) do
-        expect( subject.scorpion.hunt!( ActionDispatch::Request ).object_id ).to be subject.request.object_id
+        expect( subject.scorpion.hunt( ActionDispatch::Request ).object_id ).to be subject.request.object_id
         controller.render nothing: true
       end
 

data/spec/lib/scorpion_spec.rb

@@ -1,4 +1,40 @@
 require 'spec_helper'
 
+module Test
+  module Scorpion
+    class Logger; end
+
+    class Target
+      include ::Scorpion::King
+
+      feed_on do
+        logger Logger, public: true
+      end
+    end
+  end
+end
+
 describe Scorpion do
+  let( :scorpion ){ Scorpion::Hunter.new }
+  let( :target )  do
+    Test::Scorpion::Target.new.tap do |target|
+      target.instance_variable_set :@scorpion, scorpion
+    end
+  end
+
+  describe "#feed" do
+    it "injects attributes" do
+      scorpion.feed target
+
+      expect( target.logger ).to be_a Test::Scorpion::Logger
+    end
+
+    it "does not overwrite existing attributes" do
+      logger = Test::Scorpion::Logger.new
+      target.logger = logger
+      scorpion.feed target
+
+      expect( target.logger ).to be logger
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scorpion-ioc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Alexander
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Add IoC to rails with minimal fuss and ceremony