eac_tools 0.89.0 → 0.90.0

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,93 @@
+# 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'
+
+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)
+        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
+
+    def default_values
+      options[:default] || []
+    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,21 @@
+# 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
+      def context
+        self.class.context
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/locales/from_all_gems'
+require 'eac_ruby_utils/patches'
+require 'active_support/dependencies/autoload'
+require 'active_support/core_ext'
+require 'active_support/json'

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  # A formatter like [String.sprintf].
+  class CustomFormat
+    TYPE_PATTERN = /[a-zA-Z]/.freeze
+    SEQUENCE_PATTERN = /(?<!%)%(#{TYPE_PATTERN})/.freeze
+
+    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.select do |k, _v|
+          sequences.include?(k)
+        end
+      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, &block)
+        value = Value.new(self, key, args, &block)
+        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.count == 1 && 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

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/base_command/append_command_options.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'shellwords'
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      class AppendCommandOptions
+        enable_method_class
+        common_constructor :command, :command_line, :options
+
+        def result
+          r = command_line
+          r = "#{input.command} | #{r}" if input
+          r = "cat #{Shellwords.escape(input_file)} | #{r}" if input_file
+          r += " > #{Shellwords.escape(output_file)}" if output_file
+          r
+        end
+
+        # @return [EacRubyUtils::Envs::Command, nil]
+        def input
+          options[:input]
+        end
+
+        # @return [Pathname,  nil]
+        def input_file
+          options[:input_file].if_present(&:to_pathname)
+        end
+
+        # @return [Pathname, nil]
+        def output_file
+          options[:output_file].if_present(&:to_pathname)
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/base_command/concat.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/struct'
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      module Concat
+        AND_OPERATOR = '&&'
+        BEFORE_OPERATOR = ';'
+        OR_OPERATOR = '||'
+        PIPE_OPERATOR = '|'
+
+        # @param operator [Symbol]
+        # @return [EacRubyUtils::Envs::CompositeCommand]
+        def concat(operator, other_command)
+          require 'eac_ruby_utils/envs/composite_command'
+          ::EacRubyUtils::Envs::CompositeCommand.new(operator, self, other_command)
+        end
+
+        # @return [EacRubyUtils::Envs::Command]
+        def and(other_command)
+          concat(AND_OPERATOR, other_command)
+        end
+
+        # @return [EacRubyUtils::Envs::Command]
+        def before(other_command)
+          concat(BEFORE_OPERATOR, other_command)
+        end
+
+        def or(other_command)
+          concat(OR_OPERATOR, other_command)
+        end
+
+        def pipe(other_command)
+          concat(PIPE_OPERATOR, other_command)
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/base_command/debugging.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      module Debugging
+        def debug?
+          ENV['DEBUG'].to_s.strip != ''
+        end
+
+        # Print a message if debugging is enabled.
+        def debug_print(message)
+          message = message.to_s
+          puts message.if_respond(:light_red, message) if debug?
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/base_command/execution.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/envs/execution_error'
+require 'eac_ruby_utils/envs/execution_result'
+require 'eac_ruby_utils/envs/process'
+require 'eac_ruby_utils/envs/spawn'
+require 'pp'
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      module Execution
+        def execute!(options = {})
+          options[:exit_outputs] = status_results.merge(options[:exit_outputs].presence || {})
+          er = ::EacRubyUtils::Envs::ExecutionResult.new(execute(options), options)
+          return er.result if er.success?
+
+          raise ::EacRubyUtils::Envs::ExecutionError,
+                "execute! command failed: #{self}\n#{er.r.pretty_inspect}"
+        end
+
+        def execute(options = {})
+          c = command(options)
+          debug_print("BEFORE: #{c}")
+          t1 = Time.now
+          r = ::EacRubyUtils::Envs::Process.new(c).to_h
+          i = Time.now - t1
+          debug_print("AFTER [#{i}]: #{c}")
+          r
+        end
+
+        def spawn(options = {})
+          c = command(options)
+          debug_print("SPAWN: #{c}")
+          ::EacRubyUtils::Envs::Spawn.new(c)
+        end
+
+        def system!(options = {})
+          return if system(options)
+
+          raise ::EacRubyUtils::Envs::ExecutionError, "system! command failed: #{self}"
+        end
+
+        def system(options = {})
+          c = command(options)
+          debug_print(c)
+          Kernel.system(c)
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/base_command/extra_options.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/object/blank'
+require 'shellwords'
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      module ExtraOptions
+        # @return [ActiveSupport::HashWithIndifferentAccess]
+        def extra_options
+          @extra_options ||= {}.with_indifferent_access
+        end
+
+        def status_result(status_code, result)
+          duplicate_by_extra_options(status_results: status_results.merge(status_code => result))
+        end
+
+        private
+
+        def status_results
+          extra_options[:status_results] ||= {}.with_indifferent_access
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/base_command.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'shellwords'
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      require_sub __FILE__
+
+      common_concern do
+        enable_abstract_methods
+        include ::EacRubyUtils::Envs::BaseCommand::Concat
+        include ::EacRubyUtils::Envs::BaseCommand::Debugging
+        include ::EacRubyUtils::Envs::BaseCommand::Execution
+        include ::EacRubyUtils::Envs::BaseCommand::ExtraOptions
+      end
+
+      # @return [EacRubyUtils::Envs::BaseEnv]
+      def env
+        raise_abstract_method __method__
+      end
+
+      def command(options = {})
+        append_command_options(
+          env.command_line(command_line_without_env),
+          options
+        )
+      end
+
+      # @return [String]
+      def command_line_without_env(_options = {})
+        raise_abstract_method __method__
+      end
+
+      private
+
+      def escape(arg)
+        arg = arg.to_s
+        m = /^@ESC_(.+)$/.match(arg)
+        m ? m[1] : Shellwords.escape(arg)
+      end
+    end
+  end
+end