avm-tools 0.74.0 → 0.76.1

data/vendor/eac_cli/lib/eac_cli/definition/positional_argument.rb

@@ -5,22 +5,39 @@ require 'eac_ruby_utils/core_ext'
 module EacCli
   class Definition
     class PositionalArgument
-      common_constructor :name, :options, default: [{}]
+      DEFAULT_REQUIRED = true
+
+      enable_listable
+      lists.add_symbol :option, :optional, :repeat, :required, :subcommand
+      common_constructor :name, :options, default: [{}] do
+        options.assert_valid_keys(self.class.lists.option.values)
+      end
 
       def identifier
         name.to_s.variableize.to_sym
       end
 
       def optional?
-        options[:optional]
+        !required?
       end
 
       def repeat?
-        options[:repeat]
+        options[OPTION_REPEAT]
+      end
+
+      def required?
+        return true if options.key?(OPTION_REQUIRED) && options.fetch(OPTION_REQUIRED)
+        return false if options.key?(OPTION_OPTIONAL) && options.fetch(OPTION_OPTIONAL)
+
+        DEFAULT_REQUIRED
       end
 
       def subcommand?
-        options[:subcommand]
+        options[OPTION_SUBCOMMAND]
+      end
+
+      def to_s
+        "#{self.class.name.demodulize}[#{identifier}]"
       end
     end
   end

data/vendor/eac_cli/lib/eac_cli/docopt/runner_extension.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'eac_cli/docopt/doc_builder'
+require 'eac_cli/runner'
 require 'eac_ruby_utils/console/docopt_runner'
 
 module EacCli

data/vendor/eac_cli/lib/eac_cli/parser/collector.rb

@@ -31,6 +31,10 @@ module EacCli
         end
       end
 
+      def supplied?(option)
+        data[option].present?
+      end
+
       private
 
       def data

data/vendor/eac_cli/lib/eac_cli/parser/options_collection.rb

@@ -6,28 +6,46 @@ require 'optparse'
 module EacCli
   class Parser
     class OptionsCollection
-      SEP = ' '
-      IDENT = SEP * 2
-      OPTION_DESC_SEP = IDENT * 2
-
       enable_simple_cache
       common_constructor(:definition, :argv, :collector) { collect }
       attr_reader :arguments
 
+      def options_first?
+        definition.options_first? || definition.subcommands?
+      end
+
       private
 
+      def check_required_options
+        definition.options.each do |option|
+          next unless option.required?
+          next if collector.supplied?(option)
+
+          raise ::EacCli::Parser::Error.new(
+            definition, argv, "Option \"#{option}\" is required and a value was not supplied"
+          )
+        end
+      end
+
       def collect
         build_banner
         build_options
-        @arguments = option_parser.parse(argv)
+        parse_argv
+        check_required_options
       end
 
       def option_parser_uncached
         ::OptionParser.new
       end
 
+      def parse_argv
+        @arguments = options_first? ? option_parser.order(argv) : option_parser.parse(argv)
+      rescue ::OptionParser::InvalidOption => e
+        raise ::EacCli::Parser::Error.new(definition, argv, e.message)
+      end
+
       def build_banner
-        option_parser.banner = "#{definition.description}\n\n#{section('usage')}"
+        option_parser.banner = definition.help_formatter.to_banner
       end
 
       def build_options
@@ -38,68 +56,13 @@ module EacCli
 
       def build_option(option)
         option_parser.on(
-          *[option_short(option), option_long(option), option.description].reject(&:blank?)
+          *[::EacCli::Definition::HelpFormatter.option_short(option),
+            ::EacCli::Definition::HelpFormatter.option_long(option),
+            option.description].reject(&:blank?)
         ) do |value|
           collector.collect(option, value)
         end
       end
-
-      def positional_argument(positional)
-        if positional.subcommand?
-          ::EacRubyUtils::Console::DocoptRunner::SUBCOMMANDS_MACRO
-        else
-          r = "<#{positional.name}>"
-          r += '...' if positional.repeat?
-          r = "[#{r}]" if positional.optional?
-          r
-        end
-      end
-
-      def option_argument(option)
-        option_long(option)
-      end
-
-      def option_long(option)
-        b = option.long
-        b += '=VALUE' if option.argument?
-        b
-      end
-
-      def option_short(option)
-        b = option.short
-        b += 'VALUE' if option.argument?
-        b
-      end
-
-      def section(header, include_header = true)
-        b = include_header ? "#{header.humanize}:\n" : ''
-        b += send("self_#{header}") + "\n"
-        # TO-DO: implement alternatives
-        b
-      end
-
-      def self_options
-        definition.options.map { |option| IDENT + option_definition(option) }.join("\n")
-      end
-
-      def self_usage
-        IDENT + self_usage_arguments.join(SEP)
-      end
-
-      def self_usage_arguments
-        [::EacRubyUtils::Console::DocoptRunner::PROGRAM_MACRO] +
-          definition.options_argument.if_present([]) { |_v| ['[options]'] } +
-          self_usage_arguments_options +
-          self_usage_arguments_positional
-      end
-
-      def self_usage_arguments_options
-        definition.options.select(&:show_on_usage?).map { |option| option_argument(option) }
-      end
-
-      def self_usage_arguments_positional
-        definition.positional.map { |p| positional_argument(p) }
-      end
     end
   end
 end

data/vendor/eac_cli/lib/eac_cli/parser/parse_result.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'eac_cli/parser/error'
 require 'eac_ruby_utils/core_ext'
 
 module EacCli
@@ -8,6 +9,20 @@ module EacCli
       common_constructor :definition, :argv
 
       def result
+        result_or_error = parse(definition)
+        return result_or_error unless result_or_error.is_a?(::Exception)
+
+        definition.alternatives.each do |alternative|
+          alt_result_or_error = parse(alternative)
+          return alt_result_or_error unless alt_result_or_error.is_a?(::Exception)
+        end
+
+        raise result_or_error
+      end
+
+      private
+
+      def parse(definition)
         ::EacCli::Parser::Collector.to_data(definition) do |collector|
           ::EacCli::Parser::PositionalCollection.new(
             definition,
@@ -15,6 +30,8 @@ module EacCli
             collector
           )
         end
+      rescue ::EacCli::Parser::Error => e
+        e
       end
     end
   end

data/vendor/eac_cli/lib/eac_cli/parser/positional_collection.rb

@@ -10,39 +10,67 @@ module EacCli
 
       private
 
+      def argv_enum
+        @argv_enum ||= argv.each
+      end
+
+      def argv_pending?
+        argv_enum.ongoing?
+      end
+
+      def argv_pending_check
+        return unless argv_pending?
+        return unless positional_enum.stopped?
+
+        raise ::EacCli::Parser::Error.new(
+          definition, argv, "No positional left for argv \"#{argv_enum.current}\""
+        )
+      end
+
       def collected
         @collected ||= ::Set.new
       end
 
       def collect
-        argv.each { |argv_value| colect_argv_value(argv_value) }
-        return unless pending_required_positional?
+        loop do
+          break unless enums('pending?').any?
 
-        raise ::EacCli::Parser::Error.new(
-          definition, argv, 'No value for required positional ' \
-            "\"#{current_positional.identifier}\""
-        )
+          enums('pending_check')
+          collect_argv_value
+        end
+      end
+
+      def collect_argv_value
+        collector.collect(*enums('enum', &:peek))
+        collected << positional_enum.peek
+        positional_enum.next unless positional_enum.peek.repeat?
+        argv_enum.next
       end
 
-      def colect_argv_value(argv_value)
-        collector.collect(current_positional, argv_value)
-        collected << current_positional
-        positional_enumerator.next unless current_positional.repeat?
+      def enums(method_suffix, &block)
+        %w[positional argv].map do |method_prefix|
+          v = send("#{method_prefix}_#{method_suffix}")
+          block ? block.call(v) : v
+        end
       end
 
-      def pending_required_positional?
-        !(current_positional.blank? || current_positional.optional? ||
-            collected.include?(current_positional))
+      def positional_enum
+        @positional_enum ||= definition.positional.each
       end
 
-      def positional_enumerator
-        @positional_enumerator ||= definition.positional.each
+      def positional_pending?
+        !(positional_enum.stopped? || positional_enum.current.optional? ||
+            collected.include?(positional_enum.current))
       end
 
-      def current_positional
-        positional_enumerator.peek
-      rescue ::StopIteration
-        nil
+      def positional_pending_check
+        return unless positional_pending?
+        return unless argv_enum.stopped?
+
+        raise ::EacCli::Parser::Error.new(
+          definition, argv, 'No value for required positional ' \
+            "\"#{positional_enum.current.identifier}\""
+        )
       end
     end
   end

data/vendor/eac_cli/lib/eac_cli/patches/object/runner_with.rb

@@ -5,13 +5,14 @@ require 'eac_cli/runner'
 require 'eac_cli/runner_with'
 
 class Object
-  def runner_with(*runners)
+  def runner_with(*runners, &block)
     include ::EacCli::Runner
     enable_simple_cache
     enable_console_speaker
     runners.each do |runner|
       include runner_with_to_module(runner)
     end
+    runner_definition(&block) if block
   end
 
   private

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

@@ -18,6 +18,10 @@ module EacCli
         end
       end
 
+      def runner?(object)
+        object.is_a?(::Class) && object.included_modules.include?(::EacCli::Runner)
+      end
+
       private
 
       def alias_class_method(klass, from, to)

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'eac_cli/runner'
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module RunnerWith
+    module Subcommands
+      common_concern do
+        include ::EacCli::Runner
+      end
+
+      EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME = :extra_available_subcommands
+
+      def available_subcommands
+        @available_subcommands ||= available_subcommands_auto.merge(available_subcommands_extra)
+      end
+
+      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]) }
+            .to_h.with_indifferent_access
+      end
+
+      def available_subcommands_extra
+        if respond_to?(EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME, true)
+          send(EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME)
+        else
+          {}
+        end
+      end
+
+      def method_missing(method_name, *arguments, &block)
+        return run_with_subcommand(*arguments, &block) if
+        run_with_subcommand_alias_run?(method_name)
+
+        super
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        run_with_subcommand_alias_run?(method_name) || super
+      end
+
+      def run_with_subcommand
+        if subcommand_name
+          subcommand_runner.run
+        else
+          run_without_subcommand
+        end
+      end
+
+      def run_with_subcommand_alias_run?(method_name)
+        subcommands? && method_name.to_sym == :run
+      end
+
+      def run_without_subcommand
+        "Method #{__method__} should be overrided in #{self.class.name}"
+      end
+
+      def subcommands?
+        self.class.runner_definition.subcommands?
+      end
+
+      def subcommand_args
+        parsed.fetch(::EacCli::Definition::SUBCOMMAND_ARGS_ARG)
+      end
+
+      def subcommand_class
+        available_subcommands[subcommand_name].if_present { |v| return v }
+
+        raise(::EacCli::Parser::Error.new(
+                self.class.runner_definition, runner_context.argv,
+                "Subcommand \"#{subcommand_name}\" not found " \
+                  "(Available: #{available_subcommands.keys}"
+              ))
+      end
+
+      def subcommand_name
+        parsed.fetch(::EacCli::Definition::SUBCOMMAND_NAME_ARG)
+      end
+
+      def subcommand_program
+        subcommand_name
+      end
+
+      def subcommand_runner
+        @subcommand_runner ||= subcommand_class.create(
+          argv: subcommand_args,
+          program_name: subcommand_program,
+          parent: self
+        )
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_cli/docopt/runner_extension'
+
+RSpec.describe ::EacCli::Docopt::RunnerExtension do
+  let(:stub_runner) do
+    r = Class.new(::EacRubyUtils::Console::DocoptRunner) do
+      def run; end
+    end
+    r.include ::EacCli::Runner
+    r.runner_definition do
+      desc 'A stub runner.'
+      arg_opt '-o', '--opt1', 'A argument option'
+      pos_arg 'pos1'
+    end
+    r
+  end
+
+  let(:instance) { stub_runner.new(argv: %w[-o aaa bbb]) }
+
+  before { instance.run }
+
+  it { expect(instance.options.fetch('--opt1')).to eq('aaa') }
+  it { expect(instance.options.fetch('<pos1>')).to eq('bbb') }
+end