cl 1.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce812373badd5064879d2925c6d3cd24069c73f9
-  data.tar.gz: 8bff50303b25018a6323a1a9fe6c549af3988261
+  metadata.gz: e0e03ee27c161efccb0e06355598ab58c0ab9ef1
+  data.tar.gz: f4a43fff809f58600ac878a49f25167445b2ab52
 SHA512:
-  metadata.gz: a86caa06223d1198ac18261c7a603e8b4ac5acfbb6c66c76e8940219c2cfb6317388ebcfe7dfa90048d642894f47b69031090be01e2fe04a1db498040300e7ca
-  data.tar.gz: 945f46c74950ce7932b5642e009e9726f0add1f1655e7b756b02cdcf1f7dd1dbebf201ad3f330b26eacd672cc313b89504213f3178afef788a8e6003a58a364d
+  metadata.gz: 64eb76490a49555dff4ad9af529d9dda88ada8f04bdf1667a66ed85753027891a4792efa9860c1d1c36d36a568b817c8282e2200f589fd7953019302e66ceb29
+  data.tar.gz: 5a967a02acef85622b2da4da3abcf012cece0b9c887e837cf50b9a4f64038d8d1565a3ff77f08c72560653d15bf4d62aad347298ab300f2aaf8e6ec20327cabf

data/Gemfile

@@ -2,6 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
+# gem 'regstry', path: '../registry'
+
 group :test do
   gem 'memfs'
   gem 'rspec'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cl (1.1.4)
+    cl (1.1.5)
       regstry (~> 1.0.3)
 
 GEM
@@ -15,22 +15,22 @@ GEM
       tins (~> 1.6)
     diff-lcs (1.3)
     docile (1.3.2)
-    json (2.2.0)
+    json (2.3.0)
     memfs (1.0.0)
-    regstry (1.0.14)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    regstry (1.0.15)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -38,8 +38,8 @@ GEM
     simplecov-html (0.10.2)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (0.20.3)
-    tins (1.21.1)
+    thor (1.0.1)
+    tins (1.22.2)
 
 PLATFORMS
   ruby
@@ -51,4 +51,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/cl.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'cl/version'
+
+Gem::Specification.new do |s|
+  s.name         = 'cl'
+  s.version      = Cl::VERSION
+  s.authors      = ['Sven Fuchs']
+  s.homepage     = 'https://github.com/svenfuchs/cl'
+  s.licenses     = ['MIT']
+  s.summary      = 'Object-oriented OptionParser based CLI support'
+  s.description  = <<-str.strip.gsub(/^ +/, '')
+    OptionParser based CLI support for rapid CLI development in an object-oriented
+    context.
+
+    This library wraps Ruby's OptionParser for parsing your options under the hood,
+    so you get all the goodness that the Ruby standard library provides.
+
+    On top of that it adds a rich and powerful DSL for defining, validating, and
+    normalizing options, as well as automatic and gorgeous help output (modeled
+    after `gem --help`).
+  str
+
+  s.files        = Dir.glob('{examples/**/*,lib/**/*,[A-Z]*}')
+  s.platform     = Gem::Platform::RUBY
+  s.require_path = 'lib'
+
+  s.add_dependency 'regstry', '~> 1.0.3'
+end

data/lib/cl.rb

@@ -4,6 +4,8 @@ require 'cl/runner'
 require 'cl/errors'
 
 class Cl
+  singleton_class.send(:attr_accessor, :flag_values) # remove unless Dpl needs this
+
   attr_reader :ctx, :name, :opts
 
   # @overload initialize(ctx, name, opts)

data/lib/cl/arg.rb

@@ -5,21 +5,50 @@ class Cl
     include Cast
 
     def define(const)
-      const.send(:attr_accessor, name)
+      mod = Module.new
+      mod.send(:attr_accessor, name)
+      mod.class_eval "def #{name}?; #{name}.is_a?(Array) ? !#{name}.empty? : !!#{name} end"
+      const.include(mod)
     end
 
     def set(cmd, value)
-      cmd.send(:"#{name}=", cast(value))
+      value = cast(value)
+      unknown(value) if enum? && !known?(value)
+      cmd.send(:"#{name}=", value)
     end
 
     def type
       opts[:type] || :string
     end
 
+    def array?
+      type == :array
+    end
+
     def description
       opts[:description]
     end
 
+    def enum
+      Array(opts[:enum])
+    end
+
+    def enum?
+      opts.key?(:enum)
+    end
+
+    def default
+      opts[:default]
+    end
+
+    def default?
+      opts.key?(:default)
+    end
+
+    def known?(value)
+      enum.include?(value)
+    end
+
     def required?
       !!opts[:required]
     end
@@ -29,7 +58,11 @@ class Cl
     end
 
     def splat?
-      opts[:splat] && type == :array
+      !!opts[:splat] && array?
+    end
+
+    def unknown(value)
+      raise UnknownArgumentValue.new(value, enum.join(', '))
     end
 
     def to_s

data/lib/cl/args.rb

@@ -14,10 +14,12 @@ class Cl
     end
 
     def apply(cmd, values, opts)
-      return values if args.empty? || opts[:help]
       values = splat(values) if splat?
+      values = default(values) if default?
       validate(values)
-      args.zip(values).map { |(arg, value)| arg.set(cmd, value) }.flatten(1).compact
+      return values if args.empty?
+      values = args.zip(values).map { |(arg, value)| arg.set(cmd, value) }.flatten(1) #.compact
+      compact_args(values)
     end
 
     def each(&block)
@@ -28,15 +30,28 @@ class Cl
       self.args.index(*args, &block)
     end
 
+    attr_writer :args
+
     def args
       @args ||= []
     end
 
+    def clear
+      args.clear
+    end
+
+    def dup
+      args = super
+      args.args = args.args.dup
+      args
+    end
+
     private
 
       def validate(args)
+        # raise ArgumentError.new(:unknown_arg, arg) if unknown?(arg)
         raise ArgumentError.new(:missing_args, args.size, required) if args.size < required
-        raise ArgumentError.new(:too_many_args, args.size, allowed) if args.size > allowed && !splat?
+        raise ArgumentError.new(:too_many_args, args.join(' '), args.size, allowed) if args.size > allowed && !splat?
       end
 
       def allowed
@@ -47,6 +62,10 @@ class Cl
         any?(&:splat?)
       end
 
+      def default?
+        any?(&:default?)
+      end
+
       def required
         select(&:required?).size
       end
@@ -54,8 +73,20 @@ class Cl
       def splat(values)
         args.each.with_index.inject([]) do |group, (arg, ix)|
           count = arg && arg.splat? ? [values.size - args.size + ix + 1] : []
+          count = 0 if count.first.to_i < 0
           group << values.shift(*count)
         end
       end
+
+      def default(values)
+        args.each.with_index.inject([]) do |args, (arg, ix)|
+          args << (values[ix] || arg.default)
+        end
+      end
+
+      def compact_args(args)
+        args = compact_args(args[0..-2]) while args.last.nil? && args.size > 0
+        args
+      end
   end
 end

data/lib/cl/cast.rb

@@ -31,12 +31,12 @@ class Cl
         alias flag boolean
 
         def int
-          Integer(value)
+          Integer(value) if value
         end
         alias integer int
 
         def float
-          Float(value)
+          Float(value) if value
         end
 
         def split(value)

data/lib/cl/cmd.rb

@@ -23,14 +23,14 @@ class Cl
         if const.name
           key = underscore(const.name.split('::').last)
           key = [registry_key, key].compact.join(':') unless abstract?
+          const.register(key)
         end
-        const.register key
         const.define_singleton_method(:inherited, &inherited)
       end
       define_method(:inherited, &inherited)
 
       def cmds
-        registry.values
+        registry.values.uniq
       end
 
       def parse(ctx, cmd, args)
@@ -55,7 +55,7 @@ class Cl
       @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)
+      @args = self.class.args.apply(self, args, opts) unless help? && !is_a?(Help)
     end
 
     def opts

data/lib/cl/dsl.rb

@@ -18,7 +18,7 @@ class Cl
       #
       # See {Cl::Cmd::Dsl#arg} for more details.
       def args(*args)
-        return @args ||= Args.new unless args.any?
+        return @args ||= superclass.respond_to?(:args) ? superclass.args.dup : Args.new unless args.any?
         opts = args.last.is_a?(Hash) ? args.pop : {}
         args.each { |arg| arg(arg, opts) }
       end

