Switched to Zeitwerk as autoloader. (#46)

Signed-off-by: Hermann Mayer <[email protected]>

Author: Jack12816

CHANGELOG.md

@@ -1,6 +1,6 @@
 ### next
 
-* TODO: Replace this bullet point with an actual description of a change.
+* Switched to Zeitwerk as autoloader (#46)
 
 ### 1.9.0 (3 January 2025)
 

lib/rimless.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'zeitwerk'
 require 'active_support'
 require 'active_support/concern'
 require 'active_support/configurable'
@@ -22,35 +23,33 @@ module Rimless
   # Configure the relative gem code base location
   root_path = Pathname.new("#{__dir__}/rimless")
 
-  # Top level elements
-  autoload :Configuration, 'rimless/configuration'
-  autoload :ConfigurationHandling, 'rimless/configuration_handling'
-  autoload :AvroHelpers, 'rimless/avro_helpers'
-  autoload :AvroUtils, 'rimless/avro_utils'
-  autoload :KafkaHelpers, 'rimless/kafka_helpers'
-  autoload :Dependencies, 'rimless/dependencies'
-  autoload :BaseConsumer, 'rimless/base_consumer'
-  autoload :Consumer, 'rimless/consumer'
-  autoload :ConsumerJob, 'rimless/consumer_job'
-
-  # All Karafka-framework related components
-  module Karafka
-    autoload :Base64Interchanger, 'rimless/karafka/base64_interchanger'
-    autoload :PassthroughMapper, 'rimless/karafka/passthrough_mapper'
-    autoload :AvroDeserializer, 'rimless/karafka/avro_deserializer'
-  end
+  # Setup a Zeitwerk autoloader instance and configure it
+  loader = Zeitwerk::Loader.for_gem
+
+  # Do not auto load some parts of the gem
+  loader.ignore(root_path.join('compatibility*'))
+  loader.ignore(root_path.join('initializers*'))
+  loader.ignore(root_path.join('tasks*'))
+  loader.ignore(root_path.join('railtie.rb'))
+  loader.ignore(root_path.join('rspec*'))
+
+  # Finish the auto loader configuration
+  loader.setup
 
   # Load standalone code
   require 'rimless/version'
   require 'rimless/railtie' if defined? Rails
 
+  # Load all initializers of the gem
+  Dir[root_path.join('initializers/**/*.rb')].sort.each { |path| require path }
+
   # Include top-level features
   include Rimless::ConfigurationHandling
   include Rimless::AvroHelpers
   include Rimless::KafkaHelpers
   include Rimless::Dependencies
   include Rimless::Consumer
 
-  # Load all initializers of the gem
-  Dir[root_path.join('initializers/**/*.rb')].sort.each { |path| require path }
+  # Make sure to eager load all SDK constants
+  loader.eager_load
 end

rimless.gemspec

@@ -45,4 +45,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'sparsify', '~> 1.1'
   spec.add_dependency 'waterdrop', '~> 1.4'
   spec.add_dependency 'webmock', '~> 3.18'
+  spec.add_dependency 'zeitwerk', '~> 2.6'
 end