cl 0.1.12 → 0.1.13

data/lib/cl/errors.rb

@@ -0,0 +1,73 @@
+class Cl
+  class Error < StandardError
+    MSGS = {
+      unknown_cmd:    'Unknown command: %s',
+      missing_args:   'Missing arguments (given: %s, required: %s)',
+      too_many_args:  'Too many arguments (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',
+      unknown_values: 'Unknown value: %s',
+      required_opt:   'Missing required option: %s',
+      required_opts:  'Missing required options: %s',
+      requires_opt:   'Missing option: %s',
+      requires_opts:  'Missing options: %s',
+    }
+
+    def initialize(msg, *args)
+      super(MSGS[msg] ? MSGS[msg] % args : msg)
+    end
+  end
+
+  ArgumentError = Class.new(Error)
+  OptionError = Class.new(Error)
+
+  class UnknownCmd < Error
+    def initialize(args)
+      super(:unknown_cmd, args.join(' '))
+    end
+  end
+
+  class RequiredOpts < OptionError
+    def initialize(opts)
+      msg = opts.size == 1 ? :required_opt : :required_opts
+      super(msg, opts.join(', '))
+    end
+  end
+
+  class RequiredsOpts < OptionError
+    def initialize(opts)
+      opts = opts.map { |alts| alts.map { |alt| Array(alt).join(' and ') }.join(', or ' ) }
+      super(:requires_opts, opts.join('; '))
+    end
+  end
+
+  class RequiresOpts < OptionError
+    def initialize(opts)
+      msg = opts.size == 1 ? :requires_opt : :requires_opts
+      opts = opts.map { |one, other| "#{one} (required by #{other})" }.join(', ')
+      super(msg, opts)
+    end
+  end
+
+  class OutOfRange < OptionError
+    def initialize(opts)
+      opts = opts.map { |opt, opts| "#{opt} (#{opts.map { |pair| pair.join(': ') }.join(', ')})" }.join(', ')
+      super(:out_of_range, opts)
+    end
+  end
+
+  class InvalidFormat < OptionError
+    def initialize(opts)
+      opts = opts.map { |opt, format| "#{opt} (format: #{format})" }.join(', ')
+      super(:invalid_format, opts)
+    end
+  end
+
+  class UnknownValues < OptionError
+    def initialize(opts)
+      opts = opts.map { |(key, value, known)| "#{key}=#{value} (known values: #{known.join(', ')})" }.join(', ')
+      super(:unknown_values, opts)
+    end
+  end
+end

data/lib/cl/help/cmd.rb

@@ -13,7 +13,7 @@ class Cl
       end
 
       def format
-        [usage, arguments, options, common, summary, description].compact.join("\n\n")
+        [usage, summary, description, arguments, options, common, examples].compact.join("\n\n")
       end
 
       def usage
@@ -40,6 +40,10 @@ class Cl
         ['Common Options:', table(:cmmn)] if common?
       end
 
+      def examples
+        ['Examples:', indent(cmd.examples)] if cmd.examples
+      end
+
       def table(name)
         table = send(name)
         indent(table.to_s(width - table.width + 5))
@@ -77,7 +81,7 @@ class Cl
         opts = cmd.required
         strs = opts.map { |alts| alts.map { |alt| Array(alt).join(' and ') }.join(', or ' ) }
         strs = strs.map { |str| "Either #{str} are required." }.join("\n")
-        indent(strs)
+        indent(strs) unless strs.empty?
       end
 
       def common?
@@ -90,7 +94,7 @@ class Cl
 
       def format_obj(obj)
         opts = []
-        opts << "type: #{format_type(obj)}"
+        opts << "type: #{format_type(obj)}" unless obj.type == :flag
         opts << 'required: true' if obj.required?
         opts += format_opt(obj) if obj.is_a?(Opt)
         opts = opts.join(', ')
@@ -107,6 +111,7 @@ class Cl
         opts << "known values: #{format_enum(opt)}" if opt.enum?
         opts << "format: #{opt.format}" if opt.format?
         opts << "downcase: true" if opt.downcase?
+        opts << "min: #{opt.min}" if opt.min?
         opts << "max: #{opt.max}" if opt.max?
         opts << "e.g.: #{opt.example}" if opt.example?
         opts << "see: #{opt.see}" if opt.see?

data/lib/cl/helper.rb

@@ -25,6 +25,14 @@ class Cl
     end
   end
 
+  module Underscore
+    def underscore(string)
+      string.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      downcase
+    end
+  end
+
   extend Merge, Regex, Wrap
 end
 

data/lib/cl/opt.rb

@@ -64,6 +64,7 @@ class Cl
     def deprecated
       return [name, opts[:deprecated]] unless opts[:deprecated].is_a?(Symbol)
       [opts[:deprecated], name] if opts[:deprecated]
+      # [name, opts[:deprecated]] if opts[:deprecated]
     end
 
     def downcase?
@@ -119,6 +120,14 @@ class Cl
       !!opts[:internal]
     end
 
+    def min?
+      int? && !!opts[:min]
+    end
+
+    def min
+      opts[:min]
+    end
+
     def max?
       int? && !!opts[:max]
     end
@@ -147,6 +156,10 @@ class Cl
       opts[:see]
     end
 
+    def separator
+      opts[:sep]
+    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

@@ -24,6 +24,7 @@ class Cl
     end
 
     def <<(opt)
+      delete(opt)
       # keep the --help option at the end for help output
       opts.empty? ? opts << opt : opts.insert(-2, opt)
     end
@@ -36,6 +37,10 @@ class Cl
       opts.each(&block)
     end
 
+    def delete(opt)
+      opts.delete(opts.detect { |o| o.strs == opt.strs })
+    end
+
     def to_a
       opts
     end
@@ -60,7 +65,7 @@ class Cl
         validate_requireds(cmd, opts)
         validate_required(opts)
         validate_requires(opts)
-        validate_max(opts)
+        validate_range(opts)
         validate_format(opts)
         validate_enum(opts)
       end
@@ -81,9 +86,9 @@ class Cl
         raise RequiresOpts.new(invert(opts)) if opts.any?
       end
 
-      def validate_max(opts)
-        opts = exceeding_max(opts)
-        raise ExceedingMax.new(opts) if opts.any?
+      def validate_range(opts)
+        opts = out_of_range(opts)
+        raise OutOfRange.new(opts) if opts.any?
       end
 
       def validate_format(opts)
@@ -114,13 +119,19 @@ class Cl
         end.compact
       end
 
-      def exceeding_max(opts)
-        select(&:max?).map do |opt|
-          value = opts[opt.name]
-          [opt.name, opt.max] if value && value > opt.max
+      def out_of_range(opts)
+        self.opts.map do |opt|
+          next unless value = opts[opt.name]
+          range = only(opt.opts, :min, :max)
+          [opt.name, compact(range)] if out_of_range?(range, value)
         end.compact
       end
 
+      def out_of_range?(range, value)
+        min, max = range.values_at(:min, :max)
+        min && value < min || max && value > max
+      end
+
       def invalid_format(opts)
         select(&:format?).map do |opt|
           value = opts[opt.name]
@@ -163,6 +174,14 @@ class Cl
         end.to_h
       end
 
+      def compact(hash, *keys)
+        hash.reject { |_, value| value.nil? }.to_h
+      end
+
+      def only(hash, *keys)
+        hash.select { |key, _| keys.include?(key) }.to_h
+      end
+
       def invert(hash)
         hash.map { |key, obj| Array(obj).map { |obj| [obj, key] } }.flatten(1).to_h
       end

data/lib/cl/runner.rb

@@ -0,0 +1,10 @@
+require 'registry'
+
+class Cl
+  module Runner
+    include Registry
+  end
+end
+
+require 'cl/runner/default'
+require 'cl/runner/multi'

data/lib/cl/runner/default.rb

@@ -5,6 +5,8 @@ require 'cl/helper'
 class Cl
   module Runner
     class Default
+      Runner.register :default, self
+
       extend Forwardable
       include Merge
 
@@ -29,11 +31,28 @@ class Cl
         Help.new(ctx, [cmd.registry_key])
       end
 
-      private
+        private
 
-        # stopping at any arg that starts with a dash, find the command
+        # Finds a command class to run for the given arguments.
+        #
+        # Stopping at any arg that starts with a dash, find the command
         # with the key matching the most args when joined with ":", and
         # remove these used args from the array
+        #
+        # For example, if there are commands registered with the keys
+        #
+        #   git:pull
+        #   git:push
+        #
+        # then for the arguments:
+        #
+        #   git push master
+        #
+        # the method `lookup` will find the constant registered as `git:push`,
+        # remove these from the `args` array, and return both the constant, and
+        # the remaining args.
+        #
+        # @param args [Array<String>] arguments to run (usually ARGV)
         def lookup(args)
           keys = args.take_while { |key| !key.start_with?('-') }
 
@@ -44,6 +63,7 @@ class Cl
           end
 
           cmd, keys = keys[0].last
+          cmd || raise(UnknownCmd.new(args))
           keys.each { |key| args.delete_at(args.index(key)) }
           [cmd, args]
         end

data/lib/cl/runner/multi.rb

@@ -1,10 +1,12 @@
 class Cl
   module Runner
     class Multi
-      attr_reader :name, :cmds
+      Runner.register :multi, self
 
-      def initialize(name, *args)
-        @name = name
+      attr_reader :ctx, :cmds
+
+      def initialize(ctx, *args)
+        @ctx = ctx
         @cmds = build(group(args))
       end
 
@@ -24,7 +26,7 @@ class Cl
 
         def build(cmds)
           cmds.map do |(cmd, *args)|
-            cmd.new(name, args)
+            cmd.new(ctx, args)
           end
         end
     end

data/lib/cl/ui.rb

@@ -17,8 +17,13 @@ class Cl
         @stdout ||= opts[:stdout] || $stdout
       end
 
-      def puts(*str)
-        stdout.puts(*str)
+      def puts(*strs)
+        stdout.puts(*strs)
+      end
+
+      def abort(error, *strs)
+        self.error [error.message, *strs].join("\n\n")
+        exit 1
       end
     end
 
@@ -38,6 +43,10 @@ class Cl
       def stdout
         @stdout ||= StringIO.new
       end
+
+      def abort(error, *strs)
+        raise error
+      end
     end
 
     class Pipe < Base

data/lib/cl/version.rb

@@ -1,3 +1,3 @@
 class Cl
-  VERSION = '0.1.12'
+  VERSION = '0.1.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cl
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Sven Fuchs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-17 00:00:00.000000000 Z
+date: 2019-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: regstry
@@ -43,6 +43,28 @@ files:
 - examples/gem
 - examples/heroku
 - examples/rakeish
+- examples/readme/alias
+- examples/readme/arg
+- examples/readme/arg_array
+- examples/readme/arg_type
+- examples/readme/args_splat
+- examples/readme/array
+- examples/readme/default
+- examples/readme/deprecated
+- examples/readme/deprecated_alias
+- examples/readme/downcase
+- examples/readme/enum
+- examples/readme/example
+- examples/readme/format
+- examples/readme/internal
+- examples/readme/opts
+- examples/readme/opts_block
+- examples/readme/range
+- examples/readme/required
+- examples/readme/requireds
+- examples/readme/requires
+- examples/readme/see
+- examples/readme/type
 - lib/cl.rb
 - lib/cl/arg.rb
 - lib/cl/args.rb
@@ -52,6 +74,8 @@ files:
 - lib/cl/config/env.rb
 - lib/cl/config/files.rb
 - lib/cl/ctx.rb
+- lib/cl/dsl.rb
+- lib/cl/errors.rb
 - lib/cl/help.rb
 - lib/cl/help/cmd.rb
 - lib/cl/help/cmds.rb
@@ -61,6 +85,7 @@ files:
 - lib/cl/opt.rb
 - lib/cl/opts.rb
 - lib/cl/parser.rb
+- lib/cl/runner.rb
 - lib/cl/runner/default.rb
 - lib/cl/runner/multi.rb
 - lib/cl/ui.rb