dry-config 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98683afd3015ee5ff47cf5b9f01467dd7c63f7b6
-  data.tar.gz: 4ce00ecb1bfe04cef403638b91212fbd368f98b1
+  metadata.gz: 2e5ef4a6ae7ca95ba67b4727fe8137765874464f
+  data.tar.gz: 90bf572de240fd4250dd88353fed2be01b4b6bde
 SHA512:
-  metadata.gz: 3b70a9e1af3df65faf2b9835a7fcb7cd096c2077a575dc05721c293eb3012b115cd9a52a0ae7040a8634c52d3478e797ed56835987e0af28a54cf68af800919a
-  data.tar.gz: 0677f1074dbff533cb8d419ff434ff9e51aec379d4c3f14cde2b37c1ba4cc6c82f000becfe6ccec37dc4e9a73a5ae3ee900f288c2dd863c0c724f9e36f9e137f
+  metadata.gz: db019775409ec7a2f0aa72a47f903c8dbe25d40a4f77b6af9af3b466c701ba73c2bb642c1eabfe96a9daf8be55061a7d4298eac7998de1c96591ae0d5570cbca
+  data.tar.gz: 44db43c679ec43e5187f773fe90cbad3e76baeb0c4809d9737268894125bd1255fe284fd41ecf09d0ce3dcd105a6e10adef7cb822b6de728381fe35c7d4167ea

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+test-reports

data/.rspec

@@ -1,2 +1,2 @@
 --color
---require spec_helper
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+dry_config

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/README.md

@@ -111,6 +111,22 @@ config.options[:'aws:autoscaling:launchconfiguration'][:InstanceType] # t1.large
 - 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.
 
+## ENV Interpolation/substitution/expansion
+
+ENV variable substitution is supported and enabled by default.  It may be disabled by initializing with `{interpolation: false}`. 
+
+The following formats are acceptable:
+
+```yaml
+interpolations:
+  - ~/foo
+  - $HOME/foo
+  - ${HOME}/foo
+  - #{HOME}/foo
+  # mixed example
+  - ~/docker/mysql/${PROJECT_NAME}-${BUILD}:/var/lib/mysql:rw
+```
+
 ## White Label sample
 
 ```ruby

data/dry-config.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '>= 2.14.1'
+  s.add_development_dependency 'rspec'
 
 end

data/lib/dry/config/base.rb

@@ -17,7 +17,9 @@ module Dry
       attr_reader :environment
       attr_reader :filenames
 
-      def initialize(*args)
+      def initialize(options = {})
+        @options = {interpolation: true}.merge options
+
         seed_default_configuration
 
         # used for pruning initial base set.  See #load!
@@ -80,11 +82,38 @@ module Dry
       end
 
       def load_yaml_file(filename)
-        config = YAML::load_file(filename)
+
+        # without interpolation
+        # config = Psych.load_file(filename)
+
+        # get file contents as string
+        file = File.open(filename, 'r:bom|utf-8')
+        contents = file.read
+
+        if @options[:interpolation]
+          # interpolate/substitute/expand ENV variables with the string contents before parsing
+          # bash - $VAR
+          contents = contents.gsub(/\$(\w+)/) { ENV[$1] }
+          # bash - ${VAR}
+          contents = contents.gsub(/\${(\w+)}/) { ENV[$1] }
+          # bash - ~ is ENV['HOME']
+          contents = contents.gsub(/(~)/) { ENV['HOME'] }
+          # ruby - #{VAR}
+          contents = contents.gsub(/\#{(\w+)}/) { ENV[$1] }
+        end
+        # now parse
+        config = Psych.load(contents, filename)
+
         raise "Failed to load #{filename}" if config.nil?
         config.deep_symbolize
       end
 
+      def write_yaml_file(filename)
+        File.open(filename, 'w') do |file|
+          file.write(Psych.dump(@configuration))
+        end
+      end
+
       def reload!
         clear
         load! @environment, @filenames

data/lib/dry/config/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Config
-    VERSION = '1.1.3'
+    VERSION = '1.1.4'
   end
 end

data/spec/dry/config/docker-compose-template-simple.yml

@@ -0,0 +1,22 @@
+# https://docs.docker.com/v1.6/compose/cli/#environment-variables
+web:
+  build: .
+  command: bin/rails server --port 3000 --binding 0.0.0.0
+  ports:
+    - "3000:3000"
+  links:
+    - db
+  volumes:
+    - .:/myapp
+db:
+  # https://github.com/docker-library/docs/tree/master/mysql
+  image: library/mysql:5.7.6
+  ports:
+    - "3306:3306"
+    #  volumes:
+    #    - ~/docker/mysql/${PROJECT_NAME}:/var/lib/mysql:rw
+    # interpolation coming in compose 1.5
+    #   https://github.com/docker/compose/pull/1765
+    #   https://github.com/docker/compose/issues/1377
+  environment:
+    - MYSQL_ALLOW_EMPTY_PASSWORD=true

data/spec/dry/config/docker-compose-template.yml

@@ -0,0 +1,27 @@
+# https://docs.docker.com/v1.6/compose/cli/#environment-variables
+web:
+  build: .
+  command: bin/rails server --port 3000 --binding 0.0.0.0
+  ports:
+    - "3000:3000"
+  links:
+    - db
+  volumes:
+    - .:/myapp
+db:
+  # https://github.com/docker-library/docs/tree/master/mysql
+  image: library/mysql:5.7.6
+  ports:
+    - "3306:3306"
+  volumes:
+    - ~/docker/mysql/${PROJECT_NAME}-${BUILD}:/var/lib/mysql:rw
+    # interpolation coming in compose 1.5
+    #   https://github.com/docker/compose/pull/1765
+    #   https://github.com/docker/compose/issues/1377
+  environment:
+    - MYSQL_ALLOW_EMPTY_PASSWORD=true
+interpolations:
+  - ~/foo
+  - $HOME/foo
+  - ${HOME}/foo
+  - #{HOME}/foo

data/spec/dry/config/interpolation_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'singleton'
+
+describe Dry::Config::Base do
+
+  class ComposeConfig < Dry::Config::Base
+  end
+
+  subject(:new_compose) { ComposeConfig.new }
+
+  context 'no interpolation' do
+    let(:config_file_name) { 'docker-compose-template-simple.yml' }
+    subject(:compose) { new_compose}
+    before(:each) { FileUtils.rm_r tmp_dir }
+
+    it 'should read file and write file with all values intact' do
+      compose.clear
+      compose.load!(nil, config_file_name_path)
+
+      expected_config = compose.configuration
+      tmp_file = tmp_file(config_file_name.gsub('.', '-out.'))
+      compose.write_yaml_file(tmp_file)
+
+      compose.clear
+      compose.load!(nil, tmp_file)
+      actual_config = compose.configuration
+
+      expect(actual_config).to eq expected_config
+    end
+  end
+
+  context 'interpolation' do
+    let(:config_file_name) { 'docker-compose-template.yml' }
+    before(:each) {
+      ENV['HOME'] = '/Users/rosskevin'
+      ENV['PROJECT_NAME'] = 'acme'
+      ENV['BUILD'] = '888'
+    }
+    subject(:compose) {
+      compose = new_compose
+      compose.clear
+      compose.load!(nil, config_file_name_path)
+      compose
+    }
+    let(:configuration) { compose.configuration }
+
+    it 'parses structure' do
+      expect(configuration[:db]).not_to be_nil
+    end
+
+    it 'multiple' do
+      expect(configuration[:db][:volumes][0]).to eq '/Users/rosskevin/docker/mysql/acme-888:/var/lib/mysql:rw'
+    end
+
+    it 'all varieties' do
+      interpolations = configuration[:interpolations]
+      interpolations.each do |result|
+        expect(result).to eq '/Users/rosskevin/foo'
+      end
+    end
+
+    context 'disabled' do
+      subject(:new_compose) {ComposeConfig.new(interpolation: false)}
+
+      it 'parses structure' do
+        expect(configuration[:db]).not_to be_nil
+      end
+
+      it 'it does not interpolate' do
+        expect(configuration[:db][:volumes][0]).to eq '~/docker/mysql/${PROJECT_NAME}-${BUILD}:/var/lib/mysql:rw'
+      end
+    end
+  end
+
+
+  private
+
+  def config_file_name_path
+    File.expand_path("../#{config_file_name}", __FILE__)
+  end
+
+  def tmp_file(filename)
+    file = File.expand_path(filename, tmp_dir)
+    file
+  end
+
+  def tmp_dir
+    dir = File.expand_path("../.././../../tmp/interpolation", __FILE__)
+    FileUtils.mkdir_p(dir) unless File.exists? dir
+    dir
+  end
+end

data/spec/spec_helper.rb

@@ -4,5 +4,8 @@ require 'bundler/setup'
 # our gem
 require 'dry/config'
 
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+
 RSpec.configure do |config|
+  # config.include Dry::Config::Foo
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dry-config
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-12 00:00:00.000000000 Z
+date: 2015-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0'
 description: Simple base class for DRY environment based configurations.
 email:
 - kevin.ross@alienfast.com
@@ -61,7 +61,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".rvmrc"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -74,6 +75,9 @@ files:
 - spec/dry/config/acme.yml
 - spec/dry/config/base_spec.rb
 - spec/dry/config/deep_symbolizable_spec.rb
+- spec/dry/config/docker-compose-template-simple.yml
+- spec/dry/config/docker-compose-template.yml
+- spec/dry/config/interpolation_spec.rb
 - spec/dry/config/white-label/acme.com.yml
 - spec/dry/config/white-label/base.yml
 - spec/dry/config/white-label/scheduling.acme.com.yml
@@ -98,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Simple base class for DRY environment based configurations.
@@ -106,6 +110,9 @@ test_files:
 - spec/dry/config/acme.yml
 - spec/dry/config/base_spec.rb
 - spec/dry/config/deep_symbolizable_spec.rb
+- spec/dry/config/docker-compose-template-simple.yml
+- spec/dry/config/docker-compose-template.yml
+- spec/dry/config/interpolation_spec.rb
 - spec/dry/config/white-label/acme.com.yml
 - spec/dry/config/white-label/base.yml
 - spec/dry/config/white-label/scheduling.acme.com.yml

data/.rvmrc

@@ -1 +0,0 @@
-rvm use ruby-2.1.2@dry_config --create