eac_tools 0.3.0 → 0.6.0

data/sub/eac_ruby_utils/lib/eac_ruby_utils/inflector.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+
+module EacRubyUtils
+  class Inflector
+    class << self
+      VARIABLE_NAME_PATTERN = /[_a-z][_a-z0-9]*/i.freeze
+
+      # 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}\""
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/listable/class_methods.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'i18n'
+require_relative 'lists'
+
+module EacRubyUtils
+  module Listable
+    module ClassMethods
+      def lists
+        @lists ||= ::EacRubyUtils::Listable::Lists.new(self)
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/listable/instance_methods.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Listable
+    module InstanceMethods
+      LISTABLE_INSTANCE_VALUE_METHODS = %w[label description].freeze
+
+      def method_missing(name, *args, &block)
+        list, method = parse_method(name)
+        list && method ? list.instance_value(self).send(method) : super
+      end
+
+      def respond_to_missing?(name, include_all = false)
+        list, method = parse_method(name)
+        list && method ? true : super
+      end
+
+      private
+
+      def parse_method(method)
+        self.class.lists.acts_as_listable_items.each do |item, list|
+          LISTABLE_INSTANCE_VALUE_METHODS.each do |m|
+            return [list, m] if method.to_s == "#{item}_#{m}"
+          end
+        end
+        [nil, nil]
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/listable/integer_list.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'list'
+
+module EacRubyUtils
+  module Listable
+    class IntegerList < ::EacRubyUtils::Listable::List
+      protected
+
+      def parse_labels(labels)
+        if labels.first.is_a?(Hash)
+          Hash[labels.first.map { |k, v| [k.to_i, v.to_s] }]
+        else
+          Hash[labels.each_with_index.map { |v, i| [i + 1, v.to_s] }]
+        end
+      end
+
+      def build_value(index, _key)
+        index + 1
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/listable/list.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/listable/value'
+
+module EacRubyUtils
+  module Listable
+    class List
+      BLANK_VALUE = nil
+      BLANK_KEY = :__blank
+
+      attr_reader :item
+
+      def initialize(lists, item, labels)
+        @lists = lists
+        @item = item
+        @values = build_values(labels)
+        apply_constants
+      end
+
+      def blank_value
+        @blank_value ||= ::EacRubyUtils::Listable::Value.new(self, BLANK_VALUE, BLANK_KEY, false)
+      end
+
+      def each_value(&block)
+        values.each(&block)
+      end
+
+      def values
+        @values.values.map(&:value)
+      end
+
+      def options
+        @values.values.map { |v| [v.label, v.value] }
+      end
+
+      def method_missing(name, *args, &block)
+        list = find_list_by_method(name)
+        list || super
+      end
+
+      def respond_to_missing?(name, include_all = false)
+        find_list_by_method(name) || super
+      end
+
+      def hash_keys_validate!(hash, error_class = ::StandardError)
+        hash.each_key { |key| value_validate!(key, error_class) }
+        hash
+      end
+
+      def i18n_key
+        "eac_ruby_utils.listable.#{class_i18n_key}.#{item}"
+      end
+
+      # @return [EacRubyUtils::Listable::Value, nil]
+      def instance_value(instance)
+        v = instance.send(item)
+        return blank_value if v.blank?
+        return @values[v] if @values.key?(v)
+
+        raise "List value unkown: \"#{v}\" (Source: #{@lists.source}, Item: #{item}, Instance: " \
+          "#{instance.to_debug}, Values: #{@values.keys})"
+      end
+
+      def value_valid?(value)
+        values.include?(value)
+      end
+
+      def value_validate!(value, error_class = ::StandardError)
+        return value if value_valid?(value)
+
+        raise(error_class, "Invalid value: \"#{value}\" (Valid: #{values_to_s})")
+      end
+
+      def values_to_s
+        values.map { |v| "\"#{v}\"" }.join(', ')
+      end
+
+      private
+
+      def class_i18n_key
+        @lists.source.name.underscore.to_sym
+      end
+
+      def find_list_by_method(method)
+        @values.each_value do |v|
+          return v if method.to_s == "value_#{v.key}"
+        end
+        nil
+      end
+
+      def constants
+        labels.each_with_index.map { |v, i| ["#{item.upcase}_#{v.upcase}", values[i]] }
+      end
+
+      def apply_constants
+        @values.each_value do |v|
+          @lists.source.const_set(v.constant_name, v.value)
+        end
+      end
+
+      def build_values(labels)
+        vs = {}
+        parse_labels(labels).each do |value, key|
+          v = Value.new(self, value, key)
+          vs[v.value] = v
+        end
+        vs
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/listable/lists.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/string/inflections'
+require_relative 'integer_list'
+require_relative 'string_list'
+require_relative 'symbol_list'
+
+module EacRubyUtils
+  module Listable
+    class Lists
+      attr_reader :source
+
+      def initialize(source)
+        @source = source
+      end
+
+      %w[integer string symbol].each do |list_type|
+        define_method "add_#{list_type}" do |item, *labels|
+          add(::EacRubyUtils::Listable.const_get("#{list_type}_list".camelize), item, labels)
+        end
+      end
+
+      def method_missing(name, *args, &block)
+        list = find_list_by_method(name)
+        list || super
+      end
+
+      def respond_to_missing?(name, include_all = false)
+        find_list_by_method(name) || super
+      end
+
+      def acts_as_listable_items
+        @acts_as_listable_items ||= ActiveSupport::HashWithIndifferentAccess.new
+      end
+
+      private
+
+      def add(list_class, item, labels)
+        check_acts_as_listable_new_item(item)
+        acts_as_listable_items[item] = list_class.new(self, item, labels)
+      end
+
+      def check_acts_as_listable_new_item(item)
+        return unless acts_as_listable_items.key?(item)
+
+        raise "Item já adicionado anteriormente: #{item} em #{self} " \
+          "(#{acts_as_listable_items.keys})"
+      end
+
+      def find_list_by_method(method)
+        acts_as_listable_items.each do |item, list|
+          return list if method.to_sym == item.to_sym
+        end
+        nil
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/listable/string_list.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'list'
+
+module EacRubyUtils
+  module Listable
+    class StringList < ::EacRubyUtils::Listable::List
+      protected
+
+      def parse_labels(labels)
+        if labels.first.is_a?(Hash)
+          Hash[labels.first.map { |k, v| [k.to_s, v.to_s] }]
+        else
+          Hash[labels.map { |v| [v.to_s, v.to_s] }]
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/listable/symbol_list.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'list'
+
+module EacRubyUtils
+  module Listable
+    class SymbolList < ::EacRubyUtils::Listable::List
+      protected
+
+      def parse_labels(labels)
+        if labels.first.is_a?(Hash)
+          Hash[labels.first.map { |k, v| [k.to_sym, v.to_sym] }]
+        else
+          Hash[labels.map { |v| [v.to_sym, v.to_sym] }]
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/listable/value.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/inflector'
+
+module EacRubyUtils
+  module Listable
+    class Value
+      attr_reader :value, :key
+
+      def initialize(list, value, key, translation_required = true)
+        @list = list
+        @value = value
+        @key = key
+        @translation_required = translation_required
+      end
+
+      def to_s
+        "I: #{@list.item}, V: #{@value}, K: #{@key}"
+      end
+
+      def constant_name
+        ::EacRubyUtils::Inflector.variableize("#{@list.item}_#{@key}").upcase
+      end
+
+      def label
+        translate('label')
+      end
+
+      def description
+        translate('description')
+      end
+
+      def translation_required?
+        @translation_required
+      end
+
+      private
+
+      def translate(translate_key)
+        full_translate_key = "#{@list.i18n_key}.#{@key}.#{translate_key}"
+        if !::I18n.exists?(full_translate_key) && !translation_required?
+          ''
+        else
+          ::I18n.t(full_translate_key)
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/listable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+Dir["#{__dir__}/#{::File.basename(__FILE__, '.*')}/*.rb"].sort.each do |partial|
+  require partial
+end
+
+module EacRubyUtils
+  module Listable
+    extend ActiveSupport::Concern
+
+    included do
+      extend(ClassMethods)
+      include(InstanceMethods)
+    end
+  end
+end

data/sub/eac_ruby_utils/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/sub/eac_ruby_utils/lib/eac_ruby_utils/locales/from_all_gems.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/locales/from_gem'
+::EacRubyUtils::Locales::FromGem.include_all

data/sub/eac_ruby_utils/lib/eac_ruby_utils/locales/from_gem.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'i18n'
+require 'eac_ruby_utils/patches/class/common_constructor'
+require 'eac_ruby_utils/patches/object/to_pathname'
+
+module EacRubyUtils
+  module Locales
+    class FromGem
+      class << self
+        def include_all(i18n_obj = nil)
+          ::Gem::Specification.each { |gemspec| new(gemspec, i18n_obj).include }
+        end
+      end
+
+      LOCALES_DIR_SUBPATH = 'locale'
+      LOCALES_FILES_GLOB_PATTERNS = %w[*.yaml *.yml].freeze
+
+      common_constructor :gemspec, :i18n_obj, default: [nil] do
+        self.i18n_obj ||= ::I18n
+      end
+
+      # @return [Boolean]
+      delegate :exist?, to: :path
+
+      # @return [Pathname, nil]
+      def include
+        return nil unless exist?
+
+        ::I18n.load_path += paths_to_load.map(&:to_path)
+        path
+      end
+
+      # @return [Pathname]
+      def path
+        gemspec.gem_dir.to_pathname.join(LOCALES_DIR_SUBPATH)
+      end
+
+      # @return [Pathname]
+      def paths_to_load
+        return [] unless exist?
+
+        LOCALES_FILES_GLOB_PATTERNS.inject([]) { |a, e| a + path.glob(e) }
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/locales/module_i18n_translate.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+require 'eac_ruby_utils/common_constructor'
+require 'i18n'
+
+module EacRubyUtils
+  module Locales
+    class ModuleI18nTranslate
+      TRANSLATE_LOCALE_KEY = :__locale
+
+      common_constructor :the_module, :entry_suffix, :values, default: [{}]
+
+      def ancestor_i18n_translate(ancestor)
+        t = self.class.new(ancestor, entry_suffix, values)
+        t.exists? ? t.i18n_translate : nil
+      end
+
+      def ancestors_i18n_translate
+        the_module.ancestors.lazy.map { |v| ancestor_i18n_translate(v) }.find(&:present?)
+      end
+
+      def exists?
+        ::I18n.exists?(i18n_key)
+      end
+
+      def i18n_key
+        "#{module_entry_prefix}.#{entry_suffix}"
+      end
+
+      def i18n_options
+        values.except(TRANSLATE_LOCALE_KEY)
+      end
+
+      def i18n_translate
+        ::I18n.translate(i18n_key, i18n_options)
+      end
+
+      def locale
+        values[TRANSLATE_LOCALE_KEY]
+      end
+
+      def module_entry_prefix
+        the_module.name.underscore.gsub('/', '.')
+      end
+
+      def on_locale(&block)
+        if locale.present?
+          on_present_locale(&block)
+        else
+          block.call
+        end
+      end
+
+      def result
+        on_locale do
+          ancestors_i18n_translate || i18n_translate
+        end
+      end
+
+      private
+
+      def on_present_locale(&block)
+        old_locale = ::I18n.locale
+        begin
+          ::I18n.locale = locale
+          block.call
+        ensure
+          ::I18n.locale = old_locale
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/locales.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+
+module EacRubyUtils
+  module Locales
+    ::EacRubyUtils.require_sub __FILE__
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/method_class.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/introspection'
+require 'eac_ruby_utils/patches/class/common_constructor'
+require 'eac_ruby_utils/patches/module/common_concern'
+require 'eac_ruby_utils/patches/string/inflector'
+
+module EacRubyUtils
+  module MethodClass
+    common_concern do
+      ::EacRubyUtils::MethodClass::Setup.new(self)
+    end
+
+    class Setup
+      common_constructor :method_class do
+        perform
+      end
+
+      def perform
+        the_setup = self
+        sender_module.define_method(method_name) do |*args, &block|
+          the_setup.method_class.new(self, *args, &block).result
+        end
+      end
+
+      def method_name
+        method_class.name.demodulize.underscore.variableize
+      end
+
+      def sender_module
+        method_class.module_parent
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/options_consumer.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'ostruct'
+
+module EacRubyUtils
+  class OptionsConsumer
+    DEFAULT_OPTIONS = { validate: true, ostruct: false }.with_indifferent_access.freeze
+
+    def initialize(data)
+      @data = data.with_indifferent_access
+    end
+
+    def consume(key, default_value = nil, &block)
+      return default_value unless data.key?(key)
+
+      value = data.delete(key)
+      value = yield(value) if block
+      value
+    end
+
+    # If last argument is a Hash it is used a options.
+    # Options:
+    # * +validate+: validate after consume.
+    # * +ostruct+: return a [OpenStruct] instead a [Hash].
+    # @return [Hash] (Default) or [OpenStruct].
+    def consume_all(*keys)
+      options = consume_all_extract_options(keys)
+      result = consume_all_build_result(keys, options.fetch(:ostruct))
+      validate if options.fetch(:validate)
+      result
+    end
+
+    def validate
+      return if data.empty?
+
+      raise "Invalid keys: #{data.keys}"
+    end
+
+    def left_data
+      data.dup
+    end
+
+    private
+
+    attr_reader :data
+
+    def consume_all_extract_options(keys)
+      options = DEFAULT_OPTIONS
+      options = options.merge(keys.pop.with_indifferent_access) if keys.last.is_a?(Hash)
+      options
+    end
+
+    def consume_all_build_result(keys, ostruct)
+      if ostruct
+        ::OpenStruct.new(keys.map { |key| [key, consume(key)] }.to_h)
+      else
+        keys.map { |key| consume(key) }
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patch.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class << self
+    def patch(target, patch)
+      return if target.included_modules.include?(patch)
+
+      target.send(:include, patch)
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/class/abstract.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/abstract_methods'
+
+class Class
+  def abstract?
+    ::EacRubyUtils::AbstractMethods.abstract?(self)
+  end
+end