eac_ruby_utils 0.47.0 → 0.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdfe776f80d9f9d2326f040cc996e8b2dc5a08aaf7cb8eccf0a3ebb3b6d2ab4d
-  data.tar.gz: 4b0b779ca185c887ee7204050428060a115d12392f1807017a2dd16beec934ae
+  metadata.gz: db10c1ceaf0bbf46f4d4bb60de583c5bd0e9dcb4d9e836919ba4cbb3da526583
+  data.tar.gz: 9f84d861c34de8496ff30bb5bc14bf376bfba47a81c7ace9e8e51e006d44f4de
 SHA512:
-  metadata.gz: 9eace3e6ff7bdab20d791e9d7e5bfe81f9f8bd6ca93fb815bb77d63d30a0c2d1604ee4e3bfecbe892b179dc7c557ee9b1554a26281ba003326c12fc50c2f9ce3
-  data.tar.gz: 5ea6a75da16e45cf51e4610dbe7f0fd51ec4ccc7a7e52f96f0f5590be168d5fa6d7a1d95e95e890e10c36736b33dc2323b2549f5e8c1caf21c4af47a27e59ba5
+  metadata.gz: c61d5b10f2981624324aaa7cee8f1c554e1521814fd158f43701d42391fcb4f29b8e2b55b799f887f1434ee47ea032108ae96136fd8200fde7fbe8181fe8efab
+  data.tar.gz: 3339282f35c34c843b500a0d37a025a6f53be072e495771d6262d08fda8c3957dad6feedbc82d0b6bfdb1eeebc1cc8a6f9c183f5071f1e90cd205a9c79404e71

data/lib/eac_ruby_utils/blank_not_blank.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'singleton'
+
+module EacRubyUtils
+  # A blank string which returns +false+ for +blank?+ method.
+  class BlankNotBlank < String
+    include ::Singleton
+
+    def initialize
+      super('')
+    end
+
+    def blank?
+      false
+    end
+  end
+end

data/lib/eac_ruby_utils/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_ruby_utils/paths_hash'
+
+module EacRubyUtils
+  class Configs
+    class Base
+      enable_simple_cache
+
+      common_constructor :data, default: [{}] do
+        self.data = ::EacRubyUtils::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 = ::EacRubyUtils::PathsHash.new(new_data)
+      end
+
+      def write(entry_key, entry_value)
+        data[entry_key] = entry_value
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/configs/file.rb

@@ -1,27 +1,18 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/string'
+require 'eac_ruby_utils/configs/base'
 require 'yaml'
-require 'eac_ruby_utils/patches/hash/sym_keys_hash'
-require 'eac_ruby_utils/paths_hash'
-require 'eac_ruby_utils/simple_cache'
 
 module EacRubyUtils
   class Configs
-    class File
-      include ::EacRubyUtils::SimpleCache
-
+    class File < ::EacRubyUtils::Configs::Base
       attr_reader :path, :options
 
       # Valid options: [:autosave]
       def initialize(path, options = {})
         @path = path
         @options = options.to_sym_keys_hash.freeze
-        load
-      end
-
-      def clear
-        self.data = ::EacRubyUtils::PathsHash.new({})
+        super(raw_data_from_file)
       end
 
       def save
@@ -30,37 +21,27 @@ module EacRubyUtils
       end
 
       def load
-        self.data = if ::File.exist?(path) && ::File.size(path).positive?
-                      ::EacRubyUtils::PathsHash.new(YAML.load_file(path))
-                    else
-                      {}
-                    end
-      end
-
-      def []=(entry_key, entry_value)
-        write(entry_key, entry_value)
+        replace(raw_data_from_file)
       end
 
       def write(entry_key, entry_value)
-        data[entry_key] = entry_value
+        super
         save if autosave?
       end
 
-      def [](entry_key)
-        read(entry_key)
-      end
-
-      def read(entry_key)
-        data[entry_key]
-      end
-
       def autosave?
         options[:autosave] ? true : false
       end
 
       private
 
-      attr_accessor :data
+      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_ruby_utils/console/configs.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
-require 'eac_ruby_utils/common_constructor'
 require 'eac_ruby_utils/configs'
-require 'eac_ruby_utils/console/speaker'
-require 'eac_ruby_utils/options_consumer'
-require 'eac_ruby_utils/patches/object/asserts'
-require 'eac_ruby_utils/simple_cache'
+require 'eac_ruby_utils/core_ext'
 
 module EacRubyUtils
   module Console
     class Configs
-      include ::EacRubyUtils::Console::Speaker
+      require_sub __FILE__
+      enable_console_speaker
 
       class << self
         def entry_key_to_envvar_name(entry_key)
@@ -34,7 +31,7 @@ module EacRubyUtils
       end
 
       def read_password(entry_key, options = {})
-        options = options.merge(noecho: true)
+        options = ReadEntryOptions.new(options.merge(noecho: true))
         if store_passwords?
           read_entry(entry_key, options)
         else
@@ -66,7 +63,10 @@ module EacRubyUtils
       protected
 
       def envvar_read_entry(entry_key)
-        ENV[self.class.entry_key_to_envvar_name(entry_key)]
+        env_entry_key = self.class.entry_key_to_envvar_name(entry_key)
+        return nil unless ENV.key?(env_entry_key)
+
+        ENV.fetch(env_entry_key).if_present(::EacRubyUtils::BlankNotBlank.instance)
       end
 
       def read_entry_from_console(entry_key, options)
@@ -98,38 +98,6 @@ module EacRubyUtils
         warn('Entered value is blank') if entry_value.blank?
         entry_value
       end
-
-      class ReadEntryOptions
-        include ::EacRubyUtils::SimpleCache
-        ::EacRubyUtils::CommonConstructor.new(:options).setup_class(self)
-
-        DEFAULT_VALUES = {
-          before_input: nil, bool: false, list: false, noecho: false, noenv: false, noinput: false,
-          required: true, validator: nil
-        }.freeze
-
-        def [](key)
-          values.fetch(key.to_sym)
-        end
-
-        def request_input_options
-          values.slice(:bool, :list, :noecho)
-        end
-
-        private
-
-        def values_uncached
-          consumer = ::EacRubyUtils::OptionsConsumer.new(options)
-          r = {}
-          DEFAULT_VALUES.each do |key, default_value|
-            value = consumer.consume(key)
-            value = default_value if value.nil?
-            r[key] = value
-          end
-          consumer.validate
-          r
-        end
-      end
     end
   end
 end

data/lib/eac_ruby_utils/console/configs/read_entry_options.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacRubyUtils
+  module Console
+    class Configs
+      class ReadEntryOptions
+        enable_simple_cache
+        common_constructor :options
+
+        DEFAULT_VALUES = {
+          before_input: nil, bool: false, list: false, noecho: false, noenv: false, noinput: false,
+          required: true, validator: nil
+        }.freeze
+
+        def [](key)
+          values.fetch(key.to_sym)
+        end
+
+        def request_input_options
+          values.slice(:bool, :list, :noecho)
+        end
+
+        private
+
+        def values_uncached
+          consumer = options.to_options_consumer
+          r = {}
+          DEFAULT_VALUES.each do |key, default_value|
+            value = consumer.consume(key)
+            value = default_value if value.nil?
+            r[key] = value
+          end
+          consumer.validate
+          r
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/fs/clearable_directory.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'pathname'
+
+module EacRubyUtils
+  module Fs
+    class ClearableDirectory < ::Pathname
+      CLEARABLE_BASENAME = '.clearable_directory'
+
+      def clear
+        validate_clearable
+        directory? ? clear_directory : clear_no_directory
+        mkpath
+        ::FileUtils.touch(clearable_note_file.to_path)
+        self
+      end
+
+      def clearable?
+        clearable_negate_message ? true : false
+      end
+
+      def clearable_negate_message
+        return if !exist? || empty?
+        return "Path \"#{self}\" exists, is not empty and is not a directory" unless directory?
+        return if clearable_note_file.exist?
+
+        "Directory \"#{self}\" is not empty and does not have a #{CLEARABLE_BASENAME} file"
+      end
+
+      def clearable_note_file
+        join(CLEARABLE_BASENAME)
+      end
+
+      def validate_clearable
+        message = clearable_negate_message
+        raise message if message
+      end
+
+      private
+
+      def clear_directory
+        children.each do |child|
+          if child.directory?
+            child.rmtree
+          elsif child.file?
+            child.unlink
+          end
+        end
+      end
+
+      def clear_no_directory
+        ::FileUtils.rm_rf(to_path)
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/patches/enumerator.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub __FILE__

data/lib/eac_ruby_utils/patches/enumerator/current.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Enumerator
+  def current(default_value = nil)
+    peek
+  rescue ::StopIteration
+    default_value
+  end
+end

data/lib/eac_ruby_utils/patches/enumerator/stopped.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Enumerator
+  def ongoing?
+    !stopped?
+  end
+
+  def stopped?
+    peek
+    false
+  rescue ::StopIteration
+    true
+  end
+end

data/lib/eac_ruby_utils/patches/object/debug.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Object
+  def print_debug
+    STDERR.write(to_debug + "\n")
+
+    self
+  end
+
+  def to_debug
+    "|#{self.class}|#{self}|"
+  end
+
+  def raise_debug
+    raise to_debug
+  end
+end

data/lib/eac_ruby_utils/paths_hash.rb

@@ -1,21 +1,25 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/object'
-require 'eac_ruby_utils/patches/object/asserts'
+require 'eac_ruby_utils/core_ext'
 
 module EacRubyUtils
   class PathsHash
+    require_sub __FILE__
+
     class << self
       def parse_entry_key(entry_key)
         r = entry_key.to_s.strip
-        raise EntryKeyError, 'Entry key cannot start or end with dot' if
+        raise ::EacRubyUtils::PathsHash::EntryKeyError, 'Entry key cannot start or end with dot' if
         r.start_with?('.') || r.end_with?('.')
 
         r = r.split('.').map(&:strip)
-        raise EntryKeyError, "Entry key \"#{entry_key}\" is empty" if r.empty?
+        if r.empty?
+          raise ::EacRubyUtils::PathsHash::EntryKeyError, "Entry key \"#{entry_key}\" is empty"
+        end
         return r.map(&:to_sym) unless r.any?(&:blank?)
 
-        raise EntryKeyError, "Entry key \"#{entry_key}\" has at least one blank part"
+        raise ::EacRubyUtils::PathsHash::EntryKeyError,
+              "Entry key \"#{entry_key}\" has at least one blank part"
       end
     end
 
@@ -26,68 +30,27 @@ module EacRubyUtils
     end
 
     def [](entry_key)
-      root.read_entry(self.class.parse_entry_key(entry_key), [])
+      root.read_entry(::EacRubyUtils::PathsHash::PathSearch.parse_entry_key(entry_key))
     end
 
     def []=(entry_key, entry_value)
-      root.write_entry(self.class.parse_entry_key(entry_key), entry_value, [])
+      root.write_entry(
+        ::EacRubyUtils::PathsHash::PathSearch.parse_entry_key(entry_key), entry_value
+      )
     end
 
-    delegate :to_h, to: :root
-
-    private
-
-    attr_reader :data
-
-    class EntryKeyError < StandardError
+    def fetch(entry_key)
+      root.fetch(::EacRubyUtils::PathsHash::PathSearch.parse_entry_key(entry_key))
     end
 
-    class Node
-      def initialize(source_hash)
-        source_hash.assert_argument(Hash, 'source_hash')
-        @data = source_hash.map { |k, v| [k.to_sym, v.is_a?(Hash) ? Node.new(v) : v] }.to_h
-      end
-
-      def to_h
-        data.map { |k, v| [k, v.is_a?(Node) ? v.to_h : v] }.to_h
-      end
-
-      def read_entry(path, current)
-        validate_path(path, current)
-        node_key = path.shift
-        node = data[node_key]
-        return (node.is_a?(Node) ? node.to_h : node) if path.empty?
-        return nil if node.blank?
-        return node.read_entry(path, current + [node_key]) if node.is_a?(Node)
-
-        raise(EntryKeyError,
-              "Path #{current.join(',')} is not a Node and path continues (#{current + path})")
-      end
-
-      def write_entry(path, value, current)
-        validate_path(path, current)
-        node_key = path.shift
-        write_entry_value(path, node_key, value, current)
-      end
-
-      private
+    def key?(entry_key)
+      root.entry?(::EacRubyUtils::PathsHash::PathSearch.parse_entry_key(entry_key))
+    end
 
-      def write_entry_value(path, node_key, value, current)
-        if path.empty?
-          data[node_key] = value.is_a?(Hash) ? Node.new(value) : value
-        else
-          data[node_key] = Node.new({}) unless data[node_key].is_a?(Node)
-          data[node_key].write_entry(path, value, current + [node_key])
-        end
-      end
+    delegate :to_h, to: :root
 
-      def validate_path(path, current)
-        path.assert_argument(Array, 'path')
-        current.assert_argument(Array, 'current')
-        raise EntryKeyError, 'Path is empty' if path.empty?
-      end
+    private
 
-      attr_reader :data
-    end
+    attr_reader :data
   end
 end

data/lib/eac_ruby_utils/paths_hash/entry_key_error.rb

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

data/lib/eac_ruby_utils/paths_hash/node.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/paths_hash/entry_key_error'
+
+module EacRubyUtils
+  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.map { |k, v| [k.to_sym, v.is_a?(Hash) ? Node.new(v) : v] }.to_h
+      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.map { |k, v| [k, v.is_a?(Node) ? v.to_h : v] }.to_h
+      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/lib/eac_ruby_utils/paths_hash/path_search.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class PathsHash
+    class PathSearch
+      class << self
+        def parse_entry_key(string)
+          new(::EacRubyUtils::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 ::EacRubyUtils::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 ::EacRubyUtils::PathsHash::EntryKeyError, "#{message} (#{self})"
+      end
+
+      def succeeding
+        self.class.new(current[1..-1], previous + [cursor])
+      end
+
+      def to_s
+        "#{self.class}[Current: #{current}, Previous: #{previous}]"
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/struct.rb

@@ -27,6 +27,10 @@ module EacRubyUtils
       property_method?(method_name) || super
     end
 
+    def slice_fetch(*keys)
+      self.class.new(keys.map { |key| [key, fetch(key)] }.to_h)
+    end
+
     def to_h
       data.dup
     end

data/lib/eac_ruby_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EacRubyUtils
-  VERSION = '0.47.0'
+  VERSION = '0.51.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.47.0
+  version: 0.51.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,14 +109,17 @@ files:
 - README.rdoc
 - lib/eac_ruby_utils.rb
 - lib/eac_ruby_utils/arguments_consumer.rb
+- lib/eac_ruby_utils/blank_not_blank.rb
 - lib/eac_ruby_utils/boolean.rb
 - lib/eac_ruby_utils/by_reference.rb
 - lib/eac_ruby_utils/common_concern.rb
 - lib/eac_ruby_utils/common_constructor.rb
 - lib/eac_ruby_utils/configs.rb
+- lib/eac_ruby_utils/configs/base.rb
 - lib/eac_ruby_utils/configs/file.rb
 - lib/eac_ruby_utils/console.rb
 - lib/eac_ruby_utils/console/configs.rb
+- lib/eac_ruby_utils/console/configs/read_entry_options.rb
 - lib/eac_ruby_utils/console/docopt_runner.rb
 - lib/eac_ruby_utils/console/docopt_runner/_class_methods.rb
 - lib/eac_ruby_utils/console/docopt_runner/_doc.rb
@@ -146,6 +149,7 @@ files:
 - lib/eac_ruby_utils/envs/ssh_env/terminal.rb
 - lib/eac_ruby_utils/filesystem_cache.rb
 - lib/eac_ruby_utils/fs.rb
+- lib/eac_ruby_utils/fs/clearable_directory.rb
 - lib/eac_ruby_utils/fs/extname.rb
 - lib/eac_ruby_utils/fs/temp.rb
 - lib/eac_ruby_utils/fs/temp/directory.rb
@@ -179,6 +183,9 @@ files:
 - lib/eac_ruby_utils/patches/class/common_constructor.rb
 - lib/eac_ruby_utils/patches/enumerable.rb
 - lib/eac_ruby_utils/patches/enumerable/boolean_combinations.rb
+- lib/eac_ruby_utils/patches/enumerator.rb
+- lib/eac_ruby_utils/patches/enumerator/current.rb
+- lib/eac_ruby_utils/patches/enumerator/stopped.rb
 - lib/eac_ruby_utils/patches/hash.rb
 - lib/eac_ruby_utils/patches/hash/options_consumer.rb
 - lib/eac_ruby_utils/patches/hash/sym_keys_hash.rb
@@ -192,6 +199,7 @@ files:
 - lib/eac_ruby_utils/patches/module/simple_cache.rb
 - lib/eac_ruby_utils/patches/object.rb
 - lib/eac_ruby_utils/patches/object/asserts.rb
+- lib/eac_ruby_utils/patches/object/debug.rb
 - lib/eac_ruby_utils/patches/object/if_present.rb
 - lib/eac_ruby_utils/patches/object/if_respond.rb
 - lib/eac_ruby_utils/patches/object/template.rb
@@ -206,6 +214,9 @@ files:
 - lib/eac_ruby_utils/patches/time/default_time_zone_set.rb
 - lib/eac_ruby_utils/patches/time/local_time_zone.rb
 - lib/eac_ruby_utils/paths_hash.rb
+- lib/eac_ruby_utils/paths_hash/entry_key_error.rb
+- lib/eac_ruby_utils/paths_hash/node.rb
+- lib/eac_ruby_utils/paths_hash/path_search.rb
 - lib/eac_ruby_utils/require_sub.rb
 - lib/eac_ruby_utils/rspec.rb
 - lib/eac_ruby_utils/rspec/conditional.rb