cri 2.6.1 → 2.7.0

data/lib/cri/option_parser.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Cri
-
   # Cri::OptionParser is used for parsing commandline options.
   #
   # Option definitions are hashes with the keys `:short`, `:long` and
@@ -56,7 +55,6 @@ module Cri
   #       }
   #     }
   class OptionParser
-
     # Error that will be raised when an unknown option is encountered.
     class IllegalOptionError < Cri::Error
     end
@@ -104,7 +102,7 @@ module Cri
     #
     # @return [Cri::OptionParser] The option parser self
     def self.parse(arguments_and_options, definitions)
-      self.new(arguments_and_options, definitions).run
+      new(arguments_and_options, definitions).run
     end
 
     # Creates a new parser with the given options/arguments and definitions.
@@ -169,9 +167,9 @@ module Cri
 
         if e == '--'
           handle_dashdash(e)
-        elsif e =~ /^--./ and !@no_more_options
+        elsif e =~ /^--./ && !@no_more_options
           handle_dashdash_option(e)
-        elsif e =~ /^-./ and !@no_more_options
+        elsif e =~ /^-./ && !@no_more_options
           handle_dash_option(e)
         else
           add_argument(e)
@@ -182,7 +180,7 @@ module Cri
       @running = false
     end
 
-  private
+    private
 
     def handle_dashdash(e)
       add_argument(e)
@@ -192,8 +190,8 @@ module Cri
     def handle_dashdash_option(e)
       # Get option key, and option value if included
       if e =~ /^--([^=]+)=(.+)$/
-        option_key   = $1
-        option_value = $2
+        option_key   = Regexp.last_match[1]
+        option_value = Regexp.last_match[2]
       else
         option_key    = e[2..-1]
         option_value  = nil
@@ -201,9 +199,9 @@ module Cri
 
       # Find definition
       definition = @definitions.find { |d| d[:long] == option_key }
-      raise IllegalOptionError.new(option_key) if definition.nil?
+      fail IllegalOptionError.new(option_key) if definition.nil?
 
-      if [ :required, :optional ].include?(definition[:argument])
+      if [:required, :optional].include?(definition[:argument])
         # Get option value if necessary
         if option_value.nil?
           option_value = find_option_value(definition, option_key)
@@ -225,12 +223,12 @@ module Cri
       option_keys.each do |option_key|
         # Find definition
         definition = @definitions.find { |d| d[:short] == option_key }
-        raise IllegalOptionError.new(option_key) if definition.nil?
+        fail IllegalOptionError.new(option_key) if definition.nil?
 
-        if option_keys.length > 1 and definition[:argument] == :required
+        if option_keys.length > 1 && definition[:argument] == :required
           # This is a combined option and it requires an argument, so complain
-          raise OptionRequiresAnArgumentError.new(option_key)
-        elsif [ :required, :optional ].include?(definition[:argument])
+          fail OptionRequiresAnArgumentError.new(option_key)
+        elsif [:required, :optional].include?(definition[:argument])
           # Get option value
           option_value = find_option_value(definition, option_key)
 
@@ -247,7 +245,7 @@ module Cri
       option_value = @unprocessed_arguments_and_options.shift
       if option_value.nil? || option_value =~ /^-/
         if definition[:argument] == :required
-          raise OptionRequiresAnArgumentError.new(option_key)
+          fail OptionRequiresAnArgumentError.new(option_key)
         else
           @unprocessed_arguments_and_options.unshift(option_value)
           option_value = true
@@ -275,7 +273,5 @@ module Cri
         delegate.argument_added(value, self) unless delegate.nil?
       end
     end
-
   end
-
 end

data/lib/cri/platform.rb

@@ -1,13 +1,11 @@
 # encoding: utf-8
 
 module Cri
-
   module Platform
-
     # @return [Boolean] true if the current platform is Windows, false
     # otherwise.
     def self.windows?
-      !!(RUBY_PLATFORM =~ /windows|bccwin|cygwin|djgpp|mingw|mswin|wince/i)
+      RUBY_PLATFORM =~ /windows|bccwin|cygwin|djgpp|mingw|mswin|wince/i
     end
 
     # Checks whether colors can be enabled. For colors to be enabled, the given
@@ -24,7 +22,5 @@ module Cri
         true
       end
     end
-
   end
-
 end

data/lib/cri/string_formatter.rb

@@ -3,18 +3,16 @@
 require 'colored'
 
 module Cri
-
   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 { |s| s[0].strip }
+      lines = s.scan(/([^\n]+\n|[^\n]*$)/).map { |l| l[0].strip }
 
-      paragraphs = [ [] ]
+      paragraphs = [[]]
       lines.each do |line|
         if line.empty?
           paragraphs << []
@@ -36,15 +34,18 @@ module Cri
     #
     # @param [Number] indentation The number of spaces to indent each line.
     #
+    # @param [Boolean] first_line_already_indented Whether or not the first
+    #   line is already indented
+    #
     # @return [String] The word-wrapped and indented string
-    def wrap_and_indent(s, width, indentation)
+    def wrap_and_indent(s, width, indentation, first_line_already_indented = false)
       indented_width = width - indentation
       indent = ' ' * indentation
       # Split into paragraphs
       paragraphs = to_paragraphs(s)
 
       # Wrap and indent each paragraph
-      paragraphs.map do |paragraph|
+      text = paragraphs.map do |paragraph|
         # Initialize
         lines = []
         line = ''
@@ -58,13 +59,19 @@ module Cri
           end
 
           # Add word to line
-          line += (line == '' ? '' : ' ' ) + word
+          line += (line == '' ? '' : ' ') + word
         end
         lines << line
 
         # Join lines
         lines.map { |l| indent + l }.join("\n")
       end.join("\n\n")
+
+      if first_line_already_indented
+        text[indentation..-1]
+      else
+        text
+      end
     end
 
     # @param [String] s The string to format
@@ -102,7 +109,5 @@ module Cri
         s
       end
     end
-
   end
-
 end

data/lib/cri/version.rb

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

data/test/helper.rb

@@ -10,45 +10,45 @@ require 'cri'
 
 require 'stringio'
 
-class Cri::TestCase < Minitest::Test
-
-  def setup
-    @orig_io = capture_io
-  end
-
-  def teardown
-    uncapture_io(*@orig_io)
-  end
-
-  def capture_io_while(&block)
-    orig_io = capture_io
-    block.call
-    [ $stdout.string, $stderr.string ]
-  ensure
-    uncapture_io(*orig_io)
-  end
-
-  def lines(string)
-    string.scan(/^.*\n/).map { |s| s.chomp }
+module Cri
+  class TestCase < Minitest::Test
+    def setup
+      @orig_io = capture_io
+    end
+
+    def teardown
+      uncapture_io(*@orig_io)
+    end
+
+    def capture_io_while(&block)
+      orig_io = capture_io
+      block.call
+      [$stdout.string, $stderr.string]
+    ensure
+      uncapture_io(*orig_io)
+    end
+
+    def lines(string)
+      string.scan(/^.*\n/).map { |s| s.chomp }
+    end
+
+    private
+
+    def capture_io
+      orig_stdout = $stdout
+      orig_stderr = $stderr
+
+      $stdout = StringIO.new
+      $stderr = StringIO.new
+
+      [orig_stdout, orig_stderr]
+    end
+
+    def uncapture_io(orig_stdout, orig_stderr)
+      $stdout = orig_stdout
+      $stderr = orig_stderr
+    end
   end
-
-private
-
-  def capture_io
-    orig_stdout = $stdout
-    orig_stderr = $stderr
-
-    $stdout = StringIO.new
-    $stderr = StringIO.new
-
-    [ orig_stdout, orig_stderr ]
-  end
-
-  def uncapture_io(orig_stdout, orig_stderr)
-    $stdout = orig_stdout
-    $stderr = orig_stderr
-  end
-
 end
 
 # Unexpected system exit is unexpected

data/test/test_argument_array.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
 
-class Cri::ArgumentArrayTestCase < Cri::TestCase
-
-  def test_initialize
-    arr = Cri::ArgumentArray.new([ 'foo', 'bar', '--', 'baz' ])
-    assert_equal [ 'foo', 'bar', 'baz' ], arr
-    assert_equal [ 'foo', 'bar', '--', 'baz' ], arr.raw
+module Cri
+  class ArgumentArrayTestCase < Cri::TestCase
+    def test_initialize
+      arr = Cri::ArgumentArray.new(['foo', 'bar', '--', 'baz'])
+      assert_equal %w(foo bar baz), arr
+      assert_equal ['foo', 'bar', '--', 'baz'], arr.raw
+    end
   end
-
 end

data/test/test_base.rb

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

data/test/test_basic_help.rb

@@ -1,67 +1,67 @@
 # encoding: utf-8
 
-class Cri::BasicHelpTestCase < Cri::TestCase
+module Cri
+  class BasicHelpTestCase < Cri::TestCase
+    def test_run_without_supercommand
+      cmd = Cri::Command.new_basic_help
 
-  def test_run_without_supercommand
-    cmd = Cri::Command.new_basic_help
-
-    assert_raises Cri::NoHelpAvailableError do
-      cmd.run([])
-    end
-  end
-
-  def test_run_with_supercommand
-    cmd = Cri::Command.define do
-      name 'meh'
+      assert_raises Cri::NoHelpAvailableError do
+        cmd.run([])
+      end
     end
 
-    help_cmd = Cri::Command.new_basic_help
-    cmd.add_command(help_cmd)
+    def test_run_with_supercommand
+      cmd = Cri::Command.define do
+        name 'meh'
+      end
 
-    help_cmd.run([])
-  end
+      help_cmd = Cri::Command.new_basic_help
+      cmd.add_command(help_cmd)
 
-  def test_run_with_chain_of_commands
-    cmd = Cri::Command.define do
-      name 'root'
-      summary 'I am root!'
+      help_cmd.run([])
+    end
 
-      subcommand do
-        name 'foo'
-        summary 'I am foo!'
+    def test_run_with_chain_of_commands
+      cmd = Cri::Command.define do
+        name 'root'
+        summary 'I am root!'
 
         subcommand do
-          name 'subsubby'
-          summary 'I am subsubby!'
+          name 'foo'
+          summary 'I am foo!'
+
+          subcommand do
+            name 'subsubby'
+            summary 'I am subsubby!'
+          end
         end
       end
-    end
 
-    help_cmd = Cri::Command.new_basic_help
-    cmd.add_command(help_cmd)
+      help_cmd = Cri::Command.new_basic_help
+      cmd.add_command(help_cmd)
 
-    # Simple call
-    stdout, stderr = capture_io_while do
-      help_cmd.run([ 'foo' ])
-    end
-    assert_match(/I am foo!/m, stdout)
-    assert_equal('', stderr)
+      # Simple call
+      stdout, stderr = capture_io_while do
+        help_cmd.run(['foo'])
+      end
+      assert_match(/I am foo!/m, stdout)
+      assert_equal('', stderr)
 
-    # Subcommand
-    stdout, stderr = capture_io_while do
-      help_cmd.run([ 'foo', 'subsubby' ])
-    end
-    assert_match(/I am subsubby!/m, stdout)
-    assert_equal('', stderr)
+      # Subcommand
+      stdout, stderr = capture_io_while do
+        help_cmd.run(%w(foo subsubby))
+      end
+      assert_match(/I am subsubby!/m, stdout)
+      assert_equal('', stderr)
 
-    # Non-existing subcommand
-    stdout, stderr = capture_io_while do
-      assert_raises SystemExit do
-        help_cmd.run([ 'foo', 'mysterycmd' ])
+      # Non-existing subcommand
+      stdout, stderr = capture_io_while do
+        assert_raises SystemExit do
+          help_cmd.run(%w(foo mysterycmd))
+        end
       end
+      assert_equal '', stdout
+      assert_match(/foo: unknown command 'mysterycmd'/, stderr)
     end
-    assert_equal '', stdout
-    assert_match(/foo: unknown command 'mysterycmd'/, stderr)
   end
-
 end

data/test/test_basic_root.rb

@@ -1,17 +1,17 @@
 # encoding: utf-8
 
-class Cri::BasicRootTestCase < Cri::TestCase
+module Cri
+  class BasicRootTestCase < Cri::TestCase
+    def test_run_with_help
+      cmd = Cri::Command.new_basic_root
 
-  def test_run_with_help
-    cmd = Cri::Command.new_basic_root
-
-    stdout, stderr = capture_io_while do
-      assert_raises SystemExit do
-        cmd.run(%w( -h ))
+      stdout, _stderr = capture_io_while do
+        assert_raises SystemExit do
+          cmd.run(%w( -h ))
+        end
       end
-    end
 
-    assert stdout =~ /COMMANDS.*\n.*help.*show help/
+      assert stdout =~ /COMMANDS.*\n.*help.*show help/
+    end
   end
-
 end