cl 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da6cdad4d896abab8412852de0be59f703cd8ac6f0e45a48f79f918d5d62af07
-  data.tar.gz: e0b943d332a2879a408f242c4704f53b43a27f18f7b59aaf4fade5e85aade13f
+  metadata.gz: 8887728de74e5c76602f7aacb96b7681f89186b8f9688c9a2fe5dc239a921dbe
+  data.tar.gz: a7105d685d6965d82179c9f7b329d185016dd808b4468a0aa17d7f6f61fbfb25
 SHA512:
-  metadata.gz: e61008ae542e1ac9c3ec28c558ad85c64ea37bbb102c6c45a2cc91ce1acba24b5bc59a4f4b081b3c130724cf877df6b7cb9f635470d5f598f69fb9d6d7c28f8b
-  data.tar.gz: 82a49b01e5ac7f7969c701f12c78a6e345ed333e72ad006aea843cb6fe0f7d540bb143f8e4abbc9ee4c97e338cd6175a2fac1f88e0a07ada7b6f4b459a0a9cd1
+  metadata.gz: 774ddb21196dd996ed6a627e24eb67a01f0f9a4b44dbf1c04326ff1840c5c999dd4b738bdfd3e1d9d6a874cdb7f6edad8df21c2d0431755b724e47ef74e38ff8
+  data.tar.gz: baa6e4fc6ca95b7d34763422a1d25efbffad810173f8c79cc981c375a45c75c0542e9db1104cb5caa1d966aa2d7c3b3dba63f6073ed2dd8daec86466275e2a88

data/CHANGELOG.md

@@ -6,16 +6,19 @@
 
 * Add config, reading from env vars and yml files (inspired by gem-release)
 * Add `abstract` in order to signal a cmd is a base class that is not meant to be executed
-* Add `opt '--path', type: :array` for options that can be given multiple times
+* Add `required :one, [:two, :three]` (DNF, i.e: either :one or both :two and :three must be given)
+* Add `opt '--one STR', type: :array` for options that can be given multiple times
 * Add `opt '--one STR', default: 'one'`
 * Add `opt '--one STR', requires :two` or `[:two, :three]` for options that depend on other options
 * Add `opt '--one', alias: :other`
 * Add `opt '--one', deprecated: 'message'`, and `cmd.deprected_opts`, so clients can look up which deprecated options were used
 * Add `opt '--one', alias: :other, deprecated: :other`, so that `cmd.deprecated_opts` returns the alias name if it was used
-* Add `opt '--int', max: 10, type: :integer`
-* Add `opt '--one', format: /.+/`
-* Add `opt '--one', enum: ['one', 'two']`
-* Add `required :one, [:two, :three]` (DNF, i.e: either :one or both :two and :three must be given)
+* Add `opt '--int INT', max: 10, type: :integer`
+* Add `opt '--one STR', format: /.+/`
+* Add `opt '--one STR', enum: ['one', /\w+/]`
+* Add `opt '--one STR', downcase: true`
+* Add `opt '--one STR', example: 'foo'`
+* Add `opt '--one STR', see: 'https://provider.com/docs'
 
 ### Changed
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cl (0.0.4)
+    cl (0.1.1)
       regstry (~> 1.0.3)
 
 GEM
@@ -33,4 +33,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.17.2
+   2.0.1

data/NOTES.md

@@ -1,3 +1,5 @@
 - properly catch errors, see examples/cast etc
 - add conditional required: ->(opts) { opts[:key].nil? }
 
+
+- wrap long lines in help output

data/lib/cl/help/cmd.rb

@@ -102,7 +102,10 @@ class Cl
         opts << "default: #{format_default(opt)}" if opt.default?
         opts << "known values: #{opt.enum.join(', ')}" if opt.enum?
         opts << "format: #{opt.format}" if opt.format?
+        opts << "downcase: true" if opt.downcase?
         opts << "max: #{opt.max}" if opt.max?
+        opts << "e.g.: #{opt.example}" if opt.example?
+        opts << "see: #{opt.see}" if opt.see?
         opts << format_deprecated(opt) if opt.deprecated?
         opts.compact
       end
@@ -118,7 +121,7 @@ class Cl
 
       def format_type(obj)
         return obj.type unless obj.is_a?(Opt) && obj.type == :array
-        "array (can be given multiple times)"
+        "array (string, can be given multiple times)"
       end
 
       def format_default(opt)

data/lib/cl/helper.rb

@@ -8,4 +8,13 @@ class Cl
       objs.inject({}) { |lft, rgt| lft.merge(rgt, &MERGE) }
     end
   end
+
+  module Regex
+    def format_regex(str)
+      return str unless str.is_a?(Regexp)
+      "/#{str.to_s.sub('(?-mix:', '').sub(/\)$/, '')}/"
+    end
+  end
+
+  extend Merge, Regex
 end

data/lib/cl/opt.rb

@@ -2,7 +2,7 @@ require 'cl/cast'
 
 class Cl
   class Opt < Struct.new(:strs, :opts, :block)
-    include Cast
+    include Cast, Regex
 
     OPT = /^--(?:\[.*\])?(.*)$/
 
@@ -45,10 +45,6 @@ class Cl
       type == :int || type == :integer
     end
 
-    def description
-      opts[:description]
-    end
-
     def aliases?
       !!opts[:alias]
     end
@@ -57,6 +53,10 @@ class Cl
       Array(opts[:alias])
     end
 
+    def description
+      opts[:description]
+    end
+
     def deprecated?
       !!opts[:deprecated]
     end
@@ -66,6 +66,10 @@ class Cl
       [opts[:deprecated], name] if opts[:deprecated]
     end
 
+    def downcase?
+      !!opts[:downcase]
+    end
+
     def default?
       !!default
     end
@@ -84,6 +88,19 @@ class Cl
 
     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
+    end
+
+    def example?
+      !!opts[:example]
+    end
+
+    def example
+      opts[:example]
     end
 
     def format?
@@ -91,7 +108,7 @@ class Cl
     end
 
     def format
-      opts[:format].to_s.sub('(?-mix:', '').sub(/\)$/, '')
+      format_regex(opts[:format])
     end
 
     def formatted?(value)
@@ -118,6 +135,14 @@ class Cl
       Array(opts[:requires])
     end
 
+    def see?
+      !!opts[:see]
+    end
+
+    def see
+      opts[:see]
+    end
+
     def block
       # raise if no block was given, and the option's name cannot be inferred
       super || method(:assign)

data/lib/cl/opts.rb

@@ -2,7 +2,7 @@ require 'cl/opt'
 
 class Cl
   class Opts
-    include Enumerable
+    include Enumerable, Regex
 
     def define(const, *args, &block)
       opts = args.last.is_a?(Hash) ? args.pop : {}
@@ -16,6 +16,7 @@ class Cl
 
     def apply(cmd, opts)
       opts = with_defaults(cmd, opts)
+      opts = downcase(opts)
       opts = cast(opts)
       validate(cmd, opts) unless opts[:help]
       opts
@@ -106,6 +107,7 @@ class Cl
 
       def missing_requires(opts)
         select(&:requires?).map do |opt|
+          next unless opts.key?(opt.name)
           missing = opt.requires.select { |key| !opts.key?(key) }
           [opt.name, missing] if missing.any?
         end.compact
@@ -113,19 +115,24 @@ class Cl
 
       def exceeding_max(opts)
         select(&:max?).map do |opt|
-          [opt.name, opt.max] if opts[opt.name] > opt.max
+          value = opts[opt.name]
+          [opt.name, opt.max] if value && value > opt.max
         end.compact
       end
 
       def invalid_format(opts)
         select(&:format?).map do |opt|
-          [opt.name, opt.format] unless opt.formatted?(opts[opt.name])
+          value = opts[opt.name]
+          [opt.name, opt.format] if value && !opt.formatted?(value)
         end.compact
       end
 
       def unknown_values(opts)
         select(&:enum?).map do |opt|
-          [opt.name, opts[opt.name], opt.enum] unless opt.known?(opts[opt.name])
+          value = opts[opt.name]
+          next unless value && !opt.known?(value)
+          known = opt.enum.map { |str| format_regex(str) }
+          [opt.name, value, known]
         end.compact
       end
 
@@ -142,6 +149,13 @@ class Cl
         opts[key] || cmd.respond_to?(key) && cmd.send(key)
       end
 
+      def downcase(opts)
+        select(&:downcase?).inject(opts) do |opts, opt|
+          next opts unless value = opts[opt.name]
+          opts.merge(opt.name => value.to_s.downcase)
+        end
+      end
+
       def cast(opts)
         opts.map do |key, value|
           [key, self[key] ? self[key].cast(value) : value]

data/lib/cl/version.rb

@@ -1,3 +1,3 @@
 class Cl
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/cl.rb

@@ -29,8 +29,8 @@ class Cl
 
   class RequiredsOpts < OptionError
     def initialize(opts)
-      opts = opts.map { |alts| alts.map { |alt| Array(alt).join(' and ') }.join(' or ' ) }
-      super(:requires_opts, opts.join(', '))
+      opts = opts.map { |alts| alts.map { |alt| Array(alt).join(' and ') }.join(', or ' ) }
+      super(:requires_opts, opts.join('; '))
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cl
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sven Fuchs