dh_easy-config 0.0.6

data/lib/dh_easy/config.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+require 'dh_easy/core'
+require 'dh_easy/config/version'
+require 'dh_easy/config/local'
+
+module DhEasy
+  module Config
+  end
+end

data/lib/dh_easy/config/local.rb

@@ -0,0 +1,128 @@
+module DhEasy
+  module Config
+    # Manage configuration from a file.
+    class Local
+      # Configuration loaded from local configuarion file (see #load).
+      #
+      # @return [Hash,nil] `nil` when nothing has been loaded.
+      attr_reader :local
+
+      # Clear cache.
+      def self.clear_cache
+        @@local = {}
+      end
+
+      # Load into or from cache a configuration file contents.
+      #
+      # @param [String] file_path Configuration file path.
+      # @param [Hash] opts ({}) Configuration options.
+      # @option opts [Boolean] :force (false) Will reload configuration file
+      #   when `true`.
+      #
+      # @return [Hash] Configuration file contents.
+      def self.load_file file_path, opts = {}
+        opts = {
+          force: false
+        }.merge opts
+
+        return {} if file_path.nil?
+
+        @@local ||= {}
+        key = file_path = File.expand_path file_path
+        return @@local[key] if !opts[:force] && @@local.has_key?(key)
+
+        @@local[key] = (YAML.load_file(file_path) rescue {}) || {}
+        @@local[key].freeze
+      end
+
+      # Default configuration file path list to be prioritized from first to last.
+      #
+      # @return [Array<String>] Configuration file path list. Default is
+      #   `['./dh_easy.yaml', './dh_easy.yml']`
+      def self.default_file_path_list
+        @@default_file_path_list ||= [
+          './dh_easy.yaml',
+          './dh_easy.yml'
+        ]
+      end
+
+      # Convert to hash.
+      #
+      # @return [Hash]
+      def to_h
+        local
+      end
+
+      # Get configuration key contents.
+      #
+      # @param [String] key Configuration option key.
+      #
+      # @return [Object,nil]
+      def [](key)
+        local[key]
+      end
+
+      # Lookup #file_path_list for the first valid file.
+      #
+      # @return [String,nil] Valid file path or `nil`.
+      def lookup_file_path
+        file_path_list.each do |candidate_file_path|
+          next unless File.file?(File.expand_path(candidate_file_path))
+          return candidate_file_path
+        end
+        nil
+      end
+
+      # Local configuration file path. It will lookup for the first valid file
+      #   at #file_path_list as default value.
+      #
+      # @return [String] Configuration local file path.
+      def file_path
+        @file_path ||= lookup_file_path
+      end
+
+      # Local configuration file path list. It will prioritize from first to last.
+      #
+      # @return [Array<String>] Configuration local file path.
+      def file_path_list
+        @file_path_list ||= self.class.default_file_path_list
+      end
+
+      # Loads a local configuration file.
+      #
+      # @param [Hash] opts ({}) Configuration options.
+      # @option opts [String] :file_path (nil) Configuration file path to load (see
+      #   #file_path for configuration default file.)
+      # @option opts [Boolean] :force (false) Will reload configuration file
+      #   when `true`.
+      def load opts = {}
+        opts = {
+          file_path: nil,
+          force: false
+        }.merge opts
+        @file_path = opts[:file_path] || file_path
+        @local = self.class.load_file(file_path, opts)
+      end
+
+      # Reloads local configuration file.
+      def reload!
+        load force: true
+      end
+
+      # Reset instance to lookup for valid files from #file_path_list and load
+      #   the first valid configuration file found.
+      def reset!
+        @file_path = nil
+        load force: true
+      end
+
+      # Initialize.
+      #
+      # @param [Hash] opts ({}) Configuration options (see #load).
+      def initialize opts = {}
+        @file_path_list = (opts.delete(:file_path_list) + []) unless opts[:file_path_list].nil?
+        load opts
+      end
+    end
+  end
+end

data/lib/dh_easy/config/version.rb

@@ -0,0 +1,6 @@
+module DhEasy
+  module Config
+    # Gem version
+    VERSION = "0.0.6"
+  end
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: dh_easy-config
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Eduardo Rosales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dh_easy-core
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: simplecov-console
+  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: timecop
+  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: byebug
+  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'
+description: DataHen Easy toolkit config module allow an easy configuration from files
+  for advance features.
+email:
+- eduardo@datahen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dh_easy-config.gemspec
+- doc/DhEasy.html
+- doc/DhEasy/Config.html
+- doc/DhEasy/Config/Local.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/dh_easy/config.rb
+- lib/dh_easy/config/local.rb
+- lib/dh_easy/config/version.rb
+homepage: https://datahen.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://datahen.com
+  source_code_uri: https://github.com/DataHenOfficial/dh_easy-config
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: DataHen Easy toolkit config module
+test_files: []