injectable 0.0.3 → 0.0.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Durran Jordan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -86,6 +86,47 @@ user_service = container.get(:user_service)
 # `user_service`'s facebook_service will be an instance of DifferentFacebookService
 ```
 
+Multiple implementations for the same role can be configured - the rules on how
+they will be used are as follows: Check for an already instantiated instance in
+the container. If one or both exist, take the first. If none exist, then attempt to
+resolve the dependency with each registered role until one succeeds. An example:
+
+```ruby
+module Portable
+  def charge
+    # Some logic here.
+  end
+end
+
+class Phone
+  include Injectable
+  include Portable
+end
+
+class Tablet
+  include Injectable
+  include Portable
+end
+
+class Application
+  include Injectable
+  dependencies :portable
+end
+
+Injectable.configure do |config|
+  config.register_implementation(:portable, Phone, Tablet)
+end
+
+container = Injectable::Container.new
+application = container.get(:application)
+application.portable #=> Returns a new Phone.
+
+tablet = Tablet.new
+container = Injectable::Container.new(tablet)
+application = container.get(:application)
+application.portable #=> Returns the existing instance of a Tablet.
+```
+
 Setter injection is not supported.
 
 How about the real world
@@ -124,8 +165,8 @@ related to what one might do in a real application.
 class UsersController < ApplicationController
 
   def post_to_wall
-    container.get(UserService).post_to_wall(params[:message])
-    respond_with container.get(User)
+    container.get(:user_service).post_to_wall(params[:message])
+    respond_with container.get(:user)
   end
 
   private

data/lib/injectable.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-require "active_support/inflector"
 require "injectable/container"
+require "injectable/inflector"
 require "injectable/macros"
 require "injectable/registry"
 
@@ -41,7 +41,10 @@ module Injectable
     #
     # @since 0.0.0
     def included(klass)
-      Registry.register_implementation(klass.name.underscore.to_sym, klass)
+      Registry.register_implementation(
+        Inflector.underscore(klass.name).to_sym,
+        klass
+      )
       klass.extend(Macros)
     end
   end

data/lib/injectable/container.rb

@@ -1,15 +1,18 @@
 # encoding: utf-8
+require "injectable/registerable"
+
 module Injectable
 
   # A simple container that can resolve dependencies.
   #
   # @since 0.0.0
   class Container
+    include Registerable
 
     # Get an instance of an object from the container with the provided class.
     #
     # @example Get an instance of an object for class UserService.
-    #   container.get(UserService)
+    #   container.get(:user_service)
     #
     # @param [ Symbol ] name the role which the returned object should perform.
     #
@@ -20,11 +23,12 @@ module Injectable
     #
     # @since 0.0.0
     def get(name)
-      klass = implementing_class(name)
-      if instantiated_objects.has_key?(klass)
+      classes = registered_implementations(name)
+      if klass = instantiated_class(classes)
         instantiated_objects[klass]
       else
-        instantiated_objects[klass] = instantiate(klass)
+        object = instantiate(classes)
+        instantiated_objects[object.class] = object
       end
     end
 
@@ -43,19 +47,31 @@ module Injectable
       end
     end
 
-    # Register that instances of klass will perform the given role in this
-    # container context.
-    #
-    # @example Register that the user_finder role will be performed by
-    #   instances of DatabaseUserFinder
-    #   container.register_implementation(:user_finder, DatabaseUserFinder)
-    #
-    # @param [ Symbol ] name The name of the role.
-    # @param [ Class ] klass The name of the class performing this role.
+    # This error is raised when asking for an object out of the container that
+    # cannot be resolved.
     #
-    # @since 0.0.1
-    def register_implementation(name, klass)
-      implementing_classes[name] = klass
+    # @since 0.0.4
+    class Unresolvable < Exception
+
+      # @attribute [r] classes The classes that were attempted to instantiate.
+      attr_reader :classes
+
+      # Initialize the new error.
+      #
+      # @example Initialize the error.
+      #   Unresolvable.new([ Persistable, Saveable ])
+      #
+      # @param [ Array<Class> ] classes The classes that were attempted to
+      #   instantiate with.
+      #
+      # @since 0.0.4
+      def initialize(classes)
+        @classes = classes
+        super(
+          "Could not instantiate an object for any of: #{classes.join(", ")}. " +
+          "Please ensure all required dependencies are in the container."
+        )
+      end
     end
 
     private
@@ -66,20 +82,27 @@ module Injectable
       end
     end
 
-    def instantiate(klass)
-      klass.new(*dependencies(klass))
+    def registered_implementations(name)
+      implementations[name] || Registry.implementation(name)
     end
 
-    def instantiated_objects
-      @instantiated_objects ||= {}
+    def instantiate(classes)
+      classes.each do |klass|
+        begin
+          return klass.new(*dependencies(klass))
+        rescue ArgumentError; end
+      end
+      raise Unresolvable.new(classes)
     end
 
-    def implementing_class(name)
-      implementing_classes[name] || Registry.implementation(name)
+    def instantiated_objects
+      @instantiated_objects ||= {}
     end
 
-    def implementing_classes
-      @implementing_classes ||= {}
+    def instantiated_class(classes)
+      classes.detect do |klass|
+        instantiated_objects[klass]
+      end
     end
   end
 end

data/lib/injectable/inflector.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Injectable
+
+  # Used so we don't need active support around to perform inflections.
+  #
+  # @since 0.0.4
+  module Inflector
+
+    class << self
+
+      # Underscore a string. This is partially taken from Active Support, but
+      # dumbed down for our purposes - we don't handle namespacing.
+      #
+      # @example Underscore a string.
+      #   Inflector.underscore("Band")
+      #
+      # @param [ String ] string The string to underscore.
+      #
+      # @since 0.0.4
+      #
+      # @return [ String ] The underscored string.
+      def underscore(string)
+        value = string.dup
+        value.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        value.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        value.downcase!
+      end
+    end
+  end
+end

data/lib/injectable/registerable.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Injectable
+  module Registerable
+
+    # Register that instances of klass will perform the given role in this
+    # container context.
+    #
+    # @example Register that the user_finder role will be performed by
+    #   instances of DatabaseUserFinder
+    #   container.register_implementation(:user_finder, DatabaseUserFinder)
+    #
+    # @param [ Symbol ] name The name of the role.
+    # @param [ *Class ] classes The names of the classes performing this role.
+    #
+    # @since 0.0.1
+    def register_implementation(name, *classes)
+      implementations[name] = classes.flatten
+    end
+
+    private
+
+    def implementations
+      @implementations ||= {}
+    end
+  end
+end

data/lib/injectable/registry.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+require "injectable/registerable"
+
 module Injectable
 
   # The registry keeps track of all objects and their dependencies that need
@@ -6,6 +8,7 @@ module Injectable
   #
   # @since 0.0.0
   module Registry
+    include Registerable
     extend self
 
     # Get an implementation for the provided name.
@@ -19,22 +22,9 @@ module Injectable
     #
     # @since 0.0.2
     def implementation(name)
-      implementations[name] || raise(NotRegistered.new(name))
-    end
-
-    # Add an implementing class for a name to the registry.
-    #
-    # @example Add an implementation.
-    #   Injectable::Registry.register_implementation(
-    #     :persistable, User
-    #   )
-    #
-    # @param [ Symbol ] name The name of the implementation.
-    # @param [ Class ] klass The implementing class.
-    #
-    # @since 0.0.2
-    def register_implementation(name, klass)
-      implementations[name] = klass
+      impl = implementations[name]
+      raise(NotRegistered.new(name)) unless impl && !impl.empty?
+      impl
     end
 
     # Add a constructor method signature to the registry.
@@ -92,10 +82,6 @@ module Injectable
 
     private
 
-    def implementations
-      @implementations ||= {}
-    end
-
     def signatures
       @signatures ||= {}
     end

data/lib/injectable/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Injectable
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: injectable
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3'
+date: 2013-01-17 00:00:00.000000000 Z
+dependencies: []
 description: Dead simple Ruby dependency injection
 email:
 - durran@gmail.com
@@ -35,11 +19,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/injectable/container.rb
+- lib/injectable/inflector.rb
 - lib/injectable/macros.rb
+- lib/injectable/registerable.rb
 - lib/injectable/registry.rb
 - lib/injectable/version.rb
 - lib/injectable.rb
 - README.md
+- LICENSE
 - Rakefile
 homepage: 
 licenses: []
@@ -55,7 +42,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -519657374346971908
+      hash: 1285461619687616243
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -64,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -519657374346971908
+      hash: 1285461619687616243
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24