gli 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1fffe3ab7b8b3aa4881cfb38de3b7cc1e31508b
-  data.tar.gz: 057ab9061b13527ed56f448cc20ee3ea54a7472d
+  metadata.gz: bc8b2ac1abb69495f8096899fbb4da56b2e85d32
+  data.tar.gz: ce4f47438626b06fbd4fcf4b714a5257b63a2ec5
 SHA512:
-  metadata.gz: c61409e0f16a9d07d9e4f704e05890e48868dc359be530dd2c094d3856a841b224968c1f2902b761355ad3ff2574ab8e9a33af626ceb77e897e3a2dfa17a3580
-  data.tar.gz: 3f26ab6c6026483c986241c506fdf1742a43408eac52605aa7ba2c5a36076f1d48acba70fbba5031b649fc042043d2cdf112ebc175cf9afeb35b49821fd15979
+  metadata.gz: 1d9e77187528594f30d47c0dca4cdef47a1dc01fbc35657e0bfec3441a20b1d37d87dccecc4015957bf78c1055ff4ce9a0cb0b728b1e97305b6c8936ba82f2c2
+  data.tar.gz: 81eb28d1e7b564fed156a69fa0159bd4236bffec82d51bf1c5874c6d6a521eb8f24ce1ee3f156ff9445a504311b9deb83deb059ab27120c079b04e8578b286cf

data/README.rdoc

@@ -3,7 +3,7 @@
 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 very polished, easy-to-maintain command-line application without a lot
+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+.
 
 * {Overview}[http://davetron5000.github.com/gli]
@@ -79,6 +79,7 @@ Known to work on
 * 1.9.2
 * 1.9.3
 * 2.0.0
+* 2.1.0
 * Ruby Enterprise Edition 1.8.7
 * Rubinius 1.0.1
 * JRuby 1.6.4 

data/features/step_definitions/todo_steps.rb

@@ -18,6 +18,10 @@ Given /^the todo app is coded to wrap text only for tty$/ do
   ENV['TODO_WRAP_HELP_TEXT'] = 'tty_only'
 end
 
+Given /^the todo app is coded to hide commands without description$/ do
+  ENV['HIDE_COMMANDS_WITHOUT_DESC'] = 'true'
+end
+
 Given /^a clean home directory$/ do
   FileUtils.rm_rf File.join(ENV['HOME'],'gli_test_todo.rc')
 end

data/features/support/env.rb

@@ -38,6 +38,7 @@ After do |scenario|
   ENV['HOME'] = @original_home
   ENV['TODO_SORT_HELP'] = nil
   ENV['TODO_WRAP_HELP_TEXT'] = nil
+  ENV['HIDE_COMMANDS_WITHOUT_DESC'] = nil
   FileUtils.mv 'gli.rdoc.orig','gli.rdoc'
 end
 

data/features/todo.feature

@@ -144,6 +144,38 @@ Feature: The todo app has a nice user interface
         chained2, ch2 - 
     """
 
+  Scenario: Getting Help with commands without description hidden
+    Given the todo app is coded to hide commands without description
+    When I successfully run `todo help`
+    Then the output should contain:
+    """
+    NAME
+        todo - Manages tasks
+
+        A test program that has a sophisticated UI that can be used to exercise a
+        lot of GLI's power
+
+    SYNOPSIS
+        todo [global options] command [command options] [arguments...]
+
+    VERSION
+        0.0.1
+
+    GLOBAL OPTIONS
+        --flag=arg         - (default: none)
+        --help             - Show this message
+        --[no-]otherswitch - 
+        --[no-]switch      - 
+        --version          - Display the program version
+
+    COMMANDS
+        create, new - Create a new task or context
+        help        - Shows a list of commands or help for one command
+        initconfig  - Initialize the config file using current global options
+        list        - List things, such as tasks or contexts
+        ls          - LS things, such as tasks or contexts
+    """
+
   Scenario Outline: Getting Help for a top level command of todo
     When I successfully run `todo <help_invocation>`
     Then the output should contain:

data/lib/gli/app.rb

@@ -62,6 +62,17 @@ module GLI
       @program_long_desc
     end
 
+    # Provide a flag to choose whether to hide or not from the help the undescribed commands.
+    # By default the undescribed commands will be shown in the help.
+    #
+    # hide:: A Bool for hide the undescribed commands
+    def hide_commands_without_desc(hide=nil)
+      unless hide.nil?
+        @hide_commands_without_desc = hide
+      end
+      @hide_commands_without_desc || false
+    end
+
     # Use this if the following command should not have the pre block executed.
     # By default, the pre block is executed before each command and can result in
     # aborting the call.  Using this will avoid that behavior for the following command

data/lib/gli/command.rb

@@ -44,6 +44,7 @@ module GLI
     #           +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
+    #           +hide_commands_without_desc+:: if true and there isn't a description the command is not going to be shown in the help
     def initialize(options)
       super(options[:names],options[:description],options[:long_desc])
       @arguments_description = options[:arguments_name] || ''
@@ -51,6 +52,7 @@ module GLI
       @skips_pre = options[:skips_pre]
       @skips_post = options[:skips_post]
       @skips_around = options[:skips_around]
+      @hide_commands_without_desc = options[:hide_commands_without_desc]
       @commands_declaration_order = []
       @flags_declaration_order = []
       @switches_declaration_order = []

data/lib/gli/command_support.rb

@@ -11,8 +11,9 @@ module GLI
     end
 
     # Return true to avoid including this command in your help strings
+    # Will honor the hide_commands_without_desc flag
     def nodoc
-      false
+      @hide_commands_without_desc and description.nil?
     end
 
     # Return the arguments description

data/lib/gli/dsl.rb

@@ -53,7 +53,7 @@ module GLI
     #           +:long_desc+:: the long_description, instead of using #long_desc
     #           +:default_value+:: the default value, instead of using #default_value
     #           +:arg_name+:: the arg name, instead of using #arg_name
-    #           +:must_match+:: A regexp that the flag's value must match
+    #           +:must_match+:: A regexp that the flag's value must match or an array of allowable values
     #           +:type+:: A Class (or object you passed to GLI::App#accept) to trigger type coversion
     #
     # Example:
@@ -156,6 +156,7 @@ module GLI
         :skips_pre => @skips_pre,
         :skips_post => @skips_post,
         :skips_around => @skips_around,
+        :hide_commands_without_desc => @hide_commands_without_desc,
       }
       @commands_declaration_order ||= []
       if names.first.kind_of? Hash

data/lib/gli/version.rb

@@ -1,5 +1,5 @@
 module GLI
   unless const_defined? :VERSION
-    VERSION = '2.9.0'
+    VERSION = '2.10.0'
   end
 end

data/test/apps/todo/bin/todo

@@ -17,6 +17,7 @@ end
 sort_help (ENV['TODO_SORT_HELP'] || 'alpha').to_sym
 wrap_help_text (ENV['TODO_WRAP_HELP_TEXT'] || 'to_terminal').to_sym
 synopsis_format (ENV['SYNOPSES'] || 'full').to_sym
+hide_commands_without_desc ENV['HIDE_COMMANDS_WITHOUT_DESC'] === 'true'
 
 subcommand_option_handling :normal
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - David Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-19 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake