gli 2.17.2 → 2.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f2ff76f03d4fc53954e649cea392e77f445b9fa0deae621fba59c66c52c27f0
-  data.tar.gz: f26e176e6967175ea76cf2278a1665cb9332b8f1b425990d11f6313e458cb1fb
+  metadata.gz: 635c14c43560039c5a46a367a501201b6d255dfb850d1280a8300e0c5b7f9ab8
+  data.tar.gz: 0d82f1d19eb5f41a91cdee92f3acf1732b84f93ff9e6353a4e18ad438a5f259a
 SHA512:
-  metadata.gz: d9895c2424a0e49d6d185fc73ab433e74d9b366d87697e865633713eedbc8abbdd2afc6cfe045e9aa1197fbe4ed41eb883dcde178e615e125a9d3d70056aca2d
-  data.tar.gz: 1f5b8750936328ac2a175a7d8b9cf89cd050e8710b5b6939425bab405c8e61d7cbd59c7a34645910008440dc7034f7fab7a817553ac0ac85728bbda84e16324d
+  metadata.gz: ae6e5aa99a45658686fdbd6cb0e7835c66f0761f8cb0a7e7822265e963d08830441ba6024b747bd0a077152110b55b7c7726bdb55178b1b188bfe2e9804b3968
+  data.tar.gz: '0396dc0ac0290db90f9715bf4b3f3352394003403b81fe0b0c1c6b57af5f981983ac7e691bf17d1e68e9dee80358b9e87991407137a4824464270c4574d468b8'

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

@@ -3,63 +3,66 @@
 require 'gli'
 require 'gli/commands/scaffold'
 
-include GLI::App
+class App
+  extend GLI::App
 
-program_desc 'create scaffolding for a GLI-powered application'
+  program_desc 'create scaffolding for a GLI-powered application'
 
-version GLI::VERSION
+  version GLI::VERSION
 
-# Can't use these without changing the current behavior of gli
-# arguments :strict
-# subcommand_option_handling :normal
+  # Can't use these without changing the current behavior of gli
+  # arguments :strict
+  # subcommand_option_handling :normal
 
-switch :v, :desc => 'Be verbose'
+  switch :v, :desc => 'Be verbose'
 
-switch :n, :desc => 'Dry run; don''t change the disk'
+  switch :n, :desc => 'Dry run; don''t change the disk'
 
-desc 'Root dir of project'
+  desc 'Root dir of project'
 long_desc <<EOS
-This is the directory where the project''s directory will be made, so if you 
-specify a project name ''foo'' and the root dir of ''.'', the directory 
-''./foo'' will be created'
+  This is the directory where the project''s directory will be made, so if you
+  specify a project name ''foo'' and the root dir of ''.'', the directory
+  ''./foo'' will be created'
 EOS
 
-flag :r,:root, :default_value => '.'
+  flag :r,:root, :default_value => '.'
 
-desc 'Create a new GLI-based project'
+  desc 'Create a new GLI-based project'
 long_desc <<EOS
-This will create a scaffold command line project that uses GLI
-for command line processing.  Specifically, this will create
-an executable ready to go, as well as a lib and test directory, all
-inside the directory named for your project
+  This will create a scaffold command line project that uses GLI
+  for command line processing.  Specifically, this will create
+  an executable ready to go, as well as a lib and test directory, all
+  inside the directory named for your project
 EOS
-arg :project_name
-arg :command_name, [:optional, :multiple]
-arg_name "project_name [command_name][, [command_name]]*"
-command [:init,:scaffold] do |c|
+  arg :project_name
+  arg :command_name, [:optional, :multiple]
+  arg_name "project_name [command_name]..."
+  command [:init,:scaffold] do |c|
 
-  c.switch :e,:ext, :desc => 'Create an ext dir'
+    c.switch :e,:ext, :desc => 'Create an ext dir'
 
-  c.switch :notest, :desc => 'Do not create a test or features dir', :negatable => false
+    c.switch :notest, :desc => 'Do not create a test or features dir', :negatable => false
 
-  c.switch :force, :desc => 'Overwrite/ignore existing files and directories'
+    c.switch :force, :desc => 'Overwrite/ignore existing files and directories'
 
