eac_tools 0.121.0 → 0.123.0

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+RSpec.describe EacCli::RunnerWith::Subcommands do
+  let(:parent_runner) do
+    the_module = described_class
+    the_child = child_runner
+    Class.new do
+      include the_module
+
+      const_set('ChildCmd', the_child)
+
+      runner_definition do
+        desc 'A stub root runner.'
+        arg_opt '-r', '--root-var', 'A root variable.'
+        subcommands
+      end
+
+      delegate :root_var, to: :parsed
+      for_context :method_in_parent_runner
+
+      def method_in_parent_runner; end
+    end
+  end
+
+  let(:child_runner) do
+    Class.new do
+      include EacCli::Runner
+
+      runner_definition do
+        bool_opt '-c', '--child-opt', 'A boolean option.'
+        pos_arg :child_var
+      end
+
+      def run
+        runner_context.call(:method_in_parent_runner)
+        method_in_parent_runner
+      end
+    end
+  end
+
+  let(:instance) { parent_runner.create(argv: parent_argv) }
+
+  context 'when subcommand is supplied' do
+    let(:parent_argv) { %w[--root-var 123 child-cmd --child-opt 456] }
+
+    it { expect(instance.parsed.root_var).to eq('123') }
+    it { expect(instance.parsed.subcommand).to eq('child-cmd') }
+    it { expect(instance.parsed.subcommand_args).to eq(%w[--child-opt 456]) }
+    it { expect(instance.subcommand_runner.parsed.child_opt).to be(true) }
+    it { expect(instance.subcommand_runner.parsed.child_var).to eq('456') }
+
+    it do
+      expect { instance.run_run }.not_to raise_error
+    end
+  end
+
+  context 'when subcommand is not supplied' do
+    let(:instance) { parent_runner.create(%w[456]) }
+
+    it do
+      expect { instance.run }.to raise_error(EacCli::Parser::Error)
+    end
+  end
+
+  context 'with help' do
+    let(:instance) { parent_runner.create(%w[--help]) }
+    let(:expected_output_source) do
+      <<~OUTPUT
+        A stub root runner.
+
+        Usage:
+          __PROGRAM__ [options] __SUBCOMMANDS__ [<subcommand_args>...]
+          __PROGRAM__ --help
+
+        Options:
+          -r --root-var=<value>    A root variable.
+          -h --help    Show help.
+
+        Subcommands:
+          child-cmd
+      OUTPUT
+    end
+    let(:expected_output) do
+      expected_output_source.gsub('__PROGRAM__', instance.program_name)
+    end
+
+    before do
+      parent_runner.include(EacCli::RunnerWith::Help)
+    end
+
+    it 'show help text' do
+      expect { instance.run_run }.to output(expected_output).to_stdout_from_any_process
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+RSpec.describe EacCli::Speaker do
+  let(:instance) { described_class.new }
+
+  before do
+    allow(instance).to receive(:warn) { |message| raise(message.to_s) }
+  end
+
+  describe '#input' do
+    it 'recover value from hash list' do
+      allow(instance).to receive(:request_string).and_return('opt1')
+      list = { opt1: 'value1', opt2: 'value2' }
+      expect(instance.input('Question', list: list)).to eq('value1')
+    end
+
+    it 'recover value from array list' do
+      allow(instance).to receive(:request_string).and_return('OPT1')
+      list = %w[opt1 opt2]
+      expect(instance.input('Question', list: list)).to eq('opt1')
+    end
+
+    {
+      'yes' => true, 'y' => true, 'Y' => true, 'NO' => false, 'no' => false, 'n' => false
+    }.each do |input, expected|
+      context "when bool: true and input is \"#{input}\"" do
+        it "return #{expected}" do
+          allow(instance).to receive(:request_string).and_return(input)
+          expect(instance.input('Question', bool: true)).to eq(expected)
+        end
+      end
+    end
+  end
+end

data/sub/{avm → eac_cli}/spec/spec_helper.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'avm'
-require 'avm/eac_ruby_base1'
-require 'avm/git'
+require 'eac_cli'
 require 'eac_ruby_gem_support'
-EacRubyUtils::Rspec.default_setup_create(File.expand_path('..', __dir__)).stub_avm_contexts
+EacRubyUtils::Rspec.default_setup_create(File.expand_path('..', __dir__))

data/sub/{eac_ruby_utils → eac_config}/.gitignore

@@ -1,4 +1,2 @@
 Gemfile.local
 Gemfile.lock
-doc/
-.yardoc/

data/sub/eac_config/.gitrepo

@@ -0,0 +1,7 @@
+[subrepo]
+  cmdver = 0.4.9
+  commit = c459f9820d8555537f380f730cfa96a7c2817a46
+  method = merge
+  parent = 952fb6776fee0fecc37ba884e23864a99bfe2951
+  branch = master
+  remote = https://github.com/esquilo-azul/eac_config.git

data/sub/eac_config/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/sub/eac_config/eac_config.gemspec

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'eac_config/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'eac_config'
+  s.version     = EacConfig::VERSION
+  s.authors     = ['Put here the authors']
+  s.summary     = 'Put here de description.'
+
+  s.files = Dir['{lib}/**/*']
+  s.required_ruby_version = '>= 3.2' # rubocop:disable Gemspec/RequiredRubyVersion
+
+  s.add_dependency 'addressable', '~> 2.9'
+  s.add_dependency 'eac_ruby_base1', '~> 0.1', '>= 0.1.1'
+
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.15'
+end

data/sub/eac_config/lib/eac_config/entries.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class Entries
+    enable_memoized
+    common_constructor :root_node, :path do
+      self.path = ::EacConfig::EntryPath.assert(path)
+    end
+
+    def to_s
+      "#{self.class}[RootNode: #{root_node}, Path: #{path}]"
+    end
+
+    # @return [Array<EacConfig::Entries>]
+    memoize def node_entries
+      node_entries_from_root + node_entries_from_load_path
+    end
+
+    # @return [Array<EacConfig::Entries>]
+    memoize def node_entries_from_load_path
+      root_node.recursive_loaded_nodes.flat_map { |loaded_node| loaded_node.self_entries(path) }
+    end
+
+    # @return [Array<EacConfig::Entries>]
+    memoize def node_entries_from_root
+      root_node.self_entries(path)
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/entry/not_found_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class Entry
+    class NotFoundError < ::RuntimeError
+      def initialize(entry)
+        super("Entry #{entry} not found")
+      end
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/entry.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class Entry
+    enable_memoized
+    common_constructor :root_node, :path do
+      self.path = ::EacConfig::EntryPath.assert(path)
+    end
+
+    def found?
+      node_entry.if_present(false, &:found?)
+    end
+
+    def found_node
+      node_entry.if_present(&:node)
+    end
+
+    def secret_value
+      node_entry.if_present(&:secret_value)
+    end
+
+    def to_s
+      "#{self.class}[RootNode: #{root_node}, Path: #{path}]"
+    end
+
+    def value
+      node_entry.if_present(&:value)
+    end
+
+    def value!
+      return value if found?
+
+      raise ::EacConfig::Entry::NotFoundError, self
+    end
+
+    def value=(a_value)
+      write_node.self_entry(path).value = a_value
+    end
+
+    def write_node
+      root_node.write_node || root_node
+    end
+
+    private
+
+    memoize def node_entry
+      node_entry_from_root || node_entry_from_load_path
+    end
+
+    memoize def node_entry_from_load_path
+      root_node.recursive_loaded_nodes.lazy.map { |loaded_node| loaded_node.self_entry(path) }
+        .find(&:found?)
+    end
+
+    memoize def node_entry_from_root
+      e = root_node.self_entry(path)
+      e.found? ? e : nil
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/entry_path.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class EntryPath
+    PART_SEPARATOR = '.'
+
+    class << self
+      def assert(source)
+        source.is_a?(self) ? source : new(build_parts(source))
+      end
+
+      def build_parts(source)
+        return validate_parts!(source.split(PART_SEPARATOR)) if source.is_a?(::String)
+        return validate_parts!(source.flat_map { |part| build_parts(part) }) if
+        source.is_a?(::Enumerable)
+
+        build_parts(source.to_s)
+      end
+
+      def validate_parts!(parts)
+        parts.assert_argument(::Enumerable, 'parts')
+        parts.each_with_index do |part, index|
+          raise ::ArgumentError, "Part #{index} of #{parts} is blank" if part.blank?
+          raise ::ArgumentError, "Part #{index} is not a string" unless part.is_a?(::String)
+        end
+      end
+    end
+
+    common_constructor :parts, default: [[]] do
+      self.parts = ::Array.new(parts).freeze
+    end
+
+    compare_by :parts
+    delegate :any?, :count, :each, :each_value, :each_with_index, :empty?, :fetch, :first, :index,
+             :inject, :last, :map, :size, to: :parts
+
+    # @return [EacConfig::EntryPath]
+    def +(other)
+      self.class.new(parts + self.class.assert(other).parts)
+    end
+
+    def [](*)
+      slice(*)
+    end
+
+    def slice(*)
+      r = parts.slice(*)
+      r.is_a?(::Enumerable) ? self.class.new(r) : r
+    end
+
+    def to_s
+      "#{self.class}[#{to_string}]"
+    end
+
+    # @return [String]
+    def to_string
+      parts.join(PART_SEPARATOR)
+    end
+
+    # @param part [String]
+    # @return [EacConfig::EntryPath]
+    def with_first(part)
+      new_parts = parts.dup
+      new_parts.unshift(part)
+      self.class.new(new_parts)
+    end
+
+    # @return [EacConfig::EntryPath]
+    def without_first
+      new_parts = parts.dup
+      new_parts.shift
+      self.class.new(new_parts)
+    end
+
+    # @return [EacConfig::EntryPath]
+    def with_last(part)
+      self.class.new(parts + [part])
+    end
+
+    # @return [EacConfig::EntryPath]
+    def without_last
+      new_parts = parts.dup
+      new_parts.pop
+      self.class.new(new_parts)
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/envvars_node/entry.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class EnvvarsNode
+    class Entry < ::EacConfig::NodeEntry
+      class << self
+        def entry_path_to_envvar_name(path)
+          ::EacConfig::EntryPath.assert(path).parts.join('_').gsub(/[^a-z0-9_]/i, '')
+            .gsub(/\A_+/, '').gsub(/_+\z/, '').gsub(/_{2,}/, '_').upcase
+        end
+
+        def from_value(string)
+          return nil if string.nil?
+          return ::EacRubyUtils::Yaml.load(string) if string.start_with?('---')
+
+          string
+        end
+
+        def to_value(object)
+          return nil if object.nil?
+          return object if object.is_a?(String)
+
+          ::EacRubyUtils::Yaml.dump(object)
+        end
+      end
+
+      enable_memoized
+
+      def found?
+        ENV.key?(envvar_name)
+      end
+
+      def value
+        self.class.from_value(ENV.fetch(envvar_name, nil))
+      end
+
+      def value=(a_value)
+        ENV[envvar_name] = self.class.to_value(a_value)
+      end
+
+      private
+
+      memoize def envvar_name
+        self.class.entry_path_to_envvar_name(path)
+      end
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/envvars_node.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'addressable'
+
+module EacConfig
+  # A node that read/write entries from environment variables.
+  class EnvvarsNode
+    include ::EacConfig::Node
+
+    URI = ::Addressable::URI.parse('self://envvars')
+
+    class << self
+      def from_uri(uri)
+        new if uri == URI
+      end
+    end
+
+    # @param path [EacConfig::EntryPath]
+    # @return [Array<EacConfig::Entries>]
+    def self_entries(_path)
+      []
+    end
+
+    def url
+      URI
+    end
+
+    def to_s
+      "#{self.class}[ObjectId: #{object_id}]}"
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/load_nodes_search.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class LoadNodesSearch
+    common_constructor :root_node do
+      add_next_pending until pending.empty?
+    end
+
+    def result
+      added
+    end
+
+    private
+
+    def added
+      @added ||= []
+    end
+
+    def add_next_pending
+      current = pending.pop
+      current.self_loaded_nodes.each do |loaded_node|
+        next if added.include?(loaded_node)
+
+        added << loaded_node
+        pending.push(loaded_node)
+      end
+    end
+
+    def pending
+      @pending ||= begin
+        r = Queue.new
+        r.push(root_node)
+        r
+      end
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/load_path.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class LoadPath
+    ENTRY_PATH = ::EacConfig::EntryPath.assert(%w[load_path])
+
+    common_constructor :node
+
+    def entry
+      node.self_entry(ENTRY_PATH)
+    end
+
+    # @return [Array<String>]
+    def paths
+      r = entry.value
+      r.is_a?(::Array) ? r : []
+    end
+
+    def push(new_path)
+      entry.value = paths + [new_path]
+    end
+
+    delegate :to_s, to: :paths
+  end
+end

