config_files 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba83f6bade45d06bfa8a9ea74ba48915cfa9c908790f635aea7c53e5e12ffb2d
-  data.tar.gz: 969daeff600eb0fd4e6e084e33b3d83159e9aded3cae3df02f46528c073182dd
+  metadata.gz: 69666324c397bf59a18efef190d2660ce376143b246bda3752409af21fe1b51b
+  data.tar.gz: 79c42d11ba5617e182e6b6cdb56074036c99f7bcd32fe0f5f0d0022b971f3194
 SHA512:
-  metadata.gz: 70ad5d3313cb4a8a623bf07a0a113ab945b0ef729393d474cb076a392c5d5dbcdb5e87cc7c8dc4da0118a7f64afa31e4a5c8987f08185982590127fb94e9b731
-  data.tar.gz: 15b8aa187cdcd0ce70123ad2c98eb8a7f30652fac7455ea8a7792b570847f7b3923668b415dca9a9f6fbc9db89e008299e22dd7ca694a4d18fdd6fcf29f8548d
+  metadata.gz: e53a814869eaebf6ed6b6ecc55425dedbaca918434168720e96eed9812a84bce6b64f0818c5b751343b20ce4adc42d7d23ab3b01b857542443fb8da68a5a7eca
+  data.tar.gz: 72ea7cc041cf8405429244a42c96a5a2f275de969b9fd183b62bca9423271847d38a43ae3970b23b64679643a3acdc26ff594c82a75456509c9a7a94cb76e830

data/.gitignore

@@ -0,0 +1,3 @@
+# Created by .ignore support plugin (hsz.mobi)
+.idea/
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENCE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2012] [Paul McKibbin]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+*Description*
+
+Since it no longer just deals with yaml files as an input, *blackrat_yaml_config* has been renamed to *config_files*
+Configuration file manager.
+
+*Features*
+
+Searches for first match in multiple directories for configuration file
+Allows for dynamically updated or static config files
+
+*Example*
+
+    require 'config_files'
+
+    class Dummy
+      include ConfigFiles #mixin the config_directories and config_files generators
+
+      #search directories (in order). The system will search for the file in the following directories
+      config_directories :etc=>['~/.dummy','/opt/dummy/config','/etc/default/dummy','/etc']
+
+      #The dummy.yml and another_yaml_file.yml will be pre-loaded.
+      static_config_files :dummy, :another_yaml_file
+
+      #yet_another_yaml_file.yml will be read every time the .yet_another_yaml_file method is accessed.
+      dynamic_config_files :yet_another_yaml_file
+
+      def use_config
+        some_method(Dummy.dummy[:key]) #extract the constant values from the :key in dummy.yml
+        another_method(Dummy.yet_another_yaml_file[:another_key]) #extract the constant value from the :another_key in yet_another_yaml_file.yml
+      end
+
+    end
+
+
+
+*Todo*
+
+Allow for different keys to be stored in files in different subdirectories to allow for overridable defaults

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/config_files.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'config_files/version'
+
+Gem::Specification.new do |spec|
+  spec.authors     = ['Paul McKibbin']
+  spec.email       = ['pmckibbin@gmail.com']
+  spec.description = 'A configuration tool for using multiple configuration files with multiple formats by presenting them as a hash.'
+  spec.summary     = <<-SUMMARY
+  ConfigFiles is a configuration file access tool. It parses multiple configuration files in multiple formats and
+  presents a consistent block to the application with options to cache or use the files dynamically
+SUMMARY
+
+  spec.homepage    = 'https://github.com/blackrat/config_files'
+  spec.files       = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  spec.test_files  = spec.files.grep(%r{^(test|spec|features)/})
+  spec.name        = 'config_files'
+  spec.require_paths = ['lib']
+  spec.version     = ConfigFiles::VERSION
+  spec.license     = 'MIT'
+  spec.date        = '2012-11-11'
+
+  spec.add_dependency 'activesupport'
+end

data/lib/config_files/file_factory.rb

@@ -0,0 +1,15 @@
+module ConfigFiles
+  class FileFactory
+    class << self
+      private
+      def loader(file_name, options)
+        LoaderFactory.(file_name, options)
+      end
+
+      public
+      def call(file_name, options={})
+        loader(file_name, options).(file_name, object_class: ::Hash)
+      end
+    end
+  end
+end

data/lib/config_files/loader_factory.rb

@@ -0,0 +1,52 @@
+module ConfigFiles
+  class LoaderFactory
+    class << self
+      public
+      def call(file_name, options={include_default: true})
+        new(options).call(file_name)
+      end
+    end
+
+    private
+    attr_reader :options
+
+    def default_loaders
+      {
+        Loaders::Yaml => ['yaml', 'yml'],
+        Loaders::Json =>  ['json']
+      }
+    end
+
+    def default_loader
+      options[:default_loader]
+    end
+
+    def default_options
+      {
+        include_default: true,
+        default_loader: Loaders::Yaml,
+        loaders: default_loaders
+      }
+    end
+
+    def include_default_loaders?
+      options[:include_default]
+    end
+
+    def loaders
+      options[:loaders]
+    end
+
+    def initialize(options) #Note the check below is necessary, because we only want to do it if it is explicity set
+      @options=default_options.merge(options)
+      if include_default_loaders?
+        @options[:loaders]=default_loaders.merge(loaders)
+      end
+    end
+
+    public
+    def call(file_name)
+      loaders.detect{|_, extensions| extensions.include?(::File.extname(file_name).strip.downcase[1..-1])}&.first || default_loader
+    end
+  end
+end

data/lib/config_files/loaders/default.rb

@@ -0,0 +1 @@
+ConfigFiles::Loaders::Default=ConfigFiles::Loaders::Yaml

data/lib/config_files/loaders/json.rb

@@ -0,0 +1,13 @@
+require 'json'
+
+module ConfigFiles
+  module Loaders
+    class Json
+      class << self
+        def call(file_name, object_class: ::OpenStruct)
+          ::JSON.load(file_name, nil, {object_class: object_class})
+        end
+      end
+    end
+  end
+end

data/lib/config_files/loaders/yaml.rb

@@ -0,0 +1,11 @@
+module ConfigFiles
+  module Loaders
+    class Yaml
+      class << self
+        def call(file_name, object_class: OpenStruct)
+          JSON.parse(::YAML.load_file(file_name).to_json, object_class: object_class)
+        end
+      end
+    end
+  end
+end

data/lib/config_files/loaders.rb

@@ -0,0 +1,3 @@
+require_relative 'loaders/json'
+require_relative 'loaders/yaml'
+require_relative 'loaders/default'

data/lib/config_files/version.rb

@@ -0,0 +1,3 @@
+module ConfigFiles
+  VERSION='0.1.0'
+end

data/lib/config_files.rb

@@ -1,3 +1,9 @@
+require 'config_files/file_factory'
+require 'config_files/loader_factory'
+require 'config_files/loaders'
+require 'config_files/version'
+require 'active_support/core_ext/hash/deep_merge'
+
 require 'meta'
 require 'yaml'
 module ConfigFiles
@@ -14,8 +20,8 @@ module ConfigFiles
     include Meta
     attr_accessor :directories
 
-    def yaml_extension
-      '.yml'
+    def any_extension
+      '*'
     end
 
     def config_key
@@ -32,16 +38,24 @@ module ConfigFiles
       end
     end
 
+    def merged_hash(file)
+      config_files(file).inject({}) { |master, file|  master.deep_merge(FileFactory.(file)) }
+    end
+
+    def build_combined(file)
+      JSON.parse(merged_hash(file).to_json, object_class: OpenStruct)
+    end
+
     def static_config_files(*arr)
       arr.each do |file|
-        content=YAML.load_file(config_file(file))
+        content=build_combined(file)
         meta_def(file) { content }
       end
     end
 
     def dynamic_config_files(*arr)
       arr.each do |file|
-        meta_def(file) { YAML.load_file(config_file(file)) }
+        meta_def(file) { build_combined(file) }
       end
     end
 
@@ -49,13 +63,15 @@ module ConfigFiles
 
     private
     def first_directory(file, key=config_key)
-      self.directories[key].find { |directory|
-        File.exists?(File.join(directory, "#{file}#{yaml_extension}"))
-      } || (raise Errno::ENOENT, "No #{file}#{yaml_extension} in #{self.directories[key]}")
+      self.directories[key]&.detect { |directory| Dir.glob(File.join(directory, "#{file}.*")) } || (raise Errno::ENOENT, "No #{file}.* in #{self.directories[key]}")
+    end
+
+    def files(file, key=config_key)
+      Dir.glob(File.join(first_directory(file, key), "#{file}.*"))
     end
 
-    def config_file(file, key=config_key)
-      File.join(first_directory(file, key), "#{file}#{yaml_extension}")
+    def config_files(file, key=config_key)
+      files(file, key)
     end
   end
 end

data/test/config_files_test.rb

@@ -0,0 +1,47 @@
+$:.push(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'minitest/autorun'
+require 'config_files'
+class Dummy
+  include ConfigFiles
+  config_directories :etc => ['etc', 'nofiles/etc']
+  static_config_files :dummy, :broken
+end
+
+class Dummy2 < Dummy
+  config_directories 'config' => ['etc', 'nofiles/etc']
+  class << self
+    def config_key
+      "config"
+    end
+  end
+end
+
+class ConfigFilesTest < MiniTest::Test
+  def test_config_key
+    assert_equal(:etc, Dummy.config_key)
+  end
+
+  def test_directory_is_initialized
+    assert(Dummy.directories)
+  end
+
+  def test_has_created_methods
+    assert(Dummy.etc_dir)
+  end
+
+  def test_created_paths_for_directories
+    assert_equal([File.join(__dir__, 'etc'), File.join(__dir__, 'nofiles/etc')], Dummy.etc_dir)
+  end
+
+  def test_created_variables
+    assert_equal('test', Dummy.dummy[:config_test])
+  end
+
+  def test_empty_for_missing_files
+    assert_equal({}, Dummy.broken.to_h)
+  end
+
+  def test_yaml_and_config_override
+    assert_equal('test', Dummy2.dummy[:config_test])
+  end
+end

data/test/etc/dummy.conf

@@ -0,0 +1,2 @@
+:config_test: test2
+:only_in_conf: conf_file

data/test/etc/dummy.yml

@@ -0,0 +1,2 @@
+:config_test: test
+:only_in_yaml: yaml_file

data/test/loader_factory_test.rb

@@ -0,0 +1,40 @@
+$:.push(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'minitest/autorun'
+require 'config_files'
+class LoaderFactoryDummy
+  class << self
+    def call(file_name, options={})
+      nil
+    end
+  end
+end
+
+class LoaderFactoryTest < MiniTest::Test
+  def file_locations
+    File.join(__dir__, 'etc')
+  end
+
+  def test_detect_yaml_file_type
+    assert_equal(::ConfigFiles::Loaders::Yaml, ::ConfigFiles::LoaderFactory.(File.join(file_locations,'dummy.yml')))
+  end
+
+  def test_detect_json_file_type
+    assert_equal(::ConfigFiles::Loaders::Json, ::ConfigFiles::LoaderFactory.(File.join(file_locations,'dummy.json')))
+  end
+
+  def test_detect_unknown_file_type
+    assert_nil(::ConfigFiles::LoaderFactory.(File.join(file_locations,'dummy.wibble'), default_loader: nil))
+  end
+
+  def test_allow_addition_of_file_types_does_not_break_existing
+    assert_equal(::ConfigFiles::Loaders::Yaml, ::ConfigFiles::LoaderFactory.(File.join(file_locations,'dummy.yml'), loaders: {LoaderFactoryDummy=>['wibble']}))
+  end
+
+  def test_allow_addition_of_file_types_breaks_existing_if_specified
+    assert_nil(::ConfigFiles::LoaderFactory.(File.join(file_locations,'dummy.yml'), loaders: {LoaderFactoryDummy=>['wibble']}, include_default: false, default_loader: nil))
+  end
+
+  def test_addition_of_new_loaders
+    assert_equal(LoaderFactoryDummy, ::ConfigFiles::LoaderFactory.(File.join(file_locations,'dummy.wibble'), loaders: {LoaderFactoryDummy=>['wibble']}, include_default: false))
+  end
+end

metadata

@@ -1,26 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: config_files
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Paul McKibbin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-08 00:00:00.000000000 Z
-dependencies: []
+date: 2012-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A configuration tool for using multiple configuration files with multiple
   formats by presenting them as a hash.
-email: pmckibbin@gmail.com
+email:
+- pmckibbin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- LICENCE.txt
+- README.md
+- Rakefile
+- config_files.gemspec
 - lib/config_files.rb
+- lib/config_files/file_factory.rb
+- lib/config_files/loader_factory.rb
+- lib/config_files/loaders.rb
+- lib/config_files/loaders/default.rb
+- lib/config_files/loaders/json.rb
+- lib/config_files/loaders/yaml.rb
+- lib/config_files/version.rb
 - lib/meta.rb
+- test/config_files_test.rb
+- test/etc/dummy.conf
+- test/etc/dummy.yml
+- test/loader_factory_test.rb
 homepage: https://github.com/blackrat/config_files
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -38,8 +71,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Configuration File Manager
-test_files: []
+summary: ConfigFiles is a configuration file access tool. It parses multiple configuration
+  files in multiple formats and presents a consistent block to the application with
+  options to cache or use the files dynamically
+test_files:
+- test/config_files_test.rb
+- test/etc/dummy.conf
+- test/etc/dummy.yml
+- test/loader_factory_test.rb