Switched to Zeitwerk as autoloader.

Signed-off-by: Hermann Mayer <[email protected]>
hausgold · Jan 12, 2025 · f47b05f · f47b05f
1 parent ee16f2d
commit f47b05f
Show file tree

Hide file tree

Showing 34 changed files with 25 additions and 158 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 ### next
 
-* TODO: Replace this bullet point with an actual description of a change.
+* Switched to Zeitwerk as autoloader (#15)
 
 ### 1.7.0 (3 January 2025)
 

diff --git a/immoscout.gemspec b/immoscout.gemspec
@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday', '~> 1.10'
   spec.add_dependency 'faraday_middleware', '~> 1.2'
   spec.add_dependency 'simple_oauth', '>= 0.3'
+  spec.add_dependency 'zeitwerk', '~> 2.6'
 end
diff --git a/lib/immoscout.rb b/lib/immoscout.rb
@@ -1,29 +1,39 @@
 # frozen_string_literal: true
 
+require 'zeitwerk'
 require 'active_support/concern'
 require 'active_support/configurable'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/module'
-
-require 'immoscout/version'
-require 'immoscout/configuration'
-require 'immoscout/models'
+require 'singleton'
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
 
 # The top-namespace of the +immoscout+ gem.
 module Immoscout
+  # Setup a Zeitwerk autoloader instance and configure it
+  loader = Zeitwerk::Loader.for_gem
+
+  # Finish the auto loader configuration
+  loader.setup
+
+  # Make sure to eager load all constants
+  loader.eager_load
+
   class << self
     attr_writer :configuration
-  end
 
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+    def configuration
+      @configuration ||= Configuration.new
+    end
 
-  def self.configure
-    yield(configuration)
-  end
+    def configure
+      yield(configuration)
+    end
 
-  def self.reset_configuration!
-    self.configuration = Configuration.new
+    def reset_configuration!
+      self.configuration = Configuration.new
+    end
   end
 end
diff --git a/lib/immoscout/api/client.rb b/lib/immoscout/api/client.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'singleton'
-require_relative 'connection'
-require_relative 'request'
-
 module Immoscout
   module Api
     # The immoscout API client object.

diff --git a/lib/immoscout/api/connection.rb b/lib/immoscout/api/connection.rb
@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'faraday'
-require 'faraday_middleware'
-
 module Immoscout
   module Api
     # A connection builder/handler for reusable connections.

diff --git a/lib/immoscout/models.rb b/lib/immoscout/models.rb
diff --git a/lib/immoscout/models/actions/attachment.rb b/lib/immoscout/models/actions/attachment.rb
@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-require_relative '../concerns/modelable'
-
 # rubocop:disable Metrics/BlockLength because this is how an ActiveSupport
 #   concern looks like
 module Immoscout

diff --git a/lib/immoscout/models/actions/contact.rb b/lib/immoscout/models/actions/contact.rb
@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-require_relative '../concerns/modelable'
-
 module Immoscout
   module Models
     module Actions

diff --git a/lib/immoscout/models/actions/publish.rb b/lib/immoscout/models/actions/publish.rb
@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-require_relative '../concerns/modelable'
-
 module Immoscout
   module Models
     module Actions

diff --git a/lib/immoscout/models/actions/real_estate.rb b/lib/immoscout/models/actions/real_estate.rb
@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-require_relative '../concerns/modelable'
-
 # rubocop:disable Metrics/BlockLength because this is how an ActiveSupport
 #   concern looks like
 module Immoscout

diff --git a/lib/immoscout/models/apartment_buy.rb b/lib/immoscout/models/apartment_buy.rb
@@ -1,15 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'concerns/renderable'
-require_relative 'concerns/propertiable'
-require_relative 'actions/real_estate'
-require_relative 'parts/api_search_data'
-require_relative 'parts/address'
-require_relative 'parts/contact'
-require_relative 'parts/price'
-require_relative 'parts/courtage'
-require_relative 'parts/energy_source'
-
 module Immoscout
   module Models
     # Real Estate. (selling an apartment)

diff --git a/lib/immoscout/models/concerns/modelable.rb b/lib/immoscout/models/concerns/modelable.rb
@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-
 module Immoscout
   module Models
     module Concerns

diff --git a/lib/immoscout/models/concerns/renderable.rb b/lib/immoscout/models/concerns/renderable.rb
@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-
 # rubocop:disable Metrics/BlockLength because this is how an ActiveSupport
 #   concern looks like
 module Immoscout

diff --git a/lib/immoscout/models/contact.rb b/lib/immoscout/models/contact.rb
@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'concerns/renderable'
-require_relative 'concerns/propertiable'
-require_relative 'actions/contact'
-require_relative 'parts/address'
-
 module Immoscout
   module Models
     # A contact.

diff --git a/lib/immoscout/models/document.rb b/lib/immoscout/models/document.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'concerns/renderable'
-require_relative 'concerns/propertiable'
-require_relative 'actions/attachment'
-
 module Immoscout
   module Models
     # Attachment (document) of a Real Estate.

diff --git a/lib/immoscout/models/house_buy.rb b/lib/immoscout/models/house_buy.rb
@@ -1,17 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'concerns/renderable'
-require_relative 'concerns/propertiable'
-require_relative 'actions/real_estate'
-require_relative 'parts/api_search_data'
-require_relative 'parts/address'
-require_relative 'parts/contact'
-require_relative 'parts/price'
-require_relative 'parts/courtage'
-require_relative 'parts/energy_source'
-require_relative 'parts/energy_certificate'
-require_relative 'parts/firing_type'
-
 module Immoscout
   module Models
     # Real Estate. (selling a house)

diff --git a/lib/immoscout/models/parts/address.rb b/lib/immoscout/models/parts/address.rb
@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../parts/coordinate'
-require_relative '../parts/geo_hierarchy'
-require_relative '../parts/international_country_region'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/api_search_data.rb b/lib/immoscout/models/parts/api_search_data.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/contact.rb b/lib/immoscout/models/parts/contact.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/coordinate.rb b/lib/immoscout/models/parts/coordinate.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/courtage.rb b/lib/immoscout/models/parts/courtage.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/energy_certificate.rb b/lib/immoscout/models/parts/energy_certificate.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/energy_source.rb b/lib/immoscout/models/parts/energy_source.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/firing_type.rb b/lib/immoscout/models/parts/firing_type.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/geo_code.rb b/lib/immoscout/models/parts/geo_code.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/geo_hierarchy.rb b/lib/immoscout/models/parts/geo_hierarchy.rb
@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-require_relative 'geo_code'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/international_country_region.rb b/lib/immoscout/models/parts/international_country_region.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/price.rb b/lib/immoscout/models/parts/price.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/publish_channel.rb b/lib/immoscout/models/parts/publish_channel.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/real_estate.rb b/lib/immoscout/models/parts/real_estate.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/url.rb b/lib/immoscout/models/parts/url.rb
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/parts/urls.rb b/lib/immoscout/models/parts/urls.rb
@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../base'
-require_relative '../concerns/propertiable'
-require_relative '../concerns/renderable'
-require_relative 'url'
-
 module Immoscout
   module Models
     module Parts

diff --git a/lib/immoscout/models/picture.rb b/lib/immoscout/models/picture.rb
@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'concerns/renderable'
-require_relative 'concerns/propertiable'
-require_relative 'parts/urls'
-require_relative 'actions/attachment'
-
 module Immoscout
   module Models
     # Attachment (picture) of a Real Estate.

diff --git a/lib/immoscout/models/publish.rb b/lib/immoscout/models/publish.rb
@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'concerns/renderable'
-require_relative 'concerns/propertiable'
-require_relative 'actions/publish'
-require_relative 'parts/real_estate'
-require_relative 'parts/publish_channel'
-
 module Immoscout
   module Models
     # The Publish (object) of a Real Estate.