stacked_config 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a704406dfd46dd2f353d6aaa5dce2dee1608c257
-  data.tar.gz: fc274646518d279ba4f81578ab180f0b23aed082
+  metadata.gz: 0cc8ac49474011f38a0cf1b6859849c9feb356b9
+  data.tar.gz: 5b5076b0f63330df95152b0403619043807bee21
 SHA512:
-  metadata.gz: 855ba677dcfd1ff998845225a19cfa022dbb50065b1e5498333d499edbe74c6350c246f0e66bb926225982d9cdc9e12de59b16f5b1cde631a4749206f792c5b5
-  data.tar.gz: e6da7ea0fbf7a30f459f47057a0fa5097779502df96f61938e5800e4c305d9181573eed91d12e4082c5e365c0cf198761c50370dccac2ef055defeed76060ab6
+  metadata.gz: f66b20e0469a6c5f3ce095c401ec1ba527ef9e9a0e1a15e597c02d6d4b4f7ddf7d90362548fe9b757b9e4b2822a94bb321f463181ecd375e92f2735fa0b2a16c
+  data.tar.gz: 4f6b134a3dc729a0a03f67c70338eac58cae74780df30ee62d90a822bd5bb7026966cd1cec9fba06105b9f402c52d856f34d4f7f302a46c63bd1350734102359

data/.gitignore

@@ -1,8 +1,9 @@
 *.gem
 *.rbc
 .bundle
-.config
+/.config
 .yardoc
+.idea
 Gemfile.lock
 InstalledFiles
 _yardoc

data/lib/stacked_config.rb

@@ -9,5 +9,6 @@ require 'stacked_config/layers/system_layer'
 require 'stacked_config/layers/global_layer'
 require 'stacked_config/layers/user_layer'
 require 'stacked_config/layers/command_line_layer'
+require 'stacked_config/layers/provided_config_file_layer'
 require 'stacked_config/orchestrator'
 

data/lib/stacked_config/layers/provided_config_file_layer.rb

@@ -0,0 +1,31 @@
+module StackedConfig
+  module Layers
+
+    class ProvidedConfigFileLayer < SuperStack::Layer
+
+
+      def managed
+        build_command_line_options unless @already_built
+        if manager[:'config-file']
+          if File.readable? manager[:'config-file']
+            @file_name = manager[:'config-file']
+            self.merge_policy = SuperStack::MergePolicies::OverridePolicy if manager[:'config-override']
+          end
+        end
+      end
+
+      private
+
+      def build_command_line_options
+        manager.add_command_line_section('Configuration options') do |slop|
+          slop.on 'config-file', 'Specify a config file.', :argument => true
+          slop.on 'config-override', 'If specified override all other config.', :argument => false
+        end
+        @already_built = true
+      end
+
+
+    end
+
+  end
+end

data/lib/stacked_config/orchestrator.rb

@@ -3,7 +3,8 @@ module StackedConfig
 
     include StackedConfig::ProgramDescriptionHelper
 
-    attr_reader :system_layer, :global_layer, :user_layer, :command_line_layer
+    attr_reader :system_layer, :global_layer, :user_layer, :command_line_layer,
+                :provided_config_file_layer
 
     def initialize
       super
@@ -16,6 +17,10 @@ module StackedConfig
     private
 
     def setup_layers
+
+      # The command line level.
+      @command_line_layer = setup_layer StackedConfig::Layers::CommandLineLayer, 'Command line configuration level', 100
+
       # The system level
       @system_layer = setup_layer StackedConfig::Layers::SystemLayer, 'System-wide configuration level', 10
 
@@ -25,8 +30,8 @@ module StackedConfig
       # The user level
       @user_layer = setup_layer StackedConfig::Layers::UserLayer, 'User configuration level', 30
 
-      # The command line level
-      @command_line_layer = setup_layer StackedConfig::Layers::CommandLineLayer, 'Command line configuration level', 100
+      # The specifically provided config file level
+      @provided_config_file_layer = setup_layer StackedConfig::Layers::ProvidedConfigFileLayer, 'Specific config file configuration level', 40
 
       # The layer to write something
       override_layer = setup_layer SuperStack::Layer, 'Overridden configuration level', 1000

data/lib/stacked_config/version.rb

@@ -1,3 +1,3 @@
 module StackedConfig
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/spec/orchestrator_spec.rb

@@ -30,10 +30,10 @@ describe StackedConfig::Orchestrator do
   context 'when changing the executable_name' do
 
     it 'should reload all config files' do
-      expect(subject[:user_defined]).not_to be_nil
+      expect(subject[:user_property]).not_to be_nil
       expect(subject[:weird_property]).to be_nil
       subject.executable_name = 'weird_name'
-      expect(subject[:user_defined]).to be_nil
+      expect(subject[:user_property]).to be_nil
       expect(subject[:weird_property]).not_to be_nil
     end
 
@@ -59,8 +59,12 @@ describe StackedConfig::Orchestrator do
       expect(subject.user_layer).to be subject.to_a[2]
     end
 
-    it 'should have the command-line layer evaluated in fourth' do
-      expect(subject.command_line_layer).to be subject.to_a[3]
+    it 'should have the specific-file layer evaluated in fourth' do
+      expect(subject.provided_config_file_layer).to be subject.to_a[3]
+    end
+
+    it 'should have the command-line layer evaluated in fifth' do
+      expect(subject.command_line_layer).to be subject.to_a[4]
     end
 
     it 'should have the writable layer evaluated last' do
@@ -69,7 +73,42 @@ describe StackedConfig::Orchestrator do
 
   end
 
+  context 'when config-file is provided on the command line' do
+
+    let(:test_config_file) {
+      gem_path = File.expand_path '../..', __FILE__
+      File.join gem_path, 'test', 'specific.yml'
+    }
+
+    it 'should add the content of the specified config-file' do
+      subject[:'config-file'] = test_config_file
+      subject.provided_config_file_layer.managed
+      subject.provided_config_file_layer.reload
+      expect(subject[:system_property]).not_to be_nil
+      expect(subject[:global_property]).not_to be_nil
+      expect(subject[:user_property]).not_to be_nil
+      expect(subject[:specific_property]).not_to be_nil
+    end
+
+
+    context 'when specifying config-override on the command line' do
 
+      it 'should override all preceding layers (system, global, user)' do
+        subject[:'config-file'] = test_config_file
+        subject[:'config-override'] = true
+        subject.provided_config_file_layer.managed
+        subject.provided_config_file_layer.reload
+        expect(subject[:system_property]).to be_nil
+        expect(subject[:global_property]).to be_nil
+        expect(subject[:user_property]).to be_nil
+        expect(subject[:specific_property]).not_to be_nil
+        expect(subject[:'config-override']).not_to be_nil
+      end
+
+
+    end
+
+  end
 
 
 end

data/spec/provided_config_file_layer_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+
+describe StackedConfig::Layers::ProvidedConfigFileLayer do
+
+  subject { StackedConfig::Layers::ProvidedConfigFileLayer.new }
+
+
+  it 'should be empty by default' do
+    expect(subject.empty?).to be_truthy
+  end
+
+
+
+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.3'
+  spec.add_dependency 'super_stack', '~> 0.2', '>= 0.2.4'
   spec.add_dependency 'slop'
 
 end

data/test/specific.yml

@@ -0,0 +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:
+  - something very specific

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

@@ -2,6 +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:
   - defined at global level
   - pretty cool (global)

data/test/unix/etc/stacked_config.yml

@@ -2,4 +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
+stacked_config_copyright: (c)2014 L.Briais under MIT license
+system_property: foo

data/test/user/.config/rspec.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
+
+user_property: foo
+an_array:
+  - something weird (at user level)

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

@@ -0,0 +1,5 @@
+# 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
+
+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: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2014-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,7 +75,7 @@ dependencies:
         version: '0.2'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ dependencies:
         version: '0.2'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +117,7 @@ files:
 - lib/stacked_config/layers/command_line_layer.rb
 - lib/stacked_config/layers/generic_layer.rb
 - lib/stacked_config/layers/global_layer.rb
+- lib/stacked_config/layers/provided_config_file_layer.rb
 - lib/stacked_config/layers/system_layer.rb
 - lib/stacked_config/layers/user_layer.rb
 - lib/stacked_config/orchestrator.rb
@@ -126,13 +127,17 @@ files:
 - spec/command_line_layer_spec.rb
 - spec/global_layer_spec.rb
 - spec/orchestrator_spec.rb
+- spec/provided_config_file_layer_spec.rb
 - spec/source_helper_spec.rb
 - spec/spec_helper.rb
 - spec/system_layer_spec.rb
 - spec/user_layer_spec.rb
 - stacked_config.gemspec
+- test/specific.yml
 - test/unix/etc/rspec/rspec.yml
 - test/unix/etc/stacked_config.yml
+- test/user/.config/rspec.yml
+- test/user/.config/weird_name.yml
 homepage: https://github.com/lbriais/stacked_config
 licenses:
 - MIT
@@ -161,9 +166,13 @@ test_files:
 - spec/command_line_layer_spec.rb
 - spec/global_layer_spec.rb
 - spec/orchestrator_spec.rb
+- spec/provided_config_file_layer_spec.rb
 - spec/source_helper_spec.rb
 - spec/spec_helper.rb
 - spec/system_layer_spec.rb
 - spec/user_layer_spec.rb
+- test/specific.yml
 - test/unix/etc/rspec/rspec.yml
 - test/unix/etc/stacked_config.yml
+- test/user/.config/rspec.yml
+- test/user/.config/weird_name.yml