gli 2.11.0 → 2.20.0

data/test/apps/todo/Gemfile

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

data/test/apps/todo/bin/todo

@@ -1,17 +1,17 @@
 #!/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
@@ -20,6 +20,7 @@ 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"
@@ -41,7 +42,12 @@ 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|
@@ -64,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.
 
@@ -8,59 +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.flag :required_flag2, :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

data/test/integration/gli_powered_app_test.rb

@@ -0,0 +1,52 @@
+require_relative "test_helper"
+require "open3"
+
+class GLIPoweredAppTest < MiniTest::Test
+  include TestHelper
+
+  def teardown
+    FileUtils.rm_f("todo.rdoc")
+  end
+
+  def test_help_works
+    out = run_app("help")
+    assert_top_level_help(out)
+  end
+
+  def test_unknown_command_exits_nonzero
+    out, err, status = run_app("asdfasdfasdf", expect_failure: true, return_err_and_status: true)
+    assert_match /Unknown command 'asdfasdfasdf'/,err
+    assert_equal 64, status.exitstatus
+    assert_top_level_help(out)
+  end
+
+  def test_unknown_switch_exits_nonzero
+    out, err, status = run_app("list --foo", expect_failure: true, return_err_and_status: true)
+    assert_match /Unknown option \-\-foo/,err
+    assert_equal 64, status.exitstatus
+    assert_match /COMMAND OPTIONS/, out
+  end
+
+  def test_missing_args_exits_nonzero
+    out, err, status = run_app("list", expect_failure: true, return_err_and_status: true)
+    assert_match /required_flag is required, required_flag2 is required/,err
+    assert_equal 64, status.exitstatus
+    assert_match /COMMAND OPTIONS/, out
+  end
+
+  def test_doc_generation
+    out, err, status = run_app("_doc", return_err_and_status: true)
+    assert File.exists?("todo.rdoc")
+  end
+
+private
+  def assert_top_level_help(out)
+    assert_match /SYNOPSIS/, out
+    assert_match /GLOBAL OPTIONS/, out
+    assert_match /COMMANDS/, out
+  end
+
+  def run_app(args="", return_err_and_status: false, expect_failure: false)
+    run_command("test/apps/todo/bin/todo",args,return_err_and_status:return_err_and_status,expect_failure:expect_failure)
+  end
+end

data/test/integration/scaffold_test.rb

@@ -0,0 +1,30 @@
+require_relative "test_helper"
+require "open3"
+
+class ScaffoldCommandTest < MiniTest::Test
+  include TestHelper
+
+  def test_scaffolded_app_has_reasonable_setup
+    FileUtils.rm_rf "scaffold_test"
+    run_gli("init scaffold_test")
+    assert Dir.exist? "scaffold_test"
+    FileUtils.chdir "scaffold_test" do
+      run_command("bundle install", "", return_err_and_status: false, expect_failure: false)
+
+      scaffold_lib = "lib:../lib"
+
+      # help works
+      out = run_command("bin/scaffold_test","--help", return_err_and_status: false, expect_failure: false, rubylib: scaffold_lib)
+      assert_match /SYNOPSIS/,out
+      assert_match /GLOBAL OPTIONS/,out
+      assert_match /COMMANDS/,out
+
+      # can run unit tests
+      out = run_command("bundle exec ","rake test", return_err_and_status: false, expect_failure: false, rubylib: scaffold_lib)
+      assert_match /0 failures/,out
+      assert_match /0 errors/,out
+      assert_match /0 skips/,out
+    end
+  end
+
+end

data/test/integration/test_helper.rb

@@ -0,0 +1,52 @@
+require "minitest/autorun"
+require "pathname"
+require "fileutils"
+
+# Copied from https://github.com/splattael/minitest-around
+# so as to avoid an explicit dependency
+Minitest::Test.class_eval do
+  alias_method :run_without_around, :run
+  def run(*args)
+    if defined?(around)
+      result = nil
+      around { result = run_without_around(*args) }
+      result
+    else
+      run_without_around(*args)
+    end
+  end
+end
+
+module TestHelper
+  def around(&block)
+    Bundler.with_original_env do
+      root = Pathname(__FILE__).dirname / ".." / ".."
+      FileUtils.chdir root do
+        block.()
+      end
+    end
+  end
+
+  def run_gli(args="", return_err_and_status: false, expect_failure: false)
+    run_command("bin/gli",args,return_err_and_status:return_err_and_status,expect_failure:expect_failure)
+  end
+
+  def run_command(command,args,return_err_and_status:,expect_failure:,rubylib:nil)
+    command_line_invocation = "#{command} #{args}"
+    env = {}
+    if !rubylib.nil?
+      env["RUBYLIB"] = rubylib
+    end
+    stdout_string, stderr_string, status = Open3.capture3(env,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:\n#{stdout_string}\n\n#{stderr_string}\n\n"
+    end
+    if return_err_and_status
+      [ stdout_string, stderr_string, status ]
+    else
+      stdout_string
+    end
+  end
+end