gli 2.19.2 → 2.20.0

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/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

data/lib/gli/commands/scaffold.rb

@@ -70,10 +70,10 @@ spec = Gem::Specification.new do |s|
   s.rdoc_options << '--title' << '#{project_name}' << '--main' << 'README.rdoc' << '-ri'
   s.bindir = 'bin'
   s.executables << '#{project_name}'
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rdoc')
-  s.add_development_dependency('aruba')
-  s.add_runtime_dependency('gli','#{GLI::VERSION}')
+  s.add_development_dependency('rake','~> 0.9.2')
+  s.add_development_dependency('rdoc', '~> 4.3')
+  s.add_development_dependency('minitest', '~> 5.14')
+  s.add_runtime_dependency('gli','~> #{GLI::VERSION}')
 end
 EOS
       end
@@ -114,12 +114,6 @@ require 'rubygems'
 require 'rubygems/package_task'
 require 'rdoc/task'
 EOS
-        if create_test_dir
-          file.puts <<EOS
-require 'cucumber'
-require 'cucumber/rake/task'
-EOS
-        end
         file.puts <<EOS
 Rake::RDocTask.new do |rd|
   rd.main = "README.rdoc"
@@ -134,44 +128,19 @@ end
 EOS
         if create_test_dir
           file.puts <<EOS
-CUKE_RESULTS = 'results.html'
-CLEAN << CUKE_RESULTS
-desc 'Run features'
-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
-
-desc 'Run features tagged as work-in-progress (@wip)'
-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
-
-task :cucumber => :features
-task 'cucumber:wip' => 'features:wip'
-task :wip => 'features:wip'
-EOS
-        end
-        if create_test_dir
-          file.puts <<EOS
 require 'rake/testtask'
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.test_files = FileList['test/*_test.rb']
 end
 
-task :default => [:test,:features]
+task :default => :test
 EOS
           File.open("#{root_dir}/#{project_name}/test/default_test.rb",'w') do |test_file|
             test_file.puts <<EOS
-require 'test_helper'
+require_relative "test_helper"
 
-class DefaultTest < Test::Unit::TestCase
+class DefaultTest < Minitest::Test
 
   def setup
   end
@@ -188,15 +157,10 @@ EOS
           puts "Created #{root_dir}/#{project_name}/test/default_test.rb"
           File.open("#{root_dir}/#{project_name}/test/test_helper.rb",'w') do |test_file|
             test_file.puts <<EOS
-require 'test/unit'
+require "minitest/autorun"
 
 # Add test libraries you want to use here, e.g. mocha
-
-class Test::Unit::TestCase
-
-  # Add global extensions to the test case class here
-
-end
+# Add helper classes or methods here, too
 EOS
           end
           puts "Created #{root_dir}/#{project_name}/test/test_helper.rb"
@@ -210,54 +174,6 @@ EOS
         bundler_file.puts "gemspec"
       end
       puts "Created #{root_dir}/#{project_name}/Gemfile"
-      if create_test_dir
-        features_dir = File.join(root_dir,project_name,'features')
-        FileUtils.mkdir features_dir
-        FileUtils.mkdir File.join(features_dir,"step_definitions")
-        FileUtils.mkdir File.join(features_dir,"support")
-        File.open(File.join(features_dir,"#{project_name}.feature"),'w') do |file|
-          file.puts <<EOS
-Feature: My bootstrapped app kinda works
-  In order to get going on coding my awesome app
-  I want to have aruba and cucumber setup
-  So I don't have to do it myself
-
-  Scenario: App just runs
-    When I get help for "#{project_name}"
-    Then the exit status should be 0
-EOS
-        end
-        File.open(File.join(features_dir,"step_definitions","#{project_name}_steps.rb"),'w') do |file|
-          file.puts <<EOS
-When /^I get help for "([^"]*)"$/ do |app_name|
-  @app_name = app_name
-  step %(I run `\#{app_name} help`)
-end
-
-# Add more step definitions here
-EOS
-        end
-        File.open(File.join(features_dir,"support","env.rb"),'w') do |file|
-          file.puts <<EOS
-require 'aruba/cucumber'
-
-ENV['PATH'] = "\#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}\#{File::PATH_SEPARATOR}\#{ENV['PATH']}"
-LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
-
-Before do
-  # Using "announce" causes massive warnings on 1.9.2
-  @puts = true
-  @original_rubylib = ENV['RUBYLIB']
-  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
-end
-
-After do
-  ENV['RUBYLIB'] = @original_rubylib
-end
-EOS
-        end
-        puts "Created #{features_dir}"
-      end
     end
 
     def self.mk_binfile(root_dir,create_ext_dir,force,dry_run,project_name,commands)

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/version.rb

@@ -1,5 +1,5 @@
 module GLI
   unless const_defined? :VERSION
-    VERSION = '2.19.2'
+    VERSION = '2.20.0'
   end
 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,7 +1,7 @@
 #!/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'

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