stacked_config 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0158b5db88a7322e9e0c2aef2dba1dca08ed9bd
-  data.tar.gz: 3e80f4ae117b047fbcfda02d56396e01a6f7a013
+  metadata.gz: 282dd3a444e99efb2871011e34b58bdb8242c081
+  data.tar.gz: 5881f955417d6c531d7b239bb89270ca50201694
 SHA512:
-  metadata.gz: 0a53fc2c107073a657985d86acddba0182a482c65d9b11f31269f757328431be2865bc2c2ec560dc71723a566a72719930060b94219f08b61b06789ce715906a
-  data.tar.gz: e8952818ffb801400d1b92ac26eb4e12f8e0537ff2435a3bda6dfca14ebdc1ddf795b489c70d9720a088dee64328d2342007f34b732a6603bca80939c4109144
+  metadata.gz: b42615073c9ecbf56ff322931b2a2886a75f4ec9325cb0c4ea211a86a43f0f99afb18784389c2ea7cd610ffeb9a46d9951ecdf90ef286d0eb253afeec134a1f9
+  data.tar.gz: 10595e497a75007147911ebd1f379f73793e495e4816f92aa1bf2ad2bd30576c09a5a1360b99a3d1353ac60e1a97da7d3ad361a1a2bc19cb86fec885d1e9b42a

data/lib/stacked_config.rb

@@ -13,5 +13,6 @@ require 'stacked_config/layers/user_layer'
 require 'stacked_config/layers/env_layer'
 require 'stacked_config/layers/command_line_layer'
 require 'stacked_config/layers/provided_config_file_layer'
+require 'stacked_config/layers/project_layer'
 require 'stacked_config/orchestrator'
 

data/lib/stacked_config/layers/project_layer.rb

@@ -0,0 +1,61 @@
+module StackedConfig
+  module Layers
+
+    class ProjectLayer < SuperStack::Layer
+
+      attr_accessor :project_file_basename
+      attr_reader :started_from_directory
+
+      def initialize(file_or_directory, project_file_basename=nil)
+        if Dir.exists? file_or_directory
+          raise 'You have to provide the basename of the project file !' if project_file_basename.nil?
+          @started_from_directory = File.expand_path file_or_directory
+          self.project_file_basename = project_file_basename
+        else
+          raise "Invalid project file '#{file_or_directory}' !" unless File.readable? file_or_directory
+          normalized = File.expand_path file_or_directory
+          @started_from_directory = File.dirname normalized
+          self.project_file_basename = File.basename normalized
+        end
+      end
+
+      def file_name
+        @file_name ||= find_root_file project_file_basename, started_from_directory
+      end
+
+      def project_root
+        File.dirname file_name
+      end
+
+      def project_file_basename=(file)
+        @file_name = nil
+        @project_file_basename = file
+      end
+
+      private
+
+      def find_root_file(file_basename, initial_directory)
+        prev_dir = nil
+        cur_dir = initial_directory
+        found_file = nil
+
+        raise "Invalid directory '#{initial_directory}'" unless File.readable? initial_directory
+
+        while found_file.nil? and cur_dir != prev_dir
+          candidate_file = File.join cur_dir, file_basename
+          if File.readable? candidate_file
+            found_file = candidate_file
+          end
+          prev_dir = cur_dir
+          cur_dir = File.expand_path '..', cur_dir
+        end
+
+        raise "Cannot find any root file named '#{file_basename}' starting from '#{initial_directory}'." if found_file.nil?
+
+        found_file
+      end
+
+    end
+
+  end
+end

data/lib/stacked_config/orchestrator.rb

@@ -4,7 +4,7 @@ module StackedConfig
     include StackedConfig::ProgramDescriptionHelper
 
     attr_reader :system_layer, :global_layer, :executable_gem_layer, :user_layer, :env_layer,
-                :command_line_layer, :provided_config_file_layer
+                :command_line_layer, :provided_config_file_layer, :project_layer
 
     def initialize
       super
@@ -19,6 +19,13 @@ module StackedConfig
       File.basename($PROGRAM_NAME).gsub /\.[^\.]+$/, ''
     end
 
+    def include_project_layer(file_or_directory, project_file_basename=nil, priority = 65)
+      @project_layer = StackedConfig::Layers::ProjectLayer.new file_or_directory, project_file_basename
+      env_layer.name = 'Project level'
+      env_layer.priority = priority
+      self << env_layer
+    end
+
     def include_env_layer(filter = nil, priority = 70)
       @env_layer = StackedConfig::Layers::EnvLayer.new filter
       env_layer.name = 'Environment variables level'

data/lib/stacked_config/version.rb

@@ -1,3 +1,3 @@
 module StackedConfig
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/orchestrator_spec.rb

@@ -116,6 +116,11 @@ describe StackedConfig::Orchestrator do
 
   end
 
+  it 'should not have project layer by defaut' do
+    expect(subject.project_layer).to be_nil
+  end
+
+
   it 'should not have environment variables by defaut' do
     expect(subject.env_layer).to be_nil
   end

data/spec/project_layer_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe StackedConfig::Layers::ProjectLayer do
+
+  let(:test_root) { File.expand_path '../../test/tst_project_layer', __FILE__ }
+  let(:search_from_place1) { File.join test_root, 'single', 'level1', 'level2', 'level3' }
+  let(:search_from_place2) { File.join test_root, 'multiple', 'level1', 'level2', 'level3' }
+  let(:search_from_place3) { File.join test_root, 'multiple', 'level1', 'level2' }
+  let(:config_file_name) { 'test_config_file' }
+
+  let(:file1) { File.join test_root, 'single', 'level1', config_file_name}
+  let(:file2) { File.join test_root, 'multiple', 'level1', 'level2', 'level3', config_file_name}
+  let(:file3) { File.join test_root, 'multiple', 'level1', config_file_name}
+
+  subject { described_class.new test_root, config_file_name }
+
+  it 'should find the find the first config file in the folders hierarchy' do
+    expect(subject.send :find_root_file, config_file_name, search_from_place1).to eq file1
+    expect(subject.send :find_root_file, config_file_name, search_from_place2).to eq file2
+    expect(subject.send :find_root_file, config_file_name, search_from_place3).to eq file3
+  end
+
+  it 'should raise an exception if no file is found' do
+    expect {subject.send :find_root_file, :unknown_config_file, search_from_place1 }.to raise_error
+  end
+
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stacked_config
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2016-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ files:
 - lib/stacked_config/layers/gem_layer.rb
 - lib/stacked_config/layers/generic_layer.rb
 - lib/stacked_config/layers/global_layer.rb
+- lib/stacked_config/layers/project_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
@@ -128,6 +129,7 @@ files:
 - spec/gem_layer_spec.rb
 - spec/global_layer_spec.rb
 - spec/orchestrator_spec.rb
+- spec/project_layer_spec.rb
 - spec/provided_config_file_layer_spec.rb
 - spec/source_helper_spec.rb
 - spec/spec_helper.rb
@@ -135,6 +137,10 @@ files:
 - spec/user_layer_spec.rb
 - stacked_config.gemspec
 - test/specific.yml
+- test/tst_project_layer/multiple/level1/level2/level3/test_config_file
+- test/tst_project_layer/multiple/level1/test_config_file
+- test/tst_project_layer/single/level1/level2/level3/.keep
+- test/tst_project_layer/single/level1/test_config_file
 - test/tstgem/.rspec
 - test/tstgem/Gemfile
 - test/tstgem/LICENSE.txt
@@ -182,12 +188,17 @@ test_files:
 - spec/gem_layer_spec.rb
 - spec/global_layer_spec.rb
 - spec/orchestrator_spec.rb
+- spec/project_layer_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/tst_project_layer/multiple/level1/level2/level3/test_config_file
+- test/tst_project_layer/multiple/level1/test_config_file
+- test/tst_project_layer/single/level1/level2/level3/.keep
+- test/tst_project_layer/single/level1/test_config_file
 - test/tstgem/.rspec
 - test/tstgem/Gemfile
 - test/tstgem/LICENSE.txt