gli 2.18.2 → 2.20.1

data/test/unit/subcommands_test.rb

@@ -0,0 +1,245 @@
+require_relative "test_helper"
+require_relative "support/fake_std_out"
+
+class SubcommandsTest < MiniTest::Test
+  include TestHelper
+
+  def setup
+    @fake_stdout = FakeStdOut.new
+    @fake_stderr = FakeStdOut.new
+
+    @original_stdout = $stdout
+    $stdout = @fake_stdout
+    @original_stderr = $stderr
+    $stderr = @fake_stderr
+
+    @app = CLIApp.new
+    @app.reset
+    @app.subcommand_option_handling :legacy
+    @app.error_device=@fake_stderr
+    ENV.delete('GLI_DEBUG')
+  end
+
+  def teardown
+    $stdout = @original_stdout
+    $stderr = @original_stderr
+  end
+
+  def test_we_run_add_command_using_add
+    we_have_a_command_with_two_subcommands
+    run_app('remote',"add",'-f','foo','bar')
+    assert_command_ran_with(:add, :command_options => {:f => true}, :args => %w(foo bar))
+  end
+  def test_we_run_add_command_using_new
+    we_have_a_command_with_two_subcommands
+    run_app('remote',"new",'-f','foo','bar')
+    assert_command_ran_with(:add, :command_options => {:f => true}, :args => %w(foo bar))
+  end
+
+  def test_subcommands_not_used_on_command_line_uses_base_action
+    we_have_a_command_with_two_subcommands
+    run_app('remote','foo','bar')
+    assert_command_ran_with(:base, :command_options => {:f => false}, :args => %w(foo bar))
+  end
+
+  def test_switches_and_flags_on_subcommand_available
+    we_have_a_command_with_two_subcommands(:switches => [:addswitch], :flags => [:addflag])
+    run_app('remote','add','--addswitch','--addflag','foo','bar')
+    assert_command_ran_with(:add,:command_options => { :addswitch => true, :addflag => 'foo', :f => false },
+                            :args => ['bar'])
+  end
+
+  def test_help_flag_works_in_normal_mode
+    @app.subcommand_option_handling :normal
+    we_have_a_command_with_two_subcommands
+    @app.run(["remote", "add", "--help"]) rescue nil
+    refute_match /^error/, @fake_stderr.to_s, "should not output an error message"
+  end
+
+  def test_help_flag_works_in_legacy_mode
+    @app.subcommand_option_handling :legacy
+    we_have_a_command_with_two_subcommands
+    @app.run(["remote", "add", "--help"]) rescue nil
+    refute_match /^error/, @fake_stderr.to_s, "should not output an error message"
+  end
+
+  def test_we_can_reopen_commands_to_add_new_subcommands
+    @app.command :remote do |p|
+      p.command :add do |c|
+        c.action do |global_options,command_options,args|
+          @ran_command = :add
+        end
+      end
+    end
+    @app.command :remote do |p|
+      p.command :new do |c|
+        c.action do |global_options,command_options,args|
+          @ran_command = :new
+        end
+      end
+    end
+    run_app('remote','new')
+    assert_equal(@ran_command, :new)
+    run_app('remote', 'add')
+    assert_equal(@ran_command, :add)
+  end
+
+  def test_reopening_commands_doesnt_readd_to_output
+    @app.command :remote do |p|
+      p.command(:add) { }
+    end
+    @app.command :remote do |p|
+      p.command(:new) { }
+    end
+    command_names = @app.instance_variable_get("@commands_declaration_order").collect { |c| c.name }
+    assert_equal 1, command_names.grep(:remote).size
+  end
+
+
+  def test_we_can_reopen_commands_without_causing_conflicts
+    @app.command :remote do |p|
+      p.command :add do |c|
+        c.action do |global_options,command_options,args|
+          @ran_command = :remote_add
+        end
+      end
+    end
+    @app.command :local do |p|
+      p.command :add do |c|
+        c.action do |global_options,command_options,args|
+          @ran_command = :local_add
+        end
+      end
+    end
+    run_app('remote','add')
+    assert_equal(@ran_command, :remote_add)
+    run_app('local', 'add')
+    assert_equal(@ran_command, :local_add)
+  end
+
+
+  def test_we_can_nest_subcommands_very_deep
+    @run_results = { :add => nil, :rename => nil, :base => nil }
+    @app.command :remote do |c|
+
+      c.switch :f
+      c.command :add do |add|
+        add.command :some do |some|
+          some.command :cmd do |cmd|
+            cmd.switch :s
+            cmd.action do |global_options,command_options,args|
+              @run_results[:cmd] = [global_options,command_options,args]
+            end
+          end
+        end
+      end
+    end
+    ENV['GLI_DEBUG'] = 'true'
+    run_app('remote','add','some','cmd','-s','blah')
+    assert_command_ran_with(:cmd, :command_options => {:s => true, :f => false},:args => ['blah'])
+  end
+
+  def test_when_any_command_has_no_action_but_there_are_args_indicate_unknown_command
+    a_very_deeply_nested_command_structure
+    assert_raises GLI::UnknownCommand do
+      When run_app('remote','add','some','foo')
+    end
+    assert_match /Unknown command 'foo'/,@fake_stderr.to_s
+  end
+
+  def test_when_any_command_has_no_action_but_there_are_no_args_indicate_subcommand_needed
+    a_very_deeply_nested_command_structure
+    assert_raises GLI::BadCommandLine do
+      When run_app('remote','add','some')
+    end
+    assert_match /Command 'some' requires a subcommand/,@fake_stderr.to_s
+  end
+
+private
+
+  def run_app(*args)
+    @exit_code = @app.run(args)
+  end
+
+  def a_very_deeply_nested_command_structure
+    @run_results = { :add => nil, :rename => nil, :base => nil }
+    @app.command :remote do |c|
+
+      c.switch :f
+      c.command :add do |add|
+        add.command :some do |some|
+          some.command :cmd do |cmd|
+            cmd.switch :s
+            cmd.action do |global_options,command_options,args|
+              @run_results[:cmd] = [global_options,command_options,args]
+            end
+          end
+        end
+      end
+    end
+    ENV['GLI_DEBUG'] = 'true'
+  end
+
+  # expected_command - name of command exepcted to have been run
+  # options:
+  #   - global_options => hash of expected options
+  #   - command_options => hash of expected command options
+  #   - args => array of expected args
+  def assert_command_ran_with(expected_command,options)
+    global_options = options[:global_options] || { :help => false }
+    @run_results.each do |command,results|
+      if command == expected_command
+        assert_equal(indifferent_hash(global_options),results[0])
+        assert_equal(indifferent_hash(options[:command_options]),results[1])
+        assert_equal(options[:args],results[2])
+      else
+        assert_nil results
+      end
+    end
+  end
+
+  def indifferent_hash(possibly_nil_hash)
+    return {} if possibly_nil_hash.nil?
+    possibly_nil_hash.keys.each do |key|
+      if key.kind_of? Symbol
+        possibly_nil_hash[key.to_s] = possibly_nil_hash[key] unless possibly_nil_hash.has_key?(key.to_s)
+      elsif key.kind_of? String
+        possibly_nil_hash[key.to_sym] = possibly_nil_hash[key] unless possibly_nil_hash.has_key?(key.to_sym)
+      end
+    end
+    possibly_nil_hash
+  end
+
+  # options - 
+  #     :flags => flags to add to :add
+  #     :switiches => switiches to add to :add
+  def we_have_a_command_with_two_subcommands(options = {})
+    @run_results = { :add => nil, :rename => nil, :base => nil }
+    @app.command :remote do |c|
+
+      c.switch :f
+
+      c.desc "add a remote"
+      c.command [:add,:new] do |add|
+
+        Array(options[:flags]).each { |_| add.flag _ }
+        Array(options[:switches]).each { |_| add.switch _ }
+        add.action do |global_options,command_options,args|
+          @run_results[:add] = [global_options,command_options,args]
+        end
+      end
+
+      c.desc "rename a remote"
+      c.command :rename do |rename|
+        rename.action do |global_options,command_options,args|
+          @run_results[:rename] = [global_options,command_options,args]
+        end
+      end
+
+      c.action do |global_options,command_options,args|
+        @run_results[:base] = [global_options,command_options,args]
+      end
+    end
+    ENV['GLI_DEBUG'] = 'true'
+  end
+end

data/test/unit/switch_test.rb

@@ -0,0 +1,49 @@
+require_relative "test_helper"
+
+class SwitchTest < MiniTest::Test
+  include TestHelper
+
+  def test_basics_simple
+    switch_with_names(:filename)
+    attributes_should_be_set
+    assert_equal(:filename,@cli_option.name)
+    assert_nil @cli_option.aliases
+  end
+
+  def test_basics_kinda_complex
+    switch_with_names([:f])
+    attributes_should_be_set
+    assert_equal(:f,@cli_option.name)
+    assert_nil @cli_option.aliases
+  end
+
+  def test_basics_complex
+    switch_with_names([:f,:file,:filename])
+    attributes_should_be_set
+    assert_equal(:f,@cli_option.name)
+    assert_equal([:file,:filename],@cli_option.aliases)
+    assert_equal ["-f","--[no-]file","--[no-]filename"],@switch.arguments_for_option_parser
+  end
+
+  def test_includes_negatable
+    assert_equal '-a',GLI::Switch.name_as_string('a')
+    assert_equal '--[no-]foo',GLI::Switch.name_as_string('foo')
+  end
+
+private 
+
+  def switch_with_names(names)
+    @options = {
+      :desc => 'Filename',
+      :long_desc => 'The Filename',
+    }
+    @switch = GLI::Switch.new(names,@options)
+    @cli_option = @switch
+  end
+
+  def attributes_should_be_set
+    assert_equal(@options[:desc],@switch.description)
+    assert_equal(@options[:long_desc],@switch.long_description)
+  end
+
+end

