gli 2.12.3 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84a063f077612bd68999d7ab4771655577b9f66e
-  data.tar.gz: 1c12e2ce024650ac44bff39eaba6a4df7f28f77c
+  metadata.gz: b949aa32e5bf3ec2a8c7f98c690c75ec7e2a1577
+  data.tar.gz: da3bb5140f7bd7297857a2f80019d693b0bcb59f
 SHA512:
-  metadata.gz: d417534ed4728c1a95b03069dd965f9cc9b74bac4edcbdfc6087712ba13e6a55084c71d6c58e21af237dfc8685dc8208a3b9371a6320ba3d31c54804007251f3
-  data.tar.gz: 01fb54aa5de01661ef48dfb2d359fa396db13bbc9bb16fb20d75f1f71cda9197047f925d63754b831b4661c94ff8c3849ba1c3cf0e578074ab843eab8ae3ffa6
+  metadata.gz: 7cdc67b6b99bc4f68075c5549a44a0cfd4e779697c071dce15c777bd6a743a78a540fc87cca4b91b5d59c363bc9c370645120a9013664cfd2d920ebfb05915c7
+  data.tar.gz: 5d5687cb17c78b7e66927e195e7ee2f27defb48292fc401066caf357c3aa0e6075c238afe1feffd7f115859b1e04c57ac57472237a61fedf1deed5eed519ede0

data/lib/gli/app.rb

@@ -302,6 +302,18 @@ module GLI
       @argument_handling_strategy = handling_strategy
     end
 
+
+    # Enables/Disables command autocomplete, where partially spelled commands are automatically expanded to their full form
+    #
+    # Example:
+    # When enabled, executing 'shake' would execute 'shake_hand' (if no 'shake' command is defined).
+    # When disabled, executing 'shake' would throw an UnknownCommand error
+    #
+    # +boolean+:: Boolean value to enable or disable autocomplete, respectively. True by default.
+    def autocomplete_commands(boolean)
+      @autocomplete = boolean
+    end
+
     private
 
     def load_commands(path)

data/lib/gli/app_support.rb

@@ -26,6 +26,7 @@ module GLI
       @pre_block = false
       @post_block = false
       @default_command = :help
+      @autocomplete = false
       @around_block = nil
       @subcommand_option_handling_strategy = :legacy
       @argument_handling_strategy = :loose
@@ -68,9 +69,10 @@ module GLI
                                                 flags,
                                                 switches,
                                                 accepts,
-                                                @default_command,
-                                                self.subcommand_option_handling_strategy,
-                                                self.argument_handling_strategy)
+                                                :default_command => @default_command,
+                                                :autocomplete => autocomplete,
+                                                :subcommand_option_handling_strategy => subcommand_option_handling_strategy,
+                                                :argument_handling_strategy => argument_handling_strategy)
 
         parsing_result = gli_option_parser.parse_options(args)
         parsing_result.convert_to_openstruct! if @use_openstruct
@@ -211,6 +213,10 @@ module GLI
       @subcommand_option_handling_strategy || :legacy
     end
 
+    def autocomplete
+      @autocomplete.nil? ? true : @autocomplete
+    end
+
   private
 
     def handle_exception(ex,command)

data/lib/gli/command_finder.rb

@@ -1,40 +1,57 @@
 module GLI
   class CommandFinder
-    # Initialize a finder on the given list of commands, using default_command as the default if none found
-    def initialize(commands,default_command)
-      @default_command = default_command
-      @names_to_commands = {}
-      commands.each do |command_name,command|
-        @names_to_commands[command_name.to_s] = command
-        Array(command.aliases).each do |command_alias|
-          @names_to_commands[command_alias.to_s] = command
-        end
-      end
+    attr_accessor :options
+
+    DEFAULT_OPTIONS = {
+      default_command: nil,
+      autocomplete: true
+    }
+
+    def initialize(commands, options = {})
+      self.options = DEFAULT_OPTIONS.merge(options)
+      self.commands_with_aliases = expand_with_aliases(commands)
     end
 
-    # Finds the command with the given name, allowing for partial matches.  Returns the command named by
-    # the default command if no command with +name+ matched
     def find_command(name)
-      name ||= @default_command
-
-      raise UnknownCommand.new("No command name given nor default available") if String(name).strip == ''
+      name = String(name || options[:default_command]).strip
+      raise UnknownCommand.new("No command name given nor default available") if name == ''
 
-      command_found = @names_to_commands.fetch(name.to_s) do |command_to_match|
-        find_command_by_partial_name(@names_to_commands, command_to_match)
-      end
-      if Array(command_found).empty?
-        raise UnknownCommand.new("Unknown command '#{name}'")
-      elsif command_found.kind_of? Array
-        raise AmbiguousCommand.new("Ambiguous command '#{name}'. It matches #{command_found.sort.join(',')}")
+      command_found = commands_with_aliases.fetch(name) do |command_to_match|
+        if options[:autocomplete]
+          found_match = find_command_by_partial_name(commands_with_aliases, command_to_match)
+          if found_match.kind_of? GLI::Command
+            if ENV["GLI_DEBUG"] == 'true'
+              $stderr.puts "Using '#{name}' as it's is short for #{found_match.name}."
+              $stderr.puts "Set autocomplete false for any command you don't want matched like this"
+            end
+          elsif found_match.kind_of?(Array) && !found_match.empty?
+            raise AmbiguousCommand.new("Ambiguous command '#{name}'. It matches #{found_match.sort.join(',')}")
+          end
+          found_match
+        end
       end
+
+      raise UnknownCommand.new("Unknown command '#{name}'") if Array(command_found).empty?
       command_found
     end
 
   private
+    attr_accessor :commands_with_aliases
+
+    def expand_with_aliases(commands)
+      expanded = {}
+      commands.each do |command_name, command|
+        expanded[command_name.to_s] = command
+        Array(command.aliases).each do |command_alias|
+          expanded[command_alias.to_s] = command
+        end
+      end
+      expanded
+    end
 
-    def find_command_by_partial_name(names_to_commands, command_to_match)
-      partial_matches = names_to_commands.keys.select { |command_name| command_name =~ /^#{command_to_match}/ }
-      return names_to_commands[partial_matches[0]] if partial_matches.size == 1
+    def find_command_by_partial_name(commands_with_aliases, command_to_match)
+      partial_matches = commands_with_aliases.keys.select { |command_name| command_name =~ /^#{command_to_match}/ }
+      return commands_with_aliases[partial_matches[0]] if partial_matches.size == 1
       partial_matches
     end
   end

data/lib/gli/gli_option_parser.rb

@@ -1,24 +1,35 @@
 module GLI
   # Parses the command-line options using an actual +OptionParser+
   class GLIOptionParser
-    def initialize(commands,flags,switches,accepts,default_command = nil,subcommand_option_handling_strategy=:legacy,argument_handling_strategy=:loose)
-       command_finder       = CommandFinder.new(commands,default_command || "help")
+    attr_accessor :options
+
+    DEFAULT_OPTIONS = {
+      :default_command => nil,
+      :autocomplete => true,
+      :subcommand_option_handling_strategy => :legacy,
+      :argument_handling_strategy => :loose
+    }
+
+    def initialize(commands,flags,switches,accepts, options={})
+      self.options = DEFAULT_OPTIONS.merge(options)
+
+      command_finder       = CommandFinder.new(commands,
+                                               :default_command => (options[:default_command] || :help),
+                                               :autocomplete => options[:autocomplete])
       @global_option_parser = GlobalOptionParser.new(OptionParserFactory.new(flags,switches,accepts),command_finder,flags)
       @accepts              = accepts
-      @subcommand_option_handling_strategy = subcommand_option_handling_strategy
-      @argument_handling_strategy = argument_handling_strategy
-      if @argument_handling_strategy == :strict && @subcommand_option_handling_strategy != :normal
+      if options[:argument_handling_strategy] == :strict && options[:subcommand_option_handling_strategy] != :normal
         raise ArgumentError, "To use strict argument handling, you must enable normal subcommand_option_handling, e.g. subcommand_option_handling :normal"
       end
     end
 
     # Given the command-line argument array, returns an OptionParsingResult
     def parse_options(args) # :nodoc:
-      option_parser_class = self.class.const_get("#{@subcommand_option_handling_strategy.to_s.capitalize}CommandOptionParser")
+      option_parser_class = self.class.const_get("#{options[:subcommand_option_handling_strategy].to_s.capitalize}CommandOptionParser")
       OptionParsingResult.new.tap { |parsing_result|
         parsing_result.arguments = args
         parsing_result = @global_option_parser.parse!(parsing_result)
-        option_parser_class.new(@accepts).parse!(parsing_result, @argument_handling_strategy)
+        option_parser_class.new(@accepts).parse!(parsing_result, options[:argument_handling_strategy])
       }
     end
 
@@ -101,7 +112,7 @@ module GLI
       end
 
       def error_handler
-        lambda { |message,extra_error_context| 
+        lambda { |message,extra_error_context|
           raise UnknownCommandArgument.new(message,extra_error_context)
         }
       end
@@ -120,7 +131,7 @@ module GLI
           arguments = option_block_parser.parse!(arguments)
 
           parsed_command_options[command] = option_parser_factory.options_hash_with_defaults_set!
-          command_finder                  = CommandFinder.new(command.commands,command.get_default_command)
+          command_finder                  = CommandFinder.new(command.commands, :default_command => command.get_default_command)
           next_command_name               = arguments.shift
 
           verify_required_options!(command.flags, command, parsed_command_options[command])
@@ -193,7 +204,7 @@ module GLI
                        end
 
         default_command = command.get_default_command
-        finder = CommandFinder.new(command.commands,default_command.to_s)
+        finder = CommandFinder.new(command.commands, :default_command => default_command.to_s)
 
         begin
           results = [finder.find_command(command_name),arguments[1..-1]]

data/lib/gli/version.rb

@@ -1,5 +1,5 @@
 module GLI
   unless const_defined? :VERSION
-    VERSION = '2.12.3'
+    VERSION = '2.13.0'
   end
 end

data/test/tc_command_finder.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+class TC_testCommandFinder < Clean::Test::TestCase
+  include TestHelper
+
+  def setup
+    @app = CLIApp.new
+    [:status, :deployable, :some_command, :some_similar_command].each do |command|
+      @app.commands[command] = GLI::Command.new(:names => command)
+    end
+  end
+
+  def teardown
+  end
+
+  def test_unknown_command_name
+    assert_raise(GLI::UnknownCommand) do
+      GLI::CommandFinder.new(@app.commands, :default_command => :status).find_command(:unfindable_command)
+    end
+  end
+
+  def test_no_command_name_without_default
+    assert_raise(GLI::UnknownCommand) do
+      GLI::CommandFinder.new(@app.commands).find_command(nil)
+    end
+  end
+
+  def test_no_command_name_with_default
+    actual = GLI::CommandFinder.new(@app.commands, :default_command => :status).find_command(nil)
+    expected = @app.commands[:status]
+
+    assert_equal(actual, expected)
+  end
+
+  def test_ambigous_command
+    assert_raise(GLI::AmbiguousCommand) do
+      GLI::CommandFinder.new(@app.commands, :default_command => :status).find_command(:some)
+    end
+  end
+
+  def test_partial_name_with_autocorrect_enabled
+    actual = GLI::CommandFinder.new(@app.commands, :default_command => :status).find_command(:deploy)
+    expected = @app.commands[:deployable]
+
+    assert_equal(actual, expected)
+  end
+
+  def test_partial_name_with_autocorrect_disabled
+    assert_raise(GLI::UnknownCommand) do
+      GLI::CommandFinder.new(@app.commands, :default_command => :status, :autocomplete => false)
+        .find_command(:deploy)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.12.3
+  version: 2.13.0
 platform: ruby
 authors:
 - David Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-21 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -241,6 +241,7 @@ files:
 - test/init_simplecov.rb
 - test/option_test_helper.rb
 - test/tc_command.rb
+- test/tc_command_finder.rb
 - test/tc_compound_command.rb
 - test/tc_doc.rb
 - test/tc_flag.rb
@@ -319,6 +320,7 @@ test_files:
 - test/init_simplecov.rb
 - test/option_test_helper.rb
 - test/tc_command.rb
+- test/tc_command_finder.rb
 - test/tc_compound_command.rb
 - test/tc_doc.rb
 - test/tc_flag.rb