injectable 0.0.5 → 1.0.0

data/lib/injectable/instance_methods.rb

@@ -0,0 +1,53 @@
+module Injectable
+  module InstanceMethods
+    # Initialize the service with the dependencies injected
+    def initialize(args = {})
+      check_missing_arguments!(self.class.required_initialize_arguments, args)
+      variables_for!(self.class.initialize_arguments, args)
+      variables_from_dependencies!(args)
+      super()
+    end
+
+    # Entry point of the service.
+    # Arguments for this method should be declared explicitly with '.argument'
+    # and declare this method without arguments
+    def call(args = {})
+      check_call_definition!
+      check_missing_arguments!(self.class.required_call_arguments, args)
+      variables_for!(self.class.call_arguments, args)
+      super()
+    end
+
+    private
+
+    def check_call_definition!
+      return if (self.class.ancestors - [Injectable::InstanceMethods]).any? do |ancestor|
+        ancestor.instance_methods(false).include?(:call)
+      end
+      raise NoMethodError, "A #call method with zero arity must be defined in #{self.class}"
+    end
+
+    def check_missing_arguments!(expected, args)
+      missing = expected - args.keys
+      return if missing.empty?
+      raise ArgumentError, "missing keywords: #{missing.join(',')}"
+    end
+
+    def variables_for!(subject, args)
+      subject.each do |arg, options|
+        instance_variable_set("@#{arg}", args.fetch(arg) { options[:default] })
+      end
+    end
+
+    def variables_from_dependencies!(args)
+      self.class.dependencies.names.each do |name|
+        next if self.class.initialize_arguments.key?(name)
+        instance_variable_set("@#{name}", args[name]) if args.key?(name)
+      end
+    end
+
+    def dependencies_proxy
+      @dependencies_proxy ||= self.class.dependencies.proxy
+    end
+  end
+end

data/lib/injectable/missing_dependencies_exception.rb

@@ -0,0 +1,4 @@
+module Injectable
+  class MissingDependenciesException < RuntimeError
+  end
+end

data/lib/injectable/version.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Injectable
-  VERSION = "0.0.5"
+  VERSION = '1.0.0'
 end

metadata

@@ -1,61 +1,112 @@
 --- !ruby/object:Gem::Specification
 name: injectable
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
-- Durran Jordan
+- Papipo
+- iovis9
+- jantequera
+- amrocco
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2013-01-18 00:00:00.000000000 Z
-dependencies: []
-description: Dead simple Ruby dependency injection
+date: 2019-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
 email:
-- durran@gmail.com
+- rodrigo@rubiconmd.com
+- david.marchante@rubiconmd.com
+- julio@rubiconmd.com
+- anthony@rubiconmd.com
 executables: []
 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
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
-- LICENSE
 - Rakefile
-homepage: 
-licenses: []
+- bin/console
+- bin/setup
+- injectable.gemspec
+- lib/injectable.rb
+- lib/injectable/class_methods.rb
+- lib/injectable/dependencies_graph.rb
+- lib/injectable/dependencies_proxy.rb
+- lib/injectable/dependency.rb
+- lib/injectable/instance_methods.rb
+- lib/injectable/missing_dependencies_exception.rb
+- lib/injectable/version.rb
+homepage: https://github.com/rubiconmd/injectable
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1355353312328350373
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1355353312328350373
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.7.6
 signing_key: 
-specification_version: 3
-summary: Dead simple Ruby dependency injection
+specification_version: 4
+summary: A library to help you build nice service objects with dependency injection.
 test_files: []

data/LICENSE

@@ -1,20 +0,0 @@
-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/lib/injectable/container.rb

@@ -1,127 +0,0 @@
-# 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(:user_service)
-    #
-    # @param [ Symbol ] name the role which the returned object should perform.
-    #
-    # @return [ Object ] The instantiated object.
-    #
-    # @raise [ Injectable::RoleNotRegistered ] if queried for a role which is not
-    #   registered
-    #
-    # @since 0.0.0
-    def get(name)
-      classes = registered_implementations(name)
-      if klass = instantiated_class(classes)
-        instantiated_objects[klass]
-      else
-        object = instantiate(classes)
-        instantiated_objects[object.class] = object
-      end
-    end
-
-    # Create a new container with the objects needed to resolve dependencies
-    # and create new objects.
-    #
-    # @example Create the new container.
-    #   Injectable::Container.new(user, user_finder)
-    #
-    # @param [ Array<Object> ] objects The dependencies.
-    #
-    # @since 0.0.0
-    def initialize(*objects)
-      objects.each do |object|
-        instantiated_objects[object.class] = object
-      end
-    end
-
-    # Put objects into the container. Can be a single or multiple instances.
-    #
-    # @example Put an object in the container.
-    #   container.put(user)
-    #
-    # @example Put multiple objects in the container.
-    #   container.put(user, user_finder)
-    #
-    # @param [ *Object ] objects The objects to put in the container.
-    #
-    # @return [ Injectable::Container ] The container itself.
-    #
-    # @since 0.0.0
-    def put(*objects)
-      objects.flatten.each do |object|
-        instantiated_objects[object.class] = object
-      end and self
-    end
-
-    # This error is raised when asking for an object out of the container that
-    # cannot be resolved.
-    #
-    # @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
-
-    def dependencies(klass)
-      (Registry.signature(klass) || []).map do |dependency|
-        get(dependency)
-      end
-    end
-
-    def registered_implementations(name)
-      implementations[name] || Registry.implementation(name)
-    end
-
-    def instantiate(classes)
-      classes.each do |klass|
-        begin
-          return klass.new(*dependencies(klass))
-        rescue ArgumentError; end
-      end
-      raise Unresolvable.new(classes)
-    end
-
-    def instantiated_objects
-      @instantiated_objects ||= {}
-    end
-
-    def instantiated_class(classes)
-      classes.detect do |klass|
-        instantiated_objects[klass]
-      end
-    end
-  end
-end

data/lib/injectable/inflector.rb

@@ -1,30 +0,0 @@
-# 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/macros.rb

@@ -1,60 +0,0 @@
-# encoding: utf-8
-module Injectable
-
-  # Provides class level macros for setting up dependencies.
-  #
-  # @since 0.0.0
-  module Macros
-
-    # Sets up the dependencies for the class.
-    #
-    # @example Define a UserService that has two dependencies.
-    #   class User; end
-    #   class UserFinder; end
-    #
-    #   class UserService
-    #     include Injectable
-    #     dependencies :user, :user_finder
-    #   end
-    #
-    # @note A constructor will get created for the object that takes the same
-    #   number or arguments as provided to the dependencies macro. The types
-    #   of these arguments must match the "classified" name of the provided
-    #   symbol. For example :user would be a User class, :user_finder would be
-    #   a UserFinder class. Order matters.
-    #
-    # @param [ Array<Symbol> ] injectables The dependency list.
-    #
-    # @since 0.0.0
-    def dependencies(*injectables)
-      define_constructor(*injectables)
-      define_readers(*injectables)
-      Registry.register_signature(self, injectables)
-    end
-
-    private
-
-    def define_constructor(*injectables)
-      names = names(*injectables)
-      class_eval <<-CONST
-        def initialize(#{names})
-          #{ivars(*injectables)} = #{names}
-        end
-      CONST
-    end
-
-    def define_readers(*injectables)
-      injectables.each do |dependency|
-        attr_reader(dependency)
-      end
-    end
-
-    def ivars(*injectables)
-      injectables.map { |name| "@#{name}" }.join(",")
-    end
-
-    def names(*injectables)
-      injectables.join(",")
-    end
-  end
-end