cl 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d7b66b1117dc3bb169e4d41d91123dded7479878
-  data.tar.gz: d2fc68ec561c50b75c0d2d00ba061cbcafcdd1c3
+SHA256:
+  metadata.gz: 05d4a5fcd74cdf55dbf91276fdd200a5041c4aabef97ffa68849ad63b81b8d30
+  data.tar.gz: 143667a25f93a57662f7271353815f9c6d253055aa45510f666fb37880cdda86
 SHA512:
-  metadata.gz: dbe03ac3d14e21c1324cf477be78a0eef5e2ff430c552e2e3d3bbf69557650c845f0e71e433effd79e61c75668c2ea44ddee93240d9d83fbcb1cb87ab359f2ed
-  data.tar.gz: f0eea40b5e24b319a384ee0fd321c1f9732cf2f5991a032efc8200d0b34afdef5046cfce121decc139732b4b91fd9d8f9338a6cfed157e44a3a05820b63b44a5
+  metadata.gz: b3a7e08f7c2271b0932b424d66dde47d75c758b579f0fae714bfcd42addf7f2d0cd1a4412b156757071e079b14bb32e9fbd70e43b3fb7a056bfd8efa6e0ab554
+  data.tar.gz: 3b32efded8658b8fce630613b3391157c9b295d8861b9000ed6fa679e8e7bb44904f34e474e6783399476c17dc4adbafd1552c050005f9df19f8323f77075247

data/CHANGELOG.md

@@ -1,10 +1,16 @@
 # Changelog
 
+## 1.0.5 (2019-08-18)
+
+### Fixed
+
+* Fix an issue with alias names that contain the aliased name
+
 ## 1.0.4 (2019-08-15)
 
 ### Fixed
 
-* Fixed enum when used with `type: :array`
+* Fix enum when used with `type: :array`
 
 ## 1.0.3 (2019-08-11)
 

data/Gemfile.lock

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

data/lib/cl.rb

@@ -56,5 +56,4 @@ class Cl
     def untaint(args)
       args.map(&:dup).each(&:untaint)
     end
-
 end

data/lib/cl/cmd.rb

@@ -29,8 +29,9 @@ class Cl
         registry.values
       end
 
-      def parse(ctx, args)
-        opts = Parser.new(self.opts, args).opts unless self == Help
+      def parse(ctx, cmd, args)
+        parser = Parser.new(cmd, args)
+        args, opts = parser.args, parser.opts unless self == Help
         opts = merge(ctx.config[registry_key], opts) if ctx.config[registry_key]
         [args, opts || {}]
       end
@@ -39,11 +40,10 @@ class Cl
     opt '--help', 'Get help on this command'
 
     attr_reader :ctx, :args
-    attr_accessor :deprecations
 
     def initialize(ctx, args)
-      args, opts = self.class.parse(ctx, args)
       @ctx = ctx
+      args, opts = self.class.parse(ctx, self, args)
       @opts = self.class.opts.apply(self, self.opts.merge(opts))
       @args = self.class.args.apply(self, args, opts)
     end
@@ -51,5 +51,9 @@ class Cl
     def opts
       @opts ||= {}
     end
+
+    def deprecations
+      @deprecations ||= {}
+    end
   end
 end

data/lib/cl/errors.rb

@@ -1,3 +1,5 @@
+require 'cl/helper/suggest'
+
 class Cl
   class Error < StandardError
     MSGS = {
@@ -23,9 +25,17 @@ class Cl
   OptionError = Class.new(Error)
 
   class UnknownCmd < Error
-    def initialize(args)
+    attr_reader :runner, :args
+
+    def initialize(runner, args)
+      @runner = runner
+      @args = args
       super(:unknown_cmd, args.join(' '))
     end
+
+    def suggestions
+      runner.suggestions(args)
+    end
   end
 
   class RequiredOpts < OptionError
@@ -65,9 +75,21 @@ class Cl
   end
 
   class UnknownValues < OptionError
+    include Suggest
+
+    attr_reader :opts
+
     def initialize(opts)
-      opts = opts.map { |(key, value, known)| "#{key}=#{value} (known values: #{known.join(', ')})" }.join(', ')
-      super(:unknown_values, opts)
+      @opts = opts
+      opts = opts.map do |(opt, values, known)|
+        pairs = values.map { |value| [opt, value].join('=') }.join(' ')
+        "#{pairs} (known values: #{known.join(', ')})"
+      end
+      super(:unknown_values, opts.join(', '))
+    end
+
+    def suggestions
+      opts.map { |_, value, known| suggest(known, value) }.flatten
     end
   end
 end

data/lib/cl/help/cmd.rb

@@ -55,7 +55,7 @@ class Cl
           opts = cmd.opts.to_a
           opts = opts.reject(&:internal?)
           opts = opts - cmd.superclass.opts.to_a if common?
-          strs = Table.new(rjust(opts.map { |opt| [*opt.strs] }))
+          strs = Table.new(rjust(opts.map { |opt| opt_strs(opt) }))
           opts = opts.map { |opt| format_obj(opt) }
           Table.new(strs.rows.zip(opts))
         end
@@ -65,12 +65,24 @@ class Cl
         @cmmn ||= begin
           opts = cmd.superclass.opts
           opts = opts.reject(&:internal?)
-          strs = Table.new(rjust(opts.map { |opt| [*opt.strs] }))
+          strs = Table.new(rjust(opts.map(&:strs)))
           opts = opts.map { |opt| format_obj(opt) }
           Table.new(strs.rows.zip(opts))
         end
       end
 
+      def opt_strs(opt)
+        return opt.strs if !opt.flag? || opt.help?
+        opts = [opt.short]
+        opts << negate(opt.long, opt.negate) if opt.long && opt.negate?
+        opts.compact
+      end
+
+      def negate(opt, negations)
+        negations = negations.map { |str| "#{str}-" }.join('|')
+        opt.dup.insert(2, "[#{negations}]")
+      end
+
       def requireds
         return unless cmd.required?
         opts = cmd.required

data/lib/cl/helper.rb

@@ -1,3 +1,5 @@
+require 'cl/helper/suggest'
+
 class Cl
   module Merge
     MERGE = ->(key, lft, rgt) do

data/lib/cl/helper/suggest.rb

@@ -0,0 +1,12 @@
+class Cl
+  module Suggest
+    include DidYouMean if defined?(DidYouMean)
+
+    def suggest(dict, value)
+      return [] unless defined?(DidYouMean)
+      Array(value).map do |value|
+        SpellChecker.new(dictionary: dict.map(&:to_s)).correct(value.to_s)
+      end.flatten
+    end
+  end
+end

data/lib/cl/opt.rb

@@ -1,9 +1,15 @@
 require 'cl/cast'
+require 'cl/errors'
 
 class Cl
   class Opt < Struct.new(:strs, :opts, :block)
     include Cast, Regex
 
+    OPTS = %i(
+      alias default deprecated description downcase eg enum example format
+      internal max min negate note required requires secret see sep type upcase
+    )
+
     OPT = /^--(?:\[.*\])?(.*)$/
 
     TYPES = {
@@ -13,9 +19,11 @@ class Cl
       boolean: :flag
     }
 
-    def initialize(*)
+    attr_reader :short, :long
+
+    def initialize(strs, *)
       super
-      noize!(strs) if type == :flag
+      @short, @long = Validator.new(strs, opts).apply
     end
 
     def define(const)
@@ -28,19 +36,22 @@ class Cl
 
     def name
       return @name if instance_variable_defined?(:@name)
-      opt = strs.detect { |str| str.start_with?('--') }
-      name = opt.split(' ').first.match(OPT)[1] if opt
+      name = long.split(' ').first.match(OPT)[1] if long
       @name = name.sub('-', '_').to_sym if name
     end
 
     def type
-      TYPES[opts[:type]] || opts[:type] || infer_type
+      @type ||= TYPES[opts[:type]] || opts[:type] || infer_type
     end
 
     def infer_type
       strs.any? { |str| str.split(' ').size > 1 } ? :string : :flag
     end
 
+    def help?
+      name == :help
+    end
+
     def flag?
       type == :flag
     end
@@ -65,13 +76,16 @@ class Cl
       opts[:description]
     end
 
-    def deprecated?
-      !!opts[:deprecated]
+    def deprecated?(name = nil)
+      name ? deprecated.first == name : !!opts[:deprecated]
     end
 
     def deprecated
+      # If it's a string then it's a deprecation message and the option itself
+      # is considered deprecated. If it's a symbol it refers to a deprecated
+      # alias, and the option's name is the deprecation message.
       return [name, opts[:deprecated]] unless opts[:deprecated].is_a?(Symbol)
-      [opts[:deprecated], name] if opts[:deprecated]
+      opts[:deprecated] ? [opts[:deprecated], name] : []
     end
 
     def downcase?
@@ -99,6 +113,11 @@ class Cl
       enum.any? { |obj| obj.is_a?(Regexp) ? obj =~ value.to_s : obj == value }
     end
 
+    def unknown(value)
+      return value.reject { |value| known?(value) } if value.is_a?(Array)
+      known?(value) ? [] : Array(value)
+    end
+
     def example?
       !!opts[:example]
     end
@@ -141,11 +160,11 @@ class Cl
     end
 
     def negate?
-      !!opts[:negate]
+      !!negate
     end
 
     def negate
-      Array(opts[:negate])
+      ['no'] + Array(opts[:negate]) if flag?
     end
 
     def note?
@@ -193,19 +212,63 @@ class Cl
       super || method(:assign)
     end
 
-    def assign(opts, type, name, value)
-      if array?
-        opts[name] ||= []
-        opts[name] << value
-      else
-        opts[name] = value
+    def assign(opts, type, _, value)
+      [name, *aliases].each do |name|
+        if array?
+          opts[name] ||= []
+          opts[name] << value
+        else
+          opts[name] = value
+        end
       end
     end
 
-    def noize!(strs)
-      strs = strs.select { |str| str.start_with?('--') }
-      strs = strs.reject { |str| str.include?('[no-]') }
-      strs.each { |str| str.replace(str.sub('--', '--[no-]')) unless str == '--help' }
+    def long?(str)
+      str.start_with?('--')
+    end
+
+    class Validator < Struct.new(:strs, :opts)
+      SHORT = /^-\w( \w+)?$/
+      LONG  = /^--[\w\-\[\]]+( \w+)?$/
+
+      MSGS = {
+        missing_strs: 'No option strings given. Pass one short -s and/or one --long option string.',
+        wrong_strs:   'Wrong option strings given. Pass one short -s and/or one --long option string.',
+        invalid_strs: 'Invalid option strings given: %p',
+        unknown_opts: 'Unknown options: %s'
+      }
+
+      def apply
+        error :missing_strs if strs.empty?
+        error :wrong_strs if short.size > 1 || long.size > 1
+        error :invalid_strs, invalid unless invalid.empty?
+        error :unknown_opts, unknown.map(&:inspect).join(', ') unless unknown.empty?
+        [short.first, long.first]
+      end
+
+      def unknown
+        @unknown ||= opts.keys - Opt::OPTS
+      end
+
+      def invalid
+        @invalid ||= strs.-(valid).join(', ')
+      end
+
+      def valid
+        strs.grep(Regexp.union(SHORT, LONG))
+      end
+
+      def short
+        strs.grep(SHORT)
+      end
+
+      def long
+        strs.grep(LONG)
+      end
+
+      def error(key, *args)
+        raise Cl::Error, MSGS[key] % args
+      end
     end
   end
 end

data/lib/cl/opts.rb

@@ -18,7 +18,6 @@ class Cl
     def apply(cmd, opts)
       return opts if opts[:help]
       orig = opts.dup
-      cmd.deprecations = deprecations(cmd, opts)
       opts = defaults(cmd, opts)
       opts = downcase(opts)
       opts = upcase(opts)
@@ -66,12 +65,6 @@ class Cl
 
     private
 
-      def deprecations(cmd, opts)
-        defs = cmd.class.opts.select(&:deprecated?)
-        defs = defs.select { |opt| opts.key?(opt.deprecated[0]) }
-        defs.map(&:deprecated).to_h
-      end
-
       def defaults(cmd, opts)
         select(&:default?).inject(opts) do |opts, opt|
           next opts if opts.key?(opt.name)

data/lib/cl/opts/validate.rb

@@ -86,9 +86,10 @@ class Cl
 
         def unknown
           @unknown ||= opts.select(&:enum?).map do |opt|
-            next unless values.key?(opt.name) && !opt.known?(values[opt.name])
+            unknown = opt.unknown(values[opt.name])
+            next if unknown.empty?
             known = opt.enum.map { |str| format_regex(str) }
-            [opt.name, values[opt.name], known]
+            [opt.name, unknown, known]
           end.compact
         end
       end

data/lib/cl/parser.rb

@@ -1,47 +1,35 @@
 require 'optparse'
+require 'cl/parser/format'
 
 class Cl
   class Parser < OptionParser
-    attr_reader :opts
+    attr_reader :cmd, :args, :opts
 
-    def initialize(opts, args)
+    def initialize(cmd, args)
+      @cmd = cmd
       @opts = {}
+      opts = cmd.class.opts
 
       super do
         opts.each do |opt|
-          on(*args_for(opt, opt.strs)) do |value|
-            set(opt, value)
-          end
-
-          opt.aliases.each do |name|
-            on(*args_for(opt, [aliased(opt, name)])) do |value|
-              @opts[name] = set(opt, value)
-            end
+          Format.new(opt).strs.each do |str|
+            on(str) { |value| set(opt, str, value) }
           end
         end
       end
 
-      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.sub(/(#{opt.name}|#{opt.name.to_s.gsub('_', '-')})/, name.to_s)
+      orig = args.map(&:dup)
+      @args = parse!(normalize(opts, args))
     end
 
     # should consider negative arities (e.g. |one, *two|)
-    def set(opt, value)
+    def set(opt, str, value)
+      name = long?(str) ? opt_name(str) : opt.name
       value = true if value.nil? && opt.flag?
-      args = [opts, opt.type, opt.name, value]
+      args = [opts, opt.type, name, value]
       args = args[-opt.block.arity, opt.block.arity]
       instance_exec(*args, &opt.block)
+      cmd.deprecations[name] = opt.deprecated.last if opt.deprecated?(name)
     end
 
     def normalize(opts, args)
@@ -57,7 +45,7 @@ class Cl
     end
 
     def negation(opts, arg)
-      opts.detect do |opt|
+      opts.select(&:flag?).detect do |opt|
         str = opt.negate.detect { |str| arg =~ /^--#{str}[-_]+#{opt.name}/ }
         break str if str
       end
@@ -71,9 +59,12 @@ class Cl
       end
     end
 
-    def flagerize(strs)
-      strs = strs.map { |str| str.include?(' ') ? str : "#{str} [true|false|yes|no]" }
-      strs << TrueClass
+    def long?(str)
+      str.start_with?('--')
+    end
+
+    def opt_name(str)
+      str.split(' ').first.sub(/--(\[no[_\-]\])?/, '').to_sym
     end
   end
 end

data/lib/cl/parser/format.rb

@@ -0,0 +1,63 @@
+class Cl
+  class Parser < OptionParser
+    class Format < Struct.new(:opt)
+      NAME = /^(--(?:\[no-\])?)([^= ]+)/
+
+      def strs
+        strs = opt.strs + aliases
+        strs.map { |str| long?(str) ? long(str) : short(str) }.flatten
+      end
+
+      def long(str)
+        strs = [unnegate(str)]
+        strs = strs.map { |str| negated(str) }.flatten if flag?
+        strs = collect(strs, :dashed)
+        strs = collect(strs, :underscored)
+        strs = collect(strs, :valued) if flag?
+        strs.uniq
+      end
+
+      def short(str)
+        str = "#{str} #{opt.name.upcase}" unless opt.flag? || str.include?(' ')
+        str
+      end
+
+      def unnegate(str)
+        str.sub('--[no-]', '--')
+      end
+
+      def aliases
+        opt.aliases.map { |name| "--#{name} #{ name.upcase unless opt.flag?}".strip }
+      end
+
+      def collect(strs, mod)
+        strs = strs + strs.map { |str| send(mod, str) }
+        strs.flatten.uniq
+      end
+
+      def negated(str)
+        str.dup.insert(2, '[no-]')
+      end
+
+      def dashed(str)
+        str =~ NAME && str.sub("#{$1}#{$2}", "#{$1}#{$2.tr('_', '-')}") || str
+      end
+
+      def underscored(str)
+        str =~ NAME && str.sub("#{$1}#{$2}", "#{$1}#{$2.tr('-', '_')}") || str
+      end
+
+      def valued(str)
+        "#{str} [true|false|yes|no]"
+      end
+
+      def long?(str)
+        str.start_with?('--')
+      end
+
+      def flag?
+        opt.flag? && !opt.help?
+      end
+    end
+  end
+end

data/lib/cl/runner/default.rb

@@ -8,7 +8,7 @@ class Cl
       Runner.register :default, self
 
       extend Forwardable
-      include Merge
+      include Merge, Suggest
 
       def_delegators :ctx, :abort
 
@@ -31,6 +31,11 @@ class Cl
         Help.new(ctx, [cmd.registry_key])
       end
 
+      def suggestions(args)
+        keys = args.inject([]) { |keys, arg| keys << [keys.last, arg].compact.join(':') }
+        keys.map { |key| suggest(providers.map(&:to_s), key) }.flatten
+      end
+
         private
 
         # Finds a command class to run for the given arguments.
@@ -63,10 +68,14 @@ class Cl
           end
 
           cmd, keys = keys[0].last
-          cmd || raise(UnknownCmd.new(args))
+          raise UnknownCmd.new(self, args) unless cmd
           keys.each { |key| args.delete_at(args.index(key)) }
           [cmd, args]
         end
+
+      def providers
+        Cmd.registry.keys
+      end
     end
   end
 end

data/lib/cl/version.rb

@@ -1,3 +1,3 @@
 class Cl
-  VERSION = '1.0.5'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cl
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Sven Fuchs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-18 00:00:00.000000000 Z
+date: 2019-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: regstry
@@ -140,10 +140,12 @@ files:
 - lib/cl/help/table.rb
 - lib/cl/help/usage.rb
 - lib/cl/helper.rb
+- lib/cl/helper/suggest.rb
 - lib/cl/opt.rb
 - lib/cl/opts.rb
 - lib/cl/opts/validate.rb
 - lib/cl/parser.rb
+- lib/cl/parser/format.rb
 - lib/cl/runner.rb
 - lib/cl/runner/default.rb
 - lib/cl/runner/multi.rb
@@ -168,8 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Object-oriented OptionParser based CLI support