eac_cli 0.17.0 → 0.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be83e696754b3da778f4f01601dab1b68e6dc34248bfa70f3fc669ad102d7941
-  data.tar.gz: de452af57c0c3b0609884f82c1aed57878cae0df13f9c1628ded0b2918d20746
+  metadata.gz: ed5f842e4e428ffc7004dbd3d1e1b6c6a18d868ac51a8c61c82578708260cee6
+  data.tar.gz: 9b5bef7e60e9199c2fdc7555453ea34bc289830aee7fff44629143686e9abe69
 SHA512:
-  metadata.gz: da02c87bffd576e6abe4dc4c143c5ba89a1e5eadf9215b8665e993ff5413eedc345ed8444e2fc9a549f4af757fb0368fe97d15999f65753fde62479ae70ebef6
-  data.tar.gz: b865a33fe9660b7eaa4fc118985ef34ae289bf5593f9799e4b8274ec8694b5d5a32c895f9a30a35d74d8296c410ca6e144cc97c3a232abe18d3d6876a3f0ccb9
+  metadata.gz: 3ad50457b9d19af0bf7fbb6987d8b413c0aa8b47e14bca04b4bf6bddd4b0298137d84bb4e2f1aa12480e47f58192f67f33ff169310b52445388e29bff15d9fd0
+  data.tar.gz: e7e437ef6d395d38a965d2cf45e470ca421025ac1829dfe16c5e1f2d015ffb1163971adbcb58dca88972f5018dae648e7c7c189c810af9028c99cee005db22a1

data/lib/eac_cli/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'eac_config/envvars_node'
+require 'eac_config/yaml_file_node'
+
+module EacCli
+  class Config
+    require_sub __FILE__
+    attr_reader :sub
+
+    def initialize(sub_node)
+      @sub = sub_node
+    end
+
+    def entry(path, options = {})
+      ::EacCli::Config::Entry.new(self, path, options)
+    end
+  end
+end

data/lib/eac_cli/config/entry.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'eac_cli/speaker'
+require 'eac_config/entry_path'
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Config
+    class Entry
+      require_sub __FILE__, include_modules: true
+      enable_listable
+      enable_simple_cache
+      enable_speaker
+
+      common_constructor :config, :path, :options do
+        self.path = ::EacConfig::EntryPath.assert(path)
+        self.options = ::EacCli::Config::Entry::Options.new(options)
+      end
+
+      def value
+        return sub_value_to_return if sub_entry.found?
+        return nil unless options.required?
+
+        puts "|#{sub_entry.path}|"
+
+        input_value
+      end
+
+      delegate :value=, to: :sub_entry
+
+      private
+
+      def sub_value_to_return
+        sub_entry.value.presence || ::EacRubyUtils::BlankNotBlank.instance
+      end
+
+      def sub_entry_uncached
+        config.sub.entry(path)
+      end
+
+      def input_value_uncached
+        r = send("#{options.type}_value")
+        sub_entry.value = r if options.store?
+        r
+      end
+    end
+  end
+end

data/lib/eac_cli/config/entry/options.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Config
+    class Entry
+      class Options
+        enable_simple_cache
+        enable_listable
+
+        lists.add_symbol :type, :undefined
+
+        DEFAULT_VALUES = {
+          before_input: nil, bool: false, list: false, noecho: false, noenv: false, noinput: false,
+          required: true, store: true, type: TYPE_UNDEFINED, validator: nil
+        }.freeze
+
+        lists.add_symbol :option, *DEFAULT_VALUES.keys
+
+        common_constructor :options do
+          self.options = self.class.lists.option.hash_keys_validate!(options)
+        end
+
+        delegate :to_h, to: :options
+
+        def [](key)
+          values.fetch(key.to_sym)
+        end
+
+        def request_input_options
+          values.slice(:bool, :list, :noecho)
+        end
+
+        DEFAULT_VALUES.each do |attr, default_value|
+          define_method(attr.to_s + ([true, false].include?(default_value) ? '?' : '')) do
+            self[attr]
+          end
+        end
+
+        private
+
+        def values_uncached
+          consumer = options.to_options_consumer
+          r = {}
+          DEFAULT_VALUES.each do |key, default_value|
+            value = consumer.consume(key)
+            value = default_value if value.nil?
+            r[key] = value
+          end
+          consumer.validate
+          r
+        end
+      end
+    end
+  end
+end

data/lib/eac_cli/config/entry/undefined.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Config
+    class Entry
+      module Undefined
+        private
+
+        def undefined_value
+          loop do
+            entry_value = undefined_value_no_loop
+            next unless options[:validator].if_present(true) { |v| v.call(entry_value) }
+
+            return entry_value
+          end
+        end
+
+        def undefined_value_no_loop
+          input("Value for entry \"#{path}\"", options.request_input_options)
+        end
+      end
+    end
+  end
+end

data/lib/eac_cli/definition/positional_argument.rb

@@ -6,9 +6,10 @@ module EacCli
   class Definition
     class PositionalArgument
       DEFAULT_REQUIRED = true
+      DEFAULT_VISIBLE = true
 
       enable_listable
-      lists.add_symbol :option, :optional, :repeat, :required, :subcommand
+      lists.add_symbol :option, :optional, :repeat, :required, :subcommand, :visible
       common_constructor :name, :options, default: [{}] do
         options.assert_valid_keys(self.class.lists.option.values)
       end
@@ -51,6 +52,10 @@ module EacCli
       def to_s
         "#{self.class.name.demodulize}[#{identifier}]"
       end
+
+      def visible?
+        options.key?(OPTION_VISIBLE) ? options.fetch(OPTION_VISIBLE) : DEFAULT_VISIBLE
+      end
     end
   end
 end

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

@@ -31,10 +31,12 @@ module EacCli
         end
 
         def positionals
-          alternative.positional.map { |p| positional(p) }
+          alternative.positional.map { |p| positional(p) }.reject(&:blank?)
         end
 
         def positional(positional)
+          return unless positional.visible?
+
           if positional.subcommand?
             ::EacCli::DocoptRunner::SUBCOMMANDS_MACRO
           else

data/lib/eac_cli/docopt_runner.rb

@@ -1,17 +1,13 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/hash/slice'
+require 'eac_ruby_utils/core_ext'
 require 'docopt'
-require 'eac_ruby_utils/contextualizable'
-require 'eac_ruby_utils/patches/hash/sym_keys_hash'
-Dir["#{__dir__}/#{::File.basename(__FILE__, '.*')}/_*.rb"].sort.each do |partial|
-  require partial
-end
 
 module EacCli
   class DocoptRunner
-    include ::EacRubyUtils::Contextualizable
+    require_sub __FILE__
+    extend ::EacCli::DocoptRunner::ClassMethods
+    include ::EacCli::DocoptRunner::Context
 
     class << self
       def create(settings = {})

data/lib/eac_cli/docopt_runner/{_class_methods.rb → class_methods.rb}

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
+require 'docopt'
+
 module EacCli
   class DocoptRunner
-    DOCOPT_ERROR_EXIT_CODE = 0xC0
+    module ClassMethods
+      DOCOPT_ERROR_EXIT_CODE = 0xC0
 
-    class << self
       def run(options = {})
         create(options).send(:run)
-      rescue Docopt::Exit => e
+      rescue ::Docopt::Exit => e
         STDERR.write(e.message + "\n")
         ::Kernel.exit(DOCOPT_ERROR_EXIT_CODE)
       end

data/lib/eac_cli/docopt_runner/context.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module EacCli
+  class DocoptRunner
+    # Provides the method context which search and call a method in self and ancestor objects.
+    module Context
+      def context(method)
+        current = self
+        while current
+          return current.send(method) if current.respond_to?(method)
+
+          current = current.respond_to?(:parent) ? current.parent : nil
+        end
+        raise "Context method \"#{method}\" not found for #{self.class}"
+      end
+    end
+  end
+end

data/lib/eac_cli/old_configs.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/core_ext'
-require 'eac_cli/patches/module/speaker'
 
 module EacCli
   class OldConfigs

data/lib/eac_cli/old_configs/entry_reader.rb

@@ -70,8 +70,8 @@ module EacCli
       end
 
       def entry_value_from_input(entry_key, options)
-        entry_value = request_input("Value for entry \"#{entry_key}\"",
-                                    options.request_input_options)
+        entry_value = input("Value for entry \"#{entry_key}\"",
+                            options.request_input_options)
         warn('Entered value is blank') if entry_value.blank?
         entry_value
       end

data/lib/eac_cli/old_configs_bridge.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'eac_cli/config'
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class OldConfigsBridge < ::EacCli::Config
+    ENTRY_KEY = 'core.store_passwords'
+
+    class << self
+      def new_configs_path(configs_key, options)
+        options[:storage_path] || ::File.join(ENV['HOME'], '.config', configs_key, 'settings.yml')
+      end
+    end
+
+    def initialize(configs_key, options = {})
+      options.assert_argument(::Hash, 'options')
+      envvar_node = ::EacConfig::EnvvarsNode.new
+      file_node = ::EacConfig::YamlFileNode.new(self.class.new_configs_path(configs_key, options))
+      envvar_node.load_path.push(file_node.url)
+      envvar_node.write_node = file_node
+      super(envvar_node)
+    end
+
+    def read_entry(entry_key, options = {})
+      entry(entry_key, options).value
+    end
+
+    def read_password(entry_key, options = {})
+      entry(entry_key, options.merge(noecho: true, store: store_passwords?)).value
+    end
+
+    def store_passwords?
+      read_entry(ENTRY_KEY, bool: true)
+    end
+  end
+end

data/lib/eac_cli/runner/after_class_methods.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'eac_cli/speaker'
+require 'eac_ruby_utils/speaker'
+
 module EacCli
   module Runner
     module AfterClassMethods
@@ -10,9 +13,11 @@ module EacCli
       end
 
       def run(*runner_context_args)
-        r = create(*runner_context_args)
-        r.run_run
-        r
+        on_asserted_speaker do
+          r = create(*runner_context_args)
+          r.run_run
+          r
+        end
       end
 
       def runner_definition(&block)
@@ -24,6 +29,18 @@ 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_with/help.rb

@@ -10,8 +10,8 @@ module EacCli
         include ::EacCli::Runner
 
         runner_definition.alt do
-          options_argument false
           bool_opt '-h', '--help', 'Show help.', usage: true
+          pos_arg :any_arg_with_help, repeat: true, optional: true, visible: false
         end
 
         set_callback :run, :before do
@@ -20,7 +20,7 @@ module EacCli
       end
 
       def help_run
-        return unless parsed.help?
+        return unless show_help?
 
         puts help_text
         raise ::EacCli::Runner::Exit
@@ -31,6 +31,10 @@ module EacCli
         r += help_extra_text if respond_to?(:help_extra_text)
         r
       end
+
+      def show_help?
+        parsed.help? && !if_respond(:run_subcommand?, false)
+      end
     end
   end
 end

data/lib/eac_cli/runner_with/subcommands.rb

@@ -60,7 +60,7 @@ module EacCli
       end
 
       def run_with_subcommand
-        if subcommand_name
+        if run_subcommand?
           if subcommand_runner.respond_to?(:run_run)
             subcommand_runner.run_run
           else
@@ -79,6 +79,10 @@ module EacCli
         "Method #{__method__} should be overrided in #{self.class.name}"
       end
 
+      def run_subcommand?
+        subcommand_name.present?
+      end
+
       def subcommands?
         self.class.runner_definition.subcommands?
       end

data/lib/eac_cli/speaker.rb

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
 require 'colorize'
-require 'io/console'
-require 'eac_ruby_utils/patches/hash/options_consumer'
-require 'eac_ruby_utils/require_sub'
-::EacRubyUtils.require_sub __FILE__
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/speaker/receiver'
 
 module EacCli
-  # https://github.com/fazibear/colorize
-  module Speaker
-    def on_speaker_node(&block)
-      ::EacCli::Speaker.on_node(&block)
+  class Speaker
+    require_sub __FILE__, include_modules: true
+    include ::EacRubyUtils::Speaker::Receiver
+
+    common_constructor :options, default: [{}] do
+      self.options = self.class.lists.option.hash_keys_validate!(options)
     end
 
     def puts(string = '')
       string.to_s.each_line do |line|
-        current_node.stderr.puts(current_node.stderr_line_prefix.to_s + line)
+        err_out.puts(err_line_prefix.to_s + line)
       end
     end
 
     def out(string = '')
-      current_node.stdout.write(string.to_s)
+      out_out.write(string.to_s)
     end
 
     def fatal_error(string)
@@ -52,7 +52,7 @@ module EacCli
     #   +bool+ ([Boolean], default: +false+): requires a answer "yes" or "no".
     #   +list+ ([Hash] or [Array], default: +nil+): requires a answer from a list.
     #   +noecho+ ([Boolean], default: +false+): does not output answer.
-    def request_input(question, options = {})
+    def input(question, options = {})
       bool, list, noecho = options.to_options_consumer.consume_all(:bool, :list, :noecho)
       if list
         request_from_list(question, list, noecho)
@@ -110,22 +110,18 @@ module EacCli
     end
 
     def request_string(question, noecho)
-      current_node.stderr.write "#{question}: ".to_s.yellow
+      err_out.write "#{question}: ".to_s.yellow
       noecho ? request_string_noecho : request_string_echo
     end
 
     def request_string_noecho
-      r = current_node.stdin.noecho(&:gets).chomp.strip
-      current_node.stderr.write("\n")
+      r = in_in.noecho(&:gets).chomp.strip
+      err_out.write("\n")
       r
     end
 
     def request_string_echo
-      current_node.stdin.gets.chomp.strip
-    end
-
-    def current_node
-      ::EacCli::Speaker.current_node
+      in_in.gets.chomp.strip
     end
   end
 end

data/lib/eac_cli/speaker/_constants.rb

@@ -4,7 +4,7 @@ require 'eac_ruby_utils/by_reference'
 
 module EacCli
   # https://github.com/fazibear/colorize
-  module Speaker
+  class Speaker
     STDERR = ::EacRubyUtils::ByReference.new { $stderr }
     STDIN = ::EacRubyUtils::ByReference.new { $stdin }
     STDOUT = ::EacRubyUtils::ByReference.new { $stdout }

data/lib/eac_cli/speaker/list.rb

@@ -4,7 +4,7 @@ require 'active_support/hash_with_indifferent_access'
 require 'ostruct'
 
 module EacCli
-  module Speaker
+  class Speaker
     class List
       class << self
         def build(list)

data/lib/eac_cli/speaker/options.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Speaker
+    module Options
+      common_concern do
+        enable_listable
+        lists.add_symbol :option, :out_out, :err_out, :in_in, :parent, :err_line_prefix
+      end
+
+      def err_out
+        option(OPTION_ERR_OUT, ::EacCli::Speaker::STDERR)
+      end
+
+      def out_out
+        option(OPTION_OUT_OUT, ::EacCli::Speaker::STDOUT)
+      end
+
+      def in_in
+        option(OPTION_IN_IN, ::EacCli::Speaker::STDIN)
+      end
+
+      def err_line_prefix
+        option(OPTION_ERR_LINE_PREFIX, '')
+      end
+
+      def parent
+        options[OPTION_PARENT]
+      end
+
+      def option(key, default)
+        options[key] || parent.if_present(default) { |v| v.send(__METHOD__) }
+      end
+    end
+  end
+end

data/lib/eac_cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_cli
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.20.2
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-23 00:00:00.000000000 Z
+date: 2021-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.64'
+        version: '0.67'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.64'
+        version: '0.67'
 - !ruby/object:Gem::Dependency
   name: eac_ruby_gem_support
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +88,10 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - lib/eac_cli.rb
+- lib/eac_cli/config.rb
+- lib/eac_cli/config/entry.rb
+- lib/eac_cli/config/entry/options.rb
+- lib/eac_cli/config/entry/undefined.rb
 - lib/eac_cli/core_ext.rb
 - lib/eac_cli/default_runner.rb
 - lib/eac_cli/definition.rb
@@ -103,15 +107,17 @@ files:
 - lib/eac_cli/docopt/runner_context_replacement.rb
 - lib/eac_cli/docopt/runner_extension.rb
 - lib/eac_cli/docopt_runner.rb
-- lib/eac_cli/docopt_runner/_class_methods.rb
 - lib/eac_cli/docopt_runner/_doc.rb
 - lib/eac_cli/docopt_runner/_settings.rb
 - lib/eac_cli/docopt_runner/_subcommands.rb
+- lib/eac_cli/docopt_runner/class_methods.rb
+- lib/eac_cli/docopt_runner/context.rb
 - lib/eac_cli/old_configs.rb
 - lib/eac_cli/old_configs/entry_reader.rb
 - lib/eac_cli/old_configs/password_entry_reader.rb
 - lib/eac_cli/old_configs/read_entry_options.rb
 - lib/eac_cli/old_configs/store_passwords_entry_reader.rb
+- lib/eac_cli/old_configs_bridge.rb
 - lib/eac_cli/parser.rb
 - lib/eac_cli/parser/alternative.rb
 - lib/eac_cli/parser/alternative/argv.rb
@@ -124,8 +130,6 @@ files:
 - lib/eac_cli/parser/collector.rb
 - lib/eac_cli/parser/error.rb
 - lib/eac_cli/patches.rb
-- lib/eac_cli/patches/module.rb
-- lib/eac_cli/patches/module/speaker.rb
 - lib/eac_cli/patches/object.rb
 - lib/eac_cli/patches/object/runner_with.rb
 - lib/eac_cli/runner.rb
@@ -139,10 +143,9 @@ files:
 - lib/eac_cli/runner_with/subcommands/definition_concern.rb
 - lib/eac_cli/runner_with_set.rb
 - lib/eac_cli/speaker.rb
-- lib/eac_cli/speaker/_class_methods.rb
 - lib/eac_cli/speaker/_constants.rb
 - lib/eac_cli/speaker/list.rb
-- lib/eac_cli/speaker/node.rb
+- lib/eac_cli/speaker/options.rb
 - lib/eac_cli/version.rb
 homepage: 
 licenses: []

data/lib/eac_cli/patches/module.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/require_sub'
-::EacRubyUtils.require_sub(__FILE__)

data/lib/eac_cli/patches/module/speaker.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_cli/speaker'
-require 'eac_ruby_utils/patch'
-
-class Module
-  def enable_speaker
-    ::EacRubyUtils.patch(self, ::EacCli::Speaker)
-  end
-end

data/lib/eac_cli/speaker/_class_methods.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_cli/speaker/node'
-
-module EacCli
-  module Speaker
-    class << self
-      def current_node
-        nodes_stack.last
-      end
-
-      def on_node(&block)
-        push
-        yield(*(block.arity.zero? ? [] : [current_node]))
-      ensure
-        pop
-      end
-
-      def push
-        nodes_stack << ::EacCli::Speaker::Node.new
-        current_node
-      end
-
-      def pop
-        return nodes_stack.pop if nodes_stack.count > 1
-
-        raise "Cannot remove first node (nodes_stack.count: #{nodes_stack.count})"
-      end
-
-      private
-
-      def nodes_stack
-        @nodes_stack ||= [::EacCli::Speaker::Node.new]
-      end
-    end
-  end
-end

data/lib/eac_cli/speaker/node.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/patches/object/if_present'
-require 'eac_cli/speaker/_constants'
-
-module EacCli
-  module Speaker
-    class Node
-      attr_accessor :stdin, :stdout, :stderr, :stderr_line_prefix
-
-      def initialize(parent = nil)
-        self.stdin = parent.if_present(::EacCli::Speaker::STDIN, &:stdin)
-        self.stdout = parent.if_present(::EacCli::Speaker::STDOUT, &:stdout)
-        self.stderr = parent.if_present(::EacCli::Speaker::STDERR, &:stderr)
-        self.stderr_line_prefix = parent.if_present('', &:stderr_line_prefix)
-      end
-
-      def configure
-        yield(self)
-        self
-      end
-    end
-  end
-end