cri 2.10.1 → 2.11.0

data/test/test_command_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 module Cri
@@ -39,12 +41,12 @@ module Cri
       expected_option_definitions =
         Set.new(
           [
-            { short: 'a', long: 'aaa', desc: 'opt a', argument: :optional,  multiple: true, hidden: false, block: nil, default: nil },
-            { short: 'b', long: 'bbb', desc: 'opt b', argument: :required,  multiple: false, hidden: false, block: nil, default: nil },
-            { short: 'c', long: 'ccc', desc: 'opt c', argument: :optional,  multiple: false, hidden: false, block: nil, default: nil },
-            { short: 'd', long: 'ddd', desc: 'opt d', argument: :forbidden, multiple: false, hidden: false, block: nil, default: nil },
-            { short: 'e', long: 'eee', desc: 'opt e', argument: :forbidden, multiple: false, hidden: false, block: nil, default: nil },
-            { short: 'f', long: 'fff', desc: 'opt f', argument: :forbidden, multiple: false, hidden: true,  block: nil, default: nil },
+            { short: 'a', long: 'aaa', desc: 'opt a', argument: :optional,  multiple: true,  hidden: false, block: nil, default: nil, transform: nil },
+            { short: 'b', long: 'bbb', desc: 'opt b', argument: :required,  multiple: false, hidden: false, block: nil, default: nil, transform: nil },
+            { short: 'c', long: 'ccc', desc: 'opt c', argument: :optional,  multiple: false, hidden: false, block: nil, default: nil, transform: nil },
+            { short: 'd', long: 'ddd', desc: 'opt d', argument: :forbidden, multiple: false, hidden: false, block: nil, default: nil, transform: nil },
+            { short: 'e', long: 'eee', desc: 'opt e', argument: :forbidden, multiple: false, hidden: false, block: nil, default: nil, transform: nil },
+            { short: 'f', long: 'fff', desc: 'opt f', argument: :forbidden, multiple: false, hidden: true,  block: nil, default: nil, transform: nil },
           ],
         )
       actual_option_definitions = Set.new(command.option_definitions)
@@ -78,8 +80,8 @@ module Cri
       expected_option_definitions =
         Set.new(
           [
-            { short: 's', long: nil, desc: 'short', argument: :forbidden, multiple: false, hidden: false, block: nil, default: nil },
-            { short: nil, long: 'long', desc: 'long', argument: :forbidden, multiple: false, hidden: false, block: nil, default: nil },
+            { short: 's', long: nil,    desc: 'short', argument: :forbidden, multiple: false, hidden: false, block: nil, default: nil, transform: nil },
+            { short: nil, long: 'long', desc: 'long',  argument: :forbidden, multiple: false, hidden: false, block: nil, default: nil, transform: nil },
           ],
         )
       actual_option_definitions = Set.new(command.option_definitions)
@@ -102,9 +104,9 @@ module Cri
       expected_option_definitions =
         Set.new(
           [
-            { short: 'f', long: 'flag',     desc: 'flag', argument: :forbidden, multiple: true, hidden: false, block: nil, default: nil },
-            { short: 'r', long: 'required', desc: 'req',  argument: :required,  multiple: true, hidden: false, block: nil, default: nil },
-            { short: 'o', long: 'optional', desc: 'opt',  argument: :optional,  multiple: true, hidden: false, block: nil, default: nil },
+            { short: 'f', long: 'flag',     desc: 'flag', argument: :forbidden, multiple: true, hidden: false, block: nil, default: nil, transform: nil },
+            { short: 'r', long: 'required', desc: 'req',  argument: :required,  multiple: true, hidden: false, block: nil, default: nil, transform: nil },
+            { short: 'o', long: 'optional', desc: 'opt',  argument: :optional,  multiple: true, hidden: false, block: nil, default: nil, transform: nil },
           ],
         )
       actual_option_definitions = Set.new(command.option_definitions)
@@ -127,9 +129,9 @@ module Cri
       expected_option_definitions =
         Set.new(
           [
-            { short: 'f', long: 'flag',     desc: 'flag', argument: :forbidden, multiple: false, hidden: true, block: nil, default: nil },
-            { short: 'r', long: 'required', desc: 'req',  argument: :required,  multiple: false, hidden: true, block: nil, default: nil },
-            { short: 'o', long: 'optional', desc: 'opt',  argument: :optional,  multiple: false, hidden: true, block: nil, default: nil },
+            { short: 'f', long: 'flag',     desc: 'flag', argument: :forbidden, multiple: false, hidden: true, block: nil, default: nil, transform: nil },
+            { short: 'r', long: 'required', desc: 'req',  argument: :required,  multiple: false, hidden: true, block: nil, default: nil, transform: nil },
+            { short: 'o', long: 'optional', desc: 'opt',  argument: :optional,  multiple: false, hidden: true, block: nil, default: nil, transform: nil },
           ],
         )
       actual_option_definitions = Set.new(command.option_definitions)
@@ -222,7 +224,7 @@ module Cri
     def test_runner
       # Define
       dsl = Cri::CommandDSL.new
-      dsl.instance_eval <<-EOS
+      dsl.instance_eval(<<-CMD, __FILE__, __LINE__ + 1)
         class Cri::CommandDSLTestCaseCommandRunner < Cri::CommandRunner
           def run
             $did_it_work = arguments[0]
@@ -230,7 +232,7 @@ module Cri
         end
 
         runner Cri::CommandDSLTestCaseCommandRunner
-  EOS
+      CMD
       command = dsl.command
 
       # Check

data/test/test_command_runner.rb

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

data/test/test_help_renderer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 module Cri
@@ -10,22 +12,22 @@ module Cri
     end
 
     def test_simple
-      expected = <<EOS
-NAME
-    help - show help
-
-USAGE
-    help [command_name]
-
-DESCRIPTION
-    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.
-
-OPTIONS
-    -v --verbose      show more detailed help
-EOS
+      expected = <<~HELP
+        NAME
+            help - show help
+
+        USAGE
+            help [command_name]
+
+        DESCRIPTION
+            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.
+
+        OPTIONS
+            -v --verbose      show more detailed help
+      HELP
 
       cmd = Cri::Command.new_basic_help
       assert_equal(expected, help_for(cmd))

data/test/test_option_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 module Cri
@@ -255,8 +257,7 @@ module Cri
       parser = Cri::OptionParser.parse(input, definitions)
 
       assert_equal({}, parser.options)
-      assert_equal(['foo', 'bar', '-x', '--yyy', '-abc'],       parser.arguments)
-      assert_equal(['foo', 'bar', '--', '-x', '--yyy', '-abc'], parser.arguments.raw)
+      assert_equal(['foo', 'bar', '-x', '--yyy', '-abc'], parser.arguments)
     end
 
     def test_parse_with_end_marker_between_option_key_and_value
@@ -406,5 +407,78 @@ module Cri
       assert_equal({ aaa: true, bbb: 'xxx', ccc: 'c default' }, parser.options)
       assert_equal(%w[foo], parser.arguments)
     end
+
+    def test_parse_with_transform_proc
+      input       = %w[--port 123]
+      definitions = [
+        { long: 'port', short: 'p', argument: :required, transform: ->(x) { Integer(x) } },
+      ]
+
+      parser = Cri::OptionParser.parse(input, definitions)
+
+      assert_equal({ port: 123 }, parser.options)
+      assert_equal([], parser.arguments)
+    end
+
+    def test_parse_with_transform_method
+      input       = %w[--port 123]
+      definitions = [
+        { long: 'port', short: 'p', argument: :required, transform: method(:Integer) },
+      ]
+
+      parser = Cri::OptionParser.parse(input, definitions)
+
+      assert_equal({ port: 123 }, parser.options)
+      assert_equal([], parser.arguments)
+    end
+
+    def test_parse_with_transform_object
+      port = Class.new do
+        def call(str)
+          Integer(str)
+        end
+      end.new
+
+      input       = %w[--port 123]
+      definitions = [
+        { long: 'port', short: 'p', argument: :required, transform: port },
+      ]
+
+      parser = Cri::OptionParser.parse(input, definitions)
+
+      assert_equal({ port: 123 }, parser.options)
+      assert_equal([], parser.arguments)
+    end
+
+    def test_parse_with_transform_default
+      port = Class.new do
+        def call(str)
+          raise unless str.is_a?(String)
+          Integer(str)
+        end
+      end.new
+
+      input       = %w[]
+      definitions = [
+        { long: 'port', short: 'p', argument: :required, default: 8080, transform: port },
+      ]
+
+      parser = Cri::OptionParser.parse(input, definitions)
+
+      assert_equal({ port: 8080 }, parser.options)
+      assert_equal([], parser.arguments)
+    end
+
+    def test_parse_with_transform_exception
+      input       = %w[--port one_hundred_and_twenty_three]
+      definitions = [
+        { long: 'port', short: 'p', argument: :required, transform: method(:Integer) },
+      ]
+
+      exception = assert_raises(Cri::OptionParser::IllegalOptionValueError) do
+        Cri::OptionParser.parse(input, definitions)
+      end
+      assert_equal('invalid value "one_hundred_and_twenty_three" for --port option', exception.message)
+    end
   end
 end

data/test/test_string_formatter.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cri
 version: !ruby/object:Gem::Version
-  version: 2.10.1
+  version: 2.11.0
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-28 00:00:00.000000000 Z
+date: 2018-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -45,7 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.adoc
+- README.md
 - NEWS.md
 files:
 - CODE_OF_CONDUCT.md
@@ -53,25 +53,21 @@ files:
 - Gemfile.lock
 - LICENSE
 - NEWS.md
-- README.adoc
+- README.md
 - Rakefile
 - cri.gemspec
 - lib/cri.rb
-- lib/cri/argument_array.rb
 - lib/cri/command.rb
 - lib/cri/command_dsl.rb
 - lib/cri/command_runner.rb
 - lib/cri/commands/basic_help.rb
 - lib/cri/commands/basic_root.rb
-- lib/cri/core_ext.rb
-- lib/cri/core_ext/string.rb
 - lib/cri/help_renderer.rb
 - lib/cri/option_parser.rb
 - lib/cri/platform.rb
 - lib/cri/string_formatter.rb
 - lib/cri/version.rb
 - test/helper.rb
-- test/test_argument_array.rb
 - test/test_base.rb
 - test/test_basic_help.rb
 - test/test_basic_root.rb
@@ -88,14 +84,14 @@ metadata: {}
 post_install_message: 
 rdoc_options:
 - "--main"
-- README.adoc
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -103,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: a library for building easy-to-use command-line tools

data/lib/cri/argument_array.rb

@@ -1,21 +0,0 @@
-module Cri
-  # Represents an array of arguments. It is an array that strips separator
-  # arguments (`--`) but provides a `#raw` method to get the raw arguments
-  # array, i.e. an array that includes the separator `--` arguments.
-  class ArgumentArray < Array
-    # Initializes the array using the given raw arguments.
-    #
-    # @param [Array<String>] raw_arguments A list of raw arguments, i.e.
-    #   including any separator arguments (`--`).
-    def initialize(raw_arguments)
-      super(raw_arguments.reject { |a| a == '--' })
-      @raw_arguments = raw_arguments
-    end
-
-    # @return [Array<String>] The arguments, including any separator arguments
-    #   (`--`)
-    def raw
-      @raw_arguments
-    end
-  end
-end

data/lib/cri/core_ext.rb

@@ -1,10 +0,0 @@
-module Cri
-  module CoreExtensions
-  end
-end
-
-require 'cri/core_ext/string'
-
-class String
-  include Cri::CoreExtensions::String
-end

data/lib/cri/core_ext/string.rb

@@ -1,33 +0,0 @@
-require 'colored'
-
-module Cri
-  module CoreExtensions
-    # @deprecated
-    module String
-      # @see Cri::StringFormatter#to_paragraphs
-      def to_paragraphs
-        Cri::StringFormatter.new.to_paragraphs(self)
-      end
-
-      # @see Cri::StringFormatter#to_paragraphs
-      def wrap_and_indent(width, indentation)
-        Cri::StringFormatter.new.wrap_and_indent(self, width, indentation)
-      end
-
-      # @see Cri::StringFormatter#format_as_title
-      def formatted_as_title
-        Cri::StringFormatter.new.format_as_title(self)
-      end
-
-      # @see Cri::StringFormatter#format_as_command
-      def formatted_as_command
-        Cri::StringFormatter.new.format_as_command(self)
-      end
-
-      # @see Cri::StringFormatter#format_as_option
-      def formatted_as_option
-        Cri::StringFormatter.new.format_as_option(self)
-      end
-    end
-  end
-end

data/test/test_argument_array.rb

@@ -1,11 +0,0 @@
-require 'helper'
-
-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