gli 2.19.1 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 635c14c43560039c5a46a367a501201b6d255dfb850d1280a8300e0c5b7f9ab8
-  data.tar.gz: 0d82f1d19eb5f41a91cdee92f3acf1732b84f93ff9e6353a4e18ad438a5f259a
+  metadata.gz: 0017e490227889383633bf3d4fc2f85783aa50cd86587fd35b704f4fa036d1c3
+  data.tar.gz: 96667382f9092e22abc794e6967d969cecea12339675e46d8a2990df0067810c
 SHA512:
-  metadata.gz: ae6e5aa99a45658686fdbd6cb0e7835c66f0761f8cb0a7e7822265e963d08830441ba6024b747bd0a077152110b55b7c7726bdb55178b1b188bfe2e9804b3968
-  data.tar.gz: '0396dc0ac0290db90f9715bf4b3f3352394003403b81fe0b0c1c6b57af5f981983ac7e691bf17d1e68e9dee80358b9e87991407137a4824464270c4574d468b8'
+  metadata.gz: 7b76b5845f5beb5907d7c11355c5e02ba22521f124c0486f5d1d08ae75969338bc23434ac680da72306cd761cdaac986fb01c966e8eb14a664eb84db95164e82
+  data.tar.gz: 55f76b94f22cf271a93bc0e0916c1a500175fbaa5a45a01c74372042baba384da6660f5860946bf803c7db14c23712f51249ee03c6a1a2d9d52c3da05638eaeb

data/.circleci/config.yml

@@ -0,0 +1,28 @@
+version: 2.1
+orbs:
+  # See https://circleci.com/developer/orbs/orb/circleci/ruby
+  ruby: circleci/ruby@1.4.0
+jobs:                # keyword
+  test:              # my name for the job
+    parameters:      # keyword
+      ruby-version:  # my parameter name
+        type: string # type is a keyword
+    docker:          # keyword
+      - image: cimg/base:stable
+    steps:                                       # keyword
+      - checkout                                 # magic name
+      - ruby/install:                            # ruby/ is from the orb name, install is a command in that orb
+          version: << parameters.ruby-version >> # magic nonsense for param subst (version param to the command)
+      - run:
+          command: "bin/setup"
+      - run:
+          command: "bin/ci none"
+workflows:              # keyword
+  all-rubies:           # my name for the workflow
+    jobs:               # keyword
+      - test:           # my name for the job
+          matrix:       # keyword
+            parameters: # keyword
+              # All rubies being maintained per this page:
+              # https://www.ruby-lang.org/en/downloads/branches/
+              ruby-version: [ "2.5", "2.6", "2.7", "3.0" ]

data/.gitignore

@@ -5,11 +5,9 @@ pkg
 coverage
 .bundle
 tmp
-cruddo.rdoc
-gli.wiki
 Gemfile.lock
 *.gem
 results.html
-.rbx
 .DS_Store
 Session.vim
+scaffold_test

data/CONTRIBUTING.md

@@ -1,7 +1,7 @@
 Contributions are welcome as long as they are part of my vision for GLI (or can be treated as optional to the user).  I am obsessive about backwards-compatibility, so you may need to default things to disable your features.  Sorry, not ready to bump a major version any time soon.
 
 1. Fork my Repository
-2. Create a branch off of gli-2 (**master is no longer the canonical branch**)
+2. Create a branch off of main
 3. Make your changes:
    * Please include tests and watch out for reek and roodi; i.e. keep your code clean
    * If you make changes to the gli executable or the scaffolding, please update the cucumber features
@@ -19,5 +19,3 @@ Contributions are welcome as long as they are part of my vision for GLI (or can
    * Use <code># :nodoc:</code> for methods that a _user_ of GLI should not call (but still please do document all methods)
 4. Make sure your branch will merge with my gli-2 branch (or just rebase your branch from my gli-2 branch)
 5. Create a pull request explaining your change
-
-

data/Gemfile

@@ -2,11 +2,5 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem "rcov", ">= 0.9.8", :platforms => :mri_18
 gem "simplecov", "~> 0.6.4", :platforms => :mri_19
 gem "psych", :platforms => :mri_19
-
-major,minor = RUBY_VERSION.split(/\./)
-if major.to_i >=2 && minor.to_i >= 2
-  gem "test-unit"
-end

data/README.rdoc

@@ -2,9 +2,9 @@
 
 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]
+* {Overview}[http://davetron5000.github.io/gli]
 * {Source on Github}[http://github.com/davetron5000/gli]
-* RDoc[http://davetron5000.github.com/gli/rdoc/index.html]
+* RDoc[http://davetron5000.github.io/gli/rdoc/index.html]
 
 {<img src="https://secure.travis-ci.org/davetron5000/gli.svg?branch=gli-2" alt="Build Status" />}[https://travis-ci.org/davetron5000/gli]
 
@@ -46,7 +46,6 @@ 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.
 * an empty test in <tt>./todo/test/default_test.rb</tt> that can bootstrap your tests
-* an empty feature in <tt>./todo/features/todo.feature</tt> that can bootstrap testing your CLI via Aruba.
 * a gemspec shell
 * a README shell
 * Rakefile that can generate RDoc, package your Gem and run tests
@@ -89,28 +88,19 @@ Now, you are ready to go:
 
 All you need to do is fill in the documentation and your code; the help system, command-line parsing and many other awesome features are all handled for you.
 
-Get a more detailed walkthrough on the {main site}[http://davetron5000.github.com/gli]
+Get a more detailed walkthrough on the {main site}[http://davetron5000.github.io/gli]
 
 == Supported Platforms
 
-Tests should be passing supported MRI Rubies (see +.travis.yml+ for specifics).
-
-Due to the vagaries of Travis, I can't keep the test suite running on unsupported Rubies, but we currently support:
-
-* 2.1
-* 2.2
-* 2.3
-* 2.4
-* JRuby
-
-GLI likely works on older rubies, but the cost of keeping tests passing on those versions (which are now totally unsupported by Ruby core) is too high.
+See `.circleci/config.yml` for the supported rubies, but general we're running tests on the all MRI rubies receiving support, which tends to be the most recent four versions.
 
+GLI should work on older Rubies and JRuby, but it's too much work to keep tests passing for those.
 
 == Documentation
 
 Extensive documentation is {available at the wiki}[https://github.com/davetron5000/gli/wiki].
 
-API Documentation is available {here}[http://davetron5000.github.com/gli/rdoc/index.html].  Recommend starting with GLI::DSL or GLI::App.
+API Documentation is available {here}[http://davetron5000.github.io/gli/rdoc/index.html].  Recommend starting with GLI::DSL or GLI::App.
 
 == Credits
 
@@ -120,7 +110,7 @@ License:: Distributes under the Apache License, see LICENSE.txt in the source di
 
 == Links
 
-* [http://davetron5000.github.com/gli] - RubyDoc
+* [http://davetron5000.github.io/gli] - RubyDoc
 * [http://www.github.com/davetron5000/gli] - Source on GitHub
 * [http://www.github.com/davetron5000/gli/wiki] - Documentation Wiki
 * [http://www.github.com/davetron5000/gli/wiki/Changelog] - Changelog

data/Rakefile

@@ -3,8 +3,6 @@ require 'bundler'
 require 'rake/clean'
 require 'rake/testtask'
 require 'rdoc/task'
-require 'cucumber'
-require 'cucumber/rake/task'
 
 include Rake::DSL
 
@@ -75,52 +73,38 @@ end
 
 Bundler::GemHelper.install_tasks
 
-desc 'run unit tests'
-Rake::TestTask.new do |t|
+desc "run unit tests"
+Rake::TestTask.new("test:unit") do |t|
   t.libs << "test"
-  t.test_files = FileList['test/init_simplecov.rb','test/tc_*.rb']
-end
-
-CUKE_RESULTS = 'results.html'
-CLEAN << CUKE_RESULTS
-Cucumber::Rake::Task.new(:features) do |t|
-  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
-  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
-  t.cucumber_opts =  opts
-  t.fork = false
-end
-Cucumber::Rake::Task.new('features:wip') do |t|
-  tag_opts = ' --tags ~@pending'
-  tag_opts = ' --tags @wip'
-  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
-  t.fork = false
+  t.libs << "lib"
+  ENV["RUBYOPT"].split(/\s/).each do |opt|
+    t.ruby_opts << opt
+  end
+  t.test_files = FileList["test/unit/**/*_test.rb"]
 end
 
-begin
-  require 'rcov/rcovtask'
-  task :clobber_coverage do
-    rm_rf "coverage"
+desc "run integration tests"
+Rake::TestTask.new("test:integration") do |t|
+  t.libs << "test"
+  ENV["RUBYOPT"].split(/\s/).each do |opt|
+    t.ruby_opts << opt
   end
-
-  desc 'Measures test coverage'
-  task :coverage => :rcov do
-    puts "coverage/index.html contains what you need"
+  explicitly_named_files = ARGV[1..-1]
+  if Array(explicitly_named_files).size == 0
+    t.test_files = FileList["test/integration/**/*_test.rb"]
+  else
+    t.test_files = explicitly_named_files
   end
+end
 
-  Rcov::RcovTask.new do |t|
-    t.libs << 'lib'
-    t.test_files = FileList['test/tc_*.rb']
-  end
+
+begin
+  require 'simplecov'
 rescue LoadError
-  begin
-    require 'simplecov'
-  rescue LoadError
-    $stderr.puts "neither rcov nor simplecov are installed; you won't be able to check code coverage"
-  end
 end
 
 desc 'Publish rdoc on github pages and push to github'
 task :publish_rdoc => [:rdoc,:publish]
 
-task :default => [:test,:features]
+task :default => ["test:unit", "test:integraton"]
 

data/bin/ci

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+set -e
+if [ -z $1 ]; then
+  echo "[bin/ci] Running with default warnings"
+  export RUBYOPT=
+else
+  if [ $1 == 'warnings' ]; then
+    echo "[bin/ci] Running with all warnings on"
+    export RUBYOPT=-w
+  else
+    if [ $1 == 'none' ]; then
+      echo "[bin/ci] Running with all warnings off"
+      export RUBYOPT='-W0'
+    else
+      echo "[bin/ci] '$1' is not a supported option"
+      echo "[bin/ci] usage: $0          # run with default warnings"
+      echo "[bin/ci] usage: $0 warnings # run with all warnings"
+      echo "[bin/ci] usage: $0 none     # run with warnings disabled"
+      exit 1
+    fi
+  fi
+fi
+
+echo "[bin/ci] Running unit tests"
+bin/rake test:unit
+
+echo "[bin/ci] Running integration tests"
+bin/rake test:integration

data/bin/gli

@@ -1,68 +1,29 @@
 #!/usr/bin/env ruby
-
-require 'gli'
-require 'gli/commands/scaffold'
-
-class App
-  extend GLI::App
-
-  program_desc 'create scaffolding for a GLI-powered application'
-
-  version GLI::VERSION
-
-  # Can't use these without changing the current behavior of gli
-  # arguments :strict
-  # subcommand_option_handling :normal
-
-  switch :v, :desc => 'Be verbose'
-
-  switch :n, :desc => 'Dry run; don''t change the disk'
-
-  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'
-EOS
-
-  flag :r,:root, :default_value => '.'
-
-  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
-EOS
-  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 :notest, :desc => 'Do not create a test or features dir', :negatable => false
-
-    c.switch :force, :desc => 'Overwrite/ignore existing files and directories'
-
-    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'
-      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
-
-  post do |global,command,options,args|
-    puts "Executed #{command.name}" if global[:v]
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'gli' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
   end
 end
 
-exit App.run(ARGV)
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("gli", "gli")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -e
+
+bundle check || bundle install

data/exe/gli

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+require 'gli'
+require 'gli/commands/scaffold'
+
+class App
+  extend GLI::App
+
+  program_desc 'create scaffolding for a GLI-powered application'
+
+  version GLI::VERSION
+
+  # Can't use these without changing the current behavior of gli
+  # arguments :strict
+  # subcommand_option_handling :normal
+
+  switch :v, :desc => 'Be verbose'
+
+  switch :n, :desc => 'Dry run; don''t change the disk'
+
+  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'
+EOS
+
+  flag :r,:root, :default_value => '.'
+
+  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
+EOS
+  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 :notest, :desc => 'Do not create a test or features dir', :negatable => false
+
+    c.switch :force, :desc => 'Overwrite/ignore existing files and directories'
+
+    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'
+      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
+
+  post do |global,command,options,args|
+    puts "Executed #{command.name}" if global[:v]
+  end
+end
+
+exit App.run(ARGV)

data/gli.gemspec

@@ -1,32 +1,30 @@
 # Make sure we get the gli that's local
-require File.join([File.dirname(__FILE__),'lib','gli','version.rb'])
+require File.join([File.dirname(__FILE__),"lib","gli","version.rb"])
 
 spec = Gem::Specification.new do |s|
-  s.name = 'gli'
+  s.name = "gli"
   s.version = GLI::VERSION
-  s.licenses = ['Apache-2.0']
-  s.author = 'David Copeland'
-  s.email = 'davidcopeland@naildrivin5.com'
-  s.homepage = 'http://davetron5000.github.com/gli'
+  s.licenses = ["Apache-2.0"]
+  s.author = "David Copeland"
+  s.email = "davidcopeland@naildrivin5.com"
+  s.homepage = "http://davetron5000.github.io/gli"
   s.platform = Gem::Platform::RUBY
-  s.summary = 'Build command-suite CLI apps that are awesome.'
-  s.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'
+  s.summary = "Build command-suite CLI apps that are awesome."
+  s.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"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   =  'gli'
   s.require_paths = ["lib"]
 
-  s.extra_rdoc_files = ['README.rdoc', 'gli.rdoc']
-  s.rdoc_options << '--title' << 'Git Like Interface' << '--main' << 'README.rdoc'
-  s.bindir = 'bin'
-  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')
-  s.add_development_dependency('clean_test', '~> 1.0')
-  s.add_development_dependency('cucumber', '~> 3.1.2')
-  s.add_development_dependency('gherkin', '~> 5.1.0')
-  s.add_development_dependency('aruba', '~> 0.7.4')
-  s.add_development_dependency('sdoc', '~> 0.4')
-  s.add_development_dependency('faker','~> 1.9.1')
+  s.extra_rdoc_files = ["README.rdoc", "gli.rdoc"]
+  s.rdoc_options << "--title" << "Git Like Interface" << "--main" << "README.rdoc"
+
+  s.bindir      = "exe"
+  s.executables = "gli"
+
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rdoc")
+  s.add_development_dependency("rainbow", "~> 1.1", "~> 1.1.1")
+  s.add_development_dependency("sdoc")
+  s.add_development_dependency("minitest")
 end

data/gli.rdoc

@@ -1,6 +1,6 @@
 == gli - create scaffolding for a GLI-powered application
 
-v2.17.1
+v2.19.2
 
 === Global Options
 === -r|--root arg
@@ -43,7 +43,7 @@ List commands one per line, to assist with shell completion
 
 
 
-==== Command: <tt>init|scaffold  project_name [command_name][, [command_name]]*</tt>
+==== Command: <tt>init|scaffold  project_name [command_name]...</tt>
 Create a new GLI-based project
 
 This will create a scaffold command line project that uses GLI

data/lib/gli/app_support.rb

@@ -15,6 +15,7 @@ module GLI
       switches.clear
       flags.clear
       @commands = nil
+      @command_missing_block = nil
       @commands_declaration_order = []
       @flags_declaration_order = []
       @switches_declaration_order = []
@@ -72,7 +73,8 @@ module GLI
                                                 :default_command => @default_command,
                                                 :autocomplete => autocomplete,
                                                 :subcommand_option_handling_strategy => subcommand_option_handling_strategy,
-                                                :argument_handling_strategy => argument_handling_strategy)
+                                                :argument_handling_strategy => argument_handling_strategy,
+                                                :command_missing_block => @command_missing_block)
 
         parsing_result = gli_option_parser.parse_options(args)
         parsing_result.convert_to_openstruct! if @use_openstruct

data/lib/gli/command_support.rb

@@ -166,12 +166,8 @@ module GLI
 
     def generate_error_action(arguments)
       lambda { |global_options,options,arguments|
-        if am_subcommand?
-          if arguments.size > 0
-            raise UnknownCommand,"Unknown command '#{arguments[0]}'"
-          else
-            raise BadCommandLine,"Command '#{name}' requires a subcommand"
-          end
+        if am_subcommand? && arguments.size > 0
+          raise UnknownCommand,"Unknown command '#{arguments[0]}'"
         elsif have_subcommands?
           raise BadCommandLine,"Command '#{name}' requires a subcommand #{self.commands.keys.join(',')}"
         else

data/lib/gli/commands/help_modules/command_help_format.rb

@@ -53,7 +53,7 @@ COMMANDS
 
 
 <%= command_examples %>
-<% end %>),nil,'<>')
+<% end %>))
 
 
         def flags_and_switches(command,app)

data/lib/gli/commands/help_modules/global_help_format.rb

@@ -51,7 +51,7 @@ GLOBAL OPTIONS
 
 <% end %>
 COMMANDS
-<%= commands %>),nil,'<>')
+<%= commands %>))
 
         def global_flags_and_switches
           @app.flags_declaration_order + @app.switches_declaration_order