opal-zeitwerk 0.3.0 → 0.4.0

data/opal/zeitwerk/real_mod_name.rb

@@ -1,21 +1,20 @@
-module Zeitwerk::RealModName
-  UNBOUND_METHOD_MODULE_NAME = Module.instance_method(:name)
-  private_constant :UNBOUND_METHOD_MODULE_NAME
-
-  # Returns the real name of the class or module, as set after the first
-  # constant to which it was assigned (or nil).
-  #
-  # The name method can be overridden, hence the indirection in this method.
-  #
-  # @param mod [Class, Module]
-  # @return [String, nil]
-  if UnboundMethod.method_defined?(:bind_call)
-    def real_mod_name(mod)
-      UNBOUND_METHOD_MODULE_NAME.bind_call(mod)
-    end
-  else
-    def real_mod_name(mod)
-      UNBOUND_METHOD_MODULE_NAME.bind(mod).call
-    end
-  end
-end
+module Zeitwerk::RealModName
+  UNBOUND_METHOD_MODULE_NAME = Module.instance_method(:name)
+  private_constant :UNBOUND_METHOD_MODULE_NAME
+
+  # Returns the real name of the class or module, as set after the first
+  # constant to which it was assigned (or nil).
+  #
+  # The name method can be overridden, hence the indirection in this method.
+  #
+  # @sig (Module) -> String?
+  if UnboundMethod.method_defined?(:bind_call)
+    def real_mod_name(mod)
+      UNBOUND_METHOD_MODULE_NAME.bind_call(mod)
+    end
+  else
+    def real_mod_name(mod)
+      UNBOUND_METHOD_MODULE_NAME.bind(mod).call
+    end
+  end
+end

data/opal/zeitwerk/registry.rb

