cri 2.10.1 → 2.11.0

data/lib/cri.rb

@@ -1,4 +1,4 @@
-require 'cri/version'
+# frozen_string_literal: true
 
 # The namespace for Cri, a library for building easy-to-use command-line tools
 # with support for nested commands.
@@ -16,17 +16,17 @@ module Cri
   # command has no supercommand for which to show help.
   class NoHelpAvailableError < Error
   end
-
-  autoload 'Command',           'cri/command'
-  autoload 'StringFormatter',   'cri/string_formatter'
-  autoload 'CommandDSL',        'cri/command_dsl'
-  autoload 'CommandRunner',     'cri/command_runner'
-  autoload 'HelpRenderer',      'cri/help_renderer'
-  autoload 'OptionParser',      'cri/option_parser'
-  autoload 'Platform',          'cri/platform'
 end
 
 require 'set'
 
-require 'cri/core_ext'
-require 'cri/argument_array'
+require 'colored'
+
+require_relative 'cri/version'
+require_relative 'cri/command'
+require_relative 'cri/string_formatter'
+require_relative 'cri/command_dsl'
+require_relative 'cri/command_runner'
+require_relative 'cri/help_renderer'
+require_relative 'cri/option_parser'
+require_relative 'cri/platform'

data/lib/cri/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cri
   # Cri::Command represents a command that can be executed on the command line.
   # It is also used for the command-line tool itself.
@@ -357,7 +359,7 @@ module Cri
       opts.each_pair do |key, value|
         opt_def = global_option_definitions.find { |o| (o[:long] || o[:short]) == key.to_s }
         block = opt_def[:block]
-        block.call(value, self) if block
+        block&.call(value, self)
       end
     end
 
@@ -381,11 +383,14 @@ module Cri
     def handle_parser_errors_while
       yield
     rescue Cri::OptionParser::IllegalOptionError => e
-      warn "#{name}: illegal option -- #{e}"
+      warn "#{name}: unrecognised option -- #{e}"
       raise CriExitException.new(is_error: true)
     rescue Cri::OptionParser::OptionRequiresAnArgumentError => e
       warn "#{name}: option requires an argument -- #{e}"
       raise CriExitException.new(is_error: true)
+    rescue Cri::OptionParser::IllegalOptionValueError => e
+      warn "#{name}: #{e.message}"
+      raise CriExitException.new(is_error: true)
     end
   end
 end

data/lib/cri/command_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cri
   # The command DSL is a class that is used for building and modifying
   # commands.
@@ -130,6 +132,7 @@ module Cri
       multiple = params.fetch(:multiple, false)
       hidden = params.fetch(:hidden, false)
       default = params.fetch(:default, nil)
+      transform = params.fetch(:transform, nil)
 
       if short.nil? && long.nil?
         raise ArgumentError, 'short and long options cannot both be nil'
@@ -148,6 +151,7 @@ module Cri
         block: block,
         hidden: hidden,
         default: default,
+        transform: transform,
       }
     end
     alias opt option
@@ -169,6 +173,8 @@ module Cri
     #
     # @return [void]
     #
+    # @deprecated
+    #
     # @see {#option}
     def required(short, long, desc, params = {}, &block)
       params = params.merge(argument: :required)
@@ -216,6 +222,8 @@ module Cri
     #
     # @return [void]
     #
+    # @deprecated
+    #
     # @see {#option}
     def optional(short, long, desc, params = {}, &block)
       params = params.merge(argument: :optional)

data/lib/cri/command_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cri
   # A command runner is responsible for the execution of a command. Using it
   # is optional, but it is useful for commands whose execution block is large.

data/lib/cri/commands/basic_help.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 name        'help'
 usage       'help [command_name]'
 summary     'show help'
-description <<-EOS
-Show help for the given command, or show general help. When no command is
-given, a list of available commands is displayed, as well as a list of global
-command-line options. When a command is given, a command description, as well
-as command-specific command-line options, are shown.
-EOS
+description <<~DESC
+  Show help for the given command, or show general help. When no command is
+  given, a list of available commands is displayed, as well as a list of global
+  command-line options. When a command is given, a command description, as well
+  as command-specific command-line options, are shown.
+DESC
 
 flag :v, :verbose, 'show more detailed help'
 

data/lib/cri/commands/basic_root.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 flag :h, :help, 'show help for this command' do |_value, cmd|
   puts cmd.help
   raise CriExitException.new(is_error: false)

data/lib/cri/help_renderer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cri
   # The {HelpRenderer} class is responsible for generating a string containing
   # the help for a given command, intended to be printed on the command line.
@@ -25,7 +27,7 @@ module Cri
 
     # @return [String] The help text for this command
     def render
-      text = ''
+      text = +''
 
       append_summary(text)
       append_usage(text)
@@ -39,7 +41,7 @@ module Cri
     private
 
     def fmt
-      @_formatter ||= Cri::StringFormatter.new
+      @fmt ||= Cri::StringFormatter.new
     end
 
     def append_summary(text)
@@ -87,9 +89,9 @@ module Cri
       shown_subcommands.sort_by(&:name).each do |cmd|
         text <<
           format(
-            "    %-#{length + DESC_INDENT}s %s\n",
-            fmt.format_as_command(cmd.name, @io),
-            cmd.summary,
+            "    %<name>-#{length + DESC_INDENT}s %<summary>s\n",
+            name: fmt.format_as_command(cmd.name, @io),
+            summary: cmd.summary,
           )
       end
 
@@ -106,7 +108,7 @@ module Cri
 
     def length_for_opt_defs(opt_defs)
       opt_defs.map do |opt_def|
-        string = ''
+        string = +''
 
         # Always pretend there is a short option
         string << '-X'
@@ -189,7 +191,7 @@ module Cri
       short_value_postfix = short_value_postfix_for(opt_def)
       long_value_postfix = long_value_postfix_for(opt_def)
 
-      opt_text = ''
+      opt_text = +''
       opt_text_len = 0
       if opt_def[:short]
         opt_text << fmt.format_as_option('-' + opt_def[:short], @io)

data/lib/cri/option_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cri
   # Cri::OptionParser is used for parsing command-line options.
   #
@@ -57,6 +59,23 @@ module Cri
     class IllegalOptionError < Cri::Error
     end
 
+    # Error that will be raised when an option with an invalid or
+    # non-transformable value is encountered.
+    class IllegalOptionValueError < Cri::Error
+      attr_reader :definition
+      attr_reader :value
+
+      def initialize(definition, value)
+        @definition = definition
+        @value      = value
+      end
+
+      def message
+        name = @definition[:long] ? '--' + @definition[:long] : '-' + @definition[:short]
+        "invalid value #{value.inspect} for #{name} option"
+      end
+    end
+
     # Error that will be raised when an option without argument is
     # encountered.
     class OptionRequiresAnArgumentError < Cri::Error
@@ -128,7 +147,7 @@ module Cri
     #
     # @return [Array] The already parsed arguments.
     def arguments
-      ArgumentArray.new(@raw_arguments).freeze
+      @raw_arguments.reject { |a| a == '--' }.freeze
     end
 
     # @return [Boolean] true if the parser is running, false otherwise.
@@ -187,18 +206,18 @@ module Cri
       @definitions.each { |d| add_default_option(d) }
     end
 
-    def handle_dashdash(e)
-      add_argument(e)
+    def handle_dashdash(elem)
+      add_argument(elem)
       @no_more_options = true
     end
 
-    def handle_dashdash_option(e)
+    def handle_dashdash_option(elem)
       # Get option key, and option value if included
-      if e =~ /^--([^=]+)=(.+)$/
+      if elem =~ /^--([^=]+)=(.+)$/
         option_key   = Regexp.last_match[1]
         option_value = Regexp.last_match[2]
       else
-        option_key    = e[2..-1]
+        option_key    = elem[2..-1]
         option_value  = nil
       end
 
@@ -220,9 +239,9 @@ module Cri
       end
     end
 
-    def handle_dash_option(e)
+    def handle_dash_option(elem)
       # Get option keys
-      option_keys = e[1..-1].scan(/./)
+      option_keys = elem[1..-1].scan(/./)
 
       # For each key
       option_keys.each do |option_key|
@@ -258,9 +277,11 @@ module Cri
       option_value
     end
 
-    def add_option(definition, value)
+    def add_option(definition, value, transform: true)
       key = key_for(definition)
 
+      value = transform ? transform_value(definition, value) : value
+
       if definition[:multiple]
         options[key] ||= []
         options[key] << value
@@ -268,7 +289,7 @@ module Cri
         options[key] = value
       end
 
-      delegate.option_added(key, value, self) unless delegate.nil?
+      delegate&.option_added(key, value, self)
     end
 
     def add_default_option(definition)
@@ -278,11 +299,20 @@ module Cri
       value = definition[:default]
       return unless value
 
-      if definition[:multiple]
-        options[key] ||= []
-        options[key] << value
+      add_option(definition, value, transform: false)
+    end
+
+    def transform_value(definition, value)
+      transformer = definition[:transform]
+
+      if transformer
+        begin
+          transformer.call(value)
+        rescue StandardError
+          raise IllegalOptionValueError.new(definition, value)
+        end
       else
-        options[key] = value
+        value
       end
     end
 
@@ -294,7 +324,7 @@ module Cri
       @raw_arguments << value
 
       unless value == '--'
-        delegate.argument_added(value, self) unless delegate.nil?
+        delegate&.argument_added(value, self)
       end
     end
   end

data/lib/cri/platform.rb

@@ -1,4 +1,10 @@
+# frozen_string_literal: true
+
 module Cri
+  # Provides tools to detect platform and environment configuration (e.g. is
+  # color support available?)
+  #
+  # @api private
   module Platform
     # @return [Boolean] true if the current platform is Windows, false
     # otherwise.

data/lib/cri/string_formatter.rb

@@ -1,14 +1,18 @@
-require 'colored'
+# frozen_string_literal: true
 
 module Cri
+  # Used for formatting strings (e.g. converting to paragraphs, wrapping,
+  # formatting as title)
+  #
+  # @api private
   class StringFormatter
     # Extracts individual paragraphs (separated by two newlines).
     #
     # @param [String] s The string to format
     #
     # @return [Array<String>] A list of paragraphs in the string
-    def to_paragraphs(s)
-      lines = s.scan(/([^\n]+\n|[^\n]*$)/).map { |l| l[0].strip }
+    def to_paragraphs(str)
+      lines = str.scan(/([^\n]+\n|[^\n]*$)/).map { |l| l[0].strip }
 
       paragraphs = [[]]
       lines.each do |line|
@@ -36,11 +40,11 @@ module Cri
     #   line is already indented
     #
     # @return [String] The word-wrapped and indented string
-    def wrap_and_indent(s, width, indentation, first_line_already_indented = false)
+    def wrap_and_indent(str, width, indentation, first_line_already_indented = false)
       indented_width = width - indentation
       indent = ' ' * indentation
       # Split into paragraphs
-      paragraphs = to_paragraphs(s)
+      paragraphs = to_paragraphs(str)
 
       # Wrap and indent each paragraph
       text = paragraphs.map do |paragraph|
@@ -76,11 +80,11 @@ module Cri
     #
     # @return [String] The string, formatted to be used as a title in a section
     #   in the help
-    def format_as_title(s, io)
+    def format_as_title(str, io)
       if Cri::Platform.color?(io)
-        s.upcase.red.bold
+        str.upcase.red.bold
       else
-        s.upcase
+        str.upcase
       end
     end
 
@@ -88,11 +92,11 @@ module Cri
     #
     # @return [String] The string, formatted to be used as the name of a command
     #   in the help
-    def format_as_command(s, io)
+    def format_as_command(str, io)
       if Cri::Platform.color?(io)
-        s.green
+        str.green
       else
-        s
+        str
       end
     end
 
@@ -100,11 +104,11 @@ module Cri
     #
     # @return [String] The string, formatted to be used as an option definition
     #   of a command in the help
-    def format_as_option(s, io)
+    def format_as_option(str, io)
       if Cri::Platform.color?(io)
-        s.yellow
+        str.yellow
       else
-        s
+        str
       end
     end
   end

data/lib/cri/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Cri
   # The current Cri version.
-  VERSION = '2.10.1'.freeze
+  VERSION = '2.11.0'
 end

data/test/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'coveralls'
 Coveralls.wear!
 

data/test/test_base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 module Cri

data/test/test_basic_help.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 module Cri

data/test/test_basic_root.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 module Cri

data/test/test_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 module Cri
@@ -16,6 +18,7 @@ module Cri
         optional  :c, :ccc, 'opt c'
         flag      :d, :ddd, 'opt d'
         forbidden :e, :eee, 'opt e'
+        required  :t, :transform, 'opt t', transform: method(:Integer)
 
         run do |opts, args, c|
           $stdout.puts "Awesome #{c.name}!"
@@ -175,7 +178,7 @@ module Cri
       end
 
       assert_equal [], lines(out)
-      assert_equal ['moo: illegal option -- z'], lines(err)
+      assert_equal ['moo: unrecognised option -- z'], lines(err)
     end
 
     def test_invoke_simple_with_illegal_opt_no_exit
@@ -184,7 +187,28 @@ module Cri
       end
 
       assert_equal [], lines(out)
-      assert_equal ['moo: illegal option -- z'], lines(err)
+      assert_equal ['moo: unrecognised option -- z'], lines(err)
+    end
+
+    def test_invoke_simple_with_invalid_value_for_opt
+      out, err = capture_io_while do
+        err = assert_raises SystemExit do
+          simple_cmd.run(%w[-t nope])
+        end
+        assert_equal 1, err.status
+      end
+
+      assert_equal [], lines(out)
+      assert_equal ['moo: invalid value "nope" for --transform option'], lines(err)
+    end
+
+    def test_invoke_simple_with_invalid_value_for_opt_no_exit
+      out, err = capture_io_while do
+        simple_cmd.run(%w[-t nope], {}, hard_exit: false)
+      end
+
+      assert_equal [], lines(out)
+      assert_equal ['moo: invalid value "nope" for --transform option'], lines(err)
     end
 
     def test_invoke_simple_with_opt_with_block
@@ -568,14 +592,14 @@ module Cri
       cmd = Cri::Command.define do
         name 'moo'
         run do |_opts, args|
-          puts "args=#{args.join(',')} args.raw=#{args.raw.join(',')}"
+          puts "args=#{args.join(',')}"
         end
       end
 
       out, _err = capture_io_while do
         cmd.run(%w[foo -- bar])
       end
-      assert_equal "args=foo,bar args.raw=foo,--,bar\n", out
+      assert_equal "args=foo,bar\n", out
     end
 
     def test_run_without_block
@@ -593,7 +617,7 @@ module Cri
         name 'moo'
         runner(Class.new(Cri::CommandRunner) do
           def run
-            puts "args=#{arguments.join(',')} args.raw=#{arguments.raw.join(',')}"
+            puts "args=#{arguments.join(',')}"
           end
         end)
       end
@@ -601,7 +625,7 @@ module Cri
       out, _err = capture_io_while do
         cmd.run(%w[foo -- bar])
       end
-      assert_equal "args=foo,bar args.raw=foo,--,bar\n", out
+      assert_equal "args=foo,bar\n", out
     end
 
     def test_compare