super_stack 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f195f8d4912d140d7a3932c3d24d1a2ed4489452
-  data.tar.gz: 8eded758dd34c83dd1ded7cbf7209919d372a8ec
+  metadata.gz: 54cbe4ddd3ce5e7164c09042f75841a327cd1a1c
+  data.tar.gz: a01f72c6e8ab135e13cf12d0f9662e1bfa6c75fc
 SHA512:
-  metadata.gz: f6edf0b4ccdabef1b6cddf821f5db017bdb52e306cde0f01e5c88d5f2799b5f8ce40743aa8ecdda4375b24a1095c03519f1415332a345d8cbcede947fcd2c141
-  data.tar.gz: 75881f18d92264c18dc6f6396ec703fb7a2289cd866f220bb39c013b141024acfed260890eb59c752144218ed9212065fa59cca3dea2d6196f27f2b9f0add0a5
+  metadata.gz: 771fcfb537611679e55a5fc36c14755ee276f71f3261190245b9299e54ec1f7fa460676f1e5a80056aa673ae9fcc9e9ab438850dd8a02c88bd3fc3aa4f64a83f
+  data.tar.gz: b9a855e2c8e20d9e15181ceb843da436c6b70175f96ed1deb8c0c088a67a65b6024e943e7eb265a96055ec86601195893bb262c13c68a0d81a7f5b1b66a7b64a

data/README.md

@@ -63,11 +63,11 @@ the name conflicts with another layer already handled by the manager**.
 You can notice by the way that it gives a third way to create a layer from a hash, as when adding a hash to a manager,
 it automatically adds the `SuperStack::LayerWrapper` module to the hash.
 
-Layers can be populated from a file anytime using the `load` method:
+Layers can be populated from a yaml file anytime using the `load` method:
 
 ```ruby
 layer = SuperStack::Layer.new.load 'a_file_somewhere'
-# Once loaded you can get the file name used to load the layed anytime
+# Once loaded you can get the file name used to load the layer anytime
 puts layer.file_name
 # And you can load or reload the layer
 layer.has_file? # => true
@@ -89,6 +89,13 @@ manager << layer2
 manager.reload_layers
 ```
 
+Layers can of course be:
+* removed (using the manager's `remove_layer(layer_or_layer_name)` method).
+* Enabled or disabled (using the manager's `disable_layer(layer_or_layer_name)` and `enable_layer(layer_or_layer_name)`
+  methods).
+
+Of course these methods have an impact on the `write_layer` if applied to it. Check tests (run `rspec -f d`) for
+more info.
 
 ### Merge policies
 

data/lib/super_stack/layer_wrapper.rb

@@ -8,7 +8,8 @@ module SuperStack
 
     DEFAULT_LAYER_NAME = 'Unknown layer'
 
-    attr_reader :file_name, :priority, :manager
+    attr_reader :file_name, :priority, :manager, :disabled
+    alias_method :disabled?, :disabled
 
     def priority=(priority)
       raise 'invalid priority' unless priority.is_a? Numeric

data/lib/super_stack/manager.rb

@@ -16,14 +16,10 @@ module SuperStack
     end
 
     def write_layer=(layer_or_layer_name)
-      if layer_or_layer_name.is_a?(String) || layer_or_layer_name.is_a?(Symbol)
-        layer_name = layer_or_layer_name.to_s
-        raise 'Invalid write layer' unless layers.keys.include? layer_name
-        layer_or_layer_name = layers[layer_name]
-      end
-      # At that point layer_or_layer_name can only contain a layer object
-      raise 'Invalid write layer' unless layers.values.include? layer_or_layer_name
-      @write_layer = layer_or_layer_name
+      layer = get_existing_layer layer_or_layer_name, 'Invalid write layer specified'
+      raise 'Cannot use a disabled layer as write layer' if layer.disabled?
+      @previous_write_layer = nil
+      @write_layer = layer
     end
 
     def []=(key,value)
@@ -37,8 +33,12 @@ module SuperStack
       return layers[0] if layers.count == 1
       first_layer = layers.shift
       res = layers.inject(first_layer) do |stack, layer|
-        policy_to_apply = layer.merge_policy.nil? ? default_merge_policy : layer.merge_policy
-        policy_to_apply.merge 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, layer
+        end
       end
       if filter.nil?
         # Trick to return a bare hash
@@ -62,11 +62,35 @@ module SuperStack
       end
       set_valid_name_for layer if layers.keys.include? layer.name
       layer.priority = get_unused_priority if layer.priority.nil?
+      raise 'This layer already belongs to a manager' unless layer.manager.nil?
       layers[layer.name] = layer
       layer.instance_variable_set :@manager, self
       layer.managed if layer.respond_to? :managed
     end
 
+    def remove_layer(layer_or_layer_name)
+      layer = get_existing_layer layer_or_layer_name, 'Cannot remove unmanaged layer'
+      layer_name = layer.name
+      @write_layer = nil if layer == write_layer
+      layer.instance_variable_set :@manager, nil
+      layers.delete layer_name
+    end
+
+    def disable_layer(layer_or_layer_name)
+      layer = get_existing_layer layer_or_layer_name, 'Cannot disable unmanaged layer'
+      if layer == write_layer
+        @previous_write_layer = write_layer
+        @write_layer = nil
+      end
+      layer.instance_variable_set :@disabled, true
+    end
+
+    def enable_layer(layer_or_layer_name)
+      layer = get_existing_layer layer_or_layer_name, 'Cannot enable unmanaged layer'
+      layer.instance_variable_set :@disabled, false
+      @write_layer = @previous_write_layer if layer == @previous_write_layer
+    end
+
     def <<(layer)
       add_layer layer
     end
@@ -77,6 +101,15 @@ module SuperStack
 
     private
 
+    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
+      layer_name = layer_or_layer_name if layer_or_layer_name.is_a? String
+      layer = layers[layer_name] unless layer_name.nil?
+      layer = layer_or_layer_name if layer_or_layer_name.class.included_modules.include? SuperStack::LayerWrapper
+      raise error_message if layer.nil?
+      layer
+    end
+
     def get_unused_priority
       ordered = self.to_a
       return DEFAULT_PRIORITY_INTERVAL if ordered.empty?
@@ -85,6 +118,7 @@ module SuperStack
 
     def set_valid_name_for(layer)
       name_pattern = /^(?<layer_name>.+) #(?<number>\d+)\s*$/
+
       while layers.keys.include? layer.name
         layer.name = "#{layer.name} #1" unless layer.name =~ name_pattern
         layer.name.match(name_pattern) do |md|

data/lib/super_stack/version.rb

@@ -1,3 +1,3 @@
 module SuperStack
-  VERSION = '0.2.5'
+  VERSION = '0.3.0'
 end

data/spec/manager_spec.rb

@@ -13,6 +13,11 @@ describe SuperStack::Manager do
       layer
     }
   end
+  let(:override) {
+    override = SuperStack::Layer.new
+    override.name = :override
+    override
+  }
 
 
   it 'should contain layers' do
@@ -71,16 +76,6 @@ describe SuperStack::Manager do
     expect(subject.layers.keys[1] == "#{SuperStack::Layer::DEFAULT_LAYER_NAME} #2").to be_truthy
   end
 
-  it 'should allow the same layer to be added multiple times, automatically changing names' do
-    expect {subject.add_layer(layer1) }.not_to raise_error
-    expect {subject.add_layer(layer1) }.not_to raise_error
-    expect {subject.add_layer(layer1) }.not_to raise_error
-    expect(subject.layers.keys.count == 3).to be_truthy
-    expect(subject.layers.keys[0] == 'layer1').to be_truthy
-    expect(subject.layers.keys[1] == 'layer1 #2').to be_truthy
-    expect(subject.layers.keys[2] == 'layer1 #3').to be_truthy
-  end
-
   it 'should allow to reload all layers at once' do
     subject.add_layer layer1
     subject << {bar: :foo}
@@ -95,47 +90,53 @@ describe SuperStack::Manager do
     expect(subject[:bar] == :foo).to be_truthy
   end
 
-  it 'should be possible to specify a write layer using its name or itself' do
-    override = SuperStack::Layer.new
-    override.name = :override
-    subject << override
-    subject << layer1
-    expect {subject.write_layer = :override}.not_to raise_error
-    expect {subject.write_layer = 'override'}.not_to raise_error
-    expect {subject.write_layer = override}.not_to raise_error
-  end
-
-  it 'should not be possible to modify if no write layer has been specified' do
+  it 'should not be possible to modify the manager if no write layer has been specified' do
     subject << layer1
     subject << layer2
     expect {subject[:foo] = :bar}.to raise_error
   end
 
-  it 'should push all modifications to the write layer' do
-    override = SuperStack::Layer.new
-    override.name = :override
-    subject << override
-    subject << layer1
-    subject.write_layer = override
-    expect {subject[:foo] = :bar}.not_to raise_error
-    expect(subject.layers['override'][:foo] == :bar).to be_truthy
-    expect(subject[:foo] == :bar).to be_truthy
-  end
+  context 'when specifying a write layer' do
 
+    it 'should be possible using its name or itself' do
+      subject << override
+      subject << layer1
+      expect {subject.write_layer = :override}.not_to raise_error
+      expect {subject.write_layer = 'override'}.not_to raise_error
+      expect {subject.write_layer = override}.not_to raise_error
+    end
+
+    it 'should push all modifications to the write layer' do
+      subject << override
+      subject << layer1
+      subject.write_layer = override
+      expect {subject[:foo] = :bar}.not_to raise_error
+      expect(subject.layers['override'][:foo] == :bar).to be_truthy
+      expect(subject[:foo] == :bar).to be_truthy
+    end
+
+
+    it 'should be possible to clear modifications' do
+      subject << layer1
+      subject << override
+      subject.write_layer = override
+      subject[:something_modified] = :modified
+      expect(subject[:something_modified]).not_to be_nil
+      subject.reset
+      expect(subject[:something_modified]).to be_nil
+    end
+
+    it 'should not be possible to specify a disabled layer' do
+      subject << override
+      subject.write_layer = override
+      subject.disable_layer override
+      expect {subject.write_layer = override}.to raise_error
+    end
 
-  it 'should be possible to clear modifications' do
-    subject << layer1
-    override = SuperStack::Layer.new
-    override.name = :override
-    subject << override
-    subject.write_layer = override
-    subject[:something_modified] = :modified
-    expect(subject[:something_modified]).not_to be_nil
-    subject.reset
-    expect(subject[:something_modified]).to be_nil
   end
 
 
+
   SuperStack::MergePolicies.list.each do |policy|
     it "should provide a merged view of the layers according to the merge policy: #{policy}" do
       subject.add_layer layer1
@@ -164,4 +165,114 @@ describe SuperStack::Manager do
 
   end
 
+  context 'when removing a layer' do
+
+    subject {
+      s = SuperStack::Manager.new
+      s.add_layer layer1
+      s.add_layer layer2
+      s.add_layer layer3
+      s.add_layer layer4
+      s
+    }
+
+
+    it 'should not accept an incorrect layer' do
+      expect {subject.remove_layer :layer12}.to raise_error
+      expect {subject.remove_layer nil}.to raise_error
+    end
+
+    it 'should accept a symbol' do
+      expect {subject.remove_layer :layer3}.not_to raise_error
+    end
+    it 'should accept a string' do
+      expect {subject.remove_layer 'layer3'}.not_to raise_error
+    end
+    it 'should accept a layer itself' do
+      expect {subject.remove_layer layer3}.not_to raise_error
+    end
+    it 'should not manage the layer anymore' do
+      subject.remove_layer :layer3
+      expect(layer3.manager).to be_nil
+    end
+
+    it 'should remain consistent in terms of merged view' do
+      subject.remove_layer :layer3
+      expect(subject[:from_layer_3]).to be_nil
+      expect(subject[:from_layer_1]).not_to be_nil
+      expect(subject[:from_layer_2]).not_to be_nil
+      expect(subject[:from_layer_4]).not_to be_nil
+    end
+
+    it 'should remain consistent regarding the write level' do
+      subject.write_layer = :layer3
+      expect(subject.write_layer == layer3).to be_truthy
+      subject[:foo] = :bar
+      expect(layer3[:foo] == :bar).to be_truthy
+      subject.remove_layer :layer3
+      expect(subject[:foo] == :bar).to be_falsey
+      expect(subject.write_layer).to be_nil
+    end
+
+  end
+
+  context 'when disabling a layer' do
+
+    subject {
+      s = SuperStack::Manager.new
+      s.add_layer layer1
+      s.add_layer layer2
+      s.add_layer layer3
+      s.add_layer layer4
+      s
+    }
+
+    it 'should not been 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
+      expect(subject[:from_layer_2]).not_to be_nil
+      expect(subject[:from_layer_4]).not_to be_nil
+    end
+
+    it 'could be reactivated' do
+      subject.disable_layer :layer3
+      subject.enable_layer :layer3
+      expect(subject[:from_layer_3]).not_to be_nil
+      expect(subject[:from_layer_1]).not_to be_nil
+      expect(subject[:from_layer_2]).not_to be_nil
+      expect(subject[:from_layer_4]).not_to be_nil
+    end
+
+    context 'when enabling/disabling a layer which is the write layer' do
+      subject {
+        s = SuperStack::Manager.new
+        s.add_layer layer1
+        s.add_layer layer2
+        s.add_layer layer3
+        s.add_layer layer4
+        s.write_layer = :layer3
+        s
+      }
+      it 'should restore it as the write layer if re-enabled' do
+        subject.disable_layer :layer3
+        expect(subject.write_layer).to be_nil
+        subject.enable_layer :layer3
+        expect(subject.write_layer).to be layer3
+        expect {subject[:foo] = :bar}.not_to raise_error
+      end
+
+      it 'should not restore it as the write layer if another write layer has been set in between' do
+        subject.disable_layer :layer3
+        expect(subject.write_layer).to be_nil
+        subject.write_layer = :layer2
+        subject.enable_layer :layer3
+        expect(subject.write_layer).to be layer2
+        expect {subject[:foo] = :bar}.not_to raise_error
+      end
+    end
+
+
+  end
+
 end

data/super_stack.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_dependency 'deep_merge'
+  spec.add_dependency 'deep_merge', '~> 1.0'
 
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_stack
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-24 00:00:00.000000000 Z
+date: 2015-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: The purpose of this gem is to provide a simple way to manage the merge
   of different hashes (layers) according to priority and several merge policies.
 email: