config-factory 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85d51fce96572d3dba52936c624787dfc7318cbc
-  data.tar.gz: ee7cdc6973f8918992858021eabde2d92d272f2d
+  metadata.gz: a1f210944b382bc0260157f164e45025db904802
+  data.tar.gz: 9d0d655fbb1a219b3bb22ce320b2fd0480dde335
 SHA512:
-  metadata.gz: 74c6acb13ffe5a9892e6430b91452ca3819b149cd8d3bacb62159d2fd60ad1ea872c1043918b753279433a4e444c8d08a27c082111d2bd2963af7d4f2e8306d2
-  data.tar.gz: e7d2d643473f1de988680e736f8bbfae5e78df564259d6550d17e9409de7d5c75237e2d6d44aeae2b02858885ad6bfdd9abc71be99e631ce327c32a19e6ca3f2
+  metadata.gz: 2bd33c114f0cbcb09f70f8aacf9b9ffff28757a20a5d8039e0888d0f8575887d9d2c282c34d703fa39d77aa786c9d01b5a76d623004ce55cf2588231f0364f94
+  data.tar.gz: 7526b42e798652f771d0c094ee574ecab591811bfadd26b5446d333fcd5e62f7e22107cb50c672270ba754a590954d65fe20a9340703cb3f6ebb380359064c76

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.0.7 (31 March 2016)
+
+- Support direct instantiation of concrete config classes without
+  product keys
+
 ## 0.0.6 (16 March 2016)
 
 - Better error messages for missing keys, configs, etc.

data/README.md

@@ -11,6 +11,16 @@ pattern, with run-time configuration provided by hashes or YAML files.
 
 ## Example
 
+The abstract configuration factory declares a `key`, which is used to look up the concrete
+config class for a given configuration. Concrete implementations register themselves with a
+DSL method named after the `key` value.
+
+In the example below, the `SourceConfig` abstract factory declares the key `:protocol`; the
+concrete classes `OAISourceConfig` and `ResyncSourceConfig` register themselves with
+`protocol: 'OAI'` and `protocol: 'Resync'`, respectively. `SourceConfig.for_environment()`
+will then look for a `protocol:` line in the configuration file to determine which
+registered concrete class to instantiate.
+
 ```ruby
 class SourceConfig
   include Config::Factory
@@ -83,3 +93,38 @@ test_env = environments[:test]
 source_config = SourceConfig.for_environment(test_env, :source)
 # => #<ResyncSourceConfig:0x007fe8d48180c0 @capability_list_url="http://localhost:8888/capabilitylist.xml"> 
 ```
+
+## Config classes with only one implementation
+
+`config-factory` also supports instantiating concrete configuration classes directly.
+In this case, we simply don't declare a `key` for the class, and the configuration hash
+will be passed directly to the initializer of the concrete class.
+
+```ruby
+class DBConfig
+  include Config::Factory
+
+  def initialize(connection_info)
+    @connection_info = connection_info
+  end
+end
+```
+
+```YAML
+test:
+  db:
+    adapter: sqlite3
+    database: ':memory:'
+    pool: 5
+    timeout: 5000
+
+production:
+  db:
+    adapter: mysql2
+    host: mydb.example.org
+    database: myapp
+    username: myuser
+    password: blank
+    port: 3306
+    encoding: utf8
+```

data/lib/config/factory/abstract_factory.rb

@@ -29,15 +29,21 @@ module Config
       def build_from(arg_hash)
         fail ArgumentError, "nil argument hash passed to #{self}.build_from" unless arg_hash
         args = deep_symbolize_keys(arg_hash)
+        product_class = find_product_class(args)
+        product_class.new(args)
+      end
+
+      private
+
+      def find_product_class(args)
+        return self unless product_key
         fail ArgumentError, "product key #{product_key} not found in argument hash #{args}" unless args.key?(product_key)
         key_value = args.delete(product_key)
         product_class = products[key_value]
         fail ArgumentError, "No #{name} product class found for #{product_key}: #{key_value}" unless product_class
-        product_class.new(args)
+        product_class
       end
 
-      private
-
       def deep_symbolize_keys(val)
         return val unless val.is_a?(Hash)
         val.map do |k, v|

data/lib/config/factory/environment.rb

@@ -3,6 +3,7 @@ module Config
     class Environment
 
       attr_reader :name
