config-parser 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fc6869f1aa46b1446eff6a47d6dda33e72a7a50d
-  data.tar.gz: ac300beccf597924911ac279b2c117112cd895d8
+SHA256:
+  metadata.gz: 87a783bc84cb4b18d7c595ab1d189fc96de95b37be769e8d9283b6a6f7de6dd3
+  data.tar.gz: ea1ea23ec0ac507e57148e407ced402f96a26da73baf18ba352794eafe74e978
 SHA512:
-  metadata.gz: 01a2a7aec84c8d24ab2d58c90238ea463a5014e1403f880b06aa8c81274a915b3b60c63314c02e90406bcdbd980c7fe689e71dd51702bae8d292e55a440fbe08
-  data.tar.gz: f81280199802c941c3b7a0ef3fc0097b8840a275be38990d392388a9ae6ab5ef2e84807ed103c1180b1ec895a5cf9f51193abc061e6c6e119ee90cdea0156dd7
+  metadata.gz: 0fdea9dede402cd33725eee39f9261eadd47890e0cc5d58b06be7bf3313fe2a7d91fb7676636c86627b30158f13feb5759e6edd0e31f6757ac8848a72001fced
+  data.tar.gz: f26277e7c6874c3bf4ad4cd33f7c80859ae80028f9a5145a2661b6aa8c0b5e7cbeb202853548d22e29c71270cbd1ca7c07a24c38531860a101f7bac00c801bc3

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+cache: bundler
+
+before_install:
+  - gem install bundler -v '< 2' --conservative
+
+rvm:
+ - 1.9
+ - 2.0
+ - 2.3.3
+ - 2.5.1
+
+sudo: false
+
+script:
+ - 'COVERAGE=true bundle exec rspec'

data/Gemfile.lock

@@ -1,36 +1,38 @@
 PATH
   remote: .
   specs:
-    config-parser (0.3.0)
+    config-parser (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    deep_merge (1.2.1)
     diff-lcs (1.3)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
+      rspec-support (~> 3.9.0)
     rspec-its (1.2.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.5.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   config-parser!
+  deep_merge
   rspec
   rspec-its
 
 BUNDLED WITH
-   1.14.6
+   1.16.2

data/{README.markdown → README.md}

@@ -1,22 +1,24 @@
-## Config parser gem
+[![Build Status](https://travis-ci.org/openSUSE/rubygem_config-parser.png?branch=master)](https://travis-ci.org/openSUSE/rubygem_config-parser)
 
-Parsing an options.yml file into a Hash with convenience methods like
+## Ruby Config Parser
+
+Providing config values for your Ruby app with convenience methods like
 overwriting variables per Rails environment and overwriting variables with a local
 options_local.yml file.
 
 ### Installation
 
-The best way to install is with RubyGems:
+The best way to install is with [RubyGems](https://rubygems.org/gems/config-parser):
 
-    $ [sudo] gem install config-parser
+    $ gem install config-parser
 
-Or better still, just add it to your Gemfile:
+Or better still, just add it to your `Gemfile`:
 
     gem 'config-parser'
 
 ### Defaults
 
-Per default the parser will search for the config file at config/options.yml and config/options-local.yml.
+Per default the parser will search for the config file at `config/options.yml` and local overrides at `config/options-local.yml`.
 
 
 ### Example
@@ -33,7 +35,12 @@ Example config file:
 When running in the production environment, the mailer_delivery_method will be set to
 'smtp'. The same works for all other environments. The optional options_local.yml file
 would have the same layout.
-When used from a Rails app, just include in your application.rb:
+
+The precedence of config values goes like this (from lowest to highest):
+
+`options.yml default section -> options.yml environment section -> options-local.yml default section -> options-local.yml environment section`
+
+When used from a Rails app, just include in your `application.rb`:
 
 ```ruby
 OPTS = Common::Options.new
@@ -43,6 +50,7 @@ and you can use the config variables like:
 
 ```ruby
 OPTS.<variable_name>
+OPTS.<variable_name>[:nested_value]
 ```
 
 Also, you can pass main config and local config location as well as environment to load

data/config-parser.gemspec

@@ -1,18 +1,17 @@
 Gem::Specification.new do |gem|
   gem.name = "config-parser"
   gem.summary = %Q{Parsing an options.yml file into a Hash with convenience.}
-  gem.description = "Parsing an options.yml file into a Hash with convenience methods like
-overwriting variables per Rails environment and overwriting variables with a local
-options_local.yml file."
+  gem.description = "Providing config values for your Ruby app with convenience methods like
+  overwriting variables per Rails environment and overwriting variables with a local
+  options_local.yml file."
   gem.homepage = "https://github.com/openSUSE/rubygem_config-parser"
   gem.authors = ['cschum@suse.de', 'tom@opensuse.org', 'kpimenov@suse.de']
   gem.files = `git ls-files`.split("\n")
   gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.require_paths = ['lib']
-  gem.version = '0.3.0'
+  gem.version = '0.4.0'
   gem.license = 'MIT'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rspec-its'
+  gem.add_development_dependency 'deep_merge'
 end
-
-

data/lib/common/options.rb

@@ -22,6 +22,7 @@
 
 require 'yaml'
 require 'erb'
+require 'deep_merge'
 
 require "#{File.dirname(__FILE__)}/utils"
 
@@ -111,14 +112,14 @@ module Common
       elsif @persistent_local_cfg_file && File.exists?(@persistent_local_cfg_file)
         vputs "Loading '#{@persistent_local_cfg_file}'", args[:verbose]
         update_options(@persistent_local_cfg_file, options)
-      elsif File.exists? @local_cfg_file
+      elsif @local_cfg_file && File.exists?(@local_cfg_file)
         vputs "Loading '#{@local_cfg_file}'", args[:verbose]
         update_options(@local_cfg_file, options)
       end
 
       if args[:environment]
         vputs "Using environment '#{args[:environment]}'", args[:verbose]
-        options = (options['default']||{}).update(options[args[:environment]]||{})
+        options = (options['default']||{}).deep_merge!(options[args[:environment]]||{})
       end
 
       options.update(update_options)
@@ -164,16 +165,10 @@ module Common
       raise NoMethodError.new("undefined method `#{key}' for Options:Class", "unknown_key")
     end
 
-    # Update options.
+    # Merge options with content of <file>.
     def update_options file, options
-      load_file(file).each do |k, v|
-        next unless v
-        if options[k]
-          options[k].update(v)
-        else
-          options[k] = v
-        end
-      end
+      options.deep_merge!(load_file(file))
     end
+
   end
 end

data/spec/fixtures/example_config.yml

@@ -2,3 +2,21 @@ default:
   plain_key: plain_value
   erb_key: <%= %w(erb value).join('_') %>
   mixed_key: "<%= 'mixed_' %>value"
+
+  nested:
+    nested_key: nested_value_default
+    nested_key2: nested_value_default2
+
+  nested_env:
+    nested_key: nested_value_env
+    nested_key2: nested_value_env2
+
+  env_overwrite_key: env_value
+
+
+test:
+  env_only_key: test_value
+  env_overwrite_key: test_value
+
+  nested_env:
+    nested_key: nested_value_test

data/spec/fixtures/example_config_local.yml

@@ -0,0 +1,14 @@
+default:
+
+  plain_key: plain_value_local
+
+  nested:
+    nested_key: nested_value_local
+
+
+test:
+  env_only_key: test_value_local
+  env_overwrite_key: test_value_local
+
+  nested_env:
+    nested_key: nested_value_test_local

data/spec/local_overwrite_spec.rb

@@ -0,0 +1,26 @@
+require_relative 'spec_helper'
+
+describe Common::Options do
+  subject { Common::Options.new('spec/fixtures/example_config.yml', 'spec/fixtures/example_config_local.yml', 'test') }
+
+  it 'reads default value' do
+    expect( subject.mixed_key ).to eq("mixed_value")
+  end
+
+  it 'reads local value' do
+    expect( subject.plain_key ).to eq("plain_value_local")
+  end
+
+  it 'reads local nested value' do
+    expect( subject.nested['nested_key'] ).to eq("nested_value_local")
+  end
+
+  it 'reads nested value for local env' do
+    expect( subject.nested_env['nested_key']).to eq("nested_value_test_local")
+  end
+
+  it 'keeps default for not overwritten parts of nested set' do
+    expect(subject.nested_env['nested_key2']).to eq("nested_value_env2")
+  end
+
+end

data/spec/nested_values_spec.rb

@@ -0,0 +1,18 @@
+require_relative 'spec_helper'
+
+describe Common::Options do
+  subject { Common::Options.new('spec/fixtures/example_config.yml', nil, 'test') }
+
+  it 'reads nested value' do
+    expect( subject.nested['nested_key']).to eq("nested_value_default")
+  end
+
+  it 'reads nested value for env' do
+    expect( subject.nested_env['nested_key']).to eq("nested_value_test")
+  end
+
+  it 'keeps default for not overwritten parts of nested set' do
+    expect(subject.nested_env['nested_key2']).to eq("nested_value_env2")
+  end
+
+end

data/spec/read_values_spec.rb

@@ -0,0 +1,13 @@
+require_relative 'spec_helper'
+
+describe Common::Options do
+  subject { Common::Options.new('spec/fixtures/example_config.yml') }
+
+  it 'reads value' do
+    expect( subject.plain_key ).to eq("plain_value")
+  end
+
+  it 'reads nested value' do
+    expect( subject.nested['nested_key'] ).to eq("nested_value_default")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: config-parser
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - cschum@suse.de
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -40,26 +40,45 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
-  Parsing an options.yml file into a Hash with convenience methods like
-  overwriting variables per Rails environment and overwriting variables with a local
-  options_local.yml file.
+  Providing config values for your Ruby app with convenience methods like
+    overwriting variables per Rails environment and overwriting variables with a local
+    options_local.yml file.
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.markdown
+- README.md
 - config-parser.gemspec
 - lib/common/options.rb
 - lib/common/utils.rb
 - lib/config-parser.rb
 - spec/erb_interpolation_spec.rb
 - spec/fixtures/example_config.yml
+- spec/fixtures/example_config_local.yml
+- spec/local_overwrite_spec.rb
+- spec/nested_values_spec.rb
+- spec/read_values_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/openSUSE/rubygem_config-parser
 licenses:
@@ -81,11 +100,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Parsing an options.yml file into a Hash with convenience.
 test_files:
 - spec/erb_interpolation_spec.rb
 - spec/fixtures/example_config.yml
+- spec/fixtures/example_config_local.yml
+- spec/local_overwrite_spec.rb
+- spec/nested_values_spec.rb
+- spec/read_values_spec.rb
 - spec/spec_helper.rb