mysticonfig 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c5f9c4fb90ae354a44fa7482acf2fc3e3350735b3c11056041f27b6d521232c
-  data.tar.gz: af6ce7b30d055dbbd2607d45d22cfda485e73ce373fa06837c3b901ae562cc7c
+  metadata.gz: 20e1e44f2df29f68de88c7a553a10b761b8528451217636d8ffa7c9f01c04e2a
+  data.tar.gz: 359a08038b71b236b6b4d35ef1e841937fa29c25c8e7e3e446c9f1ec8d57b5ec
 SHA512:
-  metadata.gz: e8acfcf0d72f0542f291e143411462892dcfdf0d0380711665e457b9b24305053d385dc568b3eeee3ce7998fd97582b5fefe0718aa7f3ef1f406cbf277d6212f
-  data.tar.gz: 4b6c5f9f00cfa2dc809fae164e347e8833dca0a580d4d95a32d3b1e7a14c11303b23aa2256fc452721350a90631155c6155948d19143439c6bee0db089152118
+  metadata.gz: 378f5488068ed8b63276cb41b81105feaef7e7747b6bab14e6e2c0a738a1dae8def0cda9b345ba989edbb22364cd40ac0852d5d579fc64b36259edbfeed1796e
+  data.tar.gz: 6f9853d8f2ba64230eb75f2c798bf404c046fdd708d421c3f0516f1cfd42bc7fdf28245ee05828142d4e480c4a7405d80827184b971e7f76f36dc54867186797

data/README.md

@@ -12,6 +12,9 @@
 
 A library to load `.appnamerc`, `.appnamerc.json` or `.appnamerc.yaml` config file easily.
 
+`mysticonfig` will lookup for your config file.  
+It keeps traversing up until it **finds the config file** or **reaches your home directory**.
+
 > Gem's name inspired by [cosmiconfig](https://github.com/davidtheclark/cosmiconfig)
 
 ## Installation
@@ -22,6 +25,8 @@ gem install mysticonfig
 
 ## Usage
 
+### Normal
+
 ```ruby
 require 'mysticonfig'
 
@@ -30,3 +35,24 @@ 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)
 ```
+
+### With default config fallback
+
+```ruby
+require 'mysticonfig'
+
+DEFAULT_CONFIG = {
+	'a' => 'A',
+	'b' => 'B',
+	'c' => 'C'
+}
+
+loader = Mysticonfig::Loader.new('appname', DEFAULT_CONFIG)
+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)
+```
+
+## Documentation
+
+See https://gluons.github.io/mysticonfig/

data/lib/mysticonfig.rb

@@ -6,8 +6,9 @@ module Mysticonfig
   ##
   # Configuration loader.
   class Loader
-    def initialize(appname)
+    def initialize(appname, default_config = {})
       @filenames = Utils.generate_config_filenames appname
+      @default_config = default_config
     end
 
     ##
@@ -15,7 +16,8 @@ module Mysticonfig
     def load
       config_file = find_file @filenames
 
-      Utils.load_auto config_file
+      config = Utils.load_auto config_file
+      config.empty? ? @default_config : @default_config.merge(config)
     end
 
     ##
@@ -23,7 +25,8 @@ module Mysticonfig
     def load_json
       json_config_file = Utils.lookup_file @filenames[:json]
 
-      Utils.load_json json_config_file
+      config = Utils.load_json json_config_file
+      config.empty? ? @default_config : @default_config.merge(config)
     end
 
     ##
@@ -34,10 +37,13 @@ module Mysticonfig
 
       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?
+        unless yaml_config_file.nil?
+          config = Utils.load_yaml(yaml_config_file)
+          return config.empty? ? @default_config : @default_config.merge(config)
+        end
       end
 
-      {} # Return empty hash when can't load config file
+      @default_config # Return default config when can't load config file
     end
 
     private

data/lib/mysticonfig/utils.rb

@@ -5,7 +5,7 @@ require 'yaml'
 # Mystic Config
 module Mysticonfig
   ##
-  # Utilies
+  # Utilities
   module Utils
     ##
     # Determine whether the given file is valid JSON file.

data/lib/mysticonfig/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysticonfig
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Saran Tanpituckpong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json