cri 2.15.6 → 2.15.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79a5265f39985bdcfc272fda054b0c9351be2e249d14ce8dd85d3cbff3964479
-  data.tar.gz: 9dcbb3ab7addc6dda23d1419370882401b91747c754e6a39d7777bbfc8e6c354
+  metadata.gz: 961c45fae4395d1aad6d4f3d79ccf4b00c32bbd38f816d52df500aea7c782da5
+  data.tar.gz: 7917db80f32845b87f5cc6942623a1ee34e5d83058cc526100afc07ea412b246
 SHA512:
-  metadata.gz: 2e5fd6d1a6c496fb1887e99c02255f438b9fa6734180bb2d09d3dbb349f30136ee16007195c2848bdb26d797f38c6d22473beaa06bf7bdc7d86734619955136d
-  data.tar.gz: c02067bfb085935f46cf8b35c37862a3eac282c1dfe2eb3bc6c6162f1370d4c5bfa390a2d8a80fc536e7207a5031e225c2e7c7a3bdf3ae8efa329c561402f8b2
+  metadata.gz: 48b820bcb56c95e6ff4594db88a814c72b5c10868e971a03236d47d4826af789228e9f38e6b7d926450bbb0700aac84d575b4cd613ad5a20f8adfcfa5f220606
+  data.tar.gz: f84359f5f263d1ab38400a8b4667e8b47c2cf0b9a8ef883e8896e7c86a39b5ecc874e146f215a855c116d1863e68e62f29164c50a61f99e00ec07938ca85aaee

data/Gemfile

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls'
+gem 'm', '~> 1.5'
 gem 'minitest'
 gem 'rake'
 gem 'rubocop'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cri (2.15.6)
+    cri (2.15.7)
 
 GEM
   remote: https://rubygems.org/
@@ -16,20 +16,24 @@ GEM
     docile (1.3.1)
     jaro_winkler (1.5.2)
     json (2.2.0)
+    m (1.5.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (0.9.2)
     minitest (5.11.3)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (12.3.2)
-    rubocop (0.69.0)
+    rubocop (0.70.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.0)
+    ruby-progressbar (1.10.1)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -48,6 +52,7 @@ PLATFORMS
 DEPENDENCIES
   coveralls
   cri!
+  m (~> 1.5)
   minitest
   rake
   rubocop

data/NEWS.md

@@ -1,5 +1,11 @@
 # Cri News
 
+## 2.15.7
+
+Fixes:
+
+* Options with a forbidden argument now default to false, rather than nil (#94, #96)
+
 ## 2.15.6
 
 Fixes:

data/README.md

@@ -14,6 +14,13 @@ nested commands.
 
 Cri requires Ruby 2.3 or newer.
 
+## Compatibility policy
+
+Cri is guaranteed to be supported on any [officially supported Ruby version](https://www.ruby-lang.org/en/downloads/branches/), as well as the version of Ruby that comes by default on
+
+* the last two [Ubuntu LTS releases](https://wiki.ubuntu.com/Releases)
+* the last two major [macOS releases](https://en.wikipedia.org/wiki/MacOS_version_history)
+
 ## Usage
 
 The central concept in Cri is the _command_, which has option definitions as

data/lib/cri/command.rb

@@ -346,6 +346,16 @@ module Cri
         local_opts  = parser.options
         global_opts = parent_opts.merge(parser.options)
 
+        # Set defaults
+        all_opt_defns.each do |opt_defn|
+          key = (opt_defn.long || opt_defn.short).to_sym
+
+          next if opt_defn.default.nil?
+          next if global_opts.key?(key)
+
+          global_opts[key] = opt_defn.default
+        end
+
         # Handle options
         handle_options(local_opts)
         args = handle_errors_while { parser.gen_argument_list }
@@ -359,6 +369,10 @@ module Cri
       block.call(global_opts, args, self)
     end
 
+    def all_opt_defns
+      supercommand ? supercommand.all_opt_defns.merge(option_definitions) : option_definitions
+    end
+
     # @return [String] The help text for this command
     #
     # @option params [Boolean] :verbose true if the help output should be

data/lib/cri/option_definition.rb

@@ -31,6 +31,8 @@ module Cri
       if @default && @argument == :forbidden
         raise ArgumentError, 'a default value cannot be specified for flag options'
       end
+
+      @default = false if @argument == :forbidden
     end
 
     def to_h

data/lib/cri/parser.rb

@@ -118,8 +118,6 @@ module Cri
         end
       end
 
-      add_defaults
-
       self
     ensure
       @running = false
@@ -133,10 +131,6 @@ module Cri
 
     private
 
-    def add_defaults
-      @option_defns.each { |d| add_default_option(d) }
-    end
-
     def handle_dashdash(elem)
       add_argument(elem)
       @no_more_options = true
@@ -223,16 +217,6 @@ module Cri
       delegate&.option_added(key, value, self)
     end
 
-    def add_default_option(option_defn)
-      key = key_for(option_defn)
-      return if options.key?(key)
-
-      value = option_defn.default
-      return unless value
-
-      add_option(option_defn, value, transform: false)
-    end
-
     def transform_value(option_defn, value)
       transformer = option_defn.transform
 

data/lib/cri/version.rb

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

data/test/test_command.rb

@@ -126,7 +126,7 @@ module Cri
         simple_cmd.run(%w[])
       end
 
-      assert_equal ['Awesome moo!', '', ''], lines(out)
+      assert_equal ['Awesome moo!', '', 'ddd=false,eee=false'], lines(out)
       assert_equal [], lines(err)
     end
 
@@ -135,7 +135,7 @@ module Cri
         simple_cmd.run(%w[abc xyz])
       end
 
-      assert_equal ['Awesome moo!', 'abc,xyz', ''], lines(out)
+      assert_equal ['Awesome moo!', 'abc,xyz', 'ddd=false,eee=false'], lines(out)
       assert_equal [], lines(err)
     end
 
@@ -144,7 +144,7 @@ module Cri
         simple_cmd.run(%w[-c -b x])
       end
 
-      assert_equal ['Awesome moo!', '', 'bbb=x,ccc=true'], lines(out)
+      assert_equal ['Awesome moo!', '', 'bbb=x,ccc=true,ddd=false,eee=false'], lines(out)
       assert_equal [], lines(err)
     end
 
@@ -216,7 +216,7 @@ module Cri
         simple_cmd.run(%w[-a 123])
       end
 
-      assert_equal ['moo:123', 'Awesome moo!', '', 'aaa=123'], lines(out)
+      assert_equal ['moo:123', 'Awesome moo!', '', 'aaa=123,ddd=false,eee=false'], lines(out)
       assert_equal [], lines(err)
     end
 
@@ -246,7 +246,7 @@ module Cri
         nested_cmd.run(%w[sub])
       end
 
-      assert_equal ['Sub-awesome!', '', ''], lines(out)
+      assert_equal ['Sub-awesome!', '', 'ddd=false,eee=false,ppp=false,qqq=false'], lines(out)
       assert_equal [], lines(err)
     end
 
@@ -297,7 +297,7 @@ module Cri
         nested_cmd.run(%w[sup])
       end
 
-      assert_equal ['Sub-awesome!', '', ''], lines(out)
+      assert_equal ['Sub-awesome!', '', 'ddd=false,eee=false,ppp=false,qqq=false'], lines(out)
       assert_equal [], lines(err)
     end
 
@@ -306,7 +306,7 @@ module Cri
         nested_cmd.run(%w[-a 666 sub])
       end
 
-      assert_equal ['super:666', 'Sub-awesome!', '', 'aaa=666'], lines(out)
+      assert_equal ['super:666', 'Sub-awesome!', '', 'aaa=666,ddd=false,eee=false,ppp=false,qqq=false'], lines(out)
       assert_equal [], lines(err)
     end
 
@@ -895,5 +895,73 @@ module Cri
       assert_equal ['test? true!'], lines(out)
       assert_equal [], lines(err)
     end
+
+    def test_flag_defaults_to_false
+      cmd = Cri::Command.define do
+        name 'a'
+        option :f, :force2, 'push with force', argument: :forbidden
+
+        run do |opts, _args, _cmd|
+          puts "Force? #{opts[:force2].inspect}!"
+        end
+      end
+
+      out, err = capture_io_while do
+        cmd.run(%w[])
+      end
+      assert_equal ['Force? false!'], lines(out)
+      assert_equal [], lines(err)
+    end
+
+    def test_required_option_defaults_to_given_value
+      cmd = Cri::Command.define do
+        name 'a'
+        option :a, :animal, 'specify animal', argument: :required, default: 'cow'
+
+        run do |opts, _args, _cmd|
+          puts "Animal = #{opts[:animal]}"
+        end
+      end
+
+      out, err = capture_io_while do
+        cmd.run(%w[])
+      end
+      assert_equal ['Animal = cow'], lines(out)
+      assert_equal [], lines(err)
+    end
+
+    def test_optional_option_defaults_to_given_value
+      cmd = Cri::Command.define do
+        name 'a'
+        option :a, :animal, 'specify animal', argument: :optional, default: 'cow'
+
+        run do |opts, _args, _cmd|
+          puts "Animal = #{opts[:animal]}"
+        end
+      end
+
+      out, err = capture_io_while do
+        cmd.run(%w[])
+      end
+      assert_equal ['Animal = cow'], lines(out)
+      assert_equal [], lines(err)
+    end
+
+    def test_required_option_defaults_to_given_value_with_transform
+      cmd = Cri::Command.define do
+        name 'a'
+        option :a, :animal, 'specify animal', argument: :required, transform: ->(a) { a.upcase }, default: 'cow'
+
+        run do |opts, _args, _cmd|
+          puts "Animal = #{opts[:animal]}"
+        end
+      end
+
+      out, err = capture_io_while do
+        cmd.run(%w[])
+      end
+      assert_equal ['Animal = cow'], lines(out)
+      assert_equal [], lines(err)
+    end
   end
 end

data/test/test_command_dsl.rb

@@ -41,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, 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 },
+            { 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: false, transform: nil },
+            { short: 'e', long: 'eee', desc: 'opt e', argument: :forbidden, multiple: false, hidden: false, block: nil, default: false, transform: nil },
+            { short: 'f', long: 'fff', desc: 'opt f', argument: :forbidden, multiple: false, hidden: true,  block: nil, default: false, transform: nil },
           ],
         )
       actual_option_definitions = Set.new(command.option_definitions.map(&:to_h))
@@ -80,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, transform: nil },
-            { short: nil, long: 'long', desc: 'long',  argument: :forbidden, multiple: false, hidden: false, block: nil, default: nil, transform: nil },
+            { short: 's', long: nil,    desc: 'short', argument: :forbidden, multiple: false, hidden: false, block: nil, default: false, transform: nil },
+            { short: nil, long: 'long', desc: 'long',  argument: :forbidden, multiple: false, hidden: false, block: nil, default: false, transform: nil },
           ],
         )
       actual_option_definitions = Set.new(command.option_definitions.map(&:to_h))
