cri 2.15.0 → 2.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 146523ca2691641e1484d4765e730e990d70d7d32b2ab5aaf9e6911e089fab8b
-  data.tar.gz: 9d77fc29f799f5a18d13089bd41c2c309bebfaa6620b63f07be57b354c5e33aa
+  metadata.gz: 13bfd2fd90ec81e8bcc39c154881b0e54ac05696fce5a237cf17d3204b543c9c
+  data.tar.gz: d14b7481ce82280b035fd0f20a78e62c417e47efe545d24bebf5302b1668fb3d
 SHA512:
-  metadata.gz: ccb3ac10e23d38eda1f739f6b33ac68540d9ab9895ac66870fba15f4b7c6ae2ff159c706627996bc8ee9f566fed0068a11b708df2747df77400070ad48ed0163
-  data.tar.gz: 0464fc3a9942c35b7f6477af69495a716d06abd6bf5c2197d955342b2d77f001b3a52b795ebe4b2a186f45eaea3cb5b13fe22458fed986706dae756a1092fd18
+  metadata.gz: 06ba0a5ab7632765e40bcf3b3245418f90e414b106fad162cbd4b59e50af3152bfed637da0fb9ed3b074922dcecb8e78d6d7501a849a6763d980be3030aee7b4
+  data.tar.gz: 273ef37de868f8b546d084b48073a8f13d67b7fb57f765b4764bf4305c5992e863b46e016e45fbf4888b48291dc017a1892d6394a564374402a0466cafdb1e41

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cri (2.15.0)
+    cri (2.15.1)
       colored (~> 1.2)
 
 GEM

data/NEWS.md

@@ -1,5 +1,15 @@
 # Cri News
 
+## 2.15.1
+
+Fixes:
+
+* Made -h/--help not fail when parameters are defined for the command that -h/--help is called on (#76, #78)
+
+Enhancements:
+
+* Made `#option` raise an error when unrecognised parameters are passed to it (#77) [Marc-André Lafortune]
+
 ## 2.15.0
 
 Features:

data/lib/cri/command.rb

@@ -345,10 +345,10 @@ module Cri
         handle_errors_while { parser.run }
         local_opts  = parser.options
         global_opts = parent_opts.merge(parser.options)
-        args = handle_errors_while { parser.arguments }
 
         # Handle options
         handle_options(local_opts)
+        args = handle_errors_while { parser.gen_argument_list }
       end
 
       # Execute

data/lib/cri/command_dsl.rb

@@ -152,17 +152,23 @@ module Cri
     #   be printed in the help output
     #
     # @return [void]
-    def option(short, long, desc, params = {}, &block)
+    def option(short, long, desc,
+               argument: :forbidden,
+               multiple: false,
+               hidden: false,
+               default: nil,
+               transform: nil,
+               &block)
       @command.option_definitions << Cri::OptionDefinition.new(
         short:     short&.to_s,
         long:      long&.to_s,
         desc:      desc,
-        argument:  params.fetch(:argument, :forbidden),
-        multiple:  params.fetch(:multiple, false),
+        argument:  argument,
+        multiple:  multiple,
+        hidden:    hidden,
+        default:   default,
+        transform: transform,
         block:     block,
-        hidden:    params.fetch(:hidden, false),
-        default:   params.fetch(:default, nil),
-        transform: params.fetch(:transform, nil),
       )
     end
     alias opt option

data/lib/cri/parser.rb

@@ -127,7 +127,7 @@ module Cri
 
     # @return [Cri::ArgumentList] The list of arguments that have already been
     #   parsed, excluding the -- separator.
-    def arguments
+    def gen_argument_list
       ArgumentList.new(@raw_arguments, @explicitly_no_params, @param_defns)
     end
 

data/lib/cri/version.rb

@@ -2,5 +2,5 @@
 
 module Cri
   # The current Cri version.
-  VERSION = '2.15.0'
+  VERSION = '2.15.1'
 end

data/test/test_command.rb

@@ -830,5 +830,33 @@ module Cri
         assert_equal('moo', cmd.name)
       end
     end
+
+    def test_required_args_with_dash_h
+      dsl = Cri::CommandDSL.new
+      dsl.instance_eval do
+        name        'moo'
+        usage       'dunno whatever'
+        summary     'does stuff'
+        description 'This command does a lot of stuff.'
+
+        param :foo
+
+        option :h, :help, 'show help' do
+          $helped = true
+          exit 0
+        end
+      end
+      command = dsl.command
+
+      $helped = false
+      out, err = capture_io_while do
+        assert_raises SystemExit do
+          command.run(['-h'])
+        end
+      end
+      assert $helped
+      assert_equal [], lines(out)
+      assert_equal [], lines(err)
+    end
   end
 end

data/test/test_command_dsl.rb

@@ -138,6 +138,14 @@ module Cri
       assert_equal expected_option_definitions, actual_option_definitions
     end
 
+    def test_raises_on_unrecognized_option
+      # Define
+      dsl = Cri::CommandDSL.new
+      assert_raises ArgumentError do
+        dsl.option :s, :long, 'desc', unrecognized: true
+      end
+    end
+
     def test_required_short_and_long
       # Define
       dsl = Cri::CommandDSL.new

data/test/test_parser.rb

@@ -11,7 +11,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({}, parser.options)
-      assert_equal(%w[foo bar baz], parser.arguments.to_a)
+      assert_equal(%w[foo bar baz], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_invalid_option
@@ -43,7 +43,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(parser.options[:aaa])
-      assert_equal(%w[foo bar], parser.arguments.to_a)
+      assert_equal(%w[foo bar], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_long_valueful_option
@@ -55,7 +55,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ aaa: 'xxx' }, parser.options)
-      assert_equal(%w[foo bar], parser.arguments.to_a)
+      assert_equal(%w[foo bar], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_long_valueful_equalsign_option
@@ -67,7 +67,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ aaa: 'xxx' }, parser.options)
-      assert_equal(%w[foo bar], parser.arguments.to_a)
+      assert_equal(%w[foo bar], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_long_valueful_option_with_missing_value
@@ -102,7 +102,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(parser.options[:aaa])
-      assert_equal(['foo'], parser.arguments.to_a)
+      assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_long_valueful_option_with_optional_value
@@ -114,7 +114,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ aaa: 'xxx' }, parser.options)
-      assert_equal(['foo'], parser.arguments.to_a)
+      assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_long_valueless_option_with_optional_value_and_more_options
@@ -130,7 +130,7 @@ module Cri
       assert(parser.options[:aaa])
       assert(parser.options[:bbb])
       assert(parser.options[:ccc])
-      assert_equal(['foo'], parser.arguments.to_a)
+      assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_short_valueless_options
@@ -142,7 +142,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(parser.options[:aaa])
-      assert_equal(%w[foo bar], parser.arguments.to_a)
+      assert_equal(%w[foo bar], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_short_valueful_option_with_missing_value
@@ -169,7 +169,7 @@ module Cri
       assert(parser.options[:aaa])
       assert(parser.options[:bbb])
       assert(parser.options[:ccc])
-      assert_equal(%w[foo bar], parser.arguments.to_a)
+      assert_equal(%w[foo bar], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_short_combined_valueful_options_with_missing_value
@@ -185,7 +185,7 @@ module Cri
       assert_equal('bar', parser.options[:aaa])
       assert(parser.options[:bbb])
       assert(parser.options[:ccc])
-      assert_equal(%w[foo qux], parser.arguments.to_a)
+      assert_equal(%w[foo qux], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_two_short_valueful_options
@@ -209,7 +209,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(parser.options[:aaa])
-      assert_equal(['foo'], parser.arguments.to_a)
+      assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_short_valueful_option_with_optional_value
@@ -221,7 +221,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ aaa: 'xxx' }, parser.options)
-      assert_equal(['foo'], parser.arguments.to_a)
+      assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_short_valueless_option_with_optional_value_and_more_options
@@ -237,7 +237,7 @@ module Cri
       assert(parser.options[:aaa])
       assert(parser.options[:bbb])
       assert(parser.options[:ccc])
-      assert_equal(['foo'], parser.arguments.to_a)
+      assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_single_hyphen
@@ -247,7 +247,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({}, parser.options)
-      assert_equal(['foo', '-', 'bar'], parser.arguments.to_a)
+      assert_equal(['foo', '-', 'bar'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_end_marker
@@ -257,7 +257,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({}, parser.options)
-      assert_equal(['foo', 'bar', '-x', '--yyy', '-abc'], parser.arguments.to_a)
+      assert_equal(['foo', 'bar', '-x', '--yyy', '-abc'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_end_marker_between_option_key_and_value
@@ -293,7 +293,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'donkey' }, parser.options)
-      assert_equal(['foo'], parser.arguments.to_a)
+      assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_default_required_no_value
@@ -316,7 +316,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'giraffe' }, parser.options)
-      assert_equal(['foo'], parser.arguments.to_a)
+      assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_default_optional_unspecified
@@ -328,7 +328,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'donkey' }, parser.options)
-      assert_equal(['foo'], parser.arguments.to_a)
+      assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_default_optional_no_value
@@ -340,7 +340,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'donkey' }, parser.options)
-      assert_equal(['foo'], parser.arguments.to_a)
+      assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_default_optional_value
@@ -352,7 +352,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'giraffe' }, parser.options)
-      assert_equal(['foo'], parser.arguments.to_a)
+      assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_default_optional_value_and_arg
@@ -364,7 +364,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'gi' }, parser.options)
-      assert_equal(%w[foo raffe], parser.arguments.to_a)
+      assert_equal(%w[foo raffe], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_combined_required_options
@@ -378,7 +378,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ aaa: true, bbb: 'xxx', ccc: 'yyy' }, parser.options)
-      assert_equal(%w[foo zzz], parser.arguments.to_a)
+      assert_equal(%w[foo zzz], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_combined_optional_options
@@ -392,7 +392,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ aaa: true, bbb: 'xxx', ccc: 'yyy' }, parser.options)
-      assert_equal(%w[foo zzz], parser.arguments.to_a)
+      assert_equal(%w[foo zzz], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_combined_optional_options_with_missing_value
@@ -406,7 +406,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ aaa: true, bbb: 'xxx', ccc: 'c default' }, parser.options)
-      assert_equal(%w[foo], parser.arguments.to_a)
+      assert_equal(%w[foo], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_transform_proc
@@ -418,7 +418,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ port: 123 }, parser.options)
-      assert_equal([], parser.arguments.to_a)
+      assert_equal([], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_transform_method
@@ -430,7 +430,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ port: 123 }, parser.options)
-      assert_equal([], parser.arguments.to_a)
+      assert_equal([], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_transform_object
@@ -448,7 +448,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ port: 123 }, parser.options)
-      assert_equal([], parser.arguments.to_a)
+      assert_equal([], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_transform_default
@@ -467,7 +467,7 @@ module Cri
       parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ port: 8080 }, parser.options)
-      assert_equal([], parser.arguments.to_a)
+      assert_equal([], parser.gen_argument_list.to_a)
     end
 
     def test_parse_with_transform_exception
@@ -490,8 +490,8 @@ module Cri
 
       parser = Cri::Parser.new(input, [], param_defns, false).run
       assert_equal({}, parser.options)
-      assert_equal('localhost', parser.arguments[0])
-      assert_equal('localhost', parser.arguments[:host])
+      assert_equal('localhost', parser.gen_argument_list[0])
+      assert_equal('localhost', parser.gen_argument_list[:host])
     end
 
     def test_parse_with_param_defns_too_few_args
@@ -502,7 +502,7 @@ module Cri
 
       parser = Cri::Parser.new(input, [], param_defns, false).run
       exception = assert_raises(Cri::ArgumentList::ArgumentCountMismatchError) do
-        parser.arguments
+        parser.gen_argument_list
       end
       assert_equal('incorrect number of arguments given: expected 1, but got 0', exception.message)
     end
@@ -515,7 +515,7 @@ module Cri
 
       parser = Cri::Parser.new(input, [], param_defns, false).run
       exception = assert_raises(Cri::ArgumentList::ArgumentCountMismatchError) do
-        parser.arguments
+        parser.gen_argument_list
       end
       assert_equal('incorrect number of arguments given: expected 1, but got 2', exception.message)
     end
@@ -529,7 +529,7 @@ module Cri
       parser = Cri::Parser.new(input, [], param_defns, false).run
 
       exception = assert_raises(ArgumentError) do
-        parser.arguments['oink']
+        parser.gen_argument_list['oink']
       end
       assert_equal('argument lists can be indexed using a Symbol or an Integer, but not a String', exception.message)
     end
@@ -543,10 +543,10 @@ module Cri
 
       parser = Cri::Parser.new(input, [], param_defns, false).run
       assert_equal({}, parser.options)
-      assert_equal('localhost', parser.arguments[0])
-      assert_equal('localhost', parser.arguments[:source])
-      assert_equal('example.com', parser.arguments[1])
-      assert_equal('example.com', parser.arguments[:target])
+      assert_equal('localhost', parser.gen_argument_list[0])
+      assert_equal('localhost', parser.gen_argument_list[:source])
+      assert_equal('example.com', parser.gen_argument_list[1])
+      assert_equal('example.com', parser.gen_argument_list[:target])
     end
 
     def make_opt_defn(hash)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cri
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.15.1
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-26 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored