stacked_config 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e02ee146b2273b5918c9d33767b310694cebfed8
-  data.tar.gz: e4276b0fcbe9f34bd216b0a05afda2f6ad628d2f
+  metadata.gz: 1cfebc92ab8edbb67a0c07dda951492e63887963
+  data.tar.gz: c6de809414f4bf51c35d755a602cc6619eb5d490
 SHA512:
-  metadata.gz: 22af861beccd0d705a80e6c14642a0ed27f060dc3455fabe9249c0558052525ca6382e85b0338e6d4cb47af1d9698a48f96826c0a8e4f678c32db622499b7e2b
-  data.tar.gz: e6b35a76082840de8bb137a81ed4bbad1f45c37018b2d676e2d022c5cebabac823613434780e2410a501007e5c891f7400be1856f98e623027646115e20bca31
+  metadata.gz: 55be0be98df85a6f2a26a909282b9d6fbc08cd33f3baca77ade22bc08db01a51a58867b095329f00e06300352c4919ecc137f24377051f9abb754b1d74b3424e
+  data.tar.gz: 96c6f431ee050279f78fba963defcc707f52b05fa2d5b94141018791a61a6eda84d84ec1ec1e6fa0d8e833c287115da6d2bc2a96aae8abc12d4ca7b030ef87f2

data/README.md

@@ -9,11 +9,12 @@ running the application, some coming from the command line and more, __[This Gem
 The purpose of this gem is to provide a __simple__ way to handle the __inheritance__ of __config files__ for a ruby
 script. By default, it will handle already few config layers:
 
-* The __system layer__, which is a level common to all applications using this gem.
-* The __gem layer__, which is the layer that will enable a gem to embed its own config.
-* The __global layer__, which is the level to declare options for all users that use the ruby script using this gem.
-* The __user layer__, which is the level, 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 command line.
+* 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 __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 __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.
 
@@ -22,8 +23,8 @@ detail). The `StackedConfig::Orchestrator` will expose a merged view of all its
 
 All the config files are following the [YAML] syntax.
 
-__If you're looking for a complete solution for your scripts, including some logging features, then you are probably
-looking for the [easy_app_helper Gem][EAH], which is internally using [this one][SC].__
+__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].__
 
 ## Installation
 
@@ -101,7 +102,7 @@ As you can see in the sources, paths are expressed using kind of 'templates', wh
 * `##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 `executable_name` orchestrator property ) will trigger a
+  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__.
 * `##EXTENSION##` is one of the following extensions : `conf CONF cfg CFG yml YML yaml YAML`.
 
@@ -122,6 +123,8 @@ user config level, only the first is taken in account:
 `stacked_config` uses internally the fantastic [Slop] gem to manage options coming from the command line within the
 command line layer. This layer will be simply part of the complete config that the orchestrator exposes.
 
+`stacked_config` is using the v3 branch of [Slop] and has not yet been adapted to the newest v4 branch.
+
 #### Command line help
 
 You can easily display a help using the orchestrator `command_line_help` method.
@@ -226,6 +229,7 @@ end
 ```
 
 The `add_command_line_section` method supports a parameter to define the name of the section.
+Check [Slop] documentation for further information.
 
 __Of course adding new command line options will adapt the display of the `command_line_help` method of the
 orchestrator__.
@@ -233,6 +237,9 @@ orchestrator__.
 
 ## Advanced usage
 
+`stacked_config` is internally relying on the [super_stack Gem][SS] for the management of the layers, their priorities
+and the way they are merged in order to provide the "merged config". Check its documentation for further info.
+
 ### Re-ordering layers
 
 The way layers are processed is done according to their priority. By default the existing layers have the following
@@ -264,7 +271,7 @@ in those files cannot be overridden even at command line level thanks to [super_
 ### Adding extra layers
 
 Imagine you want to add a specific layer in your config, coming from let's say a web-service or a database, you may
-create your own layers for this purpose. Have a look at [super_stack gem][SS] for further info about how to create
+create your own layers for this purpose. Have a look at [super_stack Gem][SS] for further info about how to create
 layers.
 
 But basically just create your new layer, gives it a priority and add it to the orchestrator.

data/lib/stacked_config/layers/command_line_layer.rb

@@ -13,8 +13,7 @@ module StackedConfig
       def load(*args)
         slop_definition.parse
         slop_definition.banner = build_banner
-        clear
-        merge! slop_definition.to_hash.delete_if {|k,v| v.nil?}
+        replace slop_definition.to_hash.delete_if {|k,v| v.nil?}
       end
 
       def possible_options
@@ -59,7 +58,7 @@ module StackedConfig
         if manager.nil?
           'No banner unless added to a manager !'
         else
-          "\nUsage: #{manager.executable_name} [options]\n#{manager.app_name} Version: #{manager.app_version}\n\n#{manager.app_description}"
+          "\nUsage: #{manager.config_file_base_name} [options]\n#{manager.app_name} Version: #{manager.app_version}\n\n#{manager.app_description}"
         end
       end
 

data/lib/stacked_config/orchestrator.rb

@@ -10,12 +10,12 @@ module StackedConfig
       super
       self.merge_policy = SuperStack::MergePolicies::FullMergePolicy
       setup_layers
-      default_name = self.class.default_executable_name
-      describes_application executable_name: default_name, app_name: default_name
+      default_name = self.class.default_config_file_base_name
+      describes_application config_file_base_name: default_name, app_name: default_name
     end
 
 
-    def self.default_executable_name
+    def self.default_config_file_base_name
       File.basename($PROGRAM_NAME).gsub /\.[^\.]+$/, ''
     end
 

data/lib/stacked_config/program_description_helper.rb

@@ -1,15 +1,15 @@
 module StackedConfig
   module ProgramDescriptionHelper
 
-    attr_reader :executable_name, :app_name, :app_version, :app_description
+    attr_reader :config_file_base_name, :app_name, :app_version, :app_description
 
     def add_command_line_section(title='Script specific', &block)
       command_line_layer.add_command_line_section title, &block
     end
 
-    def executable_name=(executable_name)
-      return if executable_name.nil?
-      @executable_name = executable_name
+    def config_file_base_name=(config_file_base_name)
+      return if config_file_base_name.nil?
+      @config_file_base_name = config_file_base_name
       rescan_layers
       reload_layers
     end
@@ -72,7 +72,7 @@ module StackedConfig
       self.app_name = options.fetch(:app_name, nil)
       self.app_version = options.fetch(:app_version, nil)
       self.app_description = options.fetch(:app_description, nil)
-      self.executable_name = options.fetch(:executable_name, nil)
+      self.config_file_base_name = options.fetch(:config_file_base_name, nil)
     end
 
   end

data/lib/stacked_config/source_helper.rb

@@ -89,7 +89,7 @@ module StackedConfig
       res.gsub! '##SYSTEM_CONFIG_ROOT##', system_config_root
       res.gsub! '##USER_CONFIG_ROOT##', user_config_root
 
-      exec_name = manager.nil? ? StackedConfig::Orchestrator.default_executable_name : manager.executable_name
+      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

data/lib/stacked_config/version.rb

@@ -1,3 +1,3 @@
 module StackedConfig
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/gem_layer_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 
 describe StackedConfig::Layers::GemLayer do
-  # subject is a modified SystemLayer to redirect system_config_root to the test directory
+  # subject is a modified SystemLayer to redirect gem_config_root to the test directory
   subject {
     s = StackedConfig::Layers::GemLayer.new
     gem_path = File.expand_path '../..', __FILE__

data/spec/orchestrator_spec.rb

@@ -29,19 +29,19 @@ describe StackedConfig::Orchestrator do
   end
 
 
-  context 'when changing the executable_name' do
+  context 'when changing the config_file_base_name' do
 
     it 'should reload all config files' do
       expect(subject[:user_property]).not_to be_nil
       expect(subject[:weird_property]).to be_nil
-      subject.executable_name = 'weird_name'
+      subject.config_file_base_name = 'weird_name'
       expect(subject[:user_property]).to be_nil
       expect(subject[:weird_property]).not_to be_nil
     end
 
     it 'should keep the modified values' do
       subject[:modified_value] = :pipo
-      subject.executable_name = 'weird_name'
+      subject.config_file_base_name = 'weird_name'
       expect(subject[:modified_value]).not_to be_nil
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stacked_config
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-31 00:00:00.000000000 Z
+date: 2015-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler