gli 2.18.0 → 2.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37750b02cb524b2401b75d1f53722be230486faac88638a06c2722e8aba595bb
-  data.tar.gz: 73964afbb6c60b87be8a7cdd688cc9b54a3624b20ea32cddd1ae3ac5ba75da63
+  metadata.gz: 7089f9a6b96c1d569c7f41a03d8ffce30f3f9498ea39ca7c6c7b3717d96f71ec
+  data.tar.gz: '03592a617ed24d6595d0b5c505c2f7dea8ebcc000d654011a0e65e795838564a'
 SHA512:
-  metadata.gz: f822477176088b91c87fb1a9902e5e856c32c9904c2e8773d38566ab821f7f612ef18bcfc5a9dd67ae8c8461a6afaed60fa57fe939b0d965f707a4da88980eee
-  data.tar.gz: a68d246f06f74ef758fe75e79f9a7e6cf8a9d8667d71a1dfc2702aa1ce7f5b925a8f433b27ea3171fb1453d5b7a84d8983bb27a93df4c31a10c863f89de39b41
+  metadata.gz: 7d1611797b8f4aa7ef04671912a193fbf9882fbfd1bd0106f5d403c8da126cb24ae98fd9accaf8d72e4127d97edb13a79679c5589f0136152a945fe2e1976c08
+  data.tar.gz: 41dd9b803e0e660b0ba7f4b6f33ed591da957c99ac52a09e0fe3e171df668175ac77c9513deda9138602ad620c19f1f4470f1aa234e9ec0c84bae1cff8aa3e6a

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

data/README.rdoc

@@ -1,10 +1,6 @@
-= Git-Like Interface Command Line Parser
+= GLI, the Git-Like Interface Command Line Parser
 
-GLI is the best way to make a "command-suite" command-line application, e.g. one like <tt>git</tt> (for the best way to make a
-simpler command-line application, check out methadone[http://www.github.com/davetron5000/methadone]).
-
-GLI allows you to make a polished, easy-to-maintain command-line application without a lot
-of syntax, but without restricting you in any way from the power of +OptionParser+.
+GLI allows you to create command-line app in Ruby that behaves like <tt>git</tt> in that it takes subcommands to perform a series of complex action, e.g. <tt>git remote add</tt>.
 
 * {Overview}[http://davetron5000.github.com/gli]
 * {Source on Github}[http://github.com/davetron5000/gli]
@@ -12,16 +8,40 @@ of syntax, but without restricting you in any way from the power of +OptionParse
 
 {<img src="https://secure.travis-ci.org/davetron5000/gli.svg?branch=gli-2" alt="Build Status" />}[https://travis-ci.org/davetron5000/gli]
 
+== What Problem does GLI Solve?
+
+Creating a command-line app that uses subcommands, each of which might accept different command-line options, is somewhat difficult with Ruby's built-in <tt>OptionParser</tt>.  GLI provides an API that wraps <tt>OptionParser</tt> so that you can create a subcommand-based command-line app with minimal boilerplate. This API also produces complete documentation for your command-line app.
+
+== Why is GLI's solution different from others?
+
+There are other RubyGems that allow you to create a command-line app that takes subcommands.  These solutions are often quite limited (e.g. they don't allow deeply nested subcommand structures or sophisticated command-line options per subcommand), or require more code that we think is needed. Some solutions make it difficult or impossible to properly document your command-line  app.
+
+== What you need to know to use GLI
+
+You should know Ruby, and have a basic understanding of how the UNIX command line works: standard input, standard output, standard error, and exit codes.
+
 == Use
 
 Install if you need to:
 
     gem install gli
 
+You can validate you have installed it correctly by running <tt>gli help</tt>. You should see formatted help output.
+
+If you are using GLI in another application, add it to your <tt>Gemfile</tt>:
+
+    gem "gli"
+
+You can test your install via Bundler by running <tt>bundle exec gli help</tt>. This should produce formatted help output from GLI.
+
+== Getting Started
+
 The simplest way to get started is to create a scaffold project
 
     gli init todo list add complete
 
+(note if you installed via Bundler you will need to execute <tt>bundle exec gli init todo list add complete</tt>)
+
 This will create a basic scaffold project in <tt>./todo</tt> with:
 
 * executable in <tt>./todo/bin/todo</tt>.  This file demonstrates most of what you need to describe your command line interface.

data/bin/gli

@@ -36,7 +36,7 @@ long_desc <
 EOS
   arg :project_name
   arg :command_name, [:optional, :multiple]
-  arg_name "project_name [command_name][, [command_name]]*"
+  arg_name "project_name [command_name]..."
   command [:init,:scaffold] do |c|
 
     c.switch :e,:ext, :desc => 'Create an ext dir'

data/features/gli_executable.feature

@@ -49,7 +49,7 @@ Feature: The GLI executable works as intended
         init - Create a new GLI-based project
 
     SYNOPSIS
-        gli [global options] init [command options] project_name [command_name][, [command_name]]*
+        gli [global options] init [command options] project_name [command_name]...
 
     DESCRIPTION
         This will create a scaffold command line project that uses GLI for command

data/features/gli_init.feature

@@ -8,6 +8,7 @@ Feature: The scaffold GLI generates works
       And GLI's libs are in my path
       And my terminal size is "80x24"
 
+  @slow-command
   Scenario: Scaffold generates and things look good
     When I run `gli init --rvmrc todo add complete list`
     Then the exit status should be 0
@@ -35,6 +36,7 @@ Feature: The scaffold GLI generates works
        |todo/bin  |
        |todo/test |
        |todo/lib  |
+       |todo/.git |
      And the following files should exist:
        |todo/bin/todo              |
        |todo/README.rdoc           |

data/features/support/hooks.rb

@@ -0,0 +1,5 @@
+require 'aruba/cucumber'
+
+Before '@slow-command' do
+    @aruba_timeout_seconds = 10
+end

data/features/todo.feature

@@ -191,7 +191,7 @@ Feature: The todo app has a nice user interface
         list - List things, such as tasks or contexts
 
     SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task][, [task]]*
+        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task]...
         todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
 
     DESCRIPTION
@@ -261,7 +261,7 @@ Feature: The todo app has a nice user interface
         list - List things, such as tasks or contexts
 
     SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task][, [task]]*
+        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task]...
         todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
 
     DESCRIPTION
@@ -286,7 +286,7 @@ Feature: The todo app has a nice user interface
         list - List things, such as tasks or contexts
 
     SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task][, [task]]*
+        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task]...
         todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
 
     DESCRIPTION
@@ -319,7 +319,7 @@ Feature: The todo app has a nice user interface
         list - List things, such as tasks or contexts
 
     SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task][, [task]]*
+        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task]...
         todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
 
     DESCRIPTION
@@ -343,7 +343,7 @@ Feature: The todo app has a nice user interface
         tasks - List tasks
 
     SYNOPSIS
-        todo [global options] list tasks [command options] [task][, [task]]*
+        todo [global options] list tasks [command options] [task]...
         todo [global options] list tasks [command options] open [--flag arg] [-x arg]
 
     DESCRIPTION
@@ -370,9 +370,9 @@ Feature: The todo app has a nice user interface
         todo [global options] create 
         todo [global options] create contexts [context_name]
         todo [global options] create relation_1-1 first second [name]
-        todo [global options] create relation_1-n first second[, second]* [name]
-        todo [global options] create relation_n-1 first[, first]* second [name]
-        todo [global options] create tasks task_name[, task_name]*
+        todo [global options] create relation_1-n first second... [name]
+        todo [global options] create relation_n-1 first... second [name]
+        todo [global options] create tasks task_name...
 
     COMMANDS
         <default>    - Makes a new task
@@ -530,7 +530,7 @@ Feature: The todo app has a nice user interface
         list - List things, such as tasks or contexts
 
     SYNOPSIS
-        todo [global options] list [command options] [tasks] [subcommand options] [task][, [task]]*
+        todo [global options] list [command options] [tasks] [subcommand options] [task]...
         todo [global options] list [command options] contexts [subcommand options]
 
     DESCRIPTION

data/features/todo_legacy.feature

@@ -92,7 +92,7 @@ Feature: The todo app is backwards compatible with legacy subcommand parsing
     SYNOPSIS
         todo [global options] create 
         todo [global options] create contexts [context_name]
-        todo [global options] create tasks task_name[, task_name]*
+        todo [global options] create tasks task_name...
 
     COMMANDS
         <default> - Makes a new task

data/gli.gemspec

@@ -20,7 +20,6 @@ spec = Gem::Specification.new do |s|
   s.extra_rdoc_files = ['README.rdoc', 'gli.rdoc']
   s.rdoc_options << '--title' << 'Git Like Interface' << '--main' << 'README.rdoc'
   s.bindir = 'bin'
-  s.rubyforge_project = 'gli'
   s.add_development_dependency('rake', '~> 0.9.2.2')
   s.add_development_dependency('rdoc', '~> 4.2')
   s.add_development_dependency('rainbow', '~> 1.1', '~> 1.1.1')

data/lib/gli/command_support.rb

@@ -166,12 +166,8 @@ module GLI
 
     def generate_error_action(arguments)
       lambda { |global_options,options,arguments|
-        if am_subcommand?
-          if arguments.size > 0
-            raise UnknownCommand,"Unknown command '#{arguments[0]}'"
-          else
-            raise BadCommandLine,"Command '#{name}' requires a subcommand"
-          end
+        if am_subcommand? && arguments.size > 0
+          raise UnknownCommand,"Unknown command '#{arguments[0]}'"
         elsif have_subcommands?
           raise BadCommandLine,"Command '#{name}' requires a subcommand #{self.commands.keys.join(',')}"
         else

data/lib/gli/commands/help_modules/arg_name_formatter.rb

@@ -22,7 +22,7 @@ module GLI
               arg_desc = "[#{arg_desc}]"
             end
             if arg.multiple?
-              arg_desc = "#{arg_desc}[, #{arg_desc}]*"
+              arg_desc = "#{arg_desc}..."
             end
             desc = desc + " " + arg_desc
           end
@@ -37,7 +37,7 @@ module GLI
             desc = "[#{desc}]"
           end
           if arguments_options.include? :multiple
-            desc = "#{desc}[, #{desc}]*"
+            desc = "#{desc}..."
           end
           " " + desc
         end

data/lib/gli/commands/scaffold.rb

@@ -31,6 +31,7 @@ module GLI
           end
           puts "Created #{rvmrc}"
         end
+        init_git(root_dir, project_name)
       end
     end
 
@@ -369,6 +370,14 @@ EOS
       true
     end
 
+    def self.init_git(root_dir, project_name)
+      project_dir = "#{root_dir}/#{project_name}"
+
+      unless system("git", "init", "--quiet", project_dir)
+        puts "There was a problem initializing Git. Your gemspec may not work until you have done a successful `git init`"
+      end
+    end
+
     def self.mkdirs(dirs,force,dry_run)
       exists = false
       if !force

data/lib/gli/dsl.rb

@@ -50,7 +50,7 @@ module GLI
     #     command :pack do ...
     #
     # Produces the synopsis:
-    #     app.rb [global options] pack output input[, input]*
+    #     app.rb [global options] pack output input...
     def arg(name, options=[])
       @next_arguments ||= []
       @next_arguments << Argument.new(name, Array(options).flatten)

data/lib/gli/gli_option_parser.rb

@@ -29,7 +29,7 @@ module GLI
       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, options[:argument_handling_strategy])
+        option_parser_class.new(@accepts).parse!(parsing_result, options[:argument_handling_strategy], options[:autocomplete])
       }
     end
 
@@ -117,7 +117,7 @@ module GLI
         }
       end
 
-      def parse!(parsing_result,argument_handling_strategy)
+      def parse!(parsing_result,argument_handling_strategy,autocomplete)
         parsed_command_options = {}
         command = parsing_result.command
         arguments = nil
@@ -131,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, :default_command => command.get_default_command)
+          command_finder                  = CommandFinder.new(command.commands, :default_command => command.get_default_command, :autocomplete => autocomplete)
           next_command_name               = arguments.shift
 
           verify_required_options!(command.flags, command, parsed_command_options[command])
@@ -178,7 +178,7 @@ module GLI
     end
 
     class LegacyCommandOptionParser < NormalCommandOptionParser
-      def parse!(parsing_result,argument_handling_strategy)
+      def parse!(parsing_result,argument_handling_strategy,autocomplete)
         command                     = parsing_result.command
         option_parser_factory       = OptionParserFactory.for_command(command,@accepts)
         option_block_parser         = LegacyCommandOptionBlockParser.new(option_parser_factory, self.error_handler)
@@ -187,7 +187,7 @@ module GLI
         parsing_result.arguments       = option_block_parser.parse!(parsing_result.arguments)
         parsing_result.command_options = option_parser_factory.options_hash_with_defaults_set!
 
-        subcommand,args                = find_subcommand(command,parsing_result.arguments)
+        subcommand,args                = find_subcommand(command,parsing_result.arguments,autocomplete)
         parsing_result.command         = subcommand
         parsing_result.arguments       = args
         verify_required_options!(command.flags, parsing_result.command, parsing_result.command_options)
@@ -195,7 +195,7 @@ module GLI
 
     private
 
-      def find_subcommand(command,arguments)
+      def find_subcommand(command,arguments,autocomplete)
         arguments = Array(arguments)
         command_name = if arguments.empty?
                          nil
@@ -204,15 +204,15 @@ module GLI
                        end
 
         default_command = command.get_default_command
-        finder = CommandFinder.new(command.commands, :default_command => default_command.to_s)
+        finder = CommandFinder.new(command.commands, :default_command => default_command.to_s, :autocomplete => autocomplete)
 
         begin
           results = [finder.find_command(command_name),arguments[1..-1]]
-          find_subcommand(results[0],results[1])
+          find_subcommand(results[0],results[1],autocomplete)
         rescue UnknownCommand, AmbiguousCommand
           begin
             results = [finder.find_command(default_command.to_s),arguments]
-            find_subcommand(results[0],results[1])
+            find_subcommand(results[0],results[1],autocomplete)
           rescue UnknownCommand, AmbiguousCommand
             [command,arguments]
           end

data/lib/gli/version.rb

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

data/test/tc_subcommand_parsing.rb

@@ -78,6 +78,31 @@ class TC_testSubCommandParsing < Clean::Test::TestCase
     }
   end
 
+  test_that "in loose mode with autocomplete false, it doesn't autocorrect a sub command" do
+    Given :app_with_subcommand_storing_results, :normal, false, :loose
+    When {
+      @app.run(%w(-f global command -f flag -s subcomm  -f subflag))
+    }
+    Then {
+      with_clue {
+        assert_equal "command",@results[:command_name]
+      }
+    }
+  end
+
+  test_that "in strict mode with autocomplete false, it doesn't autocorrect a sub command" do
+    Given :app_with_subcommand_storing_results, :normal, false, :strict
+    When {
+      @app.run(%w(-f global command -f flag -s subcomm  -f subflag))
+    }
+    Then {
+      with_clue {
+        assert_equal nil,@results[:command_name]
+        assert       @fake_stderr.contained?(/error: Too many arguments for command/)
+      }
+    }
+  end
+
   test_that "in loose mode, argument validation is ignored" do
     Given :app_with_arguments, 1, 1, false, :loose
     When :run_app_with_X_arguments, 0
@@ -160,6 +185,41 @@ private
     raise
   end
 
+  def app_with_subcommand_storing_results(subcommand_option_handling_strategy, autocomplete, arguments_handling_strategy)
+    @app.subcommand_option_handling subcommand_option_handling_strategy
+    @app.autocomplete_commands autocomplete
+    @app.arguments arguments_handling_strategy
+    @app.flag ['f','flag']
+    @app.switch ['s','switch']
+
+    @app.command "command" do |c|
+      c.flag ['f','flag']
+      c.switch ['s','switch']
+      c.action do |global,options,args|
+        @results = {
+          :command_name => "command",
+          :global_options => global,
+          :command_options => options,
+          :args => args
+        }
+      end
+
+      c.command "subcommand" do |subcommand|
+        subcommand.flag ['f','flag']
+        subcommand.flag ['foo']
+        subcommand.switch ['s','switch']
+        subcommand.action do |global,options,args|
+          @results = {
+            :command_name => "subcommand",
+            :global_options => global,
+            :command_options => options,
+            :args => args
+          }
+        end
+      end
+    end
+  end
+
   def app_with_subcommands_storing_results(subcommand_option_handling_strategy = :legacy)
     @app.subcommand_option_handling subcommand_option_handling_strategy
     @app.flag ['f','flag']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.18.0
+  version: 2.19.2
 platform: ruby
 authors:
 - David Copeland
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-08 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -156,6 +156,7 @@ files:
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
@@ -172,6 +173,7 @@ files:
 - features/step_definitions/gli_init_steps.rb
 - features/step_definitions/todo_steps.rb
 - features/support/env.rb
+- features/support/hooks.rb
 - features/todo.feature
 - features/todo_legacy.feature
 - gli.cheat
@@ -264,7 +266,7 @@ homepage: http://davetron5000.github.com/gli
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - Git Like Interface
@@ -283,9 +285,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: gli
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Build command-suite CLI apps that are awesome.
 test_files:
@@ -295,6 +296,7 @@ test_files:
 - features/step_definitions/gli_init_steps.rb
 - features/step_definitions/todo_steps.rb
 - features/support/env.rb
+- features/support/hooks.rb
 - features/todo.feature
 - features/todo_legacy.feature
 - test/apps/README.md