conferrable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4e80fa2a3db3e61e5e423d6cfb046e28ba2d0d7
+  data.tar.gz: d831fe504d2ede66c549b5c39b22b02f932eace4
+SHA512:
+  metadata.gz: 6290b5fb9e797fa2d7c66d2539194003363eceffa79184dfa45e6f338e87ca2ef680116efd53fc0c5510fc51b14f1facd5bbd2043286d1b942e60c748359e566
+  data.tar.gz: 18d2fee082ac9e97d2627cc9b3b153744626a573f4a16d1f0675b4047b109afe7f3770e40d344c536e0c9ac0f73bac447f6599ac548e36f3f39c2d68fab111a3

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.3.7

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.3.7
+cache: bundler
+script:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    conferrable (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  conferrable!
+  rspec
+
+BUNDLED WITH
+   1.16.3

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2018 Blue Marble Payroll, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Conferrable
+
+[![Build Status](https://travis-ci.org/bluemarblepayroll/conferrable.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/conferrable)
+
+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:
+
+* Load a YAML file
+* Load a directory of YAML files
+* Load multiple YAML files
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install install conferrable
+````
+
+You can also add this to your Gemfile:
+
+````
+bundle add conferrable
+````
+
+## Examples
+
+### Simple Example
+
+Lets say we have a configuration file located at:
+
+````
+<app root>/config/config.yml.erb
+````
+
+We can access this by:
+
+````
+config = Conferrable.get_config # config will be a hash
+````
+
+### 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
+````
+
+We can now explicitly set the files:
+
+````
+files = [
+  './config/config1.yml.erb',
+  './config/config2.yml.erb',
+]
+
+Conferrable.set_filenames(:config, files)
+
+config = Conferrable.get_config # config will be a hash
+````
+
+Alternatively, we could use a directory:
+
+````
+Conferrable.set_filenames(:config, './config')
+
+config = Conferrable.get_config # config will be a hash
+````
+
+Note that the files will be loaded in alphabetical order.
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check conferrable.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/conferrable.git)
+4. Navigate to the root folder (cd conferrable)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite run:
+
+````
+rspec
+````
+
+## License
+
+This project is MIT Licensed.

data/conferrable.gemspec

@@ -0,0 +1,25 @@
+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.description = <<-EOS
+    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
+
+  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.homepage    = 'https://github.com/bluemarblepayroll/conferrale'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.1'
+
+  s.add_development_dependency('rspec')
+end

data/lib/conferrable/conferrable.rb

@@ -0,0 +1,68 @@
+#
+# 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 'yaml'
+require 'erb'
+
+require_relative 'file_utilities'
+require_relative 'configuration'
+require_relative 'file_based_configuration'
+require_relative 'entry'
+
+module Conferrable
+
+  GET_PREFIX_MATCHER_REGEX  = /^get_(.+)$/
+  GET_PREFIX_REGEX          = /^get_/
+
+  class << self
+
+    def clear!
+      @entries = {}
+
+      nil
+    end
+
+    def set_filenames(key, filenames)
+      entry(key).filenames = filenames
+    end
+
+    def [](key)
+      get(key)
+    end
+
+    def get(key)
+      entry(key).all
+    end
+
+    def entry(key)
+      clear! unless @entries
+
+      @entries[key.to_s] = Entry.new(key) unless @entries[key.to_s]
+
+      @entries[key.to_s]
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      if method_sym.to_s =~ GET_PREFIX_MATCHER_REGEX
+        get(keyify(method_sym))
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_sym, include_private = false)
+      method_sym.to_s =~ GET_PREFIX_MATCHER_REGEX || super
+    end
+
+    private
+
+    def keyify(val)
+      val.to_s.sub(GET_PREFIX_REGEX, '')
+    end
+
+  end
+end

data/lib/conferrable/configuration.rb

@@ -0,0 +1,34 @@
+#
+# 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.
+#
+
+module Conferrable
+  class Configuration
+
+    def initialize(*configs)
+      load!(configs)
+    end
+
+    def all
+      @all || {}
+    end
+
+    def load!(*configs)
+      configs.flatten.compact.each { |c| overlay(c) }
+
+      nil
+    end
+
+    private
+
+    def overlay(config)
+      @all = {} unless @all
+
+      @all.merge!(config || {})
+    end
+
+  end
+end

data/lib/conferrable/entry.rb

@@ -0,0 +1,84 @@
+#
+# 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.
+#
+
+module Conferrable
+  class Entry
+
+    class << self
+
+      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
+
+    def initialize(key, filenames: nil)
+      raise ArgumentError, 'key is required' unless key && key.to_s.length > 0
+
+      @key        = key.to_s
+      @filenames  = filenames
+    end
+
+    def filenames=(filenames)
+      protected!
+
+      @filenames = filenames
+    end
+
+    def loaded?
+      @loaded || false
+    end
+
+    def all
+      load!
+
+      @configuration&.all || {}
+    end
+
+    def loaded_filenames
+      @configuration&.loaded_filenames || []
+    end
+
+    private
+
+    def protected!
+      raise ArgumentError, "[Illegal] #{key} config store has been re-configured after it was loaded." if loaded?
+    end
+
+    def loaded!
+      @loaded = true
+    end
+
+    def load!
+      if loaded?
+        @configuration.load!
+        return
+      end
+
+      names = Array(filenames).flatten
+
+      names = [ self.class.default_file(key) ] if names.length == 0
+
+      @configuration = FileBasedConfiguration.new(names)
+
+      loaded!
+    end
+
+  end
+end

data/lib/conferrable/file_based_configuration.rb

@@ -0,0 +1,27 @@
+#
+# 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.
+#
+
+module Conferrable
+  class FileBasedConfiguration < Configuration
+
+    attr_reader :filenames, :loaded_filenames
+
+    def initialize(*filenames)
+      @filenames        = filenames.flatten
+      @loaded_filenames = FileUtilities.resolve(@filenames)
+
+      load!
+    end
+
+    def load!
+      configs = @loaded_filenames.map { |f| FileUtilities.read(f) }
+
+      super(configs)
+    end
+
+  end
+end

data/lib/conferrable/file_utilities.rb

@@ -0,0 +1,32 @@
+#
+# 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.
+#
+
+module Conferrable
+  class FileUtilities
+    class << self
+
+      def resolve(filenames)
+        Array(filenames).flatten.map do |filename|
+          next unless filename && filename.to_s.length > 0
+
+          if File.exist?(filename) && File.directory?(filename)
+            Dir.glob(File.join(filename, '**', '*.yml.erb')).select { |f| !File.directory?(f) }
+          elsif File.exist?(filename)
+            filename
+          else
+            raise ArgumentError, "Cannot find file: #{filename} => #{File.expand_path(filename)}"
+          end
+        end.flatten
+      end
+
+      def read(filename)
+        YAML.load(ERB.new(IO.read(filename)).result)
+      end
+
+    end
+  end
+end

data/lib/conferrable/version.rb

@@ -0,0 +1,10 @@
+#
+# 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.
+#
+
+module Conferrable
+  VERSION = "1.0.0"
+end

data/spec/conferrable_spec.rb

@@ -0,0 +1,62 @@
+#
+# 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 './lib/conferrable/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" }
+
+  before(:each) do
+    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
+
+  after(:each) do
+    Conferrable.clear!
+  end
+
+  it 'should load default file using brackets method' do
+    admin_value = Conferrable[:file1]['admin']
+
+    expect(admin_value).to be true
+  end
+
+  it 'should load default file using get method' do
+    admin_value = Conferrable.get(:file1)['admin']
+
+    expect(admin_value).to be true
+  end
+
+  it 'should load default file using get_* method_missing' do
+    admin_value = Conferrable.get_file1['admin']
+
+    expect(admin_value).to be true
+  end
+
+  it 'should set the filenames and load the correct file' do
+    Conferrable.set_filenames(:another_file, default_file_path)
+
+    admin_value = Conferrable.get_another_file['admin']
+
+    expect(admin_value).to be true
+  end
+
+  it 'should not allow you to change the filenames after its used the first time' do
+    admin_value = Conferrable.get_file1['admin']
+    expect(admin_value).to be true
+
+    expect do
+      Conferrable.set_filenames(:file1, 'something_else.yml.erb')
+    end.to raise_error(ArgumentError)
+  end
+
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,42 @@
+#
+# 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 './lib/conferrable/conferrable'
+
+describe Conferrable::Configuration do
+
+  it 'should accept no initialization arguments' do
+    config = Conferrable::Configuration.new
+
+    expect(config.all['doesnt_exist']).to be nil
+  end
+
+  it 'should accept multiple hashes as initialization arguments' do
+    c1 = { 'admin' => true }
+    c2 = { 'admin' => false }
+
+    config = Conferrable::Configuration.new(c1, c2)
+
+    expect(config.all['admin']).to be false
+  end
+
+  it 'should accept one hash as an initialization argument' do
+    config = Conferrable::Configuration.new('admin' => true)
+
+    expect(config.all['admin']).to be true
+  end
+
+  it 'should allow get to work with nested depths' do
+    c1 = { 'options' => { 'admin' => true } }
+    c2 = { 'options' => { 'admin' => false } }
+
+    config = Conferrable::Configuration.new(c1, c2)
+
+    expect(config.all.dig('options', 'admin')).to be false
+  end
+
+end

data/spec/entry_spec.rb

@@ -0,0 +1,31 @@
+#
+# 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 './lib/conferrable/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" }
+
+  before(:each) do
+    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
+
+  it 'should load default file' do
+    entry = Conferrable::Entry.new(:file1)
+
+    admin_value = entry.all['admin']
+
+    expect(admin_value).to be true
+  end
+
+end

data/spec/file_based_configuration_spec.rb

@@ -0,0 +1,73 @@
+#
+# 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 './lib/conferrable/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" }
+
+  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([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
+
+  it 'should allow no files' do
+    config = Conferrable::FileBasedConfiguration.new
+
+    admin_value = config.all['admin']
+
+    expect(admin_value).to be nil
+  end
+
+  it 'should load single file' do
+    config = Conferrable::FileBasedConfiguration.new(file1_path)
+
+    admin_value = config.all['admin']
+
+    expect(admin_value).to be true
+  end
+
+  it 'should load multiple files' do
+    # Test passing in an array
+    config = Conferrable::FileBasedConfiguration.new(files)
+    admin_value = config.all['admin']
+    expect(admin_value).to be false
+
+    # Test passing in multiple arguments
+    config = Conferrable::FileBasedConfiguration.new(*files)
+    admin_value = config.all['admin']
+    expect(admin_value).to be false
+
+    # Test passing in an nested arrays
+    config = Conferrable::FileBasedConfiguration.new([ [ files ] ])
+    admin_value = config.all['admin']
+    expect(admin_value).to be false
+  end
+
+  it 'should load directories' do
+    config = Conferrable::FileBasedConfiguration.new(files_path)
+    admin_value = config.all['admin']
+
+    expect(admin_value).to be false
+    expect(config.loaded_filenames).to eq(files)
+  end
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: conferrable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthew Ruggio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: |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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- conferrable.gemspec
+- lib/conferrable/conferrable.rb
+- lib/conferrable/configuration.rb
+- lib/conferrable/entry.rb
+- 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
+homepage: https://github.com/bluemarblepayroll/conferrale
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.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