gli 2.21.5 → 2.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4090c5ae7772cf0833abb4eda596a2eb558577de6493a1389e90e68327f41093
-  data.tar.gz: 8f18bf74f7ac11bf544ac28be9c326355199a138364b7189a10537c7eb2903f4
+  metadata.gz: e2423619abd7f36b8c610382c006ed96685d8cc7df37d85b69267a64287124de
+  data.tar.gz: f4bcf12c882dd944264b40202abc82a5f0e5c649f3f03e3934b8608cdc10e8c2
 SHA512:
-  metadata.gz: '02638fe45837c6e17d83d8e1afaf3a90e94da181419b1dfc6f53db9487a90566ff281a2e9adc4155bd4baa379f5f43f379a716e788330e12f828ad2d9a233f99'
-  data.tar.gz: fbd6c9281eaf31a203cf5f6331ce21f4241eeb6b7e8cfafc5c3c4d63e81455a60246d76aa411ec4c3ffee3137c48921c569b819f6e0b7cc0e95225c5cdf18a1f
+  metadata.gz: ee3166846a6da41489fea74cdda3e08a85982e00b480090f371606768f36086ca324c732e83704421b99bc7e474e5e5ae140d79d05f7c552525a9cb897717130
+  data.tar.gz: b09cf190a438d021f565adbaeebfc90d74aa110f5fc436a0fd59485882d096246ec5d11b1fbd55df3a0afa3a6a80a494bc0ead1d43c6795c4cfce8cf983b552b

data/lib/gli/command_support.rb

@@ -127,7 +127,7 @@ module GLI
     end
 
     # Executes the command
-    def execute(global_options,options,arguments) 
+    def execute(global_options,options,arguments)
       get_action(arguments).call(global_options,options,arguments)
     end
 

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

@@ -31,27 +31,19 @@ module GLI
 SYNOPSIS
 <% synopses.each do |s| %>
     <%= s %>
-<% end %>
-<% unless @command.long_description.nil? %>
+<% end %><% unless @command.long_description.nil? %>
 
 DESCRIPTION
     <%= wrapper.wrap(@command.long_description) %> 
-<% end %>
-<% if options_description.strip.length != 0 %>
-
+<% end %><% if options_description.strip.length != 0 %>
 COMMAND OPTIONS
 <%= options_description %>
-<% end %>
-<% unless @command.commands.empty? %>
-
+<% end %><% unless @command.commands.empty? %>
 COMMANDS
 <%= commands_description %>
-<% end %>
-<% unless @command.examples.empty? %>
-
+<% end %><% unless @command.examples.empty? %>
 <%= @command.examples.size == 1 ? 'EXAMPLE' : 'EXAMPLES' %>
 
-
 <%= command_examples %>
 <% end %>))
 

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

@@ -44,11 +44,9 @@ SYNOPSIS
 VERSION
     <%= @app.version_string %>
 
-<% end %>
-<% unless global_flags_and_switches.empty? %>
+<% end %><% unless global_flags_and_switches.empty? %>
 GLOBAL OPTIONS
 <%= global_option_descriptions %>
-
 <% end %>
 COMMANDS
 <%= commands %>))

data/lib/gli/exceptions.rb

@@ -59,17 +59,42 @@ module GLI
     end
   end
 
-  class MissingRequiredArgumentsException < BadCommandLine
+  class BadCommandOptionsOrArguments < BadCommandLine
     # The command for which the argument was unknown
     attr_reader :command_in_context
-    # +message+:: the error message to show the user
-    # +command+:: the command we were using to parse command-specific options
     def initialize(message,command)
       super(message)
       @command_in_context = command
     end
   end
 
+  class MissingRequiredArgumentsException < BadCommandOptionsOrArguments
+    attr_reader :num_arguments_received, :range_arguments_accepted
+    def initialize(command,num_arguments_received,range_arguments_accepted)
+
+      @num_arguments_received   = num_arguments_received
+      @range_arguments_accepted = range_arguments_accepted
+
+      message = if @num_arguments_received < @range_arguments_accepted.min
+                  "#{command.name} expected at least #{@range_arguments_accepted.min} arguments, but was given only #{@num_arguments_received}"
+                elsif @range_arguments_accepted.min == 0
+                  "#{command.name} expected no arguments, but received #{@num_arguments_received}"
+                else
+                  "#{command.name} expected only #{@range_arguments_accepted.max} arguments, but received #{@num_arguments_received}"
+                end
+      super(message,command)
+    end
+
+  end
+
+  class MissingRequiredOptionsException < BadCommandOptionsOrArguments
+    def initialize(command,missing_required_options)
+      message = "#{command.name} requires these options: "
+      required_options = missing_required_options.sort.map(&:name).join(", ")
+      super(message + required_options,command)
+    end
+  end
+
   # Indicates the bad command line was an unknown command argument
   class UnknownCommandArgument < CommandException
   end

data/lib/gli/gli_option_parser.rb

@@ -98,12 +98,13 @@ module GLI
         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)
+        num_arguments_range = min_number_of_arguments..max_number_of_arguments
+        if !num_arguments_range.cover?(arguments.size)
+          raise MissingRequiredArgumentsException.new(command,arguments.size,num_arguments_range)
         end
+        #if arguments.size > max_number_of_arguments
+        #  raise TooManyArgumentsException.new(command,arguments.size,max_number_of_arguments)
+        #end
       end
 
       def verify_required_options!(flags, command, options)
@@ -114,10 +115,7 @@ module GLI
             ( options[option.name].kind_of?(Array) && options[option.name].empty? )
           }
         unless missing_required_options.empty?
-          missing_required_options.sort!
-          raise MissingRequiredArgumentsException.new(missing_required_options.map { |option|
-            "#{option.name} is required"
-          }.join(', '), command)
+          raise MissingRequiredOptionsException.new(command,missing_required_options)
         end
       end
     end

data/lib/gli/version.rb

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

data/test/integration/gli_powered_app_test.rb

@@ -29,7 +29,7 @@ class GLIPoweredAppTest < Minitest::Test
 
   def test_missing_args_exits_nonzero
     out, err, status = run_app("list", expect_failure: true, return_err_and_status: true)
-    assert_match /required_flag is required, required_flag2 is required/,err
+    assert_match /list requires these options: required_flag, required_flag2/,err
     assert_equal 64, status.exitstatus
     assert_match /COMMAND OPTIONS/, out
   end

data/test/unit/gli_test.rb

@@ -71,9 +71,8 @@ class GLITest < Minitest::Test
       end
     end
     assert_equal 64, @app.run(['foo']), "Expected exit status to be 64"
-    assert  @fake_stderr.contained?(/flag is required/), @fake_stderr.strings.inspect
-    assert  @fake_stderr.contained?(/other_flag is required/), @fake_stderr.strings.inspect
-    assert  @fake_stderr.contained?(/flag is required, other_flag is required/), @fake_stderr.strings.inspect
+    assert  @fake_stderr.contained?(/requires these options.*flag/), @fake_stderr.strings.inspect
+    assert  @fake_stderr.contained?(/requires these options.*other_flag/), @fake_stderr.strings.inspect
     assert !@called
 
     assert_equal 0, @app.run(['foo','--flag=bar','--other_flag=blah']), "Expected exit status to be 0 #{@fake_stderr.strings.join(',')}"
@@ -91,8 +90,7 @@ class GLITest < Minitest::Test
       end
     end
     assert_equal 64, @app.run(['foo']), "Expected exit status to be 64"
-    assert  @fake_stderr.contained?(/flag is required/), @fake_stderr.strings.inspect
-    assert  @fake_stderr.contained?(/flag is required/), @fake_stderr.strings.inspect
+    assert  @fake_stderr.contained?(/requires these options.*flag/), @fake_stderr.strings.inspect
     assert !@called
 
     assert_equal 0, @app.run(['foo','--flag=bar']), "Expected exit status to be 0 #{@fake_stderr.strings.join(',')}"
@@ -111,9 +109,8 @@ class GLITest < Minitest::Test
       end
     end
     assert_equal 64, @app.run(['foo']), "Expected exit status to be 64"
-    assert  @fake_stderr.contained?(/flag is required/), @fake_stderr.strings.inspect
-    assert  @fake_stderr.contained?(/other_flag is required/), @fake_stderr.strings.inspect
-    assert  @fake_stderr.contained?(/flag is required, other_flag is required/), @fake_stderr.strings.inspect
+    assert  @fake_stderr.contained?(/requires these options.*flag/), @fake_stderr.strings.inspect
+    assert  @fake_stderr.contained?(/requires these options.*other_flag/), @fake_stderr.strings.inspect
     assert !@called
 
     assert_equal 0, @app.run(['--flag=bar','--other_flag=blah','foo']), "Expected exit status to be 0 #{@fake_stderr.strings.join(',')}"
@@ -131,8 +128,7 @@ class GLITest < Minitest::Test
       end
     end
     assert_equal 64, @app.run(['foo']), "Expected exit status to be 64"
-    assert  @fake_stderr.contained?(/flag is required/), @fake_stderr.strings.inspect
-    assert  @fake_stderr.contained?(/flag is required/), @fake_stderr.strings.inspect
+    assert  @fake_stderr.contained?(/requires these options.*flag/), @fake_stderr.strings.inspect
     assert !@called
 
     assert_equal 0, @app.run(['--flag=bar','foo']), "Expected exit status to be 0 #{@fake_stderr.strings.join(',')}"

data/test/unit/subcommand_parsing_test.rb

@@ -78,8 +78,8 @@ class SubcommandParsingTest < Minitest::Test
     setup_app_with_subcommand_storing_results :normal, false, :strict
     @app.run(%w(-f global command -f flag -s subcomm  -f subflag))
     with_clue {
+      assert       @fake_stderr.contained?(/expected no arguments, but received 3/)
       assert_equal nil,@results[:command_name]
-      assert       @fake_stderr.contained?(/error: Too many arguments for command/)
     }
   end
 
@@ -123,8 +123,8 @@ class SubcommandParsingTest < Minitest::Test
       with_clue {
         assert_equal number_generated, @results[:number_of_args_give_to_action]
         assert_equal 0, @exit_code
-        assert !@fake_stderr.contained?(/Not enough arguments for command/)
-        assert !@fake_stderr.contained?(/Too many arguments for command/)
+        assert !@fake_stderr.contained?(/expected at least/)
+        assert !@fake_stderr.contained?(/expected only/)
       }
     end
   end
@@ -144,11 +144,15 @@ class SubcommandParsingTest < Minitest::Test
         if status == :not_enough then
           assert_nil @results[:number_of_args_give_to_action]
           assert_equal 64, @exit_code
-          assert @fake_stderr.contained?(/Not enough arguments for command/)
+          assert @fake_stderr.contained?(/expected at least #{number_required} arguments, but was given only #{number_generated}/)
         elsif status == :too_many then
           assert_nil @results[:number_of_args_give_to_action]
           assert_equal 64, @exit_code
-          assert @fake_stderr.contained?(/Too many arguments for command/)
+          if number_required == 0
+            assert @fake_stderr.contained?(/expected no arguments, but received #{number_generated}/)
+          else
+            assert @fake_stderr.contained?(/expected only #{number_required + number_optional} arguments, but received #{number_generated}/)
+          end
         else
           assert false
         end

data/test/unit/test_helper.rb

@@ -1,5 +1,6 @@
 require "minitest/autorun"
 require "gli"
+require "pp"
 
 module TestHelper
   class CLIApp

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.21.5
+  version: 2.22.0
 platform: ruby
 authors:
 - David Copeland
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Build command-suite CLI apps that are awesome.