cri 2.14.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4990c5f7f5168cb66f3e434512976721a3dc2b1e93b0a88306c58106aacb21c
-  data.tar.gz: 6866a5179a3c338c905e5d50cb89391b12608e7d0d246def19a3e0e5971fa6f8
+  metadata.gz: 146523ca2691641e1484d4765e730e990d70d7d32b2ab5aaf9e6911e089fab8b
+  data.tar.gz: 9d77fc29f799f5a18d13089bd41c2c309bebfaa6620b63f07be57b354c5e33aa
 SHA512:
-  metadata.gz: cd21b56d57ce4356a19a4875ada15f13c7019f739ea7267a104610c3ad33557dff506c589e4b70929d20d77a938d2fb71e963ca5b2a908ad54a7ac6e89dea4e1
-  data.tar.gz: b7dfaf7409934b132cc640ca21a0128af76ea1835986627ea68d83922233fe6b14b8e8a296143ed6d545beb7c408ea028cc8353aca8d2b4371171d5c01ba02cb
+  metadata.gz: ccb3ac10e23d38eda1f739f6b33ac68540d9ab9895ac66870fba15f4b7c6ae2ff159c706627996bc8ee9f566fed0068a11b708df2747df77400070ad48ed0163
+  data.tar.gz: 0464fc3a9942c35b7f6477af69495a716d06abd6bf5c2197d955342b2d77f001b3a52b795ebe4b2a186f45eaea3cb5b13fe22458fed986706dae756a1092fd18

data/CODE_OF_CONDUCT.md

@@ -2,11 +2,17 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment include:
+Examples of behavior that contributes to creating a positive environment
+include:
 
 * Using welcoming and inclusive language
 * Being respectful of differing viewpoints and experiences
@@ -16,31 +22,53 @@ Examples of behavior that contributes to creating a positive environment include
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Our Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at denis+cri-coc@stoneship.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at denis+coc@denis.ws. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -4,7 +4,6 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'asciidoctor'
 gem 'coveralls'
 gem 'minitest'
 gem 'rake'

data/Gemfile.lock

@@ -1,13 +1,12 @@
 PATH
   remote: .
   specs:
