dry-config 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1b2402d421af2bd536b7fa28342000bcdbb71e9
-  data.tar.gz: ad9ec289bc4aa3af5ca980ccd1bfdb046818a689
+  metadata.gz: 930941affd9017b1baf6523ff3f7bdd1446556f5
+  data.tar.gz: fe728b093446b3db3cbb0c4433230572246e4ada
 SHA512:
-  metadata.gz: ae3ba6e99b1661bb39cdcc980031245739f0899fd51ade6cea8cf61e6f60ad91c1ae228f7fb1585a16f3f0d9f203dd7cd3bee6ea6f2fb5cdb1df7be5830b8f80
-  data.tar.gz: 99dfa4d86675714763b8ebc9ad587ebfee8c5b2698e7ae4598e09264ce0cb0a1bd012f29feb6e24506f42f1d2d61b66ec306a36a30f87ffa78b2a1d1fd037260
+  metadata.gz: f5a1875c5fd8705e613b950fc08ac9ef983ba6a5b52d392a23721e332806782978d3fa6fc7d0fbca57f49255caf6c611b04d65694a01af12536a2c771a94c7e7
+  data.tar.gz: edf646def929bb16f294ffef1badeabfbd38c0856f35e1a7e6680214ec6bc11cf2cc4bfb3d13e4378d65a827e1613e8bd2d2db9b528b6976338a97b8e50b2d25

data/README.md

@@ -140,6 +140,19 @@ interpolations:
 ```
       
 ## Options
+
+The default configuration is provided below, override any of these values on construction:
+```ruby
+{
+    env: ENV,                  # default to ENV for interpolation
+    interpolation: true,       # interpolate contents on read with env (above defaults to the current process's ENV)
+    symbolize: true,           # provide symbol based key access for everything i.e. access :development instead of 'development' as a rule
+    unsymbolize_to_yaml: true, # on to_yaml or write_yaml_file unsymbolize keys (several external tools do not do well with symbolized keys i.e. write `development:` instead of `:development:`
+    default_configuration: {}, # seed configuration (file contents overlay this)
+    potential_environments: 
+        [:development, :test, :staging, :production] # used for pruning (optional)
+}
+```
 - Expected environments are `[:development, :test, :staging, :production]`.  Expand or redefine `@potential_environments` these by overriding the `#initialize` or doing so in your optional `#seed_default_configuration`.  This is used in the used in the overlay pruning process to prevent unused branches of configuration from showing up in the resolved configuration.
 - An optional `#seed_default_configuration` allows you to provide a configuration base    
 - `#clear` will restore to the seed configuration, allowing you to `#load!` new settings.

data/lib/dry/config/base.rb

@@ -23,15 +23,17 @@ module Dry
 
       def initialize(options = {})
         @options = {
-            interpolation: true,
-            symbolize: true,
-            default_configuration: {},
-            potential_environments: [:development, :test, :staging, :production]
+            env: ENV,                  # default to ENV for interpolation
+            interpolation: true,       # interpolate string contents on read with given ENV
+            symbolize: true,           # provide symbol based key access for everything
+            unsymbolize_to_yaml: true, # on to_yaml or write_yaml_file unsymbolize keys
+            default_configuration: {}, # seed configuration
+            potential_environments: [:development, :test, :staging, :production] # used for pruning (optional)
         }.merge options
 
         @default_configuration = @options[:default_configuration]
 
-        # used for pruning initial base set.  See #load!
+        # (optional) used for pruning initial base set.  See #resolve_config
         @potential_environments = @options[:potential_environments]
 
         # setup a default configuration
@@ -47,8 +49,8 @@ module Dry
         # raise 'Unspecified environment' if environment.nil?
         raise 'Unspecified filename' if filenames.nil?
 
-        # ensure symbol
-        environment = environment.to_sym unless environment.nil?
+        # ensure symbol if symbolize?
+        environment = environment.to_sym if symbolize? && !environment.nil?
 
         # save these in case we #reload
         @environment = environment
@@ -95,16 +97,17 @@ module Dry
         file = File.open(filename, 'r:bom|utf-8')
         contents = file.read
 
+        env = @options[:env]
         if interpolate?
           # interpolate/substitute/expand ENV variables with the string contents before parsing
           # bash - $VAR
-          contents = contents.gsub(/\$(\w+)/) { ENV[$1] }
+          contents = contents.gsub(/\$(\w+)/) { env[$1] }
           # bash - ${VAR}
-          contents = contents.gsub(/\${(\w+)}/) { ENV[$1] }
-          # bash - ~ is ENV['HOME']
-          contents = contents.gsub(/(~)/) { ENV['HOME'] }
+          contents = contents.gsub(/\${(\w+)}/) { env[$1] }
+          # bash - ~ is env['HOME']
+          contents = contents.gsub(/(~)/) { env['HOME'] }
           # ruby - #{VAR}
-          contents = contents.gsub(/\#{(\w+)}/) { ENV[$1] }
+          contents = contents.gsub(/\#{(\w+)}/) { env[$1] }
         end
         # now parse
         config = Psych.load(contents, filename)
@@ -114,10 +117,19 @@ module Dry
         config
       end
 
+      def to_yaml
+        if unsymbolize_to_yaml?
+          config = @configuration.dup.deep_symbolize(true)
+        else
+          config = @configuration
+        end
+
+        Psych.dump(config)
+      end
 
       def write_yaml_file(filename)
         File.open(filename, 'w') do |file|
-          file.write(Psych.dump(@configuration))
+          file.write(to_yaml)
         end
       end
 
@@ -160,6 +172,10 @@ module Dry
         @options[:symbolize]
       end
 
+      def unsymbolize_to_yaml?
+        @options[:unsymbolize_to_yaml]
+      end
+
       def interpolate?
         @options[:interpolation]
       end

data/lib/dry/config/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Config
-    VERSION = '1.2.2'
+    VERSION = '1.2.3'
   end
 end

data/spec/dry/config/base_spec.rb

@@ -4,8 +4,6 @@ require 'singleton'
 describe Dry::Config::Base do
 
   class AcmeConfig < Dry::Config::Base
-    include Singleton
-
     def initialize(options = {})
       options = {
           # seed the sensible defaults here (overridable)
@@ -22,19 +20,24 @@ describe Dry::Config::Base do
     end
   end
 
-  subject(:acmeConfig) { AcmeConfig.instance }
+  class SingletonAcmeConfig < AcmeConfig
+    include Singleton
+  end
+
+  subject(:acmeConfig) { AcmeConfig.new }
+  before(:each) {
+    acmeConfig.clear
+  }
 
   it 'should work as a singleton' do
-    expect(acmeConfig).to equal(AcmeConfig.instance)
+    expect(SingletonAcmeConfig.instance).to equal(SingletonAcmeConfig.instance)
   end
 
   it 'should not raise error when key is not found' do
-    acmeConfig.clear
     expect(acmeConfig.app).to be_nil
   end
 
   it 'should provide seed configuration' do
-    acmeConfig.clear
     assert_common_seed_settings
     expect(acmeConfig.options.length).to eql 0
 
@@ -45,13 +48,12 @@ describe Dry::Config::Base do
 
   context 'hash delegation' do
     it 'manupulated delegated methods setter/getter/include?' do
-      acmeConfig.clear
       acmeConfig.load!(nil, config_file_path)
       expect(acmeConfig.symbolize?).to be_truthy
 
       acmeConfig['foo'] = 'bar'
-      expect(acmeConfig.configuration['foo']).to be_nil # no symbolization on direct access
-      expect(acmeConfig['foo']).to eq 'bar' # symbolization based on options
+      expect(acmeConfig.configuration['foo']).to be_nil # no symbolization manipulation to key on direct access to underlying hash
+      expect(acmeConfig['foo']).to eq 'bar' # symbolization manipulation of key based on options
 
       expect(acmeConfig.configuration[:foo]).to eq 'bar' # setter symbolizes, this works
       expect(acmeConfig[:foo]).to eq 'bar'
@@ -61,7 +63,7 @@ describe Dry::Config::Base do
     end
 
     it 'direct delegation' do
-      acmeConfig.clear
+      
       acmeConfig.load!(nil, config_file_path)
       expect(acmeConfig.symbolize?).to be_truthy
 
@@ -76,10 +78,41 @@ describe Dry::Config::Base do
     end
   end
 
+  context 'unsymbolize_to_yaml' do
+    it 'defaults to unsymbolized' do
+      acmeConfig.load!(nil, config_file_path)
+      expect(acmeConfig.symbolize?).to be_truthy
+      expect(acmeConfig.unsymbolize_to_yaml?).to be_truthy
+
+      yaml = acmeConfig.to_yaml
+      # puts yaml
+      expect(yaml =~ /\:app\:/).to be_falsey
+      expect(yaml =~ /app\:/).to be_truthy
+
+      expect(yaml =~ /\:strategy\:/).to be_falsey
+      expect(yaml =~ /strategy\:/).to be_truthy
+    end
+
+    context 'symbolize: false' do
+      subject(:acmeConfig) { AcmeConfig.new(unsymbolize_to_yaml:false) }
+
+      it 'should leave keys symbolized' do
+        acmeConfig.load!(nil, config_file_path)
+        expect(acmeConfig.symbolize?).to be_truthy
+        expect(acmeConfig.unsymbolize_to_yaml?).to be_falsey
+
+        yaml = acmeConfig.to_yaml
+        # puts yaml
+        expect(yaml =~ /\:app\:/).to be_truthy
+        expect(yaml =~ /\:strategy\:/).to be_truthy
+      end
+    end
+  end
+
   context 'when loading a single configuration file' do
 
     it 'should read file with nil environment' do
-      acmeConfig.clear
+      
       acmeConfig.load!(nil, config_file_path)
 
       assert_common_seed_settings
@@ -94,7 +127,7 @@ describe Dry::Config::Base do
     end
 
     it 'should override with development environment' do
-      acmeConfig.clear
+      
       acmeConfig.load!(:development, config_file_path)
 
       # assert_common_seed_settings
@@ -111,7 +144,7 @@ describe Dry::Config::Base do
     end
 
     it 'should override with production environment' do
-      acmeConfig.clear
+      
       acmeConfig.load!(:production, config_file_path)
 
       # assert_common_seed_settings

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-config
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Kevin Ross