gli 2.9.0 → 2.20.0

data/lib/gli/option_parser_factory.rb

@@ -58,8 +58,15 @@ module GLI
       tokens.each do |ignore,token|
         opts.on(*token.arguments_for_option_parser) do |arg|
           token.names_and_aliases.each do |name|
-            options[name] = arg
-            options[name.to_sym] = arg
+            if token.kind_of?(Flag) && token.multiple?
+              options[name] ||= []
+              options[name.to_sym] ||= []
+              options[name] << arg
+              options[name.to_sym] << arg
+            else
+              options[name] = arg
+              options[name.to_sym] = arg
+            end
           end
         end
       end
@@ -71,7 +78,7 @@ module GLI
       unless help_args.empty?
         help_args << "Get help for #{command.name}"
         option_parser.on(*help_args) do
-          raise CommandException.new(nil,command,0)
+          raise RequestHelp.new(command)
         end
       end
     end

data/lib/gli/options.rb

@@ -7,12 +7,12 @@ module GLI
 
     # Return the value of an attribute
     def[](k)
-      @table[k.to_sym]
+      self.send(k.to_sym)
     end
 
     # Set the value of an attribute
     def[]=(k, v)
-      @table[k.to_sym] = v
+      self.send("#{k.to_sym}=",v)
     end
 
     def map(&block)

data/lib/gli/switch.rb

@@ -31,5 +31,9 @@ module GLI
     def negatable?
       @negatable
     end
+
+    def required?
+      false
+    end
   end
 end

data/lib/gli/terminal.rb

@@ -43,7 +43,7 @@ module GLI
     #
     # +command+:: The command, as a String, to check for, without any path information.
     def self.command_exists?(command)
-      ENV['PATH'].split(File::PATH_SEPARATOR).any? {|dir| File.exists? File.join(dir, command) }
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? {|dir| File.exist? File.join(dir, command) }
     end
 
     def command_exists?(command)
@@ -78,7 +78,11 @@ module GLI
     #
     # Returns an Array of size two Ints representing the terminal width and height
     def size
-      SIZE_DETERMINERS.select { |(predicate,ignore)| predicate.call }.first[1].call
+      SIZE_DETERMINERS.each do |predicate, get_size|
+        next unless predicate.call
+        size = get_size.call
+        return size unless size == [0, 0]
+      end
     rescue Exception => ex
       raise ex if @unsafe
       Terminal.default_size

data/lib/gli/version.rb

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

data/lib/gli.rb

@@ -13,6 +13,7 @@ require 'gli/exceptions.rb'
 require 'gli/flag.rb'
 require 'gli/options.rb'
 require 'gli/switch.rb'
+require 'gli/argument.rb'
 require 'gli/dsl.rb'
 require 'gli/version.rb'
 require 'gli/commands/help'
@@ -23,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/object-model.dot

@@ -0,0 +1,29 @@
+digraph G {
+
+  rankdir="BT"
+  nodesep=0.5
+
+  node[shape=record fontname=courier fontsize=18]
+  edge[fontname=avenir fontsize=12]
+
+  CommandLineToken  [ label="{ CommandLineToken | #name\l | #description\l | #long_description\l | #aliases\l}"]
+  CommandLineOption [ label="{ CommandLineOption | #default_value \l }"]
+  DSL
+  Command
+  Flag              [ label="{ Flag | #argument_name\l }"]
+  Switch
+  App
+  TopLevel          [ label="top level?" shape=diamond fontname=avenir fontsize=12]
+
+  Command           -> DSL               [ arrowhead=oarrow   label="  includes" minlen=3]
+  Command           -> CommandLineToken  [ arrowhead=oarrow   label="inherits"]
+  CommandLineOption -> CommandLineToken  [ arrowhead=oarrow   label="inherits"]
+  Flag              -> CommandLineOption [ arrowhead=oarrow   label="inherits"]
+  Switch            -> CommandLineOption [ arrowhead=oarrow   label="inherits"]
+  Command           -> TopLevel          [ arrowhead=none     label="parent" style=dotted]
+  TopLevel          -> App               [ arrowhead=odiamond label="YES"    style=dotted ]
+  TopLevel          -> Command           [ arrowhead=odiamond label="NO"     style=dotted ]
+  CommandLineOption -> Command           [ arrowhead=odiamond style=dotted label="associated_command"]
+
+  { rank=same; DSL; App }
+}

data/test/apps/todo/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec

data/test/apps/todo/bin/todo

@@ -1,24 +1,26 @@
 #!/usr/bin/env ruby
 
 # These would not be in a real GLI app; we do this so we can easily run this on the command line
-$: << File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','lib'))
+$: << File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','..','lib'))
 $: << 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
 wrap_help_text (ENV['TODO_WRAP_HELP_TEXT'] || 'to_terminal').to_sym
 synopsis_format (ENV['SYNOPSES'] || 'full').to_sym
+hide_commands_without_desc ENV['HIDE_COMMANDS_WITHOUT_DESC'] === 'true'
 
 subcommand_option_handling :normal
+arguments :strict
 
 program_desc 'Manages tasks'
 program_long_desc "A test program that has a sophisticated UI that can be used to exercise a lot of GLI's power"
@@ -34,10 +36,18 @@ version Todo::VERSION
 commands_from 'todo/commands'
 commands_from File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'todo_plugins', 'commands'))
 
+arg_name :argument, :optional
 command :first  do |c| c.action { |g,o,a| puts "first: #{a.join(',')}" } end
+
+arg :argument, :optional
 command :second do |c| c.action { |g,o,a| puts "second: #{a.join(',')}" } end
 
+arg :first
+arg :second
 command :chained         => [ :first, :second ]
+
+arg :first
+arg :second
 command [:chained2,:ch2] => [ :second, :first ]
 
 pre do |global,command,options,args|
@@ -60,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,24 +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.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_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
+
+    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}"
+      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}"
+      end
     end
-  end
 
-  c.default_desc "Makes a new task"
-  c.action do
-    puts "default action"
+    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.
 
@@ -8,58 +9,70 @@ long_desc %(
   stored in 
   your todo databases.
 )
-command [:list] do |c|
-  c.default_command :tasks
 
-  c.desc "Show long form"
-  c.switch [:l,:long]
+  command [:list] do |c|
+    c.default_command :tasks
 
-  c.flag :required_flag, :required => true
+    c.desc "Show long form"
+    c.switch [:l,:long]
 
-  c.desc "List tasks"
-  c.long_desc %(
+    c.flag :required_flag, :required => true
+    c.flag :required_flag2, :required => true
+
+    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], :must_match => Array
 
-    tasks.flag :flag
+    c.arg :task, [:optional, :multiple]
+    c.command :tasks do |tasks|
+      tasks.desc "blah blah crud x whatever"
+      tasks.flag [:x], :must_match => Array
 
-    tasks.action do |global,options,args|
-      puts options[:x].inspect
-      puts "list tasks: #{args.join(',')}"
-    end
+      tasks.flag :flag
 
-    tasks.desc 'list open tasks'
-    tasks.command :open do |open|
-      open.action do |global,options,args|
-        puts "tasks open"
+      tasks.action do |global,options,args|
+        puts options[:x].inspect
+        puts "list tasks: #{args.join(',')}"
       end
-    end
 
-    tasks.default_desc 'list all tasks'
-  end
+      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.example "todo list tasks open --flag=blah", desc: "example number 1"
+        open.example "todo list tasks open -x foo"
 
-  c.desc "List contexts"
-  c.long_desc %(
+        open.action do |global,options,args|
+          puts "tasks open"
+        end
+      end
+
+      tasks.default_desc 'list all tasks'
+    end
+
+    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,52 +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
 
-    desc 'make a bug'
-    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/todo.gemspec

@@ -1,6 +1,6 @@
 # Ensure we require the local version and not one we might have installed already
 require File.join([File.dirname(__FILE__),'lib','todo','version.rb'])
-spec = Gem::Specification.new do |s| 
+spec = Gem::Specification.new do |s|
   s.name = 'todo'
   s.version = Todo::VERSION
   s.author = 'Your Name Here'
@@ -13,7 +13,6 @@ spec = Gem::Specification.new do |s|
 bin/todo
   )
   s.require_paths << 'lib'
-  s.has_rdoc = true
   s.extra_rdoc_files = ['README.rdoc','todo.rdoc']
   s.rdoc_options << '--title' << 'todo' << '--main' << 'README.rdoc' << '-ri'
   s.bindir = 'bin'

data/test/apps/todo_legacy/todo.gemspec

@@ -1,6 +1,6 @@
 # Ensure we require the local version and not one we might have installed already
 require File.join([File.dirname(__FILE__),'lib','todo','version.rb'])
-spec = Gem::Specification.new do |s| 
+spec = Gem::Specification.new do |s|
   s.name = 'todo'
   s.version = Todo::VERSION
   s.author = 'Your Name Here'
@@ -13,7 +13,6 @@ spec = Gem::Specification.new do |s|
 bin/todo
   )
   s.require_paths << 'lib'
-  s.has_rdoc = true
   s.extra_rdoc_files = ['README.rdoc','todo.rdoc']
   s.rdoc_options << '--title' << 'todo' << '--main' << 'README.rdoc' << '-ri'
   s.bindir = 'bin'

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/integration/gli_cli_test.rb

@@ -0,0 +1,69 @@
+require_relative "test_helper"
+require "open3"
+
+class GLICLITest < MiniTest::Test
+  include TestHelper
+
+  class AppHelp < GLICLITest
+    def test_running_with_no_options_produces_help
+      out = run_gli
+      assert_output_looks_like_help out
+    end
+
+    def test_running_with_help_command_produces_help
+      out = run_gli("help")
+      assert_output_looks_like_help out
+    end
+
+    def test_running_with_help_switch_produces_help
+      out = run_gli("--help")
+      assert_output_looks_like_help out
+    end
+
+  private
+
+    def assert_output_looks_like_help(out)
+      assert_match /gli - create scaffolding for a GLI-powered application/,out
+      assert_match /SYNOPSIS/,out
+      assert_match /GLOBAL OPTIONS/,out
+      assert_match /COMMANDS/,out
+    end
+
+  end
+
+  class Scaffolding < GLICLITest
+    def test_help_on_scaffold_command
+      out = run_gli("help scaffold")
+      assert_output_looks_like_help(out)
+    end
+    def test_help_on_scaffold_command_as_init
+      out = run_gli("help init")
+      assert_output_looks_like_help(out)
+    end
+
+  private
+
+    def assert_output_looks_like_help(out)
+      assert_match /init - Create a new GLI-based project/,out
+      assert_match /SYNOPSIS/,out
+      assert_match /COMMAND OPTIONS/,out
+    end
+  end
+
+private
+
+  def run_gli(args="", return_err_and_status: false, expect_failure: false)
+    command_line_invocation = "bin/gli #{args}"
+    stdout_string, stderr_string, status = Open3.capture3(command_line_invocation)
+    if expect_failure
+      refute_equal 0,status.exitstatus,"Expected failure for '#{command_line_invocation}' but it succeeded"
+    else
+      assert_equal 0,status.exitstatus,"Expected success for '#{command_line_invocation}' but it failed"
+    end
+    if return_err_and_status
+      [ stdout_string, stderr_string, status ]
+    else
+      stdout_string
+    end
+  end
+end