conferrable 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f92d8f5127c4ae292cb7bf8b9e7bd9600df9e71028cd31244dc334855c808be7
-  data.tar.gz: cf2d99d1a036e1f50f06b115d1d56403e58542a906d8b171cd3dbff5017cb162
+  metadata.gz: 00f6b4e7506689f8ba9637674566b37e2013753f852bded56f5997c0349dfebc
+  data.tar.gz: 3bfe518753fca7d4cec7bcd6ef1d27c9f419c9305c07a2529eae7231b9a356db
 SHA512:
-  metadata.gz: 6d18813bcbae5c777a0869a37a1a52cc63776112f5fdd004a177be75cef07c18663dbf5d6f0722a610e70ea2a0161e817152a9fec2d3be1dd2643fcf997a0847
-  data.tar.gz: cc6214c934b5dc269efcfc6c70a0d532c50685b5600acabb15be4a42663f48784095dc264234794c238e89f6eb7d5d4e2f5ec013a301e6c272790931547be465
+  metadata.gz: 30d06435baeb16ebc3e00558ca9cff70b8c7e2a55f86750cd06233624557091eda29d5e70e4336b72b77f2c5da9011a5acf23c60c1935e324226c42600ea0a9f
+  data.tar.gz: baa56734cc264d44d6d698650e6d00953dec8978d7d453567b07685c071aeb3ccd7022df38d72cfb818e546fdd5e253de44b81ea73a051026b97743993618ef9

data/.gitignore

@@ -2,3 +2,4 @@
 *.gem
 /tmp
 /coverage
+Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-2.6.0
+2.6.3

data/.travis.yml

@@ -5,9 +5,9 @@ language: ruby
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
   - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6.0
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
@@ -18,3 +18,8 @@ script:
   - bundle exec rspec
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+addons:
+  # https://docs.travis-ci.com/user/uploading-artifacts/
+  artifacts:
+    paths:
+      - Gemfile.lock

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.1.0 (August 2nd, 2019)
+
+Configuration files can now be plain YAML instead of YAML with ERB. Supported extensions are *.yml, *.yaml, *.yml.erb, and *.yaml.erb in upper, mixed, or lower case.
+
 # 1.0.4 (January 30th, 2019)
 
 Maintenance Release

data/README.md

@@ -29,7 +29,7 @@ bundle add conferrable
 Lets say we have a configuration file located at:
 
 ````
-<app root>/config/config.yml.erb
+<app root>/config/config.yaml
 ````
 
 We can access this by:
@@ -38,21 +38,23 @@ We can access this by:
 config = Conferrable.get_config # config will be a hash
 ````
 
+Note that the configuration file can also be called config.yml (three character extension).
+
 ### Multiple File Example
 
 Building on the simple example, say we have two configuration files:
 
 ````
-<app root>/config/config1.yml.erb
-<app root>/config/config2.yml.erb
+<app root>/config/config1.yaml
+<app root>/config/config2.yaml
 ````
 
 We can now explicitly set the files:
 
 ````
 files = [
-  './config/config1.yml.erb',
-  './config/config2.yml.erb',
+  './config/config1.yaml',
+  './config/config2.yaml',
 ]
 
 Conferrable.set_filenames(:config, files)
@@ -70,6 +72,10 @@ config = Conferrable.get_config # config will be a hash
 
 Note that the files will be loaded in alphabetical order.
 
+### ERB Support ###
+
+If a configuration file ends in '.erb', then it will be pre-processed by the ERB templating system. For example, a file named config.yaml.erb would first be processed by ERB and then parsed as a YAML file. This is helpful when dealing with more complex YAML files.
+
 ## Contributing
 
 ### Development Environment Configuration
@@ -102,6 +108,12 @@ Also, do not forget to run Rubocop:
 bundle exec rubocop
 ````
 
+For convenience, the default rake task will run Rspec and Rubocop:
+
+```
+bundle exec rake
+```
+
 ### Publishing
 
 Note: ensure you have proper authorization before trying to publish new versions.
@@ -109,14 +121,11 @@ Note: ensure you have proper authorization before trying to publish new versions
 After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
 
 1. Merge Pull Request into master
-2. Update ```lib/conferrable/version.rb``` using [semantic versioning](https://semver.org/)
-3. Install dependencies: ```bundle```
-4. Update ```CHANGELOG.md``` with release notes
+2. Update `lib/conferrable/version.rb` using [semantic versioning](https://semver.org/)
+3. Install dependencies: `bundle`
+4. Update `CHANGELOG.md` with release notes
 5. Commit & push master to remote and ensure CI builds master successfully
-6. Build the project locally: `gem build conferrable`
-7. Publish package to RubyGems: `gem push conferrable-X.gem` where X is the version to push
-8. Tag master with new version: `git tag <version>`
-9. Push tags remotely: `git push origin --tags`
+6. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## License
 

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/conferrable.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
     Conferrable standardizes how we interact with these static YAML configuration files.
   DESCRIPTION
 
-  s.authors     = ['Matthew Ruggio']
-  s.email       = ['mruggio@bluemarblepayroll.com']
+  s.authors     = ['Matthew Ruggio', 'Ryan Gerry']
+  s.email       = ['mruggio@bluemarblepayroll.com', 'rgerry@bluemarblepayroll.com']
   s.files       = `git ls-files`.split("\n")
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.3.8'
 
   s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('rake', '~> 12')
   s.add_development_dependency('rspec')
   s.add_development_dependency('rubocop', '~>0.63.1')
   s.add_development_dependency('simplecov', '~>0.16.1')

data/lib/conferrable/file_utilities.rb

@@ -20,11 +20,20 @@ module Conferrable
       end
 
       def read(filename)
-        YAML.safe_load(ERB.new(IO.read(filename)).result)
+        file_content = IO.read(filename)
+
+        pre_processed_content =
+          filename.downcase.end_with?(ERB_EXTENSION) ? ERB.new(file_content).result : file_content
+
+        YAML.safe_load(pre_processed_content)
       end
 
       private
 
+      ERB_EXTENSION = '.erb'
+      FILE_MATCHER = /.+\.(ya?ml|ya?ml.erb)\Z/i.freeze
+      private_constant :ERB_EXTENSION, :FILE_MATCHER
+
       def list(filename)
         if File.exist?(filename) && File.directory?(filename)
           glob_files_only(filename)
@@ -36,8 +45,8 @@ module Conferrable
       end
 
       def glob_files_only(filename)
-        dir_name = File.join(filename, '**', '*.yml.erb')
-        Dir.glob(dir_name).reject { |f| File.directory?(f) }
+        dir_glob = File.join(filename, '**/*')
+        Dir.glob(dir_glob).grep(FILE_MATCHER).reject { |f| File.directory?(f) }
       end
     end
   end

data/lib/conferrable/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Conferrable
-  VERSION = '1.0.4'
+  VERSION = '1.1.0'
 end

data/spec/conferrable/file_utilities_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require './spec/spec_helper'
+
+describe Conferrable::FileUtilities do
+  let(:config_examples_path) { File.expand_path('../config_examples/', __dir__) }
+
+  describe 'resolving file names' do
+    it 'finds all YAML and YAML + ERB files with upper or lower case extensions' do
+      expected_files = Set.new([
+                                 File.join(config_examples_path, 'full.yaml.erb'),
+                                 File.join(config_examples_path, 'full.yaml'),
+                                 File.join(config_examples_path, 'simple.yml.erb'),
+                                 File.join(config_examples_path, 'simple.yml'),
+                                 File.join(config_examples_path, 'UPPER.YML.ERB'),
+                                 File.join(config_examples_path, 'UPPER.YML')
+                               ])
+
+      expect(Set.new(described_class.resolve(config_examples_path))).to eq expected_files
+    end
+  end
+
+  describe 'reading/parsing YAML files' do
+    it 'returns a parsed YAML evaluated result for a *.yml file' do
+      file_path = File.join(config_examples_path, 'simple.yml')
+      expected_result = { 'key1' => ['element1', '<%= "ERB which will not evaluate" =>'] }
+
+      expect(described_class.read(file_path)).to eq(expected_result)
+    end
+
+    it 'returns a parsed YAML and ERB evaluated result for a *.yml.erb file' do
+      file_path = File.join(config_examples_path, 'simple.yml.erb')
+      expected_result = { 'key1' => %w[static_element dynamic_element] }
+
+      expect(described_class.read(file_path)).to eq(expected_result)
+    end
+
+    it 'returns a parsed YAML and ERB evaluated result for an upper case *.YML.ERB file' do
+      file_path = File.join(config_examples_path, 'UPPER.YML.ERB')
+      expected_result = { 'key1' => %w[static_element dynamic_element] }
+
+      expect(described_class.read(file_path)).to eq(expected_result)
+    end
+  end
+end

data/spec/config_examples/UPPER.YML.ERB

@@ -0,0 +1 @@
+key1: [static_element, <%= 'dynamic' + '_' + 'element' %>]

data/spec/config_examples/simple.yml

@@ -0,0 +1,3 @@
+key1:
+  - element1
+  - '<%= "ERB which will not evaluate" =>'

data/spec/config_examples/simple.yml.erb

@@ -0,0 +1 @@
+key1: [static_element, <%= 'dynamic' + '_' + 'element' %>]

data/spec/spec_helper.rb

@@ -10,7 +10,7 @@
 require 'simplecov'
 require 'simplecov-console'
 
-require './lib/conferrable'
-
 SimpleCov.formatter = SimpleCov::Formatter::Console
 SimpleCov.start
+
+require './lib/conferrable'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: conferrable
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthew Ruggio
+- Ryan Gerry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-04 00:00:00.000000000 Z
+date: 2019-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec
@@ -24,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +101,7 @@ description: |2
       Conferrable standardizes how we interact with these static YAML configuration files.
 email:
 - mruggio@bluemarblepayroll.com
+- rgerry@bluemarblepayroll.com
 executables:
 - console
 extensions: []
@@ -98,10 +114,10 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
+- Rakefile
 - bin/console
 - conferrable.gemspec
 - lib/conferrable.rb
@@ -111,10 +127,19 @@ files:
 - lib/conferrable/file_based_configuration.rb
 - lib/conferrable/file_utilities.rb
 - lib/conferrable/version.rb
-- spec/conferrable_spec.rb
-- spec/configuration_spec.rb
-- spec/entry_spec.rb
-- spec/file_based_configuration_spec.rb
+- spec/conferrable/conferrable_spec.rb
+- spec/conferrable/configuration_spec.rb
+- spec/conferrable/entry_spec.rb
+- spec/conferrable/file_based_configuration_spec.rb
+- spec/conferrable/file_utilities_spec.rb
+- spec/config_examples/UPPER.YML
+- spec/config_examples/UPPER.YML.ERB
+- spec/config_examples/directory.yml/.gitkeep
+- spec/config_examples/full.yaml
+- spec/config_examples/full.yaml.erb
+- spec/config_examples/not-yaml.txt
+- spec/config_examples/simple.yml
+- spec/config_examples/simple.yml.erb
 - spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/conferrable
 licenses:
@@ -135,13 +160,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple YAML file-based configuration management
 test_files:
-- spec/conferrable_spec.rb
-- spec/configuration_spec.rb
-- spec/entry_spec.rb
-- spec/file_based_configuration_spec.rb
+- spec/conferrable/conferrable_spec.rb
+- spec/conferrable/configuration_spec.rb
+- spec/conferrable/entry_spec.rb
+- spec/conferrable/file_based_configuration_spec.rb
+- spec/conferrable/file_utilities_spec.rb
+- spec/config_examples/UPPER.YML
+- spec/config_examples/UPPER.YML.ERB
+- spec/config_examples/directory.yml/.gitkeep
+- spec/config_examples/full.yaml
+- spec/config_examples/full.yaml.erb
+- spec/config_examples/not-yaml.txt
+- spec/config_examples/simple.yml
+- spec/config_examples/simple.yml.erb
 - spec/spec_helper.rb

data/Gemfile.lock

@@ -1,102 +0,0 @@
-PATH
-  remote: .
-  specs:
-    conferrable (1.0.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    ast (2.4.0)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    ffi (1.10.0)
-    formatador (0.2.5)
-    guard (2.15.0)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    hirb (0.7.3)
-    jaro_winkler (1.5.2)
-    json (2.1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.13)
-    method_source (0.9.2)
-    nenv (0.3.0)
-    notiffany (0.1.1)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    parallel (1.13.0)
-    parser (2.6.0.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rainbow (3.0.0)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
-      ffi (~> 1.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.63.1)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    ruby_dep (1.5.0)
-    shellany (0.0.1)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-console (0.4.2)
-      ansi
-      hirb
-      simplecov
-    simplecov-html (0.10.2)
-    thor (0.20.3)
-    unicode-display_width (1.4.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  conferrable!
-  guard-rspec (~> 4.7)
-  rspec
-  rubocop (~> 0.63.1)
-  simplecov (~> 0.16.1)
-  simplecov-console (~> 0.4.2)
-
-BUNDLED WITH
-   1.17.2