data/sub/eac_config/lib/eac_config/node.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module EacConfig
+  module Node
+    include ::Memoized
+
+    class << self
+      def context
+        @context ||= ::EacRubyUtils::Context.new
+      end
+    end
+
+    attr_accessor :write_node
+
+    common_concern do
+      acts_as_abstract :self_entries
+      include ::Comparable
+    end
+
+    # @return [Array<EacConfig::Entries>]
+    def entries(path)
+      ::EacConfig::Entries.new(self, path)
+    end
+
+    def entry(path)
+      ::EacConfig::Entry.new(self, path)
+    end
+
+    # @return [[EacConfig::IncludePath]]
+    def load_path
+      @load_path ||= ::EacConfig::LoadPath.new(self)
+    end
+
+    # @return [Addressable::URI]
+    def url
+      raise_abstract_method(__method__)
+    end
+
+    # Return a entry which search values only in the self node.
+    # @return [EacConfig::NodeEntry]
+    def self_entry(path)
+      self_entry_class.new(self, path)
+    end
+
+    def self_entry_class
+      self.class.const_get('Entry')
+    end
+
+    # @return [Array<EacConfig::Node>]
+    def self_loaded_nodes
+      load_path.paths.flat_map { |node_path| load_nodes(node_path) }
+    end
+
+    # @return [Array<EacConfig::Node>]
+    memoize def recursive_loaded_nodes
+      ::EacConfig::LoadNodesSearch.new(self).result
+    end
+
+    # @return [EacConfig::PrefixedPathNode]
+    def with_prefix(path_prefix)
+      ::EacConfig::PrefixedPathNode.new(self, path_prefix)
+    end
+
+    private
+
+    # @param node_path [String]
+    # @return [Array<EacConfig::Node>]
+    def load_nodes(node_path)
+      ::EacConfig::NodeUri.new(node_path, url).instanciate
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/node_entry.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module EacConfig
+  # A entry which search values only in the source node.
+  class NodeEntry
+    enable_abstract_methods
+    enable_memoized
+    common_constructor :node, :path do
+      self.path = ::EacConfig::EntryPath.assert(path)
+    end
+    compare_by :node, :path
+
+    abstract_methods :found?, :value, :value=
+
+    def secret_value
+      value
+    end
+
+    # @return [String]
+    def to_s
+      "#{self.class}[Node: #{node}, Path: #{path}]"
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/node_uri/instanciate_single.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class NodeUri
+    class InstanciateSingle
+      acts_as_instance_method
+      enable_memoized
+      common_constructor :node_uri, :instance_uri
+
+      # @return [Array<Class>]
+      def available_node_classes
+        [::EacConfig::EnvvarsNode, ::EacConfig::YamlFileNode]
+      end
+
+      # @return [EacConfig::Node]
+      def result
+        available_node_classes.lazy.map { |k| k.from_uri(self) }.find(&:present?) ||
+          raise("No class mapped for \"#{to_addressable}\"")
+      end
+
+      # @return [Addressable::URI]
+      def to_addressable
+        instance_uri.to_uri
+      end
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/node_uri.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class NodeUri
+    enable_memoized
+    common_constructor :source, :loader_uri, default: [nil]
+
+    # @return [Array<EacConfig::Node>]
+    def instanciate
+      instance_uris.map { |uri| instanciate_single(uri) }
+    end
+
+    delegate :to_s, to: :to_addressable
+
+    private
+
+    # @return [Array<Addressable::URI>]
+    def instance_uris
+      if to_addressable.scheme == 'file'
+        ::Pathname.glob(to_addressable.path).map do |found_path|
+          ::Addressable::URI.new(scheme: 'file', path: found_path.to_path)
+        end
+      else
+        [to_addressable]
+      end
+    end
+
+    memoize def to_addressable
+      r = ::Addressable::URI.parse(source)
+      path = r.path.to_pathname
+      r.path = path.expand_path(loader_uri_path_directory).to_path if path.relative?
+      r.scheme = 'file' if r.scheme.blank?
+      r
+    end
+
+    def loader_uri_path_directory
+      r = loader_uri.path
+      raise ".loader_uri \"#{loader_uri}\" has no path (Source: \"#{source}\")" if r.blank?
+
+      r.to_pathname.parent
+    end
+
+    require_sub __FILE__, require_mode: :kernel
+  end
+end