ehbrs-tools 0.16.2 → 0.18.0

data/vendor/eac_cli/lib/eac_cli/parser/alternative/long_options.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module EacCli
+  class Parser
+    class Alternative
+      module LongOptions
+        LONG_OPTION_PREFIX = '--'
+        OPTION_WITH_ARGUMENT_PATTERN = /\A([^=]+)(?:=(.*))\z/.freeze
+
+        private
+
+        def argv_current_long_option?
+          phase == PHASE_ANY && argv_enum.peek.start_with?(LONG_OPTION_PREFIX) &&
+            !argv_current_double_dash?
+        end
+
+        def long_option_collect_argv_value
+          option_long, value = parse_option_current_argv
+          alternative.options.any? do |option|
+            next false unless option.long == option_long
+
+            if value.nil?
+              option_collect_option(option)
+            else
+              option_argument_collect(option, value)
+            end
+          end || raise_argv_current_invalid_option
+        end
+
+        def parse_option_current_argv
+          m = OPTION_WITH_ARGUMENT_PATTERN.match(argv_enum.peek)
+          m ? [m[1], m[2].if_present('')] : [argv_enum.peek, nil]
+        end
+      end
+    end
+  end
+end

data/vendor/eac_cli/lib/eac_cli/parser/alternative/option_argument.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module EacCli
+  class Parser
+    class Alternative
+      module OptionArgument
+        private
+
+        attr_accessor :argument_option
+
+        def argument_option_collect_argv(option)
+          self.argument_option = option
+          self.phase = PHASE_OPTION_ARGUMENT
+        end
+
+        def option_argument_collect(option, value)
+          collector.collect(option, value)
+          self.argument_option = nil
+          self.phase = PHASE_ANY
+          option
+        end
+
+        def option_argument_collect_argv_value
+          option_argument_collect(argument_option, argv_enum.peek)
+        end
+      end
+    end
+  end
+end

data/vendor/eac_cli/lib/eac_cli/parser/alternative/options.rb

@@ -4,49 +4,20 @@ module EacCli
   class Parser
     class Alternative
       module Options
-        DOUBLE_DASH = '--'
-
         private
 
-        attr_accessor :argument_option, :double_dash
-
-        def argument_option_collect_argv(option)
-          self.argument_option = option
-          self.phase = PHASE_OPTION_ARGUMENT
-        end
-
-        def argv_current_option?
-          phase == PHASE_ANY && argv_enum.peek.start_with?('-')
-        end
-
-        def argv_current_double_dash?
-          argv_enum.peek == DOUBLE_DASH && !double_dash
-        end
-
         def boolean_option_collect_argv(option)
           collector.collect(option, true)
         end
 
-        def option_argument_collect_argv_value
-          collector.collect(argument_option, argv_enum.peek)
-          self.argument_option = nil
-          self.phase = PHASE_ANY
-        end
-
-        def option_collect_argv_value
-          return double_dash_collect_argv_value if argv_current_double_dash?
-
-          alternative.options.any? do |option|
-            next false unless [option.short, option.long].include?(argv_enum.peek)
-
-            if option.argument?
-              argument_option_collect_argv(option)
-            else
-              boolean_option_collect_argv(option)
-            end
+        def option_collect_option(option)
+          if option.argument?
+            argument_option_collect_argv(option)
+          else
+            boolean_option_collect_argv(option)
+          end
 
-            true
-          end || raise_argv_current_invalid_option
+          option
         end
 
         def raise_argv_current_invalid_option

data/vendor/eac_cli/lib/eac_cli/parser/alternative/short_options.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module EacCli
+  class Parser
+    class Alternative
+      module ShortOptions
+        SHORT_OPTION_PREFIX = '-'
+
+        private
+
+        def argv_current_short_option?
+          phase == PHASE_ANY && argv_enum.peek.start_with?(SHORT_OPTION_PREFIX) &&
+            !argv_current_long_option?
+        end
+
+        def find_short_option(char)
+          alternative.options.find { |option| short_without_prefix(option.short) == char }
+        end
+
+        def short_option_collect_argv_value
+          last_option = nil
+          short_without_prefix(argv_enum.peek).each_char do |char|
+            raise_error "Option \"#{last_option}\" requires a argument not provided" if
+            last_option.present?
+
+            collected_option = short_option_collect_char(char)
+            last_option = collected_option if collected_option.argument?
+          end
+        end
+
+        # @return [EacCli::Definition::BaseOption] The option collected.
+        def short_option_collect_char(char)
+          option = find_short_option(char)
+          raise_error "Invalid short option \"#{char}\"" unless option
+
+          option_collect_option(option)
+        end
+
+        def short_without_prefix(short)
+          short.gsub(/\A#{::Regexp.quote(SHORT_OPTION_PREFIX)}/, '')
+        end
+      end
+    end
+  end
+end

data/vendor/eac_cli/lib/eac_cli/runner.rb

@@ -44,6 +44,8 @@ module EacCli
       extend AfterClassMethods
       include InstanceMethods
       ::EacCli::Docopt::RunnerExtension.check(self)
+      include ActiveSupport::Callbacks
+      define_callbacks :run
     end
 
     module AfterClassMethods
@@ -55,8 +57,7 @@ module EacCli
 
       def run(*runner_context_args)
         r = create(*runner_context_args)
-        r.parsed
-        r.run
+        r.run_run
         r
       end
 
@@ -72,6 +73,13 @@ module EacCli
     end
 
     module InstanceMethods
+      def run_run
+        parsed
+        run_callbacks(:run) { run }
+      rescue ::EacCli::Runner::Exit # rubocop:disable Lint/SuppressedException
+        # Do nothing
+      end
+
       def runner_context
         return @runner_context if @runner_context
 

data/vendor/eac_cli/lib/eac_cli/runner/exit.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module EacCli
+  module Runner
+    class Exit < ::StandardError
+      attr_reader :status
+
+      def initialize(status = true)
+        @status = status
+      end
+    end
+  end
+end

data/vendor/eac_cli/lib/eac_cli/runner_with/help.rb

@@ -13,6 +13,23 @@ module EacCli
           options_argument false
           bool_opt '-h', '--help', 'Show help.', usage: true
         end
+
+        set_callback :run, :before do
+          help_run
+        end
+      end
+
+      def help_run
+        return unless parsed.help?
+
+        puts help_text
+        raise ::EacCli::Runner::Exit
+      end
+
+      def help_text
+        r = ::EacCli::Docopt::DocBuilder.new(self.class.runner_definition).to_s
+        r += help_extra_text if respond_to?(:help_extra_text)
+        r
       end
     end
   end

data/vendor/eac_cli/lib/eac_cli/runner_with/subcommands.rb

@@ -6,6 +6,14 @@ require 'eac_ruby_utils/core_ext'
 module EacCli
   module RunnerWith
     module Subcommands
+      class << self
+        def runner?(object)
+          ::EacCli::Runner.runner?(object) || (
+            object.is_a?(::Class) && object < ::EacRubyUtils::Console::DocoptRunner
+          )
+        end
+      end
+
       common_concern do
         include ::EacCli::Runner
       end
@@ -19,7 +27,7 @@ module EacCli
       def available_subcommands_auto
         self.class.constants
             .map { |name| [name.to_s.underscore.gsub('_', '-'), self.class.const_get(name)] }
-            .select { |c| ::EacCli::Runner.runner?(c[1]) }
+            .select { |c| ::EacCli::RunnerWith::Subcommands.runner?(c[1]) }
             .to_h.with_indifferent_access
       end
 
@@ -31,6 +39,11 @@ module EacCli
         end
       end
 
+      def help_extra_text
+        (['Subcommands:'] + available_subcommands.keys.map { |s| "  #{s}" })
+          .map { |v| "#{v}\n" }.join
+      end
+
       def method_missing(method_name, *arguments, &block)
         return run_with_subcommand(*arguments, &block) if
         run_with_subcommand_alias_run?(method_name)
@@ -44,7 +57,11 @@ module EacCli
 
       def run_with_subcommand
         if subcommand_name
-          subcommand_runner.run
+          if subcommand_runner.respond_to?(:run_run)
+            subcommand_runner.run_run
+          else
+            subcommand_runner.run
+          end
         else
           run_without_subcommand
         end

data/vendor/eac_cli/lib/eac_cli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EacCli
-  VERSION = '0.12.2'
+  VERSION = '0.12.5'
 end

data/vendor/eac_cli/spec/lib/eac_cli/runner_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe ::EacCli::Runner do
 
       runner_definition do
         arg_opt '-o', '--opt1', 'A arg option.'
-        bool_opt '-o', '--opt2', 'A boolean option'
+        bool_opt '-p', '--opt2', 'A boolean option'
         pos_arg :pos1
         pos_arg :pos2, repeat: true, optional: true
         alt do
@@ -28,7 +28,10 @@ RSpec.describe ::EacCli::Runner do
 
   context 'when all args are supplied' do
     let(:argv) { %w[--opt1 aaa --opt2 bbb ccc ddd] }
-    let(:parsed_expected) { { opt1: 'aaa', opt2: true, pos1: 'bbb', pos2: %w[ccc ddd] } }
+    let(:parsed_expected) do
+      { opt1: 'aaa', opt2: true, opt3: false, pos1: 'bbb',
+        pos2: %w[ccc ddd] }
+    end
 
     it { expect(parsed_actual).to eq(parsed_expected) }
     it { expect(instance.parsed.opt1).to eq('aaa') }
@@ -37,9 +40,30 @@ RSpec.describe ::EacCli::Runner do
     it { expect(instance.parsed.pos2).to eq(%w[ccc ddd]) }
   end
 
+  context 'with long option and argument in same position' do
+    let(:argv) { %w[--opt1=aaa pos1] }
+
+    it { expect(instance.parsed.opt1).to eq('aaa') }
+  end
+
+  context 'with valid grouped short options' do
+    let(:argv) { %w[-po aaa pos1] }
+
+    it { expect(instance.parsed.opt1).to eq('aaa') }
+    it { expect(instance.parsed.opt2?).to eq(true) }
+  end
+
+  context 'with invalid grouped short options' do
+    let(:argv) { %w[-op aaa pos1] }
+
+    it do
+      expect { instance.parsed }.to raise_error(::EacCli::Parser::Error)
+    end
+  end
+
   context 'when only required args are supplied' do
     let(:argv) { %w[bbb] }
-    let(:parsed_expected) { { opt1: nil, opt2: false, pos1: 'bbb', pos2: [] } }
+    let(:parsed_expected) { { opt1: nil, opt2: false, opt3: false, pos1: 'bbb', pos2: [] } }
 
     it { expect(parsed_actual).to eq(parsed_expected) }
     it { expect(instance.parsed.opt1).to be_nil }
@@ -58,7 +82,7 @@ RSpec.describe ::EacCli::Runner do
 
   context 'when alternative args are supplied' do
     let(:argv) { %w[--opt3] }
-    let(:parsed_expected) { { opt3: true } }
+    let(:parsed_expected) { { opt1: nil, opt2: false, opt3: true, pos1: nil, pos2: [] } }
 
     it { expect(parsed_actual).to eq(parsed_expected) }
     it { expect(instance.parsed.opt3?).to eq(true) }

data/vendor/eac_cli/spec/lib/eac_cli/runner_with/help_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'eac_cli/runner_with/help'
+require 'eac_ruby_utils/fs/temp'
+
+RSpec.describe ::EacCli::RunnerWith::Help do
+  let(:runner) do
+    the_module = described_class
+    Class.new do
+      include the_module
+
+      runner_definition do
+        desc 'A stub runner.'
+        pos_arg :a_argument
+      end
+
+      def run
+        puts 'Runner run'
+      end
+    end
+  end
+
+  let(:runner_argv) { ['--help'] }
+  let(:instance) { runner.create(argv: runner_argv) }
+  let(:expected_output) do
+    <<~OUTPUT
+      A stub runner.
+
+      Usage:
+        __PROGRAM__ [options] <a_argument>
+        __PROGRAM__ --help
+
+      Options:
+        -h --help    Show help.
+
+    OUTPUT
+  end
+
+  it 'show help text' do
+    expect { instance.run_run }.to output(expected_output).to_stdout_from_any_process
+  end
+end

data/vendor/eac_cli/spec/lib/eac_cli/runner_with/subcommands_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'eac_cli/runner'
+require 'eac_cli/runner_with/help'
 require 'eac_cli/runner_with/subcommands'
 
 RSpec.describe ::EacCli::RunnerWith::Subcommands do
@@ -8,7 +9,6 @@ RSpec.describe ::EacCli::RunnerWith::Subcommands do
     the_module = described_class
     the_child = child_runner
     Class.new do
-      include ::EacCli::Runner
       include the_module
       const_set('ChildCmd', the_child)
 
@@ -54,4 +54,32 @@ RSpec.describe ::EacCli::RunnerWith::Subcommands do
       expect { instance.run }.to raise_error(::EacCli::Parser::Error)
     end
   end
+
+  context 'with help' do
+    let(:instance) { parent_runner.create(%w[--help]) }
+    let(:expected_output) do
+      <<~OUTPUT
+        A stub root runner.
+
+        Usage:
+          __PROGRAM__ [options] __SUBCOMMANDS__ [<subcommand_args>...]
+          __PROGRAM__ --help
+
+        Options:
+          -r --root-var=<value>    A root variable.
+          -h --help    Show help.
+
+        Subcommands:
+          child-cmd
+      OUTPUT
+    end
+
+    before do
+      parent_runner.include(::EacCli::RunnerWith::Help)
+    end
+
+    it 'show help text' do
+      expect { instance.run_run }.to output(expected_output).to_stdout_from_any_process
+    end
+  end
 end