fabrique 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b961bd9747ba8e903c3dfcbc00dcada62acfdd9f
-  data.tar.gz: 9c101248eb91a7ac3012206b663e7f027624905b
+  metadata.gz: 2e300f8bf753f7c3087c94db1a3a94bd41e4964c
+  data.tar.gz: 9512f2e6bd7d69d8e76f00fa9eb17a63dfd09d9f
 SHA512:
-  metadata.gz: e3a43cad0ac1a58530ee750542d330c7f88515cfb02c0b89e66d580ab98f27ff841b8ae9bd5a44b362df855c2b76c2cf1b449c2af692133add744d07c855f93a
-  data.tar.gz: 2ce1b6c9abeb2d99cad80249a8e13a846951163d3694bdddf3aa458c9b5dfe223b08dabe57d411907f355cba21ac0a36815c67de3247801fc71c85606d0ebdaa
+  metadata.gz: ba6d63d716c3d901a3ef209dce4734707e3084a4213b54457d55712b2bd327375a695eb8b99387b681ab3e2d6d8f3f367a86d8b51be2a839f0711168697354b9
+  data.tar.gz: 9a289a742376878ed8337acae369aa2aaf8e2e0597491c31448c17db25c2c9338096bf0425ee3801edf30dfc30761c4b3c0fdcedeac9e9658d4f5ac68bae33ac

data/Gemfile

@@ -8,6 +8,6 @@ group :development, :test do
 end
 
 group :devtools do
-  gem "guard-cucumber", "~> 1.6"
-  gem "byebug", "~> 6.0"
+  gem "guard-cucumber", "~> 2.1"
+  gem "byebug", "~> 9.0"
 end

data/README.md

@@ -21,7 +21,104 @@ Or install it yourself as:
 
     $ gem install fabrique
 
+## Testing
+
+```shell
+git clone git@github.com/starjuice/fabrique.git
+cd fabrique
+bundle
+bundle exec rake
+```
+
+The test coverage is superficial at the moment. When working with features/bean_factory.feature,
+keep in mind that some exceptions are caught and stored as instance variables to be evlauated by
+subsequent steps. This avoids some English contortions, but the down side is that if you introduce
+a regression that raises an exception in a scenario that doesn't expect one, you won't see the
+exception. To log exceptions, even when they are expected:
+
+```shell
+DEBUG=1 bundle exec rake
+```
+
 ## Usage
 
 Under construction; hard hat required!
 
+The best source of documentation of what's possible in the configuration of Fabrique::BeanFactory is currently
+features/bean\_factory.feature. But reading the step definitions for an example of usage would be awkward, so
+here is a code example.
+
+Given this example YAML application context definition,
+in a file called application\_context.yml:
+
+```yaml
+---
+beans:
+- id: customer_repository
+  class: Acme::Repository::CustomerRepository
+  constructor_args:
+    - !bean/ref store
+    - !bean/ref customer_data_mapper
+- id: product_repository
+  class: Acme::Repository::ProductRepository
+  constructor_args:
+    store: !bean/ref store
+    data_mapper: !bean/ref product_data_mapper
+- id: store
+  class: Acme::Repository::MysqlStore
+  constructor_args:
+    host: localhost
+    port: 3306
+  gem:
+    name: acme-repository-mysql_store
+    version: "~> 1.0"
+    require: "acme/repository/mysql_store"
+- id: customer_data_mapper
+  class: Acme::Repository::MysqlDataMapper::Customer
+  gem:
+    name: acme-repository-mysql_data_mapper
+    require: acme/repository/mysql_data_mapper/customer
+- id: product_data_mapper
+  class: Acme::Repository::MysqlDataMapper::Product
+  gem:
+    name: acme-repository-mysql_data_mapper
+    require: acme/repository/mysql_data_mapper/product
+```
+
+Here is how we could materialize these dependencies:
+
+```ruby
+bean_factory = Fabrique::YamlBeanFactory.new(File.read('application_context.yml'))
+bean_factory.load_gem_dependencies
+
+customer_service = CustomerService.new(repository: bean_factory.get_bean('customer_repository'))
+product_service = ProductService.new(repository: bean_factory.get_bean('product_repository'))
+store_service = StoreService.new(customers: customer_service, products: product_service)
+# ...
+```
+
+Of course, the construction of these services could just as well have been handled by the
+bean factory as well. Where to draw the line is an interesting topic. The example above draws it
+"at dependencies that could be expected to vary per deployment".
+
+Notice that gems were only specified for the parts of the context that could be expected to
+vary per deployment; the gem providing Acme::Repository::CustomerRepository and
+Acme::Repository::ProductRepository would be bundled with the application.
+
+Also notice that the gem loader is activated by an explicit call to load\_gem\_dependencies.
+Runtime installation and activation of gems is controversial, and so it must be requested
+explicitly.
+
+For a data-centric approach to IoC, the entire set of beans can be materialized as a dictionary
+and made available to consumer to cherry-pick what they need without any awareness of the use
+of a BeanFactory:
+
+```ruby
+bean_factory = Fabrique::YamlBeanFactory.new('application_context.yml')
+bean_factory.load_gem_dependencies
+
+# Symbolize keys for use as keyword arguments:
+context = bean_factory.to_h.map { |k, v| [k.intern, v] }.to_h
+
+store_service = StoreService.new(context)
+```

data/fabrique.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 11.0"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "cucumber", "~> 2.0"
 end

data/features/bean_factory.feature

@@ -466,6 +466,38 @@ Feature: 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 with duplicate gem
+
+    Given I have a YAML application context definition:
+      """
+      ---
+      beans:
+      - id: sampler
+        class: Fabrique::DataBean
+        constructor_args:
+        - sample1_version: !bean/property_ref sample1.version
+          sample2_version: !bean/property_ref sample2.version
+      - id: sample1
+        class: Sample
+        gem:
+          name: sample
+          version: "= 0.1.1"
+          require: sample
+        factory_method: itself
+      - id: sample2
+        class: Sample
+        gem:
+          name: sample
+          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 "sampler" bean from the bean factory
+    Then the bean has "sample1_version" set to "0.1.1"
+    And the bean has "sample2_version" set to "0.1.1"
+
   Scenario: Gem loader version conflict
 
     Given I have a YAML application context definition:

data/lib/fabrique/bean_definition_registry.rb

@@ -1,6 +1,7 @@
 require "tsort"
 require_relative "bean_definition"
 require_relative "cyclic_bean_dependency_error"
+require_relative "missing_bean_error"
 
 module Fabrique
 
@@ -12,7 +13,7 @@ module Fabrique
     end
 
     def get_definition(bean_name)
-      @defs.detect { |d| d.id == bean_name }
+      @defs.detect { |d| d.id == bean_name } or raise MissingBeanError.new("missing bean #{bean_name.inspect}")
     end
 
     def get_definitions

data/lib/fabrique/missing_bean_error.rb

@@ -0,0 +1,6 @@
+module Fabrique
+
+  class MissingBeanError < RuntimeError
+  end
+
+end

data/lib/fabrique/version.rb

@@ -1,3 +1,3 @@
 module Fabrique
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/fabrique/bean_factory_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe Fabrique::BeanFactory do
+
+  it "raises a missing bean error when asked for a nonexistent bean" do
+    bean_factory = Fabrique::BeanFactory.new(Fabrique::BeanDefinitionRegistry.new([]))
+    expect {
+      bean_factory.get_bean("nonexistent")
+    }.to raise_error Fabrique::MissingBeanError, /nonexistent/
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fabrique
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Sheldon Hearn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,7 @@ files:
 - lib/fabrique/gem_definition.rb
 - lib/fabrique/gem_dependency_error.rb
 - lib/fabrique/gem_loader.rb
+- lib/fabrique/missing_bean_error.rb
 - lib/fabrique/test.rb
 - lib/fabrique/test/fixtures/constructors.rb
 - lib/fabrique/test/fixtures/modules.rb
@@ -129,6 +130,7 @@ files:
 - lib/fabrique/test/fixtures/repository.rb
 - lib/fabrique/version.rb
 - lib/fabrique/yaml_bean_factory.rb
+- spec/fabrique/bean_factory_spec.rb
 - spec/fabrique/data_bean_spec.rb
 - spec/fabrique/yaml_bean_factory_spec.rb
 - spec/fabrique_spec.rb
@@ -162,7 +164,9 @@ test_files:
 - features/step_definitions/bean_factory_steps.rb
 - features/support/byebug.rb
 - features/support/fabrique.rb
+- spec/fabrique/bean_factory_spec.rb
 - spec/fabrique/data_bean_spec.rb
 - spec/fabrique/yaml_bean_factory_spec.rb
 - spec/fabrique_spec.rb
 - spec/spec_helper.rb
+has_rdoc: