skn_utils 5.1.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4532c0129c738d77525a2c540cf7d6bdba464b29
-  data.tar.gz: f6fd9d50967810320042a7ceea023164082beeec
+  metadata.gz: c8ddbccefff19413e5adde085173b94bbe2a8f4f
+  data.tar.gz: 1e640fd3aa205210e71574c64d315bee47867a97
 SHA512:
-  metadata.gz: 6e784b05da136b62ccb2920d8449bb1258c1415c7d550ca2e5094c26697f01407b891b769e2d0ce094b72b36ae8171b1d3195a589f7a11f942ec15db4073bf67
-  data.tar.gz: a8ecfb811398cdde7a2aa029478f50358d99585ddcfbfe00ee9a9de5d9686607d4a0436a03c62d4e917c6c2694d4ffb97800e8ec8343094760633d7f9be2ab65
+  metadata.gz: 63a0c08de09ac7a6165e6c920d57d54c7a279b3b15ad646b101b848432d0cac7fe51a416ccd7653b99c0d2ad2fd0030efc9ced6656ee7adca8c8034bb2a70985
+  data.tar.gz: 1ce7693ec5a65324e6993745819826b57218a0065b23dad7646878ec53f6023e04d83485c1c62ad22583004c53f9e07f7051d13c94897faf0eaeaf365cb3443d

data/README.md

@@ -46,18 +46,23 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 * SknSuccess
 * SknFailure
 * SknSettings
-    * SknUtils::Configurable
+    * SknUtils::Configuration
     * SknUtils::EnvStringHandler
-* SknContainer
 * SknRegistry
+    * SknContainer
 * SknHash
-    * SknUtils::NestedResult
     * SknUtils::ResultBean
     * SknUtils::PageControls
+    * SknUtils::NestedResult
 * SknUtils::NullObject
 * SknUtils::CoreObjectExtensions
+* SknUtils::Configurable
+
 
 ## History
+    10/15/2018 V5.1.1
+    Enhanced SknSettings to match 95% of the (Rb)Config.gem public API.
+    
     10/13/2018 V5.1.0
     Added SknRegistry to handle service and handler registrations.
     - Command.class => CommandHandler.class/instance container
@@ -142,14 +147,14 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 
     SknSettings                      # Multi-level application Configuration class, Key/Value Container with Dot/Hash notiation support.    
 
-    SknContainer                     # Basic Key/Value container which #registers and #resolves procs, classes, and/or object
+    SknContainer/SknRegistry         # Basic Key/Value container which #registers and #resolves procs, classes, and/or object
 
     SknSuccess                       # Three attribute value containers for return codes   -- #success, #message, #value
     SknFailure                       # Three attribute value containers for return codes   -- #success, #message, #value
 
 
 ## Configuration Options
-    None required other than initialization hash
+    None required 
 
 
 ## Public Methods: SknContainer ONLY
@@ -186,11 +191,33 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
       #config_path!(path)                 -- Where path format is './<dirs>/', default is: './config/'
                                              and contains a settings.yml file and a 'path/settings/' directory
 
-    Paths ./config and ./config/settings must exist.
+    Paths ./config must exist.
+    Paths ./config/settings/, and ./config/environments/ are optional
     File ./config/settings.yml must exist and contain a valid YAML file structure.
-      ./config/settings.yml                              -- Required   base
-      ./config/settings/<config_name>.yml                -- Optional   base.deep_merge!()
-      ./config/settings/<config_name>.local.yml          -- Optional   base.deep_merge!()
+       
+    File load/deep_merge sequence:
+    -------------------------------------------------
+     <prepend-somefile-or-hash>                       -- see #prepend_source!(...)
+     config/settings.yml
+     config/settings/#{environment}.yml
+     config/environments/#{environment}.yml    
+     config/settings.local.yml
+     config/settings/#{environment}.local.yml
+     config/environments/#{environment}.local.yml
+     <append-somefile-or-hash>                        -- see #add_source!(...)
+    
+    
+    Public API 
+     -------------------------------------------------
+     #load_config_basename!(environment_name)          -- self, loads std sequence
+     #config_path!(config_root)                        -- self, set config_root for above
+     #load_and_set_settings(ordered_filelist)          -- self, sets config_root and loads std sequence
+       - Alias: #reload_from_files(ordered_filelist)
+     #reload!()                                        -- self, clears and reloads last filelist
+     #setting_files(config_root, environment_name)     -- returns ordered filelist
+     #add_source!(file_path_or_hash)                   -- self, adds yaml_file or hash to end of filelist (:reload! required)
+     #prepend_source!(file_path_or_hash)               -- self, adds yaml_file or hash to start of filelist (:reload! required)
+     -------------------------------------------------
 
 
 ## Public Methods: SknUtils::NestedResult, SknHash & SknSettings

data/lib/skn_settings.rb

@@ -5,7 +5,31 @@
 # Usage:
 #   SknSettings.<config.key>[.<config.key>]...
 ##
-
+# Filepath Targets:
+# -------------------------------------------------
+# <prepend-somefile>
+# config/settings.yml
+# config/settings/#{environment}.yml
+# config/environments/#{environment}.yml
+#
+# config/settings.local.yml
+# config/settings/#{environment}.local.yml
+# config/environments/#{environment}.local.yml
+# <append-somefile>
+#
+#
+# Public API
+# -------------------------------------------------
+# load_config_basename!(environment_name)
+# config_path!(config_root)
+# load_and_set_settings(ordered_list_of_files)
+#   - Alias: reload_from_files(ordered_list_of_files)
+# reload!()
+# setting_files(config_root, environment_name)
+# add_source!(file_path_or_hash)
+# prepend_source!(file_path_or_hash)
+# -------------------------------------------------
+# ##
 # This creates a global constant (and singleton) with a defaulted configuration
 class << (SknSettings = SknUtils::Configuration.new())
 end

data/lib/skn_utils/configuration.rb

@@ -1,44 +1,151 @@
+# ##
+# lib/skn_utils/configuration.rb
 #
 # @see SknSettings
+#
+# Filepath Targets:
+# -------------------------------------------------
+# <prepend-somefile>
+# config/settings.yml
+# config/settings/#{environment}.yml
+# config/environments/#{environment}.yml
+#
+# config/settings.local.yml
+# config/settings/#{environment}.local.yml
+# config/environments/#{environment}.local.yml
+# <append-somefile>
+#
+#
+# Public API
+# -------------------------------------------------
+# load_config_basename!(environment_name)
+# config_path!(config_root)
+# load_and_set_settings(ordered_list_of_files)
+#   - Alias: reload_from_files(ordered_list_of_files)
+# reload!()
+# setting_files(config_root, environment_name)
+# add_source!(file_path_or_hash)
+# prepend_source!(file_path_or_hash)
+# -------------------------------------------------
+#
+# SknSettings setup:
+# class << (SknSetting = SknUtils::Configuration.new( ENV['RACK_ENV'] )); end
+#
+#
 
 module SknUtils
 
   class Configuration < NestedResult
 
+    # "filename-only"
+    # {config_filename: "filename-only"}
     def initialize(params={})
-      default_mode = ENV.fetch('RACK_ENV', 'development')
-      @config_filename = params.is_a?(String) ? params : params.fetch(:config_filename, default_mode)
-      @base_path = ENV.fetch('TEST_GEM', 'rails').eql?('gem') ? './spec/factories/' : './config/'
-      load_config_basename!(@config_filename)
+      super()
+      @_last_filelist = []
+      @_base_path = './config/'
+      @_default_mode = ENV['RACK_ENV'] || 'development'
+      cfg_file = params.is_a?(String) ? params : (params[:config_filename] || @_default_mode)
+      test_mode = ENV.fetch('TEST_GEM', 'rails').eql?('gem')
+      config_path!( test_mode ? './spec/factories/' : './config/' )
+      load_config_basename!(cfg_file)
+    end
+
+    def config_path!(config_root)
+      @_base_path = config_root[-1].eql?('/') ? config_root : "#{config_root}/"
+      self
     end
 
-    def load_config_basename!(conf)
-      reset_from_empty!(load_config(conf), false) # enable dot notation via defined methods(true) vs method_missing(false)
+    def load_config_basename!(environment_name=@_default_mode)
+      reset_from_empty!(load_config(environment_name), false) # enable dot notation via defined methods(true) vs method_missing(false)
       self
     end
 
-    def config_path!(fpath)
-      @base_path = fpath if File.exist?("#{fpath}settings.yml")
+    def load_and_set_settings(ordered_list_of_files)
+      reset_from_empty!( load_ordered_list( ordered_list_of_files ), false )
+      self
+    end
+    alias_method :reload_from_files, :load_and_set_settings
+
+    def reload!
+      reset_from_empty!( load_ordered_list(@_last_filelist), false )
+      self
+    end
+
+    # Config.setting_files("/path/to/config_root", "your_project_environment")
+    def setting_files(config_root, environment_name) # returns a file array
+      config_path!(config_root)
+      @_default_mode = environment_name
+      configuration_files(environment_name)
+    end
+
+    # :reload! required
+    def add_source!(file_path_or_hash) # load last
+      return {} unless valid_file_path?(file_path_or_hash)
+      @_last_filelist.push(file_path_or_hash).flatten
+      self
+    end
+
+    # :reload! required
+    def prepend_source!(file_path_or_hash) # load first
+      return {} unless valid_file_path?(file_path_or_hash)
+      @_last_filelist.unshift(file_path_or_hash).flatten
+      self
     end
 
     private
 
-    def load_config(conf)
-      yname   = "#{@base_path}settings.yml"
-        return {} unless File.exist?(yname)
-        f_base  = load_yml_with_erb(yname)
+    def valid_file_path?(file_path_or_hash)
+      if file_path_or_hash.kind_of?(Hash)
+        true
+
+      elsif file_path_or_hash.kind_of?(String)
+        File.exist?( file_path_or_hash )
+
+      else
+        false
+
+      end
+    end
 
-      yname   = "#{@base_path}settings/#{conf}.yml"
-        f_env   = load_yml_with_erb(yname) if File.exist?(yname)
+    def configuration_files(environment_name=@_default_mode)
+      [
+          "#{@_base_path}settings.yml",
+          "#{@_base_path}settings/#{environment_name}.yml",
+          "#{@_base_path}environments/#{environment_name}.yml",
+          "#{@_base_path}settings.local.yml",
+          "#{@_base_path}settings/#{environment_name}.local.yml",
+          "#{@_base_path}environments/#{environment_name}.local.yml"
+      ]
+    end
+
+    def load_ordered_list(filelist)
+      settings_file = nil
+      yname = filelist.first
+
+      # maintain last list for :reload
+      @_last_filelist = filelist unless @_last_filelist === filelist
+
+      settings_file = yname if !!yname && yname.include?('settings.yml')
+
+      f_base  = {}
+      filelist.each do |filepath|
+        next unless valid_file_path?( filepath )
+        settings_file = filepath if filepath.include?('settings.yml')
+        f_env   = filepath.is_a?(Hash) ? filepath : load_yml_with_erb(filepath)
         f_base  = f_base.deep_merge!(f_env) unless (f_env.nil? || f_env.empty?)
+      end
 
-      yname   = "#{@base_path}settings/#{conf}.local.yml"
-        f_local = load_yml_with_erb(yname)  if File.exist?(yname)
-        f_base  = f_base.deep_merge!(f_local) unless (f_local.nil? || f_local.empty?)
+      unless settings_file.nil?
+        config_path!( File.dirname(settings_file) ) # maintain root dir
+      end
 
       f_base
     end
 
+    def load_config(conf)
+      load_ordered_list( configuration_files(conf) )
+    end
+
     def load_yml_with_erb(yml_file)
       erb = ERB.new(File.read(yml_file)).result
       erb.empty? ? {} : Psych.load(erb)

data/lib/skn_utils/nested_result.rb

@@ -190,7 +190,7 @@ module SknUtils
       bundle.keys.each_with_object({}) do |attr,collector|
         value = bundle[attr]
         case value
-          when NestedResult
+          when NestedResult, self.class
             value = value.to_hash
           when Array
             value = value.map {|ele| array_to_hash(ele) }

data/lib/skn_utils/version.rb

@@ -3,7 +3,7 @@ module SknUtils
   class Version
     MAJOR = 5
     MINOR = 1
-    PATCH = 0
+    PATCH = 1
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/factories/environments/development.yml

@@ -0,0 +1,4 @@
+---
+Packaging:
+  isDevelopment: true
+  configName: development

data/spec/factories/environments/production.yml

@@ -0,0 +1,4 @@
+---
+Packaging:
+  isProduction: false
+  configName: production

data/spec/factories/environments/test.yml

@@ -0,0 +1,4 @@
+---
+Packaging:
+  isTest: true
+  configName: test

data/spec/factories/settings/development.yml

@@ -0,0 +1,4 @@
+---
+Packaging:
+  isDevelopment: true
+  configName: development

data/spec/factories/settings/production.yml

@@ -0,0 +1,4 @@
+---
+Packaging:
+  isProduction: false
+  configName: production

data/spec/factories/settings/test.yml

@@ -1,5 +1,4 @@
 ---
 Packaging:
   isTest: true
-  isDevelopment: false
   configName: test

data/spec/factories/settings.yml

@@ -2,10 +2,10 @@
 Packaging:
   pomVersion: <%= SknUtils::VERSION %>
   isTest: false
-  isDevelopment: true
+  isDevelopment: false
   isStaging: false
   isProduction: false
-  configName: development
+  configName: default
   short_name: skn
 
 # Create a EnvStringHandler to support: SknSettings.env.development?

data/spec/lib/skn_settings_spec.rb

@@ -1,22 +1,71 @@
 #
 
-describe SknSettings, "Application Configuration" do
+describe SknUtils::Configuration, "SknSettings Application Configuration Module" do
+
+  let(:test_list) do
+    [
+      "./spec/factories/settings.yml",
+      "./spec/factories/settings/test.yml",
+      "./spec/factories/settings/test.local.yml"
+    ]
+  end
+
+  before :each do
+    @service = described_class.new.load_and_set_settings(test_list)
+  end
 
   it 'contains the test settings for the application' do
-    expect(SknSettings.Packaging.pomVersion).to eq SknUtils::VERSION
-    expect(SknSettings.Packaging.configName).to eq 'test.local'
-    expect(SknSettings.Packaging.isTest).to be true
+    expect(@service.Packaging.pomVersion).to eq SknUtils::VERSION
+    expect(@service.Packaging.configName).to eq 'test.local'
+    expect(@service.Packaging.isTest).to be true
   end
 
   it 'contains the current RACK or RAILS environment values' do
-    expect(SknSettings.env).to eq 'test'
-    expect(SknSettings.env.test?).to be true
-    expect(SknSettings.env.development?).to be false
+    expect(@service.env).to eq 'test'
+    expect(@service.env.test?).to be true
+    expect(@service.env.development?).to be false
   end
 
   it 'contains the application root path as a string' do
-    expect(SknSettings.root).to eq Dir.pwd
-    expect(SknSettings.root).to be_a(String)
+    expect(@service.root).to eq Dir.pwd
+    expect(@service.root).to be_a(String)
+  end
+
+  it "#load_config_basename!(conf=@default_mode) load correct environments. " do
+    %w(development production).each do |env_mode|
+      expect(@service.config_path!('./spec/factories/').load_config_basename!(env_mode).Packaging.configName).to eq env_mode
+    end
+  end
+
+  it "#reload! reloads the current list of files. " do
+    expect( @service.reload!().env.test? ).to be true
+    expect( @service.reload!().env.test? ).to be true
+  end
+
+  it "#config_path!(fpath) set the configfuration root path properly. " do
+    @service.config_path!('./spec/factories/')
+    expect( @service.instance_variable_get(:@_base_path) ).to eq('./spec/factories/')
+
+    @service.config_path!('./spec/factories')
+    expect( @service.instance_variable_get(:@_base_path) ).to eq('./spec/factories/')
+  end
+
+  it "#load_and_set_settings(ordered_list_of_files) " do
+    expect( @service.load_and_set_settings(test_list).env.test? ).to be true
+  end
+
+  # Config.setting_files("/path/to/config_root", "your_project_environment")
+  it "#setting_files(config_root, env_name) returns a file array. " do
+    expect(@service.setting_files('./spec/factories/', 'test')).to be_a(Array)
   end
 
+  it "#add_source!(file_path_or_hash) adds provided file to end of list. " do
+    expect(@service.add_source!({Packaging: {configName: 'The Doctor'}}).reload!.Packaging.configName ).to eq('The Doctor')
+  end
+
+  it "#prepend_source!(prepend_fpath) adds provided value to front of list. " do
+    expect(@service.prepend_source!({Packaging: {configName: 'The Doctor'}}).reload!.Packaging.configName ).to eq('test.local')
+  end
+
+
 end

data/spec/lib/skn_utils/registry_spec.rb

@@ -122,8 +122,8 @@ describe SknRegistry, "IoC Lite Container class." do
       expect(services.resolve(:some_depends, false)).to be_a Proc
       expect(
           services.resolve(:some_depends, false)
-          .call({greet: 'My warmest', str: 'Hello'})
-      ).to eq("My warmest HELLO")
+          .call({greet: 'My static', str: 'Hello'})
+      ).to eq("My static HELLO")
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.1
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-13 00:00:00.000000000 Z
+date: 2018-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -183,7 +183,12 @@ files:
 - lib/skn_utils/result_bean.rb
 - lib/skn_utils/version.rb
 - skn_utils.gemspec
+- spec/factories/environments/development.yml
+- spec/factories/environments/production.yml
+- spec/factories/environments/test.yml
 - spec/factories/settings.yml
+- spec/factories/settings/development.yml
+- spec/factories/settings/production.yml
 - spec/factories/settings/test.local.yml
 - spec/factories/settings/test.yml
 - spec/lib/skn_settings_spec.rb
@@ -224,7 +229,12 @@ specification_version: 4
 summary: SknUtils contains a small collection of Ruby utilities, the first being a
   NestedResult a key/value container.
 test_files:
+- spec/factories/environments/development.yml
+- spec/factories/environments/production.yml
+- spec/factories/environments/test.yml
 - spec/factories/settings.yml
+- spec/factories/settings/development.yml
+- spec/factories/settings/production.yml
 - spec/factories/settings/test.local.yml
 - spec/factories/settings/test.yml
 - spec/lib/skn_settings_spec.rb