thor-addons 0.1.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0637e70de16cdaca1968148540bc7919e001497e8c60d5212a6a5cc2bc760678
-  data.tar.gz: 1f53c76ebc9e27064fb9660c7123a740420ebe4e186884995bb4c694f0dbc66e
+  metadata.gz: '0805d43eb2a94a29a350e4d325f786627dbf24aea71e8d7bf481519901a9698a'
+  data.tar.gz: 89c2db5f9e7c866da3c40beec05e670b74d7a72a8bebfadc3d9dbd73621da1db
 SHA512:
-  metadata.gz: 0bbd51f8c4ff0a3ca464f3e3f3d6fa45053b20d874f4f094338d9743135749eec3e0fa3fa222cb4d78e7ae8d5a954e23d221caa7c2dd6b326e5c3c97be7f4cfb
-  data.tar.gz: 5af2e01103e9fa9b2603303260b873fddf52a3da26a7cb02b59bfbabb0a88d245a153bcbc8b4a0b1c0efe692e34ceea005c0738161030e27589a935b1de74e9f
+  metadata.gz: 7147d625670b7c69be63866b31d5a09a73e54521786c7af166704ceb7067988def0dacf97bb440dd2175243fe865e096efe3e73c1422c45078444036f3d59c79
+  data.tar.gz: 3af249f36fee8007549a23ba780d1bb184e64996fc4117a7b6a6734d66495f4d86ac2efc332e99606a4b8803c756aa3f2eee6dc15bb77689cbb83081bcdceb33

data/.rubocop.yml

@@ -0,0 +1,18 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Naming/FileName:
+  Exclude:
+    - lib/thor-addons.rb
+    - spec/lib/thor-addons_spec.rb
+
+# disable for now
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
 rvm:
-  - 2.3.3
-  - 2.3.1
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+before_script:
+  - bundle exec rubocop
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+1.0.0 (14/04/2018)
+
+IMPROVEMENTS:
+
+ * Convert ENV vars to correct type
+ * Fail if type is incorrect
+ * add rubocop
+
 0.1.5 (13/03/2018)
 
 BUG FIXES:

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.3.3
+FROM ruby:2.5.1
 
 ENV WORKDIR /thor-addons
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -7,7 +7,7 @@ Extend [Thor](https://github.com/erikhuda/thor) with useful Add-ons
 
 ### Installation
 
-```
+```shell
 gem install thor-addons
 ```
 
@@ -20,7 +20,7 @@ The `Options` module allows you to read the CLI options from a configuration fil
 
 include the Options module to your Thor class.
 
-```
+```ruby
 require 'thor'
 require 'thor_addons'
 
@@ -39,7 +39,7 @@ end
 
 In the example above the `--bar` option will be read from the configuration file `--config-file`
 
-```
+```ruby
 foo:
   bar: "zip"
 ```
@@ -48,7 +48,7 @@ and via the environment variable `BAR`
 
 if you want to disable the configuration file you need to set in your class
 
-```
+```ruby
 def with_config_file?
   false
 end
@@ -56,7 +56,7 @@ end
 
 and for disabling the environment variables
 
-```
+```ruby
 def with_env?
   false
 end
@@ -64,8 +64,9 @@ end
 
 you can also have environment variables aliases, by setting
 
-```
+```ruby
 def envs_aliases
+  # source => alias
   { "BAR" => "MY_BAR" }
 end
 ```

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/ext/string.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class String
+  TRUES  = %w[t true on y yes 1].freeze
+  FALSES = %w[f false off n no 0].freeze
+
+  def to_b(invalid_value_behaviour: proc { nil })
+    value = strip.downcase
+    return true  if TRUES.include?(value)
+    return false if FALSES.include?(value)
+
+    invalid_value_behaviour.call
+  end
+
+  def to_a(delimiter: " ")
+    split(delimiter)
+  end
+
+  def to_h(arr_sep: " ", key_sep: ":")
+    split(arr_sep).each_with_object({}) do |e, hsh|
+      key, value = e.split(key_sep)
+
+      hsh[key] = value
+    end
+  end
+
+  def to_n
+    return to_f if self =~ /[0-9]+\.[0-9]+/
+
+    to_i
+  end
+end

data/lib/thor-addons/helpers/defaults.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ThorAddons
+  module Helpers
+    class Defaults
+      def self.load(klass, config)
+        options = klass.class_options.dup
+        options.merge!(config[:class_options]) if config[:class_options]
+        options.merge!(config[:command_options]) if config[:command_options]
+
+        options.each_with_object({}) do |(name, obj), hsh|
+          value = obj.respond_to?(:default) ? obj.default : nil
+          type = obj.respond_to?(:type) ? obj.type : :string
+
+          hsh[name] = { value: value, type: type }
+        end
+      end
+
+      def self.add(hash, defaults)
+        hash.each_with_object({}) do |(k, v), hsh|
+          hsh[k] = v.nil? ? defaults[k][:value] : v
+        end
+      end
+
+      def self.remove(hash, defaults)
+        hash.each_with_object({}) do |(k, v), hsh|
+          hsh[k] = nil
+
+          hsh[k] = v unless defaults[k][:value] == v
+        end
+      end
+    end
+  end
+end

data/lib/thor-addons/helpers/option_type.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ThorAddons
+  module Helpers
+    class OptionType
+      attr_reader :option, :type
+
+      def initialize(option, type)
+        @option = option
+        @type = type
+
+        raise TypeError, "Invalid type: '#{type}'" unless
+          TYPE_CLASS_MAP.keys.include?(type)
+      end
+
+      TYPE_CLASS_MAP = {
+        array: [Array],
+        boolean: [TrueClass, FalseClass],
+        hash: [Hash],
+        numeric: [Integer, Float],
+        string: [String]
+      }.freeze
+
+      def valid?
+        TYPE_CLASS_MAP[type].any? { |klass| option.is_a?(klass) }
+      end
+
+      def convert_string
+        case type
+        when :boolean then option.to_b
+        when :array then option.to_a
+        when :hash then option.to_h
+        when :numeric then option.to_n
+        else option
+        end
+      end
+    end
+  end
+end

data/lib/thor-addons/helpers/options_config_file.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ThorAddons
+  module Helpers
+    class OptionsConfigFile
+      def self.parse_config_file(config_file)
+        YAML.load_file(config_file) || {}
+      rescue Errno::ENOENT, Psych::SyntaxError
+        STDERR.puts("[WARN] Unable to parse 'config_file' '#{config_file}'.")
+        {}
+      end
+
+      def self.extract_command_data(data, command)
+        data_hash = data["global"] || {}
+
+        return data_hash if command.nil? || data[command].nil?
+
+        data_hash.merge(data[command])
+      end
+
+      def self.get_command_config_data(data, invocations, current_command_name)
+        invocations ||= {}
+        commands = (invocations.values.flatten << current_command_name)
+
+        command_options = extract_command_data(data, commands.shift)
+
+        commands.each do |cmd|
+          should_break = command_options[cmd].nil?
+          command_options.merge!(extract_command_data(command_options, cmd))
+
+          %W[#{cmd} global].each { |k| command_options.delete(k) }
+
+          break if should_break
+        end
+
+        command_options
+      end
+
+      def self.parse(config_file, invocations, current_command_name, defaults)
+        data = parse_config_file(config_file)
+        opts = get_command_config_data(data, invocations, current_command_name)
+
+        config_opts = opts.each_with_object({}) do |(key, value), hsh|
+          if defaults.keys.map(&:to_s).include?(key.to_s)
+            hsh[key] = value
+          else
+            STDERR.puts("[WARN] rejecting invalid config file option: '#{key}'")
+          end
+        end
+
+        OptionsHash.new(config_opts)
+      end
+    end
+  end
+end

data/lib/thor-addons/helpers/options_env.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ThorAddons
+  module Helpers
+    class OptionsENV
+      private_class_method def self.get_from_env_or_alias(env, envs_aliases)
+        return ENV[env] unless ENV[env].nil? && envs_aliases.keys.include?(env)
+
+        ENV[envs_aliases[env]]
+      end
+
+      def self.parse(defaults, envs_aliases)
+        opts = defaults.keys.each_with_object({}) do |option, hsh|
+          value = get_from_env_or_alias(option.to_s.upcase, envs_aliases)
+
+          next if value.nil?
+
+          hsh[option] = OptionType.new(value, defaults[option][:type])
+            .convert_string
+        end
+
+        OptionsHash.new(opts)
+      end
+    end
+  end
+end

data/lib/thor-addons/helpers/options_hash.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ThorAddons
+  module Helpers
+    class OptionsHash < ::SymbolizedHash
+      private def value_empty?(value)
+        value.is_a?(NilClass) || (value.respond_to?(:empty?) && value.empty?)
+      end
+
+      def merge(new_hash)
+        new_hash.each_with_object(dup) do |(key, value), self_dup|
+          next if value_empty?(value) || !value_empty?(self_dup[key])
+
+          self_dup[key] = value
+        end
+      end
+
+      def merge!(options)
+        replace(merge(options))
+      end
+    end
+  end
+end

data/lib/thor-addons/options.rb

@@ -1,13 +1,17 @@
+# frozen_string_literal: true
+
 module ThorAddons
   module Options
-    attr_reader :current_command_name, :defaults, :invoked_via_subcommand, :invocations
+    attr_reader :defaults, :invocations, :current_command_name
 
     def initialize(args = [], local_options = {}, config = {})
-      @current_command_name = config[:current_command] ? config[:current_command].name : nil
-      @defaults = load_defaults(config.dup)
-      @invoked_via_subcommand = config[:invoked_via_subcommand]
+      @defaults = Helpers::Defaults.load(self.class, config.dup)
       @invocations = config[:invocations]
 
+      if config[:current_command].respond_to?(:name)
+        @current_command_name = config[:current_command].name
+      end
+
       super(args, local_options, config)
     end
 
@@ -19,126 +23,52 @@ module ThorAddons
       true
     end
 
-    def options
-      original = hash_with_indifferent_access(super)
-      config_file = original[:config_file]
-
-      return original unless with_env? || with_config_file?
-
-      new_options = remove_defaults(original)
-
-      if with_config_file? && !config_file.nil?
-        merge(new_options, options_from_config(config_file))
-      end
-
-      if with_env?
-        merge(new_options, options_from_env)
-      end
-
-      hash_with_indifferent_access(add_defaults(new_options))
-    end
-
-    private
-
-    def merge(options_a, options_b)
-      options_b.each do |key, value|
-        next if value.to_s.empty? || !options_a[key].to_s.empty?
-
-        options_a[key] = value
-      end
-
-      options_a
-    end
-
     def envs_aliases
       {}
     end
 
-    def options_from_env
-      opts = {}
-      defaults.keys.inject({}) do |memo, option|
-        env = option.to_s.upcase
-        opts[option] = ENV[env] unless ENV[env].nil?
-
-        next unless envs_aliases.keys.include?(env) && opts[option].nil? && ENV[envs_aliases[env]]
-
-        opts[option] = ENV[envs_aliases[env]]
-      end
-
-      hash_with_indifferent_access(opts)
-    end
-
-    def options_from_config(config_file)
-      unless File.file?(config_file)
-        STDERR.puts("[WARNING] Unable to read 'config_file' '#{config_file}' not found.")
-        return {}
-      end
-
-      data = YAML.load_file(config_file)
-      command_options = {}
-      global = data["global"] || {}
-
-      return hash_with_indifferent_access(global) if current_command_name.nil?
-
-      if invoked_via_subcommand
-        first_invoked, *remaining_invoked = invocations.values.flatten
-        command_options = data[first_invoked] unless data[first_invoked].nil?
+    def options
+      original = Helpers::OptionsHash.new(super)
 
-        remaining_invoked.each do |subcommand|
-          break if command_options[subcommand].nil?
+      return original unless with_env? || with_config_file?
 
-          subcommand_data = command_options[subcommand]
+      new_options = Helpers::Defaults.remove(original, defaults)
+      update_options!(new_options, original[:config_file])
 
-          command_options.delete(subcommand)
-          command_options.merge!(subcommand_data)
-        end
-      else
-        command_options = data[current_command_name] unless data[current_command_name].nil?
-      end
+      opts = Helpers::OptionsHash.new(
+        Helpers::Defaults.add(new_options, defaults)
+      )
 
-      hash_with_indifferent_access(global.merge(command_options))
+      validate_options(opts)
     end
 
-    def add_defaults(hash)
-      hash.inject({}) do |memo, (k, v)|
-        memo[k] = v.nil? ? defaults[k] : v
-
-        memo
-      end
+    private def update_options!(opts, cfg_file)
+      update_config_options!(opts, cfg_file) if with_config_file? && cfg_file
+      update_env_options!(opts) if with_env?
     end
 
-    def remove_defaults(hash)
-      hash.inject({}) do |memo, (k, v)|
-        if defaults[k] == v
-          memo[k] = nil
-        else
-          memo[k] = v
-        end
-
-        memo
-      end
+    private def update_config_options!(opts, cfg_file)
+      opts.merge!(
+        Helpers::OptionsConfigFile.parse(
+          cfg_file,
+          invocations,
+          current_command_name,
+          defaults
+        )
+      )
     end
 
-    def load_defaults(config)
-      parse_options = self.class.class_options.dup
-      parse_options.merge!(config[:class_options]) if config[:class_options]
-      parse_options.merge!(config[:command_options]) if config[:command_options]
+    private def update_env_options!(opts)
+      opts.merge!(Helpers::OptionsENV.parse(defaults, envs_aliases))
+    end
 
-      options_hash = parse_options.inject({}) do |memo, (key, value)|
-        begin
-          memo[key] = value.default
-        rescue NoMethodError
-          memo[key] = nil
-        end
+    private def validate_options(opts)
+      opts.each do |key, value|
+        type = defaults[key][:type]
+        is_valid = Helpers::OptionType.new(value, type).valid?
 
-        memo
+        raise TypeError, "'#{key}' should be a #{type}" unless is_valid
       end
-
-      hash_with_indifferent_access(options_hash)
-    end
-
-    def hash_with_indifferent_access(hash)
-      ::SymbolizedHash.new(hash)
     end
   end
 end

data/lib/thor-addons/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ThorAddons
-  VERSION = "0.1.6"
+  VERSION = "1.0.0"
 end

data/lib/thor-addons.rb

@@ -1,7 +1,14 @@
+# frozen_string_literal: true
+
 require "yaml"
-require "thor"
-require "thor"
 require "symbolized"
+require "thor"
 
-require "thor-addons/version"
+require "ext/string"
+require "thor-addons/helpers/defaults"
+require "thor-addons/helpers/option_type"
+require "thor-addons/helpers/options_config_file"
+require "thor-addons/helpers/options_env"
+require "thor-addons/helpers/options_hash"
 require "thor-addons/options"
+require "thor-addons/version"

data/thor-addons.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "thor-addons/version"
 
@@ -9,18 +10,23 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jacopo Scrinzi"]
   spec.email         = ["scrinzi.jcopo@gmail.com"]
 
-  spec.summary       = %q{Thor CLI Add-ons}
-  spec.description   = %q{Useful Add-ons Thor CLI}
+  spec.summary       = "Thor CLI Add-ons"
+  spec.description   = "Useful Add-ons Thor CLI"
   spec.homepage      = "https://github.com/eredi93/thor-addons"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "thor", "~> 0.19"
+  spec.files = `git ls-files -z`.split("\x0")
+    .reject { |f| f.match(%r{^(test|spec|features)/}) }
+
   spec.add_dependency "symbolized", "~> 0.0.1"
+  spec.add_dependency "thor", "~> 0.19"
 
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "climate_control"
+  spec.add_development_dependency "gem-release"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: thor-addons
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Jacopo Scrinzi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: symbolized
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
-  name: symbolized
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  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: gem-release
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Useful Add-ons Thor CLI
 email:
 - scrinzi.jcopo@gmail.com
@@ -88,6 +130,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -96,7 +140,13 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- lib/ext/string.rb
 - lib/thor-addons.rb
+- lib/thor-addons/helpers/defaults.rb
+- lib/thor-addons/helpers/option_type.rb
+- lib/thor-addons/helpers/options_config_file.rb
+- lib/thor-addons/helpers/options_env.rb
+- lib/thor-addons/helpers/options_hash.rb
 - lib/thor-addons/options.rb
 - lib/thor-addons/version.rb
 - thor-addons.gemspec