eac_cli 0.30.1 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8bb5a28b8f6905c8e8fe31a46ea1ef51aa53f40efc5754328b299414aebbd86
-  data.tar.gz: a3d0083739d15bbda74e05db8043441c254c14435532d279f3a8579bffb6bbf1
+  metadata.gz: d1e50e2a284a092f29a86d4ed6871c5f72d60cd0b655f8ab991d281bc0245786
+  data.tar.gz: 88e1aac4d700544a32debe645752a192f2732ee2e4f248796a952acf33853dab
 SHA512:
-  metadata.gz: 5eb7b2c0629d9e2b7929ad9665a1372f52f5524c7761940370a3b9491a16c1799bb261fb822c85d54e5b811e5e6a72cce82f360cb88782accf8edee04dd742fa
-  data.tar.gz: 58af9e3a6f0d69be373c6b8e118ddf44778b8304edb016632debe407fb3918d0339b03f8cb5ce55982328f805014a1006683fd3e4bc5fab66ad7f51101d5a2ba
+  metadata.gz: 1cfe95828490465373b2cacb1f7a8a087903466b89ec0a7fb208cbe05742c5a8c498834350aa35d606cefe900e088853c9b6f5fd5213c71e4a25bb1843616564
+  data.tar.gz: 9d38a66bd9b3b1f3dea27c386a50a26c430cc94ed142ab5733297ab499ad4bf718b04f17d81b765e54e6d9c08e3517abc519877b54bf521e2c15e6704c80db75

data/lib/eac_cli/runner_with/confirmation.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'eac_cli/runner'
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module RunnerWith
+    module Confirmation
+      DEFAULT_CONFIRM_QUESTION_TEXT = 'Confirm?'
+
+      common_concern do
+        include ::EacCli::Runner
+        enable_settings_provider
+        enable_simple_cache
+        runner_definition do
+          bool_opt '--no', 'Deny confirmation without question.'
+          bool_opt '--yes', 'Accept confirmation without question.'
+        end
+      end
+
+      def confirm?(message = nil)
+        return false if parsed.no?
+        return true if parsed.yes?
+
+        input(
+          message || setting_value(:confirm_question_text, default: DEFAULT_CONFIRM_QUESTION_TEXT),
+          bool: true
+        )
+      rescue ::EacCli::Speaker::InputRequested => e
+        fatal_error e.message
+      end
+
+      def run_confirm(message = nil)
+        yield if confirm?(message)
+      end
+
+      private
+
+      def cached_confirm_uncached?(message = nil)
+        confirm?(message)
+      end
+    end
+  end
+end

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/input.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'eac_cli/runner'
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/abstract_methods'
+
+module EacCli
+  module RunnerWith
+    module Input
+      STDIN_OPTION = '-'
+      BLANK_OPTION = '+'
+      DEFAULT_DEFAULT_INPUT_OPTION = BLANK_OPTION
+
+      common_concern do
+        enable_settings_provider
+        include ::EacCli::Runner
+
+        runner_definition do
+          arg_opt '-i', '--input', 'Input from file.'
+        end
+      end
+
+      def input_content
+        case input_option
+        when STDIN_OPTION then $stdin.read
+        when BLANK_OPTION then ''
+        else input_option.to_pathname.read
+        end
+      end
+
+      def input_option
+        parsed.input || setting_value(:default_input_option, default: DEFAULT_DEFAULT_INPUT_OPTION)
+      end
+    end
+  end
+end

data/lib/eac_cli/runner_with/output.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'eac_cli/runner'
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/abstract_methods'
+
+module EacCli
+  module RunnerWith
+    module Output
+      STDOUT_OPTION = '-'
+      DEFAULT_FILE_OPTION = '+'
+      DEFAULT_DEFAULT_OUTPUT_OPTION = STDOUT_OPTION
+      DEFAULT_DEFAULT_FILE_TO_OUTPUT = 'output'
+
+      common_concern do
+        enable_abstract_methods
+        enable_settings_provider
+        include ::EacCli::Runner
+
+        abstract_methods :output_content
+
+        runner_definition do
+          arg_opt '-o', '--output', 'Output to file.'
+        end
+      end
+
+      def run_output
+        file = file_to_output
+        if file
+          file.to_pathname.write(output_content)
+        else
+          $stdout.write(output_content)
+        end
+      end
+
+      def output_option
+        parsed.output || default_output_option_value
+      end
+
+      def file_to_output
+        case output_option
+        when STDOUT_OPTION then nil
+        when DEFAULT_FILE_OPTION then default_file_to_output_value
+        else output_option
+        end
+      end
+
+      def default_output_option_value
+        setting_value(:default_output_option,
+                      default: DEFAULT_DEFAULT_OUTPUT_OPTION)
+      end
+
+      def default_file_to_output_value
+        setting_value(:default_file_to_output, default: DEFAULT_DEFAULT_FILE_TO_OUTPUT)
+      end
+    end
+  end
+end

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.30.1'
+  VERSION = '0.32.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_cli
 version: !ruby/object:Gem::Version
-  version: 0.30.1
+  version: 0.32.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-29 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
@@ -122,9 +122,13 @@ files:
 - lib/eac_cli/runner/exit.rb
 - lib/eac_cli/runner/instance_methods.rb
 - lib/eac_cli/runner_with.rb
+- lib/eac_cli/runner_with/confirmation.rb
 - 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
 - lib/eac_cli/runner_with/subcommands/definition_concern.rb
 - lib/eac_cli/runner_with_set.rb