-    cri (2.13.0)
+    cri (2.15.0)
       colored (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    asciidoctor (1.5.7.1)
     ast (2.4.0)
     colored (1.2)
     coveralls (0.8.22)
@@ -51,7 +50,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  asciidoctor
   bundler (~> 1.6)
   coveralls
   cri!

data/NEWS.md

@@ -1,5 +1,11 @@
 # Cri News
 
+## 2.15.0
+
+Features:
+
+* Added support for parameter transformation (#72)
+
 ## 2.14.0
 
 Features:

data/README.md

@@ -281,6 +281,12 @@ Resetting…
 
 A future version of Cri will likely make `#no_params` the default behavior.
 
+As with options, parameter definitions take `transform:`, which can be used for transforming and validating arguments:
+
+```ruby
+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`.)
 
 ### The run block

data/Rakefile

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# encoing: utf-8
-
 require 'rake/testtask'
 require 'rubocop/rake_task'
 require 'yard'
@@ -10,7 +8,7 @@ YARD::Rake::YardocTask.new(:doc) do |yard|
   yard.files   = Dir['lib/**/*.rb']
   yard.options = [
     '--markup',        'markdown',
-    '--readme',        'README.adoc',
+    '--readme',        'README.md',
     '--files',         'NEWS.md,LICENSE',
     '--output-dir',    'doc/yardoc'
   ]
@@ -21,9 +19,7 @@ Rake::TestTask.new(:test_unit) do |t|
   t.libs << 'test'
 end
 
-RuboCop::RakeTask.new(:test_style) do |task|
-  task.options = %w[--display-cop-names --format simple]
-end
+RuboCop::RakeTask.new(:test_style)
 
 task test: %i[test_unit test_style]
 

data/lib/cri.rb

@@ -30,6 +30,6 @@ require_relative 'cri/command_dsl'
 require_relative 'cri/command_runner'
 require_relative 'cri/help_renderer'
 require_relative 'cri/option_definition'
-require_relative 'cri/option_parser'
+require_relative 'cri/parser'
 require_relative 'cri/param_definition'
 require_relative 'cri/platform'

data/lib/cri/argument_list.rb

@@ -54,20 +54,25 @@ module Cri
     end
 
     def load
-      @arguments_array = @raw_arguments.reject { |a| a == '--' }.freeze
+      @arguments_array = []
       @arguments_hash = {}
 
+      arguments_array = @raw_arguments.reject { |a| a == '--' }.freeze
+
       if !@explicitly_no_params && @param_defns.empty?
         # No parameters defined; ignore
+        @arguments_array = arguments_array
         return
       end
 
-      if @arguments_array.size != @param_defns.size
-        raise ArgumentCountMismatchError.new(@param_defns.size, @arguments_array.size)
+      if arguments_array.size != @param_defns.size
+        raise ArgumentCountMismatchError.new(@param_defns.size, arguments_array.size)
       end
 
-      @arguments_array.zip(@param_defns).each do |(arg, param_defn)|
+      arguments_array.zip(@param_defns).each do |(arg, param_defn)|
+        arg = param_defn.transform ? param_defn.transform.call(arg) : arg
         @arguments_hash[param_defn.name.to_sym] = arg
+        @arguments_array << arg
       end
     end
   end

data/lib/cri/command.rb

@@ -9,7 +9,7 @@ module Cri
     # command, is found.
     #
     # @api private
-    class OptionParserPartitioningDelegate
+    class ParserPartitioningDelegate
       # Returns the last parsed argument, which, in this case, will be the
       # first argument, which will be either nil or the command name.
       #
@@ -18,25 +18,25 @@ module Cri
 
       # Called when an option is parsed.
       #
-      # @param [Symbol] key The option key (derived from the long format)
+      # @param [Symbol] _key The option key (derived from the long format)
       #
-      # @param value The option value
+      # @param _value The option value
       #
-      # @param [Cri::OptionParser] option_parser The option parser
+      # @param [Cri::Parser] _parser The option parser
       #
       # @return [void]
-      def option_added(_key, _value, _option_parser); end
+      def option_added(_key, _value, _parser); end
 
       # Called when an argument is parsed.
       #
       # @param [String] argument The argument
       #
-      # @param [Cri::OptionParser] option_parser The option parser
+      # @param [Cri::Parser] parser The option parser
       #
       # @return [void]
-      def argument_added(argument, option_parser)
+      def argument_added(argument, parser)
         @last_argument = argument
-        option_parser.stop
+        parser.stop
       end
     end
 
@@ -336,7 +336,7 @@ module Cri
         global_opts = parent_opts
       else
         # Parse
-        parser = Cri::OptionParser.new(
+        parser = Cri::Parser.new(
           opts_and_args,
           global_option_definitions,
           parameter_definitions,
@@ -395,8 +395,8 @@ module Cri
       return [{}, opts_and_args.first, opts_and_args] if all_opts_as_args?
 
       # Parse
-      delegate = Cri::Command::OptionParserPartitioningDelegate.new
-      parser = Cri::OptionParser.new(
+      delegate = Cri::Command::ParserPartitioningDelegate.new
+      parser = Cri::Parser.new(
         opts_and_args,
         global_option_definitions,
         parameter_definitions,
@@ -415,13 +415,13 @@ module Cri
 
     def handle_errors_while
       yield
-    rescue Cri::OptionParser::IllegalOptionError => e
+    rescue Cri::Parser::IllegalOptionError => e
       warn "#{name}: unrecognised option -- #{e}"
       raise CriExitException.new(is_error: true)
-    rescue Cri::OptionParser::OptionRequiresAnArgumentError => e
+    rescue Cri::Parser::OptionRequiresAnArgumentError => e
       warn "#{name}: option requires an argument -- #{e}"
       raise CriExitException.new(is_error: true)
-    rescue Cri::OptionParser::IllegalOptionValueError => e
+    rescue Cri::Parser::IllegalOptionValueError => e
       warn "#{name}: #{e.message}"
       raise CriExitException.new(is_error: true)
     rescue Cri::ArgumentList::ArgumentCountMismatchError => e

data/lib/cri/command_dsl.rb

@@ -126,7 +126,7 @@ module Cri
     end
 
     # Skips option parsing for the command. Allows option-like arguments to be
-    # passed in, avoiding the {Cri::OptionParser} validation.
+    # passed in, avoiding the {Cri::Parser} validation.
     #
     # @return [void]
     def skip_option_parsing
@@ -170,12 +170,15 @@ module Cri
     # Defines a new parameter for the command.
     #
     # @param [Symbol] name The name of the parameter
-    def param(name)
+    def param(name, transform: nil)
       if @command.explicitly_no_params?
         raise AlreadySpecifiedAsNoParams.new(name, @command)
       end
 
-      @command.parameter_definitions << Cri::ParamDefinition.new(name: name)
+      @command.parameter_definitions << Cri::ParamDefinition.new(
+        name: name,
+        transform: transform,
+      )
     end
 
     def no_params
@@ -205,7 +208,7 @@ module Cri
     #
     # @deprecated
     #
-    # @see {#option}
+    # @see #option
     def required(short, long, desc, params = {}, &block)
       params = params.merge(argument: :required)
       option(short, long, desc, params, &block)
@@ -228,7 +231,7 @@ module Cri
     #
     # @return [void]
     #
-    # @see {#option}
+    # @see #option
     def flag(short, long, desc, params = {}, &block)
       params = params.merge(argument: :forbidden)
       option(short, long, desc, params, &block)
@@ -254,7 +257,7 @@ module Cri
     #
     # @deprecated
     #
-    # @see {#option}
+    # @see #option
     def optional(short, long, desc, params = {}, &block)
       params = params.merge(argument: :optional)
       option(short, long, desc, params, &block)

data/lib/cri/param_definition.rb

@@ -4,9 +4,11 @@ module Cri
   # The definition of a parameter.
   class ParamDefinition
     attr_reader :name
+    attr_reader :transform
 
-    def initialize(name:)
+    def initialize(name:, transform:)
       @name = name
+      @transform = transform
     end
   end
 end

data/lib/cri/{option_parser.rb → parser.rb}

@@ -1,60 +1,8 @@
 # frozen_string_literal: true
 
 module Cri
-  # Cri::OptionParser is used for parsing command-line options.
-  #
-  # Option definitions are hashes with the keys `:short`, `:long` and
-  # `:argument` (optionally `:description` but this is not used by the
-  # option parser, only by the help generator). `:short` is the short,
-  # one-character option, without the `-` prefix. `:long` is the long,
-  # multi-character option, without the `--` prefix. `:argument` can be
-  # :required (if an argument should be provided to the option), :optional
-  # (if an argument may be provided) or :forbidden (if an argument should
-  # not be provided).
-  #
-  # A sample array of definition hashes could look like this:
-  #
-  #     [
-  #       { :short => 'a', :long => 'all',  :argument => :forbidden, :multiple => true },
-  #       { :short => 'p', :long => 'port', :argument => :required, :multiple => false },
-  #     ]
-  #
-  # For example, the following command-line options (which should not be
-  # passed as a string, but as an array of strings):
-  #
-  #     foo -xyz -a hiss -s -m please --level 50 --father=ani -n luke squeak
-  #
-  # with the following option definitions:
-  #
-  #     [
-  #       { :short => 'x', :long => 'xxx',    :argument => :forbidden },
-  #       { :short => 'y', :long => 'yyy',    :argument => :forbidden },
-  #       { :short => 'z', :long => 'zzz',    :argument => :forbidden },
-  #       { :short => 'a', :long => 'all',    :argument => :forbidden },
-  #       { :short => 's', :long => 'stuff',  :argument => :optional  },
-  #       { :short => 'm', :long => 'more',   :argument => :optional  },
-  #       { :short => 'l', :long => 'level',  :argument => :required  },
-  #       { :short => 'f', :long => 'father', :argument => :required  },
-  #       { :short => 'n', :long => 'name',   :argument => :required  }
-  #     ]
-  #
-  # will be translated into:
-  #
-  #     {
-  #       :arguments => [ 'foo', 'hiss', 'squeak' ],
-  #       :options => {
-  #         :xxx    => true,
-  #         :yyy    => true,
-  #         :zzz    => true,
-  #         :all    => true,
-  #         :stuff  => true,
-  #         :more   => 'please',
-  #         :level  => '50',
-  #         :father => 'ani',
-  #         :name   => 'luke'
-  #       }
-  #     }
-  class OptionParser
+  # Cri::Parser is used for parsing command-line options and arguments.
+  class Parser
     # Error that will be raised when an unknown option is encountered.
     class IllegalOptionError < Cri::Error
     end
@@ -150,7 +98,7 @@ module Cri
     # @raise OptionRequiresAnArgumentError if an option was found that did not
     #   have a value, even though this value was required.
     #
-    # @return [Cri::OptionParser] The option parser self
+    # @return [Cri::Parser] The option parser self
     def run
       @running = true
 

data/lib/cri/string_formatter.rb

@@ -8,7 +8,7 @@ module Cri
   class StringFormatter
     # Extracts individual paragraphs (separated by two newlines).
     #
-    # @param [String] s The string to format
+    # @param [String] str The string to format
     #
     # @return [Array<String>] A list of paragraphs in the string
     def to_paragraphs(str)
@@ -28,7 +28,7 @@ module Cri
 
     # Word-wraps and indents the string.
     #
-    # @param [String] s The string to format
+    # @param [String] str The string to format
     #
     # @param [Number] width The maximal width of each line. This also includes
     #   indentation, i.e. the actual maximal width of the text is
@@ -76,7 +76,7 @@ module Cri
       end
     end
 
-    # @param [String] s The string to format
+    # @param [String] str The string to format
     #
     # @return [String] The string, formatted to be used as a title in a section
     #   in the help
@@ -88,7 +88,7 @@ module Cri
       end
     end
 
-    # @param [String] s The string to format
+    # @param [String] str The string to format
     #
     # @return [String] The string, formatted to be used as the name of a command
     #   in the help
@@ -100,7 +100,7 @@ module Cri
       end
     end
 
-    # @param [String] s The string to format
+    # @param [String] str The string to format
     #
     # @return [String] The string, formatted to be used as an option definition
     #   of a command in the help

data/lib/cri/version.rb

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

data/test/test_argument_list.rb

@@ -49,7 +49,7 @@ module Cri
     end
 
     def test_one_param_defn_matched
-      param_defns = [Cri::ParamDefinition.new(name: 'filename')]
+      param_defns = [Cri::ParamDefinition.new(name: 'filename', transform: nil)]
       args = Cri::ArgumentList.new(%w[notbad.jpg], false, param_defns)
 
       assert_equal(['notbad.jpg'], args.to_a)
@@ -59,7 +59,7 @@ module Cri
     end
 
     def test_one_param_defn_too_many
-      param_defns = [Cri::ParamDefinition.new(name: 'filename')]
+      param_defns = [Cri::ParamDefinition.new(name: 'filename', transform: nil)]
 
       exception = assert_raises(Cri::ArgumentList::ArgumentCountMismatchError) do
         Cri::ArgumentList.new(%w[notbad.jpg verybad.jpg], false, param_defns)
@@ -68,7 +68,7 @@ module Cri
     end
 
     def test_one_param_defn_too_few
-      param_defns = [Cri::ParamDefinition.new(name: 'filename')]
+      param_defns = [Cri::ParamDefinition.new(name: 'filename', transform: nil)]
 
       exception = assert_raises(Cri::ArgumentList::ArgumentCountMismatchError) do
         Cri::ArgumentList.new(%w[], false, param_defns)
@@ -90,5 +90,15 @@ module Cri
       end
       assert_equal('incorrect number of arguments given: expected 0, but got 1', exception.message)
     end
+
+    def test_transform
+      param_defns = [Cri::ParamDefinition.new(name: 'filename', transform: ->(a) { a.upcase })]
+      args = Cri::ArgumentList.new(%w[notbad.jpg], false, param_defns)
+
+      assert_equal(['NOTBAD.JPG'], args.to_a)
+      assert_equal(1, args.size)
+      assert_equal('NOTBAD.JPG', args[0])
+      assert_equal('NOTBAD.JPG', args[:filename])
+    end
   end
 end

data/test/test_command_dsl.rb

@@ -269,6 +269,32 @@ module Cri
       assert_equal({ foo: 'a', bar: 'b', qux: 'c' }, $args_sym)
     end
 
+    def test_params_transform
+      # Define
+      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, transform: ->(a) { a.upcase }
+
+        run do |_opts, args|
+          $args_num = { foo: args[0] }
+          $args_sym = { foo: args[:foo] }
+        end
+      end
+      command = dsl.command
+
+      # Run
+      $args_num = '???'
+      $args_sym = '???'
+      command.run(%w[abc])
+      assert_equal({ foo: 'ABC' }, $args_num)
+      assert_equal({ foo: 'ABC' }, $args_sym)
+    end
+
     def test_no_params_with_one_param_specified
       dsl = Cri::CommandDSL.new
       err = assert_raises Cri::CommandDSL::AlreadySpecifiedWithParams do

data/test/{test_option_parser.rb → test_parser.rb}

@@ -3,12 +3,12 @@
 require 'helper'
 
 module Cri
-  class OptionParserTestCase < Cri::TestCase
+  class ParserTestCase < Cri::TestCase
     def test_parse_without_options
       input = %w[foo bar baz]
       opt_defns = []
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({}, parser.options)
       assert_equal(%w[foo bar baz], parser.arguments.to_a)
@@ -18,8 +18,8 @@ module Cri
       input = %w[foo -x]
       opt_defns = []
 
-      assert_raises(Cri::OptionParser::IllegalOptionError) do
-        Cri::OptionParser.new(input, opt_defns, [], false).run
+      assert_raises(Cri::Parser::IllegalOptionError) do
+        Cri::Parser.new(input, opt_defns, [], false).run
       end
     end
 
@@ -29,7 +29,7 @@ module Cri
         { long: 'aaa', short: 'a', argument: :forbidden },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(!parser.options[:aaa])
     end
@@ -40,7 +40,7 @@ module Cri
         { long: 'aaa', short: 'a', argument: :forbidden },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(parser.options[:aaa])
       assert_equal(%w[foo bar], parser.arguments.to_a)
@@ -52,7 +52,7 @@ module Cri
         { long: 'aaa', short: 'a', argument: :required },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ aaa: 'xxx' }, parser.options)
       assert_equal(%w[foo bar], parser.arguments.to_a)
@@ -64,7 +64,7 @@ module Cri
         { long: 'aaa', short: 'a', argument: :required },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ aaa: 'xxx' }, parser.options)
       assert_equal(%w[foo bar], parser.arguments.to_a)
@@ -76,8 +76,8 @@ module Cri
         { long: 'aaa', short: 'a', argument: :required },
       ].map { |hash| make_opt_defn(hash) }
 
-      assert_raises(Cri::OptionParser::OptionRequiresAnArgumentError) do
-        Cri::OptionParser.new(input, opt_defns, [], false).run
+      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
+        Cri::Parser.new(input, opt_defns, [], false).run
       end
     end
 
@@ -88,8 +88,8 @@ module Cri
         { long: 'port', short: 'p', argument: :required },
       ].map { |hash| make_opt_defn(hash) }
 
-      assert_raises(Cri::OptionParser::OptionRequiresAnArgumentError) do
-        Cri::OptionParser.new(input, opt_defns, [], false).run
+      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
+        Cri::Parser.new(input, opt_defns, [], false).run
       end
     end
 
@@ -99,7 +99,7 @@ module Cri
         { long: 'aaa', short: 'a', argument: :optional },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(parser.options[:aaa])
       assert_equal(['foo'], parser.arguments.to_a)
@@ -111,7 +111,7 @@ module Cri
         { long: 'aaa', short: 'a', argument: :optional },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ aaa: 'xxx' }, parser.options)
       assert_equal(['foo'], parser.arguments.to_a)
@@ -125,7 +125,7 @@ module Cri
         { long: 'ccc', short: 'c', argument: :forbidden },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(parser.options[:aaa])
       assert(parser.options[:bbb])
@@ -139,7 +139,7 @@ module Cri
         { long: 'aaa', short: 'a', argument: :forbidden },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(parser.options[:aaa])
       assert_equal(%w[foo bar], parser.arguments.to_a)
@@ -151,8 +151,8 @@ module Cri
         { long: 'aaa', short: 'a', argument: :required },
       ].map { |hash| make_opt_defn(hash) }
 
-      assert_raises(Cri::OptionParser::OptionRequiresAnArgumentError) do
-        Cri::OptionParser.new(input, opt_defns, [], false).run
+      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
+        Cri::Parser.new(input, opt_defns, [], false).run
       end
     end
 
@@ -164,7 +164,7 @@ module Cri
         { long: 'ccc', short: 'c', argument: :forbidden },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(parser.options[:aaa])
       assert(parser.options[:bbb])
@@ -180,7 +180,7 @@ module Cri
         { long: 'ccc', short: 'c', argument: :forbidden },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal('bar', parser.options[:aaa])
       assert(parser.options[:bbb])
@@ -195,8 +195,8 @@ module Cri
         { long: 'port', short: 'p', argument: :required },
       ].map { |hash| make_opt_defn(hash) }
 
-      assert_raises(Cri::OptionParser::OptionRequiresAnArgumentError) do
-        Cri::OptionParser.new(input, opt_defns, [], false).run
+      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
+        Cri::Parser.new(input, opt_defns, [], false).run
       end
     end
 
@@ -206,7 +206,7 @@ module Cri
         { long: 'aaa', short: 'a', argument: :optional },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(parser.options[:aaa])
       assert_equal(['foo'], parser.arguments.to_a)
@@ -218,7 +218,7 @@ module Cri
         { long: 'aaa', short: 'a', argument: :optional },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ aaa: 'xxx' }, parser.options)
       assert_equal(['foo'], parser.arguments.to_a)
@@ -232,7 +232,7 @@ module Cri
         { long: 'ccc', short: 'c', argument: :forbidden },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert(parser.options[:aaa])
       assert(parser.options[:bbb])
@@ -244,7 +244,7 @@ module Cri
       input = %w[foo - bar]
       opt_defns = []
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({}, parser.options)
       assert_equal(['foo', '-', 'bar'], parser.arguments.to_a)
@@ -254,7 +254,7 @@ module Cri
       input = %w[foo bar -- -x --yyy -abc]
       opt_defns = []
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({}, parser.options)
       assert_equal(['foo', 'bar', '-x', '--yyy', '-abc'], parser.arguments.to_a)
@@ -266,8 +266,8 @@ module Cri
         { long: 'aaa', short: 'a', argument: :required },
       ].map { |hash| make_opt_defn(hash) }
 
-      assert_raises(Cri::OptionParser::OptionRequiresAnArgumentError) do
-        Cri::OptionParser.new(input, opt_defns, [], false).run
+      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
+        Cri::Parser.new(input, opt_defns, [], false).run
       end
     end
 
@@ -278,7 +278,7 @@ module Cri
         { long: 'verbose', short: 'v', multiple: true },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal(%w[test test2], parser.options[:long])
       assert_equal(3, parser.options[:verbose].size)
@@ -290,7 +290,7 @@ module Cri
         { long: 'animal', short: 'a', argument: :required, default: 'donkey' },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'donkey' }, parser.options)
       assert_equal(['foo'], parser.arguments.to_a)
@@ -302,8 +302,8 @@ module Cri
         { long: 'animal', short: 'a', argument: :required, default: 'donkey' },
       ].map { |hash| make_opt_defn(hash) }
 
-      assert_raises(Cri::OptionParser::OptionRequiresAnArgumentError) do
-        Cri::OptionParser.new(input, opt_defns, [], false).run
+      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
+        Cri::Parser.new(input, opt_defns, [], false).run
       end
     end
 
@@ -313,7 +313,7 @@ module Cri
         { long: 'animal', short: 'a', argument: :required, default: 'donkey' },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'giraffe' }, parser.options)
       assert_equal(['foo'], parser.arguments.to_a)
@@ -325,7 +325,7 @@ module Cri
         { long: 'animal', short: 'a', argument: :optional, default: 'donkey' },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'donkey' }, parser.options)
       assert_equal(['foo'], parser.arguments.to_a)
@@ -337,7 +337,7 @@ module Cri
         { long: 'animal', short: 'a', argument: :optional, default: 'donkey' },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'donkey' }, parser.options)
       assert_equal(['foo'], parser.arguments.to_a)
@@ -349,7 +349,7 @@ module Cri
         { long: 'animal', short: 'a', argument: :optional, default: 'donkey' },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'giraffe' }, parser.options)
       assert_equal(['foo'], parser.arguments.to_a)
@@ -361,7 +361,7 @@ module Cri
         { long: 'animal', short: 'a', argument: :optional, default: 'donkey' },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ animal: 'gi' }, parser.options)
       assert_equal(%w[foo raffe], parser.arguments.to_a)
@@ -375,7 +375,7 @@ module Cri
         { long: 'ccc', short: 'c', argument: :required },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      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)
@@ -389,7 +389,7 @@ module Cri
         { long: 'ccc', short: 'c', argument: :required },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      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)
@@ -403,7 +403,7 @@ module Cri
         { long: 'ccc', short: 'c', argument: :optional, default: 'c default' },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      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)
@@ -415,7 +415,7 @@ module Cri
         { long: 'port', short: 'p', argument: :required, transform: ->(x) { Integer(x) } },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ port: 123 }, parser.options)
       assert_equal([], parser.arguments.to_a)
@@ -427,7 +427,7 @@ module Cri
         { long: 'port', short: 'p', argument: :required, transform: method(:Integer) },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ port: 123 }, parser.options)
       assert_equal([], parser.arguments.to_a)
@@ -445,7 +445,7 @@ module Cri
         { long: 'port', short: 'p', argument: :required, transform: port },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ port: 123 }, parser.options)
       assert_equal([], parser.arguments.to_a)
@@ -464,7 +464,7 @@ module Cri
         { long: 'port', short: 'p', argument: :required, default: 8080, transform: port },
       ].map { |hash| make_opt_defn(hash) }
 
-      parser = Cri::OptionParser.new(input, opt_defns, [], false).run
+      parser = Cri::Parser.new(input, opt_defns, [], false).run
 
       assert_equal({ port: 8080 }, parser.options)
       assert_equal([], parser.arguments.to_a)
@@ -476,8 +476,8 @@ module Cri
         { long: 'port', short: 'p', argument: :required, transform: method(:Integer) },
       ].map { |hash| make_opt_defn(hash) }
 
-      exception = assert_raises(Cri::OptionParser::IllegalOptionValueError) do
-        Cri::OptionParser.new(input, opt_defns, [], false).run
+      exception = assert_raises(Cri::Parser::IllegalOptionValueError) do
+        Cri::Parser.new(input, opt_defns, [], false).run
       end
       assert_equal('invalid value "one_hundred_and_twenty_three" for --port option', exception.message)
     end
@@ -485,10 +485,10 @@ module Cri
     def test_parse_with_param_defns
       input       = %w[localhost]
       param_defns = [
-        { name: 'host' },
+        { name: 'host', transform: nil },
       ].map { |hash| Cri::ParamDefinition.new(hash) }
 
-      parser = Cri::OptionParser.new(input, [], param_defns, false).run
+      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])
@@ -497,10 +497,10 @@ module Cri
     def test_parse_with_param_defns_too_few_args
       input       = []
       param_defns = [
-        { name: 'host' },
+        { name: 'host', transform: nil },
       ].map { |hash| Cri::ParamDefinition.new(hash) }
 
-      parser = Cri::OptionParser.new(input, [], param_defns, false).run
+      parser = Cri::Parser.new(input, [], param_defns, false).run
       exception = assert_raises(Cri::ArgumentList::ArgumentCountMismatchError) do
         parser.arguments
       end
@@ -510,10 +510,10 @@ module Cri
     def test_parse_with_param_defns_too_many_args
       input       = %w[localhost oink]
       param_defns = [
-        { name: 'host' },
+        { name: 'host', transform: nil },
       ].map { |hash| Cri::ParamDefinition.new(hash) }
 
-      parser = Cri::OptionParser.new(input, [], param_defns, false).run
+      parser = Cri::Parser.new(input, [], param_defns, false).run
       exception = assert_raises(Cri::ArgumentList::ArgumentCountMismatchError) do
         parser.arguments
       end
@@ -523,10 +523,10 @@ module Cri
     def test_parse_with_param_defns_invalid_key
       input       = %w[localhost]
       param_defns = [
-        { name: 'host' },
+        { name: 'host', transform: nil },
       ].map { |hash| Cri::ParamDefinition.new(hash) }
 
-      parser = Cri::OptionParser.new(input, [], param_defns, false).run
+      parser = Cri::Parser.new(input, [], param_defns, false).run
 
       exception = assert_raises(ArgumentError) do
         parser.arguments['oink']
@@ -537,11 +537,11 @@ module Cri
     def test_parse_with_param_defns_two_params
       input       = %w[localhost example.com]
       param_defns = [
-        { name: 'source' },
-        { name: 'target' },
+        { name: 'source', transform: nil },
+        { name: 'target', transform: nil },
       ].map { |hash| Cri::ParamDefinition.new(hash) }
 
-      parser = Cri::OptionParser.new(input, [], param_defns, false).run
+      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])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cri
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-24 00:00:00.000000000 Z
+date: 2018-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -65,8 +65,8 @@ files:
 - lib/cri/commands/basic_root.rb
 - lib/cri/help_renderer.rb
 - lib/cri/option_definition.rb
-- lib/cri/option_parser.rb
 - lib/cri/param_definition.rb
+- lib/cri/parser.rb
 - lib/cri/platform.rb
 - lib/cri/string_formatter.rb
 - lib/cri/version.rb
@@ -79,7 +79,7 @@ files:
 - test/test_command_dsl.rb
 - test/test_command_runner.rb
 - test/test_help_renderer.rb
-- test/test_option_parser.rb
+- test/test_parser.rb
 - test/test_string_formatter.rb
 homepage: http://stoneship.org/software/cri/
 licenses: