gli 2.6.0.rc1 → 2.6.0

data/features/gli_executable.feature

@@ -27,7 +27,7 @@ Feature: The GLI executable works as intended
         -n             - Dry run; dont change the disk
         -r, --root=arg - Root dir of project (default: .)
         -v             - Be verbose
-        --version      - 
+        --version      - Display the program version
 
     COMMANDS
         help           - Shows a list of commands or help for one command

data/features/gli_init.feature

@@ -66,7 +66,7 @@ Feature: The scaffold GLI generates works
                                                   the default)
         --help                                  - Show this message
         -s, --[no-]switch                       - Describe some switch here
-        --version                               - 
+        --version                               - Display the program version
     
     COMMANDS
         add      - Describe add here
@@ -92,7 +92,7 @@ Feature: The scaffold GLI generates works
                                                   the default)
         --help                                  - Show this message
         -s, --[no-]switch                       - Describe some switch here
-        --version                               - 
+        --version                               - Display the program version
     
     COMMANDS
         add      - Describe add here

data/features/todo.feature

@@ -36,7 +36,7 @@ Feature: The todo app has a nice user interface
         --help             - Show this message
         --[no-]otherswitch - 
         --[no-]switch      - 
-        --version          - 
+        --version          - Display the program version
 
     COMMANDS
         chained       - 
@@ -54,7 +54,13 @@ Feature: The todo app has a nice user interface
     Examples:
       | help      |
       | help      |
-      | --version |
+
+  Scenario: Version display
+    When I successfully run `todo --version`
+    Then the output should contain:
+    """
+    todo version 0.0.1
+    """
 
   Scenario: Help completion mode
     When I successfully run `todo help -c`
@@ -121,7 +127,7 @@ Feature: The todo app has a nice user interface
         --flag=arg         - (default: none)
         --[no-]switch      - 
         --[no-]otherswitch - 
-        --version          - 
+        --version          - Display the program version
         --help             - Show this message
 
     COMMANDS
@@ -171,6 +177,17 @@ Feature: The todo app has a nice user interface
       | list --help     |
 
 
+  Scenario: Getting Help for a top level command of todo with no command options
+    When I successfully run `todo help chained`
+    Then the output should contain:
+    """
+    NAME
+        chained - 
+
+    SYNOPSIS
+        todo [global options] chained
+    """
+
   Scenario: Getting Help with no wrapping
     Given the todo app is coded to avoid wrapping text
     When I successfully run `todo help list`
@@ -280,9 +297,9 @@ Feature: The todo app has a nice user interface
         create - Create a new task or context
 
     SYNOPSIS
-        todo [global options] create [command options] 
-        todo [global options] create [command options]  contexts [context_name]
-        todo [global options] create [command options]  tasks task_name[, task_name]*
+        todo [global options] create 
+        todo [global options] create  contexts [context_name]
+        todo [global options] create  tasks task_name[, task_name]*
 
     COMMANDS
         <default> - Makes a new task

data/features/todo_legacy.feature

@@ -88,9 +88,9 @@ Feature: The todo app is backwards compatible with legacy subcommand parsing
         create - Create a new task or context
 
     SYNOPSIS
-        todo [global options] create [command options] 
-        todo [global options] create [command options]  contexts [context_name]
-        todo [global options] create [command options]  tasks task_name[, task_name]*
+        todo [global options] create 
+        todo [global options] create  contexts [context_name]
+        todo [global options] create  tasks task_name[, task_name]*
 
     COMMANDS
         <default> - Makes a new task

data/gli.gemspec

@@ -25,7 +25,8 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency('rdoc', '~> 3.11')
   s.add_development_dependency('rainbow', '~> 1.1.1')
   s.add_development_dependency('clean_test')
-  s.add_development_dependency('aruba')
+  s.add_development_dependency('cucumber', '1.2.3')
+  s.add_development_dependency('aruba', '0.5.1') # 0.5.3 randomly breaks with "LaunchError: no such file or directory" and only sometimes.
   s.add_development_dependency('sdoc')
   s.add_development_dependency('faker','1.0.0')
 end

data/lib/gli/app.rb

@@ -104,7 +104,7 @@ module GLI
     # the command specified will not be executed.
     # The block will receive the global-options,command,options, and arguments
     # If this block evaluates to true, the program will proceed; otherwise
-    # the program will end immediately
+    # the program will end immediately and exit nonzero
     def pre(&a_proc)
       @pre_block = a_proc
     end
@@ -157,6 +157,7 @@ module GLI
     # +version+:: String containing the version of your application.  
     def version(version)
       @version = version
+      desc 'Display the program version'
       switch :version, :negatable => false
     end
 

data/lib/gli/app_support.rb

@@ -31,6 +31,10 @@ module GLI
       clear_nexts
     end
 
+    def exe_name
+      File.basename($0)
+    end
+
     # Get an array of commands, ordered by when they were declared
     def commands_declaration_order # :nodoc:
       @commands_declaration_order
@@ -71,8 +75,12 @@ module GLI
 
         the_command = parsing_result.command
 
-        call_command(parsing_result) if proceed?(parsing_result)
-        0
+        if proceed?(parsing_result)
+          call_command(parsing_result) 
+          0
+        else
+          exit_now!(nil,65)
+        end
       rescue Exception => ex
         if the_command.nil? && ex.respond_to?(:command_in_context)
           the_command = ex.command_in_context

data/lib/gli/commands/doc.rb

@@ -23,7 +23,7 @@ module GLI
         flag          :format
 
         action do |global_options,options,arguments|
-          self.document(format_class(options[:format]).new(global_options,options,arguments))
+          self.document(format_class(options[:format]).new(global_options,options,arguments,app))
         end
       end
 
@@ -54,6 +54,12 @@ module GLI
 
       # Interface for a listener that is called during various parts of the doc process
       class DocumentListener
+        def initialize(global_options,options,arguments,app)
+          @global_options = global_options
+          @options        = options
+          @arguments      = arguments
+          @app            = app
+        end
         # Called before processing begins
         def beginning
           abstract!

data/lib/gli/commands/help.rb

@@ -60,7 +60,11 @@ module GLI
         switch :c
 
         action do |global_options,options,arguments|
-          show_help(global_options,options,arguments,output,error)
+          if global_options[:version] && !global_options[:help]
+            puts "#{@app.exe_name} version #{@app.version_string}"
+          else
+            show_help(global_options,options,arguments,output,error)
+          end
         end
       end
 
@@ -81,7 +85,7 @@ module GLI
           name = arguments.shift
           command = command_finder.find_command(name)
           unless command.nil?
-            out.puts HelpModules::CommandHelpFormat.new(command,@app,File.basename($0).to_s,@sorter,@text_wrapping_class).format
+            out.puts HelpModules::CommandHelpFormat.new(command,@app,@app.exe_name.to_s,@sorter,@text_wrapping_class).format
           end
         end
       end

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

@@ -47,7 +47,7 @@ module GLI
           if command.nil?
             @last_unknown_command = name
             unless @squelch_stderr
-              error.puts "error: Unknown command '#{name}'.  Use '#{File.basename($PROGRAM_NAME)} help' for a list of commands."
+              error.puts "error: Unknown command '#{name}'.  Use '#{@app.exe_name} help' for a list of commands."
             end
             true
           else

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

@@ -98,8 +98,10 @@ COMMANDS
  
         def basic_usage
           usage = @basic_invocation.dup
-          usage << " [global options] #{path_to_command} "
-          usage << "[command options] " unless global_flags_and_switches.empty?
+          usage << " [global options]" unless global_flags_and_switches.empty?
+          usage << " #{path_to_command}"
+          usage << " [command options]" unless flags_and_switches(@command,@app).empty?
+          usage << " "
           usage
         end
  

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

@@ -35,7 +35,7 @@ module GLI
       private
 
         GLOBAL_HELP = ERB.new(%q(NAME
-    <%= File.basename($0) %> - <%= program_desc %>
+    <%= @app.exe_name %> - <%= program_desc %>
 <%= program_long_desc %>
 SYNOPSIS
     <%= usage_string %>
@@ -58,7 +58,7 @@ COMMANDS
         end
 
         def usage_string
-          "#{File.basename($0)} ".tap do |string|
+          "#{@app.exe_name} ".tap do |string|
             string << "[global options] " unless global_flags_and_switches.empty?
             string << "command "
             string << "[command options] [arguments...]"

data/lib/gli/commands/initconfig.rb

@@ -1,6 +1,7 @@
 require 'gli'
 require 'gli/command'
 require 'yaml'
+require 'fileutils'
 
 module GLI
   # Command that initializes the configuration file for apps that use it.

data/lib/gli/commands/rdoc_document_listener.rb

@@ -4,8 +4,8 @@ module GLI
   module Commands
     class RdocDocumentListener
 
-      def initialize(global_options,options,arguments)
-        @io = File.new(File.basename($0) + ".rdoc",'w')
+      def initialize(global_options,options,arguments,app)
+        @io = File.new("#{app.exe_name}.rdoc",'w')
         @nest = ''
         @arg_name_formatter = GLI::Commands::HelpModules::ArgNameFormatter.new
       end
@@ -20,7 +20,7 @@ module GLI
 
       # Gives you the program description
       def program_desc(desc)
-        @io.puts "== #{File.basename($0)} - #{desc}"
+        @io.puts "== #{@app.exe_name} - #{desc}"
         @io.puts
       end
 

data/lib/gli/terminal.rb

@@ -59,6 +59,10 @@ module GLI
         lambda { (jruby? || (!STDIN.tty? && ENV['TERM'])) && command_exists?('tput') },
         lambda { [run_command('tput cols').to_i, run_command('tput lines').to_i] }
       ],
+      [
+        lambda { (solaris? && STDIN.tty? && command_exists?('stty')) },
+        lambda { run_command('stty').split("\n")[1].scan(/\d+/)[0..1].map { |size_element| size_element.to_i }.reverse }
+      ],
       [ 
         lambda { STDIN.tty? && command_exists?('stty') },
         lambda { run_command('stty size').scan(/\d+/).map { |size_element| size_element.to_i }.reverse }
@@ -90,5 +94,8 @@ module GLI
     # True if we are JRuby; exposed to allow for testing
     def self.jruby?; RUBY_PLATFORM =~ /java/; end
 
+    # True if this is running under Solaris Sparc
+    def self.solaris?; RUBY_PLATFORM =~ /solaris/; end
+
   end
 end

data/lib/gli/version.rb

@@ -1,5 +1,5 @@
 module GLI
   unless const_defined? :VERSION
-    VERSION = '2.6.0.rc1'
+    VERSION = '2.6.0'
   end
 end

data/test/tc_command.rb

@@ -351,6 +351,14 @@ class TC_testCommand < Clean::Test::TestCase
     assert_equal [:blah], command.aliases
   end
 
+  def test_pre_exiting_false_causes_nonzero_exit
+    @app.pre { |*| false }
+
+    assert_equal 65,@app.run(["bs"]) # BSD for "input data incorrect in some way"
+    assert_equal '',@fake_stderr.to_s
+    assert_equal '',@fake_stdout.to_s
+  end
+
   private
 
   def assert_contained(output,regexp)

data/test/tc_doc.rb

@@ -252,6 +252,7 @@ switch: s
   long_desc: switch long_desc 5
   negatable: false
 switch: version
+  desc: Display the program version
   negatable: false
 command: command1
   aliases: com1

data/test/tc_help.rb

@@ -157,6 +157,95 @@ class TC_testHelp < Clean::Test::TestCase
     }
   end
 
+  test_that "invoking help with a known command when no global options are present omits [global options] from the usage string" do
+    Given a_GLI_app(:no_options)
+    And {
+      @command_name = cm = any_command_name
+      @desc         = d  = any_desc
+      @long_desc    = ld = any_desc
+      @switch       = s  = any_option
+      @switch_desc  = sd = any_desc
+      @flag         = f  = any_option
+      @flag_desc    = fd = any_desc
+
+      @app.instance_eval do
+        desc d
+        long_desc ld
+        command cm do |c|
+
+          c.desc sd
+          c.switch s
+
+          c.desc fd
+          c.flag f
+
+          c.action {}
+        end
+      end
+      @command = GLI::Commands::Help.new(@app,@output,@error)
+    }
+    When {
+      @command.execute({},{},[@command_name])
+    }
+    Then {
+      refute_output_contained(/\[global options\]/)
+      assert_output_contained(/\[command options\]/)
+      assert_output_contained('COMMAND OPTIONS')
+    }
+  end
+
+  test_that "invoking help with a known command when no global options nor command options are present omits [global options] and [command options] from the usage string" do
+    Given a_GLI_app(:no_options)
+    And {
+      @command_name = cm = any_command_name
+      @desc         = d  = any_desc
+      @long_desc    = ld = any_desc
+
+      @app.instance_eval do
+        desc d
+        long_desc ld
+        command cm do |c|
+          c.action {}
+        end
+      end
+      @command = GLI::Commands::Help.new(@app,@output,@error)
+    }
+    When {
+      @command.execute({},{},[@command_name])
+    }
+    Then {
+      refute_output_contained(/\[global options\]/)
+      refute_output_contained(/\[command options\]/)
+      refute_output_contained('COMMAND OPTIONS')
+    }
+  end
+
+  test_that "invoking help with a known command that has no command options omits [command options] from the usage string" do
+    Given a_GLI_app
+    And {
+      @command_name = cm = any_command_name
+      @desc         = d  = any_desc
+      @long_desc    = ld = any_desc
+
+      @app.instance_eval do
+        desc d
+        long_desc ld
+        command cm do |c|
+          c.action {}
+        end
+      end
+      @command = GLI::Commands::Help.new(@app,@output,@error)
+    }
+    When {
+      @command.execute({},{},[@command_name])
+    }
+    Then {
+      assert_output_contained(/\[global options\]/)
+      refute_output_contained(/\[command options\]/)
+      refute_output_contained('COMMAND OPTIONS')
+    }
+  end
+
   test_that "omitting default_description doesn't blow up" do
     Given {
       app = TestApp.new

data/test/tc_terminal.rb

@@ -60,12 +60,14 @@ class TC_testTerminal < Clean::Test::TestCase
           return '1234' if command == 'tput lines'
         else 
           return '1234 5678' if command == 'stty size'
+          return '1234 5678' if command == 'stty'
         end
 
         raise "Unexpected command called: #{command} for #{RUBY_PLATFORM}"
       end
       def command_exists?(command); true; end
       def jruby?; false; end
+      def solaris?; false; end
     end
     ENV['COLUMNS'] = 'foo'
     assert_equal [5678,1234],terminal.size
@@ -77,6 +79,7 @@ class TC_testTerminal < Clean::Test::TestCase
     GLI::Terminal.instance_eval do
       def command_exists?(command); false; end
       def jruby?; false; end
+      def solaris?; false; end
     end
     ENV['COLUMNS'] = 'foo'
     assert_equal [80,24],terminal.size
@@ -89,6 +92,7 @@ class TC_testTerminal < Clean::Test::TestCase
     terminal = GLI::Terminal.new
     GLI::Terminal.instance_eval do
       def jruby?; raise "Problem"; end
+      def solaris?; false; end
     end
     ENV['COLUMNS'] = 'foo'
     assert_equal [80,24],terminal.size

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.6.0.rc1
-  prerelease: 6
+  version: 2.6.0
+  prerelease: 
 platform: ruby
 authors:
 - David Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-15 00:00:00.000000000 Z
+date: 2013-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -75,22 +75,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: sdoc
   requirement: !ruby/object:Gem::Requirement
@@ -365,15 +381,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2077859074459195456
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: gli
 rubygems_version: 1.8.25