fabrique 0.3.1 → 1.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fabrique
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sheldon Hearn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,8 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Factory support library for adapting existing modules for injection as
-  dependencies
+description: Configuration-based factory for dependency injection
 email:
 - sheldonh@starjuice.net
 executables: []
@@ -90,27 +89,39 @@ files:
 - docs/multiple_providers.rb
 - fabrique.gemspec
 - features/bean_factory.feature
-- features/plugin_registry.feature
 - features/step_definitions/bean_factory_steps.rb
-- features/step_definitions/plugin_registry_steps.rb
 - features/support/byebug.rb
+- features/support/fabrique.rb
+- fixtures/local_only-0.1.0.gem
+- fixtures/local_only/.gitignore
+- fixtures/local_only/Gemfile
+- fixtures/local_only/README.md
+- fixtures/local_only/Rakefile
+- fixtures/local_only/bin/console
+- fixtures/local_only/bin/setup
+- fixtures/local_only/lib/local_only.rb
+- fixtures/local_only/lib/local_only/version.rb
+- fixtures/local_only/local_only.gemspec
+- fixtures/sample/.gitignore
+- fixtures/sample/Gemfile
+- fixtures/sample/README.md
+- fixtures/sample/Rakefile
+- fixtures/sample/bin/console
+- fixtures/sample/bin/setup
+- fixtures/sample/lib/sample.rb
+- fixtures/sample/lib/sample/version.rb
+- fixtures/sample/sample.gemspec
 - lib/fabrique.rb
-- lib/fabrique/argument_adaptor/keyword.rb
-- lib/fabrique/argument_adaptor/positional.rb
 - lib/fabrique/bean_definition.rb
 - lib/fabrique/bean_definition_registry.rb
 - lib/fabrique/bean_factory.rb
 - lib/fabrique/bean_property_reference.rb
 - lib/fabrique/bean_reference.rb
-- lib/fabrique/construction/as_is.rb
-- lib/fabrique/construction/builder_method.rb
-- lib/fabrique/construction/default.rb
-- lib/fabrique/construction/keyword_argument.rb
-- lib/fabrique/construction/positional_argument.rb
-- lib/fabrique/construction/properties_hash.rb
-- lib/fabrique/constructor/identity.rb
 - lib/fabrique/cyclic_bean_dependency_error.rb
-- lib/fabrique/plugin_registry.rb
+- lib/fabrique/data_bean.rb
+- lib/fabrique/gem_definition.rb
+- lib/fabrique/gem_dependency_error.rb
+- lib/fabrique/gem_loader.rb
 - lib/fabrique/test.rb
 - lib/fabrique/test/fixtures/constructors.rb
 - lib/fabrique/test/fixtures/modules.rb
@@ -118,15 +129,7 @@ files:
 - lib/fabrique/test/fixtures/repository.rb
 - lib/fabrique/version.rb
 - lib/fabrique/yaml_bean_factory.rb
-- spec/fabrique/argument_adaptor/keyword_spec.rb
-- spec/fabrique/argument_adaptor/positional_spec.rb
-- spec/fabrique/construction/as_is_spec.rb
-- spec/fabrique/construction/builder_method_spec.rb
-- spec/fabrique/construction/default_spec.rb
-- spec/fabrique/construction/positional_argument_spec.rb
-- spec/fabrique/construction/properties_hash_spec.rb
-- spec/fabrique/constructor/identity_spec.rb
-- spec/fabrique/plugin_registry_spec.rb
+- spec/fabrique/data_bean_spec.rb
 - spec/fabrique/yaml_bean_factory_spec.rb
 - spec/fabrique_spec.rb
 - spec/spec_helper.rb
@@ -142,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -153,22 +156,13 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Factory support library
+summary: Configuration-based factory for dependency injection
 test_files:
 - features/bean_factory.feature
-- features/plugin_registry.feature
 - features/step_definitions/bean_factory_steps.rb
-- features/step_definitions/plugin_registry_steps.rb
 - features/support/byebug.rb
-- spec/fabrique/argument_adaptor/keyword_spec.rb
-- spec/fabrique/argument_adaptor/positional_spec.rb
-- spec/fabrique/construction/as_is_spec.rb
-- spec/fabrique/construction/builder_method_spec.rb
-- spec/fabrique/construction/default_spec.rb
-- spec/fabrique/construction/positional_argument_spec.rb
-- spec/fabrique/construction/properties_hash_spec.rb
-- spec/fabrique/constructor/identity_spec.rb
-- spec/fabrique/plugin_registry_spec.rb
+- features/support/fabrique.rb
+- spec/fabrique/data_bean_spec.rb
 - spec/fabrique/yaml_bean_factory_spec.rb
 - spec/fabrique_spec.rb
 - spec/spec_helper.rb

data/features/plugin_registry.feature

@@ -1,79 +0,0 @@
-@plugin_registry
-Feature: Plugin registry
-
-  As a developer
-  I want to register the identity and construction method of different plugins
-  So that I can decouple their dependants from their means of creation
-
-  Plugins are classes, modules, objects or lambdas that may come from other developers, and so
-  may have disparate construction methods. A plugin registry allows these differences to be
-  abstracted, and for them to be created by a known and invariant identity. The identities of
-  plugins must be defined by the developer of the dependant.
-
-  This does not address the concern of ensuring that multiple plugins offer the same interface.
-  That concern is dealt with by a contract conformance strategy (e.g. interface through
-  delegation).
-
-  Most developers will not use a plugin registry directly. Instead, they will use a factory
-  that implements a conformance strategy. This has the additional benefit of allowing the
-  developers of plugins to define and register the identities of their plugins.
-
-  Scenario: Multiple plugins
-
-    Given I have a plugin registry
-    And I have two classes with default constructors
-    When I register each class into the registry with a unique identity and a default construction method
-    Then I can acquire instances of each class from the registry by its unique identity
-
-  Scenario Outline: As-is plugin
-
-    Given I have a plugin registry
-    And I have <article> <entity>, i.e. <code>
-    When I register the <entity> into the registry with a unique identity and an as-is construction method
-    Then I get the same <entity> every time I acquire the same identity
-
-    Examples:
-      | article | entity | code       |
-      | an      | object | Object.new |
-      | a       | class  | Class      |
-      | a       | module | Module     |
-      | a       | lambda | -> {}      |
-
-  Scenario: Classical plugin with default constructor
-
-    Given I have a plugin registry
-    And I have a class with a default constructor
-    When I register the class into the registry with a unique identity and a default construction method
-    Then I can acquire instances of the class from the registry by its unique identity
-
-  Scenario: Classical plugin with properties hash constructor
-
-    Given I have a plugin registry
-    And I have a class with a properties hash constructor
-    When I register the class into the registry with a unique identity and a properties hash construction method
-    Then I can acquire an instance of the class from the registry by its unique identity, specifying properties with a hash argument
-
-  Scenario: Classical plugin with positional argument constructor
-
-    Given I have a plugin registry
-    And I have a class with a positional argument constructor
-    When I register the class into the registry with a unique identity and a positional argument construction method
-    Then I can acquire an instance of the class from the registry by its unique identity, specifying properties with a hash argument
-    And the instance has the specified properties
-
-  Scenario: Classical plugin with keyword argument constructor
-
-    Given I have a plugin registry
-    And I have a class with a keyword argument constructor
-    When I register the class into the registry with a unique identity and a keyword argument construction method
-    Then I can acquire an instance of the class from the registry by its unique identity, specifying properties with a hash argument
-    And the instance has the specified properties
-
-  Scenario: Builder pattern plugin
-
-    Given I have a plugin registry
-    And I have a class with a builder method
-    When I register the class into the registry with a unique identity and builder construction method
-    Then I can acquire an instance of the class from the registry by its unique identity, specifying properties with a hash argument
-    And the instance has the specified properties
-

data/features/step_definitions/plugin_registry_steps.rb

@@ -1,207 +0,0 @@
-require "rspec"
-require "fabrique/test"
-
-class PluginRegistryTestRunner
-  include RSpec::Matchers
-  include Fabrique::Test::Fixtures::Constructors
-
-  def initialize(subject_constructor)
-    @subject_constructor = subject_constructor
-  end
-
-  def have_plugin_registry
-    @registry = @subject_constructor.call
-  end
-
-  def have_class_with_default_constructor
-    @class = ClassWithDefaultConstructor
-  end
-
-  def have_two_classes_with_default_constructors
-    @class1 = ClassWithDefaultConstructor
-    @class2 = OtherClassWithDefaultConstructor
-  end
-
-  def have_object(object)
-    @object = object
-  end
-
-  def have_class_with_positional_argument_constructor
-    @class = ClassWithPositionalArgumentConstructor
-  end
-
-  def have_class_with_properties_hash_constructor
-    @class = ClassWithPropertiesHashConstructor
-  end
-
-  def have_class_with_keyword_argument_constructor
-    @class = ClassWithKeywordArgumentConstructor
-  end
-
-  def have_class_with_builder_method
-    @class = ClassWithBuilderMethod
-  end
-
-  def register_class_with_as_is_constructor
-    @identity = :my_plugin
-    @registry.register(@identity, @class, Fabrique::Construction::Default.new)
-  end
-
-  def register_classes_with_default_constructors
-    @identity1 = :plugin1
-    @identity2 = :plugin2
-    @registry.register(@identity1, @class1, Fabrique::Construction::Default.new)
-    @registry.register(@identity2, @class2, Fabrique::Construction::Default.new)
-  end
-
-  def register_object_with_as_is_constructor
-    @identity = :my_plugin
-    @registry.register(@identity, @object, Fabrique::Construction::AsIs.new)
-  end
-
-  def register_class_with_properties_hash_constructor
-    @identity = :my_plugin
-    @registry.register(@identity, @class, Fabrique::Construction::PropertiesHash.new)
-  end
-
-  def register_class_with_positional_argument_constructor
-    @identity = :my_plugin
-    @registry.register(@identity, @class, Fabrique::Construction::PositionalArgument.new(:size, :color, :shape))
-  end
-
-  def register_class_with_keyword_argument_constructor
-    @identity = :my_plugin
-    @registry.register(@identity, @class, Fabrique::Construction::KeywordArgument.new)
-  end
-
-  def register_class_with_builder_method
-    @identity = :my_plugin
-    @registry.register(@identity, @class, Fabrique::Construction::BuilderMethod.new(:build) { |builder, properties|
-      builder.size = properties[:size]
-      builder.color = properties[:color]
-      builder.shape = properties[:shape]
-    })
-  end
-
-  def can_acquire_instances_of_class
-    instance1 = @registry.acquire(@identity)
-    instance2 = @registry.acquire(@identity)
-    expect(instance1.class).to eql @class
-    expect(instance2.class).to eql @class
-    expect(instance1.object_id).to_not eql instance2.object_id
-  end
-
-  def can_acquire_instances_of_classes
-    instance1 = @registry.acquire(@identity1)
-    instance2 = @registry.acquire(@identity2)
-    expect(instance1.class).to eql @class1
-    expect(instance2.class).to eql @class2
-  end
-
-  def can_acquire_same_object_id_every_time
-    instance1 = @registry.acquire(@identity)
-    instance2 = @registry.acquire(@identity)
-    expect(instance1.object_id).to eql @object.object_id
-    expect(instance2.object_id).to eql @object.object_id
-  end
-
-  def can_acquire_instance_of_class_with_properties
-    @instance = @registry.acquire(@identity, size: "large", color: "pink", shape: "cube")
-  end
-
-  def can_verify_instance_properties
-    expect(@instance.color).to eql "pink"
-    expect(@instance.shape).to eql "cube"
-    expect(@instance.size).to eql "large"
-  end
-
-end
-
-require "fabrique"
-
-Before do |scenario|
-  if scenario.tags.any? { |tag| tag.name == "@plugin_registry" }
-    @test = PluginRegistryTestRunner.new( -> {Fabrique::PluginRegistry.new("Test plugin registry")})
-  end
-end
-
-Given(/^I have a plugin registry$/) do
-  @test.have_plugin_registry
-end
-
-Given(/^I have a class with a default constructor$/) do
-  @test.have_class_with_default_constructor
-end
-
-Given(/^I have two classes with default constructors$/) do
-  @test.have_two_classes_with_default_constructors
-end
-
-Given(/^I have an? \w+, i\.e\. (.+)$/) do |code|
-  @test.have_object(eval code)
-end
-
-Given(/^I have a class with a positional argument constructor$/) do
-  @test.have_class_with_positional_argument_constructor
-end
-
-Given(/^I have a class with a properties hash constructor$/) do
-  @test.have_class_with_properties_hash_constructor
-end
-
-Given(/^I have a class with a keyword argument constructor$/) do
-  @test.have_class_with_keyword_argument_constructor
-end
-
-Given(/^I have a class with a builder method$/) do
-  @test.have_class_with_builder_method
-end
-
-When(/^I register the class into the registry with a unique identity and a default construction method$/) do
-  @test.register_class_with_as_is_constructor
-end
-
-When(/^I register each class into the registry with a unique identity and a default construction method$/) do
-  @test.register_classes_with_default_constructors
-end
-
-When(/^I register the \w+ into the registry with a unique identity and an as\-is construction method$/) do
-  @test.register_object_with_as_is_constructor
-end
-
-When(/^I register the class into the registry with a unique identity and a properties hash construction method$/) do
-  @test.register_class_with_properties_hash_constructor
-end
-
-When(/^I register the class into the registry with a unique identity and a positional argument construction method$/) do
-  @test.register_class_with_positional_argument_constructor
-end
-
-When(/^I register the class into the registry with a unique identity and a keyword argument construction method$/) do
-  @test.register_class_with_keyword_argument_constructor
-end
-
-When(/^I register the class into the registry with a unique identity and builder construction method$/) do
-  @test.register_class_with_builder_method
-end
-
-Then(/^I can acquire instances of the class from the registry by its unique identity$/) do
-  @test.can_acquire_instances_of_class
-end
-
-Then(/^I can acquire instances of each class from the registry by its unique identity$/) do
-  @test.can_acquire_instances_of_classes
-end
-
-Then(/^I get the same \w+ every time I acquire the same identity$/) do
-  @test.can_acquire_same_object_id_every_time
-end
-
-Then(/^I can acquire an instance of the class from the registry by its unique identity, specifying properties with a hash argument$/) do
-  @test.can_acquire_instance_of_class_with_properties
-end
-
-Then(/^the instance has the specified properties$/) do
-  @test.can_verify_instance_properties
-end
-

