eac_ruby_utils 0.59.0 → 0.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 548ad31ed6381e0a51802ea856dfa885fdaef16080305285698872baa9dc9b24
-  data.tar.gz: ee4ddee8e898704ef248d82296d7cb63093a3ff8a72e929b6815c854e8e66e70
+  metadata.gz: 988305393f16d7782424d4d46c3cfa88d805d1a06b813e87027a9f44ea2b5ce3
+  data.tar.gz: c8c55c9c290a618bcf090a9c7d59bd5a51055d91284ca2e8c411fdb6898f3ee0
 SHA512:
-  metadata.gz: 2dcbd2e28932d4a287e94798511973b1ec0803838294f2eba2d5fb7ea5e7399ee5092d2bde598e5f403195c3832bdc57a4de2a9ba7514ac4f3c9ff5f23523243
-  data.tar.gz: 8a3259581c69448604dcc452f7ede39ef6ba1eaf9081d609c837e16377aa11bdd0bba9100256226334b7863149a5d93ad43d4410b4d7b660ce61f6498850612c
+  metadata.gz: c7c3cdfdef8b47a669ef14010c8a76399e4bd3febe7c860123a36a3b54dabce947ccbb5231031a11ea11540977930f10a6ca03079e8de86a47f7b4f048b4d0dc
+  data.tar.gz: b1ff9b89451e86ce8a76a05dff08b19b21a77c2c129f5390a2a9400b49bc5a9812eb44ec9591a323c5fb8f419d83da8321d4251cbd5ca0d07409277dabf8e82b

data/lib/eac_ruby_utils/filesystem_cache.rb

@@ -24,6 +24,12 @@ module EacRubyUtils
       ::File.read(content_path)
     end
 
+    def read_or_cache
+      write(yield) unless cached?
+
+      read
+    end
+
     def write(value)
       assert_directory_on_path
       ::File.write(content_path, value)

data/lib/eac_ruby_utils/fs/logs.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/filters'
+require 'eac_ruby_utils/fs/temp'
+require 'filesize'
+
+module EacRubyUtils
+  module Fs
+    class Logs
+      TRUNCATE_DEFAULT_LENGTH = 1000
+      TRUNCATE_APPEND_TEXT = '(...) '
+
+      def [](label)
+        log_set.fetch(sanitize_label(label))
+      end
+
+      def add(label)
+        log_set[sanitize_label(label)] = ::EacRubyUtils::Fs::Temp.file
+
+        self
+      end
+
+      def remove_all
+        log_set.each_key { |label| remove(label) }
+
+        self
+      end
+
+      def remove(label)
+        log_set.fetch(sanitize_label(label)).remove
+        log_set.delete(sanitize_label(label))
+      end
+
+      def truncate(label, length = TRUNCATE_DEFAULT_LENGTH)
+        content = self[label].read.strip
+        return content if content.length <= TRUNCATE_DEFAULT_LENGTH
+
+        TRUNCATE_APPEND_TEXT + content[content.length - length + TRUNCATE_APPEND_TEXT.length,
+                                       length - TRUNCATE_APPEND_TEXT.length]
+      end
+
+      def truncate_all(length = TRUNCATE_DEFAULT_LENGTH)
+        s = "Files: #{log_set.length}\n"
+        log_set.each do |label, path|
+          x = truncate(label, length)
+          y = [label, path, ::Filesize.from("#{path.size} B").pretty].join(' / ')
+          s += x.blank? ? ">>> #{y} (Blank) <<<" : ">>> #{y}\n#{x}\n<<< #{y}\n"
+        end
+        s
+      end
+
+      private
+
+      def sanitize_label(label)
+        label.to_sym
+      end
+
+      def log_set
+        @log_set ||= {}
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/inflector.rb

@@ -7,11 +7,19 @@ module EacRubyUtils
     class << self
       VARIABLE_NAME_PATTERN = /[_a-z][_a-z0-9]*/i.freeze
 
-      def variableize(string)
+      # Convert a string to a variable format: first character as a lowercase letter or underscore
+      # and other as a lowercase letter, underscore or numbers.
+      # @param string [String] The source string.
+      # @param validate [Boolean] Affect the outcome when the result builded is not in a valid
+      #   variable format. If `true`, it raises a {ArgumentError}. If `false`, return `nil`.
+      # @return [String, nil]
+      # @raise [ArgumentError]
+      def variableize(string, validate = true)
         r = ::ActiveSupport::Inflector.transliterate(string).gsub(/[^_a-z0-9]/i, '_')
                                       .gsub(/_+/, '_').gsub(/_\z/, '').gsub(/\A_/, '').downcase
         m = VARIABLE_NAME_PATTERN.match(r)
         return r if m
+        return nil unless validate
 
         raise ::ArgumentError, "Invalid variable name \"#{r}\" was generated " \
           "from string \"#{string}\""

data/lib/eac_ruby_utils/listable/list.rb

@@ -54,8 +54,9 @@ module EacRubyUtils
       end
 
       def value_validate!(value, error_class = ::StandardError)
-        value_valid?(value) ||
-          raise(error_class, "Invalid value: \"#{value}\" (Valid: #{values_to_s})")
+        return value if value_valid?(value)
+
+        raise(error_class, "Invalid value: \"#{value}\" (Valid: #{values_to_s})")
       end
 
       def values_to_s

data/lib/eac_ruby_utils/patches/kernel/nyi.rb

@@ -2,7 +2,9 @@
 
 module Kernel
   # Raise exception with text "Not yet implemented".
-  def nyi
-    raise "Not yet implemented (Called in #{caller.first})"
+  def nyi(message = nil)
+    s = "Not yet implemented (Called in #{caller.first})"
+    s += ": #{message}" if message
+    raise s
   end
 end

data/lib/eac_ruby_utils/patches/regexp/to_parser.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/regexp_parser'
+
+class Regexp
+  # @return [::EacRubyUtils::RegexpParser]
+  def to_parser(&block)
+    ::EacRubyUtils::RegexpParser.new(self, &block)
+  end
+end

data/lib/eac_ruby_utils/patches/string/inflector.rb

@@ -3,7 +3,9 @@
 require 'eac_ruby_utils/inflector'
 
 class String
-  def variableize
-    ::EacRubyUtils::Inflector.variableize(self)
+  # Shortcut to `EacRubyUtils::Inflector.variableize(self, ...)`.
+  # @see EacRubyUtils::Inflector.variableize
+  def variableize(validate = true)
+    ::EacRubyUtils::Inflector.variableize(self, validate)
   end
 end

data/lib/eac_ruby_utils/regexp_parser.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class RegexpParser
+    attr_reader :pattern, :builder_proc
+
+    def initialize(pattern, &builder_proc)
+      @pattern = pattern
+      @builder_proc = builder_proc
+    end
+
+    def parse(string)
+      internal_parse(string)[1]
+    end
+
+    def parse!(string)
+      match, result = internal_parse(string)
+      return result if match
+
+      raise ::ArgumentError, "String \"#{string}\" does not match pattern \"#{pattern}\""
+    end
+
+    private
+
+    def internal_parse(string)
+      m = pattern.match(string)
+      if m
+        [true, builder_proc ? builder_proc.call(m) : m]
+      else
+        [false, nil]
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/settings_provider.rb

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/string/inflections'
-require 'eac_ruby_utils/options_consumer'
+require 'eac_ruby_utils/require_sub'
 
 module EacRubyUtils
   # Provide a option by constant, method or options object.
   module SettingsProvider
+    ::EacRubyUtils.require_sub __FILE__, base: self
+
     def setting_constant_name(key, fullname = false)
-      name = key.to_s.underscore.upcase
-      name = "#{self.class.name}::#{name}" if fullname
-      name
+      setting_value_instance(key).constant_name(fullname)
     end
 
     def setting_search_order
@@ -25,41 +24,23 @@ module EacRubyUtils
     end
 
     def setting_value(key, options = {})
-      options = parse_setting_value_options(options)
-      options.order.each do |method|
-        value = send("setting_value_by_#{method}", key)
-        return value if value
-      end
-      return nil unless options.required
-
-      raise "Setting \"#{key}\" not found. Supply in #{settings_object_name}, implement a " \
-        "\"#{key}\" method or declare a #{setting_constant_name(key, true)} constant."
+      setting_value_instance(key, options).value
     end
 
     def setting_value_by_constant(key)
-      constant_name = setting_constant_name(key)
-      begin
-        self.class.const_get(constant_name)
-      rescue NameError
-        nil
-      end
+      setting_value_instance(key).value_by_constant
     end
 
     def setting_value_by_method(key)
-      respond_to?(key) ? send(key) : nil
+      setting_value_instance(key).value_by_method
     end
 
     def setting_value_by_settings_object(key)
-      settings_object[key.to_s] || settings_object[key.to_sym]
+      setting_value_instance(key).value_by_settings_object
     end
 
-    private
-
-    def parse_setting_value_options(options)
-      r = ::EacRubyUtils::OptionsConsumer.new(options).consume_all(:required, :order, ostruct: true)
-      r.required = true if r.required.nil?
-      r.order = setting_search_order if r.order.nil?
-      r
+    def setting_value_instance(key, options = {})
+      ::EacRubyUtils::SettingsProvider::SettingValue.new(self, key, options)
     end
   end
 end

data/lib/eac_ruby_utils/settings_provider/setting_value.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+require 'eac_ruby_utils/listable'
+require 'eac_ruby_utils/simple_cache'
+require 'eac_ruby_utils/struct'
+
+module EacRubyUtils
+  module SettingsProvider
+    class SettingValue
+      include ::EacRubyUtils::Listable
+      include ::EacRubyUtils::SimpleCache
+
+      attr_reader :source, :key, :options
+      lists.add_symbol :option, :default, :order, :required
+
+      def initialize(source, key, options)
+        @source = source
+        @key = key
+        @options = options
+      end
+
+      def constant_name(fullname = false)
+        name = key.to_s.underscore.upcase
+        name = "#{source.class.name}::#{name}" if fullname
+        name
+      end
+
+      def value
+        parsed_options.order.each do |method|
+          value = send("value_by_#{method}")
+          return value if value
+        end
+        return parsed_options.default if parsed_options.respond_to?(OPTION_DEFAULT)
+        return nil unless parsed_options.required
+
+        raise_key_not_found
+      end
+
+      def value_by_constant
+        source.class.const_get(constant_name)
+      rescue NameError
+        nil
+      end
+
+      def value_by_method
+        source.respond_to?(key, true) ? source.send(key) : nil
+      end
+
+      def value_by_settings_object
+        source.settings_object[key.to_s] || source.settings_object[key.to_sym]
+      end
+
+      private
+
+      def parsed_options_uncached
+        r = self.class.lists.option.hash_keys_validate!(options.symbolize_keys)
+        r[:required] = true unless r.key?(OPTION_REQUIRED)
+        r[:order] = source.setting_search_order if r[OPTION_ORDER].nil?
+        ::EacRubyUtils::Struct.new(r)
+      end
+
+      def raise_key_not_found
+        raise "Setting \"#{key}\" not found. Supply in #{source.settings_object_name}, implement "\
+          "a \"#{key}\" method or declare a #{constant_name(true)} constant."
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/simple_cache.rb

@@ -2,12 +2,18 @@
 
 module EacRubyUtils
   module SimpleCache
-    UNCACHED_METHOD_PATTERN = /\A(\s+)_uncached\z/.freeze
+    UNCACHED_METHOD_NAME_SUFFIX = '_uncached'
+    UNCACHED_METHOD_PATTERN = /\A(\s+)_#{::Regexp.quote(UNCACHED_METHOD_NAME_SUFFIX)}\z/.freeze
+
+    class << self
+      def uncached_method_name(method_name)
+        "#{method_name}#{UNCACHED_METHOD_NAME_SUFFIX}"
+      end
+    end
 
     def method_missing(method, *args, &block)
-      uncached_method = "#{method}_uncached"
-      if respond_to?(uncached_method, true)
-        call_method_with_cache(uncached_method, args, &block)
+      if respond_to?(::EacRubyUtils::SimpleCache.uncached_method_name(method), true)
+        call_method_with_cache(method, args, &block)
       else
         super
       end
@@ -35,10 +41,17 @@ module EacRubyUtils
       raise 'Não é possível realizar o cache de métodos com bloco' if block
 
       key = ([method] + args).join('@@@')
-      cache_keys[key] = send(method, *args) unless cache_keys.key?(key)
+      unless cache_keys.key?(key)
+        uncached_value = call_uncached_method(method, args)
+        cache_keys[key] = uncached_value
+      end
       cache_keys[key]
     end
 
+    def call_uncached_method(method, args)
+      send(::EacRubyUtils::SimpleCache.uncached_method_name(method), *args)
+    end
+
     def cache_keys
       @cache_keys ||= {}
     end

data/lib/eac_ruby_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.59.0
+  version: 0.63.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-21 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: filesize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -86,20 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0.2'
 description: 
 email: 
 executables: []
@@ -162,6 +170,7 @@ files:
 - 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/logs.rb
 - lib/eac_ruby_utils/fs/temp.rb
 - lib/eac_ruby_utils/fs/temp/directory.rb
 - lib/eac_ruby_utils/fs/temp/file.rb
@@ -226,6 +235,7 @@ files:
 - lib/eac_ruby_utils/patches/pathname/basename_sub.rb
 - lib/eac_ruby_utils/patches/regexp.rb
 - lib/eac_ruby_utils/patches/regexp/if_match.rb
+- lib/eac_ruby_utils/patches/regexp/to_parser.rb
 - lib/eac_ruby_utils/patches/string.rb
 - lib/eac_ruby_utils/patches/string/inflector.rb
 - lib/eac_ruby_utils/patches/time.rb
@@ -234,6 +244,7 @@ files:
 - 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/regexp_parser.rb
 - lib/eac_ruby_utils/require_sub.rb
 - lib/eac_ruby_utils/rspec.rb
 - lib/eac_ruby_utils/rspec/conditional.rb
@@ -242,6 +253,7 @@ files:
 - lib/eac_ruby_utils/ruby/command.rb
 - lib/eac_ruby_utils/ruby/on_clean_environment.rb
 - lib/eac_ruby_utils/settings_provider.rb
+- lib/eac_ruby_utils/settings_provider/setting_value.rb
 - lib/eac_ruby_utils/simple_cache.rb
 - lib/eac_ruby_utils/struct.rb
 - lib/eac_ruby_utils/templates.rb
@@ -275,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Utilities for E.A.C.'s Ruby projects.