@@ -104,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, 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 },
+            { short: 'f', long: 'flag',     desc: 'flag', argument: :forbidden, multiple: true, hidden: false, block: nil, default: false, 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.map(&:to_h))
@@ -129,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, 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 },
+            { short: 'f', long: 'flag',     desc: 'flag', argument: :forbidden, multiple: false, hidden: true, block: nil, default: false, 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.map(&:to_h))

data/test/test_parser.rb

@@ -284,18 +284,6 @@ module Cri
       assert_equal(3, parser.options[:verbose].size)
     end
 
-    def test_parse_with_default_required_unspecified
-      input = %w[foo]
-      opt_defns = [
-        { long: 'animal', short: 'a', argument: :required, default: 'donkey' },
-      ].map { |hash| make_opt_defn(hash) }
-
-      parser = Cri::Parser.new(input, opt_defns, [], false).run
-
-      assert_equal({ animal: 'donkey' }, parser.options)
-      assert_equal(['foo'], parser.gen_argument_list.to_a)
-    end
-
     def test_parse_with_default_required_no_value
       input = %w[foo -a]
       opt_defns = [
@@ -319,18 +307,6 @@ module Cri
       assert_equal(['foo'], parser.gen_argument_list.to_a)
     end
 
-    def test_parse_with_default_optional_unspecified
-      input = %w[foo]
-      opt_defns = [
-        { long: 'animal', short: 'a', argument: :optional, default: 'donkey' },
-      ].map { |hash| make_opt_defn(hash) }
-
-      parser = Cri::Parser.new(input, opt_defns, [], false).run
-
-      assert_equal({ animal: 'donkey' }, parser.options)
-      assert_equal(['foo'], parser.gen_argument_list.to_a)
-    end
-
     def test_parse_with_default_optional_no_value
       input = %w[foo -a]
       opt_defns = [
@@ -451,26 +427,6 @@ module Cri
       assert_equal([], parser.gen_argument_list.to_a)
     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[]
-      opt_defns = [
-        { long: 'port', short: 'p', argument: :required, default: 8080, transform: port },
-      ].map { |hash| make_opt_defn(hash) }
-
-      parser = Cri::Parser.new(input, opt_defns, [], false).run
-
-      assert_equal({ port: 8080 }, parser.options)
-      assert_equal([], parser.gen_argument_list.to_a)
-    end
-
     def test_parse_with_transform_exception
       input = %w[--port one_hundred_and_twenty_three]
       opt_defns = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cri
 version: !ruby/object:Gem::Version
-  version: 2.15.6
+  version: 2.15.7
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-19 00:00:00.000000000 Z
+date: 2019-05-30 00:00:00.000000000 Z
 dependencies: []
 description: Cri allows building easy-to-use command-line interfaces with support
   for subcommands.