thor-addons 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe504337d71eb421b7e686edcaaf999deafb7628
-  data.tar.gz: 6289a2a15f4d44a9e69680834f8fffc4b9a7c7c3
+  metadata.gz: ecbce51975324beec95b2ec8bbd5c4a0d7272beb
+  data.tar.gz: 65ff6886d60b046be49187208c4f53b2f1608827
 SHA512:
-  metadata.gz: a7c1f13322c537f4302ece4d3b051ba4bd1e6d5edb1e1be3a7f4dd2c6f68a0c02db6073f39e44b519caad44560112ade00fdfdc902a5d60b92a6a8af6a0ef337
-  data.tar.gz: ba538f94df0b4df7ef4f781eccdb5c89f912a8fd2b4ba2679ee6ebb753e986f21e6b320e07a46c79b53165f68ce18fe0ee3d62f4aca20a047f5fa21d1dea8356
+  metadata.gz: cb0497cde13470f94d69ab3b337cfc96aaa0942305992295afcad8ca0a99130668a2f2225b93d92ebe5c6b504bc18299d0d5d4111f7ec1baa056aed7ff633d1f
+  data.tar.gz: a7a78ecf49cb710dbdb7629e2f18aebd259ea44af3b57ebb48def44e9886facb0b621266648f99d31753f981c8e4130836a650fd890117e12ad98b0fcea431b3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.1.4 (21/09/2017)
+
+BUG FIXES:
+
+ * Options override #2 ([#4](https://github.com/eredi93/thor-addons/pull/8))
+
 0.1.3 (08/08/2017)
 
 BUG FIXES:

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+### Pull Requests
+
+Here are some reasons why a pull request may not be merged:
+
+1. It hasn’t been reviewed.
+2. It doesn’t include specs for new functionality.
+3. It doesn’t include documentation for new functionality.
+4. It changes behavior without changing the relevant documentation, comments, or specs.
+5. It changes behavior of an existing public API, breaking backward compatibility.
+6. It breaks the tests on a supported platform.
+7. It doesn’t merge cleanly (requiring Git rebasing and conflict resolution).

data/README.md

@@ -4,3 +4,84 @@
 [![Gem Version](https://badge.fury.io/rb/thor-addons.svg)](http://badge.fury.io/rb/thor-addons)
 
 Extend [Thor](https://github.com/erikhuda/thor) with useful Add-ons
+
+### Installation
+
+```
+gem install thor-addons
+```
+
+### Usage
+
+#### Options
+
+The `Options` module allows you to read the CLI options from a configuration file or/and environment variables.
+
+
+include the Options module to your Thor class.
+
+```
+require 'thor'
+require 'thor_addons'
+
+class CLI < Thor
+  include ThorAddons::Options
+
+  class_option :config_file, type: :string, default: "config.yml", desc: "Configuration file for the CLI"
+
+  method_option :bar, type: :string, default: "biz", desc: "some option"
+  desc "foo", "install one of the available apps"
+  def foo
+    # code
+  end
+end
+```
+
+In the example above the `--bar` option will be read from the configuration file `--config-file`
+
+```
+foo:
+  bar: "zip"
+```
+
+and via the environment variable `BAR`
+
+if you want to disable the configuration file you need to set in your class
+
+```
+def with_config_file?
+  false
+end
+```
+
+and for disabling the environment variables
+
+```
+def with_env?
+  false
+end
+```
+
+you can also have environment variables aliases, by setting
+
+```
+def envs_aliases
+  { "BAR" => "MY_BAR" }
+end
+```
+
+The cli will set bar with the value of `BAR` or `MY_BAR` if `BAR` is not set.
+
+This module will set the options in this order: cli options, config file, environment variables
+
+### Contributing
+
+If you would like to help, please read the [CONTRIBUTING][] file for suggestions.
+
+[contributing]: CONTRIBUTING.md
+
+### License
+
+Released under the MIT License.  See the [LICENSE][] file for further details.
+
+[license]: LICENSE.md

data/lib/thor_addons/options.rb

@@ -95,7 +95,7 @@ module ThorAddons
 
     def add_defaults(hash)
       hash.inject({}) do |memo, (k, v)|
-        memo[k] = v.nil? ? defaults[k] : v
+        memo[k] = v.nil? ? defaults[k.to_sym] : v
 
         memo
       end
@@ -103,7 +103,7 @@ module ThorAddons
 
     def remove_defaults(hash)
       hash.inject({}) do |memo, (k, v)|
-        if defaults[k] == v
+        if defaults[k.to_sym] == v
           memo[k] = nil
         else
           memo[k] = v

data/lib/thor_addons/version.rb

@@ -1,3 +1,3 @@
 module ThorAddons
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thor-addons
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jacopo Scrinzi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Dockerfile
 - Gemfile
 - README.md