stacked_config 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aaad69a751d17f8def42463072c1bf81b2ebe779
-  data.tar.gz: f2d3f33efdc46e9a4249be7e36b4406e63bfc9fd
+  metadata.gz: 74648d28f29b32a2a3fcdd704abeafc0219c94c4
+  data.tar.gz: f0946ee3a28f3e74ddbb84a0cac5790a1e52ae40
 SHA512:
-  metadata.gz: cabb5f83ec75cb1591301164d65c1ecc6ec3f1039b68335f924b81fb40e67a32c49b94f0105e05a0079dc4c8183a4c0495992d625e1d98ed4ab25145c06b9059
-  data.tar.gz: 051e389cbd48edab3d57bea46eb747095eae4e5658ff9a220668fab4dad22cca63bf615db4be879ef7f5ee4024981a953e65c560c0b1ac9ddbe462ea33c86ccf
+  metadata.gz: d0ed84faad7ef2cd9de6e93b1afa0989a8241ad49978d95734005056bb499d80bf9d8a34fee1c423d624f615ac9ba8bbb82dd6e9d8c4a95b238fa5760c0b8272
+  data.tar.gz: 3f2893a1d9ebcf9b4863edd1b27882022c17ecf8b5bf9c3f2cc8e6d0574626d4425b77ba3b7b78ad3a98c8edbb3a26ca14488fc23114e9b802c68609fc5c9e02

data/README.md

@@ -32,6 +32,9 @@ 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 2.x introduces  non compatibilities with previous versions. Check [below]
+(#between-version-1x-and-2x) for more info.
+
 Version 1.x introduces some minor non compatibilities with previous versions. Check [below]
 (#between-version-0x-and-1x) for more info.
 
@@ -494,6 +497,55 @@ This layer contains the following data:
 
 ## Non backward compatible changes
 
+### Between version 1.x and 2.x
+
+Versions 1.x of this gem were relying on the [super_stack][SS] 0.x, whereas versions 2.x are actually
+relying on the [super_stack][SS] 1.x. The reason why this gem bumps to 2.x is because of non-backward
+compatible features it introduces.
+
+Basically it is about clarifying some inconsistencies on how to access the merged tree. Previously for
+the first level (roots) you could access a value using indifferently a symbol or a string as a key,
+ie `manager[:an_entry]` was giving the same result as `manager['an_entry']`.
+
+This was clearly wrong and not consistent everywhere.
+__Starting with version `2.0.0` this is no more the case__. Nevertheless a compatibility mode is provided for 
+applications relying on the legacy mechanism, you just need to do __just after requiring this gem__:
+
+```ruby
+require 'stacked_config'
+SuperStack.set_compatibility_mode
+```
+
+Of course, if you don't want to use this compatibility mode, this may have an impact on you. As if in 
+your code you where using this feature, you either need to change your code or your config files. (to
+access a yaml property as symbol you need to declare it with a leading colon). 
+
+For example, the following config file:
+
+```yaml
+my_property: a value
+an_array:
+  - value 1
+  - value 2
+```
+Could be rewritten as 
+
+```yaml
+:my_property: a value
+:an_array:
+  - value 1
+  - value 2
+```
+and then if you were accessing my_property in your code using `config[:my_property]`, you won't need
+to change your code without even activating the compatibility mode.
+
+Actually depending on your case, you may want to:
+
+* Adapt your code to the new version without compatibility mode
+* Adapt your config files to the new version without compatibility mode
+* Use the new version in compatibility mode
+* Keep the old version
+
 ### Between version 0.x and 1.x
 
 The Gem layer has not really the same meaning as in version 0.x. In the v1.x it corresponds to the

data/lib/stacked_config/version.rb

@@ -1,3 +1,3 @@
 module StackedConfig
-  VERSION = '1.2.2'
+  VERSION = '2.0.0'
 end

data/spec/global_layer_spec.rb

@@ -29,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/system_layer_spec.rb

@@ -30,9 +30,9 @@ 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
 
 

data/spec/user_layer_spec.rb

@@ -28,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'
 
-  spec.add_dependency 'super_stack', '~> 0.5'
+  spec.add_dependency 'super_stack', '~> 1.0'
   spec.add_dependency 'slop', '~> 3.0'
 
 end

data/test/specific.yml

@@ -1,6 +1,6 @@
 # This is supposed to be a file loaded using the config-file command line option.
 # It is dedicated to configuration for this particular user running the program.
 
-specific_property: foo
-an_array:
+:specific_property: foo
+:an_array:
   - something very specific

data/test/tstgem/config/rspec.yml

@@ -2,6 +2,6 @@
 # It is dedicated to configuration for this particular user running the program rspec.
 # To be used at user level
 
-gem_property: foo
-an_array:
+:gem_property: foo
+:an_array:
   - something super weird (at executable gem level)

data/test/tstgem/config/tstgem.yml

@@ -2,6 +2,6 @@
 # It is dedicated to configuration for this particular user running the program rspec.
 # To be used at user level
 
-gem_property: foo
-an_array:
+:gem_property: foo
+:an_array:
   - something super weird (at gem level)

data/test/unix/etc/rspec/rspec.yml

@@ -2,7 +2,7 @@
 # It is dedicated to configuration for all users running the program rspec
 # To be used at administrator level only
 
-global_property: foo
-an_array:
+:global_property: foo
+:an_array:
   - defined at global level
   - pretty cool (global)

data/test/unix/etc/stacked_config.yml

@@ -2,5 +2,5 @@
 # It is dedicated to configuration for all gems that would use the stacked_config gem.
 # To be used at administrator level only
 
-stacked_config_copyright: (c)2014 L.Briais under MIT license
-system_property: foo
+:stacked_config_copyright: (c)2014 L.Briais under MIT license
+:system_property: foo

data/test/user/.config/rspec.yml

@@ -2,6 +2,6 @@
 # It is dedicated to configuration for this particular user running the program rspec.
 # To be used at user level
 
-user_property: foo
-an_array:
+:user_property: foo
+:an_array:
   - something weird (at user level)

data/test/user/.config/weird_name.yml

@@ -2,4 +2,4 @@
 # It is dedicated to configuration for this particular user running the program rspec.
 # To be used at user level
 
-weird_property: Defined in 'weird_name' config file.
+:weird_property: Defined in 'weird_name' config file.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stacked_config
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-09 00:00:00.000000000 Z
+date: 2016-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement