mini-cli 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 299da5a35fccbc561453ee2dc9584f7aec510b1fe9dd34e8c7ae3221b6253dbb
-  data.tar.gz: 242f37afb8733342cafd7694d73de4247f2887a027cb4f33da210eff1dc81380
+  metadata.gz: 287658b0aa4ac5340cde3aced9e0a411ed6504713c18505706ad741c7c966a8b
+  data.tar.gz: 7b6c95ddc87554a011c3f28355f3e181a7be249432d906861a92092978f5b22b
 SHA512:
-  metadata.gz: da79647fb91708e556151c22296aa0febe509c9502bbbe327e6fb10cfd3cc22b851f402cede01e25d1df6b9e42382200cc7d34c28f8dab7fc1fac9984dda6d47
-  data.tar.gz: bb7bfb271ea6cbb2e30e4a0833746a30869e484ddc4e7d13c6f1c5f44acdca10d29081f0b52fe9c045685974d6ef6c188ce0e6147cd57f331deb020d74abeacb
+  metadata.gz: 2fa1fb33a71928b5fea02349709ba6191992b5375b690a8b39fe8dcb8b932932abe61f02135ca747bf729c0ed758276f7d9b3f41f42a2db1f128ee56eeda1bcb
+  data.tar.gz: fb7397ede3cf0f0265dbafd47ef4e070153a37e3afdf5a583b68ea95dd4482e7c54522af941bdba45680ab195e0b305b286bac1c241e27b741162bb28822fcb2

data/lib/mini-cli/run.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require('shellwords')
+
 module MiniCli
   def run(*cmd, stdin_data: nil, status: false, chdir: nil)
     in_read, in_write = IO.pipe
@@ -15,8 +17,7 @@ module MiniCli
   end
 
   def run_ruby(*cmd, **run_options)
-    require 'shellwords'
-    run(Shellwords.join(RUBY_CMD_ + cmd), **run_options)
+    run(Shellwords.join(__ruby_cmd + cmd), **run_options)
   end
 
   def run_script(script, status: false, chdir: nil)
@@ -39,10 +40,12 @@ module MiniCli
     end
   end
 
-  RUBY_CMD_ =
-    %w[--disable gems --disable did_you_mean --disable rubyopt].unshift(
-      RbConfig.ruby
-    ).freeze
-
-  private_constant(:RUBY_CMD_)
+  def __ruby_cmd
+    [
+      RbConfig.ruby,
+      '--disable=gems',
+      '--disable=did_you_mean',
+      '--disable=rubyopt'
+    ]
+  end
 end

data/lib/mini-cli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MiniCli
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/lib/mini-cli.rb

@@ -75,20 +75,22 @@ module MiniCli
     def initialize(source)
       @source = source
       @name = File.basename(source, '.*')
-      @parser = @converter = @main_proc = nil
-      @before, @after = [], []
+      @converter = @main_proc = nil
+      @parser = ArgvParser.new('', [])
+      @before = []
+      @after = []
       @show_errors = true
       @before_ok = false
       @error_code = 0
       init_main
     end
 
-    def name(name = nil)
+    def name(name)
       name ? @name = name.to_s : @name
     end
 
-    def help(helptext, args)
-      @parser = ArgvParser.new(helptext, args)
+    def help(*args)
+      @parser = ArgvParser.new(*args)
     end
 
     def show_help
@@ -109,6 +111,8 @@ module MiniCli
 
     private
 
+    attr_reader :parser
+
     def init_main
       at_exit do
         next if $! and not ($!.kind_of?(SystemExit) and $!.success?)
@@ -125,25 +129,22 @@ module MiniCli
       end
     end
 
-    def parser
-      @parser ||= ArgvParser.new(nil, [])
-    end
-
     class ArgvParser
       def initialize(helptext, args)
         @helptext = helptext.to_s
         @args = args.flatten.map!(&:to_s).uniq
         @options = nil
+        @show_options_text = true
       end
 
       def show_help(name)
         parse_help! unless @options
         print("Usage: #{name}")
-        print(' [OPTIONS]') unless @options.empty?
+        print(' [<options>]') unless @options.empty?
         print(' ', @args.join(' ')) unless @args.empty?
         puts
-        puts(nil, 'Options:') unless @options.empty?
-        puts(@helptext) unless @helptext.empty?
+        puts(nil, 'Options:') if @show_options_text
+        puts(@helptext.gsub('<*name*>', name)) unless @helptext.empty?
       end
 
       def parse(argv, error)
@@ -154,6 +155,10 @@ module MiniCli
 
       private
 
+      def error(msg)
+        @error[1, msg]
+      end
+
       def parse_argv(argv)
         arguments = []
         while (arg = argv.shift)
@@ -171,10 +176,6 @@ module MiniCli
         arguments
       end
 
-      def error(msg)
-        @error[1, msg]
-      end
-
       def process(arguments)
         @args.each do |arg|
           process_arg(arg, arguments.shift) unless arg.index('..')
@@ -185,33 +186,38 @@ module MiniCli
       end
 
       def process_arg(arg, value)
-        if arg.start_with?('[')
-          @result[arg[1..-2]] = value if value
+        if arg[0] == '[' && arg[-1] == ']'
+          return unless value
+          arg = arg[1..-2]
         else
-          @result[arg] = value || error("parameter expected - #{arg}")
+          error("parameter expected - #{arg}") unless value
         end
+        @result[(arg[0] == '<' && arg[-1] == '>') ? arg[1..-2] : arg] = value
       end
 
-      def handle_option(option, argv, test = ->(k) { option == k })
-        key = @options[option] || error("unknown option - #{option}")
-        @result[key] = test[key] and return
+      def handle_option(option, argv, pref = '-')
+        key = @options[option] || error("unknown option - #{pref}-#{option}")
+        return @result[key[1..-1]] = true if key[0] == '!'
         @result[key] = value = argv.shift
-        return unless value.nil? || value.start_with?('-')
-        error("parameter #{key} expected - --#{option}")
+        return unless value.nil? || value[0] == '-'
+        error("parameter <#{key}> expected - #{pref}-#{option}")
       end
 
       def parse_options(options, argv)
-        test = ->(k) { k == k.downcase }
-        options.each_char { |opt| handle_option(opt, argv, test) }
+        options.each_char { |opt| handle_option(opt, argv, nil) }
       end
 
       def parse_help!
         @options = {}
         @helptext.each_line do |line|
           case line
-          when /-([[:alnum:]]), --([[[:alnum:]]-]+) ([[:upper:]]+)\s+\S+/
+          when /Options:$/
+            @show_options_text = false
+          when /-([[:alnum:]]), --([[[:alnum:]]-]+) ([[:upper:]]+)\s+\S+/,
+               /-([[:alnum:]]), --([[[:alnum:]]-]+) \<([[:lower:]]+)\>\s+\S+/
             option_with_argument(Regexp.last_match)
-          when /--([[[:alnum:]]-]+) ([[:upper:]]+)\s+\S+/
+          when /--([[[:alnum:]]-]+) ([[:upper:]]+)\s+\S+/,
+               /--([[[:alnum:]]-]+) \<([[:lower:]]+)\>\s+\S+/
             short_option_with_argument(Regexp.last_match)
           when /-([[:alnum:]]), --([[[:alnum:]]-]+)\s+\S+/
             option(Regexp.last_match)
@@ -219,6 +225,7 @@ module MiniCli
             short_option(Regexp.last_match)
           end
         end
+        @show_options_text &= !@options.empty?
       end
 
       def option_with_argument(match)
@@ -230,11 +237,11 @@ module MiniCli
       end
 
       def option(match)
-        @options[match[1]] = @options[match[2]] = match[2]
+        @options[match[1]] = @options[match[2]] = "!#{match[2]}"
       end
 
       def short_option(match)
-        @options[match[1]] = match[1]
+        @options[match[1]] = "!#{match[1]}"
       end
     end
   end

data/samples/custom_args.rb

@@ -4,28 +4,34 @@ require_relative '../lib/mini-cli'
 
 include MiniCli
 
-help <<~HELP, %w[TARGET [SOURCE]]
-  -n, --name NAME  option requires NAME argument, has shortcut
-      --url URL    option requires URL argument
-  -s, --switch     option without any argument, has shortcut
-      --opt        option without any argument
+help <<~HELP, %w[<target> [<source>]]
+
+  Demonstration of converting arguments to a custom argument class.
+
+  Options:
+    -n, --name <name>  option requires <name> argument, has shortcut
+        --url <url>    option requires <url> argument
+    -s, --switch       option without any argument, has shortcut
+        --opt          option without any argument
 HELP
 
 main { |cfg| cfg.each_pair { |key, value| puts("#{key}: #{value}") } }
 
 parse_argv do |args|
+  # args['FILES'] is an array containing all surplus arguments
   Struct
     .new(:target, :sources, :name, :url, :switch, :opt)
-    .new
+    .new(
+      args['target'],
+      args['FILES'],
+      args['name'] || 'default_name',
+      args['url'] || 'www.url.test',
+      args.key?('switch'),
+      args.key?('opt')
+    )
     .tap do |cfg|
-      cfg.target = args['TARGET']
-      cfg.sources = args['FILES'] # args['FILES'] is an array containing all surplus arguments
-      source = args['SOURCE'] || ENV['SOURCE']
+      source = args['source'] || ENV['SOURCE']
       cfg.sources.unshift(source) if source
       cfg.sources << 'STDIN' if cfg.sources.empty?
-      cfg.name = args['NAME'] || 'default_name'
-      cfg.url = args['URL'] || 'www.url.test'
-      cfg.switch = args.key?('switch')
-      cfg.opt = args.key?('opt')
     end
 end

data/samples/demo.rb

@@ -4,18 +4,24 @@ require_relative '../lib/mini-cli'
 
 include MiniCli
 
-help <<~HELP, %w[TARGET [SOURCE]]
-  -n, --name NAME  option requires NAME argument, has shortcut
-      --url URL    option requires URL argument
-  -s, --switch     option without any argument, has shortcut
-      --opt        option without any argument
+help <<~HELP, %w[<target> [<source>]]
+
+  Demonstration of general Mini-CLI behavior.
+
+  Options:
+    -n, --name <name>  option requires <name> argument, has shortcut
+        --url <url>    option requires <url> argument
+    -s, --switch       option without any argument, has shortcut
+        --opt          option without any argument
+
+  Try to call this <*name*> command with various options and arguments.
 HELP
 
 main do |args|
-  puts("TARGET: #{args['TARGET']}")
-  puts("SOURCE: #{args['SOURCE']}") if args.key?('SOURCE')
-  puts("NAME: #{args['NAME']}") if args.key?('NAME')
-  puts("URL: #{args['URL']}") if args.key?('URL')
+  puts("target: #{args['target']}")
+  puts("source: #{args['source']}") if args.key?('source')
+  puts("name: #{args['name']}") if args.key?('name')
+  puts("url: #{args['url']}") if args.key?('url')
   puts("FILES: #{args['FILES']}") unless args['FILES'].empty?
   puts('--switch was given') if args.key?('switch')
   puts('--opt was given') if args.key?('opt')

data/test/mini-cli/exec_test.rb

@@ -27,7 +27,7 @@ class ExecTest < Minitest::Test
 
   def test_sequence_help
     expected = [
-      'Usage: sequence [OPTIONS]',
+      'Usage: sequence [<options>]',
       '',
       'Options:',
       '-x, --exit  early exit',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini-cli
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2021-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: The lean CLI framework for Ruby