data/lib/cl/errors.rb

@@ -5,8 +5,9 @@ class Cl
     MSGS = {
       unknown_cmd:    'Unknown command: %s',
       unknown_option: 'Unknown option: %s',
+      unknown_arg:    'Unknown argument value: %s (known: %s)',
       missing_args:   'Missing arguments (given: %s, required: %s)',
-      too_many_args:  'Too many arguments (given: %s, allowed: %s)',
+      too_many_args:  'Too many arguments: %s (given: %s, allowed: %s)',
       wrong_type:     'Wrong argument type (given: %s, expected: %s)',
       out_of_range:   'Out of range: %s',
       invalid_format: 'Invalid format: %s',
@@ -91,6 +92,12 @@ class Cl
     end
   end
 
+  class UnknownArgumentValue < OptionError
+    def initialize(value, known)
+      super(:unknown_arg, value, known)
+    end
+  end
+
   class UnknownValues < OptionError
     include Suggest
 

data/lib/cl/help.rb

@@ -2,12 +2,18 @@ class Cl
   class Help < Cl::Cmd
     register :help
 
+    arg :args, splat: true
+
     def run
       ctx.puts help
     end
 
     def help
-      args.any? ? Cmd.new(ctx, cmd).format : Cmds.new(ctx, cmds).format
+      Array(args).any? ? Cmd.new(ctx, cmd).format : Cmds.new(ctx, cmds).format
+    end
+
+    def help?
+      true
     end
 
     private

data/lib/cl/help/cmd.rb

@@ -12,7 +12,7 @@ class Cl
       end
 
       def usage
-        "Usage: #{Usage.new(ctx, cmd).format}"
+        "Usage: #{Usage.new(ctx, cmd).format.join("\n   or: ")}"
       end
 
       def summary

data/lib/cl/help/cmds.rb

@@ -19,7 +19,7 @@ class Cl
       end
 
       def format_cmd(cmd)
-        ["#{Usage.new(ctx, cmd).format}", cmd.summary]
+        ["#{Usage.new(ctx, cmd).format.first}", cmd.summary]
       end
     end
   end

data/lib/cl/help/format.rb

@@ -9,7 +9,7 @@ class Cl
         def format
           opts = []
           opts << "type: #{type(obj)}" unless obj.type == :flag
-          opts << 'required: true' if obj.required?
+          opts << 'required' if obj.required?
           opts += Opt.new(obj).format if obj.is_a?(Cl::Opt)
           opts = opts.join(', ')
           opts = "(#{opts})" if obj.description && !opts.empty?
@@ -33,8 +33,8 @@ class Cl
           opts << "default: #{format_default(opt)}" if opt.default?
           opts << "known values: #{format_enum(opt)}" if opt.enum?
           opts << "format: #{opt.format}" if opt.format?
-          opts << "downcase: true" if opt.downcase?
-          opts << "upcase: true" if opt.upcase?
+          opts << "downcases" if opt.downcase?
+          opts << "upcases" if opt.upcase?
           opts << "min: #{opt.min}" if opt.min?
           opts << "max: #{opt.max}" if opt.max?
           opts << "e.g.: #{opt.example}" if opt.example?

data/lib/cl/help/usage.rb

@@ -2,7 +2,13 @@ class Cl
   class Help
     class Usage < Struct.new(:ctx, :cmd)
       def format
-        usage = [executable, name]
+        cmd.registry_keys.map do |key|
+          line(key)
+        end
+      end
+
+      def line(key)
+        usage = [executable, key.to_s.gsub(':', ' ')]
         usage += cmd.args.map(&:to_s) # { |arg| "[#{arg}]" }
         usage << '[options]' if opts?
         usage.join(' ')
@@ -12,10 +18,6 @@ class Cl
         ctx.name
       end
 
-      def name
-        cmd.registry_key.to_s.gsub(':', ' ')
-      end
-
       def opts?
         cmd.opts.any?
       end

data/lib/cl/opt.rb

@@ -231,7 +231,7 @@ class Cl
 
     class Validator < Struct.new(:strs, :opts)
       SHORT = /^-\w( \w+)?$/
-      LONG  = /^--[\w\-\[\]]+( \w+)?$/
+      LONG  = /^--[\w\-\[\]]+( \[?\w+\]?)?$/
 
       MSGS = {
         missing_strs: 'No option strings given. Pass one short -s and/or one --long option string.',

data/lib/cl/opts.rb

@@ -12,7 +12,7 @@ class Cl
 
       opt = Opt.new(strs, opts, block)
       opt.define(const)
-      self << opt
+      insert(opt, const)
     end
 
     def apply(cmd, opts)
@@ -27,10 +27,11 @@ class Cl
       opts
     end
 
-    def <<(opt)
+    def insert(opt, const)
       delete(opt)
-      # keep the --help option at the end for help output
-      opts.empty? ? opts << opt : opts.insert(-2, opt)
+      return opts << opt if const == Cmd
+      ix = opts.index(const.superclass.opts.first)
+      opts.empty? ? opts << opt : opts.insert(ix.to_i, opt)
     end
 
     def [](key)
@@ -45,6 +46,10 @@ class Cl
       opts.delete(opts.detect { |o| o.strs == opt.strs })
     end
 
+    def first
+      opts.first
+    end
+
     def to_a
       opts
     end
@@ -59,6 +64,10 @@ class Cl
       map(&:deprecated).flatten.compact
     end
 
+    def ==(other)
+      strs == other.strs
+    end
+
     def dup
       super.tap { |obj| obj.opts = opts.dup }
     end

data/lib/cl/parser.rb

@@ -33,7 +33,8 @@ class Cl
 
     def normalize(opts, args)
       args = noize(opts, args)
-      dasherize(args)
+      # dasherize(args)
+      args
     end
 
     def noize(opts, args)
@@ -50,13 +51,13 @@ class Cl
       end
     end
 
-    DASHERIZE = /^--([^= ])*/
-
-    def dasherize(strs)
-      strs.map do |str|
-        str.is_a?(String) ? str.gsub(DASHERIZE) { |opt| opt.gsub('_', '-') } : str
-      end
-    end
+    # DASHERIZE = /^--([^= ])*/
+    #
+    # def dasherize(strs)
+    #   strs.map do |str|
+    #     str.is_a?(String) ? str.gsub(DASHERIZE) { |opt| opt.gsub('_', '-') } : str
+    #   end
+    # end
 
     def long?(str)
       str.start_with?('--')

data/lib/cl/parser/format.rb

@@ -13,7 +13,7 @@ class Cl
         strs = strs.map { |str| negated(str) }.flatten if flag?
         strs = collect(strs, :dashed)
         strs = collect(strs, :underscored)
-        strs = collect(strs, :valued) if flag?
+        strs = collect(strs, :valued) if flag? && Cl.flag_values
         strs.uniq
       end
 

data/lib/cl/runner/default.rb

@@ -7,6 +7,9 @@ class Cl
     class Default
       Runner.register :default, self
 
+      singleton_class.send(:attr_accessor, :run_method)
+      self.run_method = :run
+
       extend Forwardable
       include Merge, Suggest
 
@@ -20,7 +23,7 @@ class Cl
       end
 
       def run
-        cmd.help? ? help.run : cmd.run
+        cmd.help? ? help.run : cmd.send(self.class.run_method)
       rescue OptionParser::InvalidOption => e
         raise UnknownOption.new(const, e.message)
       end
@@ -30,7 +33,7 @@ class Cl
       end
 
       def help
-        Help.new(ctx, [cmd.registry_key])
+        cmd.is_a?(Help) ? cmd : Help.new(ctx, [cmd.registry_key])
       end
 
       def suggestions(args)

data/lib/cl/version.rb

@@ -1,3 +1,3 @@
 class Cl
-  VERSION = '1.1.5'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cl
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Sven Fuchs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-10 00:00:00.000000000 Z
+date: 2020-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: regstry
@@ -45,6 +45,7 @@ files:
 - MIT_LICENSE.md
 - NOTES.md
 - README.md
+- cl.gemspec
 - examples/README.md
 - examples/_src/args/cast.erb.rb
 - examples/_src/args/opts.erb.rb
@@ -171,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Object-oriented OptionParser based CLI support