gli 2.0.0.rc3 → 2.0.0.rc4

data/README.rdoc

@@ -1,6 +1,6 @@
 = Git-Like Interface Command Line Parser
 
-<b>This describes the forthcoming GLI2 and might not be 100% accurate</b>
+<b>GLI2 is currently in Release Candidate, so this might change before the official release</b>
 
 The best way to make a "command-suite" command-line application (for the best way to make a
 simpler command-line application, check out methadone[http://www.github.com/davetron5000/methadone]).
@@ -10,7 +10,7 @@ of syntax, but without restricting you in any way from the power of +OptionParse
 
 * {Overview}[http://davetron5000.github.com/gli]
 * {Source on Github}[http://github.com/davetron5000/gli]
-* RDoc[http://davetron5000.github.com/gli]
+* RDoc[http://davetron5000.github.com/gli/rdoc/index.html]
 
 == Use
 

data/lib/gli/app.rb

@@ -58,6 +58,13 @@ module GLI
       @skips_post = true
     end
 
+    # Use this if the following command should not have the around block executed.
+    # By default, the around block is executed, but for commands that might not want the
+    # setup to happen, this can be handy
+    def skips_around
+      @skips_around = true
+    end
+
     # Sets that this app uses a config file as well as the name of the config file.  
     #
     # +filename+:: A String representing the path to the file to use for the config file.  If it's an absolute
@@ -90,6 +97,25 @@ module GLI
       @post_block = a_proc
     end
 
+    # This inverts the pre/post concept.  This is useful when you have a global shared resource that is governed by a block
+    # instead of separate open/close methods.  The block you pass here will be given four parameters:
+    #
+    # global options:: the parsed global options
+    # command:: The GLI::Command that the user is going to invoke
+    # options:: the command specific options
+    # args:: unparsed command-line args
+    # code:: a block that you must +call+ to execute the command.
+    #
+    # #help_now! and #exit_now! work as expected; you can abort the command call by simply not calling it
+    #
+    # Note that if you declare an #around block, #pre and #post blocks will still work.  The #pre is called first, followed by
+    # the around, followed by the #post.
+    #
+    # Call #skips_around before a command that should not have this hook fired
+    def around(&a_proc)
+      @around_block = a_proc
+    end
+
     # Define a block to run if an error occurs.
     # The block will receive any Exception that was caught.
     # It should evaluate to false to avoid the built-in error handling (which basically just

data/lib/gli/app_support.rb

@@ -14,7 +14,7 @@ module GLI
     def reset # :nodoc:
       switches.clear
       flags.clear
-      commands.clear
+      @commands = nil
       @version = nil
       @config_file = nil
       @use_openstruct = false
@@ -23,6 +23,7 @@ module GLI
       @pre_block = false
       @post_block = false
       @default_command = :help
+      @around_block = nil
       clear_nexts
     end
 
@@ -43,7 +44,7 @@ module GLI
 
         add_help_switch_if_needed(switches)
 
-        global_options,command,options,arguments = GLIOptionParser.new(commands,flags,switches,accepts).parse_options(args)
+        global_options,command,options,arguments = GLIOptionParser.new(commands,flags,switches,accepts,@default_command).parse_options(args)
 
         copy_options_to_aliased_versions(global_options,command,options)
 
@@ -51,7 +52,6 @@ module GLI
         options        = convert_to_openstruct_if_needed(options)
 
         if proceed?(global_options,command,options,arguments)
-          command ||= commands[:help]
           call_command(command,global_options,options,arguments)
         end
         0
@@ -93,6 +93,7 @@ module GLI
       super
       @skips_post = false
       @skips_pre = false
+      @skips_around = false
     end
 
     def stderr
@@ -126,6 +127,12 @@ module GLI
       end
     end
 
+    def around_block
+      @around_block ||= Proc.new do |global,command,options,args,code|
+        code.call
+      end
+    end
+
     # Sets the default values for flags based on the configuration
     def override_defaults_based_on_config(config)
       override_default(flags,config)
@@ -216,7 +223,12 @@ module GLI
 
     def call_command(command,global_options,options,arguments)
       arguments = arguments.map { |arg| arg.dup } # unfreeze
-      command.execute(global_options,options,arguments)
+      code = lambda { command.execute(global_options,options,arguments) }
+      if command.skips_around
+        code.call
+      else
+        around_block.call(global_options,command,options,arguments,code)
+      end
       unless command.skips_post
         post_block.call(global_options,command,options,arguments)
       end

data/lib/gli/command.rb

@@ -42,11 +42,13 @@ module GLI
     #                         as a paragraph break.  No other formatting is respected, though inner whitespace is maintained.
     #           +skips_pre+:: if true, this command advertises that it doesn't want the pre block called first
     #           +skips_post+:: if true, this command advertises that it doesn't want the post block called after it
+    #           +skips_around+:: if true, this command advertises that it doesn't want the around block called
     def initialize(options)
       super(options[:names],options[:description],options[:long_desc])
       @arguments_description = options[:arguments_name] || ''
       @skips_pre = options[:skips_pre]
       @skips_post = options[:skips_post]
+      @skips_around = options[:skips_around]
       clear_nexts
     end
 

data/lib/gli/command_support.rb

@@ -30,6 +30,11 @@ module GLI
       @skips_post
     end
 
+    # If true, this command doesn't want the around block called
+    def skips_around
+      @skips_around
+    end
+
     # Return the Array of the command's names
     def names 
       all_forms

data/lib/gli/commands/help.rb

@@ -17,7 +17,8 @@ module GLI
               :arguments_name => 'command',
               :long_desc => 'Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function',
               :skips_pre => true,
-              :skips_post => true)
+              :skips_post => true,
+              :skips_around => true)
         @app = app
         action do |global_options,options,arguments|
           show_help(global_options,options,arguments,output,error)

data/lib/gli/dsl.rb

@@ -140,6 +140,7 @@ module GLI
         :long_desc => @next_long_desc,
         :skips_pre => @skips_pre,
         :skips_post => @skips_post,
+        :skips_around => @skips_around,
       }
       if names.first.kind_of? Hash
         command = GLI::Commands::CompoundCommand.new(self,

data/lib/gli/gli_option_parser.rb

@@ -1,11 +1,12 @@
 module GLI
   # Parses the command-line options using an actual +OptionParser+
   class GLIOptionParser
-    def initialize(commands,flags,switches,accepts)
+    def initialize(commands,flags,switches,accepts,default_command = nil)
       @commands = commands
       @flags = flags
       @switches = switches
       @accepts = accepts
+      @default_command = default_command
     end
 
     # Given the command-line argument array, returns and array of size 4:
@@ -87,10 +88,13 @@ module GLI
           names_to_commands[command_alias.to_s] = command
         end
       end
-      name = name.to_s
-      return names_to_commands[name] if names_to_commands[name]
-      # Now try to match on partial names
-      partial_matches = names_to_commands.keys.select { |command_name| command_name =~ /^#{name}/ }
+      names_to_commands.fetch(name.to_s) do |command_to_match|
+        find_command_by_partial_name(names_to_commands, command_to_match)
+      end
+    end
+
+    def find_command_by_partial_name(names_to_commands, command_to_match)
+      partial_matches = names_to_commands.keys.select { |command_name| command_name =~ /^#{command_to_match}/ }
       return names_to_commands[partial_matches[0]] if partial_matches.size == 1
       partial_matches
     end

data/lib/gli/version.rb

@@ -1,5 +1,5 @@
 module GLI
   unless const_defined? :VERSION
-    VERSION = '2.0.0.rc3' #:nodoc:
+    VERSION = '2.0.0.rc4' #:nodoc:
   end
 end

data/test/tc_command.rb

@@ -4,7 +4,15 @@ require 'tempfile'
 class TC_testCommand < Clean::Test::TestCase
   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.error_device=@fake_stderr
+    ENV.delete('GLI_DEBUG')
     @app.reset
     @app.program_desc 'A super awesome program'
     @app.desc 'Some Global Option'
@@ -50,17 +58,9 @@ class TC_testCommand < Clean::Test::TestCase
     @app.command [:test_wrap] do |c|
       c.action {}
     end
-    @fake_stdout = FakeStdOut.new
-    @fake_stderr = FakeStdOut.new
-    @app.error_device=@fake_stderr
-    ENV.delete('GLI_DEBUG')
-    @original_stdout = $stdout
-    $stdout = @fake_stdout
-    @original_stderr = $stderr
-    $stderr = @fake_stderr
   end
 
-  def tear_down
+  def teardown
     $stdout = @original_stdout
     $stderr = @original_stderr
     FileUtils.rm_f "cruddo.rdoc"
@@ -100,6 +100,83 @@ class TC_testCommand < Clean::Test::TestCase
     end
   end
 
+  def test_around_filter
+    @around_block_called = false
+    @app.around do |global_options, command, options, arguments, code|
+      @around_block_called = true
+      code.call
+    end
+    @app.run(['bs'])
+    assert(@around_block_called, "Wrapper block should have been called")
+  end
+
+  def test_around_filter_can_be_skipped
+    # Given
+    @around_block_called = false
+    @action_called = false
+    @app.skips_around
+    @app.command :skips_around_filter do |c|
+      c.action do |g,o,a|
+        @action_called = true
+      end
+    end
+
+    @app.command :uses_around_filter do |c|
+      c.action do |g,o,a|
+        @action_called = true
+      end
+    end
+
+    @app.around do |global_options, command, options, arguments, code|
+      @around_block_called = true
+      code.call
+    end
+
+    # When
+    exit_status = @app.run(['skips_around_filter'])
+
+    # Then
+    assert_equal 0,exit_status
+    assert(!@around_block_called, "Wrapper block should have been skipped")
+    assert(@action_called,"Action should have been called")
+
+    # When
+    @around_block_called = false
+    @action_called = false
+    exit_status = @app.run(['uses_around_filter'])
+
+    # Then
+    assert_equal 0,exit_status
+    assert(@around_block_called, "Wrapper block should have been called")
+    assert(@action_called,"Action should have been called")
+  end
+
+  def test_around_filter_handles_exit_now
+    @around_block_called = false
+    @error_message = "OH NOES"
+    @app.around do |global_options, command, options, arguments, code|
+      @app.exit_now! @error_message
+      code.call
+    end
+    exit_code = @app.run(['bs'])
+    assert exit_code != 0
+    assert_contained(@fake_stderr,/#{@error_message}/)
+    assert_not_contained(@fake_stdout,/SYNOPSIS/)
+  end
+
+  def test_around_filter_handles_help_now
+    @around_block_called = false
+    @error_message = "OH NOES"
+    @app.around do |global_options, command, options, arguments, code|
+      @app.help_now! @error_message
+      code.call
+    end
+    exit_code = @app.run(['bs'])
+    assert exit_code != 0
+    assert_contained(@fake_stderr,/#{@error_message}/)
+    assert_contained(@fake_stdout,/SYNOPSIS/)
+  end
+
   def test_command_skips_pre
     @app.skips_pre
     @app.skips_post

data/test/tc_gli.rb

@@ -17,10 +17,15 @@ class TC_testGLI < Clean::Test::TestCase
   include GLI
 
   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
     @config_file = File.expand_path(File.dirname(File.realpath(__FILE__)) + '/new_config.yaml')
     @gli_debug = ENV['GLI_DEBUG']
-    @fake_stderr = FakeStdOut.new
     @app.error_device=@fake_stderr
     ENV.delete('GLI_DEBUG')
   end
@@ -29,6 +34,8 @@ class TC_testGLI < Clean::Test::TestCase
     File.delete(@config_file) if File.exist?(@config_file)
     ENV['GLI_DEBUG'] = @gli_debug
     @app.error_device=$stderr
+    $stdout = @original_stdout
+    $stderr = @original_stderr
   end
 
   def test_flag_create
@@ -51,6 +58,19 @@ class TC_testGLI < Clean::Test::TestCase
     assert @app.switches[:s].aliases.include? :'some-switch'
   end
 
+  def test_default_command
+    @app.reset
+    @called = false
+    @app.command :foo do |c|
+      c.action do |global, options, arguments|
+        @called = true
+      end
+    end
+    @app.default_command(:foo)
+    assert_equal 0, @app.run([]), "Expected exit status to be 0"
+    assert @called, "Expected default command to be executed"
+  end
+
   def test_flag_with_space_barfs
     @app.reset
     assert_raises(ArgumentError) { @app.flag ['some flag'] }
@@ -214,6 +234,18 @@ class TC_testGLI < Clean::Test::TestCase
     do_test_switch_create_twice(@app)
     do_test_switch_create_twice(Command.new(:names => :f))
   end
+  
+  def test_non_negatable_negative_switch
+    @app.reset
+    @app.on_error { |ex| raise ex }
+    @app.switch 'no-color', :negatable => false
+    @app.command :smth do |c|
+      c.action do |global, *args|
+        assert global[:"no-color"], "Expected :'no-color' switch to be true"
+      end
+    end
+    @app.run(%w(--no-color smth))
+  end
 
   def test_all_aliases_in_options
     @app.reset

data/test/tc_subcommands.rb

@@ -4,13 +4,25 @@ class TC_testSubCommand < Clean::Test::TestCase
   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
-    @fake_stderr = FakeStdOut.new
     @app.error_device=@fake_stderr
     ENV.delete('GLI_DEBUG')
   end
 
+  def teardown
+    $stdout = @original_stdout
+    $stderr = @original_stderr
+  end
+
   ['add','new'].each do |name|
     test_that "We run the 'add' subcommand using '#{name}'" do
       Given we_have_a_command_with_two_subcommands

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc3
+  version: 2.0.0.rc4
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-28 00:00:00.000000000 Z
+date: 2012-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake