eac_tools 0.122.0 → 0.123.0

data/sub/eac_ruby_utils/lib/eac_ruby_utils/root_module_setup/ignore.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/patches/module/acts_as_instance_method'
-require 'eac_ruby_utils/patches/object/to_pathname'
-require 'eac_ruby_utils/patches/pathname/basename_sub'
-require 'memoized'
-
-module EacRubyUtils
-  class RootModuleSetup
-    class Ignore
-      include ::Memoized
-
-      acts_as_instance_method
-      common_constructor :setup, :path do
-        self.path = path.to_pathname
-      end
-      delegate :loader, :root_module_directory, to: :setup
-
-      # @return [Set]
-      def result
-        target_paths.each do |target_path|
-          expect_count_increment { loader.ignore target_path }
-        end
-      end
-
-      protected
-
-      # @return [Pathname]
-      memoize def absolute_path
-        path.expand_path(root_module_directory)
-      end
-
-      # @return [Set]
-      def expect_count_increment
-        count_before = loader.send(:ignored_paths).count
-        result = yield
-        return result if result.count > count_before
-
-        raise ::ArgumentError, [
-          "Trying to ignore path \"#{path}\" did not increase the ignored paths.",
-          "Argument path: \"#{path}\"", "Target path: \"#{target_paths}\"",
-          "Ignored paths: #{result}"
-        ].join("\n")
-      end
-
-      # @return [Pathname]
-      memoize def target_paths
-        return [absolute_path] if %w[* ?].any? { |e| absolute_path.to_path.include?(e) }
-
-        r = []
-        r << absolute_path if absolute_path.directory?
-        r << [absolute_path.basename_sub { |b| "#{b.basename('.*')}.rb" }]
-        r
-      end
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/root_module_setup.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/inflector'
-require 'eac_ruby_utils/patches/module/require_sub'
-require 'zeitwerk'
-
-module EacRubyUtils
-  # @deprecated Use `EacRubyBase1::RootModuleSetup` instead.
-  class RootModuleSetup
-    require_sub __FILE__, require_mode: :kernel
-
-    DEFAULT_NAMESPACE = ::Object
-    LIB_DIRECTORY_BASENAME = 'lib'
-
-    class << self
-      # @param root_module_file [String]
-      def perform(root_module_file, &)
-        new(root_module_file, &).perform
-      end
-    end
-
-    attr_reader :block, :root_module_file
-    attr_writer :logging
-
-    # @param root_module_file [String]
-    def initialize(root_module_file, &block)
-      self.root_module_file = root_module_file
-      self.block = block
-    end
-
-    # @param enable [Boolean] `true` to enable, `false` (default) to disable.
-    # @return
-    def logging(enable)
-      @logging = enable
-    end
-
-    # @return [Boolean]
-    def logging?
-      @logging ? true : false
-    end
-
-    # @return [Module, nil]
-    def extension_for
-      dirname = ::File.dirname(relative_root_module_file)
-      return nil if ['.', '/', ''].include?(dirname)
-
-      require dirname
-      ::ActiveSupport::Inflector.constantize(dirname.camelize)
-    end
-
-    # @return [Zeitwerk::GemLoader]
-    def loader
-      @loader ||= ::Zeitwerk::Registry.loader_for_gem(
-        root_module_file,
-        namespace: namespace,
-        warn_on_extra_files: true
-      )
-    end
-
-    # @return [Module]
-    def namespace
-      extension_for || DEFAULT_NAMESPACE
-    end
-
-    # @return [void]
-    def perform
-      perform_block
-      perform_zeitwerk
-    end
-
-    # @return [String]
-    def relative_root_module_file
-      count = 0
-      current = ::File.basename(root_module_file, '.*')
-      dirname = ::File.dirname(root_module_file)
-      loop do
-        ibr if dirname == '/'
-
-        break current if ::File.basename(dirname) == LIB_DIRECTORY_BASENAME
-
-        current = ::File.join(::File.basename(dirname), current)
-        dirname = ::File.dirname(dirname)
-
-        count += 1
-      end
-    end
-
-    # @return [String]
-    def root_module_directory
-      ::File.expand_path(::File.basename(root_module_file, '.*'),
-                         ::File.dirname(root_module_file))
-    end
-
-    protected
-
-    attr_writer :block, :root_module_file
-
-    def perform_block
-      instance_eval(&block) if block
-    end
-
-    # @return [void]
-    def perform_zeitwerk
-      loader.log! if logging?
-      loader.setup
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/rspec/default_setup.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/rspec/setup_manager'
-
-module EacRubyUtils
-  module Rspec
-    module DefaultSetup
-      common_concern
-      class_methods do
-        # @return [EacRubyUtils::Rspec::SetupManager]
-        def default_setup
-          @default_setup ||
-            raise("Default instance was not set. Use #{self.class.name}.default_setup_create")
-        end
-
-        # @return [EacRubyUtils::Rspec::SetupManager]
-        def default_setup_create(app_root_path, rspec_config = nil)
-          @default_setup = ::EacRubyUtils::Rspec::SetupManager.create(app_root_path, rspec_config)
-        end
-      end
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/rspec/setup/conditionals.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module EacRubyUtils
-  module Rspec
-    module Setup
-      module Conditionals
-        def conditional(tag, &condition)
-          message = condition.call
-          return if message.blank?
-
-          puts("[WARN] Excluded tag: #{tag}: #{message}")
-          rspec_config.filter_run_excluding tag
-        end
-      end
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/rspec/setup/setup_manager.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module EacRubyUtils
-  module Rspec
-    module Setup
-      module SetupManager
-        # @return [Pathname]
-        delegate :app_root_path, to: :setup_manager
-
-        # @return [EacRubyUtils::Rspec::SetupManager]
-        def setup_manager
-          ::RSpec.configuration.setup_manager
-        end
-      end
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/rspec/setup.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-require 'eac_ruby_utils/rspec/stub_speaker'
-require 'eac_ruby_utils/speaker'
-
-module EacRubyUtils
-  module Rspec
-    module Setup
-      require_sub __FILE__
-
-      def self.extended(obj)
-        obj.extend(::EacRubyUtils::Rspec::Setup::Conditionals)
-        obj.rspec_config.add_setting :setup_manager
-        obj.rspec_config.setup_manager = obj
-        obj.rspec_config.include(::EacRubyUtils::Rspec::Setup::SetupManager)
-      end
-
-      # @return [self]
-      def stub_eac_speaker
-        ::EacRubyUtils::Speaker.context.push(::EacRubyUtils::Rspec::StubSpeaker.new)
-
-        self
-      end
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/rspec/setup_manager.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/gems_registry'
-require 'eac_ruby_utils/patches/object/if_respond'
-require 'eac_ruby_utils/patches/object/to_pathname'
-
-module EacRubyUtils
-  module Rspec
-    class SetupManager
-      GEMS_REGISTRY_SUFFIX = 'Rspec::Setup'
-
-      class << self
-        def create(app_root_path, rspec_config = nil)
-          if rspec_config
-            new(app_root_path, rspec_config)
-          else
-            ::RSpec.configure { |new_rspec_config| new(app_root_path, new_rspec_config) }
-          end
-        end
-      end
-
-      attr_reader :app_root_path, :rspec_config
-
-      def initialize(app_root_path, rspec_config)
-        @app_root_path = app_root_path.to_pathname
-        @rspec_config = rspec_config
-        include_registry
-      end
-
-      # @return [EacRubyUtils::GemsRegistry]
-      def gems_registry
-        @gems_registry ||= ::EacRubyUtils::GemsRegistry.new(GEMS_REGISTRY_SUFFIX)
-      end
-
-      protected
-
-      def include_registry
-        gems_registry.registered.each do |gem|
-          include_gem_registered(gem.registered_module)
-        end
-      end
-
-      # @param gem [EacRubyUtils::GemsRegistry::Gem]
-      def include_gem_registered(registered_module)
-        extend(registered_module)
-      end
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/rspec/stub_speaker.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/speaker/receiver'
-
-module EacRubyUtils
-  module Rspec
-    class StubSpeaker
-      include ::EacRubyUtils::Speaker::Receiver
-
-      def error(_string); end
-
-      def fatal_error(string)
-        error(string)
-        raise('Fatal error')
-      end
-
-      # @see EacRubyUtils::Speaker::Sender.input
-      def input(_question, _options = {})
-        raise 'Input requested'
-      end
-
-      def info(_string); end
-
-      def infom(_string); end
-
-      def infov(*_args); end
-
-      def out(_string = ''); end
-
-      def puts(_string = ''); end
-
-      def success(_string); end
-
-      def title(_string); end
-
-      def warn(_string); end
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/rspec.rb

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

data/sub/eac_ruby_utils/lib/eac_ruby_utils/ruby/command.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/envs/command'
-require 'eac_ruby_utils/ruby/on_clean_environment'
-
-module EacRubyUtils
-  module Ruby
-    # A [EacRubyUtils::Envs::Command] which runs in a clean Ruby environment.
-    class Command < ::EacRubyUtils::Envs::Command
-      def initialize(bundle_args, extra_options = {})
-        host_env = extra_options.delete(:host_env)
-        super(host_env || ::EacRubyUtils::Envs.local, bundle_args, extra_options)
-      end
-
-      %w[system execute].each do |method_prefix|
-        [method_prefix, "#{method_prefix}!"].each do |method_name|
-          define_method method_name do |*args, &block|
-            ::EacRubyUtils::Ruby.on_clean_environment do
-              super(*args, &block)
-            end
-          end
-        end
-      end
-
-      protected
-
-      def duplicate(command, extra_options)
-        self.class.new(gem, command, extra_options)
-      end
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/ruby/on_clean_environment.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler'
-require 'eac_ruby_utils/ruby/on_replace_objects'
-
-module EacRubyUtils
-  module Ruby
-    class << self
-      # Executes a block in an environment when the variables BUNDLE* and RUBY* are removed.
-      def on_clean_environment(&)
-        OnCleanEnvironment.new(&).perform
-      end
-
-      class OnCleanEnvironment
-        ENVVARS_PREFIXES_TO_CLEAN = %w[BUNDLE RUBY].freeze
-
-        attr_reader :block, :original_env
-
-        def initialize(&block)
-          @block = block
-          @original_env = ::ENV.to_h
-        end
-
-        # @return [Array<String>]
-        def envvars_prefixes_to_clean
-          ENVVARS_PREFIXES_TO_CLEAN
-        end
-
-        def perform
-          bundler_with_unbundled_env do
-            on_clean_envvars
-          end
-        end
-
-        private
-
-        def bundler_with_unbundled_env(&)
-          with_bundler_modified do
-            ::Bundler.send(bundler_with_env_method_name, &)
-          end
-        end
-
-        def bundler_with_env_method_name
-          if ::Bundler.respond_to?(:with_unbundled_env)
-            :with_unbundled_env
-          else
-            :with_clean_env
-          end
-        end
-
-        def clean_env
-          r = original_env.dup
-          r.delete_if { |k, _| envvars_prefixes_to_clean.any? { |prefix| k.start_with?(prefix) } }
-          r
-        end
-
-        def on_clean_envvars
-          ::Bundler.send('with_env', clean_env) { block.call }
-        end
-
-        def with_bundler_modified(&block)
-          cloned_env = original_env.dup
-          ::EacRubyUtils::Ruby.on_replace_objects do |replacer|
-            replacer.replace_self_method(::Bundler, :original_env) { cloned_env }
-            block.call
-          end
-        end
-      end
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/ruby/on_replace_objects/replace_instance_method.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/inflector'
-require 'eac_ruby_utils/ruby/on_replace_objects/replace_instance_method'
-
-module EacRubyUtils
-  module Ruby
-    class OnReplaceObjects
-      class ReplaceInstanceMethod
-        attr_reader :a_module, :method_new_block, :original_method
-
-        def initialize(a_module, method_name, &method_new_block)
-          @a_module = a_module
-          @original_method = a_module.instance_method(method_name)
-          @method_new_block = method_new_block
-        end
-
-        def apply
-          a_module.define_method(method_name, &method_new_block)
-
-          self
-        end
-
-        def method_name
-          original_method.name
-        end
-
-        def restore
-          a_module.define_method(method_name, original_method)
-
-          self
-        end
-      end
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/ruby/on_replace_objects.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/inflector'
-require 'eac_ruby_utils/ruby/on_replace_objects/replace_instance_method'
-
-module EacRubyUtils
-  module Ruby
-    class << self
-      def on_replace_objects
-        replacer = OnReplaceObjects.new
-        replacer.on_replacement do
-          yield(replacer)
-        end
-      end
-    end
-
-    class OnReplaceObjects
-      def on_replacement(&block)
-        clear_replacements
-        block.call(self)
-      ensure
-        restore_replacements
-      end
-
-      def replace_instance_method(a_module, method_name, &)
-        add_replacement(__method__, a_module, method_name, &)
-      end
-
-      def replace_self_method(object, method_name, &)
-        add_replacement(:replace_instance_method, object.singleton_class, method_name, &)
-      end
-
-      private
-
-      def add_replacement(method_name, *, &)
-        @replacements << replacement_class(method_name).new(*, &).apply
-      end
-
-      def replacement_class(method_name)
-        self.class.const_get(::ActiveSupport::Inflector.camelize(method_name))
-      end
-
-      def clear_replacements
-        @replacements = []
-      end
-
-      def restore_replacements
-        @replacements.reverse.each(&:restore)
-      end
-    end
-  end
-end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/ruby.rb

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

data/sub/eac_ruby_utils/lib/eac_ruby_utils/settings_provider/setting_value.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/string/inflections'
-require 'eac_ruby_utils/listable'
-require 'memoized'
-require 'eac_ruby_utils/struct'
-
-module EacRubyUtils
-  module SettingsProvider
-    class SettingValue
-      include ::EacRubyUtils::Listable
-      include ::Memoized
-
-      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) # rubocop:disable Style/OptionalBooleanParameter
-        name = key.to_s.underscore.upcase
-        name = "#{source.class.name}::#{name}" if fullname
-        name
-      end
-
-      def value
-        parsed_options.order.each do |method|
-          return send("value_by_#{method}") if send("value_by_#{method}?")
-        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)
-      end
-
-      def value_by_constant?
-        source.class.const_defined?(constant_name)
-      end
-
-      def value_by_method
-        source.send(key)
-      end
-
-      def value_by_method?
-        source.respond_to?(key, true)
-      end
-
-      def value_by_settings_object
-        source.settings_object.fetch(key)
-      end
-
-      def value_by_settings_object?
-        source.settings_object.key?(key)
-      end
-
-      private
-
-      memoize def parsed_options
-        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/sub/eac_ruby_utils/lib/eac_ruby_utils/settings_provider.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/hash_with_indifferent_access'
-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) # rubocop:disable Style/OptionalBooleanParameter
-      setting_value_instance(key).constant_name(fullname)
-    end
-
-    def setting_search_order
-      %w[settings_object method constant]
-    end
-
-    # return [ActiveSupport::HashWithIndifferentAccess]
-    def settings_object
-      ActiveSupport::HashWithIndifferentAccess.new(
-        respond_to?(settings_object_name) ? send(settings_object_name) : {}
-      )
-    end
-
-    def settings_object_name
-      'settings'
-    end
-
-    def setting_value(key, options = {})
-      setting_value_instance(key, options).value
-    end
-
-    def setting_value_by_constant(key)
-      setting_value_instance(key).value_by_constant
-    end
-
-    def setting_value_by_method(key)
-      setting_value_instance(key).value_by_method
-    end
-
-    def setting_value_by_settings_object(key)
-      setting_value_instance(key).value_by_settings_object
-    end
-
-    def setting_value_instance(key, options = {})
-      ::EacRubyUtils::SettingsProvider::SettingValue.new(self, key, options)
-    end
-  end
-end