@@ -1,121 +1,143 @@
-module Zeitwerk
-  module Registry # :nodoc: all
-    class << self
-      # Keeps track of all loaders. Useful to broadcast messages and to prevent
-      # them from being garbage collected.
-      #
-      # @private
-      # @return [<Zeitwerk::Loader>]
-      attr_reader :loaders
-
-      # Maps real paths to the loaders responsible for them.
-      #
-      # This information is used by our decorated `Kernel#require` to be able to
-      # invoke callbacks and autovivify modules.
-      #
-      # @private
-      # @return [{String => Zeitwerk::Loader}]
-      attr_reader :autoloads
-
-      # This hash table addresses an edge case in which an autoload is ignored.
-      #
-      # For example, let's suppose we want to autoload in a gem like this:
-      #
-      #   # lib/my_gem.rb
-      #   loader = Zeitwerk::Loader.new
-      #   loader.push_dir(__dir__)
-      #   loader.setup
-      #
-      #   module MyGem
-      #   end
-      #
-      # if you require "my_gem", as Bundler would do, this happens while setting
-      # up autoloads:
-      #
-      #   1. Object.autoload?(:MyGem) returns `nil` because the autoload for
-      #      the constant is issued by Zeitwerk while the same file is being
-      #      required.
-      #   2. The constant `MyGem` is undefined while setup runs.
-      #
-      # Therefore, a directory `lib/my_gem` would autovivify a module according to
-      # the existing information. But that would be wrong.
-      #
-      # To overcome this fundamental limitation, we keep track of the constant
-      # paths that are in this situation ---in the example above, "MyGem"--- and
-      # take this collection into account for the autovivification logic.
-      #
-      # Note that you cannot generally address this by moving the setup code
-      # below the constant definition, because we want libraries to be able to
-      # use managed constants in the module body:
-      #
-      #   module MyGem
-      #     include MyConcern
-      #   end
-      #
-      # @private
-      # @return [{String => (String, Zeitwerk::Loader)}]
-      attr_reader :inceptions
-
-      # Registers a loader.
-      #
-      # @private
-      # @param loader [Zeitwerk::Loader]
-      # @return [void]
-      def register_loader(loader)
-        loaders << loader
-      end
-
-      # @private
-      # @param loader [Zeitwerk::Loader]
-      # @param realpath [String]
-      # @return [void]
-      def register_autoload(loader, realpath)
-        autoloads[realpath] = loader
-      end
-
-      # @private
-      # @param realpath [String]
-      # @return [void]
-      def unregister_autoload(realpath)
-        autoloads.delete(realpath)
-      end
-
-      # @private
-      # @param cpath [String]
-      # @param realpath [String]
-      # @param loader [Zeitwerk::Loader]
-      # @return [void]
-      def register_inception(cpath, realpath, loader)
-        inceptions[cpath] = [realpath, loader]
-      end
-
-      # @private
-      # @param cpath [String]
-      # @return [String, nil]
-      def inception?(cpath)
-        if pair = inceptions[cpath]
-          pair.first
-        end
-      end
-
-      # @private
-      # @param path [String]
-      # @return [Zeitwerk::Loader, nil]
-      def loader_for(path)
-        autoloads[path]
-      end
-
-      # @private
-      # @param loader [Zeitwerk::Loader]
-      # @return [void]
-      def on_unload(loader)
-        autoloads.delete_if { |_path, object| object == loader }
-        inceptions.delete_if { |_cpath, (_path, object)| object == loader }
-      end
-    end
-
-    @loaders               = []
-    @autoloads             = {}
-    @inceptions            = {}
-  end
-end
+module Zeitwerk
+  module Registry # :nodoc: all
+    class << self
+      # Keeps track of all loaders. Useful to broadcast messages and to prevent
+      # them from being garbage collected.
+      #
+      # @private
+      # @sig Array[Zeitwerk::Loader]
+      attr_reader :loaders
+
+      # Registers loaders created with `for_gem` to make the method idempotent
+      # in case of reload.
+      #
+      # @private
+      # @sig Hash[String, Zeitwerk::Loader]
+      attr_reader :loaders_managing_gems
+
+      # Maps absolute paths to the loaders responsible for them.
+      #
+      # This information is used by our decorated `Kernel#require` to be able to
+      # invoke callbacks and autovivify modules.
+      #
+      # @private
+      # @sig Hash[String, Zeitwerk::Loader]
+      attr_reader :autoloads
+
+      # This hash table addresses an edge case in which an autoload is ignored.
+      #
+      # For example, let's suppose we want to autoload in a gem like this:
+      #
+      #   # lib/my_gem.rb
+      #   loader = Zeitwerk::Loader.new
+      #   loader.push_dir(__dir__)
+      #   loader.setup
+      #
+      #   module MyGem
+      #   end
+      #
+      # if you require "my_gem", as Bundler would do, this happens while setting
+      # up autoloads:
+      #
+      #   1. Object.autoload?(:MyGem) returns `nil` because the autoload for
+      #      the constant is issued by Zeitwerk while the same file is being
+      #      required.
+      #   2. The constant `MyGem` is undefined while setup runs.
+      #
+      # Therefore, a directory `lib/my_gem` would autovivify a module according to
+      # the existing information. But that would be wrong.
+      #
+      # To overcome this fundamental limitation, we keep track of the constant
+      # paths that are in this situation ---in the example above, "MyGem"--- and
+      # take this collection into account for the autovivification logic.
+      #
+      # Note that you cannot generally address this by moving the setup code
+      # below the constant definition, because we want libraries to be able to
+      # use managed constants in the module body:
+      #
+      #   module MyGem
+      #     include MyConcern
+      #   end
+      #
+      # @private
+      # @sig Hash[String, [String, Zeitwerk::Loader]]
+      attr_reader :inceptions
+
+      # Registers a loader.
+      #
+      # @private
+      # @sig (Zeitwerk::Loader) -> void
+      def register_loader(loader)
+        loaders << loader
+      end
+
+      # @private
+      # @sig (Zeitwerk::Loader) -> void
+      def unregister_loader(loader)
+        loaders.delete(loader)
+        loaders_managing_gems.delete_if { |_, l| l == loader }
+        autoloads.delete_if { |_, l| l == loader }
+        inceptions.delete_if { |_, (_, l)| l == loader }
+      end
+
+      # This method returns always a loader, the same instance for the same root
+      # file. That is how Zeitwerk::Loader.for_gem is idempotent.
+      #
+      # @private
+      # @sig (String) -> Zeitwerk::Loader
+      def loader_for_gem(root_file)
+        loaders_managing_gems[root_file] ||= begin
+          Loader.new.tap do |loader|
+            loader.tag = File.basename(root_file, ".rb")
+            loader.inflector = GemInflector.new(root_file)
+            loader.push_dir(File.dirname(root_file))
+          end
+        end
+      end
+
+      # @private
+      # @sig (Zeitwerk::Loader, String) -> String
+      def register_autoload(loader, abspath)
+        autoloads[abspath] = loader
+      end
+
+      # @private
+      # @sig (String) -> void
+      def unregister_autoload(abspath)
+        autoloads.delete(abspath)
+      end
+
+      # @private
+      # @sig (String, String, Zeitwerk::Loader) -> void
+      def register_inception(cpath, abspath, loader)
+        inceptions[cpath] = [abspath, loader]
+      end
+
+      # @private
+      # @sig (String) -> String?
+      def inception?(cpath)
+        if pair = inceptions[cpath]
+          pair.first
+        end
+      end
+
+      # @private
+      # @sig (String) -> Zeitwerk::Loader?
+      def loader_for(path)
+        autoloads[path]
+      end
+
+      # @private
+      # @sig (Zeitwerk::Loader) -> void
+      def on_unload(loader)
+        autoloads.delete_if { |_path, object| object == loader }
+        inceptions.delete_if { |_cpath, (_path, object)| object == loader }
+      end
+    end
+
+    @loaders               = []
+    @loaders_managing_gems = {}
+    @autoloads             = {}
+    @inceptions            = {}
+  end
+end

