cri 2.15.10 → 2.15.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ac76773abd662b4cdd83c22ade38073436ae16afeef75ad95060578b71c23ea
-  data.tar.gz: 4386555ef8c6d3c27f77205120291efc1898be80973550a81271a89ddaef8495
+  metadata.gz: 823a030106960498adbfd77e19f3ef8b30fdfc6b2b592604ced4c875c8ced9f4
+  data.tar.gz: 8663621247fffc1be92d538c7cc5d594522e2a350a126236abfe761a15973a5c
 SHA512:
-  metadata.gz: f096a5583428ecdca24ad0a800488cb07269d181bc853c6872d34caf7167b6d2d42fb0c2851da24eee4ed4fd1d0ed9e83aa2c75ed644275cb88ac081f0950ed7
-  data.tar.gz: 02645607f896fcc9ebf2f432d16f3b1b37f8688e4eca21d288bfa0e781c4e0cd2aa5125172ffde92fdec2a14f18220f93e454feb57449f88f7a95f1a0d2b9ef0
+  metadata.gz: 5a3c3038f8629238aa071a1d7dd94aee5e7f3e85df7fe097a67176c0300c2a69a3dc576da76354056e8d366ca5b6bae0806b5f0cea3f2854c6c88cafb0150bb3
+  data.tar.gz: 7d810e46680ee4802db459510635d2c9857aa400794e09d5d43a903e6ffc0edee0221ce17906f216f543892b9f5ac2f0eb71fa447b1771a9e8f12ac159d5bda8

data/Gemfile

@@ -9,4 +9,6 @@ gem 'm', '~> 1.5'
 gem 'minitest'
 gem 'rake'
 gem 'rubocop'
+gem 'rubocop-minitest', '~> 0.10.2'
+gem 'rubocop-rake', '~> 0.5.1'
 gem 'yard'

data/Gemfile.lock

@@ -1,39 +1,48 @@
 PATH
   remote: .
   specs:
-    cri (2.15.10)
+    cri (2.15.11)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.1)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
-    docile (1.3.2)
-    jaro_winkler (1.5.4)
-    json (2.3.0)
+    docile (1.3.4)
+    json (2.5.1)
     m (1.5.1)
       method_source (>= 0.6.7)
       rake (>= 0.9.2.2)
-    method_source (0.9.2)
-    minitest (5.14.0)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.1)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rubocop (1.7.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-minitest (0.10.2)
+      rubocop (>= 0.87, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    ruby-progressbar (1.11.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -43,13 +52,13 @@ GEM
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (1.0.1)
-    tins (1.24.0)
+    tins (1.26.0)
       sync
-    unicode-display_width (1.6.1)
-    yard (0.9.24)
+    unicode-display_width (1.7.0)
+    yard (0.9.26)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   coveralls
@@ -58,7 +67,9 @@ DEPENDENCIES
   minitest
   rake
   rubocop
+  rubocop-minitest (~> 0.10.2)
+  rubocop-rake (~> 0.5.1)
   yard
 
 BUNDLED WITH
-   2.1.2
+   2.2.3

data/NEWS.md

@@ -1,5 +1,15 @@
 # Cri News
 
+## 2.15.11
+
+Fixes:
+
+- Added support for Ruby 3.0 (#111)
+
+Changes:
+
+- Dropped support for Ruby 2.3 and 2.4 (#112)
+
 ## 2.15.10
 
 Fixes:

data/README.md

@@ -12,14 +12,14 @@ nested commands.
 
 ## Requirements
 
-Cri requires Ruby 2.3 or newer.
+Cri requires Ruby 2.5 or newer (including Ruby 3.x).
 
 ## Compatibility policy
 
 Cri is guaranteed to be supported on any [officially supported Ruby version](https://www.ruby-lang.org/en/downloads/branches/), as well as the version of Ruby that comes by default on
 
-* the last two [Ubuntu LTS releases](https://wiki.ubuntu.com/Releases)
-* the last two major [macOS releases](https://en.wikipedia.org/wiki/MacOS_version_history)
+- the last two [Ubuntu LTS releases](https://wiki.ubuntu.com/Releases)
+- the last two major [macOS releases](https://en.wikipedia.org/wiki/MacOS_version_history)
 
 ## Usage
 
@@ -119,101 +119,101 @@ The most generic way of definition an option is using either `#option` or `#opt`
 2. a long option name
 3. a description
 4. optional extra parameters
-    * `argument:` (default: `:forbidden`)
-    * `transform:`
-    * `default:`
-    * `multiple:` (default: `false`)
+   - `argument:` (default: `:forbidden`)
+   - `transform:`
+   - `default:`
+   - `multiple:` (default: `false`)
 5. optionally, a block
 
 In more detail:
 
-* The short option name is a symbol containing one character, to be used in single-dash options, e.g. `:f` (corresponds to `-f`). The long option name is a symbol containing a string, to be used in double-dash options, e.g. `:force` (corresponds to `--force`). Either the short or the long option name can be nil, but not both.
+- The short option name is a symbol containing one character, to be used in single-dash options, e.g. `:f` (corresponds to `-f`). The long option name is a symbol containing a string, to be used in double-dash options, e.g. `:force` (corresponds to `--force`). Either the short or the long option name can be nil, but not both.
 
-* The description is a short, one-line text that shows up in the command’s help. For example, the `-v`/`--version` option might have the description `show version information and quit`.
+- The description is a short, one-line text that shows up in the command’s help. For example, the `-v`/`--version` option might have the description `show version information and quit`.
 
-* The extra parameters, `argument:`, `multiple:`, `default:`, and `transform:`, are described in the sections below.
+- The extra parameters, `argument:`, `multiple:`, `default:`, and `transform:`, are described in the sections below.
 
-* The block, if given, will be executed when the option is found. The arguments to the block are the option value (`true` in case the option does not have an argument) and the command.
+- The block, if given, will be executed when the option is found. The arguments to the block are the option value (`true` in case the option does not have an argument) and the command.
 
 There are several convenience methods that are alternatives to `#option`/`#opt`:
 
-* `#flag` sets `argument:` to `:forbidden`
-* (**deprecated**) `#required` sets `argument:` to `:required` -- deprecated because `#required` suggests that the option is required, wich is incorrect; the _argument_ is required.)
-* (**deprecated**) `#optional` sets `argument:` to `:optional` -- deprecated because `#optional` looks too similar to `#option`.
+- `#flag` sets `argument:` to `:forbidden`
+- (**deprecated**) `#required` sets `argument:` to `:required` -- deprecated because `#required` suggests that the option is required, wich is incorrect; the _argument_ is required.)
+- (**deprecated**) `#optional` sets `argument:` to `:optional` -- deprecated because `#optional` looks too similar to `#option`.
 
 #### Forbidden, required, and optional arguments (`argument:`)
 
 The `:argument` parameter can be set to `:forbidden`, `:required`, or `:optional`.
 
-*   `:forbidden` means that when the option is present, the value will be set to `true`, and `false` otherwise. For example:
+- `:forbidden` means that when the option is present, the value will be set to `true`, and `false` otherwise. For example:
 
-    ```ruby
-    option :f, :force, 'push with force', argument: :forbidden
+  ```ruby
+  option :f, :force, 'push with force', argument: :forbidden
 
-    run do |opts, args, cmd|
-      puts "Force? #{opts[:force]}"
-    end
-    ```
+  run do |opts, args, cmd|
+    puts "Force? #{opts[:force]}"
+  end
+  ```
 
-    ```sh
-    % ./push mypackage.zip
-    Force? false
+  ```sh
+  % ./push mypackage.zip
+  Force? false
 
-    % ./push --force mypackage.zip
-    Force? true
-    ```
+  % ./push --force mypackage.zip
+  Force? true
+  ```
 
-    `:argument` is set to `:forbidden` by default.
+  `:argument` is set to `:forbidden` by default.
 
-*   `:required` means that the option must be followed by an argument, which will then be treated as the value for the option. It does not mean that the option itself is required. For example:
+- `:required` means that the option must be followed by an argument, which will then be treated as the value for the option. It does not mean that the option itself is required. For example:
 
-    ```ruby
-    option :o, :output, 'specify output file', argument: :required
-    option :f, :fast, 'fetch faster', argument: :forbidden
+  ```ruby
+  option :o, :output, 'specify output file', argument: :required
+  option :f, :fast, 'fetch faster', argument: :forbidden
 
-    run do |opts, args, cmd|
-      puts "Output file: #{opts[:output]}"
-    end
-    ```
+  run do |opts, args, cmd|
+    puts "Output file: #{opts[:output]}"
+  end
+  ```
 
-    ```sh
-    % ./fetch http://example.com/source.zip
-    Output file: nil
+  ```sh
+  % ./fetch http://example.com/source.zip
+  Output file: nil
 
-    % ./fetch --output example.zip http://example.com/source.zip
-    Output file: example.zip
+  % ./fetch --output example.zip http://example.com/source.zip
+  Output file: example.zip
 
-    % ./fetch http://example.com/source.zip --output
-    fetch: option requires an argument -- output
+  % ./fetch http://example.com/source.zip --output
+  fetch: option requires an argument -- output
 
-    % ./fetch --output --fast http://example.com/source.zip
-    fetch: option requires an argument -- output
-    ```
+  % ./fetch --output --fast http://example.com/source.zip
+  fetch: option requires an argument -- output
+  ```
 
-*   `:optional` means that the option can be followed by an argument. If it is, then the argument is treated as the value for the option; if it isn’t, the value for the option will be `true`. For example:
+- `:optional` means that the option can be followed by an argument. If it is, then the argument is treated as the value for the option; if it isn’t, the value for the option will be `true`. For example:
 
-    ```ruby
-    option :o, :output, 'specify output file', argument: :optional
-    option :f, :fast, 'fetch faster', argument: :forbidden
+  ```ruby
+  option :o, :output, 'specify output file', argument: :optional
+  option :f, :fast, 'fetch faster', argument: :forbidden
 
-    run do |opts, args, cmd|
-      puts "Output file: #{opts[:output]}"
-    end
-    ```
+  run do |opts, args, cmd|
+    puts "Output file: #{opts[:output]}"
+  end
+  ```
 
-    ```sh
-    % ./fetch http://example.com/source.zip
-    Output file: nil
+  ```sh
+  % ./fetch http://example.com/source.zip
+  Output file: nil
 
-    % ./fetch --output example.zip http://example.com/source.zip
-    Output file: example.zip
+  % ./fetch --output example.zip http://example.com/source.zip
+  Output file: example.zip
 
-    % ./fetch http://example.com/source.zip --output
-    Output file: true
+  % ./fetch http://example.com/source.zip --output
+  Output file: true
 
-    % ./fetch --output --fast http://example.com/source.zip
-    Output file: true
-    ```
+  % ./fetch --output --fast http://example.com/source.zip
+  Output file: true
+  ```
 
 #### Transforming options (`transform:`)
 
@@ -374,7 +374,7 @@ As with options, parameter definitions take `transform:`, which can be used for
 param :port, transform: method(:Integer)
 ```
 
-(*Why the distinction between argument and parameter?* A parameter is a name, e.g. `filename`, while an argument is a value for a parameter, e.g. `kitten.jpg`.)
+(_Why the distinction between argument and parameter?_ A parameter is a name, e.g. `filename`, while an argument is a value for a parameter, e.g. `kitten.jpg`.)
 
 ### Allowing arbitrary arguments
 
@@ -584,10 +584,10 @@ cmd = Cri::Command.load_file('commands/check.rb', infer_name: true)
 
 ## Contributors
 
-* Bart Mesuere
-* Ken Coar
-* Tim Sharpe
-* Toon Willems
+- Bart Mesuere
+- Ken Coar
+- Tim Sharpe
+- Toon Willems
 
 Thanks for Lee “injekt” Jarvis for [Slop](https://github.com/injekt/slop),
 which has inspired the design of Cri 2.0.

data/cri.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.files = Dir['[A-Z]*'] + Dir['{lib,test}/**/*'] + ['cri.gemspec']
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '~> 2.3'
+  s.required_ruby_version = '>= 2.5'
 
   s.rdoc_options     = ['--main', 'README.md']
   s.extra_rdoc_files = ['LICENSE', 'README.md', 'NEWS.md']

data/lib/cri/argument_list.rb

@@ -6,12 +6,7 @@ module Cri
     # Error that will be raised when an incorrect number of arguments is given.
     class ArgumentCountMismatchError < Cri::Error
       def initialize(expected_count, actual_count)
-        @expected_count = expected_count
-        @actual_count = actual_count
-      end
-
-      def message
-        "incorrect number of arguments given: expected #{@expected_count}, but got #{@actual_count}"
+        super("incorrect number of arguments given: expected #{expected_count}, but got #{actual_count}")
       end
     end
 

data/lib/cri/command.rb

@@ -46,6 +46,8 @@ module Cri
     # @api private
     class CriExitException < StandardError
       def initialize(is_error:)
+        super('exit requested')
+
         @is_error = is_error
       end
 

data/lib/cri/command_dsl.rb

@@ -8,12 +8,7 @@ module Cri
     # already declared as taken no params.
     class AlreadySpecifiedAsNoParams < Cri::Error
       def initialize(param, command)
-        @param = param
-        @command = command
-      end
-
-      def message
-        "Attempted to specify a parameter #{@param.inspect} to the command #{@command.name.inspect}, which is already specified as taking no params. Suggestion: remove the #no_params call."
+        super("Attempted to specify a parameter #{param.inspect} to the command #{command.name.inspect}, which is already specified as taking no params. Suggestion: remove the #no_params call.")
       end
     end
 
@@ -21,11 +16,7 @@ module Cri
     # parameters, when the command is already declared with parameters.
     class AlreadySpecifiedWithParams < Cri::Error
       def initialize(command)
-        @command = command
-      end
-
-      def message
-        "Attempted to declare the command #{@command.name.inspect} as taking no parameters, but some parameters are already declared for this command. Suggestion: remove the #no_params call."
+        super("Attempted to declare the command #{command.name.inspect} as taking no parameters, but some parameters are already declared for this command. Suggestion: remove the #no_params call.")
       end
     end
 

data/lib/cri/parser.rb

@@ -14,12 +14,10 @@ module Cri
       attr_reader :value
 
       def initialize(definition, value)
-        @definition = definition
-        @value      = value
-      end
+        super("invalid value #{value.inspect} for #{definition.formatted_name} option")
 
-      def message
-        "invalid value #{value.inspect} for #{@definition.formatted_name} option"
+        @value = value
+        @definition = definition
       end
     end
 

data/lib/cri/version.rb

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

data/test/test_parser.rb

@@ -443,7 +443,7 @@ module Cri
       input       = %w[localhost]
       param_defns = [
         { name: 'host', transform: nil },
-      ].map { |hash| Cri::ParamDefinition.new(hash) }
+      ].map { |hash| Cri::ParamDefinition.new(**hash) }
 
       parser = Cri::Parser.new(input, [], param_defns, false).run
       assert_equal({}, parser.options)
@@ -455,7 +455,7 @@ module Cri
       input       = []
       param_defns = [
         { name: 'host', transform: nil },
-      ].map { |hash| Cri::ParamDefinition.new(hash) }
+      ].map { |hash| Cri::ParamDefinition.new(**hash) }
 
       parser = Cri::Parser.new(input, [], param_defns, false).run
       exception = assert_raises(Cri::ArgumentList::ArgumentCountMismatchError) do
@@ -468,7 +468,7 @@ module Cri
       input       = %w[localhost oink]
       param_defns = [
         { name: 'host', transform: nil },
-      ].map { |hash| Cri::ParamDefinition.new(hash) }
+      ].map { |hash| Cri::ParamDefinition.new(**hash) }
 
       parser = Cri::Parser.new(input, [], param_defns, false).run
       exception = assert_raises(Cri::ArgumentList::ArgumentCountMismatchError) do
@@ -481,7 +481,7 @@ module Cri
       input       = %w[localhost]
       param_defns = [
         { name: 'host', transform: nil },
-      ].map { |hash| Cri::ParamDefinition.new(hash) }
+      ].map { |hash| Cri::ParamDefinition.new(**hash) }
 
       parser = Cri::Parser.new(input, [], param_defns, false).run
 
@@ -496,7 +496,7 @@ module Cri
       param_defns = [
         { name: 'source', transform: nil },
         { name: 'target', transform: nil },
-      ].map { |hash| Cri::ParamDefinition.new(hash) }
+      ].map { |hash| Cri::ParamDefinition.new(**hash) }
 
       parser = Cri::Parser.new(input, [], param_defns, false).run
       assert_equal({}, parser.options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cri
 version: !ruby/object:Gem::Version
-  version: 2.15.10
+  version: 2.15.11
 platform: ruby
 authors:
 - Denis Defreyne
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies: []
 description: Cri allows building easy-to-use command-line interfaces with support
   for subcommands.
@@ -57,7 +57,7 @@ homepage: https://github.com/ddfreyne/cri
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -65,17 +65,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: a library for building easy-to-use command-line tools
 test_files: []