config-factory 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a2b88cc897a3961acfe0506efeae2215de462b8
-  data.tar.gz: 0478ac34202073124995fd797b082bbcfa609551
+  metadata.gz: c44c851822d0e71704e0892c28b76f68cfed5772
+  data.tar.gz: 6b6fc389e2b25d2b3d2344990761ccf768c0fb0a
 SHA512:
-  metadata.gz: ac4f9910a57c0cdb78c9052f773cbef06ca811f881af87418103a2861ad5c9c17db8687f9cba42cdc465cb3092e713443ee039cae30705860e0f487692660d94
-  data.tar.gz: 971e76011a0ff96b3607392261bb88f48e708e0745406c7a28067932e8553bbd354690b396177e46a3040be0aa35837c20c96867d4322491f07305d59676a666
+  metadata.gz: f94eecfabc84b6e17d0e40538dd65dff3b299c0920acc7a5e07964552c2a521bf15e564c2c23efbf31e805d666defc7e128f8cd06981e7cb04c332e4b12de17c
+  data.tar.gz: 517762975319826c5101bf3ba0ed599735d4ab593b3c4a8bd971a3ec36fbf62886287f3b2f4f18db58e68e7eb11a6a5eede8fb9d71f157a1e840bfac7a64ec9c

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.0.9 (9 August 2016)
+
+- Add `AbstractFactory#env_name` and inject the environment name, if available, on construction,
+  in case factories need to know their environments. The default value is `Environments::DEFAULT_ENVIRONMENT`.
+
 ## 0.0.8 (4 April 2016)
 
 - Support looking up implementation classes based on an argument

data/lib/config/factory/abstract_factory.rb

@@ -1,9 +1,16 @@
+require 'config/factory/environments'
+
 module Config
   module Factory
+
     def self.included(base)
       base.extend(AbstractFactory)
     end
 
+    def env_name
+      @env_name ||= Environments::DEFAULT_ENVIRONMENT
+    end
+
     module AbstractFactory
       attr_reader :impl_key
 
@@ -26,7 +33,7 @@ module Config
       def for_environment(env, config_name)
         arg_hash = env.args_for(config_name)
         fail ArgumentError, "no #{self} arguments found for config #{config_name} in environment #{env}" unless arg_hash
-        build_from(arg_hash)
+        build_from(arg_hash, nil, env.name)
       end
 
       def from_file(path, config_name)
@@ -34,12 +41,16 @@ module Config
         for_environment(env, config_name)
       end
 
-      def build_from(arg_hash, section_name = nil)
+      def build_from(arg_hash, section_name = nil, env_name = nil)
         fail ArgumentError, "nil argument hash passed to #{self}.build_from" unless arg_hash
         args = deep_symbolize_keys(arg_hash)
         args = args[section_name] if section_name
         impl_class = find_impl_class(args)
-        impl_class.new(args)
+        begin
+          return create_impl(impl_class, args, env_name)
+        rescue => e
+          raise ArgumentError, "Error instantiating #{impl_class} with arguments #{args}: #{e}"
+        end
       end
 
       private
@@ -54,7 +65,7 @@ module Config
       end
 
       def impl_for_key(key_sym, args)
-        fail ArgumentError, "implementation key #{key_sym} not found in argument hash #{args}" unless args.key?(key_sym)
+        fail ArgumentError, "implementation key #{key_sym} not found in argument hash #{args || 'nil'}" unless args && args.key?(key_sym)
         key_value = args.delete(key_sym)
         impl_class = impls_by_key[key_value]
         fail ArgumentError, "No #{name} implementation found for #{key_sym}: #{key_value}" unless impl_class
@@ -72,6 +83,11 @@ module Config
         @impls_by_key ||= {}
       end
 
+      def create_impl(impl_class, args, env_name)
+        factory_impl = impl_class.new(args)
+        factory_impl.instance_variable_set(:@env_name, env_name)
+        factory_impl
+      end
     end
   end
 end

data/lib/config/factory/environments.rb

@@ -1,5 +1,5 @@
 require 'yaml'
-require_relative 'environment'
+require 'config/factory/environment'
 
 module Config
   module Factory

data/lib/config/factory/module_info.rb

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

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

@@ -15,6 +15,12 @@ module Config
           end
         end
 
+        it 'defaults to Environments::DEFAULT_ENVIRONMENT' do
+          config_hash = { protocol: 'OAI', oai_base_url: 'http://oai.example.org/oai', metadata_prefix: 'some_prefix', set: 'some_set', seconds_granularity: true }
+          impl = SourceConfig.build_from(config_hash)
+          expect(impl.env_name).to eq(Environments::DEFAULT_ENVIRONMENT)
+        end
+
         it 'raises a sensible exception if no impl found for the key' do
           config_hash = { protocol: 'Elvis' }
           expect { SourceConfig.build_from(config_hash) }.to raise_error(ArgumentError, /SourceConfig.*protocol.*Elvis/)
@@ -32,6 +38,7 @@ module Config
           impl = MysqlConfig.build_from(config_hash)
           expect(impl).to be_a(MysqlConfig)
           expect(impl.connection_info).to eq(config_hash)
+          expect(impl.env_name).to eq(Environments::DEFAULT_ENVIRONMENT)
         end
 
         it "can build a class without a declared key, so long as it's registered" do
@@ -46,6 +53,7 @@ module Config
           impl = PersistenceConfig.build_from(config_hash)
           expect(impl).to be_a(DBConfig)
           expect(impl.connection_info).to eq(config_hash)
+          expect(impl.env_name).to eq(Environments::DEFAULT_ENVIRONMENT)
         end
 
         it 'works with section headers' do
@@ -60,29 +68,49 @@ module Config
           impl = PersistenceConfig.build_from(hash, :persistence)
           expect(impl).to be_a(DBConfig)
           expect(impl.connection_info).to eq(expected_info)
+          expect(impl.env_name).to eq(Environments::DEFAULT_ENVIRONMENT)
         end
       end
 
       describe '#for_environment' do
         it 'builds the correct class with the correct config' do
-          config_hash = { protocol: 'OAI', oai_base_url: 'http://oai.example.org/oai', metadata_prefix: 'some_prefix', set: 'some_set', seconds_granularity: true }
           env = instance_double(Environment)
+
+          config_hash = { protocol: 'OAI', oai_base_url: 'http://oai.example.org/oai', metadata_prefix: 'some_prefix', set: 'some_set', seconds_granularity: true }
           expect(env).to receive(:args_for).with(:source) { config_hash }
 
+          env_name = :elvis
+          expect(env).to receive(:name) { env_name }
+
           impl = SourceConfig.for_environment(env, :source)
           expect(impl).to be_an(OAISourceConfig)
           args = { oai_base_url: URI('http://oai.example.org/oai'), metadata_prefix: 'some_prefix', set: 'some_set', seconds_granularity: true }
           args.each do |k, v|
             expect(impl.send(k)).to eq(v)
           end
+          expect(impl.env_name).to eq(env_name)
         end
 
         it 'raises a sensible exception if no impl found for the key' do
           config_hash = { protocol: 'Elvis' }
           env = instance_double(Environment)
           expect(env).to receive(:args_for).with(:source) { config_hash }
+          expect(env).to receive(:name) { 'elvis' }
           expect { SourceConfig.for_environment(env, :source) }.to raise_error(ArgumentError, /SourceConfig.*protocol.*Elvis/)
         end
+
+        it 'raises a sensible exception if initializer fails' do
+          bad_uri = 'I am not a URI'
+          config_hash = {
+            protocol: 'OAI',
+            oai_base_url: bad_uri,
+            metadata_prefix: 'some_prefix'
+          }
+          env = instance_double(Environment)
+          expect(env).to receive(:args_for).with(:source) { config_hash }
+          expect(env).to receive(:name) { 'elvis' }
+          expect { SourceConfig.for_environment(env, :source) }.to raise_error(ArgumentError, /OAISourceConfig.*#{bad_uri}/)
+        end
       end
 
       describe '#from_file' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config-factory
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler