scorpion-ioc 0.6.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e78bdb2ec8c0aa512d1bf013af5f3f8840160451
-  data.tar.gz: 04a5ae8792c19f7e82d44734bd42aa112bace532
+  metadata.gz: a82fd90f1ee52beb70fae54e337e99c4f707d250
+  data.tar.gz: 9f043a828f235431483c7f316deee1304c5e523d
 SHA512:
-  metadata.gz: a0425996d682925ff6bd4b38c676ba011e341bbd534f36e9de083f449cc1ed352a6302013d78077321640595fd6d1caa7ffd717e23746b9666684139b8b45d26
-  data.tar.gz: 739a23a53b35c0094e3f26bc720bc7ec5365bac68c137cc13ce539f5535e9137188ad41ada269ef392448d1758b7fc428bd9accb8d11abee2d04fee9990664e9
+  metadata.gz: ef68c508a7cd4ae4f6eefa03c3453c73a699131931f2f9db833932cca966e64c1382e517cbf703052a6ff569e0a01370fdeec667a9d9e3ec641c046ab96a17b1
+  data.tar.gz: 12fba27a0a219c6a7db956b315d260635806cd7a265f53a11556371353fe0502d2d00ee3c16c31e73b68786771d6d9cc415f7ee8105f139c85929e671ab5e879

data/.rubocop.yml

@@ -1,62 +1,176 @@
-Style/LineLength:
+AllCops:
+  TargetRubyVersion: 2.4
+
+  Exclude:
+    - "**/node_modules/**/*"
+    - "api/bin/*"
+    - "api/db/schema.rb"
+    - "api/vendor/**/*"
+    - ".*"
+    - "/**/.*"
+
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Lint/UselessAccessModifier:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 500
+
+Metrics/LineLength:
   Max: 120
 
-Style/AccessModifierIndentation:
-  EnforceStyle: indent
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/AbcSize:
+  Max: 24
 
-Style/IndentationConsistency:
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/ModuleLength:
+  Max: 500
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Metrics/BlockLength:
   Enabled: false
 
-Style/TrailingBlankLines:
+Style/Alias:
   Enabled: false
 
-Style/EmptyLinesAroundBody:
+Layout/CommentIndentation:
   Enabled: false
 
-Style/StringLiterals:
+Layout/EmptyLines:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/DoubleNegation:
   Enabled: false
 
-Style/SpaceInsideParens:
+Style/Documentation:
   Enabled: false
 
-Style/SpaceBeforeBlockBraces:
+Style/GuardClause:
   Enabled: false
 
-Style/SpaceInsideBlockBraces:
+Style/HashSyntax:
   Enabled: false
 
-Style/SpaceInsideBrackets:
+Layout/IndentArray:
   Enabled: false
 
-Style/SingleLineBlockParams:
+Layout/IndentationConsistency:
   Enabled: false
 
-Style/SingleSpaceBeforeFirstArg:
+Layout/IndentationWidth:
   Enabled: false
 
-Style/TrailingComma:
+Style/Lambda:
   Enabled: false
 
-Style/SpaceAfterComma:
+Style/FrozenStringLiteralComment:
   Enabled: false
 
-Style/ClassAndModuleChildren:
-  EnforcedStyle: nested
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/OptionHash:
+ Enabled: true
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Layout/SpaceAroundBlockParameters:
+  Enabled: false
 
 Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    '%':  '{}'
-    '%i': '{}'
-    '%q': '{}'
-    '%Q': '{}'
-    '%r': '{}'
-    '%s': '{}'
-    '%w': '{}'
-    '%W': '{}'
-    '%x': '{}'
+  Enabled: false
 
-Lint/AssignmentInCondition:
+Layout/SpaceAroundOperators:
   Enabled: false
 
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
+Layout/SpaceInsideBrackets:
+  Enabled: false
+
+Layout/SpaceInsideParens:
+  Enabled: false
+
+Layout/SpaceInsideStringInterpolation:
+  EnforcedStyle: space
+
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Layout/TrailingBlankLines:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false
+
+Style/UnneededInterpolation:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false

data/Gemfile

@@ -1,21 +1,25 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in scorpion.gemspec
 gemspec
 
 group :test do
 
-  gem 'guard', '~> 2.12.8'
-  gem 'spring'
-  gem 'byebug'
-  gem 'pry-byebug'
-  gem 'guard-rspec'
-  gem 'fuubar'
-  gem 'yard'
-  gem 'simplecov'
-  gem 'ruby_gntp', '~> 0.3.4'
-  gem 'awesome_print'
-  gem 'nokogiri', '1.6.7.2'
+  gem "rails", "~> 4.2"
+
+  gem "guard", "~> 2.12.8"
+  gem "spring"
+  gem "byebug"
+  gem "pry-byebug"
+  gem "guard-rspec"
+  gem "fuubar"
+  gem "yard"
+  gem "simplecov"
+  gem "ruby_gntp", "~> 0.3.4"
+  gem "awesome_print"
+  gem "nokogiri", "1.6.7.2"
+
+  gem "rubocop", "~> 0.50.0"
 
   gem "codeclimate-test-reporter", require: nil
-end
+end

data/README.md

@@ -10,29 +10,30 @@ 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)
-  - [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)
-  - [Objects](#objects)
-  - [Configuration](#configuration)
-    - [Classes](#classes)
-    - [Modules](#modules)
-    - [Traits](#traits)
-    - [Builders](#builders)
-    - [Hunting Delegates](#hunting-delegates)
-    - [Singletons](#singletons)
-  - [Nests](#nests)
-  - [Rails](#rails)
-    - [ActionController](#actioncontroller)
-    - [ActiveJob](#activejob)
-    - [ActiveRecord](#activerecord)
-- [Contributing](#contributing)
-- [License](#license)
-
-<!-- /MarkdownTOC -->
+<!-- vim-markdown-toc GFM -->
+
+* [Dependency Injection](#dependency-injection)
+  * [Why might you _Want_ a DI FRamework?](#why-might-you-_want_-a-di-framework)
+      * [Setter/Default Injection](#setterdefault-injection)
+      * [Constructor/Ignorant Injection](#constructorignorant-injection)
+    * [Using a Framework...like Scorpion](#using-a-frameworklike-scorpion)
+* [Using Scorpion](#using-scorpion)
+  * [Objects](#objects)
+  * [Configuration](#configuration)
+    * [Classes](#classes)
+    * [Modules](#modules)
+    * [Builders](#builders)
+    * [Hunting Delegates](#hunting-delegates)
+    * [Singletons](#singletons)
+  * [Nests](#nests)
+  * [Rails](#rails)
+    * [ActionController](#actioncontroller)
+    * [ActiveJob](#activejob)
+    * [ActiveRecord](#activerecord)
+* [Contributing](#contributing)
+* [License](#license)
+
+<!-- vim-markdown-toc -->
 
 ## Dependency Injection
 
@@ -290,52 +291,6 @@ poker = scorpion.fetch Sharp
 poker.poke     # => "Sword"
 ```
 
-#### Traits
-
-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
-class Mace < Weapon; end
-class Hammer < Weapon; end
-class Sword < Weapon; end
-
-scorpion.prepare do
-  hunt_for Hammer, :blunt
-  hunt_for Sword, :sharp
-  hunt_for Mace, :blunt, :sharp
-end
-
-scorpion.fetch Weapon, :blunt # => Hammer.new
-scorpion.fetch Weapon, :sharp # => Sword.new
-scorpion.fetch Weapon, :sharp, :blunt # => Mace.new
-```
-
-Modules can also be used to identify specific traits desired from the hunted
-dependency.
-
-```ruby
-module Color; end
-module Streaming; end
-class Logger; end
-class Console < Logger
-  include Color
-end
-class SysLog < Logger
-  include Streaming
-end
-
-scorpion.prepare do
-  hunt_for Console
-  hunt_for SysLog
-end
-
-scorpion.fetch Logger, Color      # => Console.new
-scorpion.fetch Logger, Streaming  # => SysLog.new
-```
-
 #### Builders
 
 Sometimes resolving the correct dependencies is a bit more dynamic. In those

data/Rakefile

@@ -1,2 +1,14 @@
 require "bundler/gem_tasks"
 
+desc "Run the specs"
+task :specs do
+  system "rspec"
+end
+
+desc "Run linters on the codebase"
+task :lint do
+  system "rubocop"
+end
+
+task :default => [ :lint, :specs ]
+task :release => [ :default ]

data/app/README

@@ -0,0 +1 @@
+Here to make vim-rails work

data/bin/rspec

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -9,7 +10,7 @@
 
 require "pathname"
 ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+                                           Pathname.new(__FILE__).realpath)
 
 require "rubygems"
 require "bundler/setup"

data/config.ru

@@ -1,5 +1,5 @@
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 
 Bundler.require :default, :development
 

data/config/environment.rb

@@ -0,0 +1 @@
+# Dummy file to make vim-rails work

data/lib/scorpion-ioc.rb

@@ -1 +1,3 @@
-require 'scorpion'
+# rubocop:disable Naming/FileName
+# Required case to support autorequire in gems.
+require "scorpion"

data/lib/scorpion.rb

@@ -1,50 +1,41 @@
-require 'i18n'
+require "i18n"
 
-I18n.load_path += Dir[ File.expand_path( '../scorpion/locale/*.yml', __FILE__ ) ]
+I18n.load_path += Dir[ File.expand_path( "../scorpion/locale/*.yml", __FILE__ ) ]
 
 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'
-  require 'scorpion/nest'
-  require 'scorpion/stinger'
-  require 'scorpion/rails'
-
-  # Hunts for an object that satisfies the requested `contract` and `traits`.
+  require "scorpion/version"
+  require "scorpion/error"
+  require "scorpion/method"
+  require "scorpion/object"
+  require "scorpion/attribute_set"
+  require "scorpion/hunter"
+  require "scorpion/chain_hunter"
+  require "scorpion/dependency_map"
+  require "scorpion/hunt"
+  require "scorpion/dependency"
+  require "scorpion/nest"
+  require "scorpion/stinger"
+  require "scorpion/rails"
+
+  # Hunts for an object that satisfies the requested `contract`.
+  #
   # @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.
+  # @return [Object] an object that satisfies the contract.
   # @raise [UnsuccessfulHunt] if a matching object cannot be found.
-  def fetch_by_traits( contract, traits, *arguments, **dependencies, &block )
-    hunt = Hunt.new( self, contract, traits, *arguments, **dependencies, &block )
+  def fetch( contract, *arguments, &block )
+    hunt = Hunt.new( self, contract, *arguments, &block )
     execute hunt
   end
 
-  # Hunts for an object that satisfies the requested `contract` regardless of
-  # traits.
-  # @see #fetch_by_traits
-  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.
   # @param [Class] object_class a class that includes {Scorpion::Object}.
   # @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, *arguments, **dependencies, &block )
+  def spawn( hunt, object_class, *arguments, &block )
     if object_class < Scorpion::Object
-      object_class.spawn hunt, *arguments, **dependencies, &block
+      object_class.spawn hunt, *arguments, &block
     else
       object_class.new *arguments, &block
     end
@@ -54,7 +45,7 @@ module Scorpion
   # @param [Scorpion::Object] target to inject.
   # @return [target]
   def inject( target )
-    hunt = Scorpion::Hunt.new self, nil, nil
+    hunt = Scorpion::Hunt.new self, nil
     hunt.inject target
 
     target
@@ -64,14 +55,14 @@ 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 new( object_class, *arguments, **dependencies, &block )
-    hunt = Hunt.new( self, object_class, nil, *arguments, **dependencies, &block )
+  def new( object_class, *arguments, &block )
+    hunt = Hunt.new( self, object_class, *arguments, &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.
+  # @return [Object] an object that satisfies the hunt contract.
   def execute( hunt )
     fail "Not implemented"
   end
@@ -102,6 +93,7 @@ module Scorpion
   def logger
     @logger || Scorpion.logger
   end
+
   def logger=( value )
     @logger = value
   end
@@ -125,7 +117,7 @@ module Scorpion
 
   def self.instance=( scorpion )
     if @instance_referenced
-      logger.warn "Replacing the global Scorpion.instance will not update any Scorpion::Nest instances created with the original scorpion."
+      logger.warn "Replacing the global Scorpion.instance will not update any Scorpion::Nest instances created with the original scorpion." # rubocop:disable Metrics/LineLength
       @instance_referenced = false
     end
     @instance = scorpion
@@ -145,17 +137,12 @@ module Scorpion
     instance.fetch dependencies, &block
   end
 
-  # Hunt for dependency from the primary Scorpion {#instance}.
-  # @see #fetch_by_traits
-  def self.fetch_by_traits( dependencies, &block )
-    instance.fetch_by_traits dependencies, &block
-  end
-
   # @!attribute logger
   # @return [Logger] logger for the Scorpion framework to use.
   def self.logger
     @logger ||= defined?( ::Rails ) ? ::Rails.logger : Logger.new( STDOUT )
   end
+
   def self.logger=( value )
     @logger = value
   end
@@ -168,8 +155,8 @@ module Scorpion
 
     # Used by concrete scorpions to notify the caller that the hunt was
     # unsuccessful.
-    def unsuccessful_hunt( contract, traits )
-      fail UnsuccessfulHunt.new contract, traits
+    def unsuccessful_hunt( contract )
+      fail UnsuccessfulHunt, contract
     end
 
 end