avm-tools 0.76.1 → 0.81.0

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module EacCli
+  class Parser
+    class Alternative
+      module Positionals
+        private
+
+        def positional_collect_argv_value
+          positional_check
+          collector.collect(positional_enum.peek, argv_enum.peek)
+          positional_next
+        end
+
+        def positional_enum
+          @positional_enum ||= alternative.positional.each
+        end
+
+        def positional_check
+          raise_error("Invalid positional: #{argv_enum.peek}") if positional_enum.stopped?
+        end
+
+        def positional_next
+          self.phase = PHASE_POSITIONAL if positional_enum.peek.subcommand?
+          positional_enum.next unless positional_enum.peek.repeat?
+        end
+      end
+    end
+  end
+end

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

@@ -28,7 +28,7 @@ module EacCli
         sklass = klass.singleton_class
         return unless sklass.method_defined?(from)
 
-        sklass.alias_method to, from
+        sklass.send(:alias_method, to, from)
       end
 
       def build_method_name(name, suffix)
@@ -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
 
@@ -84,7 +92,7 @@ module EacCli
       end
 
       def parsed
-        @parsed ||= ::EacCli::Parser.new(self.class.runner_definition).parse(runner_context.argv)
+        @parsed ||= ::EacCli::Parser.new(self.class.runner_definition, runner_context.argv).parsed
       end
     end
   end

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

@@ -10,9 +10,24 @@ module EacCli
         include ::EacCli::Runner
 
         runner_definition.alt do
-          options_arg false
+          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
+        ::EacCli::Docopt::DocBuilder.new(self.class.runner_definition).to_s
       end
     end
   end

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

@@ -2,12 +2,16 @@
 
 require 'eac_cli/runner'
 require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/abstract_methods'
 
 module EacCli
   module RunnerWith
     module OutputFile
       common_concern do
         include ::EacCli::Runner
+        include ::EacRubyUtils::AbstractMethods
+
+        abstract_methods :output_content
 
         runner_definition do
           arg_opt '-o', '--output-file', 'Output to file.'
@@ -18,7 +22,7 @@ module EacCli
         if parsed.output_file.present?
           ::File.write(parsed.output_file, output_content)
         else
-          out output_content
+          $stdout.write(output_content)
         end
       end
     end

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

@@ -44,7 +44,7 @@ module EacCli
 
       def run_with_subcommand
         if subcommand_name
-          subcommand_runner.run
+          subcommand_runner.run_run
         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.11.1'
+  VERSION = '0.12.3'
 end

data/vendor/eac_cli/spec/lib/eac_cli/definition/alternative_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'eac_cli/definition/alternative'
+
+RSpec.describe ::EacCli::Definition::Alternative do
+  let(:instance) { described_class.new }
+
+  it { expect { instance.arg_opt '-a', '--opt2', 'A argument option' }.not_to raise_error }
+  it { expect { instance.bool_opt '-b', '--opt1', 'A boolean option' }.not_to raise_error }
+  it { expect { instance.options_argument(true) }.not_to raise_error }
+  it { expect { instance.pos_arg :pos1 }.not_to raise_error }
+  it { expect { instance.pos_arg :pos2, optional: true, repeat: true }.not_to raise_error }
+  it { expect { instance.subcommands }.not_to raise_error }
+end

data/vendor/eac_cli/spec/lib/eac_cli/docopt/runner_extension_spec.rb

@@ -22,4 +22,14 @@ RSpec.describe ::EacCli::Docopt::RunnerExtension do
 
   it { expect(instance.options.fetch('--opt1')).to eq('aaa') }
   it { expect(instance.options.fetch('<pos1>')).to eq('bbb') }
+  it { expect(instance.doc).to eq(<<~EXPECTED) }
+    A stub runner.
+
+    Usage:
+      __PROGRAM__ [options] <pos1>
+
+    Options:
+      -o --opt1=<value>    A argument option
+
+  EXPECTED
 end

data/vendor/eac_cli/spec/lib/eac_cli/parser/alternative_spec.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'eac_cli/docopt/runner_extension'
+
+RSpec.describe ::EacCli::Parser::Alternative do
+  let(:instance) { described_class.new(alternative, argv) }
+  let(:actual_parsed) { instance.parsed.to_h.symbolize_keys }
+
+  context 'without subcommands' do
+    let(:alternative) do
+      r = ::EacCli::Definition::Alternative.new
+      r.bool_opt '-b', '--opt1', 'A boolean option'
+      r.arg_opt '-a', '--opt2', 'A argument option'
+      r.bool_opt '-c', '--opt3', 'A required boolean option', required: true
+      r.pos_arg :pos1
+      r.pos_arg :pos2, optional: true, repeat: true
+      r
+    end
+
+    context 'with all values' do
+      let(:argv) { %w[--opt1 --opt2 OPT2 --opt3 POS1 POS2_1 POS2_2] }
+      let(:parsed_expected) do
+        {
+          opt1: true, opt2: 'OPT2', opt3: true, pos1: 'POS1', pos2: %w[POS2_1 POS2_2]
+        }
+      end
+
+      it { expect(instance.error).to be_blank }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'with only required values' do
+      let(:argv) { %w[--opt3 POS1] }
+      let(:parsed_expected) { { opt1: false, opt2: nil, opt3: true, pos1: 'POS1', pos2: [] } }
+
+      it { expect(instance.error).to be_blank }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'with double dash' do
+      let(:argv) { %w[--opt3 POS1 -- --opt1 --] }
+      let(:parsed_expected) do
+        { opt1: false, opt2: nil, opt3: true, pos1: 'POS1', pos2: %w[--opt1 --] }
+      end
+
+      it { expect(instance.error).to be_blank }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'without required positional' do
+      let(:argv) { %w[--opt1 --opt3] }
+      let(:parsed_expected) { { opt1: true, opt2: nil, opt3: true, pos1: nil, pos2: [] } }
+
+      it { expect(instance.error).to be_present }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'without required option' do
+      let(:argv) { %w[--opt1 POS1] }
+      let(:parsed_expected) { { opt1: true, opt2: nil, opt3: false, pos1: 'POS1', pos2: [] } }
+
+      it { expect(instance.error).to be_present }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'without any required option or positional' do
+      let(:argv) { %w[] }
+      let(:parsed_expected) { { opt1: false, opt2: nil, opt3: false, pos1: nil, pos2: [] } }
+
+      it { expect(instance.error).to be_present }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'with excedent positional' do
+      let(:alternative) do
+        r = ::EacCli::Definition::Alternative.new
+        r.pos_arg :pos1
+        r
+      end
+
+      let(:argv) { %w[POS1 POS2] }
+      let(:parsed_expected) { { pos1: 'POS1' } }
+
+      it { expect(instance.error).to be_present }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+  end
+
+  context 'with subcommands' do
+    let(:alternative) do
+      r = ::EacCli::Definition::Alternative.new
+      r.bool_opt '-b', '--opt1', 'A boolean option'
+      r.arg_opt '-a', '--opt2', 'A argument option'
+      r.subcommands
+      r
+    end
+
+    context 'with all values' do
+      let(:argv) { %w[--opt1 --opt2 OPT2 CMD CMD_ARG_1 --CMD_ARG_2] }
+      let(:parsed_expected) do
+        {
+          opt1: true, opt2: 'OPT2',
+          ::EacCli::Definition::Alternative::SUBCOMMAND_NAME_ARG => 'CMD',
+          ::EacCli::Definition::Alternative::SUBCOMMAND_ARGS_ARG => %w[CMD_ARG_1 --CMD_ARG_2]
+        }
+      end
+
+      it { expect(instance.error).to be_blank }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'with only required values' do
+      let(:argv) { %w[CMD] }
+      let(:parsed_expected) do
+        {
+          opt1: false, opt2: nil,
+          ::EacCli::Definition::Alternative::SUBCOMMAND_NAME_ARG => 'CMD',
+          ::EacCli::Definition::Alternative::SUBCOMMAND_ARGS_ARG => []
+        }
+      end
+
+      it { expect(instance.error).to be_blank }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'without required values' do
+      let(:argv) { %w[--opt1] }
+      let(:parsed_expected) do
+        {
+          opt1: true, opt2: nil,
+          ::EacCli::Definition::Alternative::SUBCOMMAND_NAME_ARG => nil,
+          ::EacCli::Definition::Alternative::SUBCOMMAND_ARGS_ARG => []
+        }
+      end
+
+      it { expect(instance.error).to be_present }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+  end
+end

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

@@ -23,9 +23,17 @@ RSpec.describe ::EacCli::Runner do
     end
   end
 
+  let(:instance) { runner_class.create(argv) }
+  let(:parsed_actual) { instance.parsed.to_h.symbolize_keys }
+
   context 'when all args are supplied' do
-    let(:instance) { runner_class.create(%w[--opt1 aaa --opt2 bbb ccc ddd]) }
+    let(:argv) { %w[--opt1 aaa --opt2 bbb 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') }
     it { expect(instance.parsed.opt2?).to eq(true) }
     it { expect(instance.parsed.pos1).to eq('bbb') }
@@ -33,8 +41,10 @@ RSpec.describe ::EacCli::Runner do
   end
 
   context 'when only required args are supplied' do
-    let(:instance) { runner_class.create(%w[bbb]) }
+    let(:argv) { %w[bbb] }
+    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 }
     it { expect(instance.parsed.opt2?).to eq(false) }
     it { expect(instance.parsed.pos1).to eq('bbb') }
@@ -42,7 +52,7 @@ RSpec.describe ::EacCli::Runner do
   end
 
   context 'when required args are not supplied' do
-    let(:instance) { runner_class.create(%w[]) }
+    let(:argv) { %w[] }
 
     it do
       expect { instance.parsed }.to raise_error(::EacCli::Parser::Error)
@@ -50,8 +60,10 @@ RSpec.describe ::EacCli::Runner do
   end
 
   context 'when alternative args are supplied' do
-    let(:instance) { runner_class.create(%w[--opt3]) }
+    let(:argv) { %w[--opt3] }
+    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) }
   end
 
@@ -69,7 +81,7 @@ RSpec.describe ::EacCli::Runner do
       end
     end
 
-    let(:instance) { runner_class.create(%w[aaa bbb]) }
+    let(:argv) { %w[aaa bbb] }
 
     it do
       expect { instance.parsed }.to raise_error(::EacCli::Parser::Error)

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/output_file_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'eac_cli/runner_with/output_file'
+require 'eac_ruby_utils/fs/temp'
+
+RSpec.describe ::EacCli::RunnerWith::OutputFile do
+  let(:runner) do
+    the_module = described_class
+    Class.new do
+      include the_module
+
+      runner_definition do
+        desc 'A stub root runner.'
+        pos_arg :input_text
+      end
+
+      def run
+        run_output
+      end
+
+      def output_content
+        parsed.input_text
+      end
+    end
+  end
+
+  let(:stub_text) { 'STUB_TEXT' }
+  let(:instance) { runner.create(argv: runner_argv) }
+
+  context 'without --output-file option' do
+    let(:runner_argv) { [stub_text] }
+
+    it do
+      expect { instance.run }.to output(stub_text).to_stdout_from_any_process
+    end
+  end
+
+  context 'with --output-file option' do
+    let(:output_file) { ::EacRubyUtils::Fs::Temp.file }
+    let(:runner_argv) { ['--output-file', output_file.to_path, stub_text] }
+
+    before do
+      instance.run
+    end
+
+    after do
+      output_file.remove
+    end
+
+    it { expect(output_file).to exist }
+    it { expect(output_file.read).to eq(stub_text) }
+  end
+end