gli 2.18.2 → 2.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ce48a9dbc23454ebd42678e837bab21aab64a6d9e9bc1713d3ce57ddd8a802a
-  data.tar.gz: 74e014e219d5ade2ff39bdf8ad69c0a19a258bc2208566438f3b3f87fbf98d2e
+  metadata.gz: 1d9dfe82dab8b65f6e40398bac8a94cac024b5cd252da184b52b00d29512b78c
+  data.tar.gz: 3914a6632dc595e1fda18c544665cb2ead472f41f5eeb1a4357bc4bb485f20ae
 SHA512:
-  metadata.gz: 326911ec59ad5867f0a9acc3fac254258d59514b0efb99327834a6c2f79941f505f5cae9d284d330f4f32a80f4f9bea07146f48009940a7848a047899f8fcc71
-  data.tar.gz: '0585ba1acb20eb2f9a743a4e5c3e715f3a10a0d9cc60b6ba2003f4034cd9c75c9347f0c91894fc0535bc32d32871a63cb7418d326d23ab732fbd7141eec4b462'
+  metadata.gz: af8cac9a13eaea92e7c76af8036edc21ef7f01e37efd63e475de7ce85b745e20fdcffb8d4d1bc9eff8038c5e05b298f8cc8e868cd19e7d16de0a8c7f2df7dd31
+  data.tar.gz: 96dd62eed7e82d5072720408df78377d603af67bf52938b4f7844a782e0a91602ad37e33a363dc8b40cab70edd45bb31b977385428d9a33e259e56f6f39c6776

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.18.2
+  version: 2.19.0
 platform: ruby
 authors:
 - David Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-10 00:00:00.000000000 Z
+date: 2019-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake