gli 2.11.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 362815ed2ee02ae4318a321eca52acb7175f802f
-  data.tar.gz: 27dadfccc2e537d4ae9824cf1a75075020391d6c
+  metadata.gz: e3051959ac78b44c2e6c7d8be0701aebcb375700
+  data.tar.gz: 5ef912011fd093bf0afc55b7642d7eaa85f84d4f
 SHA512:
-  metadata.gz: 261bf4ac97f86f4b2b1d68aba7cb7396da8c6e2651504dfd8ce1a736215cca382b723db02820165b69c71e74721b4ac4588c45cfcf7014596c80e1225845a504
-  data.tar.gz: 4a12460017ee29eb4dd7f97111ee5cbb8b5112cd44db7dd933c7edc069b3f8053e0245417e4fa3ffaaeb108b4f85384ab2a86bf0483b7811ad52dbdafb9d6110
+  metadata.gz: 464e43336b07485f3824dbacdeb8fbe5f5ebce4bd41af6f2dbc06406560b6c1b2d4b6ea1dc413de364ddba2d0d37576e121dcc0bebf962fef2f4d1c57221f4d8
+  data.tar.gz: 03296c0c993306c51903bc142cd8478348cd616aa735b4799c27dfb7b53bd048e115b32434644c3462f63742bd4b46730cb227936baafbef7ceed4d0bf9ad62b

data/bin/gli

@@ -9,6 +9,10 @@ program_desc 'create scaffolding for a GLI-powered application'
 
 version GLI::VERSION
 
+# Can't use these without changing the current behavior of gli
+# arguments :strict
+# subcommand_option_handling :normal
+
 switch :v, :desc => 'Be verbose'
 
 switch :n, :desc => 'Dry run; don''t change the disk'
@@ -29,7 +33,9 @@ for command line processing.  Specifically, this will create
 an executable ready to go, as well as a lib and test directory, all
 inside the directory named for your project
 EOS
-arg_name 'project_name [command[ command]*]'
+arg :project_name
+arg :command_name, [:optional, :multiple]
+arg_name "project_name [command_name][, [command_name]]*"
 command [:init,:scaffold] do |c|
 
   c.switch :e,:ext, :desc => 'Create an ext dir'

data/features/gli_executable.feature

@@ -49,7 +49,7 @@ Feature: The GLI executable works as intended
         init - Create a new GLI-based project
 
     SYNOPSIS
-        gli [global options] init [command options] project_name [command[ command]*]
+        gli [global options] init [command options] project_name [command_name][, [command_name]]*
 
     DESCRIPTION
         This will create a scaffold command line project that uses GLI for command

data/features/todo.feature

@@ -185,7 +185,7 @@ Feature: The todo app has a nice user interface
         list - List things, such as tasks or contexts
 
     SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg]
+        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task][, [task]]*
         todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
 
     DESCRIPTION
@@ -233,7 +233,7 @@ Feature: The todo app has a nice user interface
         list - List things, such as tasks or contexts
 
     SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg]
+        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task][, [task]]*
         todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
 
     DESCRIPTION
@@ -258,7 +258,7 @@ Feature: The todo app has a nice user interface
         list - List things, such as tasks or contexts
 
     SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg]
+        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task][, [task]]*
         todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
 
     DESCRIPTION
@@ -291,7 +291,7 @@ Feature: The todo app has a nice user interface
         list - List things, such as tasks or contexts
 
     SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg]
+        todo [global options] list [command options] [tasks] [--flag arg] [-x arg] [task][, [task]]*
         todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
 
     DESCRIPTION
@@ -315,7 +315,7 @@ Feature: The todo app has a nice user interface
         tasks - List tasks
 
     SYNOPSIS
-        todo [global options] list tasks [command options] 
+        todo [global options] list tasks [command options] [task][, [task]]*
         todo [global options] list tasks [command options] open
 
     DESCRIPTION
@@ -502,7 +502,7 @@ Feature: The todo app has a nice user interface
         list - List things, such as tasks or contexts
 
     SYNOPSIS
-        todo [global options] list [command options] [tasks] [subcommand options]
+        todo [global options] list [command options] [tasks] [subcommand options] [task][, [task]]*
         todo [global options] list [command options] contexts [subcommand options]
 
     DESCRIPTION

data/lib/gli/app.rb

@@ -291,6 +291,13 @@ module GLI
       @subcommand_option_handling_strategy = handling_strategy
     end
 
+    # How to handle argument validation. Either +:loose+ (which does not validate argument at all)
+    # or +:strict+ (which will validate the number of arguments).
+    # If nothing is specified, +:loose+ is assumed
+    def arguments(handling_strategy)
+      @argument_handling_strategy = handling_strategy
+    end
+
     private
 
     def load_commands(path)

data/lib/gli/app_support.rb

@@ -28,6 +28,7 @@ module GLI
       @default_command = :help
       @around_block = nil
       @subcommand_option_handling_strategy = :legacy
+      @argument_handling_strategy = :loose
       clear_nexts
     end
 
@@ -68,7 +69,8 @@ module GLI
                                                 switches,
                                                 accepts,
                                                 @default_command,
-                                                self.subcommand_option_handling_strategy)
+                                                self.subcommand_option_handling_strategy,
+                                                self.argument_handling_strategy)
 
         parsing_result = gli_option_parser.parse_options(args)
         parsing_result.convert_to_openstruct! if @use_openstruct
@@ -201,6 +203,10 @@ module GLI
       end
     end
 
+    def argument_handling_strategy
+      @argument_handling_strategy || :loose
+    end
+
     def subcommand_option_handling_strategy
       @subcommand_option_handling_strategy || :legacy
     end

data/lib/gli/commands/help.rb

@@ -59,7 +59,8 @@ module GLI
         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')
+              :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',
+              :arguments => [Argument.new(:command_name, [:multiple, :optional])])
         @app = app
         @parent = app
         @sorter = SORTERS[@app.help_sort_type]

data/lib/gli/commands/scaffold.rb

@@ -284,6 +284,9 @@ program_desc 'Describe your application here'
 
 version #{project_name_as_module_name(project_name)}::VERSION
 
+# Use argument validation
+arguments :strict
+
 desc 'Describe some switch here'
 switch [:s,:switch]
 

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,default_command = nil,subcommand_option_handling_strategy=:legacy)
+    def initialize(commands,flags,switches,accepts,default_command = nil,subcommand_option_handling_strategy=:legacy,argument_handling_strategy=:loose)
        command_finder       = CommandFinder.new(commands,default_command || "help")
       @global_option_parser = GlobalOptionParser.new(OptionParserFactory.new(flags,switches,accepts),command_finder,flags)
       @accepts              = accepts
       @subcommand_option_handling_strategy = subcommand_option_handling_strategy
+      @argument_handling_strategy = argument_handling_strategy
     end
 
     # Given the command-line argument array, returns an OptionParsingResult
@@ -14,7 +15,7 @@ module GLI
       OptionParsingResult.new.tap { |parsing_result|
         parsing_result.arguments = args
         parsing_result = @global_option_parser.parse!(parsing_result)
-        option_parser_class.new(@accepts).parse!(parsing_result)
+        option_parser_class.new(@accepts).parse!(parsing_result, @argument_handling_strategy)
       }
     end
 
@@ -43,6 +44,38 @@ module GLI
       end
 
     protected
+      def verify_arguments!(arguments, command)
+        # Lets assume that if the user sets a 'arg_name' for the command it is for a complex scenario
+        # and we should not validate the arguments
+        return unless command.arguments_description.empty?
+
+        # Go through all declared arguments for the command, counting the min and max number
+        # of arguments
+        min_number_of_arguments = 0
+        max_number_of_arguments = 0
+        command.arguments.each do |arg|
+          if arg.optional?
+            max_number_of_arguments = max_number_of_arguments + 1
+          else
+            min_number_of_arguments = min_number_of_arguments + 1
+            max_number_of_arguments = max_number_of_arguments + 1
+          end
+
+          # Special case, as soon as we have a 'multiple' arguments, all bets are off for the
+          # maximum number of arguments !
+          if arg.multiple?
+            max_number_of_arguments = 99999
+          end
+        end
+
+        # Now validate the number of arguments
+        if arguments.size < min_number_of_arguments
+          raise MissingRequiredArgumentsException.new("Not enough arguments for command", command)
+        end
+        if arguments.size > max_number_of_arguments
+          raise MissingRequiredArgumentsException.new("Too many arguments for command", command)
+        end
+      end
 
       def verify_required_options!(flags, command, options)
         missing_required_options = flags.values.
@@ -70,7 +103,7 @@ module GLI
         }
       end
 
-      def parse!(parsing_result)
+      def parse!(parsing_result,argument_handling_strategy)
         parsed_command_options = {}
         command = parsing_result.command
         arguments = nil
@@ -121,13 +154,17 @@ module GLI
         parsing_result.command_options = command_options
         parsing_result.command = command
         parsing_result.arguments = Array(arguments.compact)
+
+        # Lets validate the arguments now that we know for sure the command that is invoked
+        verify_arguments!(parsing_result.arguments, parsing_result.command) if argument_handling_strategy == :strict
+
         parsing_result
       end
 
     end
 
     class LegacyCommandOptionParser < NormalCommandOptionParser
-      def parse!(parsing_result)
+      def parse!(parsing_result,argument_handling_strategy)
         command                     = parsing_result.command
         option_parser_factory       = OptionParserFactory.for_command(command,@accepts)
         option_block_parser         = LegacyCommandOptionBlockParser.new(option_parser_factory, self.error_handler)

data/lib/gli/version.rb

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

data/test/apps/todo/bin/todo

@@ -20,6 +20,7 @@ synopsis_format (ENV['SYNOPSES'] || 'full').to_sym
 hide_commands_without_desc ENV['HIDE_COMMANDS_WITHOUT_DESC'] === 'true'
 
 subcommand_option_handling :normal
+arguments :strict
 
 program_desc 'Manages tasks'
 program_long_desc "A test program that has a sophisticated UI that can be used to exercise a lot of GLI's power"
@@ -41,7 +42,12 @@ command :first  do |c| c.action { |g,o,a| puts "first: #{a.join(',')}" } end
 arg :argument, :optional
 command :second do |c| c.action { |g,o,a| puts "second: #{a.join(',')}" } end
 
+arg :first
+arg :second
 command :chained         => [ :first, :second ]
+
+arg :first
+arg :second
 command [:chained2,:ch2] => [ :second, :first ]
 
 pre do |global,command,options,args|

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

@@ -8,6 +8,7 @@ long_desc %(
   stored in 
   your todo databases.
 )
+
 command [:list] do |c|
   c.default_command :tasks
 
@@ -22,6 +23,8 @@ command [:list] do |c|
     Lists all of your tasks that you have, in varying orders, and
     all that stuff.  Yes, this is long, but I need a long description.
   )
+
+  c.arg :task, [:optional, :multiple]
   c.command :tasks do |tasks|
     tasks.desc "blah blah crud x whatever"
     tasks.flag [:x], :must_match => Array

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

@@ -13,7 +13,8 @@ command [:make] do |c|
       puts o[:long]
     end
 
-    desc 'make a bug'
+    task.desc 'make a bug'
+    task.arg :argument, [:multiple, :optional]
     task.command :bug do |bug|
       bug.desc 'make this bug in the legacy system'
       bug.flag [:l,:legacy]

data/test/tc_subcommand_parsing.rb

@@ -4,6 +4,30 @@ require 'pp'
 class TC_testSubCommandParsing < 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
+    @app.subcommand_option_handling :legacy
+    @app.error_device=@fake_stderr
+    ENV.delete('GLI_DEBUG')
+
+    @results = {}
+    @exit_code = 0
+  end
+
+  def teardown
+    $stdout = @original_stdout
+    $stderr = @original_stderr
+  end
+
   test_that "commands options may clash with globals and it gets sorted out" do
     Given :app_with_subcommands_storing_results
     When {
@@ -24,7 +48,7 @@ class TC_testSubCommandParsing < Clean::Test::TestCase
       @app.run(%w(-f global command1 -f command -s subcommand10 -f sub))
     }
     Then {
-      with_clue(@results) {
+      with_clue {
         assert_equal  'subcommand10',@results[:command_name]
         assert_equal  'global',      @results[:global_options][:f],'global'
         assert       !@results[:global_options][:s]
@@ -42,7 +66,7 @@ class TC_testSubCommandParsing < Clean::Test::TestCase
       @app.run(%w(-f global command1 -f command -s subcommand10 -f sub))
     }
     Then {
-      with_clue(@results) {
+      with_clue {
         assert_equal  'subcommand10',@results[:command_name]
         assert_equal  'global',      @results[:global_options][:f],'global'
         assert       !@results[:global_options][:s]
@@ -54,18 +78,68 @@ class TC_testSubCommandParsing < Clean::Test::TestCase
     }
   end
 
+  test_that "in loose mode, argument validation is ignored" do
+    Given :app_with_arguments, 1, 1, false, :loose
+    When :run_app_with_X_arguments, 0
+    Then {
+      with_clue {
+        assert_equal 0, @results[:nbargs]
+        assert_equal 0, @exit_code
+      }
+    }
+  end
+
+  ix = -1
+  [
+    [1, 1, false, 0, :not_enough],   [1, 1, false, 1, :success],
+    [1, 1, false, 2, :success],      [1, 1, false, 3, :too_many],
+    [1, 1, true, 0, :not_enough],    [1, 1, true, 1, :success],
+    [1, 1, true, 2, :success],       [1, 1, true, 3, :success],
+    [1, 1, true, 30, :success],      [0, 0, false, 0, :success],
+    [0, 0, false, 1, :too_many],     [0, 1, false, 1, :success],
+    [0, 1, false, 0, :success],      [1, 0, false, 1, :success],
+    [1, 0, false, 0, :not_enough],   [0, 0, true, 0, :success],
+    [0, 0, true, 10, :success]
+  ].each do |nb_required, nb_optional, has_multiple, nb_generated, status|
+    ix = ix + 1
+    test_that "in strict mode, number of arguments is validated -- #{ix}" do
+      Given :app_with_arguments, nb_required, nb_optional, has_multiple, :strict
+      When :run_app_with_X_arguments, nb_generated
+      Then {
+        with_clue {
+          if status == :success then
+            assert_equal nb_generated, @results[:nbargs]
+            assert_equal 0, @exit_code
+            assert !@fake_stderr.contained?(/Not enough arguments for command/)
+            assert !@fake_stderr.contained?(/Too many arguments for command/)
+          elsif status == :not_enough then
+            assert_equal nil, @results[:nbargs]
+            assert_equal 64, @exit_code
+            assert @fake_stderr.contained?(/Not enough arguments for command/)
+          elsif status == :too_many then
+            assert_equal nil, @results[:nbargs]
+            assert_equal 64, @exit_code
+            assert @fake_stderr.contained?(/Too many arguments for command/)
+          else
+            assert false
+          end
+        }
+      }
+    end
+  end
 private
-  def with_clue(message,&block)
+  def with_clue(&block)
     block.call
   rescue Exception
-    PP.pp message,dump=""
-    puts dump
+    dump = ""
+    PP.pp "\nRESULTS---#{@results}", dump unless @results.empty?
+    PP.pp "\nSTDERR---\n#{@fake_stderr.to_s}", dump
+    PP.pp "\nSTDOUT---\n#{@fake_stdout.to_s}", dump
+    @original_stdout.puts dump
     raise
   end
 
   def app_with_subcommands_storing_results(subcommand_option_handling_strategy = :legacy)
-    @results = {}
-    @app = CLIApp.new
     @app.subcommand_option_handling subcommand_option_handling_strategy
     @app.flag ['f','flag']
     @app.switch ['s','switch']
@@ -101,4 +175,25 @@ private
       end
     end
   end
+
+  def app_with_arguments(nb_required_arguments, nb_optional_arguments, has_argument_multiple, arguments_handling_strategy = :loose)
+    @app.arguments arguments_handling_strategy
+    @app.subcommand_option_handling :normal
+
+    nb_required_arguments.times { |i| @app.arg("needed#{i}") }
+    nb_optional_arguments.times { |i| @app.arg("optional#{i}", :optional) }
+    @app.arg :multiple, [:multiple, :optional] if has_argument_multiple
+
+    @app.command :cmd do |c|
+      c.action do |g,o,a|
+        @results = {
+          :nbargs => a.size
+        }
+      end
+    end
+  end
+
+  def run_app_with_X_arguments(nb_arguments)
+    @exit_code = @app.run [].tap{|args| args << "cmd"; nb_arguments.times {|i| args << "arg#{i}"}}
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.12.0
 platform: ruby
 authors:
 - David Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-09 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake