Merge pull request #5425 from consuldemocracy/zeitwerk

Use Zeitwerk to autoload files
consuldemocracy · Apr 11, 2024 · b520cb8 · b520cb8
2 parents 5b3a7cc + dbacd7f
commit b520cb8
Show file tree

Hide file tree

Showing 69 changed files with 144 additions and 133 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -10,7 +10,7 @@ AllCops:
   DisplayStyleGuide: true
   Exclude:
     - "db/schema.rb"
-    - "lib/ckeditor/backend/active_storage.rb"
+    - "app/lib/ckeditor/backend/active_storage.rb"
   DisabledByDefault: true
 
 Bundler/DuplicatedGem:
@@ -480,7 +480,7 @@ Rails/SkipsModelValidations:
     - update_attribute
   Exclude:
     - app/models/tenant.rb
-    - lib/acts_as_paranoid_aliases.rb
+    - app/lib/acts_as_paranoid_aliases.rb
 
 Rails/TimeZone:
   Enabled: true

diff --git a/Gemfile b/Gemfile
@@ -64,7 +64,7 @@ gem "wkhtmltopdf-binary", "~> 0.12.6"
 
 group :development, :test do
   gem "bullet", "~> 7.1.6"
-  gem "byebug", "~> 11.1.3"
+  gem "debug", "~> 1.9.2"
   gem "factory_bot_rails", "~> 6.4.3"
   gem "faker", "~> 3.2.3"
   gem "i18n-tasks", "~> 0.9.37"

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -106,7 +106,6 @@ GEM
     bullet (7.1.6)
       activesupport (>= 3.0.0)
       uniform_notifier (~> 1.11)
-    byebug (11.1.3)
     cancancan (3.5.0)
     capistrano (3.18.1)
       airbrussh (>= 1.0.0)
@@ -171,6 +170,9 @@ GEM
     daemons (1.4.1)
     dalli (3.2.8)
     date (3.3.4)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     delayed_job (4.1.11)
       activesupport (>= 3.0, < 8.0)
     delayed_job_active_record (4.1.8)
@@ -282,6 +284,10 @@ GEM
       ruby-vips (>= 2.0.17, < 3)
     invisible_captcha (2.3.0)
       rails (>= 5.2)
+    io-console (0.7.2)
+    irb (1.12.0)
+      rdoc
+      reline (>= 0.4.2)
     json (2.7.1)
     jwt (2.7.1)
     kaminari (1.2.2)
@@ -438,6 +444,8 @@ GEM
     pronto-stylelint (0.10.3)
       pronto (>= 0.10, < 0.12)
       rugged (>= 0.24, < 2.0)
+    psych (5.1.2)
+      stringio
     public_suffix (4.0.7)
     puma (5.6.8)
       nio4r (~> 2.0)
@@ -486,10 +494,14 @@ GEM
     rainbow (3.1.1)
     rake (13.1.0)
     rbtree3 (0.7.1)
+    rdoc (6.6.3.1)
+      psych (>= 4.0.0)
     recipient_interceptor (0.3.1)
       mail
     redcarpet (3.6.0)
     regexp_parser (2.9.0)
+    reline (0.5.1)
+      io-console (~> 0.5)
     request_store (1.6.0)
       rack (>= 1.4)
     responders (3.1.1)
@@ -615,6 +627,7 @@ GEM
       net-scp (>= 1.1.2)
       net-sftp (>= 2.1.2)
       net-ssh (>= 2.8.0)
+    stringio (3.1.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     terrapin (0.6.0)
@@ -683,7 +696,6 @@ DEPENDENCIES
   autoprefixer-rails (~> 10.4.16)
   bing_translator (~> 6.2.0)
   bullet (~> 7.1.6)
-  byebug (~> 11.1.3)
   cancancan (~> 3.5.0)
   capistrano (~> 3.18.1)
   capistrano-bundler (~> 2.1.0)
@@ -699,6 +711,7 @@ DEPENDENCIES
   cocoon (~> 1.2.15)
   daemons (~> 1.4.1)
   dalli (~> 3.2.8)
+  debug (~> 1.9.2)
   delayed_job_active_record (~> 4.1.8)
   devise (~> 4.9.3)
   devise-security (~> 0.18.0)

diff --git a/app/components/layout/common_html_attributes_component.rb b/app/components/layout/common_html_attributes_component.rb
@@ -1,4 +1,4 @@
-class Layout::CommonHTMLAttributesComponent < ApplicationComponent
+class Layout::CommonHtmlAttributesComponent < ApplicationComponent
   use_helpers :rtl?
 
   private

diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
@@ -1,5 +1,3 @@
-require "application_responder"
-
 class ApplicationController < ActionController::Base
   include TenantVariants
   include GlobalizeFallbacks

diff --git a/app/controllers/management/sessions_controller.rb b/app/controllers/management/sessions_controller.rb
@@ -1,5 +1,3 @@
-require "manager_authenticator"
-
 class Management::SessionsController < ActionController::Base
   include TenantVariants
   include GlobalizeFallbacks

diff --git a/app/helpers/layouts_helper.rb b/app/helpers/layouts_helper.rb
@@ -11,6 +11,6 @@ def layout_menu_link_to(text, path, is_active, options)
   end
 
   def common_html_attributes
-    render Layout::CommonHTMLAttributesComponent.new
+    render Layout::CommonHtmlAttributesComponent.new
   end
 end
diff --git a/app/helpers/votes_helper.rb b/app/helpers/votes_helper.rb
@@ -1,6 +1,6 @@
 module VotesHelper
   def debate_percentage_of_likes(debate)
-    debate.likes.percent_of(debate.total_votes)
+    (debate.likes.to_f * 100 / debate.total_votes).to_i
   end
 
   def votes_percentage(vote, debate)

diff --git a/lib/active_model/dates.rb → app/lib/active_model/dates.rb b/lib/active_model/dates.rb → app/lib/active_model/dates.rb
diff --git a/...ve_storage/service/tenant_disk_service.rb → ...ve_storage/service/tenant_disk_service.rb b/...ve_storage/service/tenant_disk_service.rb → ...ve_storage/service/tenant_disk_service.rb
diff --git a/lib/acts_as_paranoid_aliases.rb → app/lib/acts_as_paranoid_aliases.rb b/lib/acts_as_paranoid_aliases.rb → app/lib/acts_as_paranoid_aliases.rb
diff --git a/lib/admin_legislation_sanitizer.rb → app/lib/admin_legislation_sanitizer.rb b/lib/admin_legislation_sanitizer.rb → app/lib/admin_legislation_sanitizer.rb
diff --git a/lib/admin_wysiwyg_sanitizer.rb → app/lib/admin_wysiwyg_sanitizer.rb b/lib/admin_wysiwyg_sanitizer.rb → app/lib/admin_wysiwyg_sanitizer.rb
diff --git a/lib/age.rb → app/lib/age.rb b/lib/age.rb → app/lib/age.rb
diff --git a/lib/application_logger.rb → app/lib/application_logger.rb b/lib/application_logger.rb → app/lib/application_logger.rb
diff --git a/lib/application_responder.rb → app/lib/application_responder.rb b/lib/application_responder.rb → app/lib/application_responder.rb
diff --git a/lib/asset_finder.rb → app/lib/asset_finder.rb b/lib/asset_finder.rb → app/lib/asset_finder.rb
diff --git a/lib/authentication_logger.rb → app/lib/authentication_logger.rb b/lib/authentication_logger.rb → app/lib/authentication_logger.rb
diff --git a/lib/census_api.rb → app/lib/census_api.rb b/lib/census_api.rb → app/lib/census_api.rb
@@ -1,5 +1,6 @@
-include DocumentParser
 class CensusApi
+  include DocumentParser
+
   def call(document_type, document_number)
     response = nil
     get_document_number_variants(document_type, document_number).each do |variant|

diff --git a/lib/census_caller.rb → app/lib/census_caller.rb b/lib/census_caller.rb → app/lib/census_caller.rb
diff --git a/lib/ckeditor/backend/active_storage.rb → app/lib/ckeditor/backend/active_storage.rb b/lib/ckeditor/backend/active_storage.rb → app/lib/ckeditor/backend/active_storage.rb
@@ -67,7 +67,5 @@ def apply_data
           end
       end
     end
-
-    autoload :ActiveStorage, "ckeditor/backend/active_storage"
   end
 end
diff --git a/lib/comment_tree.rb → app/lib/comment_tree.rb b/lib/comment_tree.rb → app/lib/comment_tree.rb
diff --git a/lib/consul_form_builder.rb → app/lib/consul_form_builder.rb b/lib/consul_form_builder.rb → app/lib/consul_form_builder.rb
diff --git a/lib/assets/.keep → app/lib/custom/.keep b/lib/assets/.keep → app/lib/custom/.keep
diff --git a/lib/document_parser.rb → app/lib/document_parser.rb b/lib/document_parser.rb → app/lib/document_parser.rb
diff --git a/lib/email_digest.rb → app/lib/email_digest.rb b/lib/email_digest.rb → app/lib/email_digest.rb
diff --git a/lib/evaluation_comment_email.rb → app/lib/evaluation_comment_email.rb b/lib/evaluation_comment_email.rb → app/lib/evaluation_comment_email.rb
diff --git a/lib/geozone_stats.rb → app/lib/geozone_stats.rb b/lib/geozone_stats.rb → app/lib/geozone_stats.rb
diff --git a/lib/local_census.rb → app/lib/local_census.rb b/lib/local_census.rb → app/lib/local_census.rb
@@ -1,5 +1,6 @@
-include DocumentParser
 class LocalCensus
+  include DocumentParser
+
   def call(document_type, document_number)
     record = nil
     get_document_number_variants(document_type, document_number).each do |variant|

diff --git a/lib/manager_authenticator.rb → app/lib/manager_authenticator.rb b/lib/manager_authenticator.rb → app/lib/manager_authenticator.rb
diff --git a/lib/markdown_converter.rb → app/lib/markdown_converter.rb b/lib/markdown_converter.rb → app/lib/markdown_converter.rb
diff --git a/lib/merged_comment_tree.rb → app/lib/merged_comment_tree.rb b/lib/merged_comment_tree.rb → app/lib/merged_comment_tree.rb
diff --git a/lib/omniauth_tenant_setup.rb → app/lib/omniauth_tenant_setup.rb b/lib/omniauth_tenant_setup.rb → app/lib/omniauth_tenant_setup.rb
@@ -1,27 +1,19 @@
 module OmniauthTenantSetup
   class << self
-    def twitter
-      ->(env) do
-        oauth(env, secrets.twitter_key, secrets.twitter_secret)
-      end
+    def twitter(env)
+      oauth(env, secrets.twitter_key, secrets.twitter_secret)
     end
 
-    def facebook
-      ->(env) do
-        oauth2(env, secrets.facebook_key, secrets.facebook_secret)
-      end
+    def facebook(env)
+      oauth2(env, secrets.facebook_key, secrets.facebook_secret)
     end
 
-    def google_oauth2
-      ->(env) do
-        oauth2(env, secrets.google_oauth2_key, secrets.google_oauth2_secret)
-      end
+    def google_oauth2(env)
+      oauth2(env, secrets.google_oauth2_key, secrets.google_oauth2_secret)
     end
 
-    def wordpress_oauth2
-      ->(env) do
-        oauth2(env, secrets.wordpress_oauth2_key, secrets.wordpress_oauth2_secret)
-      end
+    def wordpress_oauth2(env)
+      oauth2(env, secrets.wordpress_oauth2_key, secrets.wordpress_oauth2_secret)
     end
 
     private

diff --git a/lib/percentage_calculator.rb → app/lib/percentage_calculator.rb b/lib/percentage_calculator.rb → app/lib/percentage_calculator.rb
diff --git a/lib/remote_census_api.rb → app/lib/remote_census_api.rb b/lib/remote_census_api.rb → app/lib/remote_census_api.rb
@@ -1,5 +1,6 @@
-include DocumentParser
 class RemoteCensusApi
+  include DocumentParser
+
   def call(document_type, document_number, date_of_birth, postal_code)
     response = nil
     get_document_number_variants(document_type, document_number).each do |variant|

diff --git a/lib/remote_translations/caller.rb → app/lib/remote_translations/caller.rb b/lib/remote_translations/caller.rb → app/lib/remote_translations/caller.rb
diff --git a/...anslations/microsoft/available_locales.rb → ...anslations/microsoft/available_locales.rb b/...anslations/microsoft/available_locales.rb → ...anslations/microsoft/available_locales.rb
diff --git a/lib/remote_translations/microsoft/client.rb → ...b/remote_translations/microsoft/client.rb b/lib/remote_translations/microsoft/client.rb → ...b/remote_translations/microsoft/client.rb
@@ -1,5 +1,5 @@
 class RemoteTranslations::Microsoft::Client
-  include SentencesParser
+  include RemoteTranslations::Microsoft::SentencesParser
   CHARACTERS_LIMIT_PER_REQUEST = 5000
   PREVENTING_TRANSLATION_KEY = "notranslate".freeze
 

diff --git a/...ranslations/microsoft/sentences_parser.rb → ...ranslations/microsoft/sentences_parser.rb b/...ranslations/microsoft/sentences_parser.rb → ...ranslations/microsoft/sentences_parser.rb
diff --git a/lib/reply_email.rb → app/lib/reply_email.rb b/lib/reply_email.rb → app/lib/reply_email.rb
diff --git a/lib/score_calculator.rb → app/lib/score_calculator.rb b/lib/score_calculator.rb → app/lib/score_calculator.rb
diff --git a/lib/search_dictionary_selector.rb → app/lib/search_dictionary_selector.rb b/lib/search_dictionary_selector.rb → app/lib/search_dictionary_selector.rb
diff --git a/lib/sms_api.rb → app/lib/sms_api.rb b/lib/sms_api.rb → app/lib/sms_api.rb
@@ -1,5 +1,5 @@
 require "open-uri"
-class SMSApi
+class SmsApi
   attr_accessor :client
 
   def initialize

diff --git a/lib/tag_sanitizer.rb → app/lib/tag_sanitizer.rb b/lib/tag_sanitizer.rb → app/lib/tag_sanitizer.rb
diff --git a/lib/user_segments.rb → app/lib/user_segments.rb b/lib/user_segments.rb → app/lib/user_segments.rb
diff --git a/lib/wysiwyg_sanitizer.rb → app/lib/wysiwyg_sanitizer.rb b/lib/wysiwyg_sanitizer.rb → app/lib/wysiwyg_sanitizer.rb
diff --git a/app/models/custom/setting.rb b/app/models/custom/setting.rb
@@ -1,4 +1,4 @@
-require_dependency Rails.root.join("app", "models", "setting").to_s
+load Rails.root.join("app", "models", "setting.rb")
 
 class Setting
   class << self

diff --git a/app/models/debate.rb b/app/models/debate.rb
@@ -1,5 +1,3 @@
-require "numeric"
-
 class Debate < ApplicationRecord
   include Flaggable
   include Taggable

diff --git a/app/models/verification/sms.rb b/app/models/verification/sms.rb
@@ -24,7 +24,7 @@ def update_user_phone_information
   end
 
   def send_sms
-    SMSApi.new.sms_deliver(user.unconfirmed_phone, user.sms_confirmation_code)
+    SmsApi.new.sms_deliver(user.unconfirmed_phone, user.sms_confirmation_code)
   end
 
   def verified?

diff --git a/config/application.rb b/config/application.rb
@@ -32,10 +32,6 @@ class Application < Rails::Application
     # in any CONSUL DEMOCRACY installations
     config.active_support.use_authenticated_message_encryption = false
 
-    # Keep using the classic autoloader until we decide how custom classes
-    # should work with zeitwerk
-    config.autoloader = :classic
-
     # Don't enable has_many_inversing because it doesn't seem to currently
     # work with the _count database columns we use for caching purposes
     config.active_record.has_many_inversing = false
@@ -125,21 +121,26 @@ class Application < Rails::Application
     config.assets.paths << Rails.root.join("node_modules", "jquery-ui", "themes", "base")
     config.assets.paths << Rails.root.join("node_modules")
 
-    # Add lib to the autoload path
-    config.autoload_paths << Rails.root.join("lib")
     config.active_job.queue_adapter = :delayed_job
 
     # CONSUL DEMOCRACY specific custom overrides
     # Read more on documentation:
     # * English: https://github.com/consuldemocracy/consuldemocracy/blob/master/CUSTOMIZE_EN.md
     # * Spanish: https://github.com/consuldemocracy/consuldemocracy/blob/master/CUSTOMIZE_ES.md
     #
-    config.autoload_paths << "#{Rails.root}/app/components/custom"
-    config.autoload_paths << "#{Rails.root}/app/controllers/custom"
-    config.autoload_paths << "#{Rails.root}/app/graphql/custom"
-    config.autoload_paths << "#{Rails.root}/app/mailers/custom"
-    config.autoload_paths << "#{Rails.root}/app/models/custom"
-    config.autoload_paths << "#{Rails.root}/app/models/custom/concerns"
+
+    [
+      "app/components/custom",
+      "app/controllers/custom",
+      "app/graphql/custom",
+      "app/lib/custom",
+      "app/mailers/custom",
+      "app/models/custom",
+      "app/models/custom/concerns"
+    ].each do |path|
+      config.autoload_paths << Rails.root.join(path)
+      config.eager_load_paths << Rails.root.join(path)
+    end
 
     config.paths["app/views"].unshift(Rails.root.join("app", "views", "custom"))
 

diff --git a/config/environments/development.rb b/config/environments/development.rb
@@ -72,6 +72,7 @@
   # Annotate rendered view with file names.
   # config.action_view.annotate_rendered_view_with_filenames = true
 
+  config.eager_load_paths << "#{Rails.root}/spec/mailers/previews"
   config.action_mailer.preview_path = "#{Rails.root}/spec/mailers/previews"
 
   # Limit size of local logs

diff --git a/config/environments/production.rb b/config/environments/production.rb
@@ -12,11 +12,6 @@
   # Rake tasks automatically ignore this option for performance.
   config.eager_load = true
 
-  # Because autoloading is disabled in production environments with Rails 5,
-  # using autoload_paths will not load needed classes from specified paths.
-  # The solution to this, is to ask Rails to eager load classes.
-  config.eager_load_paths += ["#{config.root}/lib"]
-
   # Full error reports are disabled and caching is turned on.
   config.consider_all_requests_local       = false
   config.action_controller.perform_caching = true

diff --git a/config/environments/test.rb b/config/environments/test.rb
@@ -20,7 +20,7 @@
   # Do not eager load code on boot. This avoids loading your whole application
   # just for the purpose of running a single test. If you are using a tool that
   # preloads Rails for running tests, you may have to set it to true.
-  config.eager_load = false
+  config.eager_load = ENV["CI"].present?
 
   # Configure public file server for tests with Cache-Control for performance.
   config.public_file_server.enabled = true

diff --git a/config/initializers/acts_as_taggable_on.rb b/config/initializers/acts_as_taggable_on.rb
@@ -7,6 +7,12 @@
   # config.base_class = "ApplicationRecord"
 end
 
+Rails.application.reloader.to_prepare do
+  ActsAsTaggableOn::Tag.class_eval do
+    include Graphqlable
+  end
+end
+
 module ActsAsTaggableOn
   Tagging.class_eval do
     after_create :increment_tag_custom_counter
@@ -39,8 +45,6 @@ def category?
       kind == "category"
     end
 
-    include Graphqlable
-
     scope :public_for_api, -> do
       where(
         kind: [nil, "category"],

diff --git a/config/initializers/age.rb b/config/initializers/age.rb
diff --git a/config/initializers/audited.rb b/config/initializers/audited.rb
@@ -1,4 +1,4 @@
 Audited.config do |config|
-  config.audit_class = ::Audit
+  config.audit_class = "::Audit"
   config.ignored_default_callbacks = [:touch]
 end
diff --git a/config/initializers/devise.rb b/config/initializers/devise.rb
@@ -1,4 +1,4 @@
-require Rails.root.join("lib", "omniauth_wordpress")
+require Rails.root.join("lib", "omni_auth", "strategies", "wordpress")
 
 # Use this hook to configure devise mailer, warden hooks and so forth.
 # Many of these configuration options can be set straight in your model.
@@ -270,23 +270,22 @@
   config.omniauth :twitter,
                   Rails.application.secrets.twitter_key,
                   Rails.application.secrets.twitter_secret,
-                  setup: OmniauthTenantSetup.twitter
+                  setup: ->(env) { OmniauthTenantSetup.twitter(env) }
   config.omniauth :facebook,
                   Rails.application.secrets.facebook_key,
                   Rails.application.secrets.facebook_secret,
                   scope: "email",
                   info_fields: "email,name,verified",
-                  setup: OmniauthTenantSetup.facebook
+                  setup: ->(env) { OmniauthTenantSetup.facebook(env) }
   config.omniauth :google_oauth2,
                   Rails.application.secrets.google_oauth2_key,
                   Rails.application.secrets.google_oauth2_secret,
-                  setup: OmniauthTenantSetup.google_oauth2
+                  setup: ->(env) { OmniauthTenantSetup.google_oauth2(env) }
   config.omniauth :wordpress_oauth2,
                   Rails.application.secrets.wordpress_oauth2_key,
                   Rails.application.secrets.wordpress_oauth2_secret,
-                  strategy_class: OmniAuth::Strategies::Wordpress,
                   client_options: { site: Rails.application.secrets.wordpress_oauth2_site },
-                  setup: OmniauthTenantSetup.wordpress_oauth2
+                  setup: ->(env) { OmniauthTenantSetup.wordpress_oauth2(env) }
 
   # ==> Warden configuration
   # If you want to use other strategies, that are not supported by Devise, or