im 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f60f56fa26101e6aeec8d3a9123f1ce8196a60ff559931ec91418316cef13e2
-  data.tar.gz: 445bf0961717077dd35e5ab900b1ab235b25a834a0b1123ed6936c2770439872
+  metadata.gz: 707475c4bc1ad6a6bf6207ca9f892a92b72a911f2fcb3cf0561e203041ede864
+  data.tar.gz: c4ad0fc4bb0f0da2dc2b31d64ba904db9f8c3f3e87fb97def63dbbdc91cd3cf8
 SHA512:
-  metadata.gz: d0c2063a12bc66f6e86565a27d1e58e2079a88466a61c42a9830fbb0705864ee33f1c780f367dbe61e55b1e21a741cd6c05fc2e4cb7c50ee2bca1625096898c1
-  data.tar.gz: 4ba1c608ba252e26625ddd136fcaddb3ac8b9f6a5f79db80796ce82ebd8b96da1560b946c79d31a8e658c1fbe5e727d6e68c793dd6a8944e6ceb60b62dd01182
+  metadata.gz: 4bd14ecfb9804594795da0db412840cc5cb8a11500a335f66dbb88424575e04bfb6b4ead19480edcdf3f68fa957be0665a3c3a317c6c832a043fb645044bfa16
+  data.tar.gz: '0048891c47b3f9bd6785141c71412c10f2ce63d746dbed8ac4e515b968e26dfe26a524ddbf8e9629eb2aa4b8fe11ef9c26ced56fa0ba6fa7d401185036e99aa8'

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 ## [Unreleased]
 
-## [0.1.2] - 2022-09-16
+## [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
+
+## [0.1.3] - 2022-09-16
 - Fix gemspec
 
 ## [0.1.1] - 2022-09-16

data/Gemfile

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

data/Gemfile.lock

@@ -1,12 +1,144 @@
 PATH
   remote: .
   specs:
-    im (0.1.2)
+    im (0.1.4)
 
 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
@@ -23,15 +155,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    sqlite3 (1.5.0)
+      mini_portile2 (~> 2.8.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)
+  sqlite3
 
 BUNDLED WITH
    2.4.0.dev

data/lib/im/kernel.rb

@@ -4,35 +4,16 @@ module Kernel
   alias_method :im_original_require, :require
 
   def require(path)
-    if Im.autoloads.key?(path)
-      return Im.with_context(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
 
-    loaded = im_original_require(path)
-    return loaded unless Im.current_import
-
-    if resolved = $LOAD_PATH.resolve_feature_path(path)
-      if Im.registry.key?(resolved_path = resolved[1])
-        _, modules = Im.registry[resolved_path]
-
-        modules.each do |m|
-          next unless 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
-      else
-        Im.registry[resolved_path] ||= [Im.current_import, []] if Im.current_import
-      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.current_import
-    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.3"
+  VERSION = "0.1.5"
 end

data/lib/im.rb

@@ -2,27 +2,93 @@
 
 module Im
   load $LOAD_PATH.resolve_feature_path("im/ruby_version_check")[1], true
+
+  @constants = Object.constants.reject { |c| Kernel.autoload?(c) }.dup
+  @autoloads = {}
+  @registry = {}
+
   require "im/version"
   require "im/kernel"
 
   class << self
-    attr_reader :current_import
-    attr_reader :tracer
+    attr_reader :current_import, :registry, :autoloads, :constants
+
+    def with_import(import)
+      original_import = current_import
+      @current_import = import || Im.current_import
+
+      unless tracer_originally_enabled = @tracer.enabled?
+        @tracer.enable
+      end
+
+      yield(import)
 
-    def with_context(context)
-      original_context = current_import
-      @current_import = context
-      yield(context)
     ensure
-      @current_import = original_context
+      @current_import = original_import
+      @tracer.disable unless tracer_originally_enabled
     end
 
-    def registry
-      @registry ||= {}
+    def importing?
+      !!Im.current_import
     end
 
-    def autoloads
-      @autoloads ||= {}
+    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|
+          !!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|
+          !!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
+
+        required.requires.each { |r| require r.path }
+        import = current_import || Object
+
+        required.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) &&
+            import.const_defined?(root, false) &&
+            Object.const_get(root) == import.const_get(root)
+
+          begin
+            import.const_set(name, m) unless import.const_defined?(name, false)
+          rescue NameError
+          end
+        end
+      end
+
+      loaded
+    end
+
+    def handle_autoload(path)
+      if resolved_path = resolve_path(path)
+        Im.autoloads[resolved_path] = Im.current_import
+      end
+      yield
+    end
+
+    def resolve_path(path)
+      (resolved = $LOAD_PATH.resolve_feature_path(path)) && resolved[1]
     end
   end
 
@@ -30,8 +96,10 @@ 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.constants.each do |const|
+          self.const_set(const, Object.const_get(const))
+        end
       end
     end
 
@@ -40,6 +108,12 @@ module Im
     end
   end
 
+  Require = Struct.new(:path, :import, :modules, :requires) do
+    def initialize(path, import, modules = [], requires = [])
+      super(path, import, modules, requires)
+    end
+  end
+
   def import(path)
     if resolved = $LOAD_PATH.resolve_feature_path(path)
       resolved_path = resolved[1]
@@ -54,23 +128,30 @@ module Im
 
       $LOADED_FEATURES << resolved_path
 
-      context = Im.current_import || Import.new(path)
-
-      Im.with_context(context) do
-        originally_enabled = Im.tracer.enabled?
-        Im.tracer.enable
-        load resolved_path, context
-        Im.tracer.disable unless originally_enabled
+      import = Im.current_import || Import.new(path)
+      (Im.registry[resolved_path] ||= Require.new(resolved_path, import)).tap do
+        Im.with_import(import) do
+          load resolved_path, import
+        end
       end
-
-      Im.registry[resolved_path] ||= [context, []]
-    end[0]
+    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)
-      if Im.current_import && Im.current_import.const_defined?(name)
-        Im.current_import.const_get(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
@@ -78,19 +159,20 @@ module Im
   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)
       resolved_path = resolved[1]
       if Im.registry.key?(resolved_path)
-        (Im.registry[resolved_path][1] << event.self).uniq!
+        (Im.registry[resolved_path].modules << event.self).uniq!
       else
-        Im.registry[resolved_path] = [Im.current_import, [event.self]]
+        Im.registry[resolved_path] = Require.new(resolved_path, Im.current_import, [event.self])
       end
     end
   end
 
   require "im/module"
-  require "im/autoload"
-  require "im/constants"
 
   extend self
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: im
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Chris Salzberg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-16 00:00:00.000000000 Z
+date: 2022-09-22 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

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.current_import
-      super(name, path)
-    end
-  end
-end

data/lib/im/constants.rb

@@ -1,103 +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,
-    :Warning,
-    :ZeroDivisionError,
-  ]
-end