gli 2.14.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71f12230a16a02ce456bc50cb4f3729797d3a21e
-  data.tar.gz: d24fb65d109f0454befb7a7d2f31c27cca91eb86
+  metadata.gz: e666d683a83a5f81875fbe30821de7a7b13b831b
+  data.tar.gz: 466f1b67952cb0627da9918d1958df1306da1978
 SHA512:
-  metadata.gz: 4abb85d5fc3cd970a6662f5c7f2da49c912e8874644537f9609b70f61969779f14f20525a1d4f12a7b071c90dc01ec489ead94378baefbbfc91d63044fd0bf9f
-  data.tar.gz: 8b5271a476e203d4e0fc06f8de8dd4b5228078a5a6b0f0702166982e10c5eb830999137f092ab4f460cc996b0d5744774e8330caaf210f096d36eb9b80d293a4
+  metadata.gz: 82e0bde97f4d3813873fea67b1d3de567eb4c82faf82f89163a30c394f6a8f3220a65e60a39f437e772bf0e96c0ff29dfae140c73291cb18a547b34a4ad05744
+  data.tar.gz: a608c4252838fdd419d2ee53d08de948d6c56b2b70bbd3cd34d6fd3ef6d18d2e54374f042c34af77d7d238c98f45eade0215cf003ea46f1aa5d6e38f878b3683

data/.gitignore

@@ -8,6 +8,7 @@ tmp
 cruddo.rdoc
 gli.wiki
 Gemfile.lock
+*.gem
 results.html
 .rbx
 .DS_Store

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.3.1

data/.travis.yml

@@ -3,9 +3,11 @@ notifications:
     on_success: always
 script: 'bundle exec rake test features'
 rvm:
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+  - jruby-19mode
 branches:
   only:
     - 'gli-2'

data/README.rdoc

@@ -75,13 +75,16 @@ Get a more detailed walkthrough on the {main site}[http://davetron5000.github.co
 
 Tests should be passing supported MRI Rubies (see +.travis.yml+ for specifics).
 
-Due to the vagaries of Travis, I can't keep the test suite running on unsupported Rubies, however GLI has been used on older ones, like:
+Due to the vagaries of Travis, I can't keep the test suite running on unsupported Rubies, but we currently support:
+
+* 2.1
+* 2.2
+* 2.3
+* 2.4
+* JRuby
+
+GLI likely works on older rubies, but the cost of keeping tests passing on those versions (which are now totally unsupported by Ruby core) is too high.
 
-* 1.8.7
-* 1.9.2
-* 1.9.3
-* Ruby Enterprise Edition 1.8.7
-* JRuby 
 
 == Documentation
 

data/features/gli_init.feature

@@ -139,7 +139,6 @@ Feature: The scaffold GLI generates works
     2 steps (2 passed)
     """
 
-    @wip
   Scenario Outline: Scaffold generates and respects flags to create ext dir and avoid test dir
     When I run `<command>`
     Then the exit status should be 0

data/features/todo.feature

@@ -211,6 +211,28 @@ Feature: The todo app has a nice user interface
       | list --help     |
       | --help list     |
 
+  Scenario: Getting Help for a leaf command of todo
+    Given todo's bin directory is in my path
+    When I successfully run `todo help list tasks open`
+    Then the output should contain:
+    """
+    NAME
+        open - list open tasks
+    
+    SYNOPSIS
+        todo [global options] list tasks open [command options] 
+    
+    COMMAND OPTIONS
+        --flag=arg - (default: none)
+        -x arg     - blah blah crud x whatever (default: none)
+
+    EXAMPLES
+
+        # example number 1
+        todo list tasks open --flag=blah
+
+        todo list tasks open -x foo
+    """
 
   Scenario: Getting Help for a top level command of todo with no command options
     When I successfully run `todo help chained`
@@ -315,7 +337,7 @@ Feature: The todo app has a nice user interface
 
     SYNOPSIS
         todo [global options] list tasks [command options] [task][, [task]]*
-        todo [global options] list tasks [command options] open
+        todo [global options] list tasks [command options] open [--flag arg] [-x arg]
 
     DESCRIPTION
         Lists all of your tasks that you have, in varying orders, and all that

data/gli.gemspec

@@ -1,9 +1,10 @@
 # Make sure we get the gli that's local
 require File.join([File.dirname(__FILE__),'lib','gli','version.rb'])
 
-spec = Gem::Specification.new do |s| 
+spec = Gem::Specification.new do |s|
   s.name = 'gli'
   s.version = GLI::VERSION
+  s.licenses = ['Apache-2.0']
   s.author = 'David Copeland'
   s.email = 'davidcopeland@naildrivin5.com'
   s.homepage = 'http://davetron5000.github.com/gli'
@@ -22,13 +23,12 @@ spec = Gem::Specification.new do |s|
   s.bindir = 'bin'
   s.rubyforge_project = 'gli'
   s.add_development_dependency('rake', '~> 0.9.2.2')
-  s.add_development_dependency('rdoc')
-  s.add_development_dependency('rainbow', '~> 1.1.1')
-  s.add_development_dependency('clean_test')
-  s.add_development_dependency('cucumber')
-  s.add_development_dependency('gherkin')
+  s.add_development_dependency('rdoc', '~> 4.2')
+  s.add_development_dependency('rainbow', '~> 1.1', '~> 1.1.1')
+  s.add_development_dependency('clean_test', '~> 1.0')
+  s.add_development_dependency('cucumber', '~> 2.4')
+  s.add_development_dependency('gherkin', '~> 4.0')
   s.add_development_dependency('aruba', '0.5.1')
-  s.add_development_dependency('sdoc')
+  s.add_development_dependency('sdoc', '~> 0.4')
   s.add_development_dependency('faker','1.0.0')
 end
-

data/lib/gli/command.rb

@@ -45,6 +45,8 @@ module GLI
     #           +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
+    #           +examples+:: An array of Hashes, where each hash must have the key +:example+ mapping to a string, and may optionally have the key +:desc+
+    #                        that documents that example.
     def initialize(options)
       super(options[:names],options[:description],options[:long_desc])
       @arguments_description = options[:arguments_name] || ''
@@ -57,9 +59,21 @@ module GLI
       @commands_declaration_order = []
       @flags_declaration_order = []
       @switches_declaration_order = []
+      @examples = options[:examples] || []
       clear_nexts
     end
 
+    # Specify an example invocation.
+    #
+    # example_invocation:: test of a complete command-line invocation you want to show
+    # options:: refine the example:
+    #           +:desc+:: A description of the example to be shown with it (optional)
+    def example(example_invocation,options = {})
+      @examples << {
+        example: example_invocation
+      }.merge(options)
+    end
+
     # Set the default command if this command has subcommands and the user doesn't 
     # provide a subcommand when invoking THIS command.  When nil, this will show an error and the help
     # for this command; when set, the command with this name will be executed.

data/lib/gli/command_support.rb

@@ -49,6 +49,11 @@ module GLI
       all_forms
     end
 
+    # Returns the array of examples
+    def examples
+      @examples
+    end
+
     # Get an array of commands, ordered by when they were declared
     def commands_declaration_order # :nodoc:
       @commands_declaration_order

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

@@ -18,6 +18,7 @@ module GLI
           
           options_description  = OptionsFormatter.new(flags_and_switches(@command,@app),@sorter,@wrapper_class).format
           commands_description = format_subcommands(@command)
+          command_examples = format_examples(@command)
 
           synopses = @synopsis_formatter.synopses_for_command(@command)
           COMMAND_HELP.result(binding)
@@ -45,6 +46,13 @@ COMMAND OPTIONS
 
 COMMANDS
 <%= commands_description %>
+<% end %>
+<% unless @command.examples.empty? %>
+
+<%= @command.examples.size == 1 ? 'EXAMPLE' : 'EXAMPLES' %>
+
+
+<%= command_examples %>
 <% end %>),nil,'<>')
 
 
@@ -76,6 +84,16 @@ COMMANDS
           formatter = ListFormatter.new(commands_array,@wrapper_class)
           StringIO.new.tap { |io| formatter.output(io) }.string
         end
+
+        def format_examples(command)
+          command.examples.map {|example|
+            string = ""
+            if example[:desc]
+              string << "    # #{example[:desc]}\n"
+            end
+            string << "    #{example.fetch(:example)}\n"
+          }.join("\n")
+        end
       end
     end
   end

data/lib/gli/version.rb

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

data/test/apps/todo/lib/todo/commands/list.rb

@@ -38,6 +38,14 @@ command [:list] do |c|
 
     tasks.desc 'list open tasks'
     tasks.command :open do |open|
+      open.desc "blah blah crud x whatever"
+      open.flag [:x], :must_match => Array
+
+      open.flag :flag
+
+      open.example "todo list tasks open --flag=blah", desc: "example number 1"
+      open.example "todo list tasks open -x foo"
+
       open.action do |global,options,args|
         puts "tasks open"
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.0
 platform: ruby
 authors:
 - David Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2017-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,20 +28,23 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
@@ -49,6 +52,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
@@ -56,44 +62,44 @@ dependencies:
   name: clean_test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: gherkin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -112,16 +118,16 @@ dependencies:
   name: sdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -255,7 +261,8 @@ files:
 - test/tc_verbatim_wrapper.rb
 - test/test_helper.rb
 homepage: http://davetron5000.github.com/gli
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: