eac_ruby_utils 0.58.0 → 0.62.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 123493b4c18d48f7366d734db4d722e0e72dd1ac0463649a45a3552c5bc8b6b7
-  data.tar.gz: 5858bc58b340efed7d26cf17695535a3fb26abbb121f53c4889d6f87c9f03a25
+  metadata.gz: c935490ddb854abc0f1aa8e473a020d6636aca5805a1312849cc3be308140798
+  data.tar.gz: '00932149f86866358f22288a3e4aa434d59b4164140ce76dda55b9f88d310bd1'
 SHA512:
-  metadata.gz: 7b3c80642b58e8eb315ca82d8d760467a7404585771907a9dbe3344e3aa3b00991e7d319beee042ee45eb36939cf93af35e38f76bd0d1642a7e9b383bdf3f023
-  data.tar.gz: d4dc7641afd5d36e818fcfe0e50f59c6f0cb2dd596fef6a7cf4fc31e0b19929638232669bf3f60e4c9da6a42616610517633f69bd7363d05120cf5b8a5192b0c
+  metadata.gz: fe63c4031d9240b8bc18dfa3b4ff39edac9465c1056971feadeb9338f8c2e4a59836fdafc5268c35dcc4158348c84c50da255b7b4e320554f56e73300b83e4e6
+  data.tar.gz: ecb86c9203690924b8263e5934f093bbf53e2218bf9b2019ccb188afc896e3ffcc21abd8565c1641bc1ab94936f909870f80413e232161092076b4163c53bab4

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/local_time_zone.rb

@@ -10,26 +10,36 @@ module EacRubyUtils
     class << self
       TIMEDATECTL_TIMEZONE_LINE_PATTERN = %r{\s*Time zone:\s*(\S+/\S+)\s}.freeze
 
+      # @return [ActiveSupport::TimeZone]
       def auto
         %w[tz_env debian_config offset].lazy.map { |s| send("by_#{s}") }.find(&:present?)
       end
 
+      def auto_set
+        ::Time.zone = auto
+      end
+
+      # @return [ActiveSupport::TimeZone]
       def by_debian_config
         path = ::Pathname.new(DEBIAN_CONFIG_PATH)
-        path.exist? ? path.read.strip.presence : nil
+        path.exist? ? path.read.strip.if_present { |v| ::ActiveSupport::TimeZone[v] } : nil
       end
 
+      # @return [ActiveSupport::TimeZone]
       def by_offset
-        ::ActiveSupport::TimeZone[::Time.now.getlocal.gmt_offset].name
+        ::ActiveSupport::TimeZone[::Time.now.getlocal.gmt_offset]
       end
 
+      # @return [ActiveSupport::TimeZone]
       def by_timedatectl
         executable = ::EacRubyUtils::Envs.local.executable('timedatectl', '--version')
         return nil unless executable.exist?
 
         TIMEDATECTL_TIMEZONE_LINE_PATTERN.if_match(executable.command.execute!) { |m| m[1] }
+                                         .if_present { |v| ::ActiveSupport::TimeZone[v] }
       end
 
+      # @return [ActiveSupport::TimeZone]
       def by_tz_env
         ENV['TZ'].presence
       end

data/lib/eac_ruby_utils/patches/class/settings_provider.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patch'
+require 'eac_ruby_utils/settings_provider'
+
+class Class
+  def enable_settings_provider
+    ::EacRubyUtils.patch(self, ::EacRubyUtils::SettingsProvider)
+  end
+end

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/object/if_nil.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Object
+  # @return +block.call(self)+ if +self+ is not nil, +default_value+ otherwise.
+  def if_not_nil(default_value = nil)
+    return default_value if nil?
+
+    block_given? ? yield(self) : self
+  end
+
+  # @return +yield+ if +self+ is nil, +self+ otherwise.
+  def if_nil
+    return yield if nil? && block_given?
+
+    self
+  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/patches/time/required_zone.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/local_time_zone'
+
+class Time
+  class << self
+    def required_zone
+      zone || ::EacRubyUtils::LocalTimeZone.auto || raise('No zone set or discovered')
+    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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.58.0
+  version: 0.62.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-17 00:00:00.000000000 Z
+date: 2021-03-28 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
@@ -162,6 +176,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
@@ -193,6 +208,7 @@ files:
 - lib/eac_ruby_utils/patches.rb
 - lib/eac_ruby_utils/patches/class.rb
 - lib/eac_ruby_utils/patches/class/common_constructor.rb
+- lib/eac_ruby_utils/patches/class/settings_provider.rb
 - lib/eac_ruby_utils/patches/enumerable.rb
 - lib/eac_ruby_utils/patches/enumerable/boolean_combinations.rb
 - lib/eac_ruby_utils/patches/enumerator.rb
@@ -216,6 +232,7 @@ files:
 - 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_nil.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
@@ -227,7 +244,7 @@ files:
 - lib/eac_ruby_utils/patches/string.rb
 - lib/eac_ruby_utils/patches/string/inflector.rb
 - lib/eac_ruby_utils/patches/time.rb
-- lib/eac_ruby_utils/patches/time/default_time_zone_set.rb
+- lib/eac_ruby_utils/patches/time/required_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
@@ -240,6 +257,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
@@ -273,7 +291,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.

data/lib/eac_ruby_utils/patches/time/default_time_zone_set.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/time/zones'
-require 'eac_ruby_utils/local_time_zone'
-
-::Time.zone = ::EacRubyUtils::LocalTimeZone.auto