avm-tools 0.64.2 → 0.69.0

data/vendor/eac_cli/eac_cli.gemspec

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'eac_cli/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'eac_cli'
+  s.version     = ::EacCli::VERSION
+  s.authors     = ['Esquilo Azul Company']
+  s.summary     = 'Utilities to build CLI applications with Ruby.'
+
+  s.files = Dir['{lib}/**/*', 'Gemfile']
+
+  s.add_dependency 'eac_ruby_utils', '~> 0.45'
+
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.1', '>= 0.1.2'
+end

data/vendor/eac_cli/lib/eac_cli.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  require_sub __FILE__
+end

data/vendor/eac_cli/lib/eac_cli/default_runner.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'eac_cli/runner'
+require 'eac_ruby_utils/console/speaker'
+require 'eac_ruby_utils/simple_cache'
+
+module EacCli
+  module DefaultRunner
+    extend ::ActiveSupport::Concern
+
+    included do
+      include ::EacCli::Runner
+      include ::EacRubyUtils::Console::Speaker
+      include ::EacRubyUtils::SimpleCache
+      runner_definition.alt do
+        options_arg false
+        bool_opt '-h', '--help', 'Show help.', usage: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'eac_cli/definition/argument_option'
+require 'eac_cli/definition/boolean_option'
+require 'eac_cli/definition/positional_argument'
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Definition
+    require_sub __FILE__
+    attr_accessor :description
+    attr_accessor :options_argument
+
+    def initialize
+      self.description = '-- NO DESCRIPTION SET --'
+      self.options_argument = true
+    end
+
+    def alt(&block)
+      r = ::EacCli::Definition.new
+      r.instance_eval(&block)
+      alternatives << r
+      r
+    end
+
+    def alternatives
+      @alternatives ||= []
+    end
+
+    def arg_opt(short, long, description, option_options = {})
+      options << ::EacCli::Definition::ArgumentOption.new(
+        short, long, description, option_options
+      )
+    end
+
+    def bool_opt(short, long, description, option_options = {})
+      options << ::EacCli::Definition::BooleanOption.new(short, long, description, option_options)
+    end
+
+    def desc(description)
+      self.description = description
+    end
+
+    def options_arg(options_argument)
+      self.options_argument = options_argument
+    end
+
+    def options
+      @options ||= []
+    end
+
+    def pos_arg(name, arg_options = {})
+      positional << ::EacCli::Definition::PositionalArgument.new(name, arg_options)
+    end
+
+    def positional
+      @positional ||= []
+    end
+
+    def subcommands
+      positional << ::EacCli::Definition::PositionalArgument.new('subcommand', subcommand: true)
+    end
+
+    def options_first(enable = true)
+      @options_first = enable
+    end
+
+    def options_first?
+      @options_first ? true : false
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_cli/definition/base_option'
+
+module EacCli
+  class Definition
+    class ArgumentOption < ::EacCli::Definition::BaseOption
+      def argument?
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Definition
+    class BaseOption
+      attr_reader :short, :long, :description, :options
+
+      def initialize(short, long, description, options = {})
+        @short = short
+        @long = long
+        @description = description
+        @options = options.with_indifferent_access
+      end
+
+      def identifier
+        long.to_s.variableize.to_sym
+      end
+
+      def show_on_usage?
+        options[:usage]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_cli/definition/base_option'
+
+module EacCli
+  class Definition
+    class BooleanOption < ::EacCli::Definition::BaseOption
+      def argument?
+        false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Definition
+    class PositionalArgument
+      common_constructor :name, :options, default: [{}]
+
+      def identifier
+        name.to_s.variableize.to_sym
+      end
+
+      def optional?
+        options[:optional]
+      end
+
+      def repeat?
+        options[:repeat]
+      end
+
+      def subcommand?
+        options[:subcommand]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/console/docopt_runner'
+
+module EacCli
+  module Docopt
+    class DocBuilder
+      common_constructor :definition
+
+      SEP = ' '
+      IDENT = SEP * 2
+      OPTION_DESC_SEP = IDENT * 2
+
+      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_definition(option)
+        option.short + SEP + option_long(option) + OPTION_DESC_SEP + option.description
+      end
+
+      def option_long(option)
+        b = option.long
+        b += '=<value>' if option.argument?
+        b
+      end
+
+      def section(header, include_header = true)
+        b = include_header ? "#{header.humanize}:\n" : ''
+        b += send("self_#{header}") + "\n"
+        definition.alternatives.each do |alternative|
+          b += self.class.new(alternative).section(header, false)
+        end
+        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
+
+      def to_s
+        "#{definition.description}\n\n#{section('usage')}\n#{section('options')}\n"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'eac_cli/docopt/doc_builder'
+require 'eac_ruby_utils/console/docopt_runner'
+
+module EacCli
+  module Docopt
+    module RunnerExtension
+      extend ::ActiveSupport::Concern
+
+      included do
+        prepend InstanceMethods
+      end
+
+      class << self
+        def check(klass)
+          return unless klass < ::EacRubyUtils::Console::DocoptRunner
+
+          ::EacCli::Runner.alias_runner_class_methods(klass, '', 'eac_cli')
+          ::EacCli::Runner.alias_runner_class_methods(klass, 'original', '')
+
+          klass.include(self)
+        end
+      end
+
+      module InstanceMethods
+        def doc
+          ::EacCli::Docopt::DocBuilder.new(self.class.runner_definition).to_s
+        end
+
+        def docopt_options
+          super.merge(options_first: self.class.runner_definition.options_first?)
+        end
+      end
+
+      def extra_available_subcommands
+        self.class.constants
+            .map { |name| self.class.const_get(name) }
+            .select { |c| c.instance_of? Class }
+            .select { |c| c.included_modules.include?(::EacCli::Runner) }
+            .map { |c| c.name.demodulize.underscore.dasherize }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Parser
+    require_sub __FILE__
+    common_constructor :definition
+
+    def parse(argv)
+      ::EacCli::Parser::ParseResult.new(definition, argv).result
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/struct'
+
+module EacCli
+  class Parser
+    class Collector
+      class << self
+        def to_data(definition)
+          collector = new(definition)
+          yield(collector)
+          collector.to_data
+        end
+      end
+
+      common_constructor :definition do
+        default_values
+      end
+
+      # @return [OpenStruct]
+      def to_data
+        ::EacRubyUtils::Struct.new(data.transform_keys(&:identifier))
+      end
+
+      def collect(option, value)
+        if data[option].is_a?(::Array)
+          data[option] << value
+        else
+          data[option] = value
+        end
+      end
+
+      private
+
+      def data
+        @data ||= {}
+      end
+
+      def default_values
+        definition.options.each { |option| data[option] = option_default_value(option) }
+        definition.positional.each do |positional|
+          data[positional] = positional_default_value(positional)
+        end
+      end
+
+      def option_default_value(option)
+        option.argument? ? nil : false
+      end
+
+      def positional_default_value(positional)
+        positional.repeat? ? [] : nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Parser
+    class Error < ::StandardError
+      def initialize(definition, argv, message)
+        @definition = definition
+        @argv = argv
+        super(message)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+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
+
+      private
+
+      def collect
+        build_banner
+        build_options
+        @arguments = option_parser.parse(argv)
+      end
+
+      def option_parser_uncached
+        ::OptionParser.new
+      end
+
+      def build_banner
+        option_parser.banner = "#{definition.description}\n\n#{section('usage')}"
+      end
+
+      def build_options
+        definition.options.each do |option|
+          build_option(option)
+        end
+      end
+
+      def build_option(option)
+        option_parser.on(
+          *[option_short(option), 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