data/lib/fabrique/argument_adaptor/keyword.rb

@@ -1,19 +0,0 @@
-module Fabrique
-
-  module ArgumentAdaptor
-
-    class Keyword
-
-      def adapt(properties = nil)
-        if properties.nil?
-          []
-        else
-          [properties]
-        end
-      end
-
-    end
-
-  end
-
-end

data/lib/fabrique/argument_adaptor/positional.rb

@@ -1,76 +0,0 @@
-module Fabrique
-
-  module ArgumentAdaptor
-
-    # TODO Initialize with the name of the class we're adapting arguments for, for use in error messages
-    class Positional
-
-      def initialize(*argument_specifiers)
-        @positional_arguments = argument_specifiers.map { |spec| PositionalArgument.create(spec) }
-      end
-
-      def adapt(properties = {})
-        @positional_arguments.map { |argument| argument.pick(properties) }
-      end
-
-      class PositionalArgument
-
-        class Required
-          def initialize(arg)
-            @arg = arg
-          end
-
-          def pick(properties)
-            pick_or_do(properties) do
-              raise ArgumentError, "required argument #{@arg} missing from properties"
-            end
-          end
-
-          private
-
-          def pick_or_do(properties, &block)
-            if properties.include?(@arg)
-              properties[@arg]
-            else
-              block.call
-            end
-          end
-        end
-
-        class Optional < Required
-          def pick(properties)
-            pick_or_do(properties) do
-              raise ArgumentError, "optional argument #{@arg} (with no default) missing from properties"
-            end
-          end
-        end
-
-        class Default < Required
-          def initialize(arg, default)
-            @arg, @default = arg, default
-          end
-
-          def pick(properties)
-            pick_or_do(properties) { @default }
-          end
-        end
-
-        def self.create(specifier)
-          if specifier.is_a?(Symbol)
-            Required.new(specifier)
-          elsif specifier.is_a?(Array) and specifier.size == 1 and specifier[0].is_a?(Symbol)
-            Optional.new(*specifier)
-          elsif specifier.is_a?(Array) and specifier.size == 2 and specifier[0].is_a?(Symbol)
-            Default.new(*specifier)
-          else
-            raise ArgumentError.new("invalid argument specifier #{specifier}")
-          end
-        end
-
-      end
-
-    end
-
-  end
-
-end