data/opal/zeitwerk.rb

@@ -1,13 +1,14 @@
-require 'opal'
-require 'corelib/trace_point'
-require 'securerandom'
-
-module Zeitwerk
-  require_relative "zeitwerk/real_mod_name"
-  require_relative "zeitwerk/loader"
-  require_relative "zeitwerk/registry"
-  require_relative "zeitwerk/explicit_namespace"
-  require_relative "zeitwerk/inflector"
-  require_relative "zeitwerk/kernel"
-  require_relative "zeitwerk/error"
-end
+require 'opal'
+require 'corelib/trace_point'
+require 'securerandom'
+
+module Zeitwerk
+  require_relative "zeitwerk/real_mod_name"
+  require_relative "zeitwerk/loader"
+  require_relative "zeitwerk/registry"
+  require_relative "zeitwerk/explicit_namespace"
+  require_relative "zeitwerk/inflector"
+  require_relative "zeitwerk/gem_inflector"
+  require_relative "zeitwerk/kernel"
+  require_relative "zeitwerk/error"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal-zeitwerk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jan Biedermann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-25 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.1
 description: |2
       A port of the Zeitwerk autoloader to Opal.
       Zeitwerk implements constant autoloading with Ruby semantics. Each gem
@@ -41,10 +41,13 @@ files:
 - opal/zeitwerk.rb
 - opal/zeitwerk/error.rb
 - opal/zeitwerk/explicit_namespace.rb
+- opal/zeitwerk/gem_inflector.rb
 - opal/zeitwerk/inflector.rb
 - opal/zeitwerk/kernel.rb
 - opal/zeitwerk/loader.rb
 - opal/zeitwerk/loader/callbacks.rb
+- opal/zeitwerk/loader/config.rb
+- opal/zeitwerk/loader/helpers.rb
 - opal/zeitwerk/real_mod_name.rb
 - opal/zeitwerk/registry.rb
 homepage: https://github.com/isomorfeus/opal-zeitwerk
@@ -67,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Opal constant autoloader using Zeitwerk