mini-cli 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86629e6e4c057eaa03c51483b6931c35517b9753ebdafa2f7b459e494be8b682
-  data.tar.gz: e16f2d52c65a4a84b7e9f631915b2d161c9e13c2d038695c0a7b764280f862c5
+  metadata.gz: 6954edd798ee19570124490d3c139443e54cf9db86da1cbf5e1ecf053f5b4de6
+  data.tar.gz: e9c458ab08eb813875df22053ce3c5fd99c651bbe24f60d787a6d0968936d204
 SHA512:
-  metadata.gz: ef6755a1c1dfdca0313daac675704265c4b35a9a44cad752ef859435abbc69b71ff0350796b86963b1b1038aa03ee609fe85a3e2063ce4b3d1d2d72efc505aea
-  data.tar.gz: b5d68657a09c053b5311a4cf5427a779e374a483142df5ca0704ad4121c4138e506ef508be97261d1bc97bf90111a4abd876b457cf0d747e38cf178bc40b4045
+  metadata.gz: ad9884fa0f18600b69212a8f3b3c36108838d510879cde3d2a4525009439a3574c8eae1d7d7d4b567647fce04aa5cfaeee3fdceec8529381defc2533c1166559
+  data.tar.gz: 287198992331abcd2fee44165775cad3a6905c15eb1fac71bee380d706ba5f2067b3b2d3498f9a7bc4f07fe92c447e417c854313b247f0b81db304f0810a582b

data/lib/mini-cli.rb

@@ -1,36 +1,41 @@
 # frozen_string_literal: true
 
 module MiniCli
-  def self.included(_)
-    return if const_defined?(:SRC)
-    const_set(:SRC, caller_locations(1, 1).first.absolute_path)
+  def self.included(mod)
+    source = caller_locations(1, 1).first.absolute_path
+    mod.const_set(:MiniCli__, Instance.new(source))
   end
 
   def name(name = nil)
-    return name ? @__name = name : @__name if defined?(@__name)
-    @__name = name || File.basename(MiniCli::SRC, '.*')
+    __minicli__.name(name)
   end
 
   def help(helptext, *args)
-    @__argv_parser = ArgvParser.new(helptext, args)
+    __minicli__.help(helptext, args)
   end
 
   def show_help
-    __argv_parser.show_help(name)
-    true
+    __minicli__.show_help
   end
 
-  def error(code, message)
-    $stderr.puts("#{name}: #{message}")
+  def show_errors?
+    __minicli__.show_errors
+  end
+
+  def show_errors=(value)
+    __minicli__.show_errors = value ? true : false
+  end
+
+  def error(code, message = nil)
+    $stderr.puts("#{name}: #{message}") if message && show_errors?
     exit(code)
   end
 
   def parse_argv(argv = nil, &argv_converter)
-    return @__argv_converter = argv_converter if argv_converter
+    return __minicli__.converter = argv_converter if argv_converter
     argv ||= ARGV.dup
     exit(show_help) if argv.index('--help') || argv.index('-h')
-    args = __argv_parser.parse(argv, method(:error).to_proc)
-    defined?(@__argv_converter) ? @__argv_converter.call(args) || args : args
+    __minicli__.convert(__minicli__.parse(argv, method(:error).to_proc))
   end
 
   def main(args = nil)
@@ -43,121 +48,159 @@ module MiniCli
 
   private
 
-  def __argv_parser
-    @__argv_parser ||= ArgvParser.new(nil, [])
+  def __minicli__
+    self.class::MiniCli__
   end
 
-  class ArgvParser
-    def initialize(helptext, args)
-      @helptext = helptext.to_s
-      @args = args.flatten.map!(&:to_s).uniq
-      @options = nil
+  class Instance
+    attr_reader :source
+    attr_writer :converter
+    attr_accessor :show_errors
+
+    def initialize(source)
+      @source = source
+      @name = File.basename(source, '.*')
+      @parser = @converter = nil
+      @show_errors = true
     end
 
-    def show_help(name)
-      parse_help! unless @options
-      print("Usage: #{name}")
-      print(' [OPTIONS]') unless @options.empty?
-      print(' ', @args.join(' ')) unless @args.empty?
-      puts
-      puts(nil, 'Valid Options:') unless @options.empty?
-      puts(@helptext) unless @helptext.empty?
+    def name(name = nil)
+      name ? @name = name.to_s : @name
+    end
+
+    def help(helptext, args)
+      @parser = ArgvParser.new(helptext, args)
+    end
+
+    def show_help
+      parser.show_help(@name)
+      true
     end
 
     def parse(argv, error)
-      @error = error
-      parse_help! unless @options
-      @result, arguments = {}, []
-      loop do
-        case arg = argv.shift
-        when nil
-          break
-        when '--'
-          arguments += argv
-          break
-        when /\A--([[[:alnum:]]-]+)\z/
-          handle_option(Regexp.last_match[1], argv)
-        when /\A-([[:alnum:]]+)\z/
-          parse_options(Regexp.last_match[1], argv)
-        else
-          arguments << arg
-        end
-      end
-      process(arguments)
+      parser.parse(argv, error)
+    end
+
+    def convert(args)
+      @converter ? @converter.call(args) || args : args
     end
 
     private
 
-    def error(msg)
-      @error.call(1, msg)
+    def parser
+      @parser ||= ArgvParser.new(nil, [])
     end
 
-    def process(arguments)
-      @args.each do |arg|
-        next if arg.index('..')
-        value = arguments.shift
+    class ArgvParser
+      def initialize(helptext, args)
+        @helptext = helptext.to_s
+        @args = args.flatten.map!(&:to_s).uniq
+        @options = nil
+      end
+
+      def show_help(name)
+        parse_help! unless @options
+        print("Usage: #{name}")
+        print(' [OPTIONS]') unless @options.empty?
+        print(' ', @args.join(' ')) unless @args.empty?
+        puts
+        puts(nil, 'Options:') unless @options.empty?
+        puts(@helptext) unless @helptext.empty?
+      end
+
+      def parse(argv, error)
+        @error, @result = error, {}
+        parse_help! unless @options
+        process(parse_argv(argv))
+      end
 
+      private
+
+      def parse_argv(argv)
+        arguments = []
+        while (arg = argv.shift)
+          case arg
+          when '--'
+            arguments += argv
+            break
+          when /\A--([[[:alnum:]]-]+)\z/
+            handle_option(Regexp.last_match[1], argv)
+          when /\A-([[:alnum:]]+)\z/
+            parse_options(Regexp.last_match[1], argv)
+          else
+            arguments << arg
+          end
+        end
+        arguments
+      end
+
+      def error(msg)
+        @error[1, msg]
+      end
+
+      def process(arguments)
+        @args.each do |arg|
+          process_arg(arg, arguments.shift) unless arg.index('..')
+        end
+        arguments.unshift(@result['FILES']) if @result.key?('FILES')
+        @result['FILES'] = arguments
+        @result
+      end
+
+      def process_arg(arg, value)
         if arg.start_with?('[')
           @result[arg[1..-2]] = value if value
         else
           @result[arg] = value || error("parameter expected - #{arg}")
         end
       end
-      arguments.unshift(@result['FILES']) if @result.key?('FILES')
-      @result['FILES'] = arguments
-      @result
-    end
 
-    def handle_option(option, argv)
-      key = @options[option] || error("unknown option - #{option}")
-      return @result[key] = true if option == key
-      @result[key] = value = argv.shift
-      return unless value.nil? || value.start_with?('-')
-      error("parameter #{key} expected - --#{option}")
-    end
-
-    def parse_options(options, argv)
-      options.each_char do |opt|
-        key = @options[opt] || error("unknown option - #{opt}")
-        next @result[key] = true if key == key.downcase
+      def handle_option(option, argv, test = ->(k) { option == k })
+        key = @options[option] || error("unknown option - #{option}")
+        @result[key] = test[key] and return
         @result[key] = value = argv.shift
-        next unless value.nil? || value.start_with?('-')
-        error("parameter #{key} expected - -#{opt}")
+        return unless value.nil? || value.start_with?('-')
+        error("parameter #{key} expected - --#{option}")
       end
-    end
 
-    def parse_help!
-      @options = {}
-      @helptext.each_line do |line|
-        case line
-        when /-([[:alnum:]]), --([[[:alnum:]]-]+) ([[:upper:]]+)\s+\S+/
-          named_option(Regexp.last_match)
-        when /--([[[:alnum:]]-]+) ([[:upper:]]+)\s+\S+/
-          named_short_option(Regexp.last_match)
-        when /-([[:alnum:]]), --([[[:alnum:]]-]+)\s+\S+/
-          option(Regexp.last_match)
-        when /--([[[:alnum:]]-]+)\s+\S+/
-          short_option(Regexp.last_match)
+      def parse_options(options, argv)
+        test = ->(k) { k == k.downcase }
+        options.each_char { |opt| handle_option(opt, argv, test) }
+      end
+
+      def parse_help!
+        @options = {}
+        @helptext.each_line do |line|
+          case line
+          when /-([[:alnum:]]), --([[[:alnum:]]-]+) ([[:upper:]]+)\s+\S+/
+            option_with_argument(Regexp.last_match)
+          when /--([[[:alnum:]]-]+) ([[:upper:]]+)\s+\S+/
+            short_option_with_argument(Regexp.last_match)
+          when /-([[:alnum:]]), --([[[:alnum:]]-]+)\s+\S+/
+            option(Regexp.last_match)
+          when /--([[[:alnum:]]-]+)\s+\S+/
+            short_option(Regexp.last_match)
+          end
         end
       end
-    end
 
-    def named_option(match)
-      @options[match[1]] = @options[match[2]] = match[3]
-    end
+      def option_with_argument(match)
+        @options[match[1]] = @options[match[2]] = match[3]
+      end
 
-    def named_short_option(match)
-      @options[match[1]] = match[2]
-    end
+      def short_option_with_argument(match)
+        @options[match[1]] = match[2]
+      end
 
-    def option(match)
-      @options[match[1]] = @options[match[2]] = match[2]
-    end
+      def option(match)
+        @options[match[1]] = @options[match[2]] = match[2]
+      end
 
-    def short_option(match)
-      @options[match[1]] = match[1]
+      def short_option(match)
+        @options[match[1]] = match[1]
+      end
     end
   end
 
-  private_constant(:ArgvParser)
+  private_constant(:Instance)
 end

data/lib/mini-cli/version.rb

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

data/lib/mini_cli.rb

@@ -0,0 +1 @@
+require_relative 'mini-cli'

data/test/mini-cli/main_test.rb

@@ -1,16 +1,29 @@
+# frozen_string_literal: true
+
 require_relative '../helper'
 
 class MainTest < Test
   def test_defaults
     assert_equal('helper', subject.name)
+    assert(subject.show_errors?)
     assert_output("Usage: helper\n") { subject.show_help }
   end
 
   def test_methods
     subject = Class.new { include MiniCli }.new
 
-    expected_methods = %i[error help main name parse_argv run show_help].sort!
-    methods = (subject.methods - Object.new.methods).sort!
+    expected_methods = %i[
+      error
+      help
+      main
+      name
+      parse_argv
+      run
+      show_errors=
+      show_errors?
+      show_help
+    ]
+    methods = (subject.methods - Object.instance_methods).sort!
     assert_equal(expected_methods, methods)
   end
 
@@ -22,6 +35,13 @@ class MainTest < Test
     assert_stop_with_error(21, 'error') { subject.error(21, :error) }
   end
 
+  def test_no_error
+    subject.show_errors = false
+
+    assert_output(nil, nil) { subject.error(666, 'some error text') }
+    assert_equal([666], subject.exit_args)
+  end
+
   def test_help_simple
     subject.help 'Some helptext'
     expected_text = <<~EXPECTED

data/test/mini-cli/run_test.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require_relative '../helper'
 
 class RunTest < Test
   def test_simple
     result = subject.run('pwd')
-    assert_equal(Dir.pwd + "\n", result)
+    assert_equal("#{Dir.pwd}\n", result)
   end
 
   def test_simple_error
@@ -15,14 +17,14 @@ class RunTest < Test
     home = Dir.home
     refute(home == Dir.pwd)
     result = subject.run('pwd', chdir: home)
-    assert_equal(home + "\n", result)
+    assert_equal("#{home}\n", result)
   end
 
   def test_status
     status, result = subject.run('pwd', status: true)
     assert_instance_of(Process::Status, status)
     assert(status.success?)
-    assert_equal(Dir.pwd + "\n", result)
+    assert_equal("#{Dir.pwd}\n", result)
   end
 
   def test_status_error
@@ -39,7 +41,7 @@ class RunTest < Test
   end
 
   def test_stdin_stream
-    stream = StringIO.new("Hello World")
+    stream = StringIO.new('Hello World')
     result = subject.run('cat', stdin_data: stream)
     assert_equal(stream.string, result)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-25 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +68,7 @@ files:
 - lib/mini-cli.rb
 - lib/mini-cli/run.rb
 - lib/mini-cli/version.rb
+- lib/mini_cli.rb
 - mini-cli.gemspec
 - rakefile.rb
 - samples/custom_args.rb