stacked_config 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ef0fb993dbab5cbf83f2a1007c488bbce22cd2d
-  data.tar.gz: 9c106a74c466771c8d9f1513f2821e9c0c1f222a
+  metadata.gz: da24388d057ab98233e3002bb7adcc961b2b5bb9
+  data.tar.gz: cb324ce96a7a17fdd7ffdbd89d9e94eaefc08a1f
 SHA512:
-  metadata.gz: 5243d90765dd73895db3c018f3912fd244ed4bff8b0ffab16a528f3b0b5dc7fda34178a3106a89a49c598cf21757ad0cbdf99dd5f0997a1cd7e61bc758ae60f5
-  data.tar.gz: dfcddb44b6cc7116001e5d0c1d11ab7c10afb9f844b17614cf2bbfdf8479923b1fb34833d14ec070fe341878a1c930bc226e14b5fbe6b1b79824d3e8dda360c0
+  metadata.gz: 3a4b2fcf9749d4a2002f6a2004ab14caaf522b04bd622f71112673654b934c37c1fd55ed1fd8974cef1413599508b4fb2e6b85984ab3f9ce3a136a9ac080a7f2
+  data.tar.gz: ce7df61eaeb80659d44b0b3e4b7aacaef1454fa9c1391b74242fb32ee5c27cc1460368ffc91be5ae132b9d0913aae05eb794ce2f5468849b822f42259d2c4a8e

data/README.md

@@ -15,6 +15,8 @@ script. By default, it will handle already few config layers:
 * The __global layer__, which is the layer to declare options for all users that use the ruby script using this gem.
 * The __user layer__, which is the layer, where a user can set options for the ruby script using this gem.
 * The __extra layer__, which provides the possibility to specify another config file from the config itself.
+* The __enviroment variables layer__, which provides the possibility to include in the config variables coming from
+  the shell variables. See [below](#environment-variables) for more info.
 * The __command-line layer__, which provides the ability to specify options from the command line.
 * The __override layer__, which will contain all modifications done to the config at run time.
 
@@ -81,6 +83,7 @@ Every layer is accessible through the following orchestrator properties:
 * `global_layer`
 * `user_layer`
 * `provided_config_file_layer`
+* `env_layer`
 * `command_line_layer`
 * `write_layer`
 
@@ -103,7 +106,8 @@ As you can see in the sources, paths are expressed using kind of 'templates', wh
   currently executing script.
 * `##PROGRAM_NAME##` is by default the name of the script you are running (with no extension). You can if you want
   change this name at runtime. __Changing it (using the `config_file_base_name` orchestrator property ) will trigger a
-  re-search and reload of all the config files__.
+  re-search and reload of all the config files__. `config_file_base_name` defines the base name to search for config
+  files accross the system. by default the name of the gem will be used.
 * `##EXTENSION##` is one of the following extensions : `conf CONF cfg CFG yml YML yaml YAML`.
 
 The search of the config files for a layer is done according to the order defined in sources just above and then
@@ -118,6 +122,41 @@ user config level, only the first is taken in account:
 * `~/.config/my_script.conf`
 
 
+### Environment variables
+
+`stacked_config` can read information from your ENV variables thanks to the dedicated `env_layer`. __This layer is not
+ created by default__, it is up to you to add it to your application, due to the fact that you will use it mostly
+ with an optional filter and that you may want to add it with different priorities regarding your use case:
+
+```ruby
+require 'stacked_config'
+
+config = StackedConfig::Orchestrator.new
+env_layer =  StackedConfig::Layers::EnvLayer.new(optional_filter)
+config.add_layer(envLayer)
+env_layer.name = 'Environment variables level'
+env_layer.priority = 60
+```
+
+Or the exactly same using the convenience method of the orchestrator:
+
+```ruby
+require 'stacked_config'
+
+config = StackedConfig::Orchestrator.new
+config.include_env_layer(optional_filter, optional_priority)
+```
+
+Which does not prevent you changing afterwards its priority using the config's `env_layer` accessor.
+
+The constructor parameter `optional_filter` parameter aims at filtering the ENV variables:
+
+* if nil, all the ENV[] content will be added to the `env_layer`
+* it can be a single string if you want only one variable
+* it can be an array of accepted names of variables. ex: `StackedConfig::Layers::EnvLayer.new 'VAR_NAME_1'`
+  `StackedConfig::Layers::EnvLayer.new ['VAR_NAME_1', 'VAR_NAME_2']`
+* it can be a regexp that variables names have to match. ex: `StackedConfig::Layers::EnvLayer.new /somePattern/`
+
 ### Script command line options
 
 `stacked_config` uses internally the fantastic [Slop] gem to manage options coming from the command line within the

data/lib/stacked_config/layers/env_layer.rb

@@ -0,0 +1,41 @@
+module StackedConfig
+  module Layers
+
+    class EnvLayer < SuperStack::Layer
+
+      attr_reader :filter
+
+      def initialize(filter=nil)
+        self.filter = filter
+      end
+
+      def filter=(filter)
+        raise 'Invalid filter' unless [NilClass, String, Array, Regexp].include? filter.class
+        @filter = filter
+        reload
+      end
+
+      def load(*args)
+        self.replace read_filtered_environment
+        @file_name = :none
+        self
+      end
+
+      private
+
+      def read_filtered_environment
+        return ENV.to_hash if filter.nil?
+
+        if filter.is_a? Array
+          ENV.to_hash.select {|k, v| filter.include?(k) }
+        elsif  filter.is_a? Regexp
+          ENV.to_hash.select {|k, v| k =~ filter }
+        elsif filter.is_a? String
+          ENV.to_hash.select {|k, v| k == filter }
+        end
+      end
+
+    end
+
+  end
+end

data/lib/stacked_config/orchestrator.rb

@@ -3,7 +3,7 @@ module StackedConfig
 
     include StackedConfig::ProgramDescriptionHelper
 
-    attr_reader :system_layer, :global_layer, :gem_layer, :user_layer,
+    attr_reader :system_layer, :global_layer, :gem_layer, :user_layer, :env_layer,
                 :command_line_layer, :provided_config_file_layer
 
     def initialize
@@ -19,6 +19,14 @@ module StackedConfig
       File.basename($PROGRAM_NAME).gsub /\.[^\.]+$/, ''
     end
 
+    def include_env_layer(filter = nil, priority = 60)
+      @env_layer = StackedConfig::Layers::EnvLayer.new filter
+      env_layer.name = 'Environment variables level'
+      env_layer.priority = priority
+      env_layer.load
+      self << env_layer
+    end
+
     private
 
     def setup_layers

data/lib/stacked_config/source_helper.rb

@@ -12,11 +12,6 @@ module StackedConfig
         unix: '/etc'
     }
 
-    USER_CONFIG_ROOT = {
-        windows: ENV['APPDATA'],
-        unix: ENV['HOME']
-    }
-
     EXTENSIONS = %w(conf CONF cfg CFG yml YML yaml YAML)
 
     def self.os_flavour
@@ -32,7 +27,7 @@ module StackedConfig
     end
 
     def self.user_config_root
-      USER_CONFIG_ROOT[os_flavour]
+      Dir.home
     end
 
     def self.gem_config_root

data/lib/stacked_config/version.rb

@@ -1,3 +1,3 @@
 module StackedConfig
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/lib/stacked_config.rb

@@ -9,6 +9,7 @@ require 'stacked_config/layers/system_layer'
 require 'stacked_config/layers/gem_layer'
 require 'stacked_config/layers/global_layer'
 require 'stacked_config/layers/user_layer'
+require 'stacked_config/layers/env_layer'
 require 'stacked_config/layers/command_line_layer'
 require 'stacked_config/layers/provided_config_file_layer'
 require 'stacked_config/orchestrator'

data/spec/env_layer_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe StackedConfig::Layers::EnvLayer do
+
+  NIL_FILTER = nil
+  STRING_FILTER ='StackedConfig::Layers::EnvLayer::VAR1'
+  ARRAY_FILTER = %w(StackedConfig::Layers::EnvLayer::VAR1 StackedConfig::Layers::EnvLayer::VAR3)
+  REGEXP_FILTER = /StackedConfig::Layers::EnvLayer::VAR[13]/
+
+  before(:all) do
+    (1..3).each { |i| ENV["StackedConfig::Layers::EnvLayer::VAR#{i}"] = "VALUE#{i}" }
+  end
+
+  after(:all) do
+    (1..3).each { |i| ENV.delete("StackedConfig::Layers::EnvLayer::VAR#{i}") }
+  end
+
+  context 'when no filter is provided' do
+
+    it 'should contain all ENV values' do
+      layer = StackedConfig::Layers::EnvLayer.new
+      layer.load
+      expect(layer.to_a).to eq(ENV.to_hash.to_a)
+      layer = StackedConfig::Layers::EnvLayer.new NIL_FILTER
+      layer.load
+      expect(layer.to_a).to eq(ENV.to_hash.to_a)
+    end
+
+  end
+
+  context 'when a filter is provided' do
+
+    [ARRAY_FILTER, REGEXP_FILTER].each do |filter|
+
+      it "should contain filtered ENV variables according to the #{filter.class} filter" do
+        layer = StackedConfig::Layers::EnvLayer.new(filter)
+        layer.load
+        [1,3].each { |i|
+          expect(layer["StackedConfig::Layers::EnvLayer::VAR#{i}"]).to eql("VALUE#{i}")
+        }
+        expect(layer.keys.length == 2).to be_truthy
+      end
+
+    end
+
+    it 'should filter according a String if only value is requested' do
+      layer = StackedConfig::Layers::EnvLayer.new(STRING_FILTER)
+      layer.load
+      expect(layer['StackedConfig::Layers::EnvLayer::VAR1']).to eql 'VALUE1'
+      expect(layer.keys.length == 1).to be_truthy
+    end
+
+  end
+
+end

data/spec/orchestrator_spec.rb

@@ -116,5 +116,19 @@ describe StackedConfig::Orchestrator do
 
   end
 
+  it 'should not have environment variables by defaut' do
+    expect(subject.env_layer).to be_nil
+  end
+
+  context 'when including environment variables in the config' do
+
+    it 'should be accessible through the #env_layer accessor' do
+      expect {subject.include_env_layer}.not_to raise_error
+      expect(subject.env_layer).not_to be_nil
+      expect(subject.env_layer).to be_a StackedConfig::Layers::EnvLayer
+    end
+
+  end
+
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stacked_config
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-10 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ files:
 - Rakefile
 - lib/stacked_config.rb
 - lib/stacked_config/layers/command_line_layer.rb
+- lib/stacked_config/layers/env_layer.rb
 - lib/stacked_config/layers/gem_layer.rb
 - lib/stacked_config/layers/generic_layer.rb
 - lib/stacked_config/layers/global_layer.rb
@@ -127,6 +128,7 @@ files:
 - lib/stacked_config/source_helper.rb
 - lib/stacked_config/version.rb
 - spec/command_line_layer_spec.rb
+- spec/env_layer_spec.rb
 - spec/gem_layer_spec.rb
 - spec/global_layer_spec.rb
 - spec/orchestrator_spec.rb
@@ -178,6 +180,7 @@ specification_version: 4
 summary: Manages config files according to standard policy.
 test_files:
 - spec/command_line_layer_spec.rb
+- spec/env_layer_spec.rb
 - spec/gem_layer_spec.rb
 - spec/global_layer_spec.rb
 - spec/orchestrator_spec.rb