+      attr_reader :configs
 
       def initialize(name:, configs:)
         self.name = name

data/lib/config/factory/module_info.rb

@@ -4,7 +4,7 @@ module Config
     NAME = 'config-factory'
 
     # The version of this gem
-    VERSION = '0.0.6'
+    VERSION = '0.0.7'
 
     # The copyright notice for this gem
     COPYRIGHT = 'Copyright (c) 2016 The Regents of the University of California'

data/spec/data/db-config.yml

@@ -0,0 +1,18 @@
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000
+
+test: &test
+  adapter: sqlite3
+#  database: db/test.sqlite3
+  database: ':memory:'
+  pool: 5
+  timeout: 5000

data/spec/unit/config/factory/abstract_factory_spec.rb

@@ -19,6 +19,20 @@ module Config
           config_hash = { protocol: 'Elvis' }
           expect { SourceConfig.build_from(config_hash) }.to raise_error(ArgumentError, /SourceConfig.*protocol.*Elvis/)
         end
+
+        it 'supports concrete factories without product keys' do
+          config_hash = {
+            adapter: 'mysql2',
+            encoding: 'utf8',
+            pool: 5,
+            database: 'example_pord',
+            host: 'mysql-dev.example.org',
+            port: 3306
+          }
+          product = DBConfig.build_from(config_hash)
+          expect(product).to be_a(DBConfig)
+          expect(product.connection_info).to eq(config_hash)
+        end
       end
 
       describe '#for_environment' do

data/spec/unit/config/factory/environment_spec.rb

@@ -28,6 +28,15 @@ module Config
         it 'requires configs to be hash-like' do
           expect { Environment.new(name: :name, configs: false) }.to raise_error(ArgumentError)
         end
+        it 'reads a standard ActiveRecord db config' do
+          yaml_hash = {
+            'adapter' => 'sqlite3',
+            'database' => 'db/development.sqlite3',
+            'pool' => 5,
+            'timeout' => 5000
+          }
+          Environment.new(name: :test, configs: yaml_hash)
+        end
       end
 
       describe '#load_file' do
@@ -57,8 +66,7 @@ module Config
 
         it 'includes the hash' do
           h = {
-            'db' =>
-            {
+            'db' => {
               'adapter' => 'mysql2',
               'encoding' => 'utf8',
               'pool' => 5,

data/spec/unit/config/factory/environments_spec.rb

@@ -7,8 +7,21 @@ module Config
         it 'loads a multi-environment config file' do
           envs = Environments.load_file('spec/data/multiple-environments.yml')
           expect(envs).to be_a(Hash)
-          expect(envs.size).to eq(4)
-          [:defaults, :development, :test, :production].each do |env_name|
+          expected = [:defaults, :development, :test, :production]
+          expect(envs.size).to eq(expected.size)
+          expected.each do |env_name|
+            env = envs[env_name]
+            expect(env).to be_an(Environment)
+            expect(env.name).to eq(env_name)
+          end
+        end
+
+        it 'reads a standard ActiveRecord DB config' do
+          envs = Environments.load_file('spec/data/db-config.yml')
+          expect(envs).to be_a(Hash)
+          expected = [:development, :test, :production]
+          expect(envs.size).to eq(expected.size)
+          expected.each do |env_name|
             env = envs[env_name]
             expect(env).to be_an(Environment)
             expect(env.name).to eq(env_name)

data/spec/unit/config/factory/fixtures.rb

@@ -41,6 +41,16 @@ class ResyncSourceConfig < SourceConfig
   end
 end
 
+class DBConfig
+  include Config::Factory
+
+  attr_reader :connection_info
+
+  def initialize(connection_info)
+    @connection_info = connection_info
+  end
+end
+
 # IndexConfig
 
 class IndexConfig

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config-factory
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,6 +120,7 @@ files:
 - lib/config/factory/log.rb
 - lib/config/factory/module_info.rb
 - spec/.rubocop.yml
+- spec/data/db-config.yml
 - spec/data/multiple-environments.yml
 - spec/data/single-environment.yml
 - spec/spec_helper.rb
@@ -154,6 +155,7 @@ specification_version: 4
 summary: A gem for creating configuration classes using the Abstract Factory pattern.
 test_files:
 - spec/.rubocop.yml
+- spec/data/db-config.yml
 - spec/data/multiple-environments.yml
 - spec/data/single-environment.yml
 - spec/spec_helper.rb