super_stack 0.5.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9880291db9eb16d90d3e7c467b972007cb7dbc0
-  data.tar.gz: 8c67ffc30d8061f2234900b779ba491a1c63d6e0
+  metadata.gz: 2ee62f30bb0b8ce359573f8d0c8de39392a866c3
+  data.tar.gz: 186733047be8988e51c76c09801d6ac93844b634
 SHA512:
-  metadata.gz: 94c027bd7b9bbfcb596463709789860375ade141ba2e04448facd9132c35aaab746cc991449caed3e4cb7c1b9891341ecb1bddd339286610089e84ed4b1b78de
-  data.tar.gz: 18b3971285ce46187050b100d102a4783f9bd72a3e02b7e78e677d54a41118b53ab882e86f9a0ef257ee17a2af725e3edce728ee760a42bfaa7ae3349af4b5f6
+  metadata.gz: 43db4607abd8d83241a3fb2645ec2969d3ba2e067016e31046d0ef339081fc564d99df14354d6fba6191f294d91dc45f5b4b9e2388b426086ea53dc1fe80728f
+  data.tar.gz: 67c73bd1935eccaa33ff4dbe0c634ae2339eeb0cfc9a7798330bfd541974f71419be0dd1b518d9e9dc59bfd31549bbd26f83b96c0eeea9806dca2fadb1b80040

data/README.md

@@ -54,6 +54,26 @@ puts manager[].class # =>  Hash
 puts manager.layers.class # =>  Hash
 ```
 
+:warning: Versions prior to `1.0.0` were trying to give an indifferent access to the merged hash for strings
+and symbols, ie `manager[:an_entry]` was giving the same result as `manager['an_entry']`.
+
+This is clearly wrong and not consistent everywhere.
+__Starting with version `1.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:
+
+```ruby
+require 'super_stack'
+SuperStack.set_compatibility_mode
+```
+or alternatively, you can do:
+
+```ruby
+require 'super_stack/old'
+```
+which is equivalent.
+
+
+
 ### Layers
 
 Layers are actually simple hashes that include the `SuperStack::LayerWrapper` module. Therefore you can create a layer by
@@ -142,4 +162,3 @@ The alternative is to set the policy at the layer level using `merge_policy=`
 
 [DMG]:      https://rubygems.org/gems/deep_merge        "Deep Merge gem"
 [DMGithub]: https://github.com/danielsdeleo/deep_merge  "Deep Merge Github project"
-

data/lib/super_stack/compatibility/layer_wrapper.rb

@@ -0,0 +1,23 @@
+module SuperStack
+  module Compatibility
+
+    module LayerWrapper
+
+      private
+
+      def load_from_yaml(file_name)
+        begin
+          self.replace Hash[YAML::load(File.open(file_name)).map { |k, v| [k.to_s, v] }]
+        rescue  NoMethodError => e
+          # Empty file...
+          raise "Invalid file '#{file_name}'" unless e.message =~ /false:FalseClass/
+        end
+        @file_name = file_name
+      end
+
+    end
+
+  end
+
+end
+

data/lib/super_stack/compatibility/manager.rb

@@ -0,0 +1,46 @@
+module SuperStack
+  module Compatibility
+
+    module Manager
+
+      def []=(key,value)
+        raise 'No write layer specified' if write_layer.nil?
+        write_layer[key.to_s] = value
+      end
+
+      def [](filter=nil)
+        layers = to_a
+        return [] if layers.empty?
+        layers.each { |layer| layer.reload if layer.source_auto_reload?}
+        first_layer = layers.shift
+        first_layer = first_layer.disabled? ? SuperStack::Layer.new : first_layer
+        res = layers.inject(first_layer) do |stack, layer|
+          if layer.disabled?
+            stack
+          else
+            policy_to_apply = layer.merge_policy.nil? ? default_merge_policy : layer.merge_policy
+            policy_to_apply.merge stack, stringify_keys(layer)
+          end
+        end
+        if filter.nil?
+          res.to_hash
+        else
+          res[filter]
+        end
+      end
+
+
+
+      private
+
+      def stringify_keys(hash)
+        hash.inject({}){|stringified_hash, (key, value)|
+          stringified_hash[key.to_s] = value
+          stringified_hash
+        }
+      end
+
+    end
+
+  end
+end

data/lib/super_stack/layer_wrapper.rb

@@ -74,15 +74,22 @@ module SuperStack
       hash.extend self
     end
 