data/test/{tc_terminal.rb → unit/terminal_test.rb}

@@ -1,9 +1,10 @@
-require 'test_helper'
+require_relative "test_helper"
 
-class TC_testTerminal < Clean::Test::TestCase
+class TerminalTest < MiniTest::Test
   include TestHelper
 
-  def test_command_exists
+  # TODO: Make this test not mess with the internals of the class
+  def xtest_command_exists
     assert GLI::Terminal.instance.command_exists?('ls')
     assert !GLI::Terminal.instance.command_exists?('asdfasfasdf')
   end

data/test/unit/test_helper.rb

@@ -0,0 +1,13 @@
+require "minitest/autorun"
+require "gli"
+
+module TestHelper
+  class CLIApp
+    include GLI::App
+
+    def reset
+      super
+      @subcommand_option_handling_strategy = :normal
+    end
+  end
+end

data/test/unit/verbatim_wrapper_test.rb

@@ -0,0 +1,24 @@
+require_relative "test_helper"
+
+class TerminalTest < MiniTest::Test
+  include TestHelper
+
+  def test_handles_nil
+    @wrapper = GLI::Commands::HelpModules::VerbatimWrapper.new(rand(100),rand(100))
+    @result = @wrapper.wrap(nil)
+    assert_equal '',@result
+  end
+
+  def test_does_not_touch_input
+    @wrapper = GLI::Commands::HelpModules::VerbatimWrapper.new(rand(100),rand(100))
+    @input = <<EOS
+      |This is|an ASCII|table|
+      +-------+--------+-----+
+      | foo   |  bar   | baz |
+      +-------+--------+-----+
+EOS
+    @result = @wrapper.wrap(@input)
+    assert_equal @input,@result
+  end
+
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.18.2
+  version: 2.20.1
 platform: ruby
 authors:
 - David Copeland
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2019-08-10 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -58,90 +58,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
-- !ruby/object:Gem::Dependency
-  name: clean_test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.2
-- !ruby/object:Gem::Dependency
-  name: gherkin
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.1.0
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.4
 - !ruby/object:Gem::Dependency
   name: sdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: '0'
 description: Build command-suite CLI apps that are awesome.  Bootstrap your app, add
   commands, options and documentation while maintaining a well-tested idiomatic command-line
   app
@@ -153,28 +97,19 @@ extra_rdoc_files:
 - README.rdoc
 - gli.rdoc
 files:
+- ".circleci/config.yml"
 - ".gitignore"
-- ".ruby-gemset"
-- ".ruby-version"
 - ".tool-versions"
-- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
-- ObjectModel.graffle
 - README.rdoc
 - Rakefile
+- bin/ci
 - bin/gli
-- bin/report_on_rake_results
-- bin/test_all_rubies.sh
-- features/gli_executable.feature
-- features/gli_init.feature
-- features/step_definitions/gli_executable_steps.rb
-- features/step_definitions/gli_init_steps.rb
-- features/step_definitions/todo_steps.rb
-- features/support/env.rb
-- features/todo.feature
-- features/todo_legacy.feature
+- bin/rake
+- bin/setup
+- exe/gli
 - gli.cheat
 - gli.gemspec
 - gli.rdoc
@@ -218,6 +153,8 @@ files:
 - lib/gli/switch.rb
 - lib/gli/terminal.rb
 - lib/gli/version.rb
+- object-model.dot
+- object-model.png
 - test/apps/README.md
 - test/apps/todo/Gemfile
 - test/apps/todo/README.rdoc
@@ -243,29 +180,32 @@ files:
 - test/apps/todo_legacy/todo.gemspec
 - test/apps/todo_legacy/todo.rdoc
 - test/apps/todo_plugins/commands/third.rb
-- test/config.yaml
-- test/fake_std_out.rb
-- test/init_simplecov.rb
-- test/option_test_helper.rb
-- test/tc_command.rb
-- test/tc_command_finder.rb
-- test/tc_compound_command.rb
-- test/tc_doc.rb
-- test/tc_flag.rb
-- test/tc_gli.rb
-- test/tc_help.rb
-- test/tc_options.rb
-- test/tc_subcommand_parsing.rb
-- test/tc_subcommands.rb
-- test/tc_switch.rb
-- test/tc_terminal.rb
-- test/tc_verbatim_wrapper.rb
-- test/test_helper.rb
-homepage: http://davetron5000.github.com/gli
+- test/integration/gli_cli_test.rb
+- test/integration/gli_powered_app_test.rb
+- test/integration/scaffold_test.rb
+- test/integration/test_helper.rb
+- test/unit/command_finder_test.rb
+- test/unit/command_test.rb
+- test/unit/compound_command_test.rb
+- test/unit/doc_test.rb
+- test/unit/flag_test.rb
+- test/unit/gli_test.rb
+- test/unit/help_test.rb
+- test/unit/init_simplecov.rb
+- test/unit/options_test.rb
+- test/unit/subcommand_parsing_test.rb
+- test/unit/subcommands_test.rb
+- test/unit/support/fake_std_out.rb
+- test/unit/support/gli_test_config.yml
+- test/unit/switch_test.rb
+- test/unit/terminal_test.rb
+- test/unit/test_helper.rb
+- test/unit/verbatim_wrapper_test.rb
+homepage: http://davetron5000.github.io/gli
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - Git Like Interface
@@ -284,19 +224,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Build command-suite CLI apps that are awesome.
 test_files:
-- features/gli_executable.feature
-- features/gli_init.feature
-- features/step_definitions/gli_executable_steps.rb
-- features/step_definitions/gli_init_steps.rb
-- features/step_definitions/todo_steps.rb
-- features/support/env.rb
-- features/todo.feature
-- features/todo_legacy.feature
 - test/apps/README.md
 - test/apps/todo/Gemfile
 - test/apps/todo/README.rdoc
@@ -322,21 +254,24 @@ test_files:
 - test/apps/todo_legacy/todo.gemspec
 - test/apps/todo_legacy/todo.rdoc
 - test/apps/todo_plugins/commands/third.rb
-- test/config.yaml
-- test/fake_std_out.rb
-- test/init_simplecov.rb
-- test/option_test_helper.rb
-- test/tc_command.rb
-- test/tc_command_finder.rb
-- test/tc_compound_command.rb
-- test/tc_doc.rb
-- test/tc_flag.rb
-- test/tc_gli.rb
-- test/tc_help.rb
-- test/tc_options.rb
-- test/tc_subcommand_parsing.rb
-- test/tc_subcommands.rb
-- test/tc_switch.rb
-- test/tc_terminal.rb
-- test/tc_verbatim_wrapper.rb
-- test/test_helper.rb
+- test/integration/gli_cli_test.rb
+- test/integration/gli_powered_app_test.rb
+- test/integration/scaffold_test.rb
+- test/integration/test_helper.rb
+- test/unit/command_finder_test.rb
+- test/unit/command_test.rb
+- test/unit/compound_command_test.rb
+- test/unit/doc_test.rb
+- test/unit/flag_test.rb
+- test/unit/gli_test.rb
+- test/unit/help_test.rb
+- test/unit/init_simplecov.rb
+- test/unit/options_test.rb
+- test/unit/subcommand_parsing_test.rb
+- test/unit/subcommands_test.rb
+- test/unit/support/fake_std_out.rb
+- test/unit/support/gli_test_config.yml
+- test/unit/switch_test.rb
+- test/unit/terminal_test.rb
+- test/unit/test_helper.rb
+- test/unit/verbatim_wrapper_test.rb