gamefic-autoload 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24affa079439426cf2ad1afbd586d34e477f92ac3024717e279cb31cb2251b12
-  data.tar.gz: 48c9c8950f62578fe13c005c076c41502dc02c048fab88a16f20da4639d03fde
+  metadata.gz: 04b696560950dd00dded43fbbbd450634941882a6b26263cb4d72a59f74fd5dd
+  data.tar.gz: 7e27ccabfd5ca459398e068f47db88b8dc89da44f9d9e0c72481067c8f3e381c
 SHA512:
-  metadata.gz: 56befe92e9ef38a0c9c0b1e54b9195fcdf9990db3109d163b5634c8fd63c6367c7ee9565e9bb9ea54bbb941e1c2436aca78f5d6c86be072c0bd4d2fbc303a73a
-  data.tar.gz: 8db06531427d6f85cf5ca03d98b02dd8570ffe5814d7a5e1c3472ea31d344b4eb03deb7d9b32489bfe620ae09f8c3e344064a8f73fb81ccb42f7c343620f1806
+  metadata.gz: 513d92125e91177f25c1233ede8d573c16eee9add44096008c5726e11281d2c9efeea66c2dc912db95f42d0cc384c8747f483f804a0a44761d1c24a92b72b371
+  data.tar.gz: 45d91e12d10778ff2dde9d8be5547712f38ed95f00af50cb3f352ae475433bcdf27aabbbb5a5c4c9acc4481104b1b47cb417cc43b1b7b2b5bef62e28d93ecab5

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+## 1.1.0 - May 24, 2025
+- Autoload.setup accepts block for loader configuration
+
 ## 1.0.0 - October 22, 2024
 - First release

data/README.md

@@ -1,14 +1,16 @@
 # Gamefic::Autoload
 
-A Zeitwerk autoloader for Gamefic projects.
+A [Zeitwerk](https://github.com/fxn/zeitwerk) autoloader for Gamefic projects.
 
 Using Gamefic::Autoload gives the Gamefic::SDK a way to use autoloading in web apps.
 
 ## Installation
 
-The Gamefic SDK installs gamefic-autoloader by default. If you need to set it up in a bespoke project, add it to your Gemfile:
+The Gamefic SDK installs gamefic-autoload by default. If you need to set it up in a bespoke project, add it to your Gemfile:
 
-    gem 'gamefic-autoloader'
+```ruby
+gem 'gamefic-autoloader'
+```
 
 Then set it up in whatever directory needs autoloading (e.g., `lib/my_project.rb`):
 
@@ -22,11 +24,21 @@ end
 
 ## Usage
 
-Gamefic::Autoload sets up autoloading in your directory using standard Zeitwerk conventions. With the above example, you could define a class named `MyProject::MyClass` in
+Gamefic::Autoload sets up Zeitwerk autoload in your directory using standard Zeitwerk conventions. With the above example, you could define a class named `MyProject::MyClass` in
 `lib/my_project/my_class.rb`, and it would be automatically loaded without the need to `require` the file.
 
 For Opal-based web apps, The Gamefic SDK will create an `autoload.rb` file that preloads your files, classes, and modules in the same manner that Zeitwerk does.
 
+If you need to customize the autoloader, you can also pass an optional `namespace` and block to the `setup` method:
+
+```ruby
+Gamefic::Autoload.setup(__dir__, namespace: Object) do |loader|
+  loader.inflector.inflect("xml" => "XML")
+end
+```
+
+See the [Zeitwerk documentation](https://github.com/fxn/zeitwerk) for more information about configuring loaders.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -35,4 +47,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gamefic-autoload.
+Bug reports and pull requests are welcome on GitHub at https://github.com/castwide/gamefic-autoload.

data/gamefic-autoload.gemspec

@@ -1,46 +1,47 @@
-# frozen_string_literal: true
-
-require_relative 'lib/gamefic/autoload/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'gamefic-autoload'
-  spec.version = Gamefic::Autoload::VERSION
-  spec.authors = ['Fred Snyder']
-  spec.email = ['fsnyder@castwide.com']
-  spec.homepage = 'https://gamefic.com'
-  spec.license = 'MIT'
-
-  spec.summary = 'Code loading for Gamefic projects'
-  # spec.description = "TODO: Write a longer description or delete this line."
-  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
-  spec.required_ruby_version = '>= 2.6.0'
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/castwide/gamefic-autoload'
-  spec.metadata['changelog_uri'] = 'https://github.com/castwide/gamefic-autoload/blob/master/CHANGELOG.md'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_dependency 'gamefic', '~> 4.0'
-  spec.add_dependency 'zeitwerk', '~> 2.6'
-
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end
+# frozen_string_literal: true
+
+require_relative 'lib/gamefic/autoload/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'gamefic-autoload'
+  spec.version = Gamefic::Autoload::VERSION
+  spec.authors = ['Fred Snyder']
+  spec.email = ['fsnyder@castwide.com']
+  spec.homepage = 'https://gamefic.com'
+  spec.license = 'MIT'
+
+  spec.summary = 'Code loading for Gamefic projects'
+  # spec.description = "TODO: Write a longer description or delete this line."
+  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  spec.required_ruby_version = '>= 2.6.0'
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/castwide/gamefic-autoload'
+  spec.metadata['changelog_uri'] = 'https://github.com/castwide/gamefic-autoload/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'gamefic', '~> 4.0'
+  spec.add_dependency 'zeitwerk', '~> 2.6'
+
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gamefic/autoload/version.rb

@@ -2,6 +2,6 @@
 
 module Gamefic
   module Autoload
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/lib/gamefic/autoload.rb

@@ -11,23 +11,41 @@ module Gamefic
   # loading conventions in Opal-based web apps.
   #
   module Autoload
-    def self.setup(directory, namespace: Object)
+    # Enable autoloading in a directory. See the Zeitwerk documentation for
+    # more information.
+    #
+    # @param directory [String] The directory name
+    # @param namespace [Module] The directory's root namespace
+    # @yieldparam [Zeitwerk::Loader]
+    # @return [Zeitwerk::Loader]
+    def self.setup(directory, namespace: Object, &block)
       if RUBY_ENGINE == 'opal'
         Gamefic.logger.info 'Opal engine detected - Gamefic::Autoload skipped'
       else
-        register_and_setup directory, namespace
+        register_and_setup directory, namespace, &block
       end
     end
 
+    # A list of all the directories that use autoloading.
+    #
+    # @return [Array<String>]
     def self.registered
       registry.keys
     end
 
+    # The history of a directory's load events.
+    #
+    # @return [Array<Hash>]
     def self.history(directory)
       registry[directory].eager_load
       histories[directory]
     end
 
+    # Translate a directory's load history into lines of Ruby source code that
+    # can replicate the autoload process without Zeitwerk.
+    #
+    # @param directory [String]
+    # @return [Array<String>]
     def self.encode(directory)
       history(directory).map do |hash|
         if File.file?(hash[:file])
@@ -39,12 +57,17 @@ module Gamefic
       end
     end
 
+    # Encode all of the registered directories.
+    #
+    # @return [Array<String>]
     def self.encode_all
       registered.flat_map { |directory| encode(directory) }
     end
 
     class << self
-      def register_and_setup(directory, namespace)
+      private
+
+      def register_and_setup(directory, namespace, &block)
         registry[directory] = Zeitwerk::Loader.new.tap do |loader|
           histories[directory] = []
           loader.push_dir directory, namespace: namespace
@@ -52,8 +75,8 @@ module Gamefic
             line = { name: name, const: const, file: file }
             histories[directory].push line
           end
+          block&.call(loader)
           loader.setup
-          loader.eager_load
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-autoload
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2025-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 description:
 email:
 - fsnyder@castwide.com
@@ -104,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Code loading for Gamefic projects