stacked_config 0.4.2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62606ce3e0ef2d847602164f729b0054c3c9efe4
-  data.tar.gz: b8cf48ecbe204b5dc0506992f26c1436132f8693
+  metadata.gz: 4b40875c352b97a4a48b2265e2952978785af039
+  data.tar.gz: 88c153c71f5795df1d1342f03e19a1d9adf45be0
 SHA512:
-  metadata.gz: e07a261e6013213c74b124340128308c081fec41fed187a7249706a0a8f63ec3402e304f59b4a1a750635347dceb6c213a2ebd02706b471fc95937fcf7dbeabf
-  data.tar.gz: b7456c412b5c158dac0fc295976b5d2ebe89a0883ee0f67e7376fdf4a8a73b7dc0038d83c52f76533bd45a509925cc2d5c042406b26930a9281c019a5c152600
+  metadata.gz: 8ef28bf029e4b335bbf6a024ff61939c7dca489cb7602b53dbc48d57b4f7668233d2dd625e1d8cdfda734a6bf6519625f160326498c0d7a2d042cc3aacbdfe92
+  data.tar.gz: e6360ba692bb4beb230a87bc067afff6063882a5448b917a6697c20b20d210e2582b28eaa34dc658b3ad45c7a6fcb6e3379cd4377bfe6e7a36d85fdafc5dc4b4

data/README.md

@@ -10,13 +10,17 @@ The purpose of this gem is to provide a __simple__ way to handle the __inheritan
 script. By default, it will handle already few config layers:
 
 * The __system layer__, which is a layer common to all applications using this gem.
-* The __gem layer__, which is the layer that will enable a gem to embed its own config. __You may consider this level
-  as the layer where you will set the default values for your properties__.
+* The __executable gem layer__, which is the layer that will enable a script provided by a gem to embed its own default
+  config. __You may consider this level as the layer where you will set the default values for the properties of your
+  executable__. This layer will get the config from the Gem that hosts the current __executable__ running.
+* The __gem layer__, which is the layer that will enable a gem to embed its own default config. Nevertheless as it is
+  not really possible to guess automatically the name of the gem, it has to be created manually.
 * 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 shell variables. See [below](#environment-variables) for more info. This level is optional and not created by
+  default.
 * 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.
 
@@ -28,6 +32,8 @@ All the config files are following the [YAML] syntax.
 __If you're looking for a complete solution for your command line scripts, including some logging features, then you
 are probably looking for the [easy_app_helper Gem][EAH], which is itself internally relying on [stacked_config][SC].__
 
+Version 1.x introduces some minor non compatibilities with previous versions. Check [below]() for more info.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -79,7 +85,7 @@ clears the override layer.
 Every layer is accessible through the following orchestrator properties:
 
 * `system_layer`
-* `gem_layer`
+* `executable_gem_layer`
 * `global_layer`
 * `user_layer`
 * `provided_config_file_layer`
@@ -87,31 +93,25 @@ Every layer is accessible through the following orchestrator properties:
 * `command_line_layer`
 * `write_layer`
 
+The 'gem_layer' has no direct accessor as there could be more than one.
+
+
 ### Where are my config files ?
 
 `stacked_config` will look for config files in different places depending on the layer we are talking about. Have a look
 at the source to understand where exactly your config files can be, but basically it is following the Unix way of
 doing things...
 
+All file based layers are inheriting from `StackedConfig::Layers::GenericLayer`
+
 * Sources for the [system layer][SystemLayer]
+* Sources for the [executable gem layer][ExecutableGemLayer]
 * Sources for the [gem layer][GemLayer]
 * Sources for the [global layer][GlobalLayer]
 * Sources for the [user layer][UserLayer]
 
-As you can see in the sources, paths are expressed using kind of 'templates', which meaning should be obvious
-
-* `##SYSTEM_CONFIG_ROOT##` is where the system config is stored. On Unix systems, it should be `/etc`.
-* `##USER_CONFIG_ROOT##` is where the user config is stored. On Unix systems, it should be your `$HOME` directory.
-* `##GEM_CONFIG_ROOT##` is the path to the "current" Gem root. The current gem being the one containing the
-  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__. `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
-extensions are tried according to the extensions just above in that exact order.
+The search of the config files for a layer is done according to the order defined in `possible_sources` just above
+and then extensions are tried according to the extensions just above in that exact order.
 
 __The first file matching for a particular level is used ! And there can be only one per level.__
 
@@ -121,6 +121,10 @@ user config level, only the first is taken in account:
 * `~/.my_script.yml`
 * `~/.config/my_script.conf`
 
+you can get information about all files that are checked by the layers inheriting from
+`StackedConfig::Layers::GenericLayer` by using the orchestrator convenience method `detailed_config_files_info` that
+returns a hash which keys are the file names and values are hashes of information stating if the file is valid or used.
+
 
 ### Environment variables
 
@@ -298,10 +302,11 @@ The way layers are processed is done according to their priority. By default the
 priorities:
 
 * The system layer has a priority of __10__
-* The gem layer has a priority of __20__
-* The global layer has a priority of __30__
-* The user layer has a priority of __40__
-* The extra layer has a priority of __50__
+* The executable gem layer has a priority of __20__
+* The gem layer has a priority of __30__ (if exists)
+* The global layer has a priority of __40__
+* The user layer has a priority of __50__
+* The extra layer has a priority of __60__
 * The command-line layer has a priority of __100__
 * The override layer has a priority of __1000__
 
@@ -485,6 +490,13 @@ This layer contains the following data:
  ## Bye...
 ```
 
+
+## Non nackward compatible changes
+
+### Between version 0.x and 1.x
+
+TODO
+
 ## Contributing
 
 1. [Fork it] ( https://github.com/lbriais/stacked_config/fork ), clone your fork.
@@ -493,12 +505,13 @@ This layer contains the following data:
 4. Push to the branch (`git push origin my-new-feature`).
 5. Create a Pull Request.
 
-[SS]:          https://github.com/lbriais/super_stack       "Super Stack gem"
-[SC]:          https://github.com/lbriais/stacked_config    "The stacked_config Gem"
-[SystemLayer]: https://github.com/lbriais/stacked_config/blob/master/lib/stacked_config/layers/system_layer.rb "the system layer places where config files are searched"
-[GemLayer]:    https://github.com/lbriais/stacked_config/blob/master/lib/stacked_config/layers/gem_layer.rb "the gem layer places where config files are searched"
-[GlobalLayer]: https://github.com/lbriais/stacked_config/blob/master/lib/stacked_config/layers/global_layer.rb "the global layer places where config files are searched"
-[UserLayer]:   https://github.com/lbriais/stacked_config/blob/master/lib/stacked_config/layers/user_layer.rb   "the user layer places where config files are searched"
-[YAML]:        http://www.yaml.org/                         "The Yaml official site"
-[Slop]:        https://rubygems.org/gems/slop               "The Slop gem"
-[EAH]:         https://github.com/lbriais/easy_app_helper   "The EasyAppHelper gem"
+[SS]:                    https://github.com/lbriais/super_stack       "Super Stack gem"
+[SC]:                    https://github.com/lbriais/stacked_config    "The stacked_config Gem"
+[SystemLayer]:           https://github.com/lbriais/stacked_config/blob/master/lib/stacked_config/layers/system_layer.rb "the system layer places where config files are searched"
+[ExecutableGemLayer]:    https://github.com/lbriais/stacked_config/blob/master/lib/stacked_config/layers/executable_gem_layer.rb "the executable gem layer places where config files are searched"
+[GemLayer]:              https://github.com/lbriais/stacked_config/blob/master/lib/stacked_config/layers/gem_layer.rb "the gem layer places where config files are searched"
+[GlobalLayer]:           https://github.com/lbriais/stacked_config/blob/master/lib/stacked_config/layers/global_layer.rb "the global layer places where config files are searched"
+[UserLayer]:             https://github.com/lbriais/stacked_config/blob/master/lib/stacked_config/layers/user_layer.rb   "the user layer places where config files are searched"
+[YAML]:                  http://www.yaml.org/                         "The Yaml official site"
+[Slop]:                  https://rubygems.org/gems/slop               "The Slop gem"
+[EAH]:                   https://github.com/lbriais/easy_app_helper   "The EasyAppHelper gem"

data/lib/stacked_config/layers/command_line_layer.rb

@@ -13,7 +13,10 @@ module StackedConfig
       def load(*args)
         slop_definition.parse
         slop_definition.banner = build_banner
-        replace slop_definition.to_hash.delete_if {|k,v| v.nil?}
+        h = slop_definition.to_hash.delete_if {|k,v| v.nil?}
+        res = {}
+        h.each{|k,v| res[k.to_s] = v }
+        h
       end
 
       def possible_options

data/lib/stacked_config/layers/executable_gem_layer.rb

@@ -0,0 +1,45 @@
+module StackedConfig
+  module Layers
+
+    class ExecutableGemLayer < StackedConfig::Layers::GenericLayer
+
+
+      def self.executable_gem_config_root
+        return nil unless $PROGRAM_NAME
+
+        Gem.loaded_specs.each_pair do |name, spec|
+          executable_basename = File.basename($PROGRAM_NAME)
+          return spec.full_gem_path if spec.executables.include? executable_basename
+        end
+        nil
+      end
+
+      def executable_gem_config_root
+        self.class.executable_gem_config_root
+      end
+
+      def possible_sources
+        [
+            %w(##EXECUTABLE_GEM_CONFIG_ROOT## etc ##PROGRAM_NAME##.##EXTENSION##),
+            %w(##EXECUTABLE_GEM_CONFIG_ROOT## etc ##PROGRAM_NAME## config.##EXTENSION##),
+            %w(##EXECUTABLE_GEM_CONFIG_ROOT## etc ##PROGRAM_NAME## ##PROGRAM_NAME##.##EXTENSION##),
+            %w(##EXECUTABLE_GEM_CONFIG_ROOT## config ##PROGRAM_NAME##.##EXTENSION##),
+            %w(##EXECUTABLE_GEM_CONFIG_ROOT## config ##PROGRAM_NAME## config.##EXTENSION##),
+            %w(##EXECUTABLE_GEM_CONFIG_ROOT## config ##PROGRAM_NAME## ##PROGRAM_NAME##.##EXTENSION##)
+        ]
+      end
+
+      def perform_substitutions path_part
+        return nil unless executable_gem_config_root
+        res = path_part.dup
+        res.gsub! '##EXECUTABLE_GEM_CONFIG_ROOT##', executable_gem_config_root
+        exec_name = manager.nil? ? StackedConfig::Orchestrator.default_config_file_base_name : manager.config_file_base_name
+        res.gsub! '##PROGRAM_NAME##', exec_name
+        res
+      end
+
+
+    end
+
+  end
+end

data/lib/stacked_config/layers/gem_layer.rb

@@ -2,17 +2,48 @@ module StackedConfig
   module Layers
 
     class GemLayer < StackedConfig::Layers::GenericLayer
+
+      attr_reader :gem_name
+
+      def self.gem_config_root(gem_name)
+        return nil unless gem_name
+        Gem.loaded_specs.each_pair do |name, spec|
+          return spec.full_gem_path if name == gem_name
+        end
+        nil
+      end
+
+      def gem_config_root
+        self.class.gem_config_root gem_name
+      end
+
+
+      def gem_name=(gem_name)
+        @gem_name = gem_name.to_s
+        rescan
+        reload
+      end
+
       def possible_sources
         [
-            ['##GEM_CONFIG_ROOT##', 'etc', '##PROGRAM_NAME##.##EXTENSION##' ],
-            ['##GEM_CONFIG_ROOT##', 'etc', '##PROGRAM_NAME##', 'config.##EXTENSION##' ],
-            ['##GEM_CONFIG_ROOT##', 'etc', '##PROGRAM_NAME##', '##PROGRAM_NAME##.##EXTENSION##' ],
-            ['##GEM_CONFIG_ROOT##', 'config', '##PROGRAM_NAME##.##EXTENSION##' ],
-            ['##GEM_CONFIG_ROOT##', 'config', '##PROGRAM_NAME##', 'config.##EXTENSION##' ],
-            ['##GEM_CONFIG_ROOT##', 'config', '##PROGRAM_NAME##', '##PROGRAM_NAME##.##EXTENSION##' ]
+            %w(##GEM_CONFIG_ROOT## etc ##GEM_NAME##.##EXTENSION##),
+            %w(##GEM_CONFIG_ROOT## etc ##GEM_NAME## config.##EXTENSION##),
+            %w(##GEM_CONFIG_ROOT## etc ##GEM_NAME## ##GEM_NAME##.##EXTENSION##),
+            %w(##GEM_CONFIG_ROOT## config ##GEM_NAME##.##EXTENSION##),
+            %w(##GEM_CONFIG_ROOT## config ##GEM_NAME## config.##EXTENSION##),
+            %w(##GEM_CONFIG_ROOT## config ##GEM_NAME## ##GEM_NAME##.##EXTENSION##)
         ]
       end
 
+      def perform_substitutions path_part
+        return nil unless gem_config_root
+        res = path_part.dup
+        res.gsub! '##GEM_CONFIG_ROOT##', gem_config_root
+        res.gsub! '##GEM_NAME##', gem_name if self.respond_to? :gem_name
+        res
+      end
+
+
     end
 
   end

data/lib/stacked_config/layers/generic_layer.rb

@@ -13,6 +13,49 @@ module StackedConfig
         rescan
       end
 
+      def possible_config_files(places=possible_sources)
+        result = {}
+        already_found = false
+        browse_files(places) do |file|
+          exists = File.readable?(file)
+          used = false
+          already_found = used = true if exists and not already_found
+          result[file] = {
+              exists: exists,
+              used: used,
+              layer: [name]
+          }
+        end
+        result
+      end
+
+      private
+
+      def set_config_file(places)
+        @file_name = nil
+        browse_files(places) do |file|
+          if File.readable? file
+            @file_name = file
+            return @file_name
+          end
+        end
+      end
+
+      def browse_files(places, &block)
+        places.each do |path_array|
+          begin
+            potential_config_file = File.join(path_array.map { |path_part| perform_substitutions path_part })
+          rescue
+            # do nothing
+          end
+          return unless potential_config_file
+          EXTENSIONS.each do |extension|
+            file  = potential_config_file.gsub '##EXTENSION##', extension
+            yield file
+          end
+        end
+      end
+
     end
 
   end

data/lib/stacked_config/layers/global_layer.rb

@@ -1,7 +1,7 @@
 module StackedConfig
   module Layers
 
-    class GlobalLayer < StackedConfig::Layers::GenericLayer
+    class GlobalLayer < StackedConfig::Layers::SystemLayer
       def possible_sources
         [
             ['##SYSTEM_CONFIG_ROOT##', '##PROGRAM_NAME##.##EXTENSION##' ],
@@ -10,7 +10,19 @@ module StackedConfig
         ]
       end
 
+      def perform_substitutions(path_part)
+        res = path_part.dup
+        res.gsub! '##SYSTEM_CONFIG_ROOT##', system_config_root
+
+        exec_name = manager.nil? ? StackedConfig::Orchestrator.default_config_file_base_name : manager.config_file_base_name
+        res.gsub! '##PROGRAM_NAME##', exec_name
+
+        res
+      end
+
     end
 
+
+
   end
 end

data/lib/stacked_config/layers/system_layer.rb

@@ -2,6 +2,21 @@ module StackedConfig
   module Layers
 
     class SystemLayer < StackedConfig::Layers::GenericLayer
+
+      SYSTEM_CONFIG_ROOT = {
+          windows: [File.join(ENV['systemRoot'] || '', 'Config')],
+          unix: '/etc'
+      }
+
+      def self.system_config_root
+        SYSTEM_CONFIG_ROOT[os_flavour]
+      end
+
+      def system_config_root
+        self.class.system_config_root
+      end
+
+
       def possible_sources
         [
             ['##SYSTEM_CONFIG_ROOT##', 'stacked_config.##EXTENSION##' ],
@@ -9,6 +24,13 @@ module StackedConfig
         ]
       end
 
+      def perform_substitutions path_part
+        res = path_part.dup
+        res.gsub! '##SYSTEM_CONFIG_ROOT##', system_config_root
+        res
+      end
+
+
     end
 
   end

data/lib/stacked_config/layers/user_layer.rb

@@ -3,6 +3,16 @@ module StackedConfig
 
     class UserLayer < StackedConfig::Layers::GenericLayer
 
+
+      def self.user_config_root
+        Dir.home
+      end
+
+      def user_config_root
+        self.class.user_config_root
+      end
+
+
       def possible_sources
         [
             ['##USER_CONFIG_ROOT##', '.##PROGRAM_NAME##.##EXTENSION##' ],
@@ -14,6 +24,16 @@ module StackedConfig
         ]
       end
 
+      def perform_substitutions path_part
+        res = path_part.dup
+        res.gsub! '##USER_CONFIG_ROOT##', user_config_root
+
+        exec_name = manager.nil? ? StackedConfig::Orchestrator.default_config_file_base_name : manager.config_file_base_name
+        res.gsub! '##PROGRAM_NAME##', exec_name
+
+        res
+      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, :env_layer,
+    attr_reader :system_layer, :global_layer, :executable_gem_layer, :user_layer, :env_layer,
                 :command_line_layer, :provided_config_file_layer
 
     def initialize
@@ -19,13 +19,22 @@ module StackedConfig
       File.basename($PROGRAM_NAME).gsub /\.[^\.]+$/, ''
     end
 
-    def include_env_layer(filter = nil, priority = 60)
+    def include_env_layer(filter = nil, priority = 70)
       @env_layer = StackedConfig::Layers::EnvLayer.new filter
       env_layer.name = 'Environment variables level'
       env_layer.priority = priority
       self << env_layer
     end
 
+    def include_gem_layer_for(gem_name, priority = 30)
+      gem_layer  = StackedConfig::Layers::GemLayer.new
+      gem_layer.gem_name = gem_name
+      raise "No config found in gem #{gem_name}" if gem_layer.file_name.nil?
+      gem_layer.name = "#{gem_name} Gem configuration level"
+      gem_layer.priority = priority
+      self << gem_layer
+    end
+
     private
 
     def setup_layers
@@ -35,17 +44,17 @@ module StackedConfig
       # The system level
       @system_layer = setup_layer StackedConfig::Layers::SystemLayer, 'System-wide configuration level', 10
 
-      # The gem level
-      @gem_layer = setup_layer StackedConfig::Layers::GemLayer, 'Gem configuration level', 20
+      # The executable gem level
+      @executable_gem_layer = setup_layer StackedConfig::Layers::ExecutableGemLayer, 'Gem associated to the executable running configuration level', 20
 
       # The global level
-      @global_layer = setup_layer StackedConfig::Layers::GlobalLayer, 'Global configuration level', 30
+      @global_layer = setup_layer StackedConfig::Layers::GlobalLayer, 'Global configuration level', 40
 
       # The user level
-      @user_layer = setup_layer StackedConfig::Layers::UserLayer, 'User configuration level', 40
+      @user_layer = setup_layer StackedConfig::Layers::UserLayer, 'User configuration level', 50
 
       # The specifically provided config file level
-      @provided_config_file_layer = setup_layer StackedConfig::Layers::ProvidedConfigFileLayer, 'Specific config file configuration level', 50
+      @provided_config_file_layer = setup_layer StackedConfig::Layers::ProvidedConfigFileLayer, 'Specific config file configuration level', 60
 
       # The layer to write something
       override_layer = setup_layer SuperStack::Layer, 'Overridden configuration level', 1000

data/lib/stacked_config/program_description_helper.rb

@@ -64,6 +64,16 @@ module StackedConfig
       info.join "\n"
     end
 
+    def detailed_config_files_info
+      merger = SuperStack::Manager.new
+      merger.merge_policy = SuperStack::MergePolicies::FullMergePolicy
+      layers.values.each do |layer|
+        merger << layer.possible_config_files if layer.respond_to? :possible_config_files
+      end
+      merger[]
+    end
+
+
     def command_line_help
       command_line_layer.help
     end

data/lib/stacked_config/source_helper.rb

@@ -7,97 +7,38 @@ module StackedConfig
     }
     DEFAULT_OS_FLAVOUR = :unix
 
-    SYSTEM_CONFIG_ROOT = {
-        windows: [File.join(ENV['systemRoot'] || '', 'Config')],
-        unix: '/etc'
-    }
 
     EXTENSIONS = %w(conf CONF cfg CFG yml YML yaml YAML)
 
-    def self.os_flavour
-      OS_FLAVOURS[RbConfig::CONFIG['target_os'].to_sym] || DEFAULT_OS_FLAVOUR
-    end
-
-    def self.supported_oses
-      OS_FLAVOURS.values.sort.uniq
-    end
-
-    def self.system_config_root
-      SYSTEM_CONFIG_ROOT[os_flavour]
-    end
-
-    def self.user_config_root
-      Dir.home
+    def self.included(base)
+      base.extend ClassMethods
     end
 
-    def self.gem_config_root
-      return nil unless $PROGRAM_NAME
+    module ClassMethods
+      def os_flavour
+        StackedConfig::SourceHelper.os_flavour
+      end
 
-      Gem.loaded_specs.each_pair do |name, spec|
-        executable_basename = File.basename($PROGRAM_NAME)
-        return spec.full_gem_path if spec.executables.include? executable_basename
+      def supported_oses
+        StackedConfig::SourceHelper.supported_oses
       end
-      nil
     end
 
-    def gem_config_root
-      StackedConfig::SourceHelper.gem_config_root
+    def self.os_flavour
+      OS_FLAVOURS[RbConfig::CONFIG['target_os'].to_sym] || DEFAULT_OS_FLAVOUR
     end
 
-    def supported_oses
-      StackedConfig::SourceHelper.supported_oses
+    def self.supported_oses
+      OS_FLAVOURS.values.sort.uniq
     end
 
     def os_flavour
-      @os_flavour ||= StackedConfig::SourceHelper.os_flavour
-    end
-
-    def system_config_root
-      StackedConfig::SourceHelper.system_config_root
-    end
-
-    def user_config_root
-      StackedConfig::SourceHelper.user_config_root
-    end
-
-    def set_config_file(places)
-      @file_name = nil
-      places.each do |path_array|
-        # Perform path substitutions
-        begin
-          potential_config_file = File.join(path_array.map { |path_part| perform_substitutions path_part })
-        rescue
-          #do nothing
-        end
-        return unless potential_config_file
-        # Try to find config file with extension
-        EXTENSIONS.each do |extension|
-          file  = potential_config_file.gsub '##EXTENSION##', extension
-          if File.readable? file
-            @file_name = file
-            return @file_name
-          end
-        end
-      end
+      @os_flavour ||= self.class.os_flavour
     end
 
-
-
-    def perform_substitutions path_part
-      res = path_part.dup
-      res.gsub! '##SYSTEM_CONFIG_ROOT##', system_config_root
-      res.gsub! '##USER_CONFIG_ROOT##', user_config_root
-
-      exec_name = manager.nil? ? StackedConfig::Orchestrator.default_config_file_base_name : manager.config_file_base_name
-      res.gsub! '##PROGRAM_NAME##', exec_name
-      if res =~ /##GEM_CONFIG_ROOT##/
-        return nil unless gem_config_root
-        res.gsub! '##GEM_CONFIG_ROOT##', gem_config_root
-      end
-
-      res
+    def supported_oses
+      self.class.supported_oses
     end
 
-
   end
 end

data/lib/stacked_config/version.rb

@@ -1,3 +1,3 @@
 module StackedConfig
-  VERSION = '0.4.2'
+  VERSION = '1.0.2'
 end

data/lib/stacked_config.rb

@@ -6,6 +6,7 @@ require 'stacked_config/source_helper'
 require 'stacked_config/program_description_helper'
 require 'stacked_config/layers/generic_layer'
 require 'stacked_config/layers/system_layer'
+require 'stacked_config/layers/executable_gem_layer'
 require 'stacked_config/layers/gem_layer'
 require 'stacked_config/layers/global_layer'
 require 'stacked_config/layers/user_layer'

data/spec/env_layer_spec.rb

@@ -46,6 +46,15 @@ describe StackedConfig::Layers::EnvLayer do
       expect(layer.keys.length == 1).to be_truthy
     end
 
+    [NIL_FILTER, STRING_FILTER, ARRAY_FILTER, REGEXP_FILTER].each do |filter|
+      it "should be the same to provide a #{filter.class} filter to the constructor or afterwards" do
+        layer1 = StackedConfig::Layers::EnvLayer.new(filter)
+        layer2 = StackedConfig::Layers::EnvLayer.new
+        layer2.filter = filter
+        expect(layer1).to eq layer2
+      end
+    end
+
   end
 
-end
+end

data/spec/executable_gem_layer_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+
+describe StackedConfig::Layers::ExecutableGemLayer do
+  # subject is a modified ExecutableGemLayer to redirect executable_gem_config_root to the test directory
+  subject {
+    s = StackedConfig::Layers::ExecutableGemLayer.new
+    gem_path = File.expand_path '../..', __FILE__
+    allow(s).to receive(:executable_gem_config_root) {File.join(gem_path, 'test', 'tstgem') }
+    s.rescan
+    s
+  }
+
+  it 'should provide an executable gem config root' do
+    expect(subject.executable_gem_config_root).to_not be_nil
+  end
+
+  it 'should return the path of the first matching config file it found' do
+    expect(subject.file_name).not_to be_nil
+  end
+
+
+end

data/spec/gem_layer_spec.rb

@@ -2,15 +2,19 @@ require 'spec_helper'
 
 
 describe StackedConfig::Layers::GemLayer do
-  # subject is a modified SystemLayer to redirect gem_config_root to the test directory
+  # subject is a modified GemLayer to redirect gem_config_root to the test directory
   subject {
     s = StackedConfig::Layers::GemLayer.new
     gem_path = File.expand_path '../..', __FILE__
     allow(s).to receive(:gem_config_root) {File.join(gem_path, 'test', 'tstgem') }
-    s.rescan
+    s.gem_name = 'tstgem'
     s
   }
 
+  it 'should provide a gem config root' do
+    expect(subject.gem_config_root).to_not be_nil
+  end
+
   it 'should return the path of the first matching config file it found' do
     expect(subject.file_name).not_to be_nil
   end

data/spec/global_layer_spec.rb

@@ -14,6 +14,10 @@ describe StackedConfig::Layers::GlobalLayer do
     s
   }
 
+  it 'should provide a system config root' do
+    expect(subject.system_config_root).to_not be_nil
+  end
+
   it 'should return the path of the first matching config file it found' do
     expect(subject.file_name).not_to be_nil
   end
@@ -25,9 +29,9 @@ describe StackedConfig::Layers::GlobalLayer do
   end
 
   it 'should enable to load the file' do
-    expect(subject[:an_array]).to be_nil
+    expect(subject['an_array']).to be_nil
     subject.load
-    expect(subject[:an_array]).to be_an Array
+    expect(subject['an_array']).to be_an Array
   end
 
 

data/spec/orchestrator_spec.rb

@@ -7,13 +7,13 @@ describe StackedConfig::Orchestrator do
     # Patching SourceHelper to find test config files in this gem test directory instead of from the system.
     os = StackedConfig::SourceHelper.os_flavour
     gem_path = File.expand_path '../..', __FILE__
-    altered_sys_conf_root = File.join gem_path, 'test', os.to_s, StackedConfig::SourceHelper::SYSTEM_CONFIG_ROOT[os]
+    altered_sys_conf_root = File.join gem_path, 'test', os.to_s, StackedConfig::Layers::SystemLayer::SYSTEM_CONFIG_ROOT[os]
     altered_user_conf_root = File.join gem_path, 'test', 'user'
     altered_gem_conf_root = File.join(gem_path, 'test', 'tstgem')
 
-    allow(StackedConfig::SourceHelper).to receive(:system_config_root) { altered_sys_conf_root }
-    allow(StackedConfig::SourceHelper).to receive(:user_config_root) { altered_user_conf_root }
-    allow(StackedConfig::SourceHelper).to receive(:gem_config_root) { altered_gem_conf_root }
+    allow(StackedConfig::Layers::SystemLayer).to receive(:system_config_root) { altered_sys_conf_root }
+    allow(StackedConfig::Layers::UserLayer).to receive(:user_config_root) { altered_user_conf_root }
+    allow(StackedConfig::Layers::ExecutableGemLayer).to receive(:executable_gem_config_root) { altered_gem_conf_root }
 
     StackedConfig::Orchestrator.new
   }
@@ -53,8 +53,8 @@ describe StackedConfig::Orchestrator do
       expect(subject.system_layer).to be subject.to_a.first
     end
 
-    it 'should have the gem layer evaluated in second' do
-      expect(subject.gem_layer).to be subject.to_a[1]
+    it 'should have the executable gem layer evaluated in second' do
+      expect(subject.executable_gem_layer).to be subject.to_a[1]
     end
 
     it 'should have the global layer evaluated in third' do
@@ -130,5 +130,28 @@ describe StackedConfig::Orchestrator do
 
   end
 
+  context 'when adding a gem config in the config' do
+
+    it 'should insert the new layer with a default priority of 30' do
+      gem_path = File.expand_path '../..', __FILE__
+      allow(StackedConfig::Layers::GemLayer).to receive(:gem_config_root) do |gem_name|
+        File.join(gem_path, 'test', gem_name.to_s)
+      end
+      expect {subject.include_gem_layer_for :tstgem}.not_to raise_error
+    end
+
+  end
+
+  it 'should give info about where files are searched' do
+    info = subject.detailed_config_files_info
+    expect(info).to be_a Hash
+    found_files = info.keys.map { |file| File.readable?(file) ? file : nil}.compact
+    expect(found_files.length).to be 4
+    found_files.each do |file|
+      expect(info[file][:exists]).to be_truthy
+      expect(info[file][:used]).to be_truthy
+    end
+
+  end
 
 end

data/spec/source_helper_spec.rb

@@ -3,24 +3,14 @@ require 'spec_helper'
 
 describe StackedConfig::SourceHelper do
 
-  subject {
-    s = Object.new
-    s.extend StackedConfig::SourceHelper
-    s
-  }
+  subject {StackedConfig::SourceHelper }
 
   it 'should provide an OS flavour' do
     expect(subject.os_flavour).to_not be_nil
+    # s = Object.new
+    # s.extend subject
+    # expect(s.os_flavour).to_not be_nil
   end
 
-  it 'should provide a system config root' do
-    expect(subject.system_config_root).to_not be_nil
-  end
-
-  it 'should provide a user config root' do
-    expect(subject.user_config_root).to_not be_nil
-  end
-
-
 end
 

data/spec/system_layer_spec.rb

@@ -14,6 +14,11 @@ describe StackedConfig::Layers::SystemLayer do
     s
   }
 
+  it 'should provide a system config root' do
+    expect(subject.system_config_root).to_not be_nil
+  end
+
+
   it 'should return the path of the first matching config file it found' do
     expect(subject.file_name).not_to be_nil
   end
@@ -25,11 +30,12 @@ describe StackedConfig::Layers::SystemLayer do
   end
 
   it 'should enable to load the file' do
-    expect(subject[:stacked_config_copyright]).to be_nil
+    expect(subject['stacked_config_copyright']).to be_nil
     subject.load
-    expect(subject[:stacked_config_copyright]).not_to be_nil
+    expect(subject['stacked_config_copyright']).not_to be_nil
   end
 
 
 
+
 end

data/spec/user_layer_spec.rb

@@ -13,6 +13,10 @@ describe StackedConfig::Layers::UserLayer do
     s
   }
 
+  it 'should provide a user config root' do
+    expect(subject.user_config_root).to_not be_nil
+  end
+
   it 'should return the path of the first matching config file it found' do
     expect(subject.file_name).not_to be_nil
   end
@@ -24,9 +28,9 @@ describe StackedConfig::Layers::UserLayer do
   end
 
   it 'should enable to load the file' do
-    expect(subject[:an_array]).to be_nil
+    expect(subject['an_array']).to be_nil
     subject.load
-    expect(subject[:an_array]).to be_an Array
+    expect(subject['an_array']).to be_an Array
   end
 
 

data/stacked_config.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_dependency 'super_stack', '~> 0.2', '>= 0.2.5', '< 0.4'
+  spec.add_dependency 'super_stack', '~> 0.4'
   spec.add_dependency 'slop', '~> 3.0'
 
 end

data/test/tstgem/config/rspec.yml

@@ -4,4 +4,4 @@
 
 gem_property: foo
 an_array:
-  - something super weird (at gem level)
+  - something super weird (at executable gem level)

data/test/tstgem/config/tstgem.yml

@@ -0,0 +1,7 @@
+# This is supposed to be a file at "user" level.
+# It is dedicated to configuration for this particular user running the program rspec.
+# To be used at user level
+
+gem_property: foo
+an_array:
+  - something super weird (at gem level)

data/test/tstgem/spec/global_spec.rb

@@ -4,8 +4,8 @@ require 'spec_helper'
 describe 'Using stacked_config within a gem' do
 
 	it 'should detect we are in a gem' do
-		expect(StackedConfig::SourceHelper.gem_config_root).to_not be_nil
-		expect(StackedConfig::SourceHelper.gem_config_root =~ /rspec-core/).to be_truthy
+		expect(StackedConfig::SourceHelper.executable_gem_config_root).to_not be_nil
+		expect(StackedConfig::SourceHelper.executable_gem_config_root =~ /rspec-core/).to be_truthy
 	end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stacked_config
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 1.0.2
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,12 +71,6 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.2.5
-    - - <
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
@@ -84,12 +78,6 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.2.5
-    - - <
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
@@ -123,6 +111,7 @@ files:
 - lib/stacked_config.rb
 - lib/stacked_config/layers/command_line_layer.rb
 - lib/stacked_config/layers/env_layer.rb
+- lib/stacked_config/layers/executable_gem_layer.rb
 - lib/stacked_config/layers/gem_layer.rb
 - lib/stacked_config/layers/generic_layer.rb
 - lib/stacked_config/layers/global_layer.rb
@@ -135,6 +124,7 @@ files:
 - lib/stacked_config/version.rb
 - spec/command_line_layer_spec.rb
 - spec/env_layer_spec.rb
+- spec/executable_gem_layer_spec.rb
 - spec/gem_layer_spec.rb
 - spec/global_layer_spec.rb
 - spec/orchestrator_spec.rb
@@ -151,6 +141,7 @@ files:
 - test/tstgem/README.md
 - test/tstgem/Rakefile
 - test/tstgem/config/rspec.yml
+- test/tstgem/config/tstgem.yml
 - test/tstgem/lib/tstgem.rb
 - test/tstgem/lib/tstgem/version.rb
 - test/tstgem/spec/global_spec.rb
@@ -180,13 +171,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.0.0
 signing_key: 
 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/executable_gem_layer_spec.rb
 - spec/gem_layer_spec.rb
 - spec/global_layer_spec.rb
 - spec/orchestrator_spec.rb
@@ -202,6 +194,7 @@ test_files:
 - test/tstgem/README.md
 - test/tstgem/Rakefile
 - test/tstgem/config/rspec.yml
+- test/tstgem/config/tstgem.yml
 - test/tstgem/lib/tstgem.rb
 - test/tstgem/lib/tstgem/version.rb
 - test/tstgem/spec/global_spec.rb