eac_config 0.2.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd6a6d3c5ab71a03c476e9d3237623e6d9911128c27301c73dcaf3fdc3e49e33
-  data.tar.gz: fd1d1139b115073c1f7bcec332dcdbbcd92c9ed7825acff34eaa7c3b76747e04
+  metadata.gz: 6a404b0d89fc683f1632c29e760ac77ac204a89de0dc979f3dc4a14365443859
+  data.tar.gz: 2efe809b7f1c5ccd6891c668ed35535d9096c26d3fd72eebbff0d3bae9c8e4a0
 SHA512:
-  metadata.gz: c29cc31ab4a5c6a834af31f12986c0e8e3b862d6603d117b7a3ca5792465636693542ae13417764c23fc2b6cfdd834bda7db0915d419157b329aec836fc7d2b2
-  data.tar.gz: 2390811743a6a997ee6d0ec2bba40ca5f27222ac14d352a51eb508e0e345c3f2190a12105bb3e9cfd63dc45052cdbe41d0c3c4df2dcf319103ec00f16db162a1
+  metadata.gz: dbbbbd172244973867db06006fb0d5a2a6bf48675ef5806b742aeb7e9fdde0c83153f4de46d4ebe1bc9a38ebebf91fffd4d4d7e57d75a2ffee9958f1d6973e21
+  data.tar.gz: 00d7a496a83302ed6ec13f691a18ef82947c1bf8f6b9d7dfd93e90fda649d2661aa1b4ed15b94602ff0caaa5bf9bc794aa817dc491cdfaa85c97932244d2a036

data/lib/eac_config/entry.rb

@@ -5,10 +5,45 @@ require 'eac_ruby_utils/core_ext'
 
 module EacConfig
   class Entry
-    common_constructor :source_node, :path, :found, :value
+    enable_simple_cache
+    common_constructor :root_node, :path do
+      self.path = ::EacConfig::EntryPath.assert(path)
+    end
 
     def found?
-      found
+      node_entry.if_present(false, &:found?)
+    end
+
+    def found_node
+      node_entry.if_present(&:node)
+    end
+
+    def value
+      node_entry.if_present(&:value)
+    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
+
+    def node_entry_uncached
+      node_entry_from_root || node_entry_from_load_path
+    end
+
+    def node_entry_from_load_path_uncached
+      root_node.recursive_loaded_nodes.lazy.map { |loaded_node| loaded_node.self_entry(path) }
+               .find(&:found?)
+    end
+
+    def node_entry_from_root_uncached
+      e = root_node.self_entry(path)
+      e.found? ? e : nil
     end
   end
 end

data/lib/eac_config/entry_path.rb

@@ -33,5 +33,9 @@ module EacConfig
     def initialize(parts)
       @parts = parts.to_a.freeze
     end
+
+    def to_s
+      "#{self.class}[#{parts.join(PART_SEPARATOR)}]"
+    end
   end
 end

data/lib/eac_config/envvars_node.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'addressable'
+require 'eac_config/node'
+require 'eac_ruby_utils/core_ext'
+
+module EacConfig
+  # A node that read/write entries from environment variables.
+  class EnvvarsNode
+    require_sub __FILE__
+    include ::EacConfig::Node
+
+    URI = ::Addressable::URI.parse('self://envvars')
+
+    class << self
+      def from_uri(uri)
+        return new if uri == URI
+      end
+    end
+
+    def url
+      URI
+    end
+  end
+end

data/lib/eac_config/envvars_node/entry.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'eac_config/entry_path'
+require 'eac_config/node_entry'
+require 'eac_ruby_utils/blank_not_blank'
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/yaml'
+
+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_simple_cache
+
+      def found?
+        ENV.key?(envvar_name)
+      end
+
+      def value
+        self.class.from_value(ENV[envvar_name])
+      end
+
+      def value=(a_value)
+        ENV[envvar_name] = self.class.to_value(a_value)
+      end
+
+      private
+
+      def envvar_name_uncached
+        self.class.entry_path_to_envvar_name(path)
+      end
+    end
+  end
+end

data/lib/eac_config/load_path.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'eac_config/entry_path'
+require 'eac_ruby_utils/core_ext'
+
+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/lib/eac_config/node.rb

@@ -1,21 +1,36 @@
 # frozen_string_literal: true
 
+require 'eac_config/entry'
 require 'eac_config/entry_path'
+require 'eac_config/load_path'
 require 'eac_config/load_nodes_search'
+require 'eac_config/node_entry'
+require 'eac_config/node_uri'
 require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/context'
 
 module EacConfig
   module Node
+    class << self
+      def context
+        @context ||= ::EacRubyUtils::Context.new
+      end
+    end
+
+    attr_accessor :write_node
+
     common_concern do
       enable_abstract_methods
       include ::Comparable
     end
 
-    LOAD_PATH_ENTRY_PATH = ::EacConfig::EntryPath.assert(%w[load_path])
-    LOAD_PATH_PATH_SEPARATOR = ':'
-
     def entry(path)
-      ::EacConfig::EntrySearch.new(self, ::EacConfig::EntryPath.assert(path)).result
+      ::EacConfig::Entry.new(self, path)
+    end
+
+    # @return [[EacConfig::IncludePath]]
+    def load_path
+      @load_path ||= ::EacConfig::LoadPath.new(self)
     end
 
     # @return [Addressable::URI]
@@ -23,12 +38,19 @@ module EacConfig
       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
-      ::EacConfig::EntrySearch.new(self, ::EacConfig::EntryPath.assert(LOAD_PATH_ENTRY_PATH))
-                              .result_from_self.if_present([]) do |e|
-        e.value.split(LOAD_PATH_PATH_SEPARATOR).map { |node_path| load_node(node_path) }
-      end
+      load_path.paths.map { |node_path| load_node(node_path) }
     end
 
     # @return [Array<EacConfig::Node>]
@@ -39,7 +61,7 @@ module EacConfig
     private
 
     def load_node(node_path)
-      self.class.new(node_path.to_pathname.expand_path(path.parent))
+      ::EacConfig::NodeUri.new(node_path, url).instanciate
     end
   end
 end

data/lib/eac_config/node_entry.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'eac_config/entry_path'
+require 'eac_config/paths_hash'
+require 'eac_ruby_utils/core_ext'
+
+module EacConfig
+  # A entry which search values only in the source node.
+  class NodeEntry
+    enable_abstract_methods
+    enable_simple_cache
+    common_constructor :node, :path do
+      self.path = ::EacConfig::EntryPath.assert(path)
+    end
+
+    abstract_methods :found?, :value, :value=
+  end
+end

data/lib/eac_config/node_uri.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module EacConfig
+  class NodeUri
+    enable_simple_cache
+    common_constructor :source, :loader_uri, default: [nil]
+
+    def available_node_classes
+      require 'eac_config/envvars_node'
+      require 'eac_config/yaml_file_node'
+      [::EacConfig::EnvvarsNode, ::EacConfig::YamlFileNode]
+    end
+
+    def instanciate
+      available_node_classes.lazy.map { |k| k.from_uri(self) }.find(&:present?) ||
+        raise("No class mapped for \"#{to_addressable}\"")
+    end
+
+    delegate :to_s, to: :to_addressable
+
+    private
+
+    def to_addressable_uncached
+      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
+  end
+end

data/lib/eac_config/old_configs.rb

@@ -0,0 +1,75 @@
+# 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(ENV['HOME'], '.config', configs_key, 'settings.yml')
+    end
+  end
+end

data/lib/eac_config/old_configs/base.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/blank_not_blank'
+require 'eac_ruby_utils/core_ext'
+require 'eac_config/paths_hash'
+
+module EacConfig
+  class OldConfigs
+    class Base
+      enable_simple_cache
+
+      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/lib/eac_config/old_configs/file.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'eac_config/old_configs/base'
+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/lib/eac_config/version.rb

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

data/lib/eac_config/yaml_file_node.rb

@@ -1,26 +1,48 @@
 # frozen_string_literal: true
 
 require 'addressable'
-require 'eac_config/entry'
-require 'eac_config/entry_search'
 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
 
+    class << self
+      def from_uri(uri)
+        return new(uri.to_addressable.path) if uri.to_addressable.scheme == 'file'
+      end
+    end
+
     common_constructor :path do
       self.path = path.to_pathname
     end
 
     def data
-      @data ||= ::EacRubyUtils::Yaml.load_file(path)
+      @data ||= ::EacRubyUtils::Yaml.load_file(assert_path) || {}
+    end
+
+    def persist_data(new_data)
+      path.parent.mkpath
+      ::EacRubyUtils::Yaml.dump_file(path, new_data)
+      @data = nil
     end
 
     def url
       ::Addressable::URI.parse("file://#{path.expand_path}")
     end
+
+    private
+
+    def assert_path
+      unless path.file?
+        raise("\"#{path}\" is a not a file") if path.exist?
+
+        persist_data({})
+      end
+      path
+    end
   end
 end

data/lib/eac_config/yaml_file_node/entry.rb

@@ -0,0 +1,37 @@
+# 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)
+        paths_hash[to_paths_hash_key] = a_value
+        node.persist_data(paths_hash.root.to_h)
+      end
+
+      private
+
+      # @return [EacConfig::PathsHash]
+      def paths_hash_uncached
+        ::EacConfig::PathsHash.new(node.data)
+      end
+
+      def to_paths_hash_key
+        path.parts.join('.')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_config
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Put here the authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-16 00:00:00.000000000 Z
+date: 2021-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.62'
+        version: '0.70'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.62'
+        version: '0.70'
 - !ruby/object:Gem::Dependency
   name: eac_ruby_gem_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 description: 
 email: 
 executables: []
@@ -61,15 +61,23 @@ files:
 - lib/eac_config.rb
 - lib/eac_config/entry.rb
 - lib/eac_config/entry_path.rb
-- lib/eac_config/entry_search.rb
+- lib/eac_config/envvars_node.rb
+- lib/eac_config/envvars_node/entry.rb
 - lib/eac_config/load_nodes_search.rb
+- lib/eac_config/load_path.rb
 - lib/eac_config/node.rb
+- lib/eac_config/node_entry.rb
+- lib/eac_config/node_uri.rb
+- lib/eac_config/old_configs.rb
+- lib/eac_config/old_configs/base.rb
+- lib/eac_config/old_configs/file.rb
 - lib/eac_config/paths_hash.rb
 - lib/eac_config/paths_hash/entry_key_error.rb
 - lib/eac_config/paths_hash/node.rb
 - lib/eac_config/paths_hash/path_search.rb
 - lib/eac_config/version.rb
 - lib/eac_config/yaml_file_node.rb
+- lib/eac_config/yaml_file_node/entry.rb
 homepage: 
 licenses: []
 metadata: {}
@@ -88,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Put here de description.

data/lib/eac_config/entry_search.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_config/entry'
-require 'eac_config/paths_hash'
-
-module EacConfig
-  class EntrySearch
-    enable_simple_cache
-    common_constructor :node, :path
-
-    private
-
-    def result_from_load_path_uncached
-      node.recursive_loaded_nodes.lazy.map { |loaded_node| loaded_node.entry(path) }.find(&:found?)
-    end
-
-    def result_from_self_uncached
-      return nil unless paths_hash.key?(to_paths_hash_key)
-
-      ::EacConfig::Entry.new(node, path, true, paths_hash.fetch(to_paths_hash_key))
-    end
-
-    def result_not_found_uncached
-      ::EacConfig::Entry.new(nil, path, false, nil)
-    end
-
-    # @return [EacConfig::Entry]
-    def result_uncached
-      result_from_self || result_from_load_path || result_not_found
-    end
-
-    # @return [EacConfig::PathsHash]
-    def paths_hash_uncached
-      ::EacConfig::PathsHash.new(node.data)
-    end
-
-    def to_paths_hash_key
-      path.parts.join('.')
-    end
-  end
-end