eac_cli 0.27.3 → 0.27.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13923176efdc8317f5f39295cb3e11e4735d66e7997580af8a5f3c8f2f0c03f4
-  data.tar.gz: 2f9edad2f2ea7484c88e9948f6c5ff47635b13ddfc2809fa2af481ebd0c347c9
+  metadata.gz: e6f469f383ca2343298743bc8ea036286aa17b853950c1fe6563a78a6aaeb00a
+  data.tar.gz: 52a728350332e7bb7782d9e9e5bf9302ef77f9101a3ec8bb6eaf230919452c5f
 SHA512:
-  metadata.gz: '0918b4794d0ced61971d2f308bb92a731b2c70130774a4e3b68db807fcb94e4a3addaa78488b1a1ab4a38e76557f1bf7fd0a1b5198dc545eefbeecfc5db5b593'
-  data.tar.gz: 6feb7e12b85ded5683858a2943390f95f092b79b4023f193c3792f24d3ed6e6294ea111f82c667c65dce50ccb005abea0c5db8233dadc6736442ab21c548c75f
+  metadata.gz: 32f0d4de473442cd637e159348af166aa6ae2611cd2f67b995f0fe0a4a190265dcd7de17eaadfc73322c35a05febe090a36225cb5b7258fdd39475ec7cd99ecb
+  data.tar.gz: 2f681a7a00aac52a079b2a5486654e9a9b2ae5f031aac037ad15e69b1f8840cf154f84041f9ad6a5903e06acabae2aa5b5d350de99341834711a0a24b147fba9

data/lib/eac_cli/definition.rb

@@ -39,10 +39,6 @@ module EacCli
       self.description = description
     end
 
-    def help_formatter
-      @help_formatter ||= ::EacCli::Definition::HelpFormatter.new(self)
-    end
-
     def main_alternative
       @main_alternative ||= begin
         r = ::EacCli::Definition::Alternative.new

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

@@ -33,7 +33,7 @@ module EacCli
         # @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
+          raise_argv_current_invalid_option unless option
 
           option_collect_option(option)
         end

data/lib/eac_cli/runner/after_class_methods.rb

@@ -1,23 +1,22 @@
 # frozen_string_literal: true
 
-require 'eac_cli/speaker'
-require 'eac_ruby_utils/speaker'
+require 'eac_cli/definition'
+require 'eac_cli/runner/class_runner'
 
 module EacCli
   module Runner
     module AfterClassMethods
+      # @return [EacCli::Runner::ClassRunner]
+      def class_runner(runner_context_args)
+        ::EacCli::Runner::ClassRunner.new(self, runner_context_args)
+      end
+
       def create(*runner_context_args)
-        r = new
-        r.runner_context = ::EacCli::Runner::Context.new(r, *runner_context_args)
-        r
+        class_runner(runner_context_args).create
       end
 
       def run(*runner_context_args)
-        on_asserted_speaker do
-          r = create(*runner_context_args)
-          r.run_run
-          r
-        end
+        class_runner(runner_context_args).run
       end
 
       def runner_definition(&block)
@@ -29,18 +28,6 @@ module EacCli
       def super_runner_definition
         superclass.try(:runner_definition).if_present(&:dup) || ::EacCli::Definition.new
       end
-
-      private
-
-      def on_asserted_speaker
-        if ::EacRubyUtils::Speaker.context.optional_current
-          yield
-        else
-          ::EacRubyUtils::Speaker.context.on(::EacCli::Speaker.new) do
-            yield
-          end
-        end
-      end
     end
   end
 end

data/lib/eac_cli/runner/class_runner.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'eac_cli/speaker'
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/speaker'
+
+module EacCli
+  module Runner
+    class ClassRunner
+      PARSER_ERROR_EXIT_CODE = 1
+
+      common_constructor :klass, :context_args
+
+      def create
+        r = klass.new
+        r.runner_context = ::EacCli::Runner::Context.new(r, *context_args)
+        r
+      end
+
+      def run
+        on_asserted_speaker do
+          r = create
+          begin
+            r.run_run
+          rescue ::EacCli::Parser::Error => e
+            run_parser_error(r, e)
+          end
+          r
+        end
+      end
+
+      def run_parser_error(runner_instance, error)
+        $stderr.write("#{runner_instance.program_name}: #{error}\n")
+        ::Kernel.exit(PARSER_ERROR_EXIT_CODE)
+      end
+
+      private
+
+      def on_asserted_speaker
+        if ::EacRubyUtils::Speaker.context.optional_current
+          yield
+        else
+          ::EacRubyUtils::Speaker.context.on(::EacCli::Speaker.new) do
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eac_cli/runner/instance_methods.rb

@@ -3,22 +3,13 @@
 module EacCli
   module Runner
     module InstanceMethods
-      PARSER_ERROR_EXIT_CODE = 1
-
       def run_run
         parsed
         run_callbacks(:run) { run }
-      rescue ::EacCli::Parser::Error => e
-        run_parser_error(e)
       rescue ::EacCli::Runner::Exit # rubocop:disable Lint/SuppressedException
         # Do nothing
       end
 
-      def run_parser_error(error)
-        $stderr.write("#{program_name}: #{error}\n")
-        ::Kernel.exit(PARSER_ERROR_EXIT_CODE)
-      end
-
       def runner_context
         return @runner_context if @runner_context
 

data/lib/eac_cli/runner_with/help/builder/alternative.rb

@@ -7,18 +7,19 @@ module EacCli
     module Help
       class Builder
         class Alternative
-          PROGRAM_MACRO = '__PROGRAM__'
+          enable_method_class
+
           SUBCOMMANDS_MACRO = '__SUBCOMMANDS__'
 
-          common_constructor :alternative
+          common_constructor :builder, :alternative
 
-          def to_s
+          def result
             (
-              [PROGRAM_MACRO] +
+              program_name +
                 alternative.options_argument?.if_present([]) { |_v| ['[options]'] } +
                 options +
                 positionals
-            ).join(::EacCli::RunnerWith::Help::Builder::SEP)
+            ).join(builder.word_separator)
           end
 
           def options
@@ -49,6 +50,12 @@ module EacCli
               r
             end
           end
+
+          def program_name
+            r = builder.runner.program_name
+            r = [r] unless r.is_a?(::Enumerable)
+            r
+          end
         end
       end
     end

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

@@ -6,8 +6,8 @@ module EacCli
   module RunnerWith
     module Help
       class Builder
-        require_sub __FILE__
-        common_constructor :definition
+        require_sub __FILE__, require_dependency: true
+        common_constructor :runner
 
         SEP = ' '
         IDENT = SEP * 2
@@ -28,11 +28,21 @@ module EacCli
 
           def option_usage_full(option)
             if option.long.present?
-              [option.short, option_long(option)].reject(&:blank?).join(SEP)
+              [option.short, option_long(option)].reject(&:blank?).join(word_separator)
             else
               option_short(option)
             end
           end
+
+          def word_separator
+            SEP
+          end
+        end
+
+        delegate :word_separator, to: :class
+
+        def definition
+          runner.class.runner_definition
         end
 
         def option_definition(option)
@@ -45,8 +55,7 @@ module EacCli
           b = include_header ? "#{header.humanize}:\n" : ''
           b += send("self_#{header}") + "\n"
           definition.alternatives.each do |alternative|
-            b += IDENT + ::EacCli::RunnerWith::Help::Builder::Alternative.new(alternative).to_s +
-                 "\n"
+            b += IDENT + self.alternative(alternative) + "\n"
           end
           b
         end
@@ -60,7 +69,7 @@ module EacCli
         def usage_section
           "Usage:\n" +
             definition.alternatives.map do |alternative|
-              IDENT + ::EacCli::RunnerWith::Help::Builder::Alternative.new(alternative).to_s + "\n"
+              IDENT + self.alternative(alternative) + "\n"
             end.join
         end
 

data/lib/eac_cli/runner_with/help.rb

@@ -6,7 +6,7 @@ require 'eac_ruby_utils/core_ext'
 module EacCli
   module RunnerWith
     module Help
-      require_sub __FILE__
+      require_sub __FILE__, require_dependency: true
       common_concern do
         include ::EacCli::Runner
 
@@ -28,7 +28,7 @@ module EacCli
       end
 
       def help_text
-        r = ::EacCli::RunnerWith::Help::Builder.new(self.class.runner_definition).to_s
+        r = ::EacCli::RunnerWith::Help::Builder.new(self).to_s
         r += help_extra_text if respond_to?(:help_extra_text)
         r
       end

data/lib/eac_cli/runner_with/subcommands.rb

@@ -12,6 +12,14 @@ module EacCli
         def runner?(object)
           ::EacCli::Runner.runner?(object)
         end
+
+        # @return [Hash<String, EacCli::Runner>]
+        def subcommands_from_module(a_module)
+          a_module.constants
+            .map { |name| [name.to_s.underscore.gsub('_', '-'), a_module.const_get(name)] }
+            .select { |c| runner?(c[1]) }
+            .to_h.with_indifferent_access
+        end
       end
 
       common_concern do
@@ -26,11 +34,9 @@ module EacCli
         @available_subcommands ||= available_subcommands_auto.merge(available_subcommands_extra)
       end
 
+      # @return [Hash<String, EacCli::Runner>]
       def available_subcommands_auto
-        self.class.constants
-          .map { |name| [name.to_s.underscore.gsub('_', '-'), self.class.const_get(name)] }
-          .select { |c| ::EacCli::RunnerWith::Subcommands.runner?(c[1]) }
-          .to_h.with_indifferent_access
+        ::EacCli::RunnerWith::Subcommands.subcommands_from_module(self.class)
       end
 
       def available_subcommands_extra
@@ -104,7 +110,7 @@ module EacCli
       end
 
       def subcommand_program
-        subcommand_name
+        [program_name, subcommand_name]
       end
 
       def subcommand_runner

data/lib/eac_cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_cli
 version: !ruby/object:Gem::Version
-  version: 0.27.3
+  version: 0.27.6
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-04 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: '0.95'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: '0.95'
 - !ruby/object:Gem::Dependency
   name: eac_ruby_gem_support
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +86,6 @@ files:
 - lib/eac_cli/definition/base_option.rb
 - lib/eac_cli/definition/base_option/initialize_args_parser.rb
 - lib/eac_cli/definition/boolean_option.rb
-- lib/eac_cli/definition/help_formatter.rb
 - lib/eac_cli/definition/positional_argument.rb
 - lib/eac_cli/enum.rb
 - lib/eac_cli/old_configs.rb
@@ -112,6 +111,7 @@ files:
 - lib/eac_cli/rspec/setup.rb
 - lib/eac_cli/runner.rb
 - lib/eac_cli/runner/after_class_methods.rb
+- lib/eac_cli/runner/class_runner.rb
 - lib/eac_cli/runner/context.rb
 - lib/eac_cli/runner/exit.rb
 - lib/eac_cli/runner/instance_methods.rb

data/lib/eac_cli/definition/help_formatter.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_cli/runner_with/help/builder/alternative'
-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?
-          ::EacCli::RunnerWith::Help::Builder::Alternative::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
-        [::EacCli::RunnerWith::Help::Builder::Alternative::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