codependent 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9346a0d2621442d6fba3e69e244895fb5a4c22dc
-  data.tar.gz: ff00bf9084921b52e50dbeba357ff06a8eadcaa7
+  metadata.gz: 824b117cef6d2000cb55df3ed8793c75f2119d42
+  data.tar.gz: d83e83d6c90f343853e26a8f6d154798bc2e32ef
 SHA512:
-  metadata.gz: 4d9d0327496277dad897ce11b73abd6548ed3f97d107d17e1bc844958e35bb42191ecd5321c17a6c3c9ecd2ab04f5d4888de3224bcdb3026910f0f283fa33765
-  data.tar.gz: 3a8a641f957db178008be0848fde2813c10c15430cd79d3fa970962d95b5426efeaf3dda1feca61031f5c9ebe7c1122def7d9cf4c756816ce6f0e3bdb9d3384d
+  metadata.gz: 16364a8df976b2b7a6da996898d16c4210248d25bb3774d0a446001d10d2fdf73395027979d87c6e359efd086b713a33b40dece6127330b356519e2249956da6
+  data.tar.gz: 2c27d0c05a78fcf297225a43cfa2cefe69cec7ed20e644841750dfee3acb253b33ce58a1efda727e8ec5ee7fe3f645bc997c2caa11dcb09b4188155e2c198d1f

data/Changelog.md

@@ -3,3 +3,23 @@
 ### Features
 
 * Initial Release
+
+## 0.2 - New injection types!
+
+### Features
+
+* Constructor injection
+* Value injection
+* Provider functions
+* Dependency type checking
+* New DSL syntax
+
+## 0.3 - Better error handling
+
+### Features
+
+* Validation errors are more descriptive and contain the ID of the injectable.
+
+### Bug Fixes
+
+* Dependencies that appear in multiple places in the dependency graph are injected properly.

data/Gemfile

@@ -1,10 +1,4 @@
 source 'https://rubygems.org'
 
-group :development do
-  gem 'rspec'
-  gem 'pry'
-  gem 'pry-byebug'
-  gem 'rubocop', '~> 0.40.0', require: false
-  gem 'rake'
-  gem 'simplecov', require: false
-end
+# Specify your gem's dependencies in pastafari.gemspec
+gemspec

data/Gemfile.lock

@@ -1,3 +1,8 @@
+PATH
+  remote: .
+  specs:
+    codependent (0.3)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -52,6 +57,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  codependent!
   pry
   pry-byebug
   rake

data/README.md

@@ -114,7 +114,7 @@ Codependent::Manager.container :my_container do
   # This block is passed to a new container instance and uses the same syntax
   # we've already seen.
   instance :logger do
-    with_constructor { Logger.new }
+    from_value Logger.new
   end
 end
 
@@ -131,33 +131,6 @@ Codependent::Manager.reset_container!(:my_container)
 Codependent::Manager.reset!
 ```
 
-### Class Definition Syntax
-
-```ruby
-# Not everyone wants to configure the container up front. You can define your
-# dependencies in your class definitions with the Codependent Helper.
-class UserRepository
-  extend Codependent::Helper
-
-  # Tell Codependent what to call this injectable and how it should be resolved:
-  singleton :user_repository do
-    # The syntax here is the same as before.
-    with_constructor { self.new }
-    depends_on :logger
-  end
-end
-
-class Logger
-  extend Codependent::Helper
-
-  # You can also specify the managed container into which this type should be
-  # defined:
-  instance :logger, in_container: :my_container do
-    with_constructor { self.new }
-  end
-end
-```
-
 ## Developing Codependent
 
 ### Building from source
@@ -166,5 +139,5 @@ end
 2. Install dependencies: `bundle install`
 3. Run the tests: `bundle exec rake ci`
 4. Build a local copy of the gem: `gem build codependent.gemspec`
-5. Install the gem locally: `gem install ./Codependent-0.1.gem`
+5. Install the gem locally: `gem install ./codependent-0.2.gem`
 6. Don't forget to version-bump the gemspec before publishing!

data/codependent.gemspec

@@ -1,11 +1,18 @@
 Gem::Specification.new do |s|
   s.name        = 'codependent'
-  s.version     = '0.2'
-  s.date        = '2017-02-23'
+  s.version     = '0.3'
+  s.date        = '2017-02-24'
   s.summary     = "A simple dependency injection library for Ruby."
   s.authors     = ["Joshua Tompkins"]
   s.email       = 'josh@joshtompkins.com'
   s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   s.homepage    = 'https://github.com/jtompkins/codependent'
   s.license     = 'MIT'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubocop', '~> 0.40.0'
+  s.add_development_dependency 'simplecov'
 end

data/lib/codependent/container.rb

@@ -50,7 +50,7 @@ module Codependent
     end
 
     def add_injectable!(id, type, config_block)
-      builder = Codependent::InjectableBuilder.new(type)
+      builder = Codependent::InjectableBuilder.new(id, type)
 
       builder.instance_eval(&config_block)
 

data/lib/codependent/errors.rb

@@ -0,0 +1,53 @@
+module Codependent
+  module Errors
+    class CodependentError < StandardError; end
+
+    class MissingTypeError < CodependentError
+      def message
+        'Type injection requires a type.'
+      end
+    end
+
+    class MissingKeywordArgError < CodependentError
+      def message
+        'All dependencies must appear as keyword arguments.'
+      end
+    end
+
+    class MissingAccessorError < CodependentError
+      def message
+        'All dependencies must have accessors.'
+      end
+    end
+
+    class NoConstructorArgsError < CodependentError
+      def message
+        'No constructor arguments.'
+      end
+    end
+
+    class MissingProviderBlockError < CodependentError
+      def message
+        'Providers must have a block.'
+      end
+    end
+
+    class ValueDependencyError < CodependentError
+      def message
+        'Value injectables may not have dependencies.'
+      end
+    end
+
+    class NoValueError < CodependentError
+      def message
+        'Value injectables must have a value.'
+      end
+    end
+
+    class ValueOnInstanceError < CodependentError
+      def message
+        'Value injectables cannot be singletons.'
+      end
+    end
+  end
+end

data/lib/codependent/injectable_builder.rb

@@ -1,4 +1,5 @@
 require 'codependent/injectable'
+require 'codependent/errors'
 
 require 'codependent/validators/value_validator'
 require 'codependent/validators/provider_validator'
@@ -12,14 +13,15 @@ require 'codependent/resolvers/value_resolver'
 
 module Codependent
   class InjectableBuilder
-    def initialize(type)
+    def initialize(id, type)
+      @id = id
       @type = type
       @dependencies = []
       @state = {}
       @skip_checks = false
     end
 
-    attr_reader :type, :dependencies, :state, :validator, :resolver
+    attr_reader :id, :type, :dependencies, :state, :validator, :resolver
 
     def from_value(value)
       @state = { value: value }
@@ -59,9 +61,17 @@ module Codependent
     def build
       return unless @validator
 
-      @validator.new.(@type, @state, @dependencies) unless @skip_checks
+      validate unless @skip_checks
 
       Injectable.new(@type, @dependencies, @state, @resolver)
     end
+
+    private
+
+    def validate
+      @validator.new.(@type, @state, @dependencies)
+    rescue Codependent::Errors::CodependentError => e
+      raise "#{e.message} Check the configuration for #{id}."
+    end
   end
 end

data/lib/codependent/resolvers/root_resolver.rb

@@ -26,7 +26,8 @@ module Codependent
 
       def resolve_eager_dependencies(injectable_ids)
         injectable_ids.reduce({}) do |acc, id|
-          acc.merge(id => resolve_value(id, acc))
+          next acc if acc.key?(id)
+          acc.tap { |hash| hash[id] = resolve_value(id, acc) }
         end
       end
 
@@ -71,9 +72,8 @@ module Codependent
           current = injectables[stack.pop]
 
           current.dependencies.each do |dep_id|
-            next if dependencies.include?(dep_id)
+            stack.push(dep_id) unless dependencies.include?(dep_id)
             dependencies.unshift(dep_id)
-            stack.push(dep_id)
           end
         end
 

data/lib/codependent/validators/constructor_injection_validator.rb

@@ -1,12 +1,10 @@
+require 'codependent/errors'
+
 module Codependent
   module Validators
     class ConstructorInjectionValidator
-      MISSING_TYPE_ERROR = 'Constructor injection requires a type to be specified.'.freeze
-      MISSING_DEPENDENCY_KEYWORDS_ERROR = 'All dependencies must appear as keyword arguments to the constructor.'.freeze
-      NO_ARGS_WITH_DEPENDENCIES_ERROR = 'Constructor injection requires the constructor to receive arguments.'.freeze
-
       def call(_, state, dependencies)
-        raise MISSING_TYPE_ERROR unless state[:type]
+        raise Codependent::Errors::MissingTypeError unless state[:type]
 
         return unless dependencies.count > 0
 
@@ -30,7 +28,7 @@ module Codependent
       def validate_constructor_params(klass, dependencies)
         params = klass.instance_method(:initialize).parameters
 
-        raise NO_ARGS_WITH_DEPENDENCIES_ERROR if params.count == 0
+        raise Codependent::Errors::NoConstructorArgsError if params.count == 0
 
         return unless all_keywords?(params)
 
@@ -38,7 +36,7 @@ module Codependent
 
         return if params_for_all_dependencies?(dependencies, parameter_names)
 
-        raise MISSING_DEPENDENCY_KEYWORDS_ERROR
+        raise Codependent::Errors::MissingKeywordArgError
       end
     end
   end

data/lib/codependent/validators/provider_validator.rb

@@ -1,10 +1,10 @@
+require 'codependent/errors'
+
 module Codependent
   module Validators
     class ProviderValidator
-      NO_BLOCK_ERROR = 'Provider injectables must have a block.'.freeze
-
       def call(_, state, _)
-        raise NO_BLOCK_ERROR unless state[:provider]
+        raise Codependent::Errors::MissingProviderBlockError unless state[:provider]
       end
     end
   end

data/lib/codependent/validators/setter_injection_validator.rb

@@ -1,11 +1,12 @@
+require 'codependent/errors'
+
 module Codependent
   module Validators
     class SetterInjectionValidator
-      MISSING_TYPE_ERROR = 'Setter injection requires a type to be specified.'.freeze
       MISSING_ACCESSOR_KEYWORDS_ERROR = 'All dependencies must appear as accessors on the class.'.freeze
 
       def call(_, state, dependencies)
-        raise MISSING_TYPE_ERROR unless state[:type]
+        raise Codependent::Errors::MissingTypeError unless state[:type]
 
         return unless dependencies.count > 0
 
@@ -17,7 +18,7 @@ module Codependent
       def validate_setters(klass, dependencies)
         dependencies.each do |dep_id|
           unless klass.method_defined? "#{dep_id}=".to_sym
-            raise MISSING_ACCESSOR_KEYWORDS_ERROR
+            raise Codependent::Errors::MissingAccessorError
           end
         end
       end

data/lib/codependent/validators/value_validator.rb

@@ -1,17 +1,15 @@
+require 'codependent/errors'
+
 module Codependent
   module Validators
     class ValueValidator
-      SINGLETON_ERROR = 'Value injectables are only allowed on singletons.'.freeze
-      NIL_VALUE_ERROR = 'Value injectables must not be nil.'.freeze
-      NO_DEPENDENCIES_ERROR = 'Value injectables may not have dependencies'.freeze
-
       def call(type, state, dependencies)
-        raise SINGLETON_ERROR unless type == :singleton
-        raise NIL_VALUE_ERROR unless state[:value]
+        raise Codependent::Errors::ValueOnInstanceError unless type == :singleton
+        raise Codependent::Errors::NoValueError unless state[:value]
 
         no_dependencies = !dependencies || dependencies.count != 0
 
-        raise NO_DEPENDENCIES_ERROR if no_dependencies
+        raise Codependent::Errors::ValueDependencyError if no_dependencies
       end
     end
   end

data/lib/codependent.rb

@@ -2,6 +2,7 @@ require 'codependent/manager'
 require 'codependent/container'
 require 'codependent/injectable'
 require 'codependent/injectable_builder'
+require 'codependent/errors'
 
 require 'codependent/resolvers/root_resolver'
 require 'codependent/resolvers/eager_type_resolver'

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: codependent
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Joshua Tompkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
-dependencies: []
+date: 2017-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: josh@joshtompkins.com
 executables: []
@@ -29,6 +113,7 @@ files:
 - codependent.gemspec
 - lib/codependent.rb
 - lib/codependent/container.rb
+- lib/codependent/errors.rb
 - lib/codependent/injectable.rb
 - lib/codependent/injectable_builder.rb
 - lib/codependent/manager.rb