eac_tools 0.122.0 → 0.123.0

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

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class OldConfigs
+    class Base
+      enable_memoized
+
+      common_constructor :data, default: [{}] do
+        self.data = ::EacConfig::PathsHash.new(data)
+      end
+
+      def []=(entry_key, entry_value)
+        write(entry_key, entry_value)
+      end
+
+      def [](entry_key)
+        read(entry_key)
+      end
+
+      def clear
+        replace({})
+      end
+
+      def read(entry_key)
+        return nil unless data.key?(entry_key)
+
+        data.fetch(entry_key).if_present(::EacRubyUtils::BlankNotBlank.instance)
+      end
+
+      def replace(new_data)
+        self.data = ::EacConfig::PathsHash.new(new_data)
+      end
+
+      def write(entry_key, entry_value)
+        data[entry_key] = entry_value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module EacConfig
+  class OldConfigs
+    class File < ::EacConfig::OldConfigs::Base
+      attr_reader :path, :options
+
+      # Valid options: [:autosave]
+      def initialize(path, options = {})
+        @path = path
+        @options = options.to_sym_keys_hash.freeze
+        super(raw_data_from_file)
+      end
+
+      def save
+        ::FileUtils.mkdir_p(::File.dirname(path))
+        ::File.write(path, data.to_h.to_yaml)
+      end
+
+      def load
+        replace(raw_data_from_file)
+      end
+
+      def write(entry_key, entry_value)
+        super
+        save if autosave?
+      end
+
+      def autosave?
+        options[:autosave] ? true : false
+      end
+
+      private
+
+      def raw_data_from_file
+        if ::File.exist?(path) && ::File.size(path).positive?
+          ::YAML.load_file(path)
+        else
+          {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string'
+require 'yaml'
+
+module EacConfig
+  # @deprecated Use {EacConfig::YamlFileNode} instead.
+  class OldConfigs
+    enable_memoized
+
+    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
+
+    memoize def file
+      ::EacConfig::OldConfigs::File.new(
+        storage_path, options
+      )
+    end
+
+    def read_entry(entry_key)
+      file.read(entry_key)
+    end
+
+    memoize def storage_path
+      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
+
+    delegate :autosave?, to: :file
+
+    private
+
+    attr_accessor :data
+
+    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

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+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

@@ -0,0 +1,39 @@
+# 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