cri 2.15.7 → 2.15.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 961c45fae4395d1aad6d4f3d79ccf4b00c32bbd38f816d52df500aea7c782da5
-  data.tar.gz: 7917db80f32845b87f5cc6942623a1ee34e5d83058cc526100afc07ea412b246
+  metadata.gz: 8133dfa33226ec959daeea2060f7efc15672e642d6a9afb8c19d9e3fabd550ce
+  data.tar.gz: 5c2c3afb7da1a9ad6adff22b136cd0cea144bb8b8e451bf0b3f50849bac10c90
 SHA512:
-  metadata.gz: 48b820bcb56c95e6ff4594db88a814c72b5c10868e971a03236d47d4826af789228e9f38e6b7d926450bbb0700aac84d575b4cd613ad5a20f8adfcfa5f220606
-  data.tar.gz: f84359f5f263d1ab38400a8b4667e8b47c2cf0b9a8ef883e8896e7c86a39b5ecc874e146f215a855c116d1863e68e62f29164c50a61f99e00ec07938ca85aaee
+  metadata.gz: 4ce23dee547462ed7d5a2f5618250019f520663c0bcdd2ce4a83cdf4a69dbfebc90a22cc61368a512a250fe2960a0a452e8c40dc65cd71afdae6f249cfe3095b
+  data.tar.gz: a471a0036ced17f51a6acef3b9e04239c74cfca8a024b76bd97837c9fc19182739165412e31021d1371875cc6fcfcc55c71cdd5983e9c4208d2555160182e418

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cri (2.15.7)
+    cri (2.15.8)
 
 GEM
   remote: https://rubygems.org/
@@ -13,7 +13,7 @@ GEM
       term-ansicolor (~> 1.3)
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
-    docile (1.3.1)
+    docile (1.3.2)
     jaro_winkler (1.5.2)
     json (2.2.0)
     m (1.5.1)
@@ -26,7 +26,7 @@ GEM
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (12.3.2)
-    rubocop (0.70.0)
+    rubocop (0.71.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
@@ -42,7 +42,7 @@ GEM
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (0.20.3)
-    tins (1.20.2)
+    tins (1.20.3)
     unicode-display_width (1.6.0)
     yard (0.9.19)
 
@@ -59,4 +59,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/NEWS.md

@@ -1,5 +1,58 @@
 # Cri News
 
+## 2.15.8
+
+Fixes:
+
+* Don’t explicitly set default values for options (#99)
+
+This release reverts a backwards-incompatible change introduced in 2.15.7.
+
+To illustrate this, compare the behavior of the following command in recent versions of Cri:
+
+```ruby
+option :f, :force, 'use force', argument: :forbidden
+
+run do |opts, args, cmd|
+  puts "Options = #{opts.inspect}"
+  puts "Force? #{opts[:force]}"
+  puts "Option given? #{opts.key?(:force)}"
+end
+```
+
+In Cri 2.15.6, the default is not set in the options hash, so the value is `nil` and `#key?` returns false:
+
+```sh
+% ./run
+Options = {}
+Force? nil
+Option given? false
+```
+
+This behavior was inconsistent with what was documented: flag options were (and still are) documented to default to `false` rather than `nil`.
+
+In Cri 2.15.7, the default value is `false`, and explicitly set in the options hash (`#key?` returns `true`):
+
+```sh
+% ./run
+Options = {:force=>false}
+Force? false
+Option given? true
+```
+
+This change made it impossible to detect options that were not explicitly specified, because the behavior of `#key?` also changed.
+
+In Cri 2.15.8, the default value is also `false` (as in 2.15.7), but not explicitly set in the options hash (`#key?` returns `false`, as in 2.15.6):
+
+```sh
+% ./run
+Options = {}
+Force? false
+Option given? false
+```
+
+This backwards-incompatible change was not intentional. To fix issue #94, a change in behavior was needed, but this change also affected other, previously-undefined behavior. The new behavior in 2.15.8 should fix the bug fixed in 2.15.7 (#94, #96), without causing the problems introduced in that version.
+
 ## 2.15.7
 
 Fixes:

data/README.md

@@ -267,6 +267,33 @@ OPTIONS
     -a --animal[=<value>]      add animal (default: giraffe)
 ```
 
+If the option is not given on the command line, the `options` hash will not have key for this option, but will still have a default value:
+
+```ruby
+option :a, :animal, 'add animal', default: 'giraffe', argument: :required
+
+run do |opts, args, cmd|
+  puts "Animal = #{opts[:animal]}"
+  puts "Option given? #{opts.key?(:animal)}"
+end
+```
+
+```sh
+% ./run --animal=donkey
+Animal = donkey
+Option given? true
+
+% ./run --animal=giraffe
+Animal = giraffe
+Option given? true
+
+% ./run
+Animal = giraffe
+Option given? false
+```
+
+This can be useful to distinguish between an explicitly-passed-in value and a default value. In the example above, the `animal` option is set to `giraffe` in the second and third cases, but it is possible to detect whether the value is a default or not.
+
 #### Multivalued options (`multiple:`)
 
 The `:multiple` parameter allows an option to be specified more than once on the command line. When set to `true`, multiple option valus are accepted, and the option values will be stored in an array.

data/lib/cri/command.rb

@@ -345,16 +345,7 @@ module Cri
         handle_errors_while { parser.run }
         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
+        global_opts = add_defaults(global_opts)
 
         # Handle options
         handle_options(local_opts)
@@ -442,5 +433,23 @@ module Cri
       warn "#{name}: #{e.message}"
       raise CriExitException.new(is_error: true)
     end
+
+    def add_defaults(options)
+      all_opt_defns_by_key =
+        all_opt_defns.each_with_object({}) do |opt_defn, hash|
+          key = (opt_defn.long || opt_defn.short).to_sym
+          hash[key] = opt_defn
+        end
+
+      new_options = Hash.new do |hash, key|
+        hash.fetch(key) { all_opt_defns_by_key[key]&.default }
+      end
+
+      options.each do |key, value|
+        new_options[key] = value
+      end
+
+      new_options
+    end
   end
 end

data/lib/cri/version.rb

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

data/test/test_command.rb

@@ -126,7 +126,7 @@ module Cri
         simple_cmd.run(%w[])
       end
 
-      assert_equal ['Awesome moo!', '', 'ddd=false,eee=false'], lines(out)
+      assert_equal ['Awesome moo!', '', ''], 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', 'ddd=false,eee=false'], lines(out)
+      assert_equal ['Awesome moo!', 'abc,xyz', ''], 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,ddd=false,eee=false'], lines(out)
+      assert_equal ['Awesome moo!', '', 'bbb=x,ccc=true'], 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,ddd=false,eee=false'], lines(out)
+      assert_equal ['moo:123', 'Awesome moo!', '', 'aaa=123'], lines(out)
       assert_equal [], lines(err)
     end
 
@@ -246,7 +246,7 @@ module Cri
         nested_cmd.run(%w[sub])
       end
 
-      assert_equal ['Sub-awesome!', '', 'ddd=false,eee=false,ppp=false,qqq=false'], lines(out)
+      assert_equal ['Sub-awesome!', '', ''], lines(out)
       assert_equal [], lines(err)
     end
 
@@ -297,7 +297,7 @@ module Cri
         nested_cmd.run(%w[sup])
       end
 
-      assert_equal ['Sub-awesome!', '', 'ddd=false,eee=false,ppp=false,qqq=false'], lines(out)
+      assert_equal ['Sub-awesome!', '', ''], 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,ddd=false,eee=false,ppp=false,qqq=false'], lines(out)
+      assert_equal ['super:666', 'Sub-awesome!', '', 'aaa=666'], lines(out)
       assert_equal [], lines(err)
     end
 
@@ -902,14 +902,14 @@ module Cri
         option :f, :force2, 'push with force', argument: :forbidden
 
         run do |opts, _args, _cmd|
-          puts "Force? #{opts[:force2].inspect}!"
+          puts "Force? #{opts[:force2].inspect}! Key present? #{opts.key?(:force2)}!"
         end
       end
 
       out, err = capture_io_while do
         cmd.run(%w[])
       end
-      assert_equal ['Force? false!'], lines(out)
+      assert_equal ['Force? false! Key present? false!'], lines(out)
       assert_equal [], lines(err)
     end
 
@@ -919,14 +919,14 @@ module Cri
         option :a, :animal, 'specify animal', argument: :required, default: 'cow'
 
         run do |opts, _args, _cmd|
-          puts "Animal = #{opts[:animal]}"
+          puts "Animal = #{opts[:animal]}! Key present? #{opts.key?(:animal)}!"
         end
       end
 
       out, err = capture_io_while do
         cmd.run(%w[])
       end
-      assert_equal ['Animal = cow'], lines(out)
+      assert_equal ['Animal = cow! Key present? false!'], lines(out)
       assert_equal [], lines(err)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cri
 version: !ruby/object:Gem::Version
-  version: 2.15.7
+  version: 2.15.8
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies: []
 description: Cri allows building easy-to-use command-line interfaces with support
   for subcommands.
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: a library for building easy-to-use command-line tools