im 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99d5cc6d355489148cd6f39fee0e50ce1a25d0e770e4f06c4918fdd41b05935b
-  data.tar.gz: ec2372445636beac68c84c0249b68e7e454dda3b0c49293bea4e8f14bfa52053
+  metadata.gz: 3ef66ecbb4745e878d911ec789567b204abe1bb174f57cee6b04ca6caddb76d9
+  data.tar.gz: a8cb56445189f2eb3d4fc4b7ff3b49c028b5b43cc7d8e20961481b125171d777
 SHA512:
-  metadata.gz: f9099a8d43b9772952916c21bd84da42da3eeac2541c0b4fe675fd7c373988d00a9522fc7dc2ce662ea7d0f3231ec4aec11941ab8f079350529d6476e535a19f
-  data.tar.gz: 764b1d2454d0158deba3cd4244453aab0d194036b0fe4104c0cb40bced64d5a0bdb6099db3f5c0b9d98cf75c1417707949f353524b8061c5db18ef96ea0aad2d
+  metadata.gz: f4fed0705aca8dfd1eb036ea78c5e5a71f64837134669937a31c04daf97224744d6c881363a688adaf61fa01322c0b462c1d6fa57ac5bf53b2eee72deb633634
+  data.tar.gz: a3e0d1b7e940c0afd22d4415d855964b73a043390fd6538f075affe1eb29964c5b7c3b4cf675a738a6b999ab73cba72ce2ec86af790797866ff97ee685979fb5

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.1.6] - 2022-10-03
+- Remove `Object.const_missing` patch (Ruby patch now handles dynamic toplevel
+  references)
+
+## [0.1.5] - 2022-09-22
+- Rename Im::Dependency -> Im::Require
+- Handle dynamic requires (require called from method body after file has been imported)
+- Refactor: move require/autoload patch logic to Im handler methods
+
 ## [0.1.4] - 2022-09-19
 - Correctly assign constants imported via recursive requires
 

data/Gemfile

@@ -6,4 +6,3 @@ source "https://rubygems.org"
 gemspec
 
 gem "rspec", "~> 3.0"
-gem "rails"

data/Gemfile.lock

@@ -1,144 +1,12 @@
 PATH
   remote: .
   specs:
-    im (0.1.3)
+    im (0.1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.4)
-      actionpack (= 7.0.4)
-      activesupport (= 7.0.4)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.4)
-      actionpack (= 7.0.4)
-      activejob (= 7.0.4)
-      activerecord (= 7.0.4)
-      activestorage (= 7.0.4)
-      activesupport (= 7.0.4)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.0.4)
-      actionpack (= 7.0.4)
-      actionview (= 7.0.4)
-      activejob (= 7.0.4)
-      activesupport (= 7.0.4)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
-      rails-dom-testing (~> 2.0)
-    actionpack (7.0.4)
-      actionview (= 7.0.4)
-      activesupport (= 7.0.4)
-      rack (~> 2.0, >= 2.2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.4)
-      actionpack (= 7.0.4)
-      activerecord (= 7.0.4)
-      activestorage (= 7.0.4)
-      activesupport (= 7.0.4)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (7.0.4)
-      activesupport (= 7.0.4)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.4)
-      activesupport (= 7.0.4)
-      globalid (>= 0.3.6)
-    activemodel (7.0.4)
-      activesupport (= 7.0.4)
-    activerecord (7.0.4)
-      activemodel (= 7.0.4)
-      activesupport (= 7.0.4)
-    activestorage (7.0.4)
-      actionpack (= 7.0.4)
-      activejob (= 7.0.4)
-      activerecord (= 7.0.4)
-      activesupport (= 7.0.4)
-      marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (7.0.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    builder (3.2.4)
-    concurrent-ruby (1.1.10)
-    crass (1.0.6)
     diff-lcs (1.5.0)
-    digest (3.1.0)
-    erubi (1.11.0)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
-    loofah (2.19.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    mini_portile2 (2.8.0)
-    minitest (5.16.3)
-    net-imap (0.2.3)
-      digest
-      net-protocol
-      strscan
-    net-pop (0.1.1)
-      digest
-      net-protocol
-      timeout
-    net-protocol (0.1.3)
-      timeout
-    net-smtp (0.3.1)
-      digest
-      net-protocol
-      timeout
-    nio4r (2.5.8)
-    nokogiri (1.13.8)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
-    racc (1.6.0)
-    rack (2.2.4)
-    rack-test (2.0.2)
-      rack (>= 1.3)
-    rails (7.0.4)
-      actioncable (= 7.0.4)
-      actionmailbox (= 7.0.4)
-      actionmailer (= 7.0.4)
-      actionpack (= 7.0.4)
-      actiontext (= 7.0.4)
-      actionview (= 7.0.4)
-      activejob (= 7.0.4)
-      activemodel (= 7.0.4)
-      activerecord (= 7.0.4)
-      activestorage (= 7.0.4)
-      activesupport (= 7.0.4)
-      bundler (>= 1.15.0)
-      railties (= 7.0.4)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
-    railties (7.0.4)
-      actionpack (= 7.0.4)
-      activesupport (= 7.0.4)
-      method_source
-      rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
     rake (13.0.6)
     rake-compiler (1.2.0)
       rake
@@ -155,25 +23,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    strscan (3.0.4)
-    thor (1.2.1)
-    timeout (0.3.0)
-    tzinfo (2.0.5)
-      concurrent-ruby (~> 1.0)
-    websocket-driver (0.7.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.6.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   im!
-  rails
   rake (~> 13.0)
   rake-compiler
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.4.0.dev
+   2.3.18

data/README.md

@@ -24,8 +24,8 @@ require "im"
 
 extend Im
 
-mod = import "activemodel"
-#=> #<Im::Import:0x00007f2d34dfd0c8 root: active_model>
+mod = import "active_model"
+#=> <#Im::Import root: active_model>
 ```
 
 Constants in the imported files are under the returned module, not the root namespace:

data/lib/im/kernel.rb

@@ -4,42 +4,16 @@ module Kernel
   alias_method :im_original_require, :require
 
   def require(path)
-    if Im.autoloads.key?(path)
-      return Im.with_import(Im.autoloads.delete(path)) do |_context|
-        !!Im.import(path)
-      end
+    Im.handle_require(path, caller_locations(1, 1).first.path) do
+      im_original_require(path)
     end
+  end
 
-    if Im.importing? && (resolved = $LOAD_PATH.resolve_feature_path(path))
-      resolved_path = resolved[1]
-      Im.registry[resolved_path] ||= Im::Dependency.new(resolved_path, Im.current_import)
-    end
-
-    loaded = im_original_require(path)
-    return loaded unless Im.importing?
-
-    if resolved
-      dependency = Im.registry[resolved_path]
-
-      if loaded && Im.registry.key?(location = caller_locations(1, 1).first.path)
-        Im.registry[location].dependencies << dependency
-      end
-
-      dependency.dependencies.each { |d| require d.path }
-
-      dependency.modules.each do |m|
-        name = m.name
-
-        # Do not assign constants that are aliased to root namespace
-        root = name.split("::", 2)[0]
-        next if Object.const_defined?(root) &&
-          Im.current_import.const_defined?(root, false) &&
-          Object.const_get(root) == Im.current_import.const_get(root)
+  alias_method :im_original_autoload, :autoload
 
-        Im.current_import.const_set(name, m) unless Im.current_import.const_defined?(name, false)
-      end
+  def autoload(name, path)
+    Im.handle_autoload(path) do
+      im_original_autoload(name, path)
     end
-
-    return loaded
   end
 end

data/lib/im/module.rb

@@ -2,7 +2,8 @@ class Module
   alias_method :im_original_autoload, :autoload
 
   def autoload(name, path)
-    Im.autoloads[path] = Im.current_import if Im.importing?
-    im_original_autoload(name, path)
+    Im.handle_autoload(path) do
+      im_original_autoload(name, path)
+    end
   end
 end

data/lib/im/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Im
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/lib/im.rb

@@ -1,38 +1,103 @@
 # frozen_string_literal: true
 
 module Im
-  load $LOAD_PATH.resolve_feature_path("im/ruby_version_check")[1], true
+  load $:.resolve_feature_path("im/ruby_version_check")[1], true
+
+  @toplevel_constants = Object.constants.reject { |c| Object.autoload?(c) }
+  @autoloads = {}
+  @registry = {}
+  @current_imports = []
+
   require "im/version"
   require "im/kernel"
 
   class << self
-    attr_reader :current_import
+    attr_reader :current_imports, :registry, :autoloads, :toplevel_constants
 
     def with_import(import)
-      original_import = current_import
-      @current_import = import
+      @current_imports.push(import || current_import)
 
       unless tracer_originally_enabled = @tracer.enabled?
         @tracer.enable
       end
 
-      yield(import)
-
+      yield
     ensure
-      @current_import = original_import
+      @current_imports.pop
       @tracer.disable unless tracer_originally_enabled
     end
 
-    def registry
-      @registry ||= {}
+    def current_import
+      current_imports.last
     end
 
-    def autoloads
-      @autoloads ||= {}
+    def importing?
+      !!current_import
     end
 
-    def importing?
-      !!Im.current_import
+    def handle_require(path, caller_path)
+      resolved_path = resolve_path(path)
+
+      return yield unless resolved_path
+
+      if autoloaded = autoloads.delete(resolved_path)
+        return with_import(autoloaded) do
+          !!import(path)
+        end
+      end
+
+      if importing?
+        registry[resolved_path] ||= Require.new(resolved_path, current_import)
+      elsif registry.key?(caller_path)
+        return with_import(registry[caller_path].import) do
+          !!import(resolved_path)
+        end
+      end
+
+      loaded = yield # super
+
+      if required = registry[resolved_path]
+        if loaded && registry.key?(caller_path)
+          registry[caller_path].requires << required
+        end
+
+        imports = importing? ? current_imports : [Object]
+        import_constants(required, imports)
+      end
+
+      loaded
+    end
+
+    def handle_autoload(path)
+      if importing? && (resolved_path = resolve_path(path))
+        autoloads[resolved_path] = current_import
+      end
+      yield
+    end
+
+    def resolve_path(path)
+      (resolved = $:.resolve_feature_path(path)) && resolved[1]
+    end
+
+    def import_constants(required, imports)
+      return if imports.empty? || required.nil?
+
+      required.requires.each { |r| require r.path }
+
+      imports.each do |import|
+        required.defined_constants.each do |name, mod|
+          # Do not assign constants that are aliased to root namespace
+          root = name.to_s.split("::", 2)[0]
+          next if Object.const_defined?(root) &&
+            import.const_defined?(root, false) &&
+            Object.const_get(root) == import.const_get(root)
+
+          begin
+            import.const_set(name, mod) unless import.const_defined?(name, false)
+          rescue NameError
+          end
+        end
+      end
     end
   end
 
@@ -40,85 +105,89 @@ module Im
     def initialize(root)
       @root = root
       super()
-      Im::CONSTANTS.each do |const|
-        self.const_set(const, Object.const_get(const))
+      Im.with_import(self) do
+        Im.toplevel_constants.each do |const|
+          self.const_set(const, Object.const_get(const))
+        end
       end
     end
 
     def inspect
       @inspect ||= "<#Im::Import root: #{@root}>"
     end
+
+    def const_added(name)
+      path = const_source_location(name)[0]
+      value = const_get(name, false)
+      Im.registry[path] ||= Require.new(path, self)
+      Im.registry[path].defined_constants[name] ||= value
+      super
+    end
   end
 
-  Dependency = Struct.new(:path, :import, :modules, :dependencies) do
-    def initialize(path, import, modules = [], dependencies = [])
-      super(path, import, modules, dependencies)
+  Require = Struct.new(:path, :import, :defined_constants, :requires) do
+    def initialize(path, import, defined_constants = {}, requires = [])
+      super
     end
   end
 
   def import(path)
-    if resolved = $LOAD_PATH.resolve_feature_path(path)
+    if resolved = $:.resolve_feature_path(path)
       resolved_path = resolved[1]
       raise LoadError, "import can only import ruby files" unless resolved[0] == :rb
     else
       raise LoadError, "cannot load such file -- #{path}"
     end
 
-    Im.registry.fetch(resolved_path) do
+    required = Im.registry.fetch(resolved_path) do
       # handle autoload within import
       return nil if $LOADED_FEATURES.include?(resolved_path)
 
       $LOADED_FEATURES << resolved_path
 
       import = Im.current_import || Import.new(path)
-      (Im.registry[resolved_path] ||= Dependency.new(resolved_path, import)).tap do
+      (Im.registry[resolved_path] ||= Require.new(resolved_path, import)).tap do
         Im.with_import(import) do
           load resolved_path, import
         end
       end
-    end&.import
-  end
-
-  # This is a hack to catch references to top-level constants (`::Foo`) and, if
-  # the calling line is a key in the Im registry, replace the toplevel constant
-  # reference with its corresponding constant under the import namespace.
-  #
-  # By doing this, a reference to `::Foo` in an imported file will resolve to
-  # `mod::Foo`, where `mod` is the import module. Ideally this should
-  # ultimately happen at the Ruby implementation level.
-  module RootNamespaceRedirect
-    def const_missing(name)
-
-      # Take top five locations to allow for other `const_missing` overrides
-      # in the backtrace. If there are more than five, then this will no longer
-      # work. This is currently very inefficient.
-      if location = caller_locations(1, 5).find { |l| Im.registry.key?(l.path) }
-        Im.registry[location.path].import.const_get(name)
-      else
-        super
-      end
     end
+
+    Im.import_constants(required, Im.current_imports)
+
+    required&.import
   end
 
   @tracer = TracePoint.new(:class) do |event|
-    next unless (name = event.self.name)
-    next if Im::CONSTANTS.include?(name.to_sym)
-
-    if resolved = $LOAD_PATH.resolve_feature_path(event.path)
+    next unless (name = event.self.name&.to_sym)
+    next if Im.toplevel_constants.include?(name)
+
+    # We don't want to track classes defined under singleton classes, like
+    # this:
+    #
+    #   class Foo
+    #     class << self
+    #       class Bar
+    #       end
+    #     end
+    #   end
+    #
+    # Here, `class Bar` will trigger a TracePoint event, and because of the
+    # Ruby patch `name` will return "Bar", but this is not actually a class we
+    # need to alias in imports, so we can safely skip it. The only way I've
+    # found to do that though is to evaluate `Module.nesting` from the event's
+    # binding. This is weird, but it works!
+    #
+    next if event.binding.eval("Module.nesting").any?(&:singleton_class?)
+
+    if resolved = $:.resolve_feature_path(event.path)
       resolved_path = resolved[1]
-      if Im.registry.key?(resolved_path)
-        (Im.registry[resolved_path].modules << event.self).uniq!
-      else
-        Im.registry[resolved_path] = Dependency.new(resolved_path, Im.current_import, [event.self])
-      end
+      Im.registry[resolved_path] ||= Require.new(resolved_path, Im.current_import)
+      Im.registry[resolved_path].defined_constants[name] = event.self
     end
   end
 
   require "im/module"
-  require "im/autoload"
-  require "im/constants"
 
   extend self
 end
-
-Object.extend Im::RootNamespaceRedirect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: im
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Chris Salzberg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,8 +66,6 @@ files:
 - README.md
 - Rakefile
 - lib/im.rb
-- lib/im/autoload.rb
-- lib/im/constants.rb
 - lib/im/kernel.rb
 - lib/im/module.rb
 - lib/im/ruby_version_check.rb
@@ -96,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Module import system.

data/lib/im/autoload.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Im
-  module Autoload
-    def autoload(name, path)
-      Im.autoloads[path] = Im.current_import if Im.importing?
-      super(name, path)
-    end
-  end
-end

data/lib/im/constants.rb

@@ -1,104 +0,0 @@
-module Im
-  # It's faster to just hard-code constants than to introspect them at runtime
-  CONSTANTS = [
-    :ArgumentError,
-    :Array,
-    :BasicObject,
-    :Binding,
-    :Class,
-    :ClosedQueueError,
-    :Comparable,
-    :Complex,
-    :ConditionVariable,
-    :DidYouMean,
-    :Dir,
-    :Encoding,
-    :EncodingError,
-    :Enumerable,
-    :Enumerator,
-    :EOFError,
-    :Errno,
-    :ErrorHighlight,
-    :Exception,
-    :FalseClass,
-    :Fiber,
-    :FiberError,
-    :File,
-    :FileTest,
-    :Float,
-    :FloatDomainError,
-    :FrozenError,
-    :GC,
-    :Gem,
-    :Hash,
-    :IndexError,
-    :Integer,
-    :Interrupt,
-    :IO,
-    :IOError,
-    :Kernel,
-    :KeyError,
-    :LoadError,
-    :LocalJumpError,
-    :Marshal,
-    :MatchData,
-    :Math,
-    :Method,
-    :Module,
-    :Monitor,
-    :MonitorMixin,
-    :Mutex,
-    :NameError,
-    :NilClass,
-    :NoMatchingPatternError,
-    :NoMatchingPatternKeyError,
-    :NoMemoryError,
-    :NoMethodError,
-    :NotImplementedError,
-    :Numeric,
-    :Object,
-    :ObjectSpace,
-    :Proc,
-    :Process,
-    :Queue,
-    :Ractor,
-    :Random,
-    :Range,
-    :RangeError,
-    :Rational,
-    :RbConfig,
-    :Refinement,
-    :Regexp,
-    :RegexpError,
-    :RubyVM,
-    :RuntimeError,
-    :ScriptError,
-    :SecurityError,
-    :Set,
-    :Signal,
-    :SignalException,
-    :SizedQueue,
-    :StandardError,
-    :StopIteration,
-    :String,
-    :Struct,
-    :Symbol,
-    :SyntaxError,
-    :SystemCallError,
-    :SystemExit,
-    :SystemStackError,
-    :Thread,
-    :ThreadError,
-    :ThreadGroup,
-    :Time,
-    :TracePoint,
-    :TrueClass,
-    :TypeError,
-    :UnboundMethod,
-    :UncaughtThrowError,
-    :UnicodeNormalize,
-    :URI,
-    :Warning,
-    :ZeroDivisionError,
-  ]
-end