eac_tools 0.119.0 → 0.120.0

data/sub/eac_ruby_utils/lib/eac_ruby_utils/common_concern/module_setup.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'eac_ruby_utils/common_concern/class_setup'
+require 'memoized'
+require 'eac_ruby_utils/patches/object/if_present'
+
+module EacRubyUtils
+  class CommonConcern
+    class ModuleSetup
+      include ::Memoized
+
+      attr_reader :a_module, :common_concern
+
+      def initialize(common_concern, a_module)
+        @common_concern = common_concern
+        @a_module = a_module
+      end
+
+      def run
+        a_module.extend(::ActiveSupport::Concern)
+        include_or_prepend(:included, :include)
+        include_or_prepend(:prepended, :prepend)
+      end
+
+      private
+
+      def include_or_prepend(module_method, class_setup_method)
+        setup = self
+        a_module.send(module_method, *a_module_method_args(module_method)) do
+          ::EacRubyUtils::CommonConcern::ClassSetup.new(setup, self, class_setup_method).run
+        end
+      end
+
+      def a_module_method_args(module_method)
+        method_arity = a_module.method(module_method).arity
+        method_arity = -method_arity - 1 if method_arity.negative?
+        method_arity.times.map { |_n| a_module }
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/common_concern.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/common_concern/module_setup'
+
+module EacRubyUtils
+  class CommonConcern
+    CLASS_METHODS_MODULE_NAME = 'ClassMethods'
+    INSTANCE_METHODS_MODULE_NAME = 'InstanceMethods'
+
+    attr_reader :after_callback
+
+    def initialize(&after_callback)
+      @after_callback = after_callback
+    end
+
+    def setup(a_module)
+      ::EacRubyUtils::CommonConcern::ModuleSetup.new(self, a_module).run
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/common_constructor/class_accessors.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/common_constructor/instance_initialize'
+require 'eac_ruby_utils/common_constructor/super_args'
+
+module EacRubyUtils
+  class CommonConstructor
+    class ClassAccessors
+      attr_reader :common_constructor, :klass
+
+      def initialize(common_constructor, klass)
+        @common_constructor = common_constructor
+        @klass = klass
+      end
+
+      def args
+        common_constructor.all_args
+      end
+
+      def perform
+        setup_class_attr_readers
+        setup_class_attr_writers
+      end
+
+      def setup_class_attr_readers
+        klass.send(:attr_reader, *args)
+        klass.send(:public, *args) if args.any?
+      end
+
+      def setup_class_attr_writers
+        klass.send(:attr_writer, *args)
+        klass.send(:private, *args.map { |a| "#{a}=" }) if args.any?
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/common_constructor/class_initialize.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/common_constructor/instance_initialize'
+require 'eac_ruby_utils/common_constructor/super_args'
+
+module EacRubyUtils
+  class CommonConstructor
+    class ClassInitialize
+      attr_reader :common_constructor, :klass
+
+      def initialize(common_constructor, klass)
+        @common_constructor = common_constructor
+        @klass = klass
+      end
+
+      def define_initialize_callbacks
+        klass.include(::ActiveSupport::Callbacks)
+        klass.define_callbacks :initialize
+      end
+
+      def define_initialize_method
+        class_initialize = self
+        klass.send(:define_method, :initialize) do |*args, &block|
+          ::EacRubyUtils::CommonConstructor::InstanceInitialize.new(
+            class_initialize.common_constructor, args, self, block
+          ).perform
+          super(*::EacRubyUtils::CommonConstructor::SuperArgs.new(
+            class_initialize, args, self
+          ).result)
+        end
+      end
+
+      def perform
+        define_initialize_callbacks
+        define_initialize_method
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/common_constructor/instance_initialize.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class CommonConstructor
+    class InstanceInitialize
+      attr_reader :common_constructor, :args, :object, :block
+
+      def initialize(common_constructor, args, object, block)
+        @common_constructor = common_constructor
+        @args = args
+        @object = object
+        @block = block
+      end
+
+      def perform
+        validate_args_count
+        object.run_callbacks :initialize do
+          object_attributes_set
+          object_block_set
+          object_after_callback
+        end
+      end
+
+      private
+
+      def arg_value(arg_name)
+        arg_index = common_constructor.args.index(arg_name)
+        if arg_index < args.count
+          args[arg_index]
+        else
+          common_constructor.default_values[arg_index - common_constructor.args_count_min]
+        end
+      end
+
+      def object_after_callback
+        return unless common_constructor.after_set_block
+
+        object.instance_eval(&common_constructor.after_set_block)
+      end
+
+      def object_attribute_set(attr_name, attr_value)
+        object.send("#{attr_name}=", attr_value)
+      end
+
+      def object_attributes_set
+        common_constructor.args.each do |arg_name|
+          object_attribute_set(arg_name, arg_value(arg_name))
+        end
+      end
+
+      def object_block_set
+        block_arg = common_constructor.block_arg
+        object_attribute_set(block_arg, block) if block_arg
+      end
+
+      def validate_args_count
+        return if common_constructor.args_count.include?(args.count)
+
+        raise ArgumentError, "#{object.class}.initialize: wrong number of arguments " \
+                             "(given #{args.count}, expected #{common_constructor.args_count})"
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/common_constructor/super_args.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+
+module EacRubyUtils
+  class CommonConstructor
+    class SuperArgs
+      attr_reader :class_initialize, :args, :object
+
+      delegate :common_constructor, to: :class_initialize
+
+      def initialize(class_initialize, args, object)
+        @class_initialize = class_initialize
+        @args = args
+        @object = object
+      end
+
+      def auto_result
+        r = []
+        sub_args.each do |name, value|
+          i = super_arg_index(name)
+          r[i] = value if i
+        end
+        r
+      end
+
+      def result
+        result_from_options || auto_result
+      end
+
+      def result_from_options
+        return unless common_constructor.super_args
+
+        object.instance_exec(&common_constructor.super_args)
+      end
+
+      def sub_args
+        common_constructor.args.each_with_index.to_h do |name, index|
+          [name, args[index]]
+        end
+      end
+
+      def super_arg_index(name)
+        super_method.parameters.each_with_index do |arg, index|
+          return index if arg[1] == name
+        end
+        nil
+      end
+
+      def super_method
+        class_initialize.klass.superclass&.instance_method(:initialize)
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/common_constructor.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'active_support/callbacks'
+require 'eac_ruby_utils/arguments_consumer'
+require 'eac_ruby_utils/common_constructor/class_accessors'
+require 'eac_ruby_utils/common_constructor/class_initialize'
+require 'eac_ruby_utils/patches/object/call_if_proc'
+
+module EacRubyUtils
+  class CommonConstructor
+    attr_reader :all_args, :options, :after_set_block
+
+    class << self
+      def parse_args_options(args)
+        result = ::Struct.new(:args, :options).new([], {})
+        options_reached = false
+        args.each do |arg|
+          raise "Options reached and there is more arguments (Arguments: #{args})" if
+          options_reached
+
+          options_reached = parse_arg_options_process_arg(result, arg)
+        end
+        result
+      end
+
+      private
+
+      def parse_arg_options_process_arg(result, arg) # rubocop:disable Naming/PredicateMethod
+        if arg.is_a?(::Hash)
+          result.options = arg
+          true
+        else
+          result.args << arg
+          false
+        end
+      end
+    end
+
+    def initialize(*args, &after_set_block)
+      args_processed = self.class.parse_args_options(args)
+      @all_args = args_processed.args
+      @options = args_processed.options
+      @after_set_block = after_set_block
+    end
+
+    def args
+      block_arg? ? all_args[0..-2] : all_args
+    end
+
+    def args_count
+      (args_count_min..args_count_max)
+    end
+
+    def args_count_min
+      args.count - default_values.count
+    end
+
+    def args_count_max
+      args.count
+    end
+
+    def block_arg
+      block_arg? ? all_args.last : nil
+    end
+
+    def block_arg?
+      options[:block_arg] || false
+    end
+
+    # @return [Enumerable]
+    def default_values
+      options[:default].call_if_proc || []
+    end
+
+    def setup_class(klass)
+      setup_class_accessors(klass)
+
+      setup_class_initialize(klass)
+
+      klass
+    end
+
+    def setup_class_accessors(klass)
+      ::EacRubyUtils::CommonConstructor::ClassAccessors.new(self, klass).perform
+    end
+
+    def setup_class_initialize(klass)
+      ::EacRubyUtils::CommonConstructor::ClassInitialize.new(self, klass).perform
+    end
+
+    def super_args
+      options[:super_args]
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/compact.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class Compact
+    ATTRIBUTE_SEPARATOR = '.'
+
+    attr_reader :object, :attributes
+
+    def initialize(object, attributes)
+      @object = object
+      @attributes = attributes
+    end
+
+    # @param attr_path [String, Symbol] A path separated by +ATTRIBUTE_SEPARATOR+.
+    # @return [Object]
+    def attribute_value(attr_path)
+      attr_path.to_s.split(ATTRIBUTE_SEPARATOR).inject(object) do |a, e|
+        a.send(e)
+      end
+    end
+
+    # @return [Array]
+    def to_a
+      attributes.map { |attr| attribute_value(attr) }
+    end
+
+    # @return [Hash]
+    def to_h
+      attributes.to_h { |attr| [attr.to_sym, attribute_value(attr)] }
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/compare_by.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/common_concern/module_setup'
+
+module EacRubyUtils
+  class CompareBy
+    attr_reader :fields
+
+    def initialize(fields)
+      @fields = fields
+    end
+
+    def apply(klass)
+      pself = self
+      klass.include(::Comparable)
+      %i[<=> eql?].each do |cmp_method|
+        klass.define_method(cmp_method) do |other|
+          pself.object_values(self).send(cmp_method, pself.object_values(other))
+        end
+      end
+      klass.define_method(:hash) { pself.object_values(self).hash }
+    end
+
+    def object_values(object)
+      fields.map { |field| object.send(field) }
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/context.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class Context
+    delegate :any?, to: :stack
+
+    def current
+      optional_current || raise('No elements in context')
+    end
+
+    def optional_current
+      stack.last
+    end
+
+    delegate :pop, to: :stack
+    delegate :push, to: :stack
+
+    def on(obj)
+      push(obj)
+      begin
+        yield
+      ensure
+        pop
+      end
+    end
+
+    private
+
+    def stack
+      @stack ||= []
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/contextualizable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/context'
+
+module EacRubyUtils
+  module Contextualizable
+    common_concern
+
+    module ClassMethods
+      def context
+        @context ||= ::EacRubyUtils::Context.new
+      end
+    end
+
+    module InstanceMethods
+      delegate :context, to: :class
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/core_ext.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/locales/from_all_gems'
+require 'eac_ruby_utils/patches'
+require 'active_support'
+require 'active_support/core_ext'

data/sub/eac_ruby_utils/lib/eac_ruby_utils/custom_format.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  # A formatter like [String.sprintf].
+  class CustomFormat
+    TYPE_PATTERN = /[a-zA-Z]/
+    SEQUENCE_PATTERN = /(?<!%)%(#{TYPE_PATTERN})/
+
+    attr_reader :mapping
+
+    def initialize(mapping)
+      @mapping = mapping.transform_keys(&:to_sym).freeze
+    end
+
+    def format(string)
+      ::EacRubyUtils::CustomFormat::String.new(self, string)
+    end
+
+    class String
+      attr_reader :format, :string
+
+      def initialize(format, string)
+        @format = format
+        @string = string
+      end
+
+      def mapping
+        @mapping ||= format.mapping.slice(*sequences)
+      end
+
+      def sequences
+        @sequences ||= string.scan(SEQUENCE_PATTERN).map(&:first).uniq.map(&:to_sym)
+      end
+
+      def source_object_value(object, method)
+        return object.send(method) if object.respond_to?(method)
+        return object[method] if object.respond_to?('[]')
+
+        raise ::ArgumentError, "Methods \"#{method}\" or \"[]\" not found for #{object}"
+      end
+
+      def with(source_object)
+        r = string
+        mapping.each do |key, method|
+          r = r.gsub(/%#{::Regexp.quote(key)}/, source_object_value(source_object, method).to_s)
+        end
+        r.gsub('%%', '%')
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/enum.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/inflector'
+
+module EacRubyUtils
+  # Similar to Java's enum type (https://docs.oracle.com/javase/tutorial/java/javaOO/enum.html).
+  class Enum
+    class << self
+      def enum(key, *args, &)
+        value = Value.new(self, key, args, &)
+        raise ::ArgumentError, "#{self} already has a value with key=#{value.key}" if
+          value_set.include?(value)
+
+        value_set << value.apply
+
+        self
+      end
+
+      def values
+        value_set.map(&:value)
+      end
+
+      private
+
+      def value_set
+        @value_set ||= []
+      end
+    end
+
+    attr_reader :key
+
+    protected
+
+    def initialize(key)
+      @key = key
+    end
+
+    class Value
+      include ::Comparable
+
+      attr_reader :klass, :key, :args, :block
+
+      def initialize(klass, key, args, &block)
+        @klass = klass
+        @key = ::EacRubyUtils::Inflector.variableize(key.to_s).to_sym
+        @args = args
+        @block = block
+      end
+
+      def <=>(other)
+        key <=> other.key
+      end
+
+      def apply
+        define_constant
+        define_class_method
+
+        self
+      end
+
+      # @return [String]
+      def class_method_name
+        key.to_s
+      end
+
+      # @return [String]
+      def constant_name
+        class_method_name.upcase
+      end
+
+      def value
+        @value ||= uncached_value
+      end
+
+      private
+
+      def define_class_method
+        the_value = self
+        klass.define_singleton_method(class_method_name) { the_value.value }
+      end
+
+      def define_constant
+        klass.const_set(constant_name, value)
+      end
+
+      def uncached_value
+        klass.new(key, *value_args)
+      end
+
+      def value_args
+        r = if block
+              block.call
+            elsif args.one? && args.first.is_a?(::Enumerable)
+              args.first
+            else
+              args
+            end
+        r.is_a?(::Enumerable) ? r : [r]
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/enumerables_methods.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patches/object/debug'
+
+module EacRubyUtils
+  module EnumerablesMethods
+    class << self
+      WRITE_METHOD_PATTERNS = [/\A[a-z].*[!=]\z/i] +
+                              %i[\[\]= <<].map { |m| /\A#{::Regexp.quote(m)}\z/ } +
+                              %i[add clear delete divide keep reset shift subtract]
+                                .map { |m| /\A#{::Regexp.quote(m)}.*\z/ }
+
+      # @param klass [Klass]
+      # @return [Enumerable<Symbol>]
+      def self_methods_names(klass)
+        (klass.public_instance_methods - klass.superclass.public_instance_methods).sort
+      end
+
+      # @param method_name [Symbol]
+      # @return [Boolean]
+      def write_method?(method_name)
+        WRITE_METHOD_PATTERNS.any? { |pattern| pattern.match?(method_name.to_s) }
+      end
+    end
+
+    ARRAY_METHODS = self_methods_names(::Array)
+    ARRAY_WRITE_METHODS = ARRAY_METHODS.select { |m| write_method?(m) }
+    ARRAY_READ_METHODS = ARRAY_METHODS - ARRAY_WRITE_METHODS
+
+    ENUMERABLE_METHODS = ::Enumerable.public_instance_methods.sort
+    ENUMERABLE_WRITE_METHODS = ENUMERABLE_METHODS.select { |m| write_method?(m) }
+    ENUMERABLE_READ_METHODS = ENUMERABLE_METHODS - ENUMERABLE_WRITE_METHODS
+
+    HASH_METHODS = self_methods_names(::Hash)
+    HASH_WRITE_METHODS = HASH_METHODS.select { |m| write_method?(m) }
+    HASH_READ_METHODS = HASH_METHODS - HASH_WRITE_METHODS
+
+    SET_METHODS = self_methods_names(::Set)
+    SET_WRITE_METHODS = SET_METHODS.select { |m| write_method?(m) } + [:merge]
+    SET_READ_METHODS = SET_METHODS - SET_WRITE_METHODS
+  end
+end