eac_cli 0.31.0 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52da9c5cfc7914cd5779c7d4f4e623a22c39e2132b1b15e4f390876a3101f62e
-  data.tar.gz: f226519347c7afb6e98377af26efd8c502eb9fb3dfe13adfa06c41e60dfcd83c
+  metadata.gz: db28e2122721492b5bb7243a022a5b53771166d3310bb75339901e9d4d216072
+  data.tar.gz: 0e8a60069bc925dc4ca2e54d98168aee9963b684cbce9c427d4f27087901e653
 SHA512:
-  metadata.gz: 26a41f87f06e3e365db2ec3f517be9fe6770fa1682fbb420f567c68dcc5011c3185656c14bfa0d4faa9718b9250de4ff8c3b5527efcbd8740ea3f1e21607ee6f
-  data.tar.gz: 2cc2ffd7ef77d57c68f3996963da7b6fb2afcb592fa4779a1c69ed348a3b65672e49f7ee60e79bfdbbcc5f33ececa4f4c0d0b222784003538d44c8aa2191c34f
+  metadata.gz: 15d640ebbe8a9fa2f1857c14ab2a5bc13aeb06dfdacde17568fe6706c7defad382d751cdbde4d1253e8b24789763c0bc58fb87c977e293b9debc05c6551eb1f9
+  data.tar.gz: 414fb900c66c2277234c167495f0e2a7fac008d02e57b76d092961ababa8ed0a39be741b9d927c99992d0f4c1c730de9b6748b035d4230aee75fb9402bba1707

data/lib/eac_cli/definition/base_option.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'eac_cli/definition/default_value'
 require 'eac_ruby_utils/core_ext'
 
 module EacCli
   class Definition
     class BaseOption
       require_sub __FILE__
+      include ::EacCli::Definition::DefaultValue
 
       class << self
         def from_args(args)
@@ -17,7 +19,7 @@ module EacCli
       DEFAULT_REQUIRED = false
 
       enable_listable
-      enable_abstract_methods :build_value, :default_value
+      enable_abstract_methods :build_value
       lists.add_symbol :option, :default, :optional, :usage, :repeat, :required
       common_constructor :short, :long, :description, :options, default: [{}] do
         raise 'Nor short neither long selector was set' if short.blank? && long.blank?

data/lib/eac_cli/definition/default_value.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Definition
+    module DefaultValue
+      def default_value
+        default_value? ? options[OPTION_DEFAULT] : default_default_value
+      end
+
+      def default_value?
+        options.key?(OPTION_DEFAULT)
+      end
+    end
+  end
+end

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

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
 
+require 'eac_cli/runner_with/help/layout'
 require 'eac_ruby_utils/core_ext'
 
 module EacCli
   module RunnerWith
     module Help
       class Builder
+        include ::EacCli::RunnerWith::Help::Layout
         require_sub __FILE__, require_dependency: true
         common_constructor :runner
 
-        SEP = ' '
-        IDENT = SEP * 2
-        OPTION_DESC_SEP = IDENT * 2
-
         class << self
           def option_long(option)
             b = option.long
@@ -35,7 +33,7 @@ module EacCli
           end
 
           def word_separator
-            SEP
+            WORD_SEPARATOR
           end
         end
 
@@ -45,36 +43,37 @@ module EacCli
           runner.class.runner_definition
         end
 
+        # @return [Enumerable<String>]
+        def extra_sections
+          runner.if_respond(:help_extra_text, []) do |v|
+            [v.to_s]
+          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
+            .reject(&:blank?).join(OPTION_DESCRIPTION_SEPARATOR)
         end
 
+        # @return [String]
         def options_section
-          "Options:\n" +
-            definition.alternatives.flat_map(&:options)
-              .map { |option| IDENT + option_definition(option) + "\n" }.join
+          list_section(
+            '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
+          list_section(
+            'Usage',
+            definition.alternatives.map { |alternative| self.alternative(alternative) }
+          )
         end
 
         def to_s
-          "#{definition.description}\n\n#{usage_section}\n#{options_section}\n"
+          join_sections(definition.description, usage_section, options_section, *extra_sections)
         end
       end
     end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module RunnerWith
+    module Help
+      module Layout
+        common_concern do
+          include InstanceClassMethods
+          extend InstanceClassMethods
+        end
+
+        module InstanceClassMethods
+          WORD_SEPARATOR = ' '
+          IDENTATION = WORD_SEPARATOR * 2
+          OPTION_DESCRIPTION_SEPARATOR = IDENTATION * 2
+          LINE_BREAK = "\n"
+          SECTION_SEPARATOR = LINE_BREAK * 2
+
+          # @param title String
+          # @param items [Enumerable<String>]
+          # @return [String]
+          def list_section(title, items)
+            (["#{title}:"] + items.map { |line| "#{IDENTATION}#{line}" })
+              .map { |line| "#{line}\n" }.join
+          end
+
+          # @param sections [Enumerable<String>]
+          # @return [String]
+          def join_sections(*sections)
+            sections.map { |s| s.to_s.strip }.join(SECTION_SEPARATOR) + LINE_BREAK
+          end
+        end
+
+        extend InstanceClassMethods
+      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
 
@@ -20,6 +20,18 @@ module EacCli
         end
       end
 
+      # @param items [Enumerable<String>]
+      # @return [String]
+      def help_list_section(title, items)
+        ::EacCli::RunnerWith::Help::Layout.list_section(title, items)
+      end
+
+      # @param items [Enumerable<String>]
+      # @return [String]
+      def help_join_sections(*sections)
+        ::EacCli::RunnerWith::Help::Layout.join_sections(*sections)
+      end
+
       def help_run
         return unless show_help?
 
@@ -27,10 +39,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/input.rb

@@ -2,7 +2,7 @@
 
 require 'eac_cli/runner'
 require 'eac_ruby_utils/core_ext'
-require 'eac_ruby_utils/abstract_methods'
+require 'eac_ruby_utils/acts_as_abstract'
 
 module EacCli
   module RunnerWith

data/lib/eac_cli/runner_with/output.rb

@@ -2,7 +2,7 @@
 
 require 'eac_cli/runner'
 require 'eac_ruby_utils/core_ext'
-require 'eac_ruby_utils/abstract_methods'
+require 'eac_ruby_utils/acts_as_abstract'
 
 module EacCli
   module RunnerWith

data/lib/eac_cli/runner_with/subcommands.rb

@@ -51,9 +51,9 @@ 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
+        help_list_section('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.33.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.33.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-05-12 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.114'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.112'
+        version: '0.114'
 - !ruby/object:Gem::Dependency
   name: eac_ruby_gem_support
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +92,7 @@ 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/default_value.rb
 - lib/eac_cli/definition/positional_argument.rb
 - lib/eac_cli/enum.rb
 - lib/eac_cli/old_configs.rb
@@ -126,6 +127,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/layout.rb
 - lib/eac_cli/runner_with/input.rb
 - lib/eac_cli/runner_with/output.rb
 - lib/eac_cli/runner_with/subcommands.rb