require-hooks 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ecc9a4046183806287747095063d7d422acd865315cde4ce322bf24f00463d5
-  data.tar.gz: 58f6a905e3370857373dcd8a101ac4931352982d3e6a1a612bf5bcf0fff2c8cc
+  metadata.gz: 36e7f23cef600d120d9139555f3e3ef4b8bd46b9929387b99dce99280108615c
+  data.tar.gz: c89a896109b87d81d2e1a7690398bc337b6723c2ae006c5a2a0f0c7a8e01c52a
 SHA512:
-  metadata.gz: d2b6f66c0601c8fa49a874ea28522a53fa5770106572cf96570f8bfce444d1a76ac16e6ce63fa73e2e39b371d84173fb4a2c6eb880fd37b62ca130b3d10dd161
-  data.tar.gz: 2e1ac761b1d464961cbd6106788564f83f5f0469b9cdcd6cf437afeb5ec0adf8ffc9bdbc48dbb74ba07985cc979e8bc5a0e47edca6b0a0d6b8dcde26360044c6
+  metadata.gz: 4af96e3f1d117b10e7cedc4cb564e47768ac5eb44e8f83e666e90b9f98178fd827a19641caa0f2dd3e674736ec7aa0982e11d184fa780e46fc89a0c399098f00
+  data.tar.gz: c0c60d8e40d22743aa24c671b88989c6aef61c58d39cdefe39e26c73905fc08286d0fb68d09e409e0762e8ccbfe5334926d7c35321f2442bf4158e5e8dda0d1e

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## master
 
+## 0.3.0 (2026-04-22)
+
+- Fix the order of around hooks execution (after part) when using `#load_iseq` driven hooks.
+
+- Improve `Kernel#require` patch performance.
+
+- Reduce context object creation and use a single object when only one context defined.
+
+## 0.2.3 (2026-01-13)
+
+- Gem metadata fixes.
+
 ## 0.2.2 (2023-12-19)
 
 - Fix handing uncompilable source code with Bootsnap. ([@palkan][])

data/README.md

@@ -16,6 +16,7 @@ Require hooks allows you to interfere with `Kernel#require` (incl. `Kernel#requi
 
 - [Ruby Next][ruby-next]
 - [Freezolite](https://github.com/ruby-next/freezolite)
+- [Tapioca](https://github.com/Shopify/tapioca)
 
 ## Installation
 

data/lib/require-hooks/api.rb

@@ -1,19 +1,34 @@
 # frozen_string_literal: true
 
 module RequireHooks
-  @@around_load = []
-  @@source_transform = []
-  @@hijack_load = []
-
   class Context
-    def initialize(around_load, source_transform, hijack_load)
-      @around_load = around_load
-      @source_transform = source_transform
-      @hijack_load = hijack_load
+    attr_reader :around_load, :source_transform, :hijack_load,
+      :patterns, :exclude_patterns
+
+    def initialize(patterns: nil, exclude_patterns: nil)
+      @patterns = patterns.freeze
+      @exclude_patterns = exclude_patterns.freeze
+
+      @around_load = []
+      @source_transform = []
+      @hijack_load = []
+
+      @empty = nil
+    end
+
+    def to_key
+      [patterns, exclude_patterns]
+    end
+
+    def match?(path)
+      return false unless !patterns || patterns.any? { |pattern| File.fnmatch?(pattern, path) }
+      return false if exclude_patterns&.any? { |pattern| File.fnmatch?(pattern, path) }
+      true
     end
 
     def empty?
-      @around_load.empty? && @source_transform.empty? && @hijack_load.empty?
+      return @empty unless @empty.nil?
+      @empty = @around_load.empty? && @source_transform.empty? && @hijack_load.empty?
     end
 
     def source_transform?
@@ -57,6 +72,10 @@ module RequireHooks
     end
   end
 
+  @@default_context = Context.new
+  @@noop_context = Context.new
+  @@contexts = {}
+
   class << self
     attr_accessor :print_warnings
 
@@ -69,7 +88,13 @@ module RequireHooks
     #      block.call.tap { puts "Loaded #{path}" }
     #    end
     def around_load(patterns: nil, exclude_patterns: nil, &block)
-      @@around_load << [patterns, exclude_patterns, block]
+      @@default_context = nil
+      ctx = Context.new(patterns: patterns, exclude_patterns: exclude_patterns)
+
+      @@contexts[ctx.to_key] ||= ctx
+      @@contexts[ctx.to_key].around_load << block
+
+      @@default_context = @@contexts.values.first if @@contexts.size == 1
     end
 
     # Define hooks to perform source-to-source transformations.
@@ -83,7 +108,13 @@ module RequireHooks
     #      "# frozen_string_literal: true\n#{source}"
     #    end
     def source_transform(patterns: nil, exclude_patterns: nil, &block)
-      @@source_transform << [patterns, exclude_patterns, block]
+      @@default_context = nil
+      ctx = Context.new(patterns: patterns, exclude_patterns: exclude_patterns)
+
+      @@contexts[ctx.to_key] ||= ctx
+      @@contexts[ctx.to_key].source_transform << block
+
+      @@default_context = @@contexts.values.first if @@contexts.size == 1
     end
 
     # This hook should be used to manually compile byte code to be loaded by the VM.
@@ -101,32 +132,35 @@ module RequireHooks
     #     end
     #   end
     def hijack_load(patterns: nil, exclude_patterns: nil, &block)
-      @@hijack_load << [patterns, exclude_patterns, block]
+      @@default_context = nil
+      ctx = Context.new(patterns: patterns, exclude_patterns: exclude_patterns)
+
+      @@contexts[ctx.to_key] ||= ctx
+      @@contexts[ctx.to_key].hijack_load << block
+
+      @@default_context = @@contexts.values.first if @@contexts.size == 1
     end
 
     def context_for(path)
-      around_load = @@around_load.select do |patterns, exclude_patterns, _block|
-        next unless !patterns || patterns.any? { |pattern| File.fnmatch?(pattern, path) }
-        next if exclude_patterns&.any? { |pattern| File.fnmatch?(pattern, path) }
-
-        true
-      end.map { |_patterns, _exclude_patterns, block| block }
+      # Fast-track in case we have just a single context defined
+      if @@default_context
+        return @@noop_context unless @@default_context.match?(path)
 
-      source_transform = @@source_transform.select do |patterns, exclude_patterns, _block|
-        next unless !patterns || patterns.any? { |pattern| File.fnmatch?(pattern, path) }
-        next if exclude_patterns&.any? { |pattern| File.fnmatch?(pattern, path) }
+        return @@default_context
+      end
 
-        true
-      end.map { |_patterns, _exclude_patterns, block| block }
+      matching = @@contexts.values.select { |ctx| ctx.match?(path) }
 
-      hijack_load = @@hijack_load.select do |patterns, exclude_patterns, _block|
-        next unless !patterns || patterns.any? { |pattern| File.fnmatch?(pattern, path) }
-        next if exclude_patterns&.any? { |pattern| File.fnmatch?(pattern, path) }
+      return matching[0] || @@noop_context if matching.size < 2
 
-        true
-      end.map { |_patterns, _exclude_patterns, block| block }
+      ctx = Context.new
+      matching.each do |mctx|
+        ctx.around_load.concat(mctx.around_load)
+        ctx.source_transform.concat(mctx.source_transform)
+        ctx.hijack_load.concat(mctx.hijack_load)
+      end
 
-      Context.new(around_load, source_transform, hijack_load)
+      ctx
     end
   end
 end

data/lib/require-hooks/mode/bootsnap.rb

@@ -2,9 +2,12 @@
 
 module RequireHooks
   module Bootsnap
+    EMPTY_ISEQ = RubyVM::InstructionSequence.compile("").freeze
+
     module CompileCacheExt
       def input_to_storage(source, path, *)
         ctx = RequireHooks.context_for(path)
+        return super if ctx.empty?
 
         new_contents = ctx.perform_source_transform(path)
         hijacked = ctx.try_hijack_load(path, new_contents)
@@ -26,7 +29,17 @@ module RequireHooks
       # Around hooks must be performed every time we trigger a file load, even if
       # the file is already cached.
       def load_iseq(path)
-        RequireHooks.context_for(path).run_around_load_callbacks(path) { super }
+        ctx = RequireHooks.context_for(path)
+        # Early-return for non-trackable paths
+        return super if ctx.empty?
+
+        ctx.run_around_load_callbacks(path) do
+          iseq = super
+          return unless iseq
+
+          iseq.eval
+          EMPTY_ISEQ
+        end
       end
     end
   end

data/lib/require-hooks/mode/kernel_patch.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require "mutex_m"
 require "pathname"
 
 module RequireHooks
   module KernelPatch
     class << self
-      def load(path)
-        ctx = RequireHooks.context_for(path)
+      def load(path, ctx: nil)
+        ctx ||= RequireHooks.context_for(path)
 
         ctx.run_around_load_callbacks(path) do
           next load_without_require_hooks(path) unless ctx.source_transform? || ctx.hijack?
@@ -141,32 +140,6 @@ module RequireHooks
           path
         end
 
-        # Based on https://github.com/ruby/ruby/blob/b588fd552390c55809719100d803c36bc7430f2f/load.c#L403-L415
-        def feature_loaded?(feature)
-          return true if $LOADED_FEATURES.include?(feature) && !LOCK.locked_feature?(feature)
-
-          feature = Pathname.new(feature).cleanpath.to_s
-          efeature = File.expand_path(feature)
-
-          # Check absoulute and relative paths
-          return true if $LOADED_FEATURES.include?(efeature) && !LOCK.locked_feature?(efeature)
-
-          candidates = []
-
-          $LOADED_FEATURES.each do |lf|
-            candidates << lf if lf.end_with?("/#{feature}")
-          end
-
-          return false if candidates.empty?
-
-          $LOAD_PATH.each do |lp|
-            lp_feature = File.join(lp, feature)
-            return true if candidates.include?(lp_feature) && !LOCK.locked_feature?(lp_feature)
-          end
-
-          false
-        end
-
         private
 
         def lookup_feature_path(path, implitic_ext: true)
@@ -251,13 +224,13 @@ module Kernel
 
     return require_without_require_hooks(path) if ctx.empty?
 
-    return false if RequireHooks::KernelPatch::Features.feature_loaded?(feature)
+    return false if $LOADED_FEATURES.include?(realpath)
 
     RequireHooks::KernelPatch::Features::LOCK.lock_feature(feature) do |loaded|
       return false if loaded
 
       $LOADED_FEATURES << realpath
-      RequireHooks::KernelPatch.load(realpath)
+      RequireHooks::KernelPatch.load(realpath, ctx: ctx)
       true
     end
   rescue LoadError => e

data/lib/require-hooks/mode/load_iseq.rb

@@ -1,24 +1,32 @@
 # frozen_string_literal: true
 
 module RequireHooks
+  EMPTY_ISEQ = RubyVM::InstructionSequence.compile("").freeze
+
   module LoadIseq
     def load_iseq(path)
       ctx = RequireHooks.context_for(path)
 
+      # Early-return for non-trackable paths
+      return if ctx.empty?
+
       ctx.run_around_load_callbacks(path) do
-        if ctx.source_transform? || ctx.hijack?
-          new_contents = ctx.perform_source_transform(path)
-          hijacked = ctx.try_hijack_load(path, new_contents)
-
-          if hijacked
-            raise TypeError, "Unsupported bytecode format for #{path}: #{hijack.class}" unless hijacked.is_a?(::RubyVM::InstructionSequence)
-            return hijacked
-          elsif new_contents
-            return RubyVM::InstructionSequence.compile(new_contents, path, path, 1)
+        iseq =
+          if ctx.source_transform? || ctx.hijack?
+            new_contents = ctx.perform_source_transform(path)
+            hijacked = ctx.try_hijack_load(path, new_contents)
+
+            if hijacked
+              raise TypeError, "Unsupported bytecode format for #{path}: #{hijack.class}" unless hijacked.is_a?(::RubyVM::InstructionSequence)
+              hijacked
+            elsif new_contents
+              RubyVM::InstructionSequence.compile(new_contents, path, path, 1)
+            end
           end
-        end
 
-        defined?(super) ? super : RubyVM::InstructionSequence.compile_file(path)
+        iseq ||= (defined?(super) ? super : RubyVM::InstructionSequence.compile_file(path))
+        iseq.eval
+        EMPTY_ISEQ
       end
     end
   end

data/lib/require-hooks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RequireHooks
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: require-hooks
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Require Hooks provide infrastructure for intercepting require/load calls
   in Ruby
@@ -28,17 +27,17 @@ files:
 - lib/require-hooks/mode/load_iseq.rb
 - lib/require-hooks/setup.rb
 - lib/require-hooks/version.rb
-homepage: https://github.com/ruby-next/ruby-next
+homepage: https://github.com/ruby-next/require-hooks
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/ruby-next/ruby-next/issues
-  changelog_uri: https://github.com/ruby-next/ruby-next/blob/master/CHANGELOG.md
-  documentation_uri: https://github.com/ruby-next/ruby-next/blob/master/README.md
-  homepage_uri: https://github.com/ruby-next/ruby-next
-  source_code_uri: https://github.com/ruby-next/ruby-next
+  bug_tracker_uri: https://github.com/ruby-next/require-hooks/issues
+  changelog_uri: https://github.com/ruby-next/require-hooks/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/ruby-next/require-hooks/blob/master/README.md
+  homepage_uri: https://github.com/ruby-next/require-hooks
+  source_code_uri: https://github.com/ruby-next/require-hooks
   funding_uri: https://github.com/sponsors/palkan
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -53,8 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Require Hooks provide infrastructure for intercepting require/load calls
   in Ruby.