mini-cli 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6954edd798ee19570124490d3c139443e54cf9db86da1cbf5e1ecf053f5b4de6
-  data.tar.gz: e9c458ab08eb813875df22053ce3c5fd99c651bbe24f60d787a6d0968936d204
+  metadata.gz: 287658b0aa4ac5340cde3aced9e0a411ed6504713c18505706ad741c7c966a8b
+  data.tar.gz: 7b6c95ddc87554a011c3f28355f3e181a7be249432d906861a92092978f5b22b
 SHA512:
-  metadata.gz: ad9884fa0f18600b69212a8f3b3c36108838d510879cde3d2a4525009439a3574c8eae1d7d7d4b567647fce04aa5cfaeee3fdceec8529381defc2533c1166559
-  data.tar.gz: 287198992331abcd2fee44165775cad3a6905c15eb1fac71bee380d706ba5f2067b3b2d3498f9a7bc4f07fe92c447e417c854313b247f0b81db304f0810a582b
+  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
@@ -14,6 +16,14 @@ module MiniCli
     in_write&.close
   end
 
+  def run_ruby(*cmd, **run_options)
+    run(Shellwords.join(__ruby_cmd + cmd), **run_options)
+  end
+
+  def run_script(script, status: false, chdir: nil)
+    run_ruby(stdin_data: script, status: status, chdir: chdir)
+  end
+
   private
 
   def __run_proc(stdin_data, in_write)
@@ -29,4 +39,13 @@ module MiniCli
       out.read
     end
   end
+
+  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.3.0'
+  VERSION = '0.6.0'
 end

data/lib/mini-cli.rb

@@ -2,8 +2,11 @@
 
 module MiniCli
   def self.included(mod)
-    source = caller_locations(1, 1).first.absolute_path
-    mod.const_set(:MiniCli__, Instance.new(source))
+    mod.const_set(
+      :MiniCli__,
+      Instance.new(caller_locations(1, 1).first.absolute_path)
+    )
+    mod.private_constant(:MiniCli__)
   end
 
   def name(name = nil)
@@ -26,50 +29,68 @@ module MiniCli
     __minicli__.show_errors = value ? true : false
   end
 
+  def error_code
+    __minicli__.error_code
+  end
+
   def error(code, message = nil)
     $stderr.puts("#{name}: #{message}") if message && show_errors?
-    exit(code)
+    exit(__minicli__.error_code = code)
   end
 
   def parse_argv(argv = nil, &argv_converter)
     return __minicli__.converter = argv_converter if argv_converter
-    argv ||= ARGV.dup
+    argv = Array.new(argv || ARGV)
     exit(show_help) if argv.index('--help') || argv.index('-h')
-    __minicli__.convert(__minicli__.parse(argv, method(:error).to_proc))
+    __minicli__.main(argv, method(:error).to_proc)
   end
 
-  def main(args = nil)
-    at_exit do
-      yield(args || parse_argv)
+  def main
+    __minicli__.run do
+      yield(parse_argv)
     rescue Interrupt
       error(130, 'aborted')
     end
   end
 
+  def before(&callback)
+    callback and __minicli__.before << callback
+  end
+
+  def after(&callback)
+    callback and __minicli__.after << callback
+  end
+
   private
 
   def __minicli__
-    self.class::MiniCli__
+    self.class.const_get(:MiniCli__)
   end
 
   class Instance
     attr_reader :source
     attr_writer :converter
-    attr_accessor :show_errors
+    attr_accessor :show_errors, :before, :after, :error_code
 
     def initialize(source)
       @source = source
       @name = File.basename(source, '.*')
-      @parser = @converter = nil
+      @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
@@ -77,18 +98,35 @@ module MiniCli
       true
     end
 
-    def parse(argv, error)
-      parser.parse(argv, error)
+    def run(&main_proc)
+      @main_proc = main_proc
     end
 
-    def convert(args)
+    def main(argv, error)
+      @before.each(&:call)
+      @before_ok = true
+      args = parser.parse(argv, error)
       @converter ? @converter.call(args) || args : args
     end
 
     private
 
-    def parser
-      @parser ||= ArgvParser.new(nil, [])
+    attr_reader :parser
+
+    def init_main
+      at_exit do
+        next if $! and not ($!.kind_of?(SystemExit) and $!.success?)
+        shutdown unless @after.empty?
+        @main_proc&.call
+      end
+    end
+
+    def shutdown(pid = Process.pid)
+      at_exit do
+        next if Process.pid != pid
+        @after.reverse_each(&:call) if @before_ok
+        exit(@error_code)
+      end
     end
 
     class ArgvParser
@@ -96,16 +134,17 @@ module MiniCli
         @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)
@@ -116,13 +155,16 @@ module MiniCli
 
       private
 
+      def error(msg)
+        @error[1, msg]
+      end
+
       def parse_argv(argv)
         arguments = []
         while (arg = argv.shift)
           case arg
           when '--'
-            arguments += argv
-            break
+            break arguments += argv
           when /\A--([[[:alnum:]]-]+)\z/
             handle_option(Regexp.last_match[1], argv)
           when /\A-([[:alnum:]]+)\z/
@@ -134,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('..')
@@ -148,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)
@@ -182,6 +225,7 @@ module MiniCli
             short_option(Regexp.last_match)
           end
         end
+        @show_options_text &= !@options.empty?
       end
 
       def option_with_argument(match)
@@ -193,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/mini-cli.gemspec

@@ -2,30 +2,30 @@
 
 require_relative './lib/mini-cli/version'
 
-GemSpec = Gem::Specification.new do |gem|
-  gem.name = 'mini-cli'
-  gem.version = MiniCli::VERSION
-  gem.summary = 'The lean CLI framework for Ruby'
-  gem.description = <<~DESC
+Gem::Specification.new do |spec|
+  spec.name = 'mini-cli'
+  spec.version = MiniCli::VERSION
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.summary = 'The lean CLI framework for Ruby'
+  spec.description = <<~DESC
     This gem is a lean, easy to use CLI framework with a very small footprint.
     It provides an easy to use argument parsing, help displaying and
     minimalistic error handling.
   DESC
-  gem.author = 'Mike Blumtritt'
-  gem.homepage = 'https://github.com/mblumtritt/mini-cli'
-  gem.metadata = {
-    'source_code_uri' => 'https://github.com/mblumtritt/mini-cli',
-    'bug_tracker_uri' => 'https://github.com/mblumtritt/mini-cli/issues'
-  }
 
-  gem.required_ruby_version = '>= 2.5.0'
+  spec.author = 'Mike Blumtritt'
+  spec.homepage = 'https://github.com/mblumtritt/mini-cli'
+  spec.metadata['source_code_uri'] = 'https://github.com/mblumtritt/mini-cli'
+  spec.metadata['bug_tracker_uri'] =
+    'https://github.com/mblumtritt/mini-cli/issues'
 
-  gem.add_development_dependency 'bundler'
-  gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'rake'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
 
-  all_files = %x(git ls-files -z).split(0.chr)
-  gem.test_files = all_files.grep(%r{^(spec|test)/})
-  gem.files = all_files - gem.test_files
-  gem.extra_rdoc_files = %w[README.md]
+  all_files = Dir.chdir(__dir__) { `git ls-files -z`.split(0.chr) }
+  spec.test_files = all_files.grep(%r{^(spec|test)/})
+  spec.files = all_files - spec.test_files
+  spec.extra_rdoc_files = %w[README.md]
 end

data/rakefile.rb

@@ -3,13 +3,11 @@
 require 'rake/testtask'
 require 'bundler/gem_tasks'
 
-STDOUT.sync = STDERR.sync = true
+$stdout.sync = $stderr.sync = true
 
-CLOBBER << 'prj'
+task(:default) { exec('rake --tasks') }
 
-task :default do
-  exec "#{$PROGRAM_NAME} --tasks"
-end
+CLOBBER << 'prj'
 
 Rake::TestTask.new(:test) do |t|
   t.ruby_opts = %w[-w]

data/samples/custom_args.rb

@@ -4,25 +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|
-  Struct.new(:target, :sources, :name, :url, :switch, :opt).new.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']
-    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
+  # args['FILES'] is an array containing all surplus arguments
+  Struct
+    .new(:target, :sources, :name, :url, :switch, :opt)
+    .new(
+      args['target'],
+      args['FILES'],
+      args['name'] || 'default_name',
+      args['url'] || 'www.url.test',
+      args.key?('switch'),
+      args.key?('opt')
+    )
+    .tap do |cfg|
+      source = args['source'] || ENV['SOURCE']
+      cfg.sources.unshift(source) if source
+      cfg.sources << 'STDIN' if cfg.sources.empty?
+    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/apps/noop.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# completely empty command
+
+require_relative '../../lib/mini-cli'
+include(MiniCli)
+main {}

data/test/apps/sequence.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# demonstrates the call sequence
+
+require_relative '../../lib/mini-cli'
+include(MiniCli)
+
+help <<~HELP
+  -x, --exit  early exit
+  -e, --error exit with error
+HELP
+
+main do |*args|
+  puts('main' + args.inspect)
+  exit if args.first['exit']
+  error(42, '!error!') if args.first['error']
+end
+
+before { |*args| puts('before_1' + args.inspect) }
+after { |*args| puts('after_1' + args.inspect) }
+before { |*args| puts('before_2' + args.inspect) }
+after { |*args| puts('after_2' + args.inspect) }
+
+parse_argv do |*args|
+  puts('parse_argv' + args.inspect)
+  args.first
+end

data/test/mini-cli/exec_test.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'shellwords'
+require_relative '../helper'
+
+class ExecTest < Minitest::Test
+  def test_noop
+    assert_empty(assert_no_err('noop.rb'))
+  end
+
+  def test_noop_help
+    assert_equal("Usage: noop\n", assert_no_err('noop.rb', '--help'))
+  end
+
+  def test_sequence
+    expected = [
+      'before_1[]',
+      'before_2[]',
+      "parse_argv[{\"FILES\"=>[]}]",
+      "main[{\"FILES\"=>[]}]",
+      'after_2[]',
+      'after_1[]'
+    ]
+    assert_equal(expected, assert_no_err('sequence.rb').split("\n"))
+  end
+
+  def test_sequence_help
+    expected = [
+      'Usage: sequence [<options>]',
+      '',
+      'Options:',
+      '-x, --exit  early exit',
+      '-e, --error exit with error'
+    ]
+    assert_equal(expected, assert_no_err('sequence.rb', '--help').split("\n"))
+  end
+
+  def test_sequence_early_exit
+    expected = [
+      'before_1[]',
+      'before_2[]',
+      "parse_argv[{\"exit\"=>true, \"FILES\"=>[]}]",
+      "main[{\"exit\"=>true, \"FILES\"=>[]}]",
+      'after_2[]',
+      'after_1[]'
+    ]
+    assert_equal(expected, assert_no_err('sequence.rb', '-x').split("\n"))
+  end
+
+  def test_sequence_error
+    expected = [
+      'before_1[]',
+      'before_2[]',
+      "parse_argv[{\"error\"=>true, \"FILES\"=>[]}]",
+      "main[{\"error\"=>true, \"FILES\"=>[]}]",
+      'after_2[]',
+      'after_1[]'
+    ]
+    std, err, status = invoke('sequence.rb', '-e')
+    assert_same(42, status.exitstatus)
+    assert_equal("sequence: !error!\n", err)
+    assert_equal(expected, std.split("\n"))
+  end
+
+  def assert_no_err(...)
+    std, err = assert_success(...)
+    assert_empty(err)
+    std
+  end
+
+  def assert_success(...)
+    std, err, status = invoke(...)
+    assert(status.success?)
+    return std, err
+  end
+
+  def invoke(name, *args)
+    Open3.capture3(
+      Shellwords.join(
+        [
+          RbConfig.ruby,
+          '--disable',
+          'gems',
+          '--disable',
+          'did_you_mean',
+          '--disable',
+          'rubyopt',
+          File.expand_path("../apps/#{name}", __dir__)
+        ] + args
+      )
+    )
+  end
+end

data/test/mini-cli/main_test.rb

@@ -13,12 +13,17 @@ class MainTest < Test
     subject = Class.new { include MiniCli }.new
 
     expected_methods = %i[
+      after
+      before
       error
+      error_code
       help
       main
       name
       parse_argv
       run
+      run_ruby
+      run_script
       show_errors=
       show_errors?
       show_help
@@ -176,4 +181,13 @@ class MainTest < Test
     result = subject.parse_argv(as_argv('-nup name port in out opt file'))
     assert_equal(expected, result)
   end
+
+  def test_run
+    call_sequence = []
+    subject.main { call_sequence << :main }
+    subject.before { call_sequence << :start_1 }
+    subject.after { call_sequence << :end_1 }
+    subject.before { call_sequence << :start_2 }
+    subject.after { call_sequence << :end_2 }
+  end
 end

data/test/mini-cli/ruby_run_test.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative '../helper'
+
+class RubyRunTest < Test
+  def test_simple
+    result = subject.run_script('puts("Hello World")')
+    assert_equal("Hello World\n", result)
+  end
+
+  def test_error
+    result = subject.run_script('UNDEFINED')
+    assert_match(/NameError/, result)
+  end
+
+  def test_chdir
+    home = Dir.home
+    refute(home == Dir.pwd)
+    result = subject.run_script('print Dir.pwd', chdir: home)
+    assert_equal(home, result)
+  end
+
+  def test_status
+    status, result = subject.run_script('print :Ok', status: true)
+    assert_instance_of(Process::Status, status)
+    assert(status.success?)
+    assert_equal('Ok', result)
+  end
+
+  def test_status_error
+    status, result = subject.run_script('print :Err;exit 42', status: true)
+    assert_instance_of(Process::Status, status)
+    refute(status.success?)
+    assert_same(42, status.exitstatus)
+    assert_equal('Err', result)
+  end
+
+  def test_stream
+    stream = StringIO.new('puts "Hello World"')
+    result = subject.run_script(stream)
+    assert_equal("Hello World\n", result)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2021-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,8 +74,12 @@ files:
 - samples/custom_args.rb
 - samples/demo.rb
 - samples/simple.rb
+- test/apps/noop.rb
+- test/apps/sequence.rb
 - test/helper.rb
+- test/mini-cli/exec_test.rb
 - test/mini-cli/main_test.rb
+- test/mini-cli/ruby_run_test.rb
 - test/mini-cli/run_test.rb
 homepage: https://github.com/mblumtritt/mini-cli
 licenses: []
@@ -97,11 +101,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: The lean CLI framework for Ruby
 test_files:
+- test/apps/noop.rb
+- test/apps/sequence.rb
 - test/helper.rb
+- test/mini-cli/exec_test.rb
 - test/mini-cli/main_test.rb
+- test/mini-cli/ruby_run_test.rb
 - test/mini-cli/run_test.rb