scorpion-ioc 0.5.13 → 0.5.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2707ee5f873ced43d6fcbbd383fc2d055dc71fb7
-  data.tar.gz: de8955d86ecb98696c7734d89e539463aafe26a7
+  metadata.gz: 0f144ad2a3f2570fbb1e71ed99d52dd5b1cecc33
+  data.tar.gz: 08ff7b8a52474b70dc790596f5869312cda8846d
 SHA512:
-  metadata.gz: ac6c07abf770a6d836d8031cc35dd1825e45066bbad7d0cc11077f2c5af2f492963e412f4fedfad5f3c5b8b9e8295ba7b6a84cb4fac45545a52e7efe3bd3cac4
-  data.tar.gz: f2982774adc0dbe4ed94247917a5e869b8be1bf819e8da78103302bd9b9ca692b5ec44b7dfe8b3c10a0264382127c0df526bf79eec2adc248c2db95faacf15f3
+  metadata.gz: 4ac170a30e129bbdcac5aa5e2f29987a71604bdadd3bda1db63b890b2b86230708d14ccb49c85468eb056232ecba6a899f510395426bc292fb63554d909ffb40
+  data.tar.gz: 699520623d7dbe81f57de933e1a1fa571ee5371b06b63d67953fec8fae1eeb9628dcc412760bffe56564c356d3e6b2f5e0ef296adbda2122d878468ef581182e

data/README.md

@@ -140,6 +140,9 @@ class Hunter
   depend_on do
     weapon Weapon
   end
+
+  # or
+  attr_dependency :weapon, Weapon
 end
 ```
 
@@ -168,17 +171,17 @@ hunter.weapon # => an Axe
 Overriding hunters!
 
 ```ruby
-  class Axe < Weapon; end
-  class Predator < Hunter; end
+class Axe < Weapon; end
+class Predator < Hunter; end
 
-  scorpion.prepare do
-    hunt_for Predator
-    hunt_for Axe
-  end
+scorpion.prepare do
+  hunt_for Predator
+  hunt_for Axe
+end
 
-  hunter = scorpion.fetch Hunter
-  hunter        # => Predator
-  hunter.weapon # => an Axe
+hunter = scorpion.fetch Hunter
+hunter        # => Predator
+hunter.weapon # => an Axe
 ```
 
 
@@ -210,10 +213,14 @@ end
 class Zoo
   include Scorpion::Object
 
-  depend_on do # or #depend_on if you like
+  depend_on do
     keeper Zoo::Keeper
     vet Zoo::Vet, lazy: true
   end
+
+  # or with like attr_accessor
+  attr_dependency :keeper, Zook::Keeper
+  attr_dependency :vet, Zoo::Vet, lazy: true
 end
 
 zoo = scorpion.fetch Zoo
@@ -285,9 +292,9 @@ poker.poke     # => "Sword"
 
 #### Traits
 
-Traits can be used to distinguish between dependency of the same type. For example
-a scorpion may be prepare to hunt for several weapons and the object needs a
-blunt weapon.
+Traits can be used to distinguish between dependencies of the same type. For
+example a scorpion may be prepared to hunt for several weapons and the object
+needs a blunt weapon.
 
 ```ruby
 class Weapon; end
@@ -351,13 +358,14 @@ arguments.
 ```ruby
 class City
   def self.create( scorpion, name )
-    klass = if name == "New York"
-      BigCity
-    else
-      SmallCity
-    end
+    klass = 
+      if name == "New York"
+        BigCity
+      else
+        SmallCity
+      end
 
-    klass.new name
+    scorpion.new klass, name
   end
 
   def initialize( name )
@@ -421,9 +429,9 @@ scorpion.fetch Logger  # => Logger.new
 scorpion.fetch Logger  # => Previously captured logger
 ```
 
-Captured dependencies are not shared with child scorpions (for example when
-conceiving scorpions from a [Nest](Nests)). To share captured dependency with children
-use `share`.
+> Captured dependencies are not shared with child scorpions (for example when
+> conceiving scorpions from a [Nest](Nests)). To share captured dependency with
+> children use `share`.
 
 ### Nests
 
@@ -447,8 +455,8 @@ scorpion.fetch Logger  # => Logger.new
 
 #### ActionController
 
-Scorpion provides simple integration into for rails controllers to establish
-a scorpion for each request.
+Scorpion provides simple integration for rails controllers to establish a
+scorpion for each request.
 
 ```ruby
 # user_service.rb
@@ -456,7 +464,7 @@ class UserService
   def find( username ) ... end
 end
 
-# config/nest.rb
+# config/initializers/nest.rb
 require 'scorpion'
 
 Scorpion.prepare do
@@ -494,6 +502,11 @@ injection into ActiveJob objects.
 
 # avatar_job.rb
 class AvatarJob < ActiveJob::Base
+  depend_on do
+    users UserService, lazy: true
+    logger Logger
+  end
+
   def perform( id )
     user = users.find( id )
     logger.write "Found a user: #{ user }"
@@ -506,6 +519,9 @@ end
 Scorpion enhances ActiveRecord models to support resolving dependencies from
 a scorpion and sharing that scorpion with all associations.
 
+> Consider using a SOA framework like [Shamu](https://github.com/phallguy/shamu)
+> for managing complex resource relationships.
+
 ```ruby
 class User < ActiveRecord::Base
   depend_on do
@@ -518,7 +534,6 @@ class User < ActiveRecord::Base
 end
 
 class SessionsController < ActionController::Base
-
   def create
     user = User.with_scorpion( scorpion ).find params[:id]
     user = scorpion( User ).find params[:id]
@@ -542,3 +557,5 @@ end
 [The MIT License (MIT)](http://opensource.org/licenses/MIT)
 
 Copyright (c) 2015 Paul Alexander
+
+[@phallguy](http://twitter.com/phallguy) / http://phallguy.com

data/lib/scorpion/dependency.rb

@@ -64,6 +64,13 @@ module Scorpion
       traits.hash
     end
 
+    def inspect
+      result = "<#{ contract.inspect }"
+      result << " traits=#{ traits.to_a.inspect }" if traits.present?
+      result << ">"
+      result
+    end
+
     private
 
       # @return [Boolean] true if the pray satisfies the given contract.

data/lib/scorpion/hunter.rb

@@ -64,5 +64,14 @@ module Scorpion
       dependency_map.reset
     end
 
+    # @return [String]
+    def inspect
+      dependencies = dependency_map.to_a
+      result = "<#{ self.class.name } contracts=#{ dependencies.inspect }"
+      result << " parent=#{ parent.inspect }" if parent
+      result << ">"
+      result
+    end
+
   end
 end

data/lib/scorpion/version.rb

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

data/spec/lib/scorpion/hunter_spec.rb

@@ -121,4 +121,10 @@ describe Scorpion::Hunter do
     end
   end
 
+  describe "#inspect" do
+    it "is helpful" do
+      expect( hunter.inspect ).to match /contracts/
+      expect( hunter.inspect ).not_to match /0x/
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorpion-ioc
 version: !ruby/object:Gem::Version
-  version: 0.5.13
+  version: 0.5.14
 platform: ruby
 authors:
 - Paul Alexander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails