mysticonfig 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c5f9c4fb90ae354a44fa7482acf2fc3e3350735b3c11056041f27b6d521232c
+  data.tar.gz: af6ce7b30d055dbbd2607d45d22cfda485e73ce373fa06837c3b901ae562cc7c
+SHA512:
+  metadata.gz: e8acfcf0d72f0542f291e143411462892dcfdf0d0380711665e457b9b24305053d385dc568b3eeee3ce7998fd97582b5fefe0718aa7f3ef1f406cbf277d6212f
+  data.tar.gz: 4b6c5f9f00cfa2dc809fae164e347e8833dca0a580d4d95a32d3b1e7a14c11303b23aa2256fc452721350a90631155c6155948d19143439c6bee0db089152118

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Saran Tanpituckpong
+
+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,32 @@
+# mysticonfig
+[![license](https://img.shields.io/github/license/gluons/mysticonfig.svg?style=flat-square)](./LICENSE)
+[![Gem](https://img.shields.io/gem/v/mysticonfig.svg?style=flat-square)](https://rubygems.org/gems/mysticonfig)
+[![Gem](https://img.shields.io/gem/dt/mysticonfig.svg?style=flat-square)](https://rubygems.org/gems/mysticonfig)
+[![Gemnasium](https://img.shields.io/gemnasium/gluons/mysticonfig.svg?style=flat-square)](https://gemnasium.com/github.com/gluons/mysticonfig)
+[![Travis](https://img.shields.io/travis/gluons/mysticonfig.svg?style=flat-square)](https://travis-ci.org/gluons/mysticonfig)
+<br><br>
+<p align="center">
+	<strong>🔮 The configuration loader for wizard.</strong>
+</p>
+<br>
+
+A library to load `.appnamerc`, `.appnamerc.json` or `.appnamerc.yaml` config file easily.
+
+> Gem's name inspired by [cosmiconfig](https://github.com/davidtheclark/cosmiconfig)
+
+## Installation
+
+```bash
+gem install mysticonfig
+```
+
+## Usage
+
+```ruby
+require 'mysticonfig'
+
+loader = Mysticonfig::Loader.new 'appname'
+config = loader.load # Automatically detect and load config
+json_config = loader.load_json # Only load config from JSON file
+yaml_config = loader.load_yaml # Only load config from YAML file (.yaml or .yml)
+```

data/lib/mysticonfig/utils.rb

@@ -0,0 +1,91 @@
+require 'json'
+require 'yaml'
+
+##
+# Mystic Config
+module Mysticonfig
+  ##
+  # Utilies
+  module Utils
+    ##
+    # Determine whether the given file is valid JSON file.
+    def self.json_file?(file)
+      return false if file.nil?
+
+      JSON.parse(File.read(file))
+      true
+    rescue
+      false
+    end
+
+    ##
+    # Determine whether the given file is valid YAML file.
+    def self.yaml_file?(file)
+      return false if file.nil? || json_file?(file)
+
+      result = YAML.safe_load(File.read(file))
+      result.is_a?(Hash)
+    rescue
+      false
+    end
+
+    ##
+    # Generate config filenames from given app name.
+    def self.generate_config_filenames(appname)
+      return nil if appname.nil?
+
+      {
+        plain: ".#{appname}rc",
+        json: ".#{appname}rc.json",
+        yaml: [".#{appname}rc.yaml", ".#{appname}rc.yml"]
+      }
+    end
+
+    ##
+    # Load JSON config file.
+    def self.load_json(config_file)
+      return {} if config_file.nil? || !File.exist?(config_file)
+
+      JSON.parse(File.read(config_file))
+    end
+
+    ##
+    # Load YAML config file.
+    def self.load_yaml(config_file)
+      return {} if config_file.nil? || !File.exist?(config_file)
+
+      YAML.safe_load(File.read(config_file))
+    end
+
+    ##
+    # Load config file with automatic file type detection.
+    def self.load_auto(config_file)
+      return {} if config_file.nil? || !File.exist?(config_file)
+
+      if json_file?(config_file)
+        load_json(config_file)
+      elsif yaml_file?(config_file)
+        load_yaml(config_file)
+      else
+        {}
+      end
+    end
+
+    ##
+    # Look up for an existent config file.
+    def self.lookup_file(config_file, dir = Dir.pwd)
+      dir = File.realpath dir
+      current_filepath = File.expand_path(config_file, dir)
+      return current_filepath if File.exist?(current_filepath)
+
+      # Stop on home directory or root directory.
+      home_path = File.expand_path '~'
+      is_home = dir == home_path
+      is_root = dir == '/'
+      return nil if is_home || is_root
+
+      upper_path = File.realpath('..', dir)
+      lookup_file(config_file, upper_path) # Traverse up
+    end
+  end
+end

data/lib/mysticonfig/version.rb

@@ -0,0 +1,4 @@
+# Mysticonfig
+module Mysticonfig
+  VERSION = '0.0.1'.freeze
+end

data/lib/mysticonfig.rb

@@ -0,0 +1,69 @@
+require_relative 'mysticonfig/utils'
+
+##
+# Mystic Config
+module Mysticonfig
+  ##
+  # Configuration loader.
+  class Loader
+    def initialize(appname)
+      @filenames = Utils.generate_config_filenames appname
+    end
+
+    ##
+    # Find and load config file.
+    def load
+      config_file = find_file @filenames
+
+      Utils.load_auto config_file
+    end
+
+    ##
+    # Find and load JSON config file.
+    def load_json
+      json_config_file = Utils.lookup_file @filenames[:json]
+
+      Utils.load_json json_config_file
+    end
+
+    ##
+    # Find and load YAML config file.
+    def load_yaml
+      yaml_config_files = @filenames[:yaml]
+      yaml_config_file = nil
+
+      yaml_config_files.each do |file|
+        yaml_config_file = Utils.lookup_file file
+        return Utils.load_yaml(yaml_config_file) unless yaml_config_file.nil?
+      end
+
+      {} # Return empty hash when can't load config file
+    end
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+
+    ##
+    # Find an existent config file from all posible files.
+    def find_file(filenames)
+      return nil if filenames.nil?
+
+      filenames.each_value do |value|
+        if value.is_a? Array
+          value.each do |file|
+            file_path = Utils.lookup_file file
+            return file_path unless file_path.nil?
+          end
+        else
+          file_path = Utils.lookup_file value
+          return file_path unless file_path.nil?
+        end
+      end
+
+      nil
+    end
+
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/mysticonfig.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('./lib', File.dirname(__FILE__))
+
+$LOAD_PATH.push lib unless $LOAD_PATH.include?(lib)
+
+require 'mysticonfig/version'
+
+DESCRIPTION = 'The configuration loader to load rc config file.'.freeze
+
+Gem::Specification.new do |s|
+  s.name = 'mysticonfig'
+  s.version = Mysticonfig::VERSION
+  s.summary = 'The configuration loader for wizard.'
+  s.description = DESCRIPTION
+  s.files = ['mysticonfig.gemspec', 'LICENSE', 'Gemfile']
+  s.files += Dir['*.md', 'lib/**/*']
+  s.required_ruby_version = '>= 2.1.0'
+  s.author = 'Saran Tanpituckpong'
+  s.license = 'MIT'
+  s.homepage = 'https://github.com/gluons/mysticonfig'
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/gluons/mysticonfig/issues',
+    'homepage_uri' => 'https://gluons.github.io/mysticonfig/'
+  }
+
+  s.add_runtime_dependency 'json', '~> 2.1'
+
+  s.add_development_dependency 'rake', '~> 12.3'
+  s.add_development_dependency 'rspec', '~> 3.7'
+  s.add_development_dependency 'rubocop', '~> 0.52.1'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: mysticonfig
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Saran Tanpituckpong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+description: The configuration loader to load rc config file.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/mysticonfig.rb
+- lib/mysticonfig/utils.rb
+- lib/mysticonfig/version.rb
+- mysticonfig.gemspec
+homepage: https://github.com/gluons/mysticonfig
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/gluons/mysticonfig/issues
+  homepage_uri: https://gluons.github.io/mysticonfig/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.5
+signing_key: 
+specification_version: 4
+summary: The configuration loader for wizard.
+test_files: []