gli 2.18.1 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5687d6e6cfea1165eba186bdee08325eaa1588d21e7d0ef5b0aa283a6fcb79ab
-  data.tar.gz: 3f157eef5e5e3d8fe7137adb71ec1885e723705574a87229bbf34fd2b46ecfb8
+  metadata.gz: f99bcd6fc563c75307924a23694720c7a5a68d0957afbb7b25fb15e21257011c
+  data.tar.gz: 9e508b67d421593391c447f3778c90df01565f36e5db41cab83fce806bdc6417
 SHA512:
-  metadata.gz: 071cd902d777a38f668edbbe0d71814d56d727b9238b0e40e6601fe35e50f29bf7f9ab382a073a21dc17801d4351ea1379f2d0467148bbbd885e5ef5a5dd3fb1
-  data.tar.gz: 45b16d82f3410716380cda524b631fdf38b44ce702c7a2f92ded226a42932eeff274b8afbf9e735a40bc515add4328ad940f22b82e98c61634f51b8cf73de0fd
+  metadata.gz: bbfbd6572090c9a8b86ae7e165cbb3b12d5500fa3dda114bb1add6375ea32864e38b0857d29ba399deb3f45250d655ec61c6acb78d8c5bc9172c1e0eebfa0d20
+  data.tar.gz: 8ad9e606b644c9374a616cfd0d013ffc90909851d77f0b96fc366debb274e55698388e749756318db2437d23a640f4118459ada89b8d1ca1e035f507576611ff

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.1.2
+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"
+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/.tool-versions

@@ -1 +1 @@
-ruby 2.6.3
+ruby 2.7.1

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

@@ -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,21 +8,44 @@ 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.
 * 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
@@ -73,18 +92,9 @@ Get a more detailed walkthrough on the {main site}[http://davetron5000.github.co
 
 == 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
 

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,48 +73,28 @@ 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']
+  t.libs << "lib"
+  t.test_files = FileList["test/unit/**/*_test.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
-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"
+  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
 
-  desc 'Measures test coverage'
-  task :coverage => :rcov do
-    puts "coverage/index.html contains what you need"
-  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'

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_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)