-  c.switch :rvmrc, :desc => 'Create an .rvmrc based on your current RVM setup'
+    c.switch :rvmrc, :desc => 'Create an .rvmrc based on your current RVM setup'
 
-  c.action do |g,o,args|
-    if args.length < 1
-      raise 'You must specify the name of your project'
+    c.action do |g,o,args|
+      if args.length < 1
+        raise 'You must specify the name of your project'
+      end
+      GLI::Commands::Scaffold.create_scaffold(g[:r],!o[:notest],o[:e],args[0],args[1..-1],o[:force],g[:n],o[:rvmrc])
     end
-    GLI::Commands::Scaffold.create_scaffold(g[:r],!o[:notest],o[:e],args[0],args[1..-1],o[:force],g[:n],o[:rvmrc])
   end
-end
 
-pre do |global,command,options,args|
-  puts "Executing #{command.name}" if global[:v]
-  true
-end
+  pre do |global,command,options,args|
+    puts "Executing #{command.name}" if global[:v]
+    true
+  end
 
-post do |global,command,options,args|
-  puts "Executed #{command.name}" if global[:v]
+  post do |global,command,options,args|
+    puts "Executed #{command.name}" if global[:v]
+  end
 end
-exit run(ARGV)
+
+exit App.run(ARGV)

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           |
@@ -47,6 +49,8 @@ Feature: The scaffold GLI generates works
        |todo/lib/todo/version.rb   |
        |todo/lib/todo.rb           |
        |todo/.rvmrc                |
+     And the file "todo/README.rdoc" should contain ":include:todo.rdoc"
+     And the file "todo/todo.rdoc" should contain "todo _doc"
     When I cd to "todo"
      And I make sure todo's lib dir is in my lib path
      And I run `bin/todo`

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/gli.rdoc

@@ -1,6 +1,6 @@
 == gli - create scaffolding for a GLI-powered application
 
-v2.12.1
+v2.17.1
 
 === Global Options
 === -r|--root arg
@@ -8,9 +8,9 @@ v2.12.1
 Root dir of project
 
 [Default Value] .
-This is the directory where the project''s directory will be made, so if you 
-specify a project name ''foo'' and the root dir of ''.'', the directory 
-''./foo'' will be created'
+This is the directory where the project''s directory will be made, so if you
+  specify a project name ''foo'' and the root dir of ''.'', the directory
+  ''./foo'' will be created'
 
 === --help
 Show this message
@@ -33,3 +33,41 @@ Display the program version
 
 
 === Commands
+==== Command: <tt>help  command</tt>
+Shows a list of commands or help for one command
+
+Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function
+===== Options
+===== -c
+List commands one per line, to assist with shell completion
+
+
+
+==== Command: <tt>init|scaffold  project_name [command_name][, [command_name]]*</tt>
+Create a new GLI-based project
+
+This will create a scaffold command line project that uses GLI
+  for command line processing.  Specifically, this will create
+  an executable ready to go, as well as a lib and test directory, all
+  inside the directory named for your project
+===== Options
+===== -e|--[no-]ext
+Create an ext dir
+
+
+
+===== --[no-]force
+Overwrite/ignore existing files and directories
+
+
+
+===== --notest
+Do not create a test or features dir
+
+
+
+===== --[no-]rvmrc
+Create an .rvmrc based on your current RVM setup
+
+
+

data/lib/gli.rb

@@ -24,6 +24,7 @@ require 'gli/commands/doc'
 
 module GLI
   include GLI::App
+
   def self.included(klass)
     warn "You should include GLI::App instead"
   end

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/rdoc_document_listener.rb

@@ -5,6 +5,7 @@ module GLI
     class RdocDocumentListener
 
       def initialize(global_options,options,arguments,app)
+        @app = app
         @io = File.new("#{app.exe_name}.rdoc",'w')
         @nest = ''
         @arg_name_formatter = GLI::Commands::HelpModules::ArgNameFormatter.new

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
 
@@ -44,7 +45,7 @@ module GLI
       puts "Created #{root_dir}/#{project_name}/README.rdoc"
       File.open("#{root_dir}/#{project_name}/#{project_name}.rdoc",'w') do |file|
         file << "= #{project_name}\n\n"
-        file << "Generate this with\n    #{project_name} rdoc\nAfter you have described your command line interface"
+        file << "Generate this with\n    #{project_name} _doc\nAfter you have described your command line interface"
       end
       puts "Created #{root_dir}/#{project_name}/#{project_name}.rdoc"
     end
@@ -277,85 +278,87 @@ rescue LoadError
   exit 64
 end
 
-include GLI::App
+class App
+  extend GLI::App
 
-program_desc 'Describe your application here'
+  program_desc 'Describe your application here'
 
-version #{project_name_as_module_name(project_name)}::VERSION
+  version #{project_name_as_module_name(project_name)}::VERSION
 
-subcommand_option_handling :normal
-arguments :strict
+  subcommand_option_handling :normal
+  arguments :strict
 
-desc 'Describe some switch here'
-switch [:s,:switch]
+  desc 'Describe some switch here'
+  switch [:s,:switch]
 
-desc 'Describe some flag here'
-default_value 'the default'
-arg_name 'The name of the argument'
-flag [:f,:flagname]
+  desc 'Describe some flag here'
+  default_value 'the default'
+  arg_name 'The name of the argument'
+  flag [:f,:flagname]
 EOS
             first = true
             commands.each do |command|
               file.puts <<EOS
 
-desc 'Describe #{command} here'
-arg_name 'Describe arguments to #{command} here'
+  desc 'Describe #{command} here'
+  arg_name 'Describe arguments to #{command} here'
 EOS
               if first
                 file.puts <<EOS
-command :#{command} do |c|
-  c.desc 'Describe a switch to #{command}'
-  c.switch :s
+  command :#{command} do |c|
+    c.desc 'Describe a switch to #{command}'
+    c.switch :s
 
-  c.desc 'Describe a flag to #{command}'
-  c.default_value 'default'
-  c.flag :f
-  c.action do |global_options,options,args|
+    c.desc 'Describe a flag to #{command}'
+    c.default_value 'default'
+    c.flag :f
+    c.action do |global_options,options,args|
 
-    # Your command logic here
+      # Your command logic here
 
-    # If you have any errors, just raise them
-    # raise "that command made no sense"
+      # If you have any errors, just raise them
+      # raise "that command made no sense"
 
-    puts "#{command} command ran"
+      puts "#{command} command ran"
+    end
   end
-end
 EOS
               else
                 file.puts <<EOS
-command :#{command} do |c|
-  c.action do |global_options,options,args|
-    puts "#{command} command ran"
+  command :#{command} do |c|
+    c.action do |global_options,options,args|
+      puts "#{command} command ran"
+    end
   end
-end
 EOS
               end
               first = false
             end
             file.puts <<EOS
 
-pre do |global,command,options,args|
-  # Pre logic here
-  # Return true to proceed; false to abort and not call the
-  # chosen command
-  # Use skips_pre before a command to skip this block
-  # on that command only
-  true
-end
+  pre do |global,command,options,args|
+    # Pre logic here
+    # Return true to proceed; false to abort and not call the
+    # chosen command
+    # Use skips_pre before a command to skip this block
+    # on that command only
+    true
+  end
 
-post do |global,command,options,args|
-  # Post logic here
-  # Use skips_post before a command to skip this
-  # block on that command only
-end
+  post do |global,command,options,args|
+    # Post logic here
+    # Use skips_post before a command to skip this
+    # block on that command only
+  end
 
-on_error do |exception|
-  # Error logic here
-  # return false to skip default error handling
-  true
+  on_error do |exception|
+    # Error logic here
+    # return false to skip default error handling
+    true
+  end
 end
 
-exit run(ARGV)
+exit App.run(ARGV)
 EOS
             puts "Created #{bin_file}"
           end
@@ -367,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.17.2'
+    VERSION = '2.19.1'
   end
 end

data/test/apps/todo/bin/todo

@@ -7,11 +7,11 @@ $: << File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
 require 'gli'
 require 'todo/version'
 
-
+class App
 if ENV['GLI1_COMPATIBILITY']
-include GLI
+extend GLI
 else
-include GLI::App
+extend GLI::App
 end
 
 sort_help (ENV['TODO_SORT_HELP'] || 'alpha').to_sym
@@ -70,5 +70,5 @@ on_error do |exception|
   # return false to skip default error handling
   true
 end
-
-exit run(ARGV)
+end
+exit App.run(ARGV)

data/test/apps/todo/lib/todo/commands/create.rb

@@ -1,53 +1,54 @@
-desc "Create a new task or context"
-command [:create,:new] do |c|
-  c.desc "Make a new task"
-  c.arg_name 'task_name', :multiple
-  c.arg :should_ignore_this
-  c.command :tasks do |tasks|
-    tasks.action do |global,options,args|
-      puts "#{args}"
+class App
+  desc "Create a new task or context"
+  command [:create,:new] do |c|
+    c.desc "Make a new task"
+    c.arg_name 'task_name', :multiple
+    c.arg :should_ignore_this
+    c.command :tasks do |tasks|
+      tasks.action do |global,options,args|
+        puts "#{args}"
+      end
     end
-  end
 
-  c.desc "Make a new context"
-  c.arg :should_ignore_this
-  c.arg_name 'context_name', :optional
-  c.command :contexts do |contexts|
-    contexts.action do |global,options,args|
-      puts "#{args}"
+    c.desc "Make a new context"
+    c.arg :should_ignore_this
+    c.arg_name 'context_name', :optional
+    c.command :contexts do |contexts|
+      contexts.action do |global,options,args|
+        puts "#{args}"
+      end
     end
-  end
 
-  c.default_desc "Makes a new task"
-  c.action do
-    puts "default action"
-  end
+    c.default_desc "Makes a new task"
+    c.action do
+      puts "default action"
+    end
 
-  c.arg "first"
-  c.arg "second"
-  c.arg "name", :optional
-  c.command :"relation_1-1" do |remote|
-    remote.action do |global,options,args|
-      puts "relation: #{args}"
+    c.arg "first"
+    c.arg "second"
+    c.arg "name", :optional
+    c.command :"relation_1-1" do |remote|
+      remote.action do |global,options,args|
+        puts "relation: #{args}"
+      end
     end
-  end
 
-  c.arg "first", :multiple
-  c.arg "second"
-  c.arg "name", :optional
-  c.command :"relation_n-1" do |remote|
-    remote.action do |global,options,args|
-      puts "relation: #{args}"
+    c.arg "first", :multiple
+    c.arg "second"
+    c.arg "name", :optional
+    c.command :"relation_n-1" do |remote|
+      remote.action do |global,options,args|
+        puts "relation: #{args}"
+      end
     end
-  end
 
-  c.arg "first"
-  c.arg "second", :multiple
-  c.arg "name", :optional
-  c.command :"relation_1-n" do |remote|
-    remote.action do |global,options,args|
-      puts "relation: #{args}"
+    c.arg "first"
+    c.arg "second", :multiple
+    c.arg "name", :optional
+    c.command :"relation_1-n" do |remote|
+      remote.action do |global,options,args|
+        puts "relation: #{args}"
+      end
     end
   end
 end
-

data/test/apps/todo/lib/todo/commands/list.rb

@@ -1,5 +1,6 @@
-desc "List things, such as tasks or contexts"
-long_desc %(
+class App
+  desc "List things, such as tasks or contexts"
+  long_desc %(
   List a whole lot of things that you might be keeping track of 
   in your overall todo list.
 
@@ -9,69 +10,69 @@ long_desc %(
   your todo databases.
 )
 
-command [:list] do |c|
-  c.default_command :tasks
+  command [:list] do |c|
+    c.default_command :tasks
 
-  c.desc "Show long form"
-  c.switch [:l,:long]
+    c.desc "Show long form"
+    c.switch [:l,:long]
 
-  c.flag :required_flag, :required => true
-  c.flag :required_flag2, :required => true
+    c.flag :required_flag, :required => true
+    c.flag :required_flag2, :required => true
 
-  c.desc "List tasks"
-  c.long_desc %(
+    c.desc "List tasks"
+    c.long_desc %(
     Lists all of your tasks that you have, in varying orders, and
     all that stuff.  Yes, this is long, but I need a long description.
   )
 
-  c.arg :task, [:optional, :multiple]
-  c.command :tasks do |tasks|
-    tasks.desc "blah blah crud x whatever"
-    tasks.flag [:x], :must_match => Array
+    c.arg :task, [:optional, :multiple]
+    c.command :tasks do |tasks|
+      tasks.desc "blah blah crud x whatever"
+      tasks.flag [:x], :must_match => Array
 
-    tasks.flag :flag
+      tasks.flag :flag
 
-    tasks.action do |global,options,args|
-      puts options[:x].inspect
-      puts "list tasks: #{args.join(',')}"
-    end
+      tasks.action do |global,options,args|
+        puts options[:x].inspect
+        puts "list tasks: #{args.join(',')}"
+      end
 
-    tasks.desc 'list open tasks'
-    tasks.command :open do |open|
-      open.desc "blah blah crud x whatever"
-      open.flag [:x], :must_match => Array
+      tasks.desc 'list open tasks'
+      tasks.command :open do |open|
+        open.desc "blah blah crud x whatever"
+        open.flag [:x], :must_match => Array
 
-      open.flag :flag
+        open.flag :flag
 
-      open.example "todo list tasks open --flag=blah", desc: "example number 1"
-      open.example "todo list tasks open -x foo"
+        open.example "todo list tasks open --flag=blah", desc: "example number 1"
+        open.example "todo list tasks open -x foo"
 
-      open.action do |global,options,args|
-        puts "tasks open"
+        open.action do |global,options,args|
+          puts "tasks open"
+        end
       end
-    end
 
-    tasks.default_desc 'list all tasks'
-  end
+      tasks.default_desc 'list all tasks'
+    end
 
-  c.desc "List contexts"
-  c.long_desc %(
+    c.desc "List contexts"
+    c.long_desc %(
     Lists all of your contexts, which are places you might be 
     where you can do stuff and all that.
   )
-  c.command :contexts do |contexts|
+    c.command :contexts do |contexts|
 
-    contexts.desc "Foobar"
-    contexts.switch [:f,'foobar']
+      contexts.desc "Foobar"
+      contexts.switch [:f,'foobar']
 
-    contexts.desc "Blah"
-    contexts.switch [:b]
+      contexts.desc "Blah"
+      contexts.switch [:b]
 
-    contexts.flag :otherflag
+      contexts.flag :otherflag
 
-    contexts.action do |global,options,args|
-      puts "list contexts: #{args.join(',')}"
+      contexts.action do |global,options,args|
+        puts "list contexts: #{args.join(',')}"
+      end
     end
   end
 end
-

data/test/apps/todo/lib/todo/commands/ls.rb

@@ -1,6 +1,7 @@
-# This is copied so I can have two slightly different versions of the same thing
-desc "LS things, such as tasks or contexts"
-long_desc %(
+class App
+  # This is copied so I can have two slightly different versions of the same thing
+  desc "LS things, such as tasks or contexts"
+  long_desc %(
   List a whole lot of things that you might be keeping track of 
   in your overall todo list.
 
@@ -9,39 +10,39 @@ long_desc %(
   stored in 
   your todo databases.
 )
-command [:ls] do |c|
-  c.desc "Show long form"
-  c.switch [:l,:long]
+  command [:ls] do |c|
+    c.desc "Show long form"
+    c.switch [:l,:long]
 
-  c.desc "List tasks"
-  c.long_desc %(
+    c.desc "List tasks"
+    c.long_desc %(
     Lists all of your tasks that you have, in varying orders, and
     all that stuff.  Yes, this is long, but I need a long description.
   )
-  c.command :tasks do |tasks|
-    tasks.desc "blah blah crud x whatever"
-    tasks.flag [:x]
-    tasks.action do |global,options,args|
-      puts "ls tasks: #{args.join(',')}"
+    c.command :tasks do |tasks|
+      tasks.desc "blah blah crud x whatever"
+      tasks.flag [:x]
+      tasks.action do |global,options,args|
+        puts "ls tasks: #{args.join(',')}"
+      end
     end
-  end
 
-  c.desc "List contexts"
-  c.long_desc %(
+    c.desc "List contexts"
+    c.long_desc %(
     Lists all of your contexts, which are places you might be 
     where you can do stuff and all that.
   )
-  c.command :contexts do |contexts|
+    c.command :contexts do |contexts|
 
-    contexts.desc "Foobar"
-    contexts.switch [:f,'foobar']
+      contexts.desc "Foobar"
+      contexts.switch [:f,'foobar']
 
-    contexts.desc "Blah"
-    contexts.switch [:b]
+      contexts.desc "Blah"
+      contexts.switch [:b]
 
-    contexts.action do |global,options,args|
-      puts "ls contexts: #{args.join(',')}"
+      contexts.action do |global,options,args|
+        puts "ls contexts: #{args.join(',')}"
+      end
     end
   end
 end
-

data/test/apps/todo/lib/todo/commands/make.rb

@@ -1,53 +1,55 @@
-command [:make] do |c|
-  c.desc "Show long form"
-  c.flag [:l,:long]
+class App
+  command [:make] do |c|
+    c.desc "Show long form"
+    c.flag [:l,:long]
 
-  c.desc 'make a new task'
-  c.command :task do |task|
-    task.desc 'make the task a long task'
-    task.flag [:l,:long]
+    c.desc 'make a new task'
+    c.command :task do |task|
+      task.desc 'make the task a long task'
+      task.flag [:l,:long]
 
-    task.action do |g,o,a|
-      puts 'new task'
-      puts a.join(',')
-      puts o[:long]
+      task.action do |g,o,a|
+        puts 'new task'
+        puts a.join(',')
+        puts o[:long]
+      end
+
+      task.desc 'make a bug'
+      task.arg :argument, [:multiple, :optional]
+      task.command :bug do |bug|
+        bug.desc 'make this bug in the legacy system'
+        bug.flag [:l,:legacy]
+
+        bug.action do |g,o,a|
+          puts 'new task bug'
+          puts a.join(',')
+          # All this .to_s is to make sure 1.8.7/REE don't convert nil to the string "nil"
+          puts o[:legacy].to_s
+          puts o[:long].to_s
+          puts o[:l].to_s
+          puts o[GLI::Command::PARENT][:l].to_s
+          puts o[GLI::Command::PARENT][:long].to_s
+          puts o[GLI::Command::PARENT][:legacy].to_s
+          puts o[GLI::Command::PARENT][GLI::Command::PARENT][:l].to_s
+          puts o[GLI::Command::PARENT][GLI::Command::PARENT][:long].to_s
+          puts o[GLI::Command::PARENT][GLI::Command::PARENT][:legacy].to_s
+        end
+      end
     end
 
-    task.desc 'make a bug'
-    task.arg :argument, [:multiple, :optional]
-    task.command :bug do |bug|
-      bug.desc 'make this bug in the legacy system'
-      bug.flag [:l,:legacy]
+    c.desc 'make a new context'
+    c.command :context do |context|
+      context.desc 'make the context a local context'
+      context.flag [:l,:local]
 
-      bug.action do |g,o,a|
-        puts 'new task bug'
+      context.action do |g,o,a|
+        puts 'new context'
         puts a.join(',')
-        # All this .to_s is to make sure 1.8.7/REE don't convert nil to the string "nil"
-        puts o[:legacy].to_s
+        puts o[:local].to_s
         puts o[:long].to_s
         puts o[:l].to_s
-        puts o[GLI::Command::PARENT][:l].to_s
-        puts o[GLI::Command::PARENT][:long].to_s
-        puts o[GLI::Command::PARENT][:legacy].to_s
-        puts o[GLI::Command::PARENT][GLI::Command::PARENT][:l].to_s
-        puts o[GLI::Command::PARENT][GLI::Command::PARENT][:long].to_s
-        puts o[GLI::Command::PARENT][GLI::Command::PARENT][:legacy].to_s
       end
     end
-  end
-
-  c.desc 'make a new context'
-  c.command :context do |context|
-    context.desc 'make the context a local context'
-    context.flag [:l,:local]
 
-    context.action do |g,o,a|
-      puts 'new context'
-      puts a.join(',')
-      puts o[:local].to_s
-      puts o[:long].to_s
-      puts o[:l].to_s
-    end
   end
-
 end

data/test/apps/todo_plugins/commands/third.rb

@@ -1 +1,3 @@
+class App
 command :third do |c| c.action { |g,o,a| puts "third: #{a.join(',')}" } 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.17.2
+  version: 2.19.1
 platform: ruby
 authors:
 - David Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-18 00:00:00.000000000 Z
+date: 2020-05-31 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
@@ -283,8 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: gli
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Build command-suite CLI apps that are awesome.
@@ -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