data/lib/fabrique/construction/as_is.rb

@@ -1,16 +0,0 @@
-module Fabrique
-
-  module Construction
-
-    class AsIs
-
-      def call(type, properties = nil)
-        raise ArgumentError.new("unexpected properties for as-is construction") unless (properties.nil? or properties.empty?)
-        type
-      end
-
-    end
-
-  end
-
-end

data/lib/fabrique/construction/builder_method.rb

@@ -1,21 +0,0 @@
-module Fabrique
-
-  module Construction
-
-    class BuilderMethod
-
-      def initialize(builder_method_name, &block)
-        @builder_method_name, @builder_runner = builder_method_name, block
-      end
-
-      def call(type, properties = {})
-        type.send(@builder_method_name) do |builder|
-          @builder_runner.call(builder, properties)
-        end
-      end
-
-    end
-
-  end
-
-end

data/lib/fabrique/construction/default.rb

@@ -1,17 +0,0 @@
-require_relative "positional_argument"
-
-module Fabrique
-
-  module Construction
-
-    class Default < PositionalArgument
-
-      def initialize
-        super()
-      end
-
-    end
-
-  end
-
-end

data/lib/fabrique/construction/keyword_argument.rb

@@ -1,16 +0,0 @@
-module Fabrique
-
-  module Construction
-
-    # TODO Derive from PropertiesHash
-    class KeywordArgument
-
-      def call(type, properties)
-        type.new(properties)
-      end
-
-    end
-
-  end
-
-end

data/lib/fabrique/construction/positional_argument.rb

@@ -1,40 +0,0 @@
-module Fabrique
-
-  module Construction
-
-    class PositionalArgument
-
-      def initialize(*argument_names)
-        @argument_names = argument_names
-      end
-
-      def call(type, properties = nil)
-        if properties.nil?
-          type.new
-        else
-          type.new(*get_args(properties))
-        end
-      end
-
-      private
-
-        def get_args(properties)
-          @argument_names.inject([]) do |arguments, arg|
-            if arg.is_a?(Array)
-              arg.each do |optional_arg|
-                arguments << properties[optional_arg] if properties.include?(optional_arg)
-              end
-            elsif properties.include?(arg)
-              arguments << properties[arg]
-            else
-              raise ArgumentError, "required argument #{arg} missing from properties"
-            end
-            arguments
-          end
-        end
-
-    end
-
-  end
-
-end

data/lib/fabrique/construction/properties_hash.rb

@@ -1,19 +0,0 @@
-module Fabrique
-
-  module Construction
-
-    class PropertiesHash
-
-      def call(type, properties = nil)
-        if properties.nil?
-          type.new
-        else
-          type.new(properties)
-        end
-      end
-
-    end
-
-  end
-
-end

data/lib/fabrique/constructor/identity.rb

@@ -1,10 +0,0 @@
-module Fabrique
-
-  module Constructor
-
-    class Identity
-    end
-
-  end
-
-end