zeroload 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ff5fae430018bfb1219524cfd85e641487ccdd4
-  data.tar.gz: cf6085c9d9b835345a5046aaf4a4e8822cd9015f
+  metadata.gz: 3044e8cfa181f2091ca8133fc4799d199fe06aa9
+  data.tar.gz: ab6233dfc22ac453539d27aec3e0960911952fe4
 SHA512:
-  metadata.gz: 830b47b027951eafaf5b6175d1f4ab23c94a81b03a10468e9518618ad54ee8f133b0f2cdff2bda0c97334282943c9b543b1a49f4831598eda87e81952d70668a
-  data.tar.gz: f2799be3bdb1aae80d1082fbb061743bb1b9e36faa81b1773f6014d11c7deec7bb931dbac07f9bf4e411ccaa4e97395709224fae0272a59518c1732f2476a972
+  metadata.gz: 7a9703f11a869319b104784e233487d92932646e5f6c03d1942fa7c75f98bce0ec17a6ff9ef49c78cbfa2b2708fc30ba372e499c42217815f24a347eded122e3
+  data.tar.gz: a1ea891510cf0f3ed460cafb838904cd6fc451045e684458acb16e569ac6876dfc85271afa803e7efd9d4c3a8902b9b81a9c0a7d71d65c29b0c9e8be4105b48d

data/README.markdown

@@ -35,7 +35,7 @@ Given the files
 
 The contents of lib/Foo.rb is:
 
-    require "zeroload"
+    require "Zeroload"
 
     module Foo
       zeroload!
@@ -51,7 +51,8 @@ And the contents of lib/Foo/bar.rb is:
       class Bar
         zeroload! # only necessary if there's stuff nested below 
 
-      # Code of Foo::Bar
+        # Code of Foo::Bar
+      end
     end
 
 
@@ -73,3 +74,6 @@ Caveats
   * [see Revision 33078](https://bugs.ruby-lang.org/projects/ruby-trunk/repository/revisions/33078)
 * **Q:** But isn't Kernel#autoload deprecated?
 * **A:** Sadly, the state on this is not entirely clear. But it seems it is no longer deprecated.
+* **Q:** But with autoloaded constants, Module#constants will not report all constants.
+* **A:** That is not correct. Autoloaded (but not yet loaded) constants show up with
+  Module#constants. But you can also use Zeroconf.preload! to load all constants at once.

data/lib/Zeroload.rb

@@ -0,0 +1,117 @@
+require "Zeroload/Version"
+
+# Zeroload
+# Automatically autoload all constants for a module. This requires a change from
+# the current convention of putting class Foo::BarBaz into foo/barbaz.rb (or
+# foo/bar_baz.rb in rails) to using Foo/BarBaz.rb instead.
+#
+# @example Usage
+#     require "Zeroload"
+#
+#     class Foo
+#        zeroload! # calls Zeroload.module(Foo)
+#     end
+#     Foo::Bar # will now load Foo/Bar.rb
+#
+module Zeroload
+
+  # Controls whether Module is automatically patched or not.
+  # Zeroload/no_patch.rb sets it to false. It is not advised to use this
+  # option, since using zeroload is viral.
+  #
+  Patch = true unless defined?(Patch)
+
+  # All registered autoloads. A nested hash of the structure:  
+  # `{NestedModuleName: {UnnestedModuleName => path}`  
+  # e.g. `{"Foo::Bar" => {"Baz" => "/absolute/path/to/Foo/Bar/Baz.rb"}}`
+  #
+  Registry = {}
+
+  # Module#name as UnboundMethod
+  #
+  Name     = Module.instance_method(:name)
+
+  # Patches the Module class, adding Module#zeroload!, which invokes
+  # 
+  # @return self
+  #
+  def self.patch!
+    ::Module.class_eval do
+      def zeroload!(directory=nil, *args)
+        directory ||= caller_locations.first.absolute_path.sub(/\.[^.]*\z/, "")
+
+        Zeroload.module(self, directory, *args)
+      end
+    end
+
+    self
+  end
+
+  patch! if Patch
+
+  # Register a module to be zero-loaded.  
+  # Use Module#zeroload! instead.
+  #
+  # @param [Module, Class] mod
+  #   The module which should be autoloaded.
+  # @param [String, nil] directory
+  #   The directory in which to search for nested constants.
+  #
+  # @return mod
+  #   Returns the module which is zeroloaded
+  #
+  def self.module(mod, directory=nil)
+    directory ||= caller_locations.first.absolute_path.sub(/\.[^.]*\z/, "".freeze)
+    mod_name    = Name.bind(mod).call rescue nil # some modules don't have a name
+    Registry[mod_name] ||= {} if mod_name
+
+    Dir.glob("#{directory}/*.{rb,so,bundle,dll}") do |path|
+      name = File.basename(path)
+      if /\A[A-Z]/ =~ name
+        name = :"#{name.sub(/\.[^.]*\z/, "".freeze)}"
+
+        warn "#{mod} autoloads #{mod}::#{name} from #{path}" if $VERBOSE
+
+        Registry[mod_name][name] = path if mod_name
+        mod.autoload name, path
+      end
+    end
+
+    mod
+  end
+
+  # Preload all zeroloaded constants for all or a given module.
+  #
+  # @note
+  #   Module#constants properly lists all constants, even if the file
+  #   has not yet been loaded.
+  #
+  # @param [Module, Class] mod
+  #   The module whose autoloaded constants should be preloaded
+  # @param [true, false] recursive
+  #   Whether the constants should be recursively loaded, or only the current
+  #   level
+  #
+  # @return nil
+  #
+  def self.preload!(mod=nil, recursive=true)
+    if mod
+      nested_mod_name = Name.bind(mod).call rescue nil # some modules don't have a name
+      preload         = Registry[nested_mod_name]
+
+      if preload
+        preload.each_key do |name|
+          loaded = mod.const_get(name)
+          preload!(loaded, true) if recursive
+        end
+      end
+    else
+      Registry.dup.each do |nested_mod_name, zeroloaded|
+        loaded = Object.const_get(nested_mod_name) # Object.const_get does not like Symbols for nested modules.
+        Zeroload.preload!(loaded, true)
+      end
+    end
+
+    nil
+  end
+end

data/lib/{zeroload/version.rb → Zeroload/Version.rb}

@@ -1,5 +1,5 @@
 require 'rubygems/version' # newer rubygems use this
 
 module Zeroload
-  Version = Gem::Version.new("0.0.1")
+  Version = Gem::Version.new("0.0.2")
 end

data/lib/Zeroload/no_patch.rb

@@ -0,0 +1,9 @@
+module Zeroload
+  if defined?(Patch)
+    raise "Zeroload has been required before zeroload/no_patch"
+  else
+    Patch = false
+  end
+end
+
+require "Zeroload"

data/zeroload.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name                      = "zeroload"
-  s.version                   = "0.0.1"
+  s.version                   = "0.0.2"
   s.authors                   = "Stefan Rusterholz"
   s.email                     = "stefan.rusterholz@gmail.com"
   s.homepage                  = "https://github.com/apeiros/jacob"
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
     Automatically autoload all constants for a module.
   SUMMARY
 
-  s.required_ruby_version     = ">= 2.1.0" # TODO: figure out, when autoload became thread-safe
+  s.required_ruby_version     = ">= 2.0.0" # TODO: figure out, when autoload became thread-safe
   s.files                     =
     Dir['bin/**/*'] +
     Dir['lib/**/*'] +

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zeroload
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stefan Rusterholz
@@ -21,9 +21,9 @@ extra_rdoc_files: []
 files:
 - README.markdown
 - Rakefile
-- lib/zeroload.rb
-- lib/zeroload/auto.rb
-- lib/zeroload/version.rb
+- lib/Zeroload.rb
+- lib/Zeroload/Version.rb
+- lib/Zeroload/no_patch.rb
 - zeroload.gemspec
 homepage: https://github.com/apeiros/jacob
 licenses:
@@ -37,7 +37,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/zeroload.rb

@@ -1,21 +0,0 @@
-require 'zeroload/version'
-require 'zeroload/auto'
-
-# Zeroload
-# Automatically autoload all constants for a module. This requires a change from
-# the current convention of putting class Foo::BarBaz into foo/barbaz.rb (or
-# foo/bar_baz.rb in rails) to using Foo/BarBaz.rb instead.
-module Zeroload
-  def self.module(mod, directory=nil)
-    directory ||= caller_locations.first.absolute_path.sub(/\.[^.]*\z/, "".freeze)
-
-    Dir.glob("#{directory}/*.{rb,so,bundle,dll}") do |path|
-      name = File.basename(path)
-      if /\A[A-Z]/ =~ name
-        name.sub!(/\.[^.]*\z/, "".freeze)
-        warn "#{mod} autoloads #{name} from #{path}" if $VERBOSE
-        mod.autoload :"#{name}", path
-      end
-    end
-  end
-end

data/lib/zeroload/auto.rb

@@ -1,7 +0,0 @@
-module Kernel
-  def zeroload!(directory=nil, *args)
-    directory ||= caller_locations.first.absolute_path.sub(/\.[^.]*\z/, "")
-
-    Zeroload.module(self, directory, *args)
-  end
-end