+    def to_hash
+      # Trick to return a bare hash
+      {}.merge self
+    end
+
     private
 
-    def load_from_yaml(file_name)
-      begin
-        self.replace Hash[YAML::load(File.open(file_name)).map { |k, v| [k.to_s, v] }]
 
-      rescue  NoMethodError => e
-        # Empty file...
-        raise "Invalid file '#{file_name}'" unless e.message =~ /false:FalseClass/
+    def load_from_yaml(file_name)
+      raw_content = File.read file_name
+      res = YAML.load raw_content
+      if res
+        self.replace Hash[res.map { |k, v| [k, v] }]
+      else
+        raise "Invalid file content for '#{file_name}'" unless raw_content.empty?
+        clear
       end
       @file_name = file_name
     end

data/lib/super_stack/manager.rb

@@ -24,7 +24,7 @@ module SuperStack
 
     def []=(key,value)
       raise 'No write layer specified' if write_layer.nil?
-      write_layer[key.to_s] = value
+      write_layer[key] = value
     end
 
     def [](filter=nil)
@@ -38,14 +38,13 @@ module SuperStack
           stack
         else
           policy_to_apply = layer.merge_policy.nil? ? default_merge_policy : layer.merge_policy
-          policy_to_apply.merge stack, stringify_keys(layer)
+          policy_to_apply.merge stack, layer
         end
       end
       if filter.nil?
-        # Trick to return a bare hash
-        {}.merge res
+        res.to_hash
       else
-        res[filter.to_s]
+        res[filter]
       end
     end
 
@@ -102,13 +101,6 @@ module SuperStack
 
     private
 
-    def stringify_keys(hash)
-      hash.inject({}){|stringified_hash, (key, value)|
-        stringified_hash[key.to_s] = value
-        stringified_hash
-      }
-    end
-
 
     def get_existing_layer(layer_or_layer_name, error_message)
       layer_name = layer_or_layer_name.to_s if layer_or_layer_name.is_a? Symbol

data/lib/super_stack/old.rb

@@ -0,0 +1,3 @@
+require 'super_stack'
+
+SuperStack.set_compatibility_mode

data/lib/super_stack/version.rb

@@ -1,3 +1,3 @@
 module SuperStack
-  VERSION = '0.5.3'
+  VERSION = '1.0.0'
 end

data/lib/super_stack.rb

@@ -4,3 +4,19 @@ require 'super_stack/layer_wrapper'
 require 'super_stack/layer'
 require 'super_stack/manager'
 
+module SuperStack
+
+  def self.set_compatibility_mode
+    require 'super_stack/compatibility/layer_wrapper'
+    require 'super_stack/compatibility/manager'
+
+    SuperStack::Manager.class_eval do
+      include SuperStack::Compatibility::Manager
+    end
+
+    SuperStack::LayerWrapper.module_eval do
+      include SuperStack::Compatibility::LayerWrapper
+    end
+  end
+
+end

data/spec/manager_spec.rb

@@ -5,19 +5,20 @@ describe SuperStack::Manager do
   subject {described_class.new}
 
   (1..4).each do |layer_number|
-    let("layer#{layer_number}".to_sym) {
+    let("layer#{layer_number}".to_sym) do
       file_name = file_from_layer layer_number
       layer = SuperStack::Layer.new
       layer.load file_name
       layer.name = "layer#{layer_number}"
       layer
-    }
+    end
   end
-  let(:override) {
+
+  let(:override) do
     override = SuperStack::Layer.new
     override.name = :override
     override
-  }
+  end
 
 
   it 'should contain layers' do
@@ -76,13 +77,13 @@ describe SuperStack::Manager do
     expect(subject.layers.keys[1] == "#{SuperStack::Layer::DEFAULT_LAYER_NAME} #2").to be_truthy
   end
 
-  it 'should allow to reload all layers at once' do
+  it 'should provide a dynamic merge' do
     subject.add_layer layer1
     subject << {bar: :foo}
     subject.add_layer layer3
     subject.add_layer layer4
     expect(subject[:foo]).not_to eq :bar
-    subject.layers['layer3']['foo'] = :bar
+    subject.layers['layer3'][:foo] = :bar
     expect(subject[:foo]).to eq :bar
     expect(subject[:bar]).to eq :foo
     expect {subject.reload_layers}.not_to raise_error
@@ -111,9 +112,9 @@ describe SuperStack::Manager do
       subject << layer1
       subject.write_layer = override
       expect {subject[:foo] = :bar}.not_to raise_error
-      expect(subject.layers['override']['foo']).to eq :bar
+      expect(subject.layers['override'][:foo]).to eq :bar
       expect(subject[:foo]).to eq :bar
-      expect(subject['foo']).to eq :bar
+      expect(subject['foo']).not_to eq :bar
     end
 
 
@@ -147,7 +148,7 @@ describe SuperStack::Manager do
       subject.default_merge_policy = policy
       expect(subject[].is_a? Hash).to be_truthy
       policy == SuperStack::MergePolicies::KeepPolicy ?
-          expect(subject[:layer] == 'one').to(be_truthy) : expect(subject[:layer] == 'four').to(be_truthy)
+          expect(subject[:layer]).to(eq 'one') : expect(subject[:layer]).to(eq 'four')
     end
   end
 
@@ -209,10 +210,9 @@ describe SuperStack::Manager do
       subject.write_layer = :layer3
       expect(subject.write_layer).to eq layer3
       subject[:foo] = :bar
-      expect(layer3['foo']).to eq :bar
+      expect(layer3[:foo]).to eq :bar
       subject.remove_layer :layer3
       expect(subject[:foo]).not_to eq :bar
-      expect(subject['foo']).not_to eq :bar
       expect(subject.write_layer).to be_nil
     end
 
@@ -229,7 +229,7 @@ describe SuperStack::Manager do
       s
     }
 
-    it 'should not been taken in account in the merge' do
+    it 'should not be taken in account in the merge' do
       subject.disable_layer :layer3
       expect(subject[:from_layer_3]).to be_nil
       expect(subject[:from_layer_1]).not_to be_nil
@@ -297,7 +297,7 @@ describe SuperStack::Manager do
     it 'should reflect any change applied to the source' do
       subject << synced_layer
       File.open(source_file, 'a') do |f|
-        f.puts 'extra_foo: extra_bar'
+        f.puts ':extra_foo: extra_bar'
       end
       expect(subject[:extra_foo]).to eq 'extra_bar'
     end

data/spec/spec_helper.rb

@@ -16,6 +16,7 @@
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
 require 'super_stack'
+SuperStack.set_compatibility_mode
 
 
 def file_from_layer(layer_number)

data/test/layer_content_type_containing_an_array.yml

@@ -1,3 +1,4 @@
 - One
 - two
-- three
+- three
+- :four

data/test/stacked_layer_1.yml

@@ -1,9 +1,9 @@
-layer: one
+:layer: one
 
-from_layer_1:
+:from_layer_1:
   stupid-data: stupid in one
 
-to-be-merged:
+:to-be-merged:
   name: from layer 1
   my-prop: property one
   my-array:

data/test/stacked_layer_2.yml

@@ -1,9 +1,9 @@
-layer: two
+:layer: two
 
-from_layer_2:
+:from_layer_2:
   stupid-data: stupid in two
 
-to-be-merged:
+:to-be-merged:
   name: from layer 2
   my-prop: property two
   my-array:

data/test/stacked_layer_3.yml

@@ -1,9 +1,9 @@
-layer: three
+:layer: three
 
-from_layer_3:
+:from_layer_3:
   stupid-data: stupid in three
 
-to-be-merged:
+:to-be-merged:
   name: from layer 3
   my-prop: property three
   my-array:

data/test/stacked_layer_4.yml

@@ -1,9 +1,9 @@
-layer: four
+:layer: four
 
-from_layer_4:
+:from_layer_4:
   stupid-data: stupid in four
 
-to-be-merged:
+:to-be-merged:
   name: from layer 4
   my-prop: property four
   my-array:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_stack
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,6 +110,8 @@ files:
 - README.md
 - Rakefile
 - lib/super_stack.rb
+- lib/super_stack/compatibility/layer_wrapper.rb
+- lib/super_stack/compatibility/manager.rb
 - lib/super_stack/layer.rb
 - lib/super_stack/layer_wrapper.rb
 - lib/super_stack/manager.rb
@@ -118,6 +120,7 @@ files:
 - lib/super_stack/merge_policies/keep_policy.rb
 - lib/super_stack/merge_policies/override_policy.rb
 - lib/super_stack/merge_policies/standard_merge_policy.rb
+- lib/super_stack/old.rb
 - lib/super_stack/version.rb
 - spec/layer_spec.rb
 - spec/manager_spec.rb