eac_ruby_utils 0.57.1 → 0.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6469a891b6aa484b994c98c3617fc63508607703f7eeb85106d543bdfb5a17e2
-  data.tar.gz: 8724c432235e501b3e3a645caee3ac3eb42ba2d0430d870db8b06dcd5c5b2afc
+  metadata.gz: 70fe181d734d1e97b9467b44302604bb7b2a61ef3102e08aeddd1a9dd9a5d6be
+  data.tar.gz: d04e61f84fd5c9fa22bca11be939732c23e352eb019ba7a2260c5ef3012b339d
 SHA512:
-  metadata.gz: 7138140617aba1656eeaf68cce2a3a1895d9cc7f6bf9702c2d5630d71d4ca20022cb63c97bdefaae31815aaf7bfbb35d40ee2c139093c097c43f1f5819703bf8
-  data.tar.gz: f509f49102ff7360aa6d368a2558876d808d5cd78f419886304acfcadb219a54ec9a4ecaad988fad7c38f992e77d087d6b8580cb80df9a8b59ad9fc55ca30314
+  metadata.gz: ce2f14b7c8cc05f34337212a54cf4ae4d33a44fb1cfb83c1365e5c86a08e4d4bd3395c29bc4cf4a09969d25760c0340094939c804956b4a5e586caeffdfaf4e7
+  data.tar.gz: 8b243bf7a7de4cadadbd3497df8ecf8ac97fbc16bbc084d9459e12f72244963c878043eaeb95c180cee10b6ead01c044530732196cdaf13a55997431f74e2816

data/lib/eac_ruby_utils/local_time_zone.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'active_support/values/time_zone'
+
+module EacRubyUtils
+  module LocalTimeZone
+    DEBIAN_CONFIG_PATH = '/etc/timezone'
+
+    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.if_present { |v| ::ActiveSupport::TimeZone[v] } : nil
+      end
+
+      # @return [ActiveSupport::TimeZone]
+      def by_offset
+        ::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
+    end
+  end
+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.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/kernel/nyi.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Kernel
+  # Raise exception with text "Not yet implemented".
+  def nyi
+    raise "Not yet implemented (Called in #{caller.first})"
+  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/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.57.1'
+  VERSION = '0.60.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.57.1
+  version: 0.60.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -186,12 +186,14 @@ files:
 - lib/eac_ruby_utils/listable/string_list.rb
 - lib/eac_ruby_utils/listable/symbol_list.rb
 - lib/eac_ruby_utils/listable/value.rb
+- lib/eac_ruby_utils/local_time_zone.rb
 - lib/eac_ruby_utils/on_clean_ruby_environment.rb
 - lib/eac_ruby_utils/options_consumer.rb
 - lib/eac_ruby_utils/patch.rb
 - 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
@@ -200,6 +202,8 @@ files:
 - 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
+- lib/eac_ruby_utils/patches/kernel.rb
+- lib/eac_ruby_utils/patches/kernel/nyi.rb
 - lib/eac_ruby_utils/patches/module.rb
 - lib/eac_ruby_utils/patches/module/abstract_methods.rb
 - lib/eac_ruby_utils/patches/module/common_concern.rb
@@ -213,6 +217,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
@@ -224,8 +229,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/local_time_zone.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
@@ -238,6 +242,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

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

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/patches/time/local_time_zone'
-
-::Time.zone = ::Time.local_time_zone

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/time/zones'
-require 'eac_ruby_utils/envs'
-
-class Time
-  class << self
-    TIMEDATECTL_TIMEZONE_LINE_PATTERN = %r{\s*Time zone:\s*(\S+/\S+)\s}.freeze
-
-    def local_time_zone
-      local_time_zone_by_timedatectl || local_time_zone_by_offset
-    end
-
-    def local_time_zone_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] }
-    end
-
-    def local_time_zone_by_offset
-      ::ActiveSupport::TimeZone[::Time.now.getlocal.gmt_offset].name
-    end
-  end
-end