mini-cli 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6954edd798ee19570124490d3c139443e54cf9db86da1cbf5e1ecf053f5b4de6
-  data.tar.gz: e9c458ab08eb813875df22053ce3c5fd99c651bbe24f60d787a6d0968936d204
+  metadata.gz: 969a4421172e3cf6a3b6c6ecc294932e825a170de914ac5f19926fcc4e3da674
+  data.tar.gz: '039fc6a1d177834a3999468142a71a985ef417d179011cbba6b7b57777cb05c8'
 SHA512:
-  metadata.gz: ad9884fa0f18600b69212a8f3b3c36108838d510879cde3d2a4525009439a3574c8eae1d7d7d4b567647fce04aa5cfaeee3fdceec8529381defc2533c1166559
-  data.tar.gz: 287198992331abcd2fee44165775cad3a6905c15eb1fac71bee380d706ba5f2067b3b2d3498f9a7bc4f07fe92c447e417c854313b247f0b81db304f0810a582b
+  metadata.gz: e8fc8a932a4e508327570bb3c4e062950d78b19cbaf87594456e2f5d340a22bcbe2db32bbffd55c76e7e57e2fdb1ca63118d2f20a67976bb60fb3795e9cf372a
+  data.tar.gz: 3a2d8fa7af6ec17ae701ab0a6505ce03084646540c3cab5a54facb76c5434ad5b29acdbcb9aea35d19e7daa60bdabdb79cf143a8f8a22a2d6af0b6c7d4aeb98e

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,42 +29,58 @@ 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
+      @parser = @converter = @main_proc = nil
+      @before, @after = [], []
       @show_errors = true
+      @before_ok = false
+      @error_code = 0
+      init_main
     end
 
     def name(name = nil)
@@ -77,16 +96,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 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
+
     def parser
       @parser ||= ArgvParser.new(nil, [])
     end
@@ -121,8 +159,7 @@ module MiniCli
         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/

data/lib/mini-cli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MiniCli
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 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

@@ -14,15 +14,18 @@ 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
+  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
 end

data/test/apps/noop

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# completely empty command
+
+require_relative '../../lib/mini-cli'
+include(MiniCli)
+main {}

data/test/apps/sequence

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# 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,96 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'shellwords'
+require_relative '../helper'
+
+class ExecTest < Minitest::Test
+  parallelize_me!
+
+  def test_noop
+    assert_empty(assert_no_err('noop'))
+  end
+
+  def test_noop_help
+    assert_equal("Usage: noop\n", assert_no_err('noop', '--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').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', '--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', '-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', '-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,7 +13,10 @@ class MainTest < Test
     subject = Class.new { include MiniCli }.new
 
     expected_methods = %i[
+      after
+      before
       error
+      error_code
       help
       main
       name
@@ -176,4 +179,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

metadata

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