commander 4.4.6 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 584705d6b59c75d49df6d2369763f91b5a5dbc5013575dbb2be575983b040f60
-  data.tar.gz: 0bab3911300bcc194406717c08ab1718608c86fe62703f0219a16a645bded947
+  metadata.gz: f91f8a37c32e7971823b150b8b89d7f992a6971c66351ae7527b27cdbf0926db
+  data.tar.gz: bcd3c3131f145cea800da48c7231a6d3b0b892eed9107fd64dac52b03da2f44b
 SHA512:
-  metadata.gz: 1bb1d5703d53f0c6a140e7f24e0d4c9f0e80283425b2daf49d80da554a78122d4eb731bb9ee817c11e0636732938ffab81367312f599b40c3c8f8dc036ab9604
-  data.tar.gz: 1da0b8c354a4b0fc744e170c6d6e3393ddbb759ae9fecf50cf06274ee1611dd48d1f9c69e0414c3b28d2d810d56e0a6348c17eec3c58b084dd14f594a7f9a3b4
+  metadata.gz: e9c808ed77df3bc880db7a790ca207b6b6beb98be447f27f55fdcd25dc32c1131bb06d6d69e47de076b590ff4182e250b6b752b3bf2439ef0f94a2168d3acc40
+  data.tar.gz: fcfb725ce863649b098cea94314d612a5b755abd996199ed63a3e8018baef804790b8ce57e02229fed75c3247597f2030aab3bec47d0a544eb81586c45548722

data/.rubocop.yml

@@ -1,18 +1,20 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 1.9
+  TargetRubyVersion: 2.4
+  NewCops: enable
+  SuggestExtensions: false
 
 # not Ruby 1.9.3 compatible
 Style/PercentLiteralDelimiters:
   Enabled: false
 
-# Offense count: 5
-Encoding:
-  Enabled: false
+# Enforce trailing comma after last item of multiline arrays.
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
 
 # Enforce trailing comma after last item of multiline hashes.
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
 Metrics/BlockLength:
@@ -27,7 +29,7 @@ Style/ParallelAssignment:
 Style/NumericLiteralPrefix:
   EnforcedOctalStyle: zero_only
 
-Style/MethodMissing:
+Style/MissingRespondToMissing:
   Enabled: false
 
 Layout/SpaceInsideStringInterpolation:
@@ -42,3 +44,21 @@ Style/EmptyMethod:
 Metrics/ModuleLength:
   CountComments: false  # count full line comments?
   Max: 150
+
+Lint/EmptyBlock:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/MixinUsage:
+  Enabled: false
+
+Lint/ErbNewArguments:
+  Enabled: false
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false

data/.rubocop_todo.yml

@@ -10,12 +10,12 @@ Security/Eval:
   Enabled: false
 
 # Offense count: 2
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Enabled: false
 
 # Offense count: 5
 Metrics/AbcSize:
-  Max: 29
+  Max: 30
 
 # Offense count: 1
 # Configuration parameters: CountComments.
@@ -28,7 +28,7 @@ Metrics/CyclomaticComplexity:
 
 # Offense count: 89
 # Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
+Layout/LineLength:
   Max: 242
 
 # Offense count: 7
@@ -41,7 +41,7 @@ Metrics/PerceivedComplexity:
   Max: 14
 
 # Offense count: 1
-Style/AccessorMethodName:
+Naming/AccessorMethodName:
   Enabled: false
 
 # Offense count: 18

data/.travis.yml

@@ -4,11 +4,10 @@ before_install:
   - gem update --system
   - gem update bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.10
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - jruby-19mode
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
+  - jruby
+  - ruby-head

data/Gemfile

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

data/History.rdoc

@@ -1,3 +1,28 @@
+=== 4.6.0 / 2021-04-09
+
+* Fix error with SortedSet on Ruby 3.0 (#98).
+* Remove `#reset_io` as it didn't do anything.
+* Drop support for Ruby < 2.4.
+
+=== 4.5.2 / 2020-03-12
+
+* Fix bug handling global options provided in option=value form (#47). (@orien)
+* Fix ERB warnings under Ruby 2.7. (@esotericpig)
+* Fix bug handling global options placed before command name (#32). (@orien)
+
+=== 4.5.1 / 2020-03-08
+
+* Fix bug causing global options to be ignored when arguments are present (#86). (@orien)
+
+=== 4.5.0 / 2020-01-21
+
+* Drop support for Ruby < 2.3.
+* Fix bug parsing double dash (#75).
+
+=== 4.4.7 / 2018-10-22
+
+* Update HighLine dependency to 2.0.0. (@rohitpaulk)
+
 === 4.4.6 / 2018-07-31
 
 * Fix unexpected internal behavior change introduced in 4.4.5.

data/README.md

@@ -1,5 +1,5 @@
-[<img src="https://api.travis-ci.org/commander-rb/commander.svg" alt="Build Status" />](http://travis-ci.org/commander-rb/commander)
-[![Inline docs](http://inch-ci.org/github/commander-rb/commander.svg)](http://inch-ci.org/github/commander-rb/commander)
+[<img src="https://api.travis-ci.org/commander-rb/commander.svg" alt="Build Status" />](https://travis-ci.org/commander-rb/commander)
+[![Inline docs](https://inch-ci.org/github/commander-rb/commander.svg)](https://inch-ci.org/github/commander-rb/commander)
 
 # Commander
 
@@ -243,8 +243,8 @@ end
 ## Growl Notifications
 
 Commander provides methods for displaying Growl notifications. To use these
-methods you need to install http://github.com/tj/growl which utilizes
-the [growlnotify](http://growl.info/extras.php#growlnotify) executable. Note that
+methods you need to install https://github.com/tj/growl which utilizes
+the [growlnotify](https://growl.info/extras.php#growlnotify) executable. Note that
 growl is auto-imported by Commander when available, no need to require.
 
 ```ruby
@@ -449,7 +449,7 @@ global_option '--config FILE'
 
 ## ASCII Tables
 
-For feature rich ASCII tables for your terminal app check out the terminal-table gem at http://github.com/tj/terminal-table
+For feature rich ASCII tables for your terminal app check out the terminal-table gem at https://github.com/tj/terminal-table
 
     +----------+-------+----+--------+-----------------------+
     | Terminal | Table | Is | Wicked | Awesome               |
@@ -468,7 +468,7 @@ OR
 ## Contrib
 
 Feel free to fork and request a pull, or submit a ticket
-http://github.com/commander-rb/commander/issues
+https://github.com/commander-rb/commander/issues
 
 ## License
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
@@ -10,4 +12,4 @@ end
 
 RuboCop::RakeTask.new
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]

data/bin/commander

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'commander/import'
@@ -97,7 +98,7 @@ command :init do |c|
         File.chmod 0755, file
         say "Initialized template in #{file}"
       end
-    rescue => e
+    rescue StandardError => e
       abort e
     end
   end

data/commander.gemspec

@@ -1,6 +1,6 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'commander/version'
 
 Gem::Specification.new do |s|
@@ -12,21 +12,24 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/commander-rb/commander'
   s.summary     = 'The complete solution for Ruby command-line executables'
   s.description = 'The complete solution for Ruby command-line executables. Commander bridges the gap between other terminal related libraries you know and love (OptionParser, HighLine), while providing many new features, and an elegant API.'
+  s.metadata    = {
+    'bug_tracker_uri' => "#{s.homepage}/issues",
+    'changelog_uri' => "#{s.homepage}/blob/master/History.rdoc",
+    'documentation_uri' => "https://www.rubydoc.info/gems/commander/#{s.version}",
+    'homepage_uri' => s.homepage,
+    'source_code_uri' => "#{s.homepage}/tree/v#{s.version}",
+  }
+  s.required_ruby_version = '>= 2.4'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency('highline', '~> 1.7.2')
+  s.add_runtime_dependency('highline', '~> 2.0.0')
 
-  s.add_development_dependency('rspec', '~> 3.2')
   s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '~> 3.2')
+  s.add_development_dependency('rubocop', '~> 1.12.1')
   s.add_development_dependency('simplecov')
-  if RUBY_VERSION < '2.0'
-    s.add_development_dependency('rubocop', '~> 0.41.1')
-    s.add_development_dependency('json', '< 2.0')
-  else
-    s.add_development_dependency('rubocop', '~> 0.49.1')
-  end
 end

data/lib/commander.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2008-2009 TJ Holowaychuk <tj@vision-media.ca>
 #

data/lib/commander/blank.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blank
   def self.included(base)
     base.class_eval do

data/lib/commander/command.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module Commander
   class Command
-    attr_accessor :name, :examples, :syntax, :description
-    attr_accessor :summary, :proxy_options, :options
+    attr_accessor :name, :examples, :syntax, :description, :summary, :proxy_options, :options
+    attr_reader :global_options
 
     ##
     # Options struct.
@@ -38,6 +40,7 @@ module Commander
     def initialize(name)
       @name, @examples, @when_called = name.to_s, [], []
       @options, @proxy_options = [], []
+      @global_options = []
     end
 
     ##
@@ -138,6 +141,7 @@ module Commander
 
     def when_called(*args, &block)
       fail ArgumentError, 'must pass an object, class, or block.' if args.empty? && !block
+
       @when_called = block ? [block] : args
     end
     alias action when_called
@@ -161,6 +165,7 @@ module Commander
 
     def parse_options_and_call_procs(*args)
       return args if args.empty?
+
       # empty proxy_options before populating via OptionParser
       # prevents duplication of options if the command is run twice
       proxy_options.clear
@@ -180,8 +185,8 @@ module Commander
 
       case object
       when Proc then object.call(args, options)
-      when Class then meth != :call ? object.new.send(meth, args, options) : object.new(args, options)
-      else object.send(meth, args, options) if object
+      when Class then meth == :call ? object.new(args, options) : object.new.send(meth, args, options)
+      else object&.send(meth, args, options)
       end
     end
 
@@ -190,7 +195,7 @@ module Commander
     # collected by the #option_proc.
 
     def proxy_option_struct
-      proxy_options.each_with_object(Options.new) do |(option, value), options|
+      (global_options + proxy_options).each_with_object(Options.new) do |(option, value), options|
         # options that are present will evaluate to true
         value = true if value.nil?
         options.__send__ :"#{option}=", value

data/lib/commander/configure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Commander
   def configure(*configuration_opts, &configuration_block)
     configuration_module = Module.new

data/lib/commander/core_ext.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'commander/core_ext/array'
 require 'commander/core_ext/object'

data/lib/commander/core_ext/array.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class Array
   ##
   # Split _string_ into an array. Used in
-  # conjunction with Highline's #ask, or #ask_for_array
+  # conjunction with HighLine's #ask, or #ask_for_array
   # methods, which must respond to #parse.
   #
   # This method allows escaping of whitespace. For example

data/lib/commander/core_ext/object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Object
   ##
   # Return the current binding.

data/lib/commander/delegates.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Commander
   module Delegates
     %w(
@@ -11,7 +13,7 @@ module Commander
       always_trace!
       never_trace!
     ).each do |meth|
-      eval <<-END, binding, __FILE__, __LINE__
+      eval <<-END, binding, __FILE__, __LINE__ + 1
         def #{meth}(*args, &block)
           ::Commander::Runner.instance.#{meth}(*args, &block)
         end

data/lib/commander/help_formatters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Commander
   module HelpFormatter
     autoload :Base, 'commander/help_formatters/base'
@@ -43,7 +45,7 @@ module Commander
     module_function
 
     def indent(amount, text)
-      text.to_s.gsub("\n", "\n" + (' ' * amount))
+      text.to_s.gsub("\n", "\n#{' ' * amount}")
     end
   end
 end

data/lib/commander/help_formatters/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Commander
   ##
   # = Help Formatter

data/lib/commander/help_formatters/terminal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'erb'
 
 module Commander
@@ -12,7 +14,11 @@ module Commander
       end
 
       def template(name)
-        ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal', "#{name}.erb")), nil, '-')
+        if RUBY_VERSION < '2.6'
+          ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal', "#{name}.erb")), nil, '-')
+        else
+          ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal', "#{name}.erb")), trim_mode: '-')
+        end
       end
     end
   end

data/lib/commander/help_formatters/terminal/command_help.erb

@@ -1,22 +1,22 @@
 
-  <%= $terminal.color "NAME", :bold %>:
+  <%= HighLine.default_instance.color "NAME", :bold %>:
 
     <%= @name %>
 <% if @syntax -%>
 
-  <%= $terminal.color "SYNOPSIS", :bold %>:
+  <%= HighLine.default_instance.color "SYNOPSIS", :bold %>:
 
     <%= @syntax -%>
 
 <% end -%>
 
-  <%= $terminal.color "DESCRIPTION", :bold %>:
+  <%= HighLine.default_instance.color "DESCRIPTION", :bold %>:
 
     <%= Commander::HelpFormatter.indent 4, (@description || @summary || 'No description.') -%>
 
 <% unless @examples.empty? -%>
 
-  <%= $terminal.color "EXAMPLES", :bold %>:
+  <%= HighLine.default_instance.color "EXAMPLES", :bold %>:
 	<% for description, command in @examples -%>
 
     # <%= description %>
@@ -25,10 +25,10 @@
 <% end -%>
 <% unless @options.empty? -%>
 
-  <%= $terminal.color "OPTIONS", :bold %>:
+  <%= HighLine.default_instance.color "OPTIONS", :bold %>:
 	<% for option in @options -%>
 
-    <%= option[:switches].join ', ' %> 
+    <%= option[:switches].join ', ' %>
         <%= Commander::HelpFormatter.indent 8, option[:description] %>
 	<% end -%>
 <% end -%>