bogo-config 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cadce180e20ddcac050c69cdd03ea31d89209372
-  data.tar.gz: 4c3e7ecc4f82b71cb880f6747ac739770a7d1bcc
+SHA256:
+  metadata.gz: 204ca66bb65a46620d29828b9b865d3a8790f6cd6a78a79030bf1137959892e7
+  data.tar.gz: 4acf0af5110993cd575ac808bdf87ff6aa7653f2f3666d861d002e5d786e6823
 SHA512:
-  metadata.gz: d484b882507f5548790589a3e43483814da5f13a354e2cb2f6cae3a009dd8992085a99e1149cd357c1ef255ef3603215a827ea50a0c38c9dd2503d77ea5c80dc
-  data.tar.gz: f0672ad3745a2a1abd5a86469ffaebea1818f2c97114fb2c36122867618c88ee9d80a1d318b4c9d5915ce74bdef0ead57b028b64c5673a7d80f6abf461aefe54
+  metadata.gz: 5399bcb175d746d6b08fdfc00a4beb869929ad4de92240b5a5e6db0463adccdb6e34ece73be9810508b07874069026ce37b605ac40262ef911ac72868e071816
+  data.tar.gz: d2d5247b8ddc9f39db38b6837eaa455e62ed0dc84b55f0c08f93f34d2f6d78902eaf4cf6ce8d6d4ff23140e2c0b6df0dc6fe78b6eabbe588099c2b1a4c3b5a2f

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.3.0
+* Update path layouts
+
 # v0.2.2
 * Fix explicit struct load conditional for .rb files (#5)
 

data/CONTRIBUTING.md

@@ -1,22 +1,18 @@
 # Contributing
 
-## Branches
+## Fixes
 
-### `master` branch
+Have a fix to some bug you want to submit? Well you're
+awesome. Please just include a description of the bug
+(or link to originating issue) and test coverage on the
+modifications.
 
-The master branch is the current stable released version.
+## New Features
 
-### `develop` branch
-
-The develop branch is the current edge of development.
-
-## Pull requests
-
-* https://github.com/spox/bogo-config/pulls
-
-Please base all pull requests of the `develop` branch. Merges to
-`master` only occur through the `develop` branch. Pull requests
-based on `master` will likely be cherry picked.
+Have a new feature you want to add? Well you're awesome
+too! It may be a good idea to submit an issue first to
+describe the desired feature and get any feedback. Please
+be sure to include tests.
 
 ## Issues
 

data/LICENSE

@@ -1,4 +1,4 @@
-   Copyright 2014 Chris Roberts
+   Copyright 2022 Chris Roberts
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -10,4 +10,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

data/bogo-config.gemspec

@@ -1,5 +1,5 @@
 $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
-require 'bogo-config/version'
+require 'bogo/config/version'
 Gem::Specification.new do |s|
   s.name = 'bogo-config'
   s.version = Bogo::Config::VERSION.version
@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'multi_xml'
   s.add_runtime_dependency 'attribute_struct'
   s.add_development_dependency 'minitest'
-  s.add_development_dependency 'rake', '~> 10'
+  s.add_development_dependency 'rexml'
+  s.add_development_dependency 'rake'
   s.files = Dir['lib/**/*'] + %w(bogo-config.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
 end

data/lib/bogo/config/configuration.rb

@@ -0,0 +1,5 @@
+require 'bogo-config'
+require 'attribute_struct'
+
+class Configuration < AttributeStruct
+end

data/lib/bogo/config/version.rb

@@ -0,0 +1,6 @@
+module Bogo
+  class Config
+    # Current library version
+    VERSION = Gem::Version.new('0.3.0')
+  end
+end

data/lib/bogo/config.rb

@@ -0,0 +1,336 @@
+require 'bogo'
+require 'yaml'
+require 'multi_xml'
+require 'multi_json'
+require 'attribute_struct'
+require 'forwardable'
+require 'bogo/config/version'
+
+autoload :Configuration, 'bogo/config/configuration'
+
+module Bogo
+
+  class Config
+
+    # Exception wrapper class used for configuration file load failure
+    class FileLoadError < LoadError
+
+      # @return [Exception]
+      attr_reader :original
+
+      def initialize(message, original_exception = nil)
+        super(message)
+        @original = original_exception
+      end
+
+      # @return [Fixnum]
+      def exit_code
+        222
+      end
+
+    end
+
+    class << self
+
+      include Bogo::Memoization
+
+      # Reload any registered `Bogo::Config` instances
+      #
+      # @return [TrueClass]
+      def reload!
+        obj_ids = memoize(:bogo_reloadable_configs, :global)
+        objects = Thread.exclusive do
+          ObjectSpace.each_object.find_all do |obj|
+            obj_ids.include?(obj.object_id)
+          end
+        end
+        objects.map(&:init!)
+        memoize(:bogo_reloadable_configs, :global).delete_if do |oid|
+          !obj_ids.include?(oid)
+        end
+        true
+      end
+
+      # Register config instance to auto reload on HUP
+      #
+      # @param config [Bogo::Config]
+      # @return [TrueClass]
+      def reloadable(config)
+        if(config.is_a?(Bogo::Config))
+          reloader
+          memoize(:bogo_reloadable_configs, :global){ [] }.push(config.object_id).uniq!
+        else
+          raise TypeError.new "Expecting type `Bogo::Config`. Received: `#{config.class}`"
+        end
+        true
+      end
+
+      # Internal reloader
+      #
+      # @return [Thread]
+      def reloader
+        memoize(:bogo_config_reloader, :global) do
+          Thread.new do
+            begin
+              loop do
+                begin
+                  sleep
+                rescue SignalException => e
+                  if(e.signm == 'SIGHUP')
+                    if(ENV['BOGO_DEBUG'])
+                      $stdout.puts 'SIGHUP encountered. Reloading `Bogo::Config` instances.'
+                    end
+                    Bogo::Config.reload!
+                  else
+                    raise
+                  end
+                end
+              end
+            rescue => e
+              if(ENV['BOGO_DEBUG'])
+                $stderr.puts "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
+              end
+              retry
+            end
+          end
+        end
+      end
+
+    end
+
+    include Bogo::Lazy
+    extend Forwardable
+
+    # @return [String] configuration path
+    attr_reader :path
+    # @return [String, Hash]
+    attr_reader :initial
+
+    # Create new instance
+    #
+    # @param path_or_hash [String, Hash] file/directory path or base Hash
+    # @return [self]
+    def initialize(path_or_hash=nil)
+      super()
+      @initial = path_or_hash
+      @data = Smash.new
+      init!
+    end
+
+    # Enables automatic reloading on SIGHUP
+    #
+    # @return [TrueClass]
+    def reloadable!
+      Bogo::Config.reloadable(self)
+      true
+    end
+
+    # Freeze underlying configuration data
+    #
+    # @return [self]
+    def immutable!
+      @data = data.to_smash(:freeze)
+    end
+
+    # Intialize the configuration
+    #
+    # @return [self]
+    def init!
+      if(initial.is_a?(String))
+        @path = initial.dup
+        hash = load!
+      else
+        hash = initial
+      end
+      if(hash)
+        is_immutable = data.frozen?
+        # TODO: synchronize here
+        load_data(hash)
+        @data = hash.to_smash.deep_merge(data.to_smash)
+        @data.to_smash(:freeze) if is_immutable
+      end
+      self
+    end
+
+    # Allow Smash like behavior
+    def_delegators *([:data, :[]] + (Smash.public_instance_methods - Object.public_instance_methods))
+
+    # Override to force consistent data access (removes dirty
+    # functionality)
+    #
+    # @return [Smash]
+    def dirty
+      data
+    end
+
+    # @return [String]
+    def to_json(*args)
+      MultiJson.dump(data, *args)
+    end
+
+    # Load configuration from file(s)
+    #
+    # @return [self]
+    def load!
+      if(path)
+        if(File.directory?(path))
+          conf = Dir.glob(File.join(path, '*')).sort.inject(Smash.new) do |memo, file_path|
+            memo.deep_merge(load_file(file_path))
+          end
+        elsif(File.file?(path))
+          conf = load_file(path)
+        else
+          raise Errno::ENOENT.new path
+        end
+        conf
+      end
+    end
+
+    # Load configuration file
+    #
+    # @param file_path [String] path to file
+    # @return [Smash]
+    def load_file(file_path)
+      result = nil
+      errors = Smash.new
+      error = nil
+      begin
+        result = case File.extname(file_path)
+                 when '.yaml', '.yml'
+                   yaml_load(file_path)
+                 when '.json'
+                   json_load(file_path)
+                 when '.xml'
+                   xml_load(file_path)
+                 when '.rb'
+                   struct_load(file_path)
+                 else
+                   [:struct_load, :json_load, :yaml_load, :xml_load].each do |loader|
+                     begin
+                       result = send(loader, file_path)
+                       break
+                     rescue StandardError, ScriptError => e
+                       errors[loader] = e
+                       if(ENV['BOGO_DEBUG'])
+                         $stderr.puts "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
+                       end
+                     end
+                   end
+                   result
+                 end
+      rescue => error
+      end
+      unless(result)
+        raise FileLoadError.new(
+          "Failed to load configuration from file (#{file_path})",
+          error || extract_error_for(file_path, errors)
+        )
+      end
+      result
+    end
+
+    # Read and parse YAML file
+    #
+    # @param file_path
+    # @return [Smash]
+    def yaml_load(file_path)
+      YAML.load(File.read(file_path)).to_smash
+    end
+
+    # Read and parse JSON file
+    #
+    # @param file_path
+    # @return [Smash]
+    def json_load(file_path)
+      MultiJson.load(File.read(file_path)).to_smash
+    end
+
+    # Read and parse XML file
+    #
+    # @param file_path
+    # @return [Smash]
+    # @note supar ENTERPRISE
+    def xml_load(file_path)
+      result = MultiXml.parse(File.read(file_path)).to_smash[:configuration]
+      xml_format(result)
+    end
+
+    # Format XML types
+    #
+    # @param result [Smash]
+    # @return [Smash]
+    def xml_format(result)
+      Smash[result.map{|k,v| [k, xml_format_value(v)]}]
+    end
+
+    # Format XML value types
+    #
+    # @param value [Object]
+    # @return [Object]
+    def xml_format_value(value)
+      case value
+      when Hash
+        xml_format(value)
+      when Array
+        value.map{|v| xml_format_value(v)}
+      else
+        value.strip!
+        if(value == 'true')
+          true
+        elsif(value == 'false')
+          false
+        elsif(value.to_i.to_s == value)
+          value.to_i
+        elsif(value.to_f.to_s == value)
+          value.to_f
+        else
+          value
+        end
+      end
+    end
+
+    # Read and parse AttributeStruct file
+    #
+    # @param file_path
+    # @return [Smash]
+    def struct_load(file_path)
+      if(eval_disabled?)
+        raise 'Ruby based configuration evaluation is currently disabled!'
+      else
+        result = Module.new.instance_eval(
+          IO.read(file_path), file_path, 1
+        )
+        result._dump.to_smash
+      end
+    end
+
+    # @return [TrueClass, FalseClass]
+    def eval_enabled?
+      ENV['BOGO_CONFIG_DISABLE_EVAL'].to_s.downcase != 'true'
+    end
+
+    # @return [TrueClass, FalseClass]
+    def eval_disabled?
+      !eval_enabled?
+    end
+
+    # Extract appropriate execption based on path
+    #
+    # @param path [String]
+    # @param errors [Hash]
+    # @return [Exception, NilClass]
+    def extract_error_for(path, errors)
+      content = File.read(path).strip
+      if(content.start_with?('{'))
+        errors[:json_load]
+      elsif(content.start_with?('<'))
+        errors[:xml_load]
+      elsif(content.match(/\.new\s*(do|\{)/))
+        errors[:struct_load]
+      else
+        errors[:yaml_load]
+      end
+    end
+
+  end
+end

data/lib/bogo-config/config.rb

@@ -1,333 +1 @@
-require 'yaml'
-require 'multi_xml'
-require 'multi_json'
-require 'attribute_struct'
-require 'forwardable'
-
-require 'bogo-config'
-
-module Bogo
-
-  class Config
-
-    # Exception wrapper class used for configuration file load failure
-    class FileLoadError < LoadError
-
-      # @return [Exception]
-      attr_reader :original
-
-      def initialize(message, original_exception = nil)
-        super(message)
-        @original = original_exception
-      end
-
-      # @return [Fixnum]
-      def exit_code
-        222
-      end
-
-    end
-
-    class << self
-
-      include Bogo::Memoization
-
-      # Reload any registered `Bogo::Config` instances
-      #
-      # @return [TrueClass]
-      def reload!
-        obj_ids = memoize(:bogo_reloadable_configs, :global)
-        objects = Thread.exclusive do
-          ObjectSpace.each_object.find_all do |obj|
-            obj_ids.include?(obj.object_id)
-          end
-        end
-        objects.map(&:init!)
-        memoize(:bogo_reloadable_configs, :global).delete_if do |oid|
-          !obj_ids.include?(oid)
-        end
-        true
-      end
-
-      # Register config instance to auto reload on HUP
-      #
-      # @param config [Bogo::Config]
-      # @return [TrueClass]
-      def reloadable(config)
-        if(config.is_a?(Bogo::Config))
-          reloader
-          memoize(:bogo_reloadable_configs, :global){ [] }.push(config.object_id).uniq!
-        else
-          raise TypeError.new "Expecting type `Bogo::Config`. Received: `#{config.class}`"
-        end
-        true
-      end
-
-      # Internal reloader
-      #
-      # @return [Thread]
-      def reloader
-        memoize(:bogo_config_reloader, :global) do
-          Thread.new do
-            begin
-              loop do
-                begin
-                  sleep
-                rescue SignalException => e
-                  if(e.signm == 'SIGHUP')
-                    if(ENV['BOGO_DEBUG'])
-                      $stdout.puts 'SIGHUP encountered. Reloading `Bogo::Config` instances.'
-                    end
-                    Bogo::Config.reload!
-                  else
-                    raise
-                  end
-                end
-              end
-            rescue => e
-              if(ENV['BOGO_DEBUG'])
-                $stderr.puts "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
-              end
-              retry
-            end
-          end
-        end
-      end
-
-    end
-
-    include Bogo::Lazy
-    extend Forwardable
-
-    # @return [String] configuration path
-    attr_reader :path
-    # @return [String, Hash]
-    attr_reader :initial
-
-    # Create new instance
-    #
-    # @param path_or_hash [String, Hash] file/directory path or base Hash
-    # @return [self]
-    def initialize(path_or_hash=nil)
-      @initial = path_or_hash
-      @data = Smash.new
-      init!
-    end
-
-    # Enables automatic reloading on SIGHUP
-    #
-    # @return [TrueClass]
-    def reloadable!
-      Bogo::Config.reloadable(self)
-      true
-    end
-
-    # Freeze underlying configuration data
-    #
-    # @return [self]
-    def immutable!
-      @data = data.to_smash(:freeze)
-    end
-
-    # Intialize the configuration
-    #
-    # @return [self]
-    def init!
-      if(initial.is_a?(String))
-        @path = initial.dup
-        hash = load!
-      else
-        hash = initial
-      end
-      if(hash)
-        is_immutable = data.frozen?
-        # TODO: synchronize here
-        load_data(hash)
-        @data = hash.to_smash.deep_merge(data.to_smash)
-        @data.to_smash(:freeze) if is_immutable
-      end
-      self
-    end
-
-    # Allow Smash like behavior
-    def_delegators *([:data, :[]] + (Smash.public_instance_methods - Object.public_instance_methods))
-
-    # Override to force consistent data access (removes dirty
-    # functionality)
-    #
-    # @return [Smash]
-    def dirty
-      data
-    end
-
-    # @return [String]
-    def to_json(*args)
-      MultiJson.dump(data, *args)
-    end
-
-    # Load configuration from file(s)
-    #
-    # @return [self]
-    def load!
-      if(path)
-        if(File.directory?(path))
-          conf = Dir.glob(File.join(path, '*')).sort.inject(Smash.new) do |memo, file_path|
-            memo.deep_merge(load_file(file_path))
-          end
-        elsif(File.file?(path))
-          conf = load_file(path)
-        else
-          raise Errno::ENOENT.new path
-        end
-        conf
-      end
-    end
-
-    # Load configuration file
-    #
-    # @param file_path [String] path to file
-    # @return [Smash]
-    def load_file(file_path)
-      result = nil
-      errors = Smash.new
-      error = nil
-      begin
-        result = case File.extname(file_path)
-                 when '.yaml', '.yml'
-                   yaml_load(file_path)
-                 when '.json'
-                   json_load(file_path)
-                 when '.xml'
-                   xml_load(file_path)
-                 when '.rb'
-                   struct_load(file_path)
-                 else
-                   [:struct_load, :json_load, :yaml_load, :xml_load].each do |loader|
-                     begin
-                       result = send(loader, file_path)
-                       break
-                     rescue StandardError, ScriptError => e
-                       errors[loader] = e
-                       if(ENV['BOGO_DEBUG'])
-                         $stderr.puts "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
-                       end
-                     end
-                   end
-                   result
-                 end
-      rescue => error
-      end
-      unless(result)
-        raise FileLoadError.new(
-          "Failed to load configuration from file (#{file_path})",
-          error || extract_error_for(file_path, errors)
-        )
-      end
-      result
-    end
-
-    # Read and parse YAML file
-    #
-    # @param file_path
-    # @return [Smash]
-    def yaml_load(file_path)
-      YAML.load(File.read(file_path)).to_smash
-    end
-
-    # Read and parse JSON file
-    #
-    # @param file_path
-    # @return [Smash]
-    def json_load(file_path)
-      MultiJson.load(File.read(file_path)).to_smash
-    end
-
-    # Read and parse XML file
-    #
-    # @param file_path
-    # @return [Smash]
-    # @note supar ENTERPRISE
-    def xml_load(file_path)
-      result = MultiXml.parse(File.read(file_path)).to_smash[:configuration]
-      xml_format(result)
-    end
-
-    # Format XML types
-    #
-    # @param result [Smash]
-    # @return [Smash]
-    def xml_format(result)
-      Smash[result.map{|k,v| [k, xml_format_value(v)]}]
-    end
-
-    # Format XML value types
-    #
-    # @param value [Object]
-    # @return [Object]
-    def xml_format_value(value)
-      case value
-      when Hash
-        xml_format(value)
-      when Array
-        value.map{|v| xml_format_value(v)}
-      else
-        value.strip!
-        if(value == 'true')
-          true
-        elsif(value == 'false')
-          false
-        elsif(value.to_i.to_s == value)
-          value.to_i
-        elsif(value.to_f.to_s == value)
-          value.to_f
-        else
-          value
-        end
-      end
-    end
-
-    # Read and parse AttributeStruct file
-    #
-    # @param file_path
-    # @return [Smash]
-    def struct_load(file_path)
-      if(eval_disabled?)
-        raise 'Ruby based configuration evaluation is currently disabled!'
-      else
-        result = Module.new.instance_eval(
-          IO.read(file_path), file_path, 1
-        )
-        result._dump.to_smash
-      end
-    end
-
-    # @return [TrueClass, FalseClass]
-    def eval_enabled?
-      ENV['BOGO_CONFIG_DISABLE_EVAL'].to_s.downcase != 'true'
-    end
-
-    # @return [TrueClass, FalseClass]
-    def eval_disabled?
-      !eval_enabled?
-    end
-
-    # Extract appropriate execption based on path
-    #
-    # @param path [String]
-    # @param errors [Hash]
-    # @return [Exception, NilClass]
-    def extract_error_for(path, errors)
-      content = File.read(path).strip
-      if(content.start_with?('{'))
-        errors[:json_load]
-      elsif(content.start_with?('<'))
-        errors[:xml_load]
-      elsif(content.match(/\.new\s*(do|\{)/))
-        errors[:struct_load]
-      else
-        errors[:yaml_load]
-      end
-    end
-
-  end
-end
+require 'bogo/config'

data/lib/bogo-config/configuration.rb

@@ -1,5 +1 @@
-require 'bogo-config'
-require 'attribute_struct'
-
-class Configuration < AttributeStruct
-end
+require 'bogo/config'

data/lib/bogo-config/version.rb

@@ -1,6 +1 @@
-module Bogo
-  class Config
-    # Current library version
-    VERSION = Gem::Version.new('0.2.2')
-  end
-end
+require 'bogo/config'

data/lib/bogo-config.rb

@@ -1,5 +1 @@
-require 'bogo'
-require 'bogo-config/config'
-require 'bogo-config/version'
-
-autoload :Configuration, 'bogo-config/configuration'
+require 'bogo/config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bogo-config
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2022-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo
@@ -86,20 +86,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
 description: Configuration helper library
 email: code@chrisroberts.org
 executables: []
@@ -115,6 +129,9 @@ files:
 - lib/bogo-config/config.rb
 - lib/bogo-config/configuration.rb
 - lib/bogo-config/version.rb
+- lib/bogo/config.rb
+- lib/bogo/config/configuration.rb
+- lib/bogo/config/version.rb
 homepage: https://github.com/spox/bogo-config
 licenses:
 - Apache 2.0
@@ -134,10 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.4.0.dev
 signing_key: 
 specification_version: 4
 summary: Configuration helper library
 test_files: []
-has_rdoc: