cri 2.7.0 → 2.7.1

data/lib/cri/core_ext.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Cri
   module CoreExtensions
   end

data/lib/cri/core_ext/string.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'colored'
 
 module Cri

data/lib/cri/help_renderer.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 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.
@@ -86,22 +84,21 @@ module Cri
       length = shown_subcommands.map { |c| fmt.format_as_command(c.name, @io).size }.max
 
       # Command
-      shown_subcommands.sort_by { |cmd| cmd.name }.each do |cmd|
+      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)
+            cmd.summary,
+          )
       end
 
       # Hidden notice
       unless @is_verbose
         diff = @cmd.subcommands.size - shown_subcommands.size
-        case diff
-        when 0
-        when 1
+        if diff == 1
           text << "    (1 hidden command omitted; show it with --verbose)\n"
-        else
+        elsif diff > 1
           text << "    (#{diff} hidden commands omitted; show them with --verbose)\n"
         end
       end
@@ -145,7 +142,7 @@ module Cri
       return if defs.empty?
 
       text << "\n"
-      text << fmt.format_as_title("#{name}", @io)
+      text << fmt.format_as_title(name.to_s, @io)
       text << "\n"
 
       ordered_defs = defs.sort_by { |x| x[:short] || x[:long] }
@@ -164,8 +161,6 @@ module Cri
           '<value>'
         when :optional
           '[<value>]'
-        else
-          nil
         end
 
       if value_postfix
@@ -182,8 +177,6 @@ module Cri
           '=<value>'
         when :optional
           '[=<value>]'
-        else
-          nil
         end
 
       if value_postfix

data/lib/cri/option_parser.rb

@@ -1,7 +1,5 @@
-# encoding: utf-8
-
 module Cri
-  # Cri::OptionParser is used for parsing commandline options.
+  # 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
@@ -19,7 +17,7 @@ module Cri
   #       { :short => 'p', :long => 'port', :argument => :required, :multiple => false },
   #     ]
   #
-  # For example, the following commandline options (which should not be
+  # 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
@@ -92,11 +90,11 @@ module Cri
     # @return [Array] The not yet parsed options and arguments.
     attr_reader :unprocessed_arguments_and_options
 
-    # Parses the commandline arguments. See the instance `parse` method for
+    # Parses the command-line arguments. See the instance `parse` method for
     # details.
     #
     # @param [Array<String>] arguments_and_options An array containing the
-    #   commandline arguments (will probably be `ARGS` for a root command)
+    #   command-line arguments (will probably be `ARGS` for a root command)
     #
     # @param [Array<Hash>] definitions An array of option definitions
     #
@@ -108,7 +106,7 @@ module Cri
     # Creates a new parser with the given options/arguments and definitions.
     #
     # @param [Array<String>] arguments_and_options An array containing the
-    #   commandline arguments (will probably be `ARGS` for a root command)
+    #   command-line arguments (will probably be `ARGS` for a root command)
     #
     # @param [Array<Hash>] definitions An array of option definitions
     def initialize(arguments_and_options, definitions)
@@ -146,7 +144,7 @@ module Cri
       @running = false
     end
 
-    # Parses the commandline arguments into options and arguments.
+    # Parses the command-line arguments into options and arguments.
     #
     # During parsing, two errors can be raised:
     #
@@ -199,7 +197,7 @@ module Cri
 
       # Find definition
       definition = @definitions.find { |d| d[:long] == option_key }
-      fail IllegalOptionError.new(option_key) if definition.nil?
+      raise IllegalOptionError.new(option_key) if definition.nil?
 
       if [:required, :optional].include?(definition[:argument])
         # Get option value if necessary
@@ -223,11 +221,11 @@ module Cri
       option_keys.each do |option_key|
         # Find definition
         definition = @definitions.find { |d| d[:short] == option_key }
-        fail IllegalOptionError.new(option_key) if definition.nil?
+        raise IllegalOptionError.new(option_key) if definition.nil?
 
         if option_keys.length > 1 && definition[:argument] == :required
           # This is a combined option and it requires an argument, so complain
-          fail OptionRequiresAnArgumentError.new(option_key)
+          raise OptionRequiresAnArgumentError.new(option_key)
         elsif [:required, :optional].include?(definition[:argument])
           # Get option value
           option_value = find_option_value(definition, option_key)
@@ -245,7 +243,7 @@ module Cri
       option_value = @unprocessed_arguments_and_options.shift
       if option_value.nil? || option_value =~ /^-/
         if definition[:argument] == :required
-          fail OptionRequiresAnArgumentError.new(option_key)
+          raise OptionRequiresAnArgumentError.new(option_key)
         else
           @unprocessed_arguments_and_options.unshift(option_value)
           option_value = true

data/lib/cri/platform.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Cri
   module Platform
     # @return [Boolean] true if the current platform is Windows, false

data/lib/cri/string_formatter.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'colored'
 
 module Cri
@@ -21,7 +19,7 @@ module Cri
         end
       end
 
-      paragraphs.reject { |p| p.empty? }.map { |p| p.join(' ') }
+      paragraphs.reject(&:empty?).map { |p| p.join(' ') }
     end
 
     # Word-wraps and indents the string.

data/lib/cri/version.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
 module Cri
   # The current Cri version.
-  VERSION = '2.7.0'
+  VERSION = '2.7.1'.freeze
 end

data/test/helper.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'coveralls'
 Coveralls.wear!
 
@@ -20,16 +18,16 @@ module Cri
       uncapture_io(*@orig_io)
     end
 
-    def capture_io_while(&block)
+    def capture_io_while
       orig_io = capture_io
-      block.call
+      yield
       [$stdout.string, $stderr.string]
     ensure
       uncapture_io(*orig_io)
     end
 
     def lines(string)
-      string.scan(/^.*\n/).map { |s| s.chomp }
+      string.scan(/^.*\n/).map(&:chomp)
     end
 
     private

data/test/test_argument_array.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Cri
   class ArgumentArrayTestCase < Cri::TestCase
     def test_initialize

data/test/test_base.rb

@@ -1,8 +1,5 @@
-# encoding: utf-8
-
 module Cri
   class BaseTestCase < Cri::TestCase
-    def test_stub
-    end
+    def test_stub; end
   end
 end

data/test/test_basic_help.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Cri
   class BasicHelpTestCase < Cri::TestCase
     def test_run_without_supercommand

data/test/test_basic_root.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Cri
   class BasicRootTestCase < Cri::TestCase
     def test_run_with_help
@@ -7,7 +5,7 @@ module Cri
 
       stdout, _stderr = capture_io_while do
         assert_raises SystemExit do
-          cmd.run(%w( -h ))
+          cmd.run(%w(-h))
         end
       end
 

data/test/test_command.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Cri
   class CommandTestCase < Cri::TestCase
     def simple_cmd
@@ -9,7 +7,7 @@ module Cri
         summary     'does stuff'
         description 'This command does a lot of stuff.'
 
-        option    :a, :aaa, 'opt a', :argument => :optional do |value, cmd|
+        option :a, :aaa, 'opt a', argument: :optional do |value, cmd|
           $stdout.puts "#{cmd.name}:#{value}"
         end
         required  :b, :bbb, 'opt b'
@@ -31,7 +29,7 @@ module Cri
 
     def bare_cmd
       Cri::Command.define do
-        name        'moo'
+        name 'moo'
 
         run do |_opts, _args|
         end
@@ -45,7 +43,7 @@ module Cri
         summary     'does super stuff'
         description 'This command does super stuff.'
 
-        option    :a, :aaa, 'opt a', :argument => :optional do |value, cmd|
+        option :a, :aaa, 'opt a', argument: :optional do |value, cmd|
           $stdout.puts "#{cmd.name}:#{value}"
         end
         required  :b, :bbb, 'opt b'
@@ -61,7 +59,7 @@ module Cri
         summary     'does subby stuff'
         description 'This command does subby stuff.'
 
-        option    :m, :mmm, 'opt m', :argument => :optional
+        option    :m, :mmm, 'opt m', argument: :optional
         required  :n, :nnn, 'opt n'
         optional  :o, :ooo, 'opt o'
         flag      :p, :ppp, 'opt p'
@@ -148,7 +146,7 @@ module Cri
     def test_invoke_simple_with_missing_opt_arg
       out, err = capture_io_while do
         assert_raises SystemExit do
-          simple_cmd.run(%w( -b ))
+          simple_cmd.run(%w(-b))
         end
       end
 
@@ -159,7 +157,7 @@ module Cri
     def test_invoke_simple_with_illegal_opt
       out, err = capture_io_while do
         assert_raises SystemExit do
-          simple_cmd.run(%w( -z ))
+          simple_cmd.run(%w(-z))
         end
       end
 
@@ -169,7 +167,7 @@ module Cri
 
     def test_invoke_simple_with_opt_with_block
       out, err = capture_io_while do
-        simple_cmd.run(%w( -a 123 ))
+        simple_cmd.run(%w(-a 123))
       end
 
       assert_equal ['moo:123', 'Awesome moo!', '', 'aaa=123'], lines(out)
@@ -189,7 +187,7 @@ module Cri
 
     def test_invoke_nested_with_correct_command_name
       out, err = capture_io_while do
-        nested_cmd.run(%w( sub ))
+        nested_cmd.run(%w(sub))
       end
 
       assert_equal ['Sub-awesome!', '', ''], lines(out)
@@ -199,7 +197,7 @@ module Cri
     def test_invoke_nested_with_incorrect_command_name
       out, err = capture_io_while do
         assert_raises SystemExit do
-          nested_cmd.run(%w( oogabooga ))
+          nested_cmd.run(%w(oogabooga))
         end
       end
 
@@ -210,7 +208,7 @@ module Cri
     def test_invoke_nested_with_ambiguous_command_name
       out, err = capture_io_while do
         assert_raises SystemExit do
-          nested_cmd.run(%w( s ))
+          nested_cmd.run(%w(s))
         end
       end
 
@@ -220,7 +218,7 @@ module Cri
 
     def test_invoke_nested_with_alias
       out, err = capture_io_while do
-        nested_cmd.run(%w( sup ))
+        nested_cmd.run(%w(sup))
       end
 
       assert_equal ['Sub-awesome!', '', ''], lines(out)
@@ -229,7 +227,7 @@ module Cri
 
     def test_invoke_nested_with_options_before_command
       out, err = capture_io_while do
-        nested_cmd.run(%w( -a 666 sub ))
+        nested_cmd.run(%w(-a 666 sub))
       end
 
       assert_equal ['super:666', 'Sub-awesome!', '', 'aaa=666'], lines(out)
@@ -245,7 +243,7 @@ module Cri
       assert_equal [], lines(err)
 
       out, err = capture_io_while do
-        nested_cmd_with_run_block.run(%w( sub ))
+        nested_cmd_with_run_block.run(%w(sub))
       end
 
       assert_equal ['sub'], lines(out)
@@ -354,7 +352,7 @@ module Cri
     def test_help_with_multiple_groups
       help = nested_cmd.subcommands.find { |cmd| cmd.name == 'sub' }.help
 
-      assert_match(/OPTIONS.*OPTIONS FOR SUPER/m,  help)
+      assert_match(/OPTIONS.*OPTIONS FOR SUPER/m, help)
     end
 
     def test_modify_with_block_argument
@@ -377,7 +375,7 @@ module Cri
 
       cmd = Cri::Command.define do
         name 'build'
-        flag     nil, :longflag,     'This is an option with a very long description that should be wrapped'
+        flag nil, :longflag, 'This is an option with a very long description that should be wrapped'
       end
       help = cmd.help
 
@@ -469,9 +467,9 @@ module Cri
       assert cmd.help.include?('hidden command omitted')
       refute cmd.help.include?('old-and-deprecated')
 
-      refute cmd.help(:verbose => true).include?('hidden commands omitted')
-      refute cmd.help(:verbose => true).include?('hidden command omitted')
-      assert cmd.help(:verbose => true).include?('old-and-deprecated')
+      refute cmd.help(verbose: true).include?('hidden commands omitted')
+      refute cmd.help(verbose: true).include?('hidden command omitted')
+      assert cmd.help(verbose: true).include?('old-and-deprecated')
     end
 
     def test_hidden_commands_multiple
@@ -505,13 +503,13 @@ module Cri
       refute cmd.help.include?('old-and-deprecated')
       refute cmd.help.include?('ancient-and-deprecated')
 
-      refute cmd.help(:verbose => true).include?('hidden commands omitted')
-      refute cmd.help(:verbose => true).include?('hidden command omitted')
-      assert cmd.help(:verbose => true).include?('old-and-deprecated')
-      assert cmd.help(:verbose => true).include?('ancient-and-deprecated')
+      refute cmd.help(verbose: true).include?('hidden commands omitted')
+      refute cmd.help(verbose: true).include?('hidden command omitted')
+      assert cmd.help(verbose: true).include?('old-and-deprecated')
+      assert cmd.help(verbose: true).include?('ancient-and-deprecated')
 
       pattern = /ancient-and-deprecated.*first.*old-and-deprecated/m
-      assert_match(pattern, cmd.help(:verbose => true))
+      assert_match(pattern, cmd.help(verbose: true))
     end
 
     def test_run_with_raw_args
@@ -523,7 +521,7 @@ module Cri
       end
 
       out, _err = capture_io_while do
-        cmd.run(%w( foo -- bar ))
+        cmd.run(%w(foo -- bar))
       end
       assert_equal "args=foo,bar args.raw=foo,--,bar\n", out
     end
@@ -549,7 +547,7 @@ module Cri
       end
 
       out, _err = capture_io_while do
-        cmd.run(%w( foo -- bar ))
+        cmd.run(%w(foo -- bar))
       end
       assert_equal "args=foo,bar args.raw=foo,--,bar\n", out
     end

data/test/test_command_dsl.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Cri
   class CommandDSLTestCase < Cri::TestCase
     def test_create_command
@@ -11,12 +9,12 @@ module Cri
         summary     'does stuff'
         description 'This command does a lot of stuff.'
 
-        option    :a, :aaa, 'opt a', :argument => :optional, :multiple => true
+        option    :a, :aaa, 'opt a', argument: :optional, multiple: true
         required  :b, :bbb, 'opt b'
         optional  :c, :ccc, 'opt c'
         flag      :d, :ddd, 'opt d'
         forbidden :e, :eee, 'opt e'
-        flag      :f, :fff, 'opt f', :hidden => true
+        flag      :f, :fff, 'opt f', hidden: true
 
         run do |_opts, _args|
           $did_it_work = :probably
@@ -26,7 +24,7 @@ module Cri
 
       # Run
       $did_it_work = :sadly_not
-      command.run(%w( -a x -b y -c -d -e ))
+      command.run(%w(-a x -b y -c -d -e))
       assert_equal :probably, $did_it_work
 
       # Check
@@ -37,13 +35,13 @@ module Cri
 
       # Check options
       expected_option_definitions = Set.new([
-        { :short => 'a', :long => 'aaa', :desc => 'opt a', :argument => :optional,  :multiple => true,  :hidden => false, :block => nil },
-        { :short => 'b', :long => 'bbb', :desc => 'opt b', :argument => :required,  :multiple => false, :hidden => false, :block => nil },
-        { :short => 'c', :long => 'ccc', :desc => 'opt c', :argument => :optional,  :multiple => false, :hidden => false, :block => nil },
-        { :short => 'd', :long => 'ddd', :desc => 'opt d', :argument => :forbidden, :multiple => false, :hidden => false, :block => nil },
-        { :short => 'e', :long => 'eee', :desc => 'opt e', :argument => :forbidden, :multiple => false, :hidden => false, :block => nil },
-        { :short => 'f', :long => 'fff', :desc => 'opt f', :argument => :forbidden, :multiple => false, :hidden => true,  :block => nil },
-      ])
+                                              { short: 'a', long: 'aaa', desc: 'opt a', argument: :optional,  multiple: true, hidden: false, block: nil },
+                                              { short: 'b', long: 'bbb', desc: 'opt b', argument: :required,  multiple: false, hidden: false, block: nil },
+                                              { short: 'c', long: 'ccc', desc: 'opt c', argument: :optional,  multiple: false, hidden: false, block: nil },
+                                              { short: 'd', long: 'ddd', desc: 'opt d', argument: :forbidden, multiple: false, hidden: false, block: nil },
+                                              { short: 'e', long: 'eee', desc: 'opt e', argument: :forbidden, multiple: false, hidden: false, block: nil },
+                                              { short: 'f', long: 'fff', desc: 'opt f', argument: :forbidden, multiple: false, hidden: true,  block: nil },
+                                            ])
       actual_option_definitions = Set.new(command.option_definitions)
       assert_equal expected_option_definitions, actual_option_definitions
     end
@@ -68,14 +66,14 @@ module Cri
 
       # Run
       $did_it_work = :sadly_not
-      command.run(%w( -s --long ))
+      command.run(%w(-s --long))
       assert_equal :probably, $did_it_work
 
       # Check options
       expected_option_definitions = Set.new([
-        { :short => 's', :long => nil,    :desc => 'short', :argument => :forbidden, :multiple => false, :hidden => false, :block => nil },
-        { :short => nil, :long => 'long', :desc => 'long',  :argument => :forbidden, :multiple => false, :hidden => false, :block => nil },
-      ])
+                                              { short: 's', long: nil, desc: 'short', argument: :forbidden, multiple: false, hidden: false, block: nil },
+                                              { short: nil, long: 'long', desc: 'long', argument: :forbidden, multiple: false, hidden: false, block: nil },
+                                            ])
       actual_option_definitions = Set.new(command.option_definitions)
       assert_equal expected_option_definitions, actual_option_definitions
     end
@@ -84,9 +82,9 @@ module Cri
       # Define
       dsl = Cri::CommandDSL.new
       dsl.instance_eval do
-        flag     :f, :flag,     'flag', :multiple => true
-        required :r, :required, 'req',  :multiple => true
-        optional :o, :optional, 'opt',  :multiple => true
+        flag     :f, :flag,     'flag', multiple: true
+        required :r, :required, 'req',  multiple: true
+        optional :o, :optional, 'opt',  multiple: true
 
         run { |_opts, _args| }
       end
@@ -94,10 +92,10 @@ module Cri
 
       # Check options
       expected_option_definitions = Set.new([
-        { :short => 'f', :long => 'flag',     :desc => 'flag', :argument => :forbidden, :multiple => true, :hidden => false, :block => nil },
-        { :short => 'r', :long => 'required', :desc => 'req',  :argument => :required,  :multiple => true, :hidden => false, :block => nil },
-        { :short => 'o', :long => 'optional', :desc => 'opt',  :argument => :optional,  :multiple => true, :hidden => false, :block => nil },
-      ])
+                                              { short: 'f', long: 'flag',     desc: 'flag', argument: :forbidden, multiple: true, hidden: false, block: nil },
+                                              { short: 'r', long: 'required', desc: 'req',  argument: :required,  multiple: true, hidden: false, block: nil },
+                                              { short: 'o', long: 'optional', desc: 'opt',  argument: :optional,  multiple: true, hidden: false, block: nil },
+                                            ])
       actual_option_definitions = Set.new(command.option_definitions)
       assert_equal expected_option_definitions, actual_option_definitions
     end
@@ -106,9 +104,9 @@ module Cri
       # Define
       dsl = Cri::CommandDSL.new
       dsl.instance_eval do
-        flag     :f, :flag,     'flag', :hidden => true
-        required :r, :required, 'req',  :hidden => true
-        optional :o, :optional, 'opt',  :hidden => true
+        flag     :f, :flag,     'flag', hidden: true
+        required :r, :required, 'req',  hidden: true
+        optional :o, :optional, 'opt',  hidden: true
 
         run { |_opts, _args| }
       end
@@ -116,10 +114,10 @@ module Cri
 
       # Check options
       expected_option_definitions = Set.new([
-        { :short => 'f', :long => 'flag',     :desc => 'flag', :argument => :forbidden, :multiple => false, :hidden => true, :block => nil },
-        { :short => 'r', :long => 'required', :desc => 'req',  :argument => :required,  :multiple => false, :hidden => true, :block => nil },
-        { :short => 'o', :long => 'optional', :desc => 'opt',  :argument => :optional,  :multiple => false, :hidden => true, :block => nil },
-      ])
+                                              { short: 'f', long: 'flag',     desc: 'flag', argument: :forbidden, multiple: false, hidden: true, block: nil },
+                                              { short: 'r', long: 'required', desc: 'req',  argument: :required,  multiple: false, hidden: true, block: nil },
+                                              { short: 'o', long: 'optional', desc: 'opt',  argument: :optional,  multiple: false, hidden: true, block: nil },
+                                            ])
       actual_option_definitions = Set.new(command.option_definitions)
       assert_equal expected_option_definitions, actual_option_definitions
     end
@@ -175,7 +173,7 @@ module Cri
       command = dsl.command
 
       # Check
-      assert_equal %w( aah moo ), command.aliases.sort
+      assert_equal %w(aah moo), command.aliases.sort
     end
 
     def test_run_arity
@@ -204,7 +202,7 @@ module Cri
 
       # Check
       $did_it_work = false
-      command.run(%w( certainly ))
+      command.run(%w(certainly))
       assert_equal 'certainly', $did_it_work
     end
   end