cconfig 1.0.0

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    cconfig (1.0.0rc1)
+      safe_yaml (~> 1.0.0, >= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.3)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.15.1)
+      rubocop (>= 0.42.0)
+    ruby-progressbar (1.8.1)
+    safe_yaml (1.0.4)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  cconfig!
+  rake (>= 10.0)
+  rspec (>= 3.0)
+  rubocop (~> 0.49.1)
+  rubocop-rspec
+
+BUNDLED WITH
+   1.15.3

data/README.md

@@ -0,0 +1,139 @@
+# CConfig [![Build Status](https://travis-ci.org/mssola/cconfig.svg?branch=master)](https://travis-ci.org/mssola/cconfig)
+
+CConfig (Container Config) is a container-aware configuration management
+gem. This is useful for applications that want to keep a reference configuration
+and add modifications to it in two different ways:
+
+- An alternative configuration file that lists all the modifications.
+- A list of environment variables that follow a given naming policy.
+
+## Basic usage
+
+Let's assume that our application has a `config.yml` file that contains all the
+possible configurable values with their defaults:
+
+```yaml
+option:
+  enabled: true
+
+another:
+  value: 5
+```
+
+Then, you will have the following (irb prompt):
+
+```
+>> require "cconfig/cconfig"
+>> cfg = ::CConfig::Config.new(default: "config.yml", local: "", prefix: "")
+>> obj = cfg.fetch
+>> puts obj
+=> {"option"=>{"enabled"=>true}, "another"=>{"value"=>5}}
+```
+
+Moreover, this gem also adds an `enabled?` method to this hash returned by
+`#fetch`. With this method, configurable values with an `enabled` boolean value
+will have this shorthand available. For example:
+
+```
+>> obj.enabled?("option")
+=> true
+>> obj.enabled?("another")
+=> false
+```
+
+This also works for embedded configurable options. From the above example, let's
+assume that we update the `config.yml` file with these contents:
+
+```yaml
+option:
+  enabled: true
+
+  embedded:
+    enabled: false
+
+another:
+  value: 5
+```
+
+Let's also add an alternative configuration file with these contents:
+
+```yaml
+option:
+  embedded:
+    enabled: true
+```
+
+Then we have the following:
+
+```
+>> cfg = ::CConfig::Config.new(default: "config.yml", local: "config-local.yml", prefix: "")
+>> obj = cfg.fetch
+=> {"option"=>{"enabled"=>true, "embedded"=>{"enabled"=>true}}, "another"=>{"value"=>5}}
+>> obj.enabled?("option.embedded")
+=> true
+```
+
+As you can see, the contents from the `config-local.yml` file that are available
+in the `config.yml` have been overwritten.
+
+That being said, mounting a volume for changing some default values inside of a
+Docker container is a bit of an overkill. So, instead you can use **environment
+variables**. In the above example we can add an environment variable (shell prompt):
+
+```
+$ export APPLICATION_ANOTHER_VALUE=2
+```
+
+Then (irb prompt):
+
+```
+>> cfg = ::CConfig::Config.new(default: "config.yml", local: "config-local.yml", prefix: "application")
+>> cfg.fetch
+=> {"option"=>{"enabled"=>true, "embedded"=>{"enabled"=>true}}, "another"=>{"value"=>2}}
+```
+
+Moreover, the environment variable value takes precedence over the
+`config-local.yml` file.
+
+## Ruby on Rails integration
+
+This gem also provides a Railtie, so it can be better used inside of a Ruby on
+Rails application.
+
+First of all, this Railtie will initialize a global constant named `APP_CONFIG`
+automatically with the merged contents of the configuration files and
+environment variables. Some notes:
+
+- The *prefix* is taken from the Rails' application name. If you don't want
+  this, set the `CCONFIG_PREFIX` environment variable.
+- The file with the default values has to be located in `config/config.yml` from
+  your Ruby on Rails root directory. Moreover, the other file is located in
+  `config/config-local.yml`, but this can be changed by setting the
+  `#{prefix}_LOCAL_CONFIG_PATH` environment variable.
+
+Last but not least, this Railtie also offers a rake task called
+`cconfig:info`. This rake task prints to standard output the evaluated
+configuration.
+
+## License
+
+This project is based on work I did for the
+[Portus](https://github.com/SUSE/Portus) project. I've extracted my code into a
+gem so it can be also used for other projects that might be interested in this.
+
+```
+Copyright (C) 2017 Miquel Sabaté Solà <msabate@suse.com>
+
+CConfig is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+CConfig is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with CConfig.  If not, see <http://www.gnu.org/licenses/>.
+```

data/Rakefile

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+# Copyright (C) 2017 Miquel Sabaté Solà <msabate@suse.com>
+#
+# This file is part of CConfig.
+#
+# CConfig is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# CConfig is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CConfig.  If not, see <http://www.gnu.org/licenses/>.
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]
+task test: :spec

data/cconfig.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "cconfig/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cconfig"
+  spec.version       = CConfig::VERSION
+  spec.authors       = ["mssola"]
+  spec.email         = ["mssola@suse.com"]
+  spec.description   = "Configuration management for container-aware applications"
+  spec.summary       = "Configuration management for container-aware applications."
+  spec.homepage      = "https://github.com/mssola/cconfig"
+  spec.license       = "LGPL-3.0"
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.test_files    = spec.files.grep("^spec/")
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.1"
+
+  spec.add_dependency "safe_yaml", "~> 1.0.0", ">= 1.0.0"
+
+  spec.add_development_dependency "bundler", ">= 1.0.0"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.49.1"
+  spec.add_development_dependency "rubocop-rspec"
+end

data/config/rubocop-suse.yml

@@ -0,0 +1,74 @@
+# This is the shared Rubocop configuration for SUSE projects. It is maintained
+# at https://github.com/SUSE/style-guides/blob/master/rubocop-suse.yml
+#
+# The configuration is tested and used with the Rubocop version used by Hound
+# (https://houndci.com).
+#
+# We use the default Hound config as a baseline:
+#
+#   https://raw.githubusercontent.com/thoughtbot/hound/master/config/style_guides/ruby.yml
+#
+# This file contains the rules with derive from this.
+
+Lint/EndAlignment:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#lintendalignment
+  EnforcedStyleAlignWith: variable
+
+Metrics/AbcSize:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#metricsabcsize
+  Max: 30
+
+Metrics/LineLength:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#metricslinelength
+  Max: 100
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # contaning a URI to be longer than Max.
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Layout/AlignHash:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylealignhash
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/AlignParameters:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylealignparameters
+  Enabled: false
+
+Style/CollectionMethods:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylecollectionmethods
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#styleemptylinesaroundblockbody
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylemultilineoperationindentation
+  EnforcedStyle: indented
+
+Style/StringLiterals:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylestringliterals
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylestringliteralsininterpolation
+  EnforcedStyle: double_quotes
+
+Style/WordArray:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#deviations-from-the-upstream-style-guide
+  Enabled: false
+
+Style/RegexpLiteral:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#deviations-from-the-upstream-style-guide
+  Enabled: false
+
+Style/SignalException:
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  EnforcedStyle: only_raise
+
+Style/NumericLiterals:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylenumericliterals
+  Enabled: false