eac_tools 0.3.0 → 0.4.0

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/pathname/parent_n.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Pathname
+  # Apply .parent n times.
+  # @return [Pathname]
+  def parent_n(n) # rubocop:disable Naming/MethodParameterName
+    n.times.inject(self) { |a, _e| a.parent }
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/pathname/readlink_r.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Pathname
+  def readlink_r
+    r = self
+    r = r.readlink while r.symlink?
+    r
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/pathname/reqdir_glob.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Pathname
+  # A .glob that raises a ::RuntimeError if +self+ is not a directory.
+  # @return [Pathname]
+  def reqdir_glob(*args)
+    raise ::RuntimeError, "\"#{self}\" is not a directory" unless directory?
+
+    glob(*args)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/pathname.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub __FILE__

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/regexp/if_match.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class Regexp
+  # If +self+ matches +string+ returns +block.call(Match result) or only Match result if block is
+  # not provided.
+  # If +self+ does not match +string+ raises a +ArgumentError+ if +required+ is truthy or return
+  # +nil+ otherwise.
+  def if_match(string, required = true, &block)
+    m = match(string)
+    if m
+      block ? block.call(m) : m
+    elsif required
+      raise(::ArgumentError, "Pattern \"#{self}\" does not match string \"#{string}\"")
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/regexp/to_parser.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/regexp_parser'
+
+class Regexp
+  # @return [::EacRubyUtils::RegexpParser]
+  def to_parser(&block)
+    ::EacRubyUtils::RegexpParser.new(self, &block)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/regexp.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub __FILE__

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/string/delimited.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/string_delimited'
+
+class String
+  # @return [EacRubyUtils::StringDelimited]
+  def delimited(begin_delimiter, end_delimiter)
+    ::EacRubyUtils::StringDelimited.new(self, begin_delimiter, end_delimiter)
+  end
+
+  %w[inner outer without_inner without_outer].each do |method_suffix|
+    define_method "delimited_#{method_suffix}" do |begin_delimiter, end_delimiter|
+      delimited(begin_delimiter, end_delimiter).send(method_suffix)
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/inflector'
+
+class String
+  # Shortcut to `EacRubyUtils::Inflector.variableize(self, ...)`.
+  # @see EacRubyUtils::Inflector.variableize
+  def variableize(validate = true)
+    ::EacRubyUtils::Inflector.variableize(self, validate)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/string.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub __FILE__

data/sub/eac_ruby_utils/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/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/time.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub __FILE__

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

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

data/sub/eac_ruby_utils/lib/eac_ruby_utils/recursive_builder.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/simple_cache'
+
+module EacRubyUtils
+  class RecursiveBuilder
+    include ::EacRubyUtils::SimpleCache
+
+    attr_reader :root, :neighbors_block
+
+    def initialize(root, &neighbors_block)
+      @root = root
+      @neighbors_block = neighbors_block
+    end
+
+    private
+
+    attr_reader :added, :to_check
+
+    def result_uncached
+      @added = []
+      @to_check = []
+      item_try_add_to_check(root)
+      while check_next_item
+        # Do nothing
+      end
+      added
+    end
+
+    def item_try_add_to_check(item)
+      to_check << item unless item_added?(item)
+    end
+
+    def item_added?(item)
+      added.include?(item) || to_check.include?(item)
+    end
+
+    def check_next_item
+      return false unless to_check.any?
+
+      item = to_check.shift
+      added << item
+      item_neighborhs(item).each { |sub_item| item_try_add_to_check(sub_item) }
+      true
+    end
+
+    def item_neighborhs(item)
+      neighbors_block.call(item)
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/regexp_parser.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class RegexpParser
+    attr_reader :pattern, :builder_proc
+
+    def initialize(pattern, &builder_proc)
+      @pattern = pattern
+      @builder_proc = builder_proc
+    end
+
+    def parse(string)
+      internal_parse(string)[1]
+    end
+
+    def parse!(string)
+      match, result = internal_parse(string)
+      return result if match
+
+      raise ::ArgumentError, "String \"#{string}\" does not match pattern \"#{pattern}\""
+    end
+
+    private
+
+    def internal_parse(string)
+      m = pattern.match(string)
+      if m
+        [true, builder_proc ? builder_proc.call(m) : m]
+      else
+        [false, nil]
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/require_sub.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+require 'active_support/dependencies'
+require 'eac_ruby_utils/listable'
+
+module EacRubyUtils
+  class << self
+    def require_sub(file, options = {})
+      ::EacRubyUtils::RequireSub.new(file, options).apply
+    end
+  end
+
+  class RequireSub
+    INCLUDE_MODULES_MAP = {
+      nil => nil,
+      false => nil,
+      true => :include,
+      include: :include,
+      prepend: :prepend
+    }.freeze
+
+    include ::EacRubyUtils::Listable
+    lists.add_symbol :option, :base, :include_modules, :require_dependency
+
+    attr_reader :file, :options
+
+    def initialize(file, options = {})
+      @file = file
+      @options = self.class.lists.option.hash_keys_validate!(options)
+    end
+
+    def apply
+      require_sub_files
+      include_modules
+    end
+
+    def base
+      options[OPTION_BASE] || raise('Option :base not setted')
+    end
+
+    def base?
+      options[OPTION_BASE] ? true : false
+    end
+
+    def include_modules
+      sub_files.each(&:include_module)
+    end
+
+    def include_or_prepend_method
+      return INCLUDE_MODULES_MAP.fetch(options[OPTION_INCLUDE_MODULES]) if
+        INCLUDE_MODULES_MAP.key?(options[OPTION_INCLUDE_MODULES])
+
+      raise ::ArgumentError, "Invalid value for 'options[OPTION_INCLUDE_MODULES]':" \
+         " \"#{options[OPTION_INCLUDE_MODULES]}\""
+    end
+
+    def require_sub_files
+      sub_files.each(&:require_file)
+    end
+
+    def sub_files
+      @sub_files ||= Dir["#{File.dirname(file)}/#{::File.basename(file, '.*')}/*.rb"].sort
+                       .map { |path| SubFile.new(self, path) }
+    end
+
+    class SubFile
+      attr_reader :owner, :path
+
+      def initialize(owner, path)
+        @owner = owner
+        @path = path
+      end
+
+      def base_constant
+        return nil unless owner.base?
+
+        owner.base.const_get(constant_name)
+      rescue ::NameError
+        nil
+      end
+
+      def constant_name
+        ::ActiveSupport::Inflector.camelize(::File.basename(path, '.rb'))
+      end
+
+      def include_module
+        return unless module?
+
+        owner.include_or_prepend_method.if_present do |v|
+          owner.base.send(v, base_constant)
+        end
+      end
+
+      def include_or_prepend_method
+        return :include if owner.options[OPTION_INCLUDE_MODULES]
+        return :prepend if owner.options[OPTION_PREPEND_MODULES]
+
+        nil
+      end
+
+      def module?
+        base_constant.is_a?(::Module) && !base_constant.is_a?(::Class)
+      end
+
+      def require_file
+        active_support_require || autoload_require || kernel_require
+      end
+
+      private
+
+      def active_support_require
+        return false unless owner.options[OPTION_REQUIRE_DEPENDENCY]
+
+        ::Kernel.require_dependency(path)
+        true
+      end
+
+      def autoload_require
+        return false unless owner.base?
+
+        basename = ::File.basename(path, '.*')
+        return false if basename.start_with?('_')
+
+        owner.base.autoload ::ActiveSupport::Inflector.camelize(basename), path
+        true
+      end
+
+      def kernel_require
+        ::Kernel.require(path)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/rspec/setup_manager'
+
+module EacRubyUtils
+  module Rspec
+    class << self
+      # @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

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

@@ -0,0 +1,17 @@
+# 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.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacRubyUtils
+  module Rspec
+    module Setup
+      extend ::ActiveSupport::Concern
+      require_sub __FILE__, include_modules: true
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# 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

@@ -0,0 +1,39 @@
+# 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

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

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

@@ -0,0 +1,32 @@
+# 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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+module EacRubyUtils
+  module Ruby
+    class << self
+      # Executes a block in an environment when the variables BUNDLE* and RUBY* are removed.
+      def on_clean_environment
+        bundler_with_unbundled_env do
+          on_clean_envvars('BUNDLE', 'RUBY') { yield }
+        end
+      end
+
+      private
+
+      def bundler_with_unbundled_env(&block)
+        if ::Bundler.respond_to?(:with_unbundled_env)
+          ::Bundler.with_unbundled_env(&block)
+        else
+          ::Bundler.with_clean_env(&block)
+        end
+      end
+
+      def on_clean_envvars(*start_with_vars)
+        old_values = envvars_starting_with(start_with_vars)
+        old_values.each_key { |k| ENV.delete(k) }
+        yield
+      ensure
+        old_values&.each { |k, v| ENV[k] = v }
+      end
+
+      def envvars_starting_with(start_with_vars)
+        ENV.select { |k, _v| start_with_vars.any? { |var| k.start_with?(var) } }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# 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

@@ -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