gli 2.5.3 → 2.5.4

data/lib/gli/commands/help.rb

@@ -30,14 +30,25 @@ module GLI
     }
     # The help command used for the two-level interactive help system
     class Help < Command
+      @@skips_pre    = true
+      @@skips_post   = true
+      @@skips_around = true
+
+      # Configure help to explicitly skip or not skip the pre block when the help command runs.
+      # This is here because the creation of the help command is outside of the client programmer's control
+      def self.skips_pre=(skips_pre)       ; @@skips_pre = skips_pre       ; end
+      # Configure help to explicitly skip or not skip the post block when the help command runs.
+      # This is here because the creation of the help command is outside of the client programmer's control
+      def self.skips_post=(skips_post)     ; @@skips_post = skips_post     ; end
+      # Configure help to explicitly skip or not skip the around block when the help command runs.
+      # This is here because the creation of the help command is outside of the client programmer's control
+      def self.skips_around=(skips_around) ; @@skips_around = skips_around ; end
+
       def initialize(app,output=$stdout,error=$stderr)
         super(:names => :help,
               :description => 'Shows a list of commands or help for one command',
               :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_around => true)
+              :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')
         @app = app
         @sorter = SORTERS[@app.help_sort_type]
         @text_wrapping_class = WRAPPERS[@app.help_text_wrap_type]
@@ -50,6 +61,10 @@ module GLI
         end
       end
 
+      def skips_pre    ; @@skips_pre    ; end
+      def skips_post   ; @@skips_post   ; end
+      def skips_around ; @@skips_around ; end
+
     private
 
       def show_help(global_options,options,arguments,out,error)

data/lib/gli/version.rb

@@ -1,5 +1,5 @@
 module GLI
   unless const_defined? :VERSION
-    VERSION = '2.5.3' #:nodoc:
+    VERSION = '2.5.4' #:nodoc:
   end
 end

data/test/tc_help.rb

@@ -10,6 +10,10 @@ class TC_testHelp < Clean::Test::TestCase
     @output = StringIO.new
     @error = StringIO.new
     @command_names_used = []
+    # Reset help command to its default state
+    GLI::Commands::Help.skips_pre    = true
+    GLI::Commands::Help.skips_post   = true
+    GLI::Commands::Help.skips_around = true
   end
 
   def teardown
@@ -32,6 +36,35 @@ class TC_testHelp < Clean::Test::TestCase
       assert_not_nil @command.long_description
       assert         @command.skips_pre
       assert         @command.skips_post
+      assert         @command.skips_around
+    }
+  end
+
+  test_that "the help command can be configured to skip things declaratively" do
+    Given {
+      @command = GLI::Commands::Help.new(TestApp.new,@output,@error)
+      GLI::Commands::Help.skips_pre    = false
+      GLI::Commands::Help.skips_post   = false
+      GLI::Commands::Help.skips_around = false
+    }
+    Then {
+      assert !@command.skips_pre
+      assert !@command.skips_post
+      assert !@command.skips_around
+    }
+  end
+
+  test_that "the help command can be configured to skip things declaratively regardless of when it the object was created" do
+    Given {
+      GLI::Commands::Help.skips_pre    = false
+      GLI::Commands::Help.skips_post   = false
+      GLI::Commands::Help.skips_around = false
+      @command = GLI::Commands::Help.new(TestApp.new,@output,@error)
+    }
+    Then {
+      assert !@command.skips_pre
+      assert !@command.skips_post
+      assert !@command.skips_around
     }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 2.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-26 00:00:00.000000000 Z
+date: 2013-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -333,7 +333,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3516893403879120401
+      hash: -1157408326756213175
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -342,7 +342,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3516893403879120401
+      hash: -1157408326756213175
 requirements: []
 rubyforge_project: gli
 rubygems_version: 1.8.23