ehbrs-tools 0.16.0 → 0.16.5

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'eac_cli/definition/argument_option'
+require 'eac_cli/definition/boolean_option'
+require 'eac_cli/definition/positional_argument'
+
+module EacCli
+  class Definition
+    class Alternative
+      SUBCOMMAND_NAME_ARG = :subcommand
+      SUBCOMMAND_ARGS_ARG = :subcommand_args
+
+      def arg_opt(short, long, description, option_options = {})
+        options_set << ::EacCli::Definition::ArgumentOption.new(
+          short, long, description, option_options
+        )
+      end
+
+      def bool_opt(short, long, description, option_options = {})
+        options_set << ::EacCli::Definition::BooleanOption.new(short, long, description,
+                                                               option_options)
+      end
+
+      def options
+        options_set.to_a
+      end
+
+      def options_argument?
+        @options_argument ? true : false
+      end
+
+      def options_argument(enable)
+        @options_argument = enable
+
+        self
+      end
+
+      def pos_arg(name, arg_options = {})
+        new_pos_arg = ::EacCli::Definition::PositionalArgument.new(name, arg_options)
+        check_positional_blocked(new_pos_arg)
+        pos_set << new_pos_arg
+      end
+
+      def positional
+        pos_set.to_a
+      end
+
+      def positional_arguments_blocked?(new_pos_arg)
+        last = pos_set.last
+        return false unless last
+        return true if subcommands?
+        return true if last.repeat?
+        return true if last.optional? && new_pos_arg.if_present(&:required?)
+
+        false
+      end
+
+      def subcommands
+        pos_arg(SUBCOMMAND_NAME_ARG, subcommand: true)
+        pos_set << ::EacCli::Definition::PositionalArgument.new(SUBCOMMAND_ARGS_ARG,
+                                                                optional: true, repeat: true)
+      end
+
+      def subcommands?
+        pos_set.any?(&:subcommand?)
+      end
+
+      private
+
+      def check_positional_blocked(new_pos_arg)
+        raise 'Positional arguments are blocked' if positional_arguments_blocked?(new_pos_arg)
+      end
+
+      def pos_set
+        @pos_set ||= []
+      end
+
+      def options_set
+        @options_set ||= []
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Definition
+    class HelpFormatter
+      SEP = ' '
+      IDENT = SEP * 2
+      OPTION_DESC_SEP = IDENT * 2
+
+      class << self
+        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
+      end
+
+      common_constructor :definition
+
+      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 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 do |option|
+          self.class.option_long(option)
+        end
+      end
+
+      def self_usage_arguments_positional
+        definition.positional.map { |p| positional_argument(p) }
+      end
+
+      def to_banner
+        "#{definition.description}\n\n#{section('usage')}"
+      end
+    end
+  end
+end

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

@@ -5,8 +5,10 @@ require 'eac_ruby_utils/core_ext'
 module EacCli
   class Definition
     class PositionalArgument
+      DEFAULT_REQUIRED = true
+
       enable_listable
-      lists.add_symbol :option, :optional, :repeat, :subcommand
+      lists.add_symbol :option, :optional, :repeat, :required, :subcommand
       common_constructor :name, :options, default: [{}] do
         options.assert_valid_keys(self.class.lists.option.values)
       end
@@ -16,16 +18,27 @@ module EacCli
       end
 
       def optional?
-        options[OPTION_OPTIONAL]
+        !required?
       end
 
       def 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[OPTION_SUBCOMMAND]
       end
+
+      def to_s
+        "#{self.class.name.demodulize}[#{identifier}]"
+      end
     end
   end
 end

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

@@ -6,71 +6,49 @@ require 'eac_ruby_utils/console/docopt_runner'
 module EacCli
   module Docopt
     class DocBuilder
+      require_sub __FILE__
       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
+      class << self
+        def option_long(option)
+          b = option.long
+          b += '=<value>' if option.argument?
+          b
         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
+        option.short + SEP + self.class.option_long(option) + OPTION_DESC_SEP + option.description
       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)
+          b += IDENT + ::EacCli::Docopt::DocBuilder::Alternative.new(alternative).to_s + "\n"
         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) }
+      def options_section
+        "Options:\n" +
+          definition.alternatives.flat_map(&:options)
+                    .map { |option| IDENT + option_definition(option) + "\n" }.join
       end
 
-      def self_usage_arguments_positional
-        definition.positional.map { |p| positional_argument(p) }
+      def usage_section
+        "Usage:\n" +
+          definition.alternatives.map do |alternative|
+            IDENT + ::EacCli::Docopt::DocBuilder::Alternative.new(alternative).to_s + "\n"
+          end.join
       end
 
       def to_s
-        "#{definition.description}\n\n#{section('usage')}\n#{section('options')}\n"
+        "#{definition.description}\n\n#{usage_section}\n#{options_section}\n"
       end
     end
   end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/console/docopt_runner'
+
+module EacCli
+  module Docopt
+    class DocBuilder
+      class Alternative
+        common_constructor :alternative
+
+        def to_s
+          (
+            [::EacRubyUtils::Console::DocoptRunner::PROGRAM_MACRO] +
+              alternative.options_argument?.if_present([]) { |_v| ['[options]'] } +
+              options +
+              positionals
+          ).join(::EacCli::Docopt::DocBuilder::SEP)
+        end
+
+        def options
+          alternative.options.select(&:show_on_usage?).map do |option|
+            ::EacCli::Docopt::DocBuilder.option_long(option)
+          end
+        end
+
+        def option_argument(option)
+          b = option.long
+          b += '=<value>' if option.argument?
+          b
+        end
+
+        def positionals
+          alternative.positional.map { |p| positional(p) }
+        end
+
+        def positional(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
+      end
+    end
+  end
+end

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

@@ -5,10 +5,30 @@ require 'eac_ruby_utils/core_ext'
 module EacCli
   class Parser
     require_sub __FILE__
-    common_constructor :definition
+    enable_simple_cache
+    common_constructor :definition, :argv
 
-    def parse(argv)
-      ::EacCli::Parser::ParseResult.new(definition, argv).result
+    private
+
+    def parsed_uncached
+      raise 'Definition has no alternatives' if alternatives.empty?
+      raise first_error unless alternatives.select(&:success?).any?
+
+      alternatives_parsed(true).merge(alternatives_parsed(false))
+    end
+
+    def alternatives_parsed(error)
+      alternatives.select { |a| error == a.error? }.map(&:parsed).reverse
+                  .inject(::EacRubyUtils::Struct.new) { |a, e| a.merge(e) }
+    end
+
+    def alternatives_uncached
+      definition.alternatives
+                .map { |alternative| ::EacCli::Parser::Alternative.new(alternative, argv) }
+    end
+
+    def first_error_uncached
+      alternatives.lazy.select(&:error?).map(&:error).first
     end
   end
 end

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'eac_cli/parser/collector'
+require 'eac_cli/parser/error'
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Parser
+    class Alternative
+      require_sub __FILE__, include_modules: true
+      enable_listable
+      lists.add_symbol :phase, :any, :option_argument, :positional
+      attr_reader :error
+
+      common_constructor :alternative, :argv do
+        alternative.assert_argument(::EacCli::Definition::Alternative, :alternative)
+        self.phase = PHASE_ANY
+        collect
+      end
+
+      def error?
+        error.present?
+      end
+
+      def success?
+        !error?
+      end
+
+      def parsed
+        @parsed ||= collector.to_data.freeze
+      end
+
+      private
+
+      attr_accessor :phase
+
+      def any_collect_argv_value
+        if argv_current_option?
+          option_collect_argv_value
+        else
+          positional_collect_argv_value
+        end
+      end
+
+      def collector
+        @collector ||= ::EacCli::Parser::Collector.new(alternative)
+      end
+
+      def collect
+        loop do
+          break unless argv_pending?
+
+          collect_argv_value
+        end
+        validate
+      rescue ::EacCli::Parser::Error => e
+        @error = e
+      end
+
+      def collect_argv_value
+        send("#{phase}_collect_argv_value")
+        argv_enum.next
+      end
+
+      def collect_option_argv_value
+        alternative.options.each do |option|
+        end
+
+        raise ::EacCli::Parser::Error.new(
+          alternative, argv, "Invalid option: #{argv_enum.current}"
+        )
+      end
+
+      def raise_error(message)
+        raise ::EacCli::Parser::Error.new(alternative, argv, message)
+      end
+
+      def validate
+        (alternative.options + alternative.positional).each do |option|
+          validate_option(option)
+        end
+      end
+
+      def validate_option(option)
+        return unless option.required?
+        return if collector.supplied?(option)
+
+        raise_error("Required option/positional #{option} not supplied")
+      end
+    end
+  end
+end