Module: Kernel

Defined in:

lib/require-hooks/mode/kernel_patch.rb

Overview

Patch Kernel to hijack require/require_relative/load

Class Method Summary

• .load(path, wrap = false) ⇒ Object
• .load_without_require_hooks ⇒ Object
• .require(path) ⇒ Object

  See github.com/ruby/ruby/blob/d814722fb8299c4baace3e76447a55a3d5478e3a/load.c#L1181.

• .require_relative(path) ⇒ Object
• .require_relative_without_require_hooks ⇒ Object
• .require_without_require_hooks ⇒ Object

Class Method Details

.load(path, wrap = false) ⇒ Object

# File 'lib/require-hooks/mode/kernel_patch.rb', line 277

def load(path, wrap = false)
  if wrap
    warn "RequireHooks does not support `load(smth, wrap: ...)`. Falling back to original `Kernel#load`" if RequireHooks.print_warnings
    return load_without_require_hooks(path, wrap)
  end

  path = path.to_path if path.respond_to?(:to_path)
  raise TypeError unless path.respond_to?(:to_str)

  path = path.to_str

  raise TypeError unless path.is_a?(::String)

  realpath =
    if path =~ /^\.\.?\//
      path
    else
      RequireHooks::KernelPatch::Features.feature_path(path, implitic_ext: false)
    end

  return load_without_require_hooks(path, wrap) unless realpath

  RequireHooks::KernelPatch.load(realpath)
rescue Errno::ENOENT, Errno::EACCES
  raise LoadError, "cannot load such file -- #{path}"
rescue LoadError => e
  warn "RuquireHooks failed to load '#{path}': #{e.message}" if RequireHooks.print_warnings
  load_without_require_hooks(path)
end

.load_without_require_hooks ⇒ Object

# File 'lib/require-hooks/mode/kernel_patch.rb', line 276

alias_method :load_without_require_hooks, :load

.require(path) ⇒ Object

See github.com/ruby/ruby/blob/d814722fb8299c4baace3e76447a55a3d5478e3a/load.c#L1181

Raises:

• (TypeError)

# File 'lib/require-hooks/mode/kernel_patch.rb', line 203

def require(path)
  path = path.to_path if path.respond_to?(:to_path)
  raise TypeError unless path.respond_to?(:to_str)

  path = path.to_str

  raise TypeError unless path.is_a?(::String)

  realpath = nil
  feature = path

  # if extname == ".rb" => lookup feature -> resolve feature -> load
  # if extname != ".rb" => append ".rb" - lookup feature -> resolve feature -> lookup orig (no ext) -> resolve orig (no ext) -> load
  if File.extname(path) != ".rb"
    realpath = RequireHooks::KernelPatch::Features.feature_path(path + ".rb")

    if realpath
      feature = path + ".rb"
    end
  end

  realpath ||= RequireHooks::KernelPatch::Features.feature_path(path)

  return require_without_require_hooks(path) unless realpath

  ctx = RequireHooks.context_for(realpath)

  return require_without_require_hooks(path) if ctx.empty?

  return false if $LOADED_FEATURES.include?(realpath)

  begin
    RequireHooks::KernelPatch::Features::LOCK.lock_feature(feature) do |loaded|
      return false if loaded

      $LOADED_FEATURES << realpath
      RequireHooks::KernelPatch.load(realpath, ctx: ctx)
      true
    end
  rescue LoadError => e
    $LOADED_FEATURES.delete(realpath) if realpath
    warn "RequireHooks failed to require '#{path}' from '#{realpath}': #{e.message}" if RequireHooks.print_warnings
    require_without_require_hooks(path)
  rescue Errno::ENOENT, Errno::EACCES
    raise LoadError, "cannot load such file -- #{path}"
  rescue
    $LOADED_FEATURES.delete(realpath) if realpath
    raise
  end
end

.require_relative(path) ⇒ Object

Raises:

• (TypeError)

# File 'lib/require-hooks/mode/kernel_patch.rb', line 255

def require_relative(path)
  path = path.to_path if path.respond_to?(:to_path)
  raise TypeError unless path.respond_to?(:to_str)
  path = path.to_str

  raise TypeError unless path.is_a?(::String)

  return require(path) if Pathname.new(path).absolute?

  loc = caller_locations(1..1).first
  from = loc.absolute_path || loc.path || File.join(Dir.pwd, "main")
  realpath = File.absolute_path(
    File.join(
      File.dirname(File.absolute_path(from)),
      path
    )
  )

  require(realpath)
end

.require_relative_without_require_hooks ⇒ Object

# File 'lib/require-hooks/mode/kernel_patch.rb', line 254

alias_method :require_relative_without_require_hooks, :require_relative

.require_without_require_hooks ⇒ Object

# File 'lib/require-hooks/mode/kernel_patch.rb', line 201

alias_method :require_without_require_hooks, :require