eac_tools 0.122.0 → 0.123.0

data/sub/eac_config/lib/eac_config/paths_hash.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class PathsHash
+    class << self
+      def parse_entry_key(entry_key) # rubocop:disable Metrics/CyclomaticComplexity
+        r = entry_key.to_s.strip
+        raise ::EacConfig::PathsHash::EntryKeyError, 'Entry key cannot start or end with dot' if
+        r.start_with?('.') || r.end_with?('.')
+
+        r = r.split('.').map(&:strip)
+        if r.empty?
+          raise ::EacConfig::PathsHash::EntryKeyError, "Entry key \"#{entry_key}\" is empty"
+        end
+        return r.map(&:to_sym) unless r.any?(&:blank?)
+
+        raise ::EacConfig::PathsHash::EntryKeyError,
+              "Entry key \"#{entry_key}\" has at least one blank part"
+      end
+    end
+
+    attr_reader :root
+
+    def initialize(source_hash = {})
+      @root = Node.new(source_hash)
+    end
+
+    def [](entry_key)
+      root.read_entry(::EacConfig::PathsHash::PathSearch.parse_entry_key(entry_key))
+    end
+
+    def []=(entry_key, entry_value)
+      root.write_entry(
+        ::EacConfig::PathsHash::PathSearch.parse_entry_key(entry_key), entry_value
+      )
+    end
+
+    def fetch(entry_key)
+      root.fetch(::EacConfig::PathsHash::PathSearch.parse_entry_key(entry_key))
+    end
+
+    def key?(entry_key)
+      root.entry?(::EacConfig::PathsHash::PathSearch.parse_entry_key(entry_key))
+    end
+
+    delegate :to_h, to: :root
+
+    # @return [EacConfig::PathsHash
+    def write(entry_key, entry_value)
+      self[entry_key] = entry_value
+
+      self
+    end
+
+    private
+
+    attr_reader :data
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class PrefixedPathNode
+    class Entry < ::EacConfig::NodeEntry
+      enable_memoized
+      delegate :found?, :found_node, :secret_value, :value, :value=, :writ_node, to: :full_entry
+
+      # @return [EacConfig::EntryPath]
+      def full_path
+        node.path_prefix + path
+      end
+
+      private
+
+      # @return [EacConfig::NodeEntry]
+      memoize def full_entry
+        node.from_node.entry(full_path)
+      end
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/prefixed_path_node.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class PrefixedPathNode
+    include ::EacConfig::Node
+
+    common_constructor :from_node, :path_prefix do
+      self.path_prefix = ::EacConfig::EntryPath.assert(path_prefix)
+    end
+
+    def entry(path)
+      ::EacConfig::Entry.new(self, path)
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/rspec/setup.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module EacConfig
+  module Rspec
+    module Setup
+      def self.extended(obj)
+        obj.rspec_config.around do |example|
+          obj.on_envvars_load_path_clean(example)
+        end
+      end
+
+      def on_envvars_load_path_clean(example)
+        old_value = envvars_load_path_entry.value
+        begin
+          envvars_load_path_entry.value = old_value = []
+          example.run
+        ensure
+          envvars_load_path_entry.value = old_value
+        end
+      end
+
+      def envvars_load_path_entry
+        ::EacConfig::EnvvarsNode.new.load_path.entry
+      end
+
+      # Wraps a RSpec example in a EacConfig node using a alternative file.
+      #
+      # @param target_example [RSpec::Core::ExampleGroup] The example to wrap. If not provided,
+      #   it is applied to all examples.
+      # @param target_file [Pathname] The file used by the EacConfig node. If not provided, a
+      #   temporary file is used.
+      # @param node_builder [Proc] Should return the desired EacConfig node. If not provided, a
+      #   EacConfig::YamlFileNode is created.
+      def stub_eac_config_node(target_example = nil, target_file = nil, &)
+        parent_self = self
+        (target_example || rspec_config).around do |example|
+          parent_self.stub_eac_config_node_on_file(target_file) do |file|
+            ::EacConfig::Node
+              .context.on(parent_self.stub_eac_config_node_build(file, &)) do
+              example.run
+            end
+          end
+        end
+      end
+
+      def stub_eac_config_node_build(file, &node_builder)
+        node_builder.present? ? node_builder.call(file) : ::EacConfig::YamlFileNode.new(file)
+      end
+
+      def stub_eac_config_node_on_file(target_file, &)
+        if target_file
+          yield(target_file.to_pathname)
+        else
+          ::EacRubyUtils::Fs::Temp.on_file(&)
+        end
+      end
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/rspec.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module EacConfig
+  module Rspec
+  end
+end

data/sub/eac_config/lib/eac_config/version.rb

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

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class YamlFileNode
+    class Entry < ::EacConfig::NodeEntry
+      enable_memoized
+
+      def found?
+        paths_hash.key?(to_paths_hash_key)
+      end
+
+      def value
+        paths_hash[to_paths_hash_key]
+      end
+
+      def value=(a_value)
+        node.persist_data(paths_hash.write(to_paths_hash_key, a_value).root.to_h)
+      end
+
+      private
+
+      # @return [EacConfig::PathsHash]
+      def paths_hash
+        ::EacConfig::PathsHash.new(node.data)
+      end
+
+      def to_paths_hash_key
+        path.parts.join('.')
+      end
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/yaml_file_node/self_entries.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class YamlFileNode
+    class SelfEntries
+      acts_as_instance_method
+      common_constructor :node, :path do
+        self.path = ::EacConfig::EntryPath.assert(path)
+      end
+
+      # @return [Array<EacConfig::YamlFileNode>]
+      def result
+        head_node.result.map { |found_path| ::EacConfig::YamlFileNode::Entry.new(node, found_path) }
+      end
+
+      private
+
+      # @return [DataNode]
+      def head_node
+        DataNode.new(node.data, ::EacConfig::EntryPath.new, path)
+      end
+
+      class DataNode
+        common_constructor :data_node, :path_from, :path_to do
+          self.data_node = data_node.stringify_keys if data_node.is_a?(::Hash)
+        end
+
+        # @return [DataNode]
+        def child(child_key)
+          self.class.new(data_node.fetch(child_key), path_from.with_last(child_key),
+                         path_to.without_first)
+        end
+
+        def children
+          return [] unless data_node.is_a?(::Hash)
+
+          data_node.keys.select { |k| key_matcher.match?(k) }.map { |k| child(k) } # rubocop:disable Style/SelectByRegexp
+        end
+
+        # @return [Symbol]
+        def key
+          path_to.first
+        end
+
+        # @return [EacRubyUtils::Wildcards]
+        def key_matcher
+          @key_matcher ||= ::EacRubyUtils::Wildcards.new(key)
+        end
+
+        # @return [Array<EacConfig::EntryPath>]
+        def result
+          (path_to.empty? ? result_from_self : result_from_children)
+        end
+
+        # @return [Array<EacConfig::EntryPath>]
+        def result_from_self
+          [path_from]
+        end
+
+        # @return [Array<EacConfig::EntryPath>]
+        def result_from_children
+          children.flat_map(&:result)
+        end
+      end
+    end
+  end
+end

data/sub/eac_config/lib/eac_config/yaml_file_node.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'addressable'
+
+module EacConfig
+  class YamlFileNode
+    include ::EacConfig::Node
+
+    enable_memoized
+
+    class << self
+      def from_uri(uri)
+        new(uri.to_addressable.path) if uri.to_addressable.scheme == 'file'
+      end
+    end
+
+    common_constructor :path do
+      self.path = path.to_pathname
+    end
+    compare_by :path
+
+    memoize def data
+      r = nil
+      if path.file?
+        r = ::EacRubyUtils::Yaml.load_file(path)
+      elsif path.exist?
+        raise("\"#{path}\" is a not a file")
+      end
+
+      r.is_a?(::Hash) ? r : {}
+    end
+
+    def persist_data(new_data)
+      path.parent.mkpath
+      ::EacRubyUtils::Yaml.dump_file(path, new_data)
+      unmemoize(:data)
+    end
+
+    def url
+      ::Addressable::URI.parse("file://#{path.expand_path}")
+    end
+
+    def to_s
+      "#{self.class}[#{path}]"
+    end
+
+    require_sub __FILE__, require_mode: :kernel
+  end
+end

data/sub/eac_config/lib/eac_config.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_base1'
+EacRubyBase1::RootModuleSetup.perform __FILE__

data/sub/eac_config/spec/lib/eac_config/entry_path_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+RSpec.describe EacConfig::EntryPath do
+  describe '#assert' do
+    {
+      ['a.b.c'] => %w[a b c],
+      [['a', 1], 'b', []] => %w[a 1 b],
+      ['a', 'b', ['c', 1.2], 'd', 'e.f'] => %w[a b c 1 2 d e f]
+    }.each do |data|
+      source = data[0] # rubocop:disable RSpec/LeakyLocalVariable
+
+      context "when source is #{source}" do
+        let(:instance) { described_class.assert(source) }
+        let(:expected_parts) { data[1] }
+
+        it { expect(instance.parts).to eq(expected_parts) }
+      end
+    end
+
+    [['a..c'], ['a', ' ']].each do |source|
+      context "when invalid source is #{source}" do
+        it do
+          expect { described_class.assert(source) }.to raise_error(ArgumentError)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+RSpec.describe EacConfig::EnvvarsNode::Entry 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_path_to_envvar_name(input)).to eq(expected_result) }
+    end
+  end
+end

data/sub/eac_config/spec/lib/eac_config/envvars_node_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+RSpec.describe EacConfig::EnvvarsNode do
+  let(:instance) { described_class.new }
+
+  before do
+    ENV['COMMON'] = 'AAA'
+    ENV['BLANK'] = ''
+    ENV.delete('NO_EXIST')
+  end
+
+  context 'with common entry' do
+    let(:entry) { instance.entry('common') }
+
+    it { expect(entry).to be_a(EacConfig::Entry) }
+    it { expect(entry.value).to eq('AAA') }
+    it { expect(entry.found_node).to eq(instance) }
+    it { expect(entry).to be_found }
+
+    context 'with a clean ruby environment' do
+      let(:entry_value) do
+        EacRubyUtils::Ruby.on_clean_environment do
+          entry.value
+        end
+      end
+
+      it { expect(entry_value).to eq('AAA') }
+    end
+  end
+
+  context 'with blank entry' do
+    let(:entry) { instance.entry('blank') }
+
+    it { expect(entry).to be_a(EacConfig::Entry) }
+    it { expect(entry.value).to eq('') }
+    it { expect(entry.found_node).to eq(instance) }
+    it { expect(entry).to be_found }
+  end
+
+  context 'with not existing entry' do
+    let(:entry) { instance.entry('no.exist') }
+
+    it { expect(entry).to be_a(EacConfig::Entry) }
+    it { expect(entry.value).to be_nil }
+    it { expect(entry.found_node).to be_nil }
+    it { expect(entry).not_to be_found }
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+RSpec.describe EacConfig::OldConfigs do
+  let(:configs_key) { 'configsspec' }
+  let(:storage_path) do
+    file = Tempfile.new(configs_key)
+    path = file.path
+    file.close
+    file.unlink
+    path
+  end
+  let(:instance) { described_class.new(configs_key, storage_path: storage_path) }
+
+  describe '#storage_path' do
+    it { expect(instance.storage_path).to eq(storage_path) }
+  end
+
+  describe '#write' do
+    let(:entry_key) { 'parent.child' }
+
+    before do
+      instance[entry_key] = 'value1'
+      instance.save
+    end
+
+    it { expect(YAML.load_file(storage_path)).to eq(parent: { child: 'value1' }) }
+  end
+
+  describe '#read' do
+    let(:present_key) { 'a.present.key' }
+    let(:blank_key) { 'a.blank.key' }
+
+    before do
+      instance[present_key] = 'A value'
+      instance[blank_key] = ''
+      instance.save
+      instance.load
+    end
+
+    it { expect(instance[present_key]).to be_present }
+    it { expect(instance[blank_key]).to be_present }
+  end
+end

data/sub/eac_config/spec/lib/eac_config/paths_hash_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+RSpec.describe EacConfig::PathsHash do
+  let(:source_hash) do
+    {
+      parent: {
+        child1: {
+          child1_1: 'v1_1', # rubocop:disable Naming/VariableNumber
+          child1_2: 'v1_2' # rubocop:disable Naming/VariableNumber
+        },
+        child2: 'v2'
+      }
+    }
+  end
+  let(:instance) { described_class.new(source_hash) }
+
+  describe '#[]' do
+    {
+      'parent.child1.child1_1' => 'v1_1',
+      'parent.child1.child1_2' => 'v1_2',
+      'parent.child2' => 'v2',
+      'no_exist' => nil,
+      'parent.child1' => {
+        child1_1: 'v1_1', # rubocop:disable Naming/VariableNumber
+        child1_2: 'v1_2' # rubocop:disable Naming/VariableNumber
+      }
+    }.each do |entry_key, expected_value|
+      it { expect(instance[entry_key]).to eq(expected_value) }
+    end
+
+    ['.only_suffix', '', '.', 'only_prefx.', 'empty..part'].each do |entry_key|
+      it "invalid entry key \"#{entry_key}\" raises EntryKeyError" do
+        expect { instance[entry_key] }.to raise_error(EacConfig::PathsHash::EntryKeyError)
+      end
+    end
+  end
+
+  describe '#[]=' do
+    let(:source_hash) { {} }
+
+    before do
+      instance['a.b.c'] = '123'
+    end
+
+    it { expect(instance.to_h).to eq(a: { b: { c: '123' } }) }
+  end
+
+  describe '#key?' do
+    {
+      'parent.child1.child1_1' => true,
+      'parent.child1.child1_2' => true,
+      'parent.child1.child1_2.no_exist' => false,
+      'parent.child1.child1_3' => false,
+      'parent.child2' => true,
+      'no_exist' => false,
+      'parent.child1' => true
+    }.each do |entry_key, expected_value|
+      it { expect(instance.key?(entry_key)).to eq(expected_value) }
+    end
+  end
+end

data/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+RSpec.describe EacConfig::YamlFileNode do
+  storages = %w[1 1_1 1_2 1_2_1].map do |suffix|
+    key = "storage#{suffix}"
+    subpath = "#{key}.yaml"
+    subpath = "storage1_2/#{subpath}" if suffix == '1_2_1'
+    EacRubyUtils::Struct.new(suffix: suffix, key: key, subpath: subpath.to_pathname)
+  end
+
+  let(:fixtures_dir) { Pathname.new(__dir__).join('yaml_file_node_spec_files') }
+  let(:instance) { storage1 }
+
+  storages.each do |storage|
+    let(storage.key) { described_class.new(fixtures_dir.join(storage.subpath)) }
+  end
+
+  describe '#entry' do
+    context 'with common entry' do
+      let(:entry) { instance.entry('common') }
+
+      it { expect(entry.value).to eq('AAA') }
+      it { expect(entry.found_node).to eq(instance) }
+      it { expect(entry).to be_found }
+    end
+
+    storages.each do |storage|
+      context "with entry in loaded path \"#{storage.subpath}\"" do
+        let(:entry) { instance.entry(storage.key) }
+        let(:storage_node) { send(storage.key) }
+
+        it { expect(entry).to be_a(EacConfig::Entry) }
+        it { expect(entry).to be_found }
+        it { expect(entry.value).to eq(storage.key) }
+        it { expect(entry.found_node.url).to eq(storage_node.url) }
+      end
+    end
+
+    context 'with not existing entry' do
+      let(:entry) { instance.entry('no_exist') }
+
+      it { expect(entry).to be_a(EacConfig::Entry) }
+      it { expect(entry.value).to be_nil }
+      it { expect(entry.found_node).to be_nil }
+      it { expect(entry).not_to be_found }
+    end
+  end
+
+  describe '#entries' do
+    context 'when search path is "common"' do
+      let(:path) { 'common' }
+      let(:actual) { instance.entries(path).node_entries }
+      let(:expected) { [EacConfig::YamlFileNode::Entry.new(storage1, path)] }
+
+      it { expect(actual).to eq(expected) }
+    end
+
+    context 'when search path is "same.path"' do
+      let(:path) { 'same.path' }
+      let(:actual) { instance.entries(path).node_entries }
+      let(:expected) do
+        [storage1_1, storage1_2_1].map do |n|
+          EacConfig::YamlFileNode::Entry.new(n, 'same.path')
+        end
+      end
+
+      it { expect(actual).to eq(expected) }
+    end
+
+    context 'when search path is "*.search_me"' do
+      let(:path) { '*.search_me' }
+      let(:actual) { instance.entries(path).node_entries }
+      let(:expected) do
+        [
+          [storage1, 'storage1_a'], [storage1, 'storage1_b'],
+          [storage1_2, 'storage1_2_a'], [storage1_2, 'storage1_2_b'], [storage1_2, 'storage1_2_c']
+        ].map do |args|
+          EacConfig::YamlFileNode::Entry.new(args[0], "#{args[1]}.search_me")
+        end
+      end
+
+      it { expect(actual).to eq(expected) }
+    end
+  end
+end

data/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1.yaml

@@ -0,0 +1,10 @@
+---
+common: AAA
+load_path:
+  - storage1_1.yaml
+  - storage1_2.yaml
+storage1: storage1
+storage1_a:
+  search_me: 1_a
+storage1_b:
+  search_me: 1_b

data/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1_1.yaml

@@ -0,0 +1,4 @@
+---
+storage1_1: storage1_1
+same:
+  path: SAME_PATH_1_1

data/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1_2/storage1_2_1.yaml

@@ -0,0 +1,4 @@
+---
+storage1_2_1: storage1_2_1
+same:
+  path: SAME_PATH_1_2_1

data/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1_2.yaml

@@ -0,0 +1,10 @@
+---
+load_path:
+  - ./storage1_2/storage1_2_1.yaml
+storage1_2: storage1_2
+storage1_2_a:
+  search_me: 1_2_a
+storage1_2_b:
+  search_me: 1_2_a
+storage1_2_c:
+  search_me: 1_2_a

data/sub/eac_config/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'eac_config'
+require 'eac_ruby_gem_support'
+EacRubyUtils::Rspec.default_setup_create(File.expand_path('..', __dir__))

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

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

data/sub/eac_ruby_base0/.gitrepo

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

data/sub/eac_ruby_base0/.rspec

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

data/sub/eac_ruby_base0/.rubocop.yml

@@ -0,0 +1,3 @@
+---
+inherit_gem:
+  eac_ruby_gem_support: ".rubocop.yml"

data/sub/eac_ruby_base0/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+local_gemfile = File.join(File.dirname(__FILE__), 'Gemfile.local')
+eval_gemfile local_gemfile if File.exist?(local_gemfile)