conferrable 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 540aa0627fba5b489ce2f93d6da830021ed7c9c3
-  data.tar.gz: 8e1e82140cb2e202fae3ee82fad21650c50049db
+SHA256:
+  metadata.gz: f92d8f5127c4ae292cb7bf8b9e7bd9600df9e71028cd31244dc334855c808be7
+  data.tar.gz: cf2d99d1a036e1f50f06b115d1d56403e58542a906d8b171cd3dbff5017cb162
 SHA512:
-  metadata.gz: aa9e2aff2d7a5304d4b422f79389e13f382f1b307987074f4b5f5fa481e4e24c3d1f68f5c82aa76566246a031b0d2b370f96c90cb56c233abd087a492e67e1df
-  data.tar.gz: 6b1efa372cfcbdbc409a9ceafeb4cb23be9a7cdb2266e524283f2657dc94abf0127025bcbdb4e3a7b18e35bf5052fa8e4c1c0a4ce970c657e0d83250baf3a207
+  metadata.gz: 6d18813bcbae5c777a0869a37a1a52cc63776112f5fdd004a177be75cef07c18663dbf5d6f0722a610e70ea2a0161e817152a9fec2d3be1dd2643fcf997a0847
+  data.tar.gz: cc6214c934b5dc269efcfc6c70a0d532c50685b5600acabb15be4a42663f48784095dc264234794c238e89f6eb7d5d4e2f5ec013a301e6c272790931547be465

data/.gitignore

@@ -1,2 +1,4 @@
 .DS_Store
 *.gem
+/tmp
+/coverage

data/.rubocop.yml

@@ -1,4 +1,8 @@
-inherit_from: .rubocop_todo.yml
-
 Metrics/LineLength:
   Max: 100
+
+Metrics/BlockLength:
+  ExcludedMethods: ['it', 'describe', 'context', 'let', 'specify']
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.ruby-version

@@ -1 +1 @@
-2.3.7
+2.6.0

data/.travis.yml

@@ -1,8 +1,20 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=d2049a4da7f1063141bf29853e71045d856a341f8e4462ffc236c8a81b4c29a2
 language: ruby
 rvm:
-  - 2.3.1
-  - 2.3.7
+  # 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
 cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
 script:
   - bundle exec rubocop
   - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 1.0.4 (January 30th, 2019)
+
+Maintenance Release
+
+* Added bin/console script
+* Added CHANGELOG
+* Updated README with publication steps, additional testing steps
+* Bumped minimum Ruby to 2.3.8
+* Added Guard

data/Gemfile.lock

@@ -1,19 +1,56 @@
 PATH
   remote: .
   specs:
-    conferrable (1.0.3)
+    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)
-    jaro_winkler (1.5.1)
-    parallel (1.12.1)
-    parser (2.5.1.2)
+    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)
@@ -27,24 +64,39 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.59.2)
+    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.0, >= 1.0.1)
+      unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.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.59.2)
+  rubocop (~> 0.63.1)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
 
 BUNDLED WITH
-   1.16.3
+   1.17.2

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,6 +1,6 @@
 # Conferrable
 
-[![Build Status](https://travis-ci.org/bluemarblepayroll/conferrable.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/conferrable)
+[![Gem Version](https://badge.fury.io/rb/conferrable.svg)](https://badge.fury.io/rb/conferrable) [![Build Status](https://travis-ci.org/bluemarblepayroll/conferrable.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/conferrable) [![Maintainability](https://api.codeclimate.com/v1/badges/4149dfc2579b9345c4be/maintainability)](https://codeclimate.com/github/bluemarblepayroll/conferrable/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/4149dfc2579b9345c4be/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/conferrable/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 We have seen our applications gain more and more static configuration files over time.  A common library we use on a daily basis is these configuration file loaders.  Conferrable standardizes how we interact with these static YAML configuration files.  It offers a simple and extendable API for dealing with the following scenarios:
 
@@ -87,9 +87,37 @@ Basic steps to take to get this repository compiling:
 To execute the test suite run:
 
 ````
-rspec
+bundle exec rspec spec --format documentation
 ````
 
+Alternatively, you can have Guard watch for changes:
+
+````
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````
+bundle exec rubocop
+````
+
+### Publishing
+
+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
+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`
+
 ## License
 
 This project is MIT Licensed.

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'conferrable'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/conferrable.gemspec

@@ -21,8 +21,11 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bluemarblepayroll/conferrable'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.3.1'
+  s.required_ruby_version = '>= 2.3.8'
 
+  s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~> 0.59.2')
+  s.add_development_dependency('rubocop', '~>0.63.1')
+  s.add_development_dependency('simplecov', '~>0.16.1')
+  s.add_development_dependency('simplecov-console', '~>0.4.2')
 end

data/lib/conferrable/conferrable.rb

@@ -17,8 +17,8 @@ require_relative 'entry'
 
 # This is the main module that contains the class-level methods that define the main API.
 module Conferrable
-  GET_PREFIX_MATCHER_REGEX  = /^get_(.+)$/
-  GET_PREFIX_REGEX          = /^get_/
+  GET_PREFIX_MATCHER_REGEX  = /^get_(.+)$/.freeze
+  GET_PREFIX_REGEX          = /^get_/.freeze
 
   class << self
     def clear!

data/lib/conferrable/file_utilities.rb

@@ -15,20 +15,30 @@ module Conferrable
         Array(filenames).flatten.map do |filename|
           next unless filename && filename.to_s.length.positive?
 
-          if File.exist?(filename) && File.directory?(filename)
-            dir_name = File.join(filename, '**', '*.yml.erb')
-            Dir.glob(dir_name).reject { |f| File.directory?(f) }
-          elsif File.exist?(filename)
-            filename
-          else
-            raise ArgumentError, "Cannot find file: #{filename} => #{File.expand_path(filename)}"
-          end
+          list(filename)
         end.flatten
       end
 
       def read(filename)
         YAML.safe_load(ERB.new(IO.read(filename)).result)
       end
+
+      private
+
+      def list(filename)
+        if File.exist?(filename) && File.directory?(filename)
+          glob_files_only(filename)
+        elsif File.exist?(filename)
+          filename
+        else
+          raise ArgumentError, "Cannot find file: #{filename} => #{File.expand_path(filename)}"
+        end
+      end
+
+      def glob_files_only(filename)
+        dir_name = File.join(filename, '**', '*.yml.erb')
+        Dir.glob(dir_name).reject { |f| File.directory?(f) }
+      end
     end
   end
 end

data/lib/conferrable/version.rb

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

data/spec/conferrable_spec.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require './lib/conferrable'
+require './spec/spec_helper'
 
 describe Conferrable do
   let(:default_file_path) { './config/file1.yml.erb' }

data/spec/configuration_spec.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require './lib/conferrable'
+require './spec/spec_helper'
 
 describe Conferrable::Configuration do
   it 'should accept no initialization arguments' do

data/spec/entry_spec.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require './lib/conferrable'
+require './spec/spec_helper'
 
 describe Conferrable::Entry do
   let(:default_file_path) { './config/file1.yml.erb' }

data/spec/file_based_configuration_spec.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require './lib/conferrable'
+require './spec/spec_helper'
 
 describe Conferrable::FileBasedConfiguration do
   let(:file1_path) { File.expand_path('spec/files/file1.yml.erb') }

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# 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 'simplecov'
+require 'simplecov-console'
+
+require './lib/conferrable'
+
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: conferrable
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -30,34 +44,65 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.4.2
 description: |2
       We have seen our applications gain more and more static configuration files over time.
       A common library we use on a daily basis is these configuration file loaders.
       Conferrable standardizes how we interact with these static YAML configuration files.
 email:
 - mruggio@bluemarblepayroll.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
 - README.md
+- bin/console
 - conferrable.gemspec
 - lib/conferrable.rb
 - lib/conferrable/conferrable.rb
@@ -70,6 +115,7 @@ files:
 - spec/configuration_spec.rb
 - spec/entry_spec.rb
 - spec/file_based_configuration_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/conferrable
 licenses:
 - MIT
@@ -82,15 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.1
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Simple YAML file-based configuration management
@@ -99,3 +144,4 @@ test_files:
 - spec/configuration_spec.rb
 - spec/entry_spec.rb
 - spec/file_based_configuration_spec.rb
+- spec/spec_helper.rb

data/.rubocop_todo.yml

@@ -1,22 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2018-09-28 08:27:14 -0500 using RuboCop version 0.59.2.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-Metrics/AbcSize:
-  Max: 17
-
-# Offense count: 2
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Max: 45
-
-# Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/MethodLength:
-  Max: 11