mc-settings 0.1.6 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32996c683ae9a0437ef3b40f2cbba22b967c69f6527e3b62ca272e48c06b8597
+  data.tar.gz: a7779f2a1334f8b0b7324fedc44209773bb50973b3f2a422a2e47b37e344a6ef
+SHA512:
+  metadata.gz: fb499eda38d18f7dc13b1f94a93c5adb8779f9c8e9875981150075c1b4f5505940b86c0b3c87a49c4805f2871c03180b9eb132398a41439e43804989f2f9697c
+  data.tar.gz: 0c08e73de2e86263ab0742e69b04725272e3fa9e42f84507c4ff9d3354460dd7c7741fb852f255c15f822a43dc34a7e298b965e9471f54aceb708866f77db00f

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Run Tests
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,45 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp
+.idea
+.rvmrc
+Gemfile.lock

data/Gemfile

@@ -1,14 +1,3 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source "https://rubygems.org"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rspec"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.1"
-  gem "rcov", ">= 0"
-  gem "ruby-debug"
-end
+gemspec

data/Gemfile.lock

@@ -1,36 +1,55 @@
+PATH
+  remote: .
+  specs:
+    mc-settings (0.2.0)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    columnize (0.3.2)
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    jeweler (1.5.1)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    linecache (0.43)
-    rake (0.8.7)
-    rcov (0.9.9)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.0)
-    rspec-expectations (2.3.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-    ruby-debug (0.10.4)
-      columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.4.0)
-    ruby-debug-base (0.10.4)
-      linecache (>= 0.3)
+    asciidoctor (2.0.10)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.1)
-  rcov
-  rspec
-  ruby-debug
+  asciidoctor
+  bundler
+  mc-settings!
+  pry-byebug
+  rake
+  rspec (~> 3.0)
+  rspec-expectations
+  rspec-mocks
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -1,20 +1,7 @@
-Copyright (c) 2010 Edwin Cruz
+Copyright 2010-2020 Edwin Cruz, Colin Shield, Konstantin Gredeskoul
 
-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:
+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 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.
+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.adoc

@@ -0,0 +1,217 @@
+= MC-Settings — An Application Settings Manager
+:toc:
+:toclevels: 4
+:sectnums:
+
+
+image:https://github.com/kigster/mc-settings/workflows/Ruby/badge.svg[Ruby,link=https://github.com/kigster/kitchen/actions?query=workflow%3ARuby]
+
+== Description
+
+This Ruby gem provides a an easy way to manage application configuration across multiple environments, such as development, QA, staging, production, etc.
+It should be compatible with Capistrano deployments.
+
+=== Background
+
+Applications typically rely on configuration settings, such as host names, URLs, usernames and many more.
+Some values change between deployment environemnts, some do not.
+
+The library assumes that application configuration is represented by a Hash of arbitrary depth, and provides a convenient and a compact syntax to access the settings through a singleton instance inside Setting class.
+
+Configuration is stored in one or more YAML files with the top-level Hash, having the keys as names of individual settings.
+
+=== Example
+
+For example, consider the following sample application configuration file:
+
+[source,yaml]
+----
+ tax:
+   default: 0.0
+   california: 7.5
+ states:
+   default:
+     - 'CA'
+     - 'WA'
+     - 'NY'
+   ship_to:
+     - 'CA'
+     - 'NY'
+ math_pi: 3.14159526
+----
+
+Setting Gem provides `Setting.load(..)` method to load configuration from files in a way that allows some configuration files to override previously loaded values, and then offers a simple method API to access the values, for example `Setting.tax(:california)` or `Setting.tax`.
+Supporting default values in 2nd, 3rd, .. - level hashes is one of the advantages of using this gem.
+
+By loading configuration from YAML files, Setting gem is inherently compatible with Capistrano deployment methodology, where a certain set of files may become "activated" by simply sym-linking them into the appropriate settings folder.
+
+Note: using example above, "1st level" hash is the one with keys `tax`, `states` and `math_pi`.
+The 2nd-level hash is, for example, the tax definition one, with keys `default` and `california`.
+
+== Usage
+
+Once configuration is initialized using `Setting#load` or `Setting#reload` methods (see below), they can be used in code in the following way:
+
+* `Setting.key_name` is optimized to return default value if available instead of a Hash.
+* `Setting.key_name(:sub_key_name)` returns a value from the 2nd level hash.
+* `Setting.key_name(:sub_key_name, :sub_sub_key_name)` returns value from the 3rd level hash if available.
++
+The algorithm is recursive, so only the maximum method stack depth will limit the number of nested hash values you can access this way.
+* Special syntax `Setting[:key_name]`, `Setting[:key_name][:sub_key_name]`, etc also supported.
+This method, however, does not support default values (see below).
+
+NOTE: Method notation is recommended over square bracket accessing single values.
+
+However, square bracket notation may be useful when you want to fetch the entire 2nd-level hash that includes the default value.
+
+For example, given the above YAML file, you can access the settings in your code as follows:
+
+[source,ruby]
+----
+Setting.tax => 0.0
+Setting.tax(:california) => 7.5
+Setting.math_pi => 3.14159526
+Setting[:math_pi] => 3.14159526
+Setting.states => [ 'CA', 'WA', 'NY' ]
+Setting.states['ship_to'] => [ 'CA', 'NY' ]
+----
+
+Method-calling notation allows passing an array of keys to fetch a value from a nested hash.
+This method also supports returning a default value, stored against the "default" key.
+
+[source,ruby]
+----
+  Setting.tax => 0.0
+----
+
+Square bracket syntax returns the actual nested hash, without any regard for the default value:
+
+[source,ruby]
+----
+Setting[:tax] => { 'default' => 0.0, 'california' => 7.5 }
+----
+
+== Loading Settings
+
+The gem should be initialized in your environment.rb (if using Rails), or in any other application initialization block. `Setting.load()` method is provided for loading settings, and it can be called only once in application life cycle, or it will throw an exception.
+
+If you need to reload settings, use the `reload()` method with similar arguments.
+
+Consider an example:
+
+[source,ruby]
+----
+Setting.load(
+  path:  "#{Rails.root}/config/settings",
+  files: ["default.yml", "environments/#{Rails.env}.yml"],
+  local: true
+)
+----
+
+The argument is an options hash that configures which YAML files to load, in what order, and from where.
+
+* *path* specifies the "root" folder where settings files will be loaded from
+* *files* is an array that lists file names relative to the path.
+* *local* can be optionally specified as a true value, and if the specified Setting gem will load all `*.yml` files that live under the :path/local folder.
+
+Below is list of YAML files loaded in order specified in the above example, assuming that "development" is the Rails environment, and "local" folder exists with 3 additional YAML files in it:
+
+  config/settings/default.yml
+  config/settings/environments/development.yml
+  config/settings/local/authorize-net.yml
+  config/settings/local/paypal.yml
+  config/settings/local/other.yml
+
+Each YML file defines a ruby Hash.
+During file loading, the hashes are merged, so that values loaded in early files may be overwritten by values in subsequent files.
+This is deliberate and by design: it allows you to create small "override" files for each environment, or even each machine you want to deploy to.
+Exactly how you split your application settings in files is up to you.
+
+=== Nested Hashes and Default Values
+
+MC Setting gem provides a convenient way to access nested values, including full support for the default values within nested hashes (as of 0.1.1).
+
+Consider the following nested hash example:
+
+*default.yml*
+
+[source,yaml]
+----
+services:
+  inventory:
+    url: http://ims.mycompany.com:3443/inventory_manager
+    name: Inventory Management
+  shipping:
+    url: http://ship.mycompany.com:3443/shipper
+    name: Shipping
+----
+
+[source,ruby]
+----
+Setting.load(:files => ['default.yml'], :path => ...)
+
+Setting.services(:inventory)
+# => {
+#   :url => "http://localhost:3443/inventory_manager",
+#   :name => "Inventory Management"
+# }
+
+Setting.services(:inventory, :url)
+# => "http://localhost:3443/inventory_manager"
+
+----
+
+*staging.yml*
+
+We are changing URLs for services in staging.yml, so they work in the staging environment. Service URLs have been updated to use localhost:
+
+[source,yaml]
+----
+services:
+  inventory:
+    url: http://localhost:8009/inventory_manager
+  shipping:
+    url: http://localhost:8008/shipper
+----
+
+[source,ruby]
+----
+Setting.load(:files => ['default.yml', 'staging.yml'], :path => ...)
+
+Setting.services(:inventory)
+# => {
+#   :url => "http://localhost:8009/inventory_manager",
+#   :name => "Inventory Management"
+# }
+
+Setting.services(:inventory, :url)
+# => "http://localhost:8008/inventory_manager"
+----
+
+== Capistrano Recommendations
+
+Assume the directory structure of your Rails application is as follows:
+
+  config/settings/default.yml
+  config/settings/environments/development.yml
+  config/settings/environments/staging.yml
+  config/settings/environments/production.yml
+  config/settings/local
+  config/settings/systems/reporting.yml
+  config/settings/systems/admin.yml
+
+Note that the "local" directory is empty, and that the "systems" directory contains several YAML files which provide alternative configuration for a reporting server and the admin server, both of which run in the "production" rails environment.
+
+When deploying to the main production site, neither YAML files inside "systems" folder are activated or used.
+
+But upon deployment to the admin server, Capistrano could symlink "admin.yml" from `config/settings/local` folder, so the Setting gem would load these values. So for each Capistrano role, you can define which files need to be symlinked into local, thus creating a flexible configuration scheme which can be easily managed by Capistrano.
+
+== Copyright
+
+Copyright 2010-2020 © ModCloth Inc & Contributors.
+
+Authors: 2010-2020 Edwin Cruz, Colin Shield & Konstantin Gredeskoul
+
+== License
+
+This software is distributed under the xref:LICENSE.txt[MIT License].

data/Rakefile

@@ -1,50 +1,29 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'timeout'
+
+def shell(*args)
+  puts "running: #{args.join(' ')}"
+  system(args.join(' '))
 end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "mc-settings"
-  gem.homepage = "http://github.com/modcloth/mc-settings"
-  gem.license = "MIT"
-  gem.summary = %Q{Manage settings per environment}
-  gem.description = %Q{implement custom keys indenendently of environment}
-  gem.email = "rubydev@modcloth.com"
-  gem.authors = ["Edwin Cruz", "Colin Shield"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+
+task :clean do
+  shell('rm -rf pkg/ tmp/ coverage/ doc/ ' )
 end
-Jeweler::RubygemsDotOrgTasks.new
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
-require 'ruby-debug'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+task gem: [:build] do
+  shell('gem install pkg/*')
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+task permissions: [:clean] do
+  shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
+  shell("find . -type d -exec chmod o+x,g+x {} \\;")
 end
 
-task :default => :spec
+task build: :permissions
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+RSpec::Core::RakeTask.new(:spec)
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "mc-settings #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task default: :spec