eac_config 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd6a6d3c5ab71a03c476e9d3237623e6d9911128c27301c73dcaf3fdc3e49e33
-  data.tar.gz: fd1d1139b115073c1f7bcec332dcdbbcd92c9ed7825acff34eaa7c3b76747e04
+  metadata.gz: 1146b6d7dcccd0749b9ac875dceb8b521e386cc4468ffeab106f33e29e254a85
+  data.tar.gz: b4da054e60c2c5316670d047869ce98c3ca4255fc1df62db9b5ef5f303bdd5e8
 SHA512:
-  metadata.gz: c29cc31ab4a5c6a834af31f12986c0e8e3b862d6603d117b7a3ca5792465636693542ae13417764c23fc2b6cfdd834bda7db0915d419157b329aec836fc7d2b2
-  data.tar.gz: 2390811743a6a997ee6d0ec2bba40ca5f27222ac14d352a51eb508e0e345c3f2190a12105bb3e9cfd63dc45052cdbe41d0c3c4df2dcf319103ec00f16db162a1
+  metadata.gz: e3c47344815bd911603f54a37581a6be9b7182f87d3b2546e708f903a5da3bb7799da013c189db7a3f3d0572e64b4124562a43f9ebe54c0e88805d12fa94503a
+  data.tar.gz: 5f6ba2fb942129f1b8b5d47ab1e1693d025303f501ebb6e7f0a25109369beaa99dfcc420e08f5d8c50ffb495bf52c287f6491a5d4b11014c1c051f21c4cd272b

data/lib/eac_config/entry.rb

@@ -5,10 +5,39 @@ 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
+
+    delegate :value=, to: :root_node
+
+    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/load_path.rb

@@ -0,0 +1,36 @@
+# 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])
+    PATH_SEPARATOR = ':'
+
+    class << self
+      def paths_to_string(paths)
+        paths.map(&:to_s).join(PATH_SEPARATOR)
+      end
+
+      def string_to_paths(string)
+        string.to_s.split(PATH_SEPARATOR)
+      end
+    end
+
+    common_constructor :node
+
+    def entry
+      node.self_entry(ENTRY_PATH)
+    end
+
+    # @return [Array<String>]
+    def paths
+      self.class.string_to_paths(entry.value)
+    end
+
+    def push(new_path)
+      entry.value = self.class.paths_to_string(paths + [new_path])
+    end
+  end
+end

data/lib/eac_config/node.rb

@@ -1,7 +1,10 @@
 # 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_ruby_utils/core_ext'
 
 module EacConfig
@@ -11,11 +14,13 @@ module EacConfig
       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 +28,15 @@ 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)
+      ::EacConfig::NodeEntry.new(self, path)
+    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>]

data/lib/eac_config/node_entry.rb

@@ -0,0 +1,39 @@
+# 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_simple_cache
+    common_constructor :node, :path do
+      self.path = ::EacConfig::EntryPath.assert(path)
+    end
+
+    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

data/lib/eac_config/old_configs.rb

@@ -0,0 +1,74 @@
+# 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
+  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.3.0'
 end

data/lib/eac_config/yaml_file_node.rb

@@ -1,8 +1,6 @@
 # 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'
@@ -16,11 +14,28 @@ module EacConfig
     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)
+      reset_cache(:data)
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_config
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Put here the authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-16 00:00:00.000000000 Z
+date: 2021-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.62'
+        version: '0.64'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.62'
+        version: '0.64'
 - !ruby/object:Gem::Dependency
   name: eac_ruby_gem_support
   requirement: !ruby/object:Gem::Requirement
@@ -61,9 +61,13 @@ 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/load_nodes_search.rb
+- lib/eac_config/load_path.rb
 - lib/eac_config/node.rb
+- lib/eac_config/node_entry.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

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