cl 0.1.25 → 0.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: fdd4074de1e4d5cd388b007470f2670288ceea192d9759e8a2f023970ae814eb
-  data.tar.gz: 9e65045265af54581182190eb281f594e6154d2db4bd54481af2e894405b6d02
+SHA1:
+  metadata.gz: cfda6ea85d151f58e3705bebe492eae526565db9
+  data.tar.gz: 491a59779fb7c13c144f89f2af7cfc1938466bad
 SHA512:
-  metadata.gz: 71b0cb12a6a341e6dc92c11f0035550cea52978419bd4f9038f62e2590aa8782486f752742d22060a23a2d70aed0b08e12e8fa564d7d1898f7a8e6c707249f7a
-  data.tar.gz: e7c17550880c5fd107a3e1afb463e6057fbfb834481c87e58cef744b044f98feef6e501137835b6fd2f9893669bad0999b3fa5ced89ce794e11b6079b1d970f9
+  metadata.gz: c298f35079ea96d36e2d6e8b1e9c2da37cffed21b4a380b60102beb3b8749d2374c678f550df73b5f30f2dfc5fd7182bbaed330f490dce2daaa0f6b2f3ebc577
+  data.tar.gz: 6728ad70ef348061b6b555144e6dfab65b6187aff46bd5c3816c9192e8b6d0449290185dccf062db9393748a2554c7277927b10b027fb6920f1dac6f7ae1b4e7

data/CHANGELOG.md

@@ -21,6 +21,7 @@
 * Add `opt '--one STR', downcase: true`
 * Add `opt '--one STR', internal: true`, hide internal options from help output
 * Add `opt '--one STR', example: 'foo'`
+* Add `opt '--one STR', negate: %w(skip)`
 * Add `opt '--one STR', note: 'note'`
 * Add `opt '--one STR', see: 'https://provider.com/docs'
 * Add `opt '--one STR', secret: true`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cl (0.1.23)
+    cl (0.1.25)
       regstry (~> 1.0.3)
 
 GEM

data/README.md

@@ -37,6 +37,7 @@ Further documentation is available on [rubydoc.info](https://www.rubydoc.info/gi
     * [Format](#format)
     * [Internal](#internal)
     * [Min and Max](#min-and-max)
+    * [Negations](#negations)
     * [Note](#note)
     * [Secret](#secret)
     * [See Also](#see-also)
@@ -655,14 +656,14 @@ Cl.new('owners').run(%w(add --to one))
 
 Cl.new('owners').run(['add', '--to', 'does not match!'])
 
-Invalid format: to (format: /^\w+$/)
-
-Usage: format add [options]
-
-Options:
-
-  --to GROUP      type: string, format: /^\w+$/
-  --help          Get help on this command
+# Invalid format: to (format: /^\w+$/)
+#
+# Usage: format add [options]
+#
+# Options:
+#
+#   --to GROUP      type: string, format: /^\w+$/
+#   --help          Get help on this command
 
 ```
 
@@ -727,6 +728,39 @@ Cl.new('owners').run(%w(add --retries 10))
 
 ```
 
+#### Negations
+
+Flags (boolean options) automatically allow negation using `--no-*` and
+`--no_*` using OptionParser's support for these. However, sometimes it can be
+convenient to allow other terms for negating an option. Flags therefore accept
+an option `negate` like so:
+
+```ruby
+class Add < Cl::Cmd
+  opt '--notifications', 'Send out notifications to the team', negate: %w(skip)
+
+  def run
+    p notifications?
+  end
+end
+
+Cl.new('owners').run(%w(add --notifications))
+# => true
+
+Cl.new('owners').run(%w(add --no_notifications))
+# => false
+
+Cl.new('owners').run(%w(add --no-notifications))
+# => false
+
+Cl.new('owners').run(%w(add --skip_notifications))
+# => false
+
+Cl.new('owners').run(%w(add --skip-notifications))
+# => false
+
+```
+
 #### Note
 
 Options can have a note that will be printed in the help output.

data/examples/readme/format

@@ -19,11 +19,11 @@ Cl.new('owners').run(%w(add --to one))
 
 Cl.new('owners').run(['add', '--to', 'does not match!'])
 
-Invalid format: to (format: /^\w+$/)
-
-Usage: format add [options]
-
-Options:
-
-  --to GROUP      type: string, format: /^\w+$/
-  --help          Get help on this command
+# Invalid format: to (format: /^\w+$/)
+#
+# Usage: format add [options]
+#
+# Options:
+#
+#   --to GROUP      type: string, format: /^\w+$/
+#   --help          Get help on this command

data/examples/readme/negate

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--notifications', 'Send out notifications to the team', negate: %w(skip)
+
+  def run
+    p notifications?
+  end
+end
+
+Cl.new('owners').run(%w(add --notifications))
+# => true
+
+Cl.new('owners').run(%w(add --no_notifications))
+# => false
+
+Cl.new('owners').run(%w(add --no-notifications))
+# => false
+
+Cl.new('owners').run(%w(add --skip_notifications))
+# => false
+
+Cl.new('owners').run(%w(add --skip-notifications))
+# => false

data/lib/cl/opt.rb

@@ -41,6 +41,10 @@ class Cl
       strs.any? { |str| str.split(' ').size > 1 } ? :string : :flag
     end
 
+    def flag?
+      type == :flag
+    end
+
     def int?
       type == :int || type == :integer
     end
@@ -71,7 +75,7 @@ class Cl
     end
 
     def default?
-      !!default
+      opts.key?(:default)
     end
 
     def default
@@ -87,12 +91,7 @@ class Cl
     end
 
     def known?(value)
-      enum.include?(value)
-      enum.any? { |obj| matches?(obj, value) }
-    end
-
-    def matches?(obj, value)
-      obj.is_a?(Regexp) ? obj =~ value.to_s : obj == value
+      enum.any? { |obj| obj.is_a?(Regexp) ? obj =~ value.to_s : obj == value }
     end
 
     def example?
@@ -136,6 +135,14 @@ class Cl
       opts[:max]
     end
 
+    def negate?
+      !!opts[:negate]
+    end
+
+    def negate
+      Array(opts[:negate])
+    end
+
     def note?
       !!opts[:note]
     end

data/lib/cl/parser.rb

@@ -9,22 +9,28 @@ class Cl
 
       super do
         opts.each do |opt|
-          on(*dasherize(*opt.strs)) do |value|
+          on(*args_for(opt, opt.strs)) do |value|
             set(opt, value)
           end
 
           opt.aliases.each do |name|
-            on(*dasherize(aliased(opt, name))) do |value|
+            on(*args_for(opt, [aliased(opt, name)])) do |value|
               @opts[name] = set(opt, value)
             end
           end
         end
       end
 
-      args.replace(dasherize(*args))
+      args.replace(normalize(opts, args))
       parse!(args)
     end
 
+    def args_for(opt, strs)
+      args = dasherize(strs)
+      args = flagerize(args) if opt.flag?
+      args
+    end
+
     def aliased(opt, name)
       str = opt.strs.detect { |str| str.start_with?('--') } || raise
       str = str.sub(opt.name.to_s, name.to_s)
@@ -33,15 +39,42 @@ class Cl
 
     # should consider negative arities (e.g. |one, *two|)
     def set(opt, value)
+      value = true if value.nil? && opt.flag?
       args = [opts, opt.type, opt.name, value]
       args = args[-opt.block.arity, opt.block.arity]
       instance_exec(*args, &opt.block)
     end
 
+    def normalize(opts, args)
+      args = noize(opts, args)
+      dasherize(args)
+    end
+
+    def noize(opts, args)
+      args.map do |arg|
+        str = negation(opts, arg)
+        str ? arg.sub(/^--#{str}[-_]+/, '--no-') : arg
+      end
+    end
+
+    def negation(opts, arg)
+      opts.detect do |opt|
+        str = opt.negate.detect { |str| arg =~ /^--#{str}[-_]+/ }
+        break str if str
+      end
+    end
+
     DASHERIZE = /^--([^= ])*/
 
-    def dasherize(*strs)
-      strs.map { |str| str.gsub(DASHERIZE) { |opt| opt.gsub('_', '-') } }
+    def dasherize(strs)
+      strs.map do |str|
+        str.is_a?(String) ? str.gsub(DASHERIZE) { |opt| opt.gsub('_', '-') } : str
+      end
+    end
+
+    def flagerize(strs)
+      strs = strs.map { |str| str.include?(' ') ? str : "#{str} [true|false|yes|no]" }
+      strs << TrueClass
     end
   end
 end

data/lib/cl/version.rb

@@ -1,3 +1,3 @@
 class Cl
-  VERSION = '0.1.25'
+  VERSION = '0.1.26'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cl
 version: !ruby/object:Gem::Version
-  version: 0.1.25
+  version: 0.1.26
 platform: ruby
 authors:
 - Sven Fuchs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-27 00:00:00.000000000 Z
+date: 2019-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: regstry
@@ -70,6 +70,7 @@ files:
 - examples/readme/example
 - examples/readme/format
 - examples/readme/internal
+- examples/readme/negate
 - examples/readme/note
 - examples/readme/opts
 - examples/readme/opts_block
@@ -124,7 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Object-oriented OptionParser based CLI support