fabrique 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3796e9e745800e240d127f0672f1c8d22ab40745
-  data.tar.gz: 8a4ce3af7cfd0a4be962e95df662d15d2b2b15d2
+  metadata.gz: b961bd9747ba8e903c3dfcbc00dcada62acfdd9f
+  data.tar.gz: 9c101248eb91a7ac3012206b663e7f027624905b
 SHA512:
-  metadata.gz: 04869a6c8850d01a46188df165ca99f04004943cd902c19e21fc97f53248f4248462435e7b74e4f0c6d66aca8f7fcbe530cddabfdf324578006bac48e60335e7
-  data.tar.gz: af63e7a6b236ba0bbb0cd3216604d2059072dedafe9f675eb342e16bead68fc2942a3369061edfa04666ae3a85d0769874d85cfda41cd5499a2e3d9c36e69868
+  metadata.gz: e3a43cad0ac1a58530ee750542d330c7f88515cfb02c0b89e66d580ab98f27ff841b8ae9bd5a44b362df855c2b76c2cf1b449c2af692133add744d07c855f93a
+  data.tar.gz: 2ce1b6c9abeb2d99cad80249a8e13a846951163d3694bdddf3aa458c9b5dfe223b08dabe57d411907f355cba21ac0a36815c67de3247801fc71c85606d0ebdaa

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.0.0
   - 2.1.5
-  - 2.2.1
+  - 2.2.3
+  - 2.3.0
 bundler_args: --without devtools

data/Gemfile

@@ -3,6 +3,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in fabrique.gemspec
 gemspec
 
+group :development, :test do
+  gem "local_only", "~> 0.1.0", path: "fixtures/local_only"
+end
+
 group :devtools do
   gem "guard-cucumber", "~> 1.6"
   gem "byebug", "~> 6.0"

data/README.md

@@ -2,7 +2,8 @@
 
 # Fabrique
 
-Factory support library for adapting existing modules for injection as dependencies.
+Configuration-based factory for dependency injection.
+Inspired by Java [spring beans](http://docs.spring.io/spring/docs/current/spring-framework-reference/html/beans.html).
 
 ## Installation
 
@@ -24,157 +25,3 @@ Or install it yourself as:
 
 Under construction; hard hat required!
 
-## Puzzling
-
-However plugin factories are composed, the process of constructing a plugin
-will be:
-
-```ruby
-Properties -> PropertyValidator -> ArgumentAdaptor -> Constructor => plugin`
-```
-
-A global function that takes the plugin registration as the composite would
-then look like this:
-
-```ruby
-def fabricate(registry, plugin_identity, properties)
-  registration = registry.find(plugin_identity)
-  property_validator = registration.property_validator
-  argument_adaptor = registration.argument_adaptor
-  constructor = registration.constructor
-  plugin_template = registration.template # Currently called the type
-
-  if property_validator.valid?(properties)
-    arguments = argument_adaptor.adapt(properties)
-    plugin = constructor.construct(plugin_template, arguments)
-    return plugin
-  else
-    raise
-  end
-end
-```
-
-So we might compose thus:
-
-```ruby
-# API gem does this
-class Store
-  def initialize(provider)
-    @provider = provider
-  end
-  # API definition
-end
-StoreApiFactory = Fabrique::FactoryAdaptor.new(
-  template: Store,
-  constructor: Constructor::Classical.new,
-  argument_adaptor: ArgumentAdaptor::Positional.new(:provider)
-)
-StoreProviderFactoryRegistry = Fabrique::Registry.new("Store API Provider Registry")
-
-# Provider gem does this
-require "store_api"
-class S3StoreProvider
-  # API implementation here
-end
-S3StoreProviderFactory = Fabrique::FactoryAdaptor.new(
-  template: S3StoreProvider,
-  constructor: Constructor::Classical.new,
-  argument_adaptor: ArgumentAdaptor::Keyword.new,
-)
-StoreProviderFactoryRegistry.register(:s3, S3StoreProviderFactory)
-
-# API consumer does this
-Bundler.require(:default)
-provider_factory = StoreProviderFactoryRegistry.find(:s3)
-provider = provider_factory.create(region: "eu-west-1", bucket: "fabrique")
-api = StoreApiFactory.create(provider: provider)
-
-# Now, if the API consumer and the API developer agree that this is too high ceremony...
-
-# API gem adds this
-class StoreFactory
-  def self.create(provider_id: DEFAULT_PROVIDER, provider_properties: DEFAULT_PROVIDER_PROPERTIES)
-    provider_factory = StoreProviderFactoryRegistry.find(provider_id)
-    provider = provider_factory.create(provider_properties)
-    StoreApiFactory.create(provider: provider)
-  end
-end
-
-# and API consumer just does this
-Bundler.require(:default)
-api = StoreFactory.create(provider_id: :s3, provider_properties: {region: "eu-west-1", bucket: "fabrique"})
-```
-
-Fabrique might be able to offer an easy way to build the low ceremony "provider
-API factory". Let's wait and see if high ceremony is really a problem for people.
-
-### Constructors
-
-What kinds of construction process do we care about?
-
-#### Identity
-
-* Makes no sense to use an ArgumentAdaptor (or, by implication, a
-  PropertyValidator).
-
-So this is a good pressure to compose everything except Properties
-into the Constructor, registered by plugin\_identity.
-
-#### Classical
-
-* Keywords
-* Positional
-* Builder?
-
-If we say you can mix Classical constructor with Builder ArgumentAdaptor,
-then the constructor must call a default constructor only (::new()), passing
-in a block.
-
-#### Builder
-
-If we say Builder is a constructor, then it can pass adapted arguments *and*
-a block to the adapted constructor.
-
-So, does the world really have constructors that take arguments *and* a
-builder block?
-
-#### Lambda?
-
-This could be used to allow *any* adaptation conceivably supported by the
-interface of the provider type.
-
-So, are there adaptations we might want that wouldn't be supported by
-Identity, Classical and Builder? Yes, surely. But are they *factory*
-adaptations? Well...
-
-```ruby
-class BadlyDesigned
-  def initialize(first_name, last_name)
-    @first_name, @last_name = first_name, last_name
-  end
-
-  def set_title(title)
-    @title = title
-  end
-
-  def address
-    "#{@name} #{@first_name} #{@last_name}"
-  end
-end
-
-lambda_constructor = ->(type, properties) do
-  type.new(properties).tap { |o| o.set_title(properties[:title]) if properties.include?(:title) }
-end
-```
-
-But are we in the business of adapting badly designed software for use in
-plugin factories? Should the scope perhaps be to adapt well designed software
-for use in plugin factories?
-
-## Contributing
-
-1. Fork it ( https://github.com/starjuice/fabrique/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/fabrique.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |spec|
   spec.version       = Fabrique::VERSION
   spec.authors       = ["Sheldon Hearn"]
   spec.email         = ["sheldonh@starjuice.net"]
-  spec.summary       = %q{Factory support library}
-  spec.description   = %q{Factory support library for adapting existing modules for injection as dependencies}
+  spec.summary       = %q{Configuration-based factory for dependency injection}
+  spec.description   = %q{Configuration-based factory for dependency injection}
   spec.homepage      = "https://github.com/starjuice/fabrique"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.0"
+  spec.required_ruby_version = ">= 2.1"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/features/bean_factory.feature

@@ -79,6 +79,24 @@ Feature: Bean Factory
     And the bean has "color" set to "purple"
     And the bean has "shape" set to "elephant"
 
+  Scenario: Factory method with bean reference as class
+
+    Given I have a YAML application context definition:
+      """
+      ---
+      beans:
+      - id: factory
+        class: Fabrique::Test::Fixtures::Constructors::FactoryWithCreateMethod
+      - id: created_object
+        class: !bean/ref factory
+        factory_method: create
+      """
+    When I request a bean factory for the application context
+    And I request the "created_object" bean from the bean factory
+    Then the bean has "size" set to "factory size"
+    And the bean has "color" set to "factory color"
+    And the bean has "shape" set to "factory shape"
+
   Scenario: Module by identity
 
     Given I have a YAML application context definition:
@@ -142,7 +160,8 @@ Feature: Bean Factory
         properties:
           shape: !bean/ref left
       """
-    Then I get a cyclic bean dependency error when I request a bean factory for the application context
+    When I request a bean factory for the application context
+    Then I get a cyclic bean dependency error
 
   Scenario: Cyclic bean constructor arg reference
 
@@ -163,7 +182,8 @@ Feature: Bean Factory
           - purple
           - elephant
       """
-    Then I get a cyclic bean dependency error when I request a bean factory for the application context
+    When I request a bean factory for the application context
+    Then I get a cyclic bean dependency error
 
   Scenario: Cyclic bean property reference with non-cyclic constructor arg reference
 
@@ -184,7 +204,25 @@ Feature: Bean Factory
         properties:
           shape: !bean/ref left
       """
-    Then I get a cyclic bean dependency error when I request a bean factory for the application context
+    When I request a bean factory for the application context
+    Then I get a cyclic bean dependency error
+
+  Scenario: Cyclic bean class reference
+
+    Given I have a YAML application context definition:
+      """
+      ---
+      beans:
+      - id: factory
+        class: Fabrique::Test::Fixtures::Constructors::FactoryWithCreateMethod
+        constructor_args:
+          - !bean/ref created_object
+      - id: created_object
+        class: !bean/ref factory
+        factory_method: create
+      """
+    When I request a bean factory for the application context
+    Then I get a cyclic bean dependency error
 
   Scenario: Nested bean references
 
@@ -255,6 +293,35 @@ Feature: Bean Factory
     And the bean has "color" set to "purple"
     And the bean has "shape" set to "elephant"
 
+  Scenario: Nested bean property reference
+
+    Given I have a YAML application context definition:
+      """
+      ---
+      beans:
+      - id: left
+        class: Fabrique::Test::Fixtures::Constructors::ClassWithPositionalArgumentConstructor
+        constructor_args:
+          - !bean/property_ref middle.object.size
+          - !bean/property_ref middle.object.color
+          - !bean/property_ref middle.object.shape
+      - id: middle
+        class: Fabrique::Test::Fixtures::Constructors::ClassWithProperties
+        properties:
+          object: !bean/ref right
+      - id: right
+        class: Fabrique::Test::Fixtures::Constructors::ClassWithPositionalArgumentConstructor
+        constructor_args:
+          - tiny
+          - purple
+          - elephant
+      """
+    When I request a bean factory for the application context
+    And I request the "left" bean from the bean factory
+    Then the bean has "size" set to "tiny"
+    And the bean has "color" set to "purple"
+    And the bean has "shape" set to "elephant"
+
   Scenario: Singleton bean (default)
 
     Given I have a YAML application context definition:
@@ -340,3 +407,127 @@ Feature: Bean Factory
     And the bean has "color" set to "invisible"
     And the bean has "shape" that is the Integer "42"
 
+  Scenario: Data bean
+
+    Given I have a YAML application context definition:
+      """
+      ---
+      beans:
+      - id: data
+        class: Fabrique::DataBean
+        constructor_args:
+        - size: small
+          color: red
+          shape: dot
+      """
+    When I request a bean factory for the application context
+    And I request the "data" bean from the bean factory
+    Then the bean has "size" set to "small"
+    And the bean has "color" set to "red"
+    And the bean has "shape" set to "dot"
+
+  Scenario: Gem loader
+
+    Given I have a YAML application context definition:
+      """
+      ---
+      beans:
+      - id: sample
+        class: Sample
+        gem:
+          name: sample
+          version: "= 0.1.1"
+          require: sample
+        factory_method: itself
+      """
+    And the "sample" gem is not installed
+    When I request a bean factory for the application context
+    And I request that bean dependency gems be loaded for the bean factory
+    And I request the "sample" bean from the bean factory
+    Then the bean has "version" set to "0.1.1"
+
+  Scenario: Gem loader with already-installed gem
+
+    Given I have a YAML application context definition:
+      """
+      ---
+      beans:
+      - id: local_only
+        class: LocalOnly
+        gem:
+          name: local_only
+          version: "= 0.1.0"
+          require: local_only
+        factory_method: itself
+      """
+    And the "local_only" gem is already installed
+    When I request a bean factory for the application context
+    And I request that bean dependency gems be loaded for the bean factory
+    And I request the "local_only" bean from the bean factory
+    Then the bean has "version" set to "0.1.0"
+
+  Scenario: Gem loader version conflict
+
+    Given I have a YAML application context definition:
+      """
+      ---
+      beans:
+      - id: sample
+        class: Sample
+        gem:
+          name: sample
+          version: "= 0.1.1"
+          require: sample
+        factory_method: itself
+      - id: conflicting_sample
+        class: Sample
+        gem:
+          name: sample
+          version: "= 0.1.0"
+          require: sample
+        factory_method: itself
+      """
+    And the "sample" gem is not installed
+    When I request a bean factory for the application context
+    And I request that bean dependency gems be loaded for the bean factory
+    Then I get a gem dependency error
+
+  Scenario: Gem loader install error
+
+    Given I have a YAML application context definition:
+      """
+      ---
+      beans:
+      - id: sample
+        class: Sample
+        gem:
+          name: nosuchgeminstallable
+        factory_method: itself
+      """
+    And the "sample" gem is not installed
+    When I request a bean factory for the application context
+    And I request that bean dependency gems be loaded for the bean factory
+    Then I get a gem dependency error
+
+  Scenario: #to_h
+
+    Given I have a YAML application context definition:
+      """
+      ---
+      beans: !beans
+      - !bean
+        id: square_bean
+        class: Fabrique::Test::Fixtures::Constructors::ClassWithKeywordArgumentConstructor
+        constructor_args:
+          shape: square
+      - !bean
+        id: round_bean
+        class: Fabrique::Test::Fixtures::Constructors::ClassWithKeywordArgumentConstructor
+        constructor_args:
+          shape: round
+      """
+    When I request a bean factory for the application context
+    And I request a dictionary of all beans
+    Then the dictionary maps "square_bean" to the "square_bean" bean
+    And the dictionary maps "round_bean" to the "round_bean" bean
+

data/features/step_definitions/bean_factory_steps.rb

@@ -13,7 +13,12 @@ Given(/^I have a YAML application context definition:$/) do |string|
 end
 
 When(/^I request a bean factory for the application context$/) do
-  @bean_factory = Fabrique::YamlBeanFactory.new(@tmpfile.path)
+  begin
+    @bean_factory = Fabrique::YamlBeanFactory.new(@tmpfile.path)
+  rescue Exception => e
+    $stderr.puts "DEBUG @bean_factory_request_exception -> #{e.inspect}\n\t#{e.backtrace.join("\n\t")}" if ENV["DEBUG"]
+    @bean_factory_request_exception = e
+  end
 end
 
 When(/^I request the "(.*?)" bean from the bean factory$/) do |bean_name|
@@ -58,8 +63,8 @@ Then(/^I get a different object when I request the "(.*?)" bean again$/) do |bea
   expect(new_reference.object_id).to_not eql @bean.object_id
 end
 
-Then(/^I get a cyclic bean dependency error when I request a bean factory for the application context$/) do
-  expect { Fabrique::YamlBeanFactory.new(@tmpfile.path) }.to raise_error(Fabrique::CyclicBeanDependencyError, /cyclic bean dependency error/)
+Then(/^I get a cyclic bean dependency error$/) do
+  expect(@bean_factory_request_exception).to be_a Fabrique::CyclicBeanDependencyError
 end
 
 Then(/^the "(.*?)" and "(.*?)" beans share the same "(.*?)"$/) do |bean1_name, bean2_name, shared_property|
@@ -74,3 +79,36 @@ Then(/^the "(.*?)" and "(.*?)" beans each have their own "(.*?)"$/) do |bean1_na
   expect(bean1.send(own_property).object_id).to_not eql bean2.send(own_property).object_id
 end
 
+Given(/^the "(.*?)" gem is not installed$/) do |gem|
+  require "rubygems/uninstaller"
+  dep = Gem::Dependency.new(gem, Gem::Requirement.default)
+  specs = dep.matching_specs
+  specs.each do |spec|
+    Gem::Uninstaller.new(spec).uninstall
+  end
+end
+
+Given(/^the "([^"]*)" gem is already installed$/) do |arg1|
+  %x{ gem install --no-ri --no-rdoc fixtures/local_only-0.1.0.gem }
+end
+
+When(/^I request that bean dependency gems be loaded for the bean factory$/) do
+  begin
+    @bean_factory.load_gem_dependencies
+  rescue Exception => e
+    $stderr.puts "DEBUG @bean_factory_load_gem_dependencies_exception -> #{e.inspect}\n\t#{e.backtrace.join("\n\t")}" if ENV["DEBUG"]
+    @bean_factory_load_gem_dependencies_exception = e
+  end
+end
+
+Then(/^I get a gem dependency error$/) do
+  expect(@bean_factory_load_gem_dependencies_exception).to be_a Fabrique::GemDependencyError
+end
+
+When(/^I request a dictionary of all beans$/) do
+  @dictionary = @bean_factory.to_h
+end
+
+Then(/^the dictionary maps "([^"]*)" to the "([^"]*)" bean$/) do |dictionary_key, bean_name|
+  expect(@dictionary[dictionary_key]).to eql @bean_factory.get_bean(bean_name)
+end

data/features/support/fabrique.rb

@@ -0,0 +1 @@
+require "fabrique"

data/fixtures/local_only/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/fixtures/local_only/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in local_only.gemspec
+gemspec

data/fixtures/local_only/README.md

@@ -0,0 +1,36 @@
+# LocalOnly
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/local_only`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'local_only'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install local_only
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/local_only.
+

data/fixtures/local_only/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/fixtures/local_only/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "local_only"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/fixtures/local_only/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fixtures/local_only/lib/local_only/version.rb

@@ -0,0 +1,3 @@
+module LocalOnly
+  VERSION = "0.1.0"
+end

data/fixtures/local_only/lib/local_only.rb

@@ -0,0 +1,7 @@
+require "local_only/version"
+
+module LocalOnly
+  def self.version
+    LocalOnly::VERSION
+  end
+end

data/fixtures/local_only/local_only.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'local_only/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "local_only"
+  spec.version       = LocalOnly::VERSION
+  spec.authors       = ["Sheldon Hearn"]
+  spec.email         = ["sheldonh@starjuice.net"]
+
+  spec.summary       = %q{Sample gem that is not avialable from rubygems.org}
+  spec.description   = %q{Sample gem that is not avilable from rubygems.org, for testing software that uses gems}
+  spec.homepage      = "https://github.com/starjuice/fabrique.git"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "http://localhost"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/fixtures/sample/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/fixtures/sample/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sample.gemspec
+gemspec