eac_tools 0.2.1 → 0.2.2

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module RunnerWith
+    module Help
+      class Builder
+        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
+            b += '=<value>' if option.argument?
+            b
+          end
+
+          def option_short(option)
+            b = option.short
+            b += '=<value>' if option.argument?
+            b
+          end
+
+          def option_usage_full(option)
+            if option.long.present?
+              [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)
+          [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
+
+        def options_section
+          "Options:\n" +
+            definition.alternatives.flat_map(&:options)
+              .map { |option| IDENT + option_definition(option) + "\n" }.join
+        end
+
+        def usage_section
+          "Usage:\n" +
+            definition.alternatives.map do |alternative|
+              IDENT + self.alternative(alternative) + "\n"
+            end.join
+        end
+
+        def to_s
+          "#{definition.description}\n\n#{usage_section}\n#{options_section}\n"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'eac_cli/runner'
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module RunnerWith
+    module Help
+      require_sub __FILE__, require_dependency: true
+      common_concern do
+        include ::EacCli::Runner
+
+        runner_definition.alt do
+          bool_opt '-h', '--help', 'Show help.', usage: true, required: true
+          pos_arg :any_arg_with_help, repeat: true, optional: true, visible: false
+        end
+
+        set_callback :run, :before do
+          help_run
+        end
+      end
+
+      def help_run
+        return unless show_help?
+
+        puts help_text
+        raise ::EacCli::Runner::Exit
+      end
+
+      def help_text
+        r = ::EacCli::RunnerWith::Help::Builder.new(self).to_s
+        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/sub/eac_cli/lib/eac_cli/runner_with/subcommands/definition_concern.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module EacCli
+  module RunnerWith
+    module Subcommands
+      module DefinitionConcern
+      end
+    end
+  end
+end

data/sub/eac_cli/lib/eac_cli/runner_with/subcommands.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'eac_cli/runner'
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module RunnerWith
+    module Subcommands
+      require_sub __FILE__
+
+      class << self
+        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
+        include ::EacCli::Runner
+        runner_definition.singleton_class
+          .include(::EacCli::RunnerWith::Subcommands::DefinitionConcern)
+      end
+
+      EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME = :extra_available_subcommands
+
+      def available_subcommands
+        @available_subcommands ||= available_subcommands_auto.merge(available_subcommands_extra)
+      end
+
+      # @return [Hash<String, EacCli::Runner>]
+      def available_subcommands_auto
+        ::EacCli::RunnerWith::Subcommands.subcommands_from_module(self.class)
+      end
+
+      def available_subcommands_extra
+        if respond_to?(EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME, true)
+          send(EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME)
+        else
+          {}
+        end
+      end
+
+      def help_extra_text
+        (['Subcommands:'] + available_subcommands.keys.sort.map { |s| "  #{s}" })
+          .map { |v| "#{v}\n" }.join
+      end
+
+      def method_missing(method_name, *arguments, &block)
+        return run_with_subcommand(*arguments, &block) if
+        run_with_subcommand_alias_run?(method_name)
+
+        super
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        run_with_subcommand_alias_run?(method_name) || super
+      end
+
+      def run_with_subcommand
+        if run_subcommand?
+          if subcommand_runner.respond_to?(:run_run)
+            subcommand_runner.run_run
+          else
+            subcommand_runner.run
+          end
+        else
+          run_without_subcommand
+        end
+      end
+
+      def run_with_subcommand_alias_run?(method_name)
+        subcommands? && method_name.to_sym == :run
+      end
+
+      def run_without_subcommand
+        "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
+
+      def subcommand_args
+        parsed.fetch(::EacCli::Definition::SUBCOMMAND_ARGS_ARG)
+      end
+
+      def subcommand_class
+        available_subcommands[subcommand_name].if_present { |v| return v }
+
+        raise(::EacCli::Parser::Error.new(
+                self.class.runner_definition, runner_context.argv,
+                "Subcommand \"#{subcommand_name}\" not found " \
+                  "(Available: #{available_subcommands.keys})"
+              ))
+      end
+
+      def subcommand_name
+        parsed.fetch(::EacCli::Definition::SUBCOMMAND_NAME_ARG)
+      end
+
+      def subcommand_program
+        [program_name, subcommand_name]
+      end
+
+      def subcommand_runner
+        @subcommand_runner ||= subcommand_class.create(
+          argv: subcommand_args,
+          program_name: subcommand_program,
+          parent: self
+        )
+      end
+    end
+  end
+end

data/sub/eac_cli/lib/eac_cli/runner_with.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module RunnerWith
+    require_sub __FILE__
+  end
+end

data/sub/eac_cli/lib/eac_cli/runner_with_set.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module EacCli
+  class RunnerWithSet
+    class << self
+      def default
+        @default ||= new
+      end
+    end
+
+    def add_namespace(namespace)
+      namespace = sanitize_namespace(namespace)
+      raise "\"#{namespace}\" already was included" if namespace_set.include?(namespace)
+
+      namespace_set << namespace
+      self
+    end
+
+    def item_to_module(item)
+      item.is_a?(::Module) ? item : key_to_module(item)
+    end
+
+    def namespaces
+      namespace_set.dup
+    end
+
+    private
+
+    def namespace_set
+      @namespace_set ||= ::Array.new
+    end
+
+    def key_to_module(key)
+      namespace_set.lazy
+        .map { |namespace| key_to_module_in_namespace(namespace, key) }
+        .find(&:present?) ||
+        raise("Not module found with key \"#{key}\" (Namespaces: #{namespace_set})")
+    end
+
+    def key_to_module_in_namespace(namespace, key)
+      namespace.const_get(key.to_s.camelize)
+    rescue ::NameError
+      nil
+    end
+
+    def sanitize_namespace(source)
+      source.is_a?(::Module) ? source : source.to_s.constantize
+    end
+  end
+end

data/sub/eac_cli/lib/eac_cli/speaker/constants.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/by_reference'
+
+module EacCli
+  class Speaker
+    module Constants
+      STDERR = ::EacRubyUtils::ByReference.new { $stderr }
+      STDIN = ::EacRubyUtils::ByReference.new { $stdin }
+      STDOUT = ::EacRubyUtils::ByReference.new { $stdout }
+    end
+  end
+end

data/sub/eac_cli/lib/eac_cli/speaker/list.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'active_support/hash_with_indifferent_access'
+require 'ostruct'
+
+module EacCli
+  class Speaker
+    class List
+      class << self
+        def build(list)
+          return List.new(hash_to_values(list)) if list.is_a?(::Hash)
+          return List.new(array_to_values(list)) if list.is_a?(::Array)
+
+          raise "Invalid list: #{list} (#{list.class})"
+        end
+
+        private
+
+        def hash_to_values(list)
+          list.map { |key, value| ::OpenStruct.new(key: key, label: key, value: value) }
+        end
+
+        def array_to_values(list)
+          list.map { |value| ::OpenStruct.new(key: value, label: value, value: value) }
+        end
+      end
+
+      attr_reader :values
+
+      def initialize(values)
+        @values = values.map do |v|
+          ::OpenStruct.new(key: to_key(v.key), label: to_label(v.label), value: v.value)
+        end
+      end
+
+      def valid_labels
+        values.map(&:label)
+      end
+
+      def valid_value?(value)
+        values.any? { |v| v.key == to_key(value) }
+      end
+
+      def to_key(value)
+        to_label(value).downcase
+      end
+
+      def to_label(value)
+        value.to_s.strip
+      end
+
+      def build_value(value)
+        key = to_key(value)
+        values.each do |v| # rubocop:disable Style/HashEachMethods
+          return v.value if v.key == key
+        end
+        raise "Value not found: \"#{value}\" (#{values})"
+      end
+    end
+  end
+end

data/sub/eac_cli/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/sub/eac_cli/lib/eac_cli/speaker.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'colorize'
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/speaker/receiver'
+
+module EacCli
+  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|
+        err_out.puts(err_line_prefix.to_s + line)
+      end
+    end
+
+    def out(string = '')
+      out_out.write(string.to_s)
+    end
+
+    def error(string)
+      puts "ERROR: #{string}".white.on_red
+    end
+
+    def title(string)
+      string = string.to_s
+      puts(('-' * (8 + string.length)).green)
+      puts("--- #{string} ---".green)
+      puts(('-' * (8 + string.length)).green)
+      puts
+    end
+
+    def info(string)
+      puts string.to_s.white
+    end
+
+    def infom(string)
+      puts string.to_s.light_yellow
+    end
+
+    def warn(string)
+      puts string.to_s.yellow
+    end
+
+    # Options:
+    #   +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 input(question, options = {})
+      bool, list, noecho = options.to_options_consumer.consume_all(:bool, :list, :noecho)
+      if list
+        request_from_list(question, list, noecho)
+      elsif bool
+        request_from_bool(question, noecho)
+      else
+        request_string(question, noecho)
+      end
+    end
+
+    def infov(*args)
+      r = []
+      args.each_with_index do |v, i|
+        if i.even?
+          r << "#{v}: ".cyan
+        else
+          r.last << v.to_s
+        end
+      end
+      puts r.join(', ')
+    end
+
+    def success(string)
+      puts string.to_s.green
+    end
+
+    private
+
+    def list_value(list, input)
+      values = list_values(list)
+      return input, true unless values
+      return input, false unless values.include?(input)
+    end
+
+    def list_values(list)
+      if list.is_a?(::Hash)
+        list.keys.map(&:to_s)
+      elsif list.is_a?(::Array)
+        list.map(&:to_s)
+      end
+    end
+
+    def request_from_bool(question, noecho)
+      request_from_list(question, { yes: true, y: true, no: false, n: false }, noecho)
+    end
+
+    def request_from_list(question, list, noecho)
+      list = ::EacCli::Speaker::List.build(list)
+      loop do
+        input = request_string("#{question} [#{list.valid_labels.join('/')}]", noecho)
+        return list.build_value(input) if list.valid_value?(input)
+
+        warn "Invalid input: \"#{input}\" (Valid: #{list.valid_labels.join(', ')})"
+      end
+    end
+
+    def request_string(question, noecho)
+      err_out.write "#{question}: ".to_s.yellow
+      noecho ? request_string_noecho : request_string_echo
+    end
+
+    def request_string_noecho
+      r = in_in.noecho(&:gets).chomp.strip
+      err_out.write("\n")
+      r
+    end
+
+    def request_string_echo
+      in_in.gets.chomp.strip
+    end
+  end
+end

data/sub/eac_cli/lib/eac_cli/version.rb

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

data/sub/eac_cli/lib/eac_cli.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  require_sub __FILE__
+end

data/sub/eac_cli/spec/lib/eac_cli/definition/alternative_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'eac_cli/definition/alternative'
+
+RSpec.describe ::EacCli::Definition::Alternative do
+  let(:instance) { described_class.new }
+
+  it { expect { instance.arg_opt '-a', '--opt2', 'A argument option' }.not_to raise_error }
+  it { expect { instance.bool_opt '-b', '--opt1', 'A boolean option' }.not_to raise_error }
+  it { expect { instance.bool_opt '-b', '--no-description' }.not_to raise_error }
+  it { expect { instance.bool_opt '--opt1', 'A option without short' }.not_to raise_error }
+  it { expect { instance.bool_opt '-b', 'A option without long' }.not_to raise_error }
+  it { expect { instance.bool_opt 'A option without selectors' }.to raise_error(::StandardError) }
+  it { expect { instance.options_argument(true) }.not_to raise_error }
+  it { expect { instance.pos_arg :pos1 }.not_to raise_error }
+  it { expect { instance.pos_arg :pos2, optional: true, repeat: true }.not_to raise_error }
+  it { expect { instance.subcommands }.not_to raise_error }
+end

data/sub/eac_cli/spec/lib/eac_cli/old_configs_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'eac_cli/old_configs'
+
+RSpec.describe ::EacCli::OldConfigs do
+  describe '#entry_key_to_envvar_name' do
+    {
+      'a.entry.value' => 'A_ENTRY_VALUE',
+      'appli-cation_0.var_one' => 'APPLICATION_0_VAR_ONE'
+    }.each do |input, expected_result|
+      it { expect(described_class.entry_key_to_envvar_name(input)).to eq(expected_result) }
+    end
+  end
+end