eac_tools 0.97.2 → 0.98.0

data/sub/eac_config/lib/eac_config/old_configs.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/string'
-require 'yaml'
-require 'eac_config/old_configs/file'
-require 'eac_ruby_utils/patches/hash/sym_keys_hash'
-require 'eac_config/paths_hash'
-require 'eac_ruby_utils/simple_cache'
-
-module EacConfig
-  # @deprecated Use {EacConfig::YamlFileNode} instead.
-  class OldConfigs
-    include ::EacRubyUtils::SimpleCache
-
-    attr_reader :configs_key, :options
-
-    # Valid options: [:storage_path]
-    def initialize(configs_key, options = {})
-      @configs_key = configs_key
-      @options = options.to_sym_keys_hash.freeze
-      load
-    end
-
-    delegate :clear, to: :file
-
-    delegate :save, to: :file
-
-    delegate :load, to: :file
-
-    def []=(entry_key, entry_value)
-      write_entry(entry_key, entry_value)
-    end
-
-    def write_entry(entry_key, entry_value)
-      file.write(entry_key, entry_value)
-    end
-
-    def [](entry_key)
-      read_entry(entry_key)
-    end
-
-    def read_entry(entry_key)
-      file.read(entry_key)
-    end
-
-    delegate :autosave?, to: :file
-
-    private
-
-    attr_accessor :data
-
-    def file_uncached
-      ::EacConfig::OldConfigs::File.new(
-        storage_path, options
-      )
-    end
-
-    def storage_path_uncached
-      path = options_storage_path || default_storage_path
-      return path if ::File.exist?(path) && ::File.size(path).positive?
-
-      ::FileUtils.mkdir_p(::File.dirname(path))
-      ::File.write(path, {}.to_yaml)
-      path
-    end
-
-    def options_storage_path
-      options[:storage_path]
-    end
-
-    def default_storage_path
-      ::File.join(Dir.home, '.config', configs_key, 'settings.yml')
-    end
-  end
-end

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

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module EacConfig
-  class PathsHash
-    class EntryKeyError < StandardError
-    end
-  end
-end

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

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-require 'eac_config/paths_hash/entry_key_error'
-
-module EacConfig
-  class PathsHash
-    class Node
-      PATH_SEARCH_UNENDED_ERROR_MESSAGE = 'Path search is not a Node and is not ended'
-
-      def initialize(source_hash)
-        source_hash.assert_argument(Hash, 'source_hash')
-        @data = source_hash.to_h { |k, v| [k.to_sym_by_eac, v.is_a?(Hash) ? Node.new(v) : v] }
-      end
-
-      def entry?(path_search)
-        return false unless data.key?(path_search.cursor)
-        return true if path_search.ended?
-        return data.fetch(path_search.cursor).entry?(path_search.succeeding) if
-          data.fetch(path_search.cursor).is_a?(Node)
-
-        false # Paths continue and there is not available nodes
-      end
-
-      def fetch(path_search)
-        if data.key?(path_search.cursor)
-          node = data.fetch(path_search.cursor)
-          return (node.is_a?(Node) ? node.to_h : node) if path_search.ended?
-          return nil if node.blank?
-          return node.fetch(path_search.succeeding) if node.is_a?(Node)
-        end
-
-        path_search.raise_error(PATH_SEARCH_UNENDED_ERROR_MESSAGE)
-      end
-
-      def to_h
-        data.transform_values { |v| v.is_a?(Node) ? v.to_h : v }
-      end
-
-      def read_entry(path_search)
-        node = data[path_search.cursor]
-        return (node.is_a?(Node) ? node.to_h : node) if path_search.ended?
-        return nil if node.blank?
-        return node.read_entry(path_search.succeeding) if node.is_a?(Node)
-
-        path_search.raise_error(PATH_SEARCH_UNENDED_ERROR_MESSAGE)
-      end
-
-      def write_entry(path_search, value)
-        if path_search.ended?
-          data[path_search.cursor] = value.is_a?(Hash) ? self.class.new(value) : value
-        else
-          assert_data_node(path_search.cursor).write_entry(path_search.succeeding, value)
-        end
-      end
-
-      private
-
-      attr_reader :data
-
-      def assert_data_node(key)
-        data[key] = self.class.new({}) unless data[key].is_a?(Node)
-        data[key]
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module EacConfig
-  class PathsHash
-    class PathSearch
-      class << self
-        def parse_entry_key(string)
-          new(::EacConfig::PathsHash.parse_entry_key(string), [])
-        end
-      end
-
-      common_constructor :current, :previous do
-        self.current = current.assert_argument(Array, 'current').freeze
-        self.previous = previous.assert_argument(Array, 'previous')
-        raise ::EacConfig::PathsHash::EntryKeyError, 'Current is empty' if current.empty?
-      end
-
-      def cursor
-        current.first
-      end
-
-      def ended?
-        current.count <= 1
-      end
-
-      def raise_error(message)
-        raise ::EacConfig::PathsHash::EntryKeyError, "#{message} (#{self})"
-      end
-
-      def succeeding
-        self.class.new(current[1..], previous + [cursor])
-      end
-
-      def to_s
-        "#{self.class}[Current: #{current}, Previous: #{previous}]"
-      end
-    end
-  end
-end

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

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-
-module EacConfig
-  class PathsHash
-    require_sub __FILE__
-
-    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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_config/node_entry'
-require 'eac_ruby_utils/core_ext'
-
-module EacConfig
-  class PrefixedPathNode
-    class Entry < ::EacConfig::NodeEntry
-      enable_simple_cache
-      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]
-      def full_entry_uncached
-        node.from_node.entry(full_path)
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_config/entry_path'
-require 'eac_config/paths_hash'
-require 'eac_ruby_utils/core_ext'
-
-module EacConfig
-  class PrefixedPathNode
-    require_sub __FILE__
-    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

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-require 'eac_ruby_utils/fs/temp'
-require 'eac_config/envvars_node'
-require 'eac_config/node'
-require 'eac_config/yaml_file_node'
-
-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, &node_builder)
-        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, &node_builder)) 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, &block)
-        if target_file
-          yield(target_file.to_pathname)
-        else
-          ::EacRubyUtils::Fs::Temp.on_file(&block)
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_config/entry_path'
-require 'eac_config/node_entry'
-require 'eac_ruby_utils/core_ext'
-
-module EacConfig
-  class YamlFileNode
-    class Entry < ::EacConfig::NodeEntry
-      enable_simple_cache
-
-      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

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_config/entry_path'
-require 'eac_config/yaml_file_node/entry'
-require 'eac_ruby_utils/core_ext'
-require 'eac_ruby_utils/wildcards'
-
-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

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require 'addressable'
-require 'eac_config/node'
-require 'eac_ruby_utils/core_ext'
-require 'eac_ruby_utils/yaml'
-
-module EacConfig
-  class YamlFileNode
-    require_sub __FILE__
-    include ::EacConfig::Node
-    enable_simple_cache
-
-    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
-
-    def persist_data(new_data)
-      path.parent.mkpath
-      ::EacRubyUtils::Yaml.dump_file(path, new_data)
-      reset_cache(:data)
-    end
-
-    def url
-      ::Addressable::URI.parse("file://#{path.expand_path}")
-    end
-
-    def to_s
-      "#{self.class}[#{path}]"
-    end
-
-    private
-
-    def data_uncached
-      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
-
-    require_sub __FILE__, require_mode: :kernel
-  end
-end

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_config/entry_path'
-
-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]
-      expected_parts = data[1]
-
-      context "when source is #{source}" do
-        let(:instance) { described_class.assert(source) }
-
-        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

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_config/envvars_node/entry'
-
-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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_config/envvars_node'
-require 'eac_ruby_utils/ruby'
-
-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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require 'tempfile'
-require 'eac_config/old_configs'
-
-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