commander 4.4.6 → 4.6.0

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

@@ -1,34 +1,34 @@
-  <%= $terminal.color "NAME", :bold %>:
+  <%= HighLine.default_instance.color "NAME", :bold %>:
 
     <%= program :name %>
 
-  <%= $terminal.color "DESCRIPTION", :bold %>:
+  <%= HighLine.default_instance.color "DESCRIPTION", :bold %>:
 
     <%= Commander::HelpFormatter.indent 4, program(:description) %>
 
-  <%= $terminal.color "COMMANDS", :bold %>:
+  <%= HighLine.default_instance.color "COMMANDS", :bold %>:
 <% for name, command in @commands.sort -%>
 	<% unless alias? name %>
     <%= "%-#{max_command_length}s %s" % [command.name, command.summary || command.description] -%>
 	<% end -%>
 <% end %>
 <% unless @aliases.empty? %>
-  <%= $terminal.color "ALIASES", :bold %>:
+  <%= HighLine.default_instance.color "ALIASES", :bold %>:
   <% for alias_name, args in @aliases.sort %>
     <%= "%-#{max_aliases_length}s %s %s" % [alias_name, command(alias_name).name, args.join(' ')] -%>
   <% end %>
 <% end %>
 <% unless @options.empty? -%>
-  <%= $terminal.color "GLOBAL OPTIONS", :bold %>:
+  <%= HighLine.default_instance.color "GLOBAL OPTIONS", :bold %>:
 	<% for option in @options -%>
 
-    <%= option[:switches].join ', ' %> 
+    <%= option[:switches].join ', ' %>
         <%= option[:description] %>
 	<% end -%>
 <% end -%>
 <% if program :help -%>
   <% for title, body in program(:help) %>
-  <%= $terminal.color title.to_s.upcase, :bold %>:
+  <%= HighLine.default_instance.color title.to_s.upcase, :bold %>:
 
     <%= body %>
   <% end -%>

data/lib/commander/help_formatters/terminal_compact.rb

@@ -1,10 +1,16 @@
+# frozen_string_literal: true
+
 require 'erb'
 
 module Commander
   module HelpFormatter
     class TerminalCompact < Terminal
       def template(name)
-        ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal_compact', "#{name}.erb")), nil, '-')
+        if RUBY_VERSION < '2.6'
+          ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal_compact', "#{name}.erb")), nil, '-')
+        else
+          ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal_compact', "#{name}.erb")), trim_mode: '-')
+        end
       end
     end
   end

data/lib/commander/import.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'commander'
 
 include Commander::Methods

data/lib/commander/methods.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Commander
   module Methods
     include Commander::UI
     include Commander::UI::AskForClass
     include Commander::Delegates
 
-    if $stdin.tty? && (cols = $terminal.output_cols) >= 40
-      $terminal.wrap_at = cols - 5
+    if $stdin.tty? && (cols = HighLine.default_instance.output_cols) >= 40
+      HighLine.default_instance.wrap_at = cols - 5
     end
   end
 end

data/lib/commander/platform.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Commander
   module Platform
     def self.jruby?

data/lib/commander/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module Commander
@@ -7,22 +9,10 @@ module Commander
     #++
 
     class CommandError < StandardError; end
-    class InvalidCommandError < CommandError; end
-
-    ##
-    # Array of commands.
-
-    attr_reader :commands
 
-    ##
-    # Global options.
-
-    attr_reader :options
-
-    ##
-    # Hash of help formatter aliases.
+    class InvalidCommandError < CommandError; end
 
-    attr_reader :help_formatter_aliases
+    attr_reader :commands, :options, :help_formatter_aliases
 
     ##
     # Initialize a new command runner. Optionally
@@ -41,7 +31,7 @@ module Commander
     # Return singleton Runner instance.
 
     def self.instance
-      @singleton ||= new
+      @instance ||= new
     end
 
     ##
@@ -76,7 +66,7 @@ module Commander
           OptionParser::InvalidArgument,
           OptionParser::MissingArgument => e
           abort e.to_s
-        rescue => e
+        rescue StandardError => e
           if @never_trace
             abort "error: #{e}."
           else
@@ -231,21 +221,23 @@ module Commander
     # Get active command within arguments passed to this runner.
 
     def active_command
-      @__active_command ||= command(command_name_from_args)
+      @active_command ||= command(command_name_from_args)
     end
 
     ##
     # Attempts to locate a command name from within the arguments.
     # Supports multi-word commands, using the largest possible match.
+    # Returns the default command, if no valid commands found in the args.
 
     def command_name_from_args
-      @__command_name_from_args ||= (valid_command_names_from(*@args.dup).sort.last || @default_command)
+      @command_name_from_args ||= (longest_valid_command_name_from(@args) || @default_command)
     end
 
     ##
     # Returns array of valid command names found within _args_.
 
     def valid_command_names_from(*args)
+      remove_global_options options, args
       arg_string = args.delete_if { |value| value =~ /^-/ }.join ' '
       commands.keys.find_all { |name| name if arg_string =~ /^#{name}\b/ }
     end
@@ -254,7 +246,7 @@ module Commander
     # Help formatter instance.
 
     def help_formatter
-      @__help_formatter ||= program(:help_formatter).new self
+      @help_formatter ||= program(:help_formatter).new self
     end
 
     ##
@@ -303,7 +295,7 @@ module Commander
           if args.empty?
             say help_formatter.render
           else
-            command = command args.join(' ')
+            command = command(longest_valid_command_name_from(args))
             begin
               require_valid_command command
             rescue InvalidCommandError => e
@@ -328,26 +320,32 @@ module Commander
     # again for the command.
 
     def remove_global_options(options, args)
-      # TODO: refactor with flipflop, please TJ ! have time to refactor me !
       options.each do |option|
-        switches = option[:switches].dup
+        switches = option[:switches]
         next if switches.empty?
 
-        if (switch_has_arg = switches.any? { |s| s =~ /[ =]/ })
-          switches.map! { |s| s[0, s.index('=') || s.index(' ') || s.length] }
-        end
-
+        option_takes_argument = switches.any? { |s| s =~ /[ =]/ }
         switches = expand_optionally_negative_switches(switches)
 
-        past_switch, arg_removed = false, false
-        args.delete_if do |arg|
-          if switches.any? { |s| s[0, arg.length] == arg }
-            arg_removed = !switch_has_arg
-            past_switch = true
-          elsif past_switch && !arg_removed && arg !~ /^-/
-            arg_removed = true
+        option_argument_needs_removal = false
+        args.delete_if do |token|
+          break if token == '--'
+
+          # Use just the portion of the token before the = when
+          # comparing switches.
+          index_of_equals = token.index('=') if option_takes_argument
+          token = token[0, index_of_equals] if index_of_equals
+          token_contains_option_argument = !index_of_equals.nil?
+
+          if switches.any? { |s| s[0, token.length] == token }
+            option_argument_needs_removal =
+              option_takes_argument && !token_contains_option_argument
+            true
+          elsif option_argument_needs_removal && token !~ /^-/
+            option_argument_needs_removal = false
+            true
           else
-            arg_removed = true
+            option_argument_needs_removal = false
             false
           end
         end
@@ -395,7 +393,7 @@ module Commander
     def global_option_proc(switches, &block)
       lambda do |value|
         unless active_command.nil?
-          active_command.proxy_options << [Runner.switch_to_sym(switches.last), value]
+          active_command.global_options << [Runner.switch_to_sym(switches.last), value]
         end
         yield value if block && !value.nil?
       end
@@ -448,7 +446,17 @@ module Commander
     end
 
     def say(*args) #:nodoc:
-      $terminal.say(*args)
+      HighLine.default_instance.say(*args)
+    end
+
+    private
+
+    ##
+    # Attempts to locate a command name from within the provided arguments.
+    # Supports multi-word commands, using the largest possible match.
+
+    def longest_valid_command_name_from(args)
+      valid_command_names_from(*args.dup).max
     end
   end
 end

data/lib/commander/user_interaction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tempfile'
 require 'shellwords'
 
@@ -66,7 +68,7 @@ module Commander
 
     def say_ok(*args)
       args.each do |arg|
-        say $terminal.color(arg, :green)
+        say HighLine.default_instance.color(arg, :green)
       end
     end
 
@@ -80,7 +82,7 @@ module Commander
 
     def say_warning(*args)
       args.each do |arg|
-        say $terminal.color(arg, :yellow)
+        say HighLine.default_instance.color(arg, :yellow)
       end
     end
 
@@ -94,7 +96,7 @@ module Commander
 
     def say_error(*args)
       args.each do |arg|
-        say $terminal.color(arg, :red)
+        say HighLine.default_instance.color(arg, :red)
       end
     end
 
@@ -113,7 +115,7 @@ module Commander
     #   * highligh: on_<color>
 
     def color(*args)
-      say $terminal.color(*args)
+      say HighLine.default_instance.color(*args)
     end
 
     ##
@@ -218,20 +220,16 @@ module Commander
     #
 
     def io(input = nil, output = nil, &block)
+      orig_stdin, orig_stdout = $stdin, $stdout
       $stdin = File.new(input) if input
       $stdout = File.new(output, 'r+') if output
       return unless block
+
       yield
+      $stdin, $stdout = orig_stdin, orig_stdout
       reset_io
     end
 
-    ##
-    # Reset IO to initial constant streams.
-
-    def reset_io
-      $stdin, $stdout = STDIN, STDOUT
-    end
-
     ##
     # Find an editor available in path. Optionally supply the _preferred_
     # editor. Returns the name as a string, nil if none is available.
@@ -274,6 +272,7 @@ module Commander
     def enable_paging
       return unless $stdout.tty?
       return unless Process.respond_to? :fork
+
       read, write = IO.pipe
 
       # Kernel.fork is not supported on all platforms and configurations.
@@ -324,12 +323,12 @@ module Commander
     # Implements ask_for_CLASS methods.
 
     module AskForClass
-      DEPRECATED_CONSTANTS = [:Config, :TimeoutError, :MissingSourceFile, :NIL, :TRUE, :FALSE, :Fixnum, :Bignum, :Data].freeze
+      DEPRECATED_CONSTANTS = %i[Config TimeoutError MissingSourceFile NIL TRUE FALSE Fixnum Bignum Data].freeze
 
       # define methods for common classes
       [Float, Integer, String, Symbol, Regexp, Array, File, Pathname].each do |klass|
         define_method "ask_for_#{klass.to_s.downcase}" do |prompt|
-          $terminal.ask(prompt, klass)
+          HighLine.default_instance.ask(prompt, klass)
         end
       end
 
@@ -338,20 +337,26 @@ module Commander
           if arguments.count != 1
             fail ArgumentError, "wrong number of arguments (given #{arguments.count}, expected 1)"
           end
+
           prompt = arguments.first
           requested_class = Regexp.last_match[1]
 
           # All Classes that respond to #parse
           # Ignore constants that trigger deprecation warnings
           available_classes = (Object.constants - DEPRECATED_CONSTANTS).map do |const|
-            Object.const_get(const)
-          end.select do |const|
-            const.class == Class && const.respond_to?(:parse)
+            begin
+              Object.const_get(const)
+            rescue RuntimeError
+              # Rescue errors in Ruby 3 for SortedSet:
+              # The `SortedSet` class has been extracted from the `set` library.
+            end
+          end.compact.select do |const|
+            const.instance_of?(Class) && const.respond_to?(:parse)
           end
 
           klass = available_classes.find { |k| k.to_s.downcase == requested_class }
           if klass
-            $terminal.ask(prompt, klass)
+            HighLine.default_instance.ask(prompt, klass)
           else
             super
           end
@@ -498,7 +503,7 @@ module Commander
           steps_remaining: steps_remaining,
           total_steps: @total_steps,
           time_elapsed: format('%0.2fs', time_elapsed),
-          time_remaining: @step > 0 ? format('%0.2fs', time_remaining) : '',
+          time_remaining: @step.positive? ? format('%0.2fs', time_remaining) : '',
         }.merge! @tokens
       end
 
@@ -507,11 +512,12 @@ module Commander
 
       def show
         return if finished?
+
         erase_line
         if completed?
-          $terminal.say UI.replace_tokens(@complete_message, generate_tokens) if @complete_message.is_a? String
+          HighLine.default_instance.say UI.replace_tokens(@complete_message, generate_tokens) if @complete_message.is_a? String
         else
-          $terminal.say UI.replace_tokens(@format, generate_tokens) << ' '
+          HighLine.default_instance.say UI.replace_tokens(@format, generate_tokens) << ' '
         end
       end
 
@@ -544,7 +550,7 @@ module Commander
 
       def erase_line
         # highline does not expose the output stream
-        $terminal.instance_variable_get('@output').print "\r\e[K"
+        HighLine.default_instance.instance_variable_get('@output').print "\r\e[K"
       end
     end
   end

data/lib/commander/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Commander
-  VERSION = '4.4.6'.freeze
+  VERSION = '4.6.0'
 end

data/spec/command_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Commander::Command do
@@ -164,6 +166,33 @@ describe Commander::Command do
         end
         @command.run '--interval', '15'
       end
+
+      describe 'given a global option' do
+        before do
+          @command.global_options << [:global_option, 'gvalue']
+        end
+
+        describe 'and no command specific arguments' do
+          it 'provides the global option to the command action' do
+            @command.when_called { |_, options| expect(options.global_option).to eq('gvalue') }
+            @command.run
+          end
+        end
+
+        describe 'and a command specific option' do
+          it 'provides the global option to the command action' do
+            @command.when_called { |_, options| expect(options.global_option).to eq('gvalue') }
+            @command.run '--verbose'
+          end
+        end
+
+        describe 'and a command specific argument' do
+          it 'provides the global option to the command action' do
+            @command.when_called { |_, options| expect(options.global_option).to eq('gvalue') }
+            @command.run 'argument'
+          end
+        end
+      end
     end
   end
 end