eac_cli 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52da9c5cfc7914cd5779c7d4f4e623a22c39e2132b1b15e4f390876a3101f62e
-  data.tar.gz: f226519347c7afb6e98377af26efd8c502eb9fb3dfe13adfa06c41e60dfcd83c
+  metadata.gz: d1e50e2a284a092f29a86d4ed6871c5f72d60cd0b655f8ab991d281bc0245786
+  data.tar.gz: 88e1aac4d700544a32debe645752a192f2732ee2e4f248796a952acf33853dab
 SHA512:
-  metadata.gz: 26a41f87f06e3e365db2ec3f517be9fe6770fa1682fbb420f567c68dcc5011c3185656c14bfa0d4faa9718b9250de4ff8c3b5527efcbd8740ea3f1e21607ee6f
-  data.tar.gz: 2cc2ffd7ef77d57c68f3996963da7b6fb2afcb592fa4779a1c69ed348a3b65672e49f7ee60e79bfdbbcc5f33ececa4f4c0d0b222784003538d44c8aa2191c34f
+  metadata.gz: 1cfe95828490465373b2cacb1f7a8a087903466b89ec0a7fb208cbe05742c5a8c498834350aa35d606cefe900e088853c9b6f5fd5213c71e4a25bb1843616564
+  data.tar.gz: 9d38a66bd9b3b1f3dea27c386a50a26c430cc94ed142ab5733297ab499ad4bf718b04f17d81b765e54e6d9c08e3517abc519877b54bf521e2c15e6704c80db75

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'eac_cli/runner_with/help/list_section'
 require 'eac_ruby_utils/core_ext'
 
 module EacCli
@@ -9,9 +10,8 @@ module EacCli
         require_sub __FILE__, require_dependency: true
         common_constructor :runner
 
-        SEP = ' '
-        IDENT = SEP * 2
-        OPTION_DESC_SEP = IDENT * 2
+        OPTION_DESC_SEP = ::EacCli::RunnerWith::Help::ListSection::IDENTATION * 2
+        SECTION_SEPARATOR = "\n"
 
         class << self
           def option_long(option)
@@ -35,7 +35,7 @@ module EacCli
           end
 
           def word_separator
-            SEP
+            ::EacCli::RunnerWith::Help::ListSection::WORD_SEPARATOR
           end
         end
 
@@ -45,36 +45,53 @@ module EacCli
           runner.class.runner_definition
         end
 
+        # @return [String, nil]
+        def extra_section
+          ess = extra_sections
+          return nil if ess.none?
+
+          ess.join(SECTION_SEPARATOR)
+        end
+
+        # @return [Enumerable<String>]
+        def extra_sections
+          runner.if_respond(:help_extra_text, []) do |v|
+            if v.is_a?(::Hash)
+              v.map do |title, lines|
+                ::EacCli::RunnerWith::Help::ListSection.new(title, lines)
+              end
+            else
+              [v.to_s]
+            end
+          end
+        end
+
         def option_definition(option)
           [self.class.option_usage_full(option), option.description,
            option.default_value? ? "[Default: \"#{option.default_value}\"]" : nil]
             .reject(&:blank?).join(OPTION_DESC_SEP)
         end
 
-        def section(header, include_header = true)
-          b = include_header ? "#{header.humanize}:\n" : ''
-          b += send("self_#{header}") + "\n"
-          definition.alternatives.each do |alternative|
-            b += IDENT + self.alternative(alternative) + "\n"
-          end
-          b
-        end
-
+        # @return [String]
         def options_section
-          "Options:\n" +
-            definition.alternatives.flat_map(&:options)
-              .map { |option| IDENT + option_definition(option) + "\n" }.join
+          ::EacCli::RunnerWith::Help::ListSection.new(
+            'Options',
+            definition.alternatives.flat_map(&:options).map { |option| option_definition(option) }
+          )
         end
 
+        # @return [String]
         def usage_section
-          "Usage:\n" +
-            definition.alternatives.map do |alternative|
-              IDENT + self.alternative(alternative) + "\n"
-            end.join
+          ::EacCli::RunnerWith::Help::ListSection.new(
+            'Usage',
+            definition.alternatives.map { |alternative| self.alternative(alternative) }
+          )
         end
 
         def to_s
-          "#{definition.description}\n\n#{usage_section}\n#{options_section}\n"
+          r = ["#{definition.description}\n", usage_section, options_section]
+                .map { |s| "#{s}#{SECTION_SEPARATOR}" }.join
+          extra_section.if_present(r) { |v| r + v }
         end
       end
     end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module RunnerWith
+    module Help
+      class ListSection
+        WORD_SEPARATOR = ' '
+        IDENTATION = WORD_SEPARATOR * 2
+
+        common_constructor :title, :items
+
+        # @return [String]
+        def to_s
+          (["#{title}:"] + items.map { |line| "#{IDENTATION}#{line}" })
+            .map { |line| "#{line}\n" }.join
+        end
+      end
+    end
+  end
+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_dependency: true
+      require_sub __FILE__, require_mode: :kernel
       common_concern do
         include ::EacCli::Runner
 
@@ -27,10 +27,9 @@ module EacCli
         raise ::EacCli::Runner::Exit
       end
 
+      # @return [String]
       def help_text
-        r = ::EacCli::RunnerWith::Help::Builder.new(self).to_s
-        r += help_extra_text if respond_to?(:help_extra_text)
-        r
+        ::EacCli::RunnerWith::Help::Builder.new(self).to_s
       end
 
       def show_help?

data/lib/eac_cli/runner_with/subcommands.rb

@@ -51,9 +51,12 @@ module EacCli
         available_subcommands.keys.sort.join(', ')
       end
 
+      # @return [Hash<String, Enumerable<String>]
       def help_extra_text
-        (['Subcommands:'] + available_subcommands.keys.sort.map { |s| "  #{s}" })
-          .map { |v| "#{v}\n" }.join
+        {
+          'Subcommands' =>
+          available_subcommands.keys.sort
+        }
       end
 
       def method_missing(method_name, *arguments, &block)

data/lib/eac_cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_cli
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.112'
+        version: '0.113'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.112'
+        version: '0.113'
 - !ruby/object:Gem::Dependency
   name: eac_ruby_gem_support
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +126,7 @@ files:
 - lib/eac_cli/runner_with/help.rb
 - lib/eac_cli/runner_with/help/builder.rb
 - lib/eac_cli/runner_with/help/builder/alternative.rb
+- lib/eac_cli/runner_with/help/list_section.rb
 - lib/eac_cli/runner_with/input.rb
 - lib/eac_cli/runner_with/output.rb
 - lib/eac_cli/runner_with/subcommands.rb