conferrable 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cca938558ae02f3ddcbb70d0a27bbad49f0fde54
-  data.tar.gz: 357db2e7fc8a1ef810f785a98efa48c31f28c5a5
+  metadata.gz: 540aa0627fba5b489ce2f93d6da830021ed7c9c3
+  data.tar.gz: 8e1e82140cb2e202fae3ee82fad21650c50049db
 SHA512:
-  metadata.gz: 26012d1c811df974b41083bff49090f3f1a845344367b053395a4a694c79aadc82a4d00b6402d5f25b63c4e2cdd154e3c12c9bc349748b5b869b58f8aa2e4bfe
-  data.tar.gz: 30f7070c56bd45879d32b7c9f3db5280366ba7300ceafb49d89567675941b5cf6a3ac16d1eb35c754dd991f0cd33b998f116c4a2699506df71992bf0b77291a4
+  metadata.gz: aa9e2aff2d7a5304d4b422f79389e13f382f1b307987074f4b5f5fa481e4e24c3d1f68f5c82aa76566246a031b0d2b370f96c90cb56c233abd087a492e67e1df
+  data.tar.gz: 6b1efa372cfcbdbc409a9ceafeb4cb23be9a7cdb2266e524283f2657dc94abf0127025bcbdb4e3a7b18e35bf5052fa8e4c1c0a4ce970c657e0d83250baf3a207

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 100

data/.rubocop_todo.yml

@@ -0,0 +1,22 @@
+# 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

data/.travis.yml

@@ -4,4 +4,5 @@ rvm:
   - 2.3.7
 cache: bundler
 script:
+  - bundle exec rubocop
   - bundle exec rspec

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,12 +1,19 @@
 PATH
   remote: .
   specs:
-    conferrable (1.0.2)
+    conferrable (1.0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -20,6 +27,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.59.2)
+      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)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
@@ -27,6 +44,7 @@ PLATFORMS
 DEPENDENCIES
   conferrable!
   rspec
+  rubocop (~> 0.59.2)
 
 BUNDLED WITH
    1.16.3

data/conferrable.gemspec

@@ -1,25 +1,28 @@
-require "./lib/conferrable/version"
+# frozen_string_literal: true
+
+require './lib/conferrable/version'
 
 Gem::Specification.new do |s|
   s.name        = 'conferrable'
   s.version     = Conferrable::VERSION
-  s.summary     = "Simple YAML file-based configuration management"
+  s.summary     = 'Simple YAML file-based configuration management'
 
-  s.description = <<-EOS
+  s.description = <<-DESCRIPTION
     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.
-  EOS
+  DESCRIPTION
 
-  s.authors     = [ 'Matthew Ruggio' ]
-  s.email       = [ 'mruggio@bluemarblepayroll.com' ]
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@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) }
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.homepage    = 'https://github.com/bluemarblepayroll/conferrable'
   s.license     = 'MIT'
 
   s.required_ruby_version = '>= 2.3.1'
 
   s.add_development_dependency('rspec')
+  s.add_development_dependency('rubocop', '~> 0.59.2')
 end

data/lib/conferrable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #

data/lib/conferrable/conferrable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -13,13 +15,12 @@ require_relative 'configuration'
 require_relative 'file_based_configuration'
 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_/
 
   class << self
-
     def clear!
       @entries = {}
 
@@ -63,6 +64,5 @@ module Conferrable
     def keyify(val)
       val.to_s.sub(GET_PREFIX_REGEX, '')
     end
-
   end
 end

data/lib/conferrable/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -6,29 +8,20 @@
 #
 
 module Conferrable
+  # Base class that defines main hash-based implementation.
   class Configuration
+    attr_reader :all
 
     def initialize(*configs)
-      load!(configs)
-    end
+      @all = {}
 
-    def all
-      @all || {}
+      overlay(configs)
     end
 
-    def load!(*configs)
-      configs.flatten.compact.each { |c| overlay(c) }
+    def overlay(*configs)
+      configs.flatten.compact.each { |config| @all.merge!(config || {}) }
 
       nil
     end
-
-    private
-
-    def overlay(config)
-      @all = {} unless @all
-
-      @all.merge!(config || {})
-    end
-
   end
 end

data/lib/conferrable/entry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -6,30 +8,25 @@
 #
 
 module Conferrable
+  # This class builds on the basic concepts of Configuration and FileBasedConfiguration.
+  # It allows the ability to define a "configuration store".
   class Entry
-
     class << self
+      attr_writer :default_folder
 
       def default_folder
         @default_folder || File.join('.', 'config')
       end
 
-      def default_folder=(path)
-        @default_folder = path
-      end
-
       def default_file(name)
         File.join(default_folder, "#{name}.yml.erb")
       end
-
     end
 
-    attr_reader :key
-
-    attr_accessor :filenames
+    attr_reader :key, :filenames
 
     def initialize(key, filenames: nil)
-      raise ArgumentError, 'key is required' unless key && key.to_s.length > 0
+      raise ArgumentError, 'key is required' unless key && key.to_s.length.positive?
 
       @key        = key.to_s
       @filenames  = filenames
@@ -58,7 +55,7 @@ module Conferrable
     private
 
     def protected!
-      raise ArgumentError, "[Illegal] #{key} config store has been re-configured after it was loaded." if loaded?
+      raise ArgumentError, "#{key} config store has been re-configured after load." if loaded?
     end
 
     def loaded!
@@ -73,12 +70,11 @@ module Conferrable
 
       names = Array(filenames).flatten
 
-      names = [ self.class.default_file(key) ] if names.length == 0
+      names = [self.class.default_file(key)] if names.length.zero?
 
       @configuration = FileBasedConfiguration.new(names)
 
       loaded!
     end
-
   end
 end

data/lib/conferrable/file_based_configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -6,11 +8,14 @@
 #
 
 module Conferrable
+  # This class extends the Configuration class by introducing the concept of
+  # loading from a file.
   class FileBasedConfiguration < Configuration
-
     attr_reader :filenames, :loaded_filenames
 
     def initialize(*filenames)
+      super() # explicit () because we do not want to send in filenames
+
       @filenames        = filenames.flatten
       @loaded_filenames = FileUtilities.resolve(@filenames)
 
@@ -20,8 +25,7 @@ module Conferrable
     def load!
       configs = @loaded_filenames.map { |f| FileUtilities.read(f) }
 
-      super(configs)
+      overlay(configs)
     end
-
   end
 end

data/lib/conferrable/file_utilities.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -6,15 +8,16 @@
 #
 
 module Conferrable
+  # Extra utilities that help, but do not define the domain.
   class FileUtilities
     class << self
-
       def resolve(filenames)
         Array(filenames).flatten.map do |filename|
-          next unless filename && filename.to_s.length > 0
+          next unless filename && filename.to_s.length.positive?
 
           if File.exist?(filename) && File.directory?(filename)
-            Dir.glob(File.join(filename, '**', '*.yml.erb')).select { |f| !File.directory?(f) }
+            dir_name = File.join(filename, '**', '*.yml.erb')
+            Dir.glob(dir_name).reject { |f| File.directory?(f) }
           elsif File.exist?(filename)
             filename
           else
@@ -24,9 +27,8 @@ module Conferrable
       end
 
       def read(filename)
-        YAML.load(ERB.new(IO.read(filename)).result)
+        YAML.safe_load(ERB.new(IO.read(filename)).result)
       end
-
     end
   end
 end

data/lib/conferrable/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -6,5 +8,5 @@
 #
 
 module Conferrable
-  VERSION = "1.0.2"
+  VERSION = '1.0.3'
 end

data/spec/conferrable_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -8,14 +10,14 @@
 require './lib/conferrable'
 
 describe Conferrable do
-
   let(:default_file_path) { './config/file1.yml.erb' }
   let(:default_abs_file_path) { File.expand_path(default_file_path) }
 
-  let(:default_file) { "admin: true" }
+  let(:default_file) { 'admin: true' }
 
   before(:each) do
-    allow(::Conferrable::FileUtilities).to receive(:resolve).with([default_file_path]).and_return([default_abs_file_path])
+    allow(::Conferrable::FileUtilities).to receive(:resolve).with([default_file_path])
+                                                            .and_return([default_abs_file_path])
 
     allow(IO).to receive(:read).with(default_abs_file_path).and_return(default_file)
   end
@@ -58,5 +60,4 @@ describe Conferrable do
       Conferrable.set_filenames(:file1, 'something_else.yml.erb')
     end.to raise_error(ArgumentError)
   end
-
 end

data/spec/configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -8,7 +10,6 @@
 require './lib/conferrable'
 
 describe Conferrable::Configuration do
-
   it 'should accept no initialization arguments' do
     config = Conferrable::Configuration.new
 
@@ -38,5 +39,4 @@ describe Conferrable::Configuration do
 
     expect(config.all.dig('options', 'admin')).to be false
   end
-
 end

data/spec/entry_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -8,14 +10,13 @@
 require './lib/conferrable'
 
 describe Conferrable::Entry do
-
   let(:default_file_path) { './config/file1.yml.erb' }
   let(:default_abs_file_path) { File.expand_path(default_file_path) }
-
-  let(:default_file) { "admin: true" }
+  let(:default_file) { 'admin: true' }
 
   before(:each) do
-    allow(::Conferrable::FileUtilities).to receive(:resolve).with([default_file_path]).and_return([default_abs_file_path])
+    allow(::Conferrable::FileUtilities).to receive(:resolve).with([default_file_path])
+                                                            .and_return([default_abs_file_path])
 
     allow(IO).to receive(:read).with(default_abs_file_path).and_return(default_file)
   end
@@ -27,5 +28,4 @@ describe Conferrable::Entry do
 
     expect(admin_value).to be true
   end
-
 end

data/spec/file_based_configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -8,24 +10,30 @@
 require './lib/conferrable'
 
 describe Conferrable::FileBasedConfiguration do
-
   let(:file1_path) { File.expand_path('spec/files/file1.yml.erb') }
   let(:file2_path) { File.expand_path('spec/files/file2.yml.erb') }
   let(:files_path) { File.expand_path('spec/files') }
-  let(:files) { [ file1_path, file2_path ]}
-
-  let(:file1) { "admin: true" }
-  let(:file2) { "admin: false" }
+  let(:files) { [file1_path, file2_path] }
+  let(:file1) { 'admin: true' }
+  let(:file2) { 'admin: false' }
 
   before(:each) do
     allow(::Conferrable::FileUtilities).to receive(:resolve).with([]).and_return([])
-    allow(::Conferrable::FileUtilities).to receive(:resolve).with([file1_path]).and_return([file1_path])
-    allow(::Conferrable::FileUtilities).to receive(:resolve).with([file2_path]).and_return([file2_path])
+
+    allow(::Conferrable::FileUtilities).to receive(:resolve).with([file1_path])
+                                                            .and_return([file1_path])
+
+    allow(::Conferrable::FileUtilities).to receive(:resolve).with([file2_path])
+                                                            .and_return([file2_path])
+
     allow(::Conferrable::FileUtilities).to receive(:resolve).with([files_path]).and_return(files)
+
     allow(::Conferrable::FileUtilities).to receive(:resolve).with([files]).and_return(files)
+
     allow(::Conferrable::FileUtilities).to receive(:resolve).with(files).and_return(files)
 
     allow(IO).to receive(:read).with(file1_path).and_return(file1)
+
     allow(IO).to receive(:read).with(file2_path).and_return(file2)
   end
 
@@ -57,7 +65,7 @@ describe Conferrable::FileBasedConfiguration do
     expect(admin_value).to be false
 
     # Test passing in an nested arrays
-    config = Conferrable::FileBasedConfiguration.new([ [ files ] ])
+    config = Conferrable::FileBasedConfiguration.new([[files]])
     admin_value = config.all['admin']
     expect(admin_value).to be false
   end
@@ -69,5 +77,4 @@ describe Conferrable::FileBasedConfiguration do
     expect(admin_value).to be false
     expect(config.loaded_filenames).to eq(files)
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conferrable
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.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.
@@ -36,6 +50,8 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile