eac_tools 0.103.0 → 0.103.1

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'active_support/hash_with_indifferent_access'
+require 'ostruct'
+
+module EacCli
+  class Speaker
+    class List
+      VALUE_STRUCT = ::Struct.new(:key, :label, :value)
+
+      class << self
+        # @param list [Array, Hash]
+        # @param options [Hash]
+        def build(list, options = {})
+          return List.new(hash_to_values(list), options) if list.is_a?(::Hash)
+          return List.new(array_to_values(list), options) if list.is_a?(::Array)
+
+          raise "Invalid list: #{list} (#{list.class})"
+        end
+
+        private
+
+        def hash_to_values(list)
+          list.map { |key, value| VALUE_STRUCT.new(key, key, value) }
+        end
+
+        def array_to_values(list)
+          list.map { |value| VALUE_STRUCT.new(value, value, value) }
+        end
+      end
+
+      DEFAULT_IGNORE_CASE = true
+
+      enable_listable
+      lists.add_symbol :option, :ignore_case
+
+      # @!attribute [r] values
+      #   @return [Array<VALUE_STRUCT>]
+      #   # @!attribute [r] options
+      #   @return [Hash]
+      # @!method initialize(values)
+      #   @param values [Array<VALUE_STRUCT>]
+      #   @param options [Hash]
+      common_constructor :values, :options, default: [{}] do
+        self.options = self.class.lists.option.hash_keys_validate!(options)
+        self.values = values.map do |v|
+          VALUE_STRUCT.new(to_key(v.key), to_label(v.label), v.value)
+        end
+      end
+
+      # @return [Boolean]
+      def ignore_case?
+        options.if_key(OPTION_IGNORE_CASE, DEFAULT_IGNORE_CASE, &:to_bool)
+      end
+
+      def valid_labels
+        values.map(&:label)
+      end
+
+      def valid_value?(value)
+        values.any? { |v| v.key == to_key(value) }
+      end
+
+      # @param value [Object]
+      # @return [String]
+      def to_key(value)
+        r = to_label(value)
+        ignore_case? ? r.downcase : r
+      end
+
+      def to_label(value)
+        value.to_s.strip
+      end
+
+      def build_value(value)
+        key = to_key(value)
+        values.each do |v|
+          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,42 @@
+# frozen_string_literal: true
+
+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,
+                         :ignore_case
+      end
+
+      def err_out
+        option(OPTION_ERR_OUT, $stderr)
+      end
+
+      def out_out
+        option(OPTION_OUT_OUT, $stdout)
+      end
+
+      def in_in
+        option(OPTION_IN_IN, $stdin)
+      end
+
+      # @return [Boolean]
+      def ignore_case
+        option(OPTION_IGNORE_CASE, nil)
+      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/request_from_list.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module EacCli
+  class Speaker
+    class RequestFromList
+      acts_as_instance_method
+      enable_simple_cache
+      common_constructor :speaker, :question, :list_values, :noecho,
+                         :ignore_case
+
+      # @return [String]
+      def result
+        loop do
+          return list.build_value(input) if list.valid_value?(input)
+
+          speaker.warn "Invalid input: \"#{input}\" (Valid: #{list.valid_labels.join(', ')})"
+        end
+      end
+
+      protected
+
+      # @return [String]
+      def input_uncached
+        speaker.send(
+          :request_string,
+          "#{question} [#{list.valid_labels.join('/')}]",
+          noecho
+        )
+      end
+
+      # @return [EacCli::Speaker::List]
+      def list_uncached
+        list_options = {}
+        list_options[::EacCli::Speaker::List::OPTION_IGNORE_CASE] = ignore_case unless
+          ignore_case.nil?
+        ::EacCli::Speaker::List.build(list_values, list_options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+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, ignore_case =
+        options.to_options_consumer.consume_all(:bool, :list, :noecho, :ignore_case)
+      if list
+        request_from_list(question, list, noecho, ignore_case)
+      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
+
+      [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, true)
+    end
+
+    def request_string(question, noecho)
+      err_out.write "#{question}: ".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.44.1'
+end

data/sub/eac_cli/lib/eac_cli.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils'
+EacRubyUtils::RootModuleSetup.perform __FILE__ do
+  ignore 'core_ext'
+  ignore 'patches'
+end
+
+module EacCli
+end
+
+require 'eac_config'
+require 'colorize'
+require 'eac_cli/core_ext'

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

data/sub/eac_cli/spec/lib/eac_cli/parser/alternative/subcommands_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'eac_cli/definition/alternative'
+require 'eac_cli/parser/alternative'
+
+RSpec.describe EacCli::Parser::Alternative, '#subcommands' do
+  let(:instance) { described_class.new(alternative, argv) }
+  let(:actual_parsed) { instance.parsed.to_h.symbolize_keys }
+  let(:alternative) do
+    r = EacCli::Definition::Alternative.new
+    r.bool_opt '-b', '--opt1', 'A boolean option'
+    r.arg_opt '-a', '--opt2', 'A argument option'
+    r.subcommands
+    r
+  end
+
+  context 'with all values' do
+    let(:argv) { %w[--opt1 --opt2 OPT2 CMD CMD_ARG_1 --CMD_ARG_2] }
+    let(:parsed_expected) do
+      {
+        opt1: true, opt2: 'OPT2',
+        EacCli::Definition::Alternative::SUBCOMMAND_NAME_ARG => 'CMD',
+        EacCli::Definition::Alternative::SUBCOMMAND_ARGS_ARG => %w[CMD_ARG_1 --CMD_ARG_2]
+      }
+    end
+
+    it { expect(instance.error).to be_blank }
+    it { expect(actual_parsed).to eq(parsed_expected) }
+  end
+
+  context 'with only required values' do
+    let(:argv) { %w[CMD] }
+    let(:parsed_expected) do
+      {
+        opt1: false, opt2: nil,
+        EacCli::Definition::Alternative::SUBCOMMAND_NAME_ARG => 'CMD',
+        EacCli::Definition::Alternative::SUBCOMMAND_ARGS_ARG => []
+      }
+    end
+
+    it { expect(instance.error).to be_blank }
+    it { expect(actual_parsed).to eq(parsed_expected) }
+  end
+
+  context 'without required values' do
+    let(:argv) { %w[--opt1] }
+    let(:parsed_expected) do
+      {
+        opt1: true, opt2: nil,
+        EacCli::Definition::Alternative::SUBCOMMAND_NAME_ARG => nil,
+        EacCli::Definition::Alternative::SUBCOMMAND_ARGS_ARG => []
+      }
+    end
+
+    it { expect(instance.error).to be_present }
+    it { expect(actual_parsed).to eq(parsed_expected) }
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'eac_cli/definition/alternative'
+require 'eac_cli/parser/alternative'
+
+RSpec.describe EacCli::Parser::Alternative do
+  let(:instance) { described_class.new(alternative, argv) }
+  let(:actual_parsed) { instance.parsed.to_h.symbolize_keys }
+
+  context 'without subcommands' do
+    let(:alternative) do
+      r = EacCli::Definition::Alternative.new
+      r.bool_opt '-b', '--opt1', 'A boolean option'
+      r.arg_opt '-a', '--opt2', 'A argument option'
+      r.bool_opt '-c', '--opt3', 'A required boolean option', required: true
+      r.pos_arg :pos1
+      r.pos_arg :pos2, optional: true, repeat: true
+      r
+    end
+
+    context 'with all values' do
+      let(:argv) { %w[--opt1 --opt2 OPT2 --opt3 POS1 POS2_1 POS2_2] }
+      let(:parsed_expected) do
+        {
+          opt1: true, opt2: 'OPT2', opt3: true, pos1: 'POS1', pos2: %w[POS2_1 POS2_2]
+        }
+      end
+
+      it { expect(instance.error).to be_blank }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'with only required values' do
+      let(:argv) { %w[--opt3 POS1] }
+      let(:parsed_expected) { { opt1: false, opt2: nil, opt3: true, pos1: 'POS1', pos2: [] } }
+
+      it { expect(instance.error).to be_blank }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'with double dash' do
+      let(:argv) { %w[--opt3 POS1 -- --opt1 --] }
+      let(:parsed_expected) do
+        { opt1: false, opt2: nil, opt3: true, pos1: 'POS1', pos2: %w[--opt1 --] }
+      end
+
+      it { expect(instance.error).to be_blank }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'without required positional' do
+      let(:argv) { %w[--opt1 --opt3] }
+      let(:parsed_expected) { { opt1: true, opt2: nil, opt3: true, pos1: nil, pos2: [] } }
+
+      it { expect(instance.error).to be_present }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'without required option' do
+      let(:argv) { %w[--opt1 POS1] }
+      let(:parsed_expected) { { opt1: true, opt2: nil, opt3: false, pos1: 'POS1', pos2: [] } }
+
+      it { expect(instance.error).to be_present }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'without any required option or positional' do
+      let(:argv) { %w[] }
+      let(:parsed_expected) { { opt1: false, opt2: nil, opt3: false, pos1: nil, pos2: [] } }
+
+      it { expect(instance.error).to be_present }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+
+    context 'with excedent positional' do
+      let(:alternative) do
+        r = EacCli::Definition::Alternative.new
+        r.pos_arg :pos1
+        r
+      end
+
+      let(:argv) { %w[POS1 POS2] }
+      let(:parsed_expected) { { pos1: 'POS1' } }
+
+      it { expect(instance.error).to be_present }
+      it { expect(actual_parsed).to eq(parsed_expected) }
+    end
+  end
+end

data/sub/eac_cli/spec/lib/eac_cli/runner/for_context_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'eac_cli/runner'
+
+RSpec.describe EacCli::Runner, '#for_context' do
+  let(:parent_runner_class) do
+    example = self
+    Class.new do
+      include example.described_class
+
+      def self.name
+        'ParentRunnerClass'
+      end
+
+      for_context :method_for_context
+
+      def run; end
+
+      def method_for_context; end
+
+      def method_not_for_context; end
+    end
+  end
+
+  let(:child_runner_class1) do # rubocop:disable RSpec/IndexedLet
+    example = self
+    Class.new do
+      include example.described_class
+
+      def self.name
+        'ChildRunnerClass1'
+      end
+
+      def run
+        method_for_context
+        runner_context.call(:method_for_context)
+        runner_context.call(:method_not_for_context)
+      end
+    end
+  end
+
+  let(:child_runner_class2) do # rubocop:disable RSpec/IndexedLet
+    example = self
+    Class.new do
+      include example.described_class
+
+      def self.name
+        'ChildRunnerClass2'
+      end
+
+      def run
+        method_not_for_context
+      end
+    end
+  end
+
+  let(:parent_runner) { parent_runner_class.create }
+  let(:context_args) { [{ argv: [], parent: parent_runner }] }
+  let(:child_runner) { child_runner_class.create(*context_args) }
+
+  it { expect(parent_runner.for_context?(:method_for_context)).to be(true) }
+  it { expect(parent_runner.for_context?(:method_not_for_context)).to be(false) }
+
+  context 'when method is for context' do
+    let(:child_runner_class) { child_runner_class1 }
+
+    it do
+      expect { child_runner.run }.not_to raise_error
+    end
+  end
+
+  context 'when method is not for context' do
+    let(:child_runner_class) { child_runner_class2 }
+
+    it do
+      expect { child_runner.run }.to raise_error(NameError)
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'eac_cli/runner'
+
+RSpec.describe EacCli::Runner do
+  let(:runner_class) do
+    the_module = described_class
+    Class.new do
+      include the_module
+
+      runner_definition do
+        arg_opt '-o', '--opt1', 'A arg option.'
+        bool_opt '-p', '--opt2', 'A boolean option'
+        arg_opt '-q', '--opt4', 'A repeatable argument option.', repeat: true
+        bool_opt '-r', '--opt5', 'A repeatable boolean option', repeat: true
+        arg_opt '-s', '--opt6', 'A argument option with default value', default: 'DEFAULT'
+        pos_arg :pos1
+        pos_arg :pos2, repeat: true, optional: true
+        alt do
+          bool_opt '-a', '--opt3', 'A boolean option in a alternative.', required: true
+        end
+      end
+
+      def run; end
+    end
+  end
+
+  let(:instance) { runner_class.create(argv) }
+  let(:parsed_actual) { instance.parsed.to_h.symbolize_keys }
+
+  context 'when all args are supplied' do
+    let(:argv) { %w[--opt1 aaa --opt2 bbb ccc ddd --opt6 6] }
+    let(:parsed_expected) do
+      { opt1: 'aaa', opt2: true, opt3: false, opt4: [], opt5: 0, opt6: '6', pos1: 'bbb',
+        pos2: %w[ccc ddd] }
+    end
+
+    it { expect(parsed_actual).to eq(parsed_expected) }
+    it { expect(instance.parsed.opt1).to eq('aaa') }
+    it { expect(instance.parsed.opt2?).to be(true) }
+    it { expect(instance.parsed.pos1).to eq('bbb') }
+    it { expect(instance.parsed.pos2).to eq(%w[ccc ddd]) }
+  end
+
+  context 'with long option and argument in same position' do
+    let(:argv) { %w[--opt1=aaa pos1] }
+
+    it { expect(instance.parsed.opt1).to eq('aaa') }
+  end
+
+  context 'with valid grouped short options' do
+    let(:argv) { %w[-po aaa pos1] }
+
+    it { expect(instance.parsed.opt1).to eq('aaa') }
+    it { expect(instance.parsed.opt2?).to be(true) }
+  end
+
+  context 'with invalid grouped short options' do
+    let(:argv) { %w[-op aaa pos1] }
+
+    it do
+      expect { instance.parsed }.to raise_error(EacCli::Parser::Error)
+    end
+  end
+
+  context 'when only required args are supplied' do
+    let(:argv) { %w[bbb] }
+    let(:parsed_expected) do
+      { opt1: nil, opt2: false, opt3: false, opt4: [], opt5: 0, opt6: 'DEFAULT', pos1: 'bbb',
+        pos2: [] }
+    end
+
+    it { expect(parsed_actual).to eq(parsed_expected) }
+    it { expect(instance.parsed.opt1).to be_nil }
+    it { expect(instance.parsed.opt2?).to be(false) }
+    it { expect(instance.parsed.pos1).to eq('bbb') }
+    it { expect(instance.parsed.pos2).to eq([]) }
+  end
+
+  context 'when required args are not supplied' do
+    let(:argv) { %w[] }
+
+    it do
+      expect { instance.parsed }.to raise_error(EacCli::Parser::Error)
+    end
+  end
+
+  context 'when alternative args are supplied' do
+    let(:argv) { %w[--opt3] }
+    let(:parsed_expected) do
+      { opt1: nil, opt2: false, opt3: true, opt4: [], opt5: 0, opt6: 'DEFAULT', pos1: nil,
+        pos2: [] }
+    end
+
+    it { expect(parsed_actual).to eq(parsed_expected) }
+    it { expect(instance.parsed.opt3?).to be(true) }
+  end
+
+  context 'when repeated options are supplied' do
+    let(:argv) { %w[--opt5 -rrr --opt4=A -q B --opt4 C AAA] }
+    let(:parsed_expected) do
+      { opt1: nil, opt2: false, opt3: false, opt4: %w[A B C], opt5: 4, opt6: 'DEFAULT', pos1: 'AAA',
+        pos2: [] }
+    end
+
+    it { expect(parsed_actual).to eq(parsed_expected) }
+  end
+
+  context 'when extra args are not supplied' do
+    let(:runner_class) do
+      the_module = described_class
+      Class.new do
+        include the_module
+
+        runner_definition do
+          pos_arg :pos1
+        end
+
+        def run; end
+      end
+    end
+
+    let(:argv) { %w[aaa bbb] }
+
+    it do
+      expect { instance.parsed }.to raise_error(EacCli::Parser::Error)
+    end
+  end
+end