Modernize with zeitwerk, rubocop-gusto, gemspec deps

Author: martinemde

.rubocop.yml

@@ -1,3 +1,13 @@
+inherit_gem:
+  rubocop-gusto:
+    - config/default.yml
+
+plugins:
+  - rubocop-gusto
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
+
 # The behavior of RuboCop can be controlled via the .rubocop.yml
 # configuration file. It makes it possible to enable/disable
 # certain cops (checks) and to alter their behavior if they accept
@@ -14,66 +24,69 @@ AllCops:
     - vendor/bundle/**/**
   TargetRubyVersion: 2.6
 
-Metrics/ParameterLists:
+Gemspec/RequireMFA:
   Enabled: false
 
-# This cop is annoying with typed configuration
-Style/TrivialAccessors:
+# This leads to code that is not very readable at times (very long lines)
+Layout/ArgumentAlignment:
   Enabled: false
 
-# This rubocop is annoying when we use interfaces a lot
-Lint/UnusedMethodArgument:
+# This leads to code that is not very readable at times (very long lines)
+Layout/FirstArgumentIndentation:
   Enabled: false
 
-Gemspec/RequireMFA:
+Layout/LineLength:
   Enabled: false
 
-Lint/DuplicateBranch:
+# This leads to code that is not very readable at times (very long lines)
+Layout/MultilineMethodCallIndentation:
   Enabled: false
 
-# If is sometimes easier to think about than unless sometimes
-Style/NegatedIf:
+Lint/DuplicateBranch:
   Enabled: false
 
-# Disabling for now until it's clearer why we want this
-Style/FrozenStringLiteralComment:
+# This rubocop is annoying when we use interfaces a lot
+Lint/UnusedMethodArgument:
   Enabled: false
 
-# It's nice to be able to read the condition first before reading the code within the condition
-Style/GuardClause:
+Metrics/AbcSize:
   Enabled: false
 
-#
-# Leaving length metrics to human judgment for now
-#
-Metrics/ModuleLength:
+Metrics/BlockLength:
   Enabled: false
 
-Layout/LineLength:
+Metrics/ClassLength:
   Enabled: false
 
-Metrics/BlockLength:
+# This doesn't feel useful
+Metrics/CyclomaticComplexity:
   Enabled: false
 
 Metrics/MethodLength:
   Enabled: false
 
-Metrics/AbcSize:
+#
+# Leaving length metrics to human judgment for now
+#
+Metrics/ModuleLength:
   Enabled: false
 
-Metrics/ClassLength:
+Metrics/ParameterLists:
   Enabled: false
 
 # This doesn't feel useful
-Metrics/CyclomaticComplexity:
+Metrics/PerceivedComplexity:
   Enabled: false
 
-# This doesn't feel useful
-Metrics/PerceivedComplexity:
+# Sometimes we like methods like `get_packages`
+Naming/AccessorMethodName:
   Enabled: false
 
-# It's nice to be able to read the condition first before reading the code within the condition
-Style/IfUnlessModifier:
+Style/AccessorGrouping:
+  Enabled: false
+
+# Blocks across lines are okay sometimes
+Style/BlockDelimiters:
   Enabled: false
 
 # This leads to code that is not very readable at times (very long lines)
@@ -88,36 +101,29 @@ Style/Documentation:
 Style/EmptyElse:
   Enabled: false
 
-# Sometimes we want to more explicitly list out a condition
-Style/RedundantCondition:
-  Enabled: false
-
-# This leads to code that is not very readable at times (very long lines)
-Layout/MultilineMethodCallIndentation:
+# Disabling for now until it's clearer why we want this
+Style/FrozenStringLiteralComment:
   Enabled: false
 
-# Blocks across lines are okay sometimes
-Style/BlockDelimiters:
+# It's nice to be able to read the condition first before reading the code within the condition
+Style/GuardClause:
   Enabled: false
 
-# Sometimes we like methods like `get_packages`
-Naming/AccessorMethodName:
+Style/HashSyntax:
   Enabled: false
 
-# This leads to code that is not very readable at times (very long lines)
-Layout/FirstArgumentIndentation:
+# It's nice to be able to read the condition first before reading the code within the condition
+Style/IfUnlessModifier:
   Enabled: false
 
-# This leads to code that is not very readable at times (very long lines)
-Layout/ArgumentAlignment:
+# If is sometimes easier to think about than unless sometimes
+Style/NegatedIf:
   Enabled: false
 
-Style/AccessorGrouping:
+# Sometimes we want to more explicitly list out a condition
+Style/RedundantCondition:
   Enabled: false
 
-Style/HashSyntax:
+# This cop is annoying with typed configuration
+Style/TrivialAccessors:
   Enabled: false
-
-Gemspec/DevelopmentDependencies:
-  Enabled: true
-  EnforcedStyle: gemspec

.rubocop_todo.yml

@@ -1,3 +1,13 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
+
+gem "debug"
+gem "packwerk"
+gem "railties"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-gusto", "~> 10.0"
+gem "sorbet"
+gem "tapioca"

Gemfile

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

bin/rubocop

@@ -30,13 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'code_teams', '~> 1.0'
   spec.add_dependency 'packs-specification'
   spec.add_dependency 'sorbet-runtime', '>= 0.5.11249'
-
-  spec.add_development_dependency 'debug'
-  spec.add_development_dependency 'packwerk'
-  spec.add_development_dependency 'railties'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'sorbet'
-  spec.add_development_dependency 'tapioca'
+  spec.add_dependency 'zeitwerk'
 end

code_ownership.gemspec

@@ -7,14 +7,13 @@
 require 'sorbet-runtime'
 require 'json'
 require 'packs-specification'
-require 'code_ownership/mapper'
-require 'code_ownership/validator'
-require 'code_ownership/private'
-require 'code_ownership/cli'
-require 'code_ownership/configuration'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
 
 if defined?(Packwerk)
-  require 'code_ownership/private/permit_pack_owner_top_level_key'
+  require 'code_ownership/private/pack_ownership_validator'
 end
 
 module CodeOwnership
@@ -97,10 +96,10 @@ def validate!(
     Private.load_configuration!
 
     tracked_file_subset = if files
-                            files.select { |f| Private.file_tracked?(f) }
-                          else
-                            Private.tracked_files
-                          end
+      files.select { |f| Private.file_tracked?(f) }
+    else
+      Private.tracked_files
+    end
 
     Private.validate!(files: tracked_file_subset, autocorrect: autocorrect, stage_changes: stage_changes)
   end
@@ -162,7 +161,7 @@ def backtrace_with_ownership(backtrace)
 
       [
         CodeOwnership.for_file(file),
-        file
+        file,
       ]
     end
   end

lib/code_ownership.rb

@@ -1,23 +1,5 @@
-# frozen_string_literal: true
-
 # typed: strict
-
-require 'code_ownership/private/extension_loader'
-require 'code_ownership/private/team_plugins/ownership'
-require 'code_ownership/private/team_plugins/github'
-require 'code_ownership/private/codeowners_file'
-require 'code_ownership/private/parse_js_packages'
-require 'code_ownership/private/glob_cache'
-require 'code_ownership/private/owner_assigner'
-require 'code_ownership/private/validations/files_have_owners'
-require 'code_ownership/private/validations/github_codeowners_up_to_date'
-require 'code_ownership/private/validations/files_have_unique_owners'
-require 'code_ownership/private/ownership_mappers/file_annotations'
-require 'code_ownership/private/ownership_mappers/team_globs'
-require 'code_ownership/private/ownership_mappers/directory_ownership'
-require 'code_ownership/private/ownership_mappers/package_ownership'
-require 'code_ownership/private/ownership_mappers/js_package_ownership'
-require 'code_ownership/private/ownership_mappers/team_yml_ownership'
+# frozen_string_literal: true
 
 module CodeOwnership
   module Private
@@ -117,10 +99,10 @@ def self.find_team!(team_name, location_of_reference)
     def self.glob_cache
       @glob_cache ||= T.let(@glob_cache, T.nilable(GlobCache))
       @glob_cache ||= if CodeownersFile.use_codeowners_cache?
-                        CodeownersFile.to_glob_cache
-                      else
-                        Mapper.to_glob_cache
-                      end
+        CodeownersFile.to_glob_cache
+      else
+        Mapper.to_glob_cache
+      end
     end
   end
 

lib/code_ownership/private.rb

@@ -0,0 +1,76 @@
+# typed: false
+# frozen_string_literal: true
+
+# Zeitwerk Compliance Smoke Test
+#
+# This test serves as a Zeitwerk compliance smoke test that validates the gem's
+# file structure and naming conventions. It ensures that all files in the gem
+# follow Zeitwerk's strict naming conventions by forcing the autoloader to
+# eagerly load every constant and file in the gem.
+#
+# How it works:
+# 1. Eager Loading: Forces Zeitwerk to immediately load all files and constants
+#    in the gem, rather than loading them on-demand
+# 2. Error Detection: If there are any naming convention violations, Zeitwerk
+#    will raise an error during this process
+# 3. Validation: The test passes only if no errors are raised
+#
+# What it catches:
+# - Misnamed files (e.g., my_class.rb should define MyClass)
+# - Incorrect directory structure relative to module nesting
+# - Missing constants (files that exist but don't define expected constants)
+# - Extra or orphaned files that don't follow naming patterns
+# - Namespace violations (constants defined in wrong namespace for their location)
+
+RSpec.describe "zeitwerk autoloader" do
+  it "werks (successfully loads the gem)" do
+    Zeitwerk::Loader.eager_load_namespace(CodeOwnership)
+  rescue => error
+    # Enhance the error message with more specific information
+    enhanced_message = build_enhanced_error_message(error)
+    raise enhanced_message
+  end
+
+  private
+
+  def build_enhanced_error_message(error)
+    message_parts = [
+      "Zeitwerk eager loading failed with the following error:",
+      "",
+      "Original Error: #{error.class}: #{error.message}",
+      "",
+    ]
+
+    # Add backtrace information to help identify the problematic file
+    if error.backtrace
+      gem_related_trace = error.backtrace.select do |line|
+        line.include?('lib/') || line.include?('zeitwerk')
+      end
+
+      if gem_related_trace.any?
+        message_parts << "Relevant backtrace:"
+        gem_related_trace.first(5).each do |line|
+          message_parts << "  #{line}"
+        end
+        message_parts << ""
+      end
+    end
+
+    # Try to identify which file might be causing the issue
+    if /(?:wrong constant name|uninitialized constant|expected.*to define)/i.match?(error.message)
+      message_parts << "This error typically indicates:"
+      message_parts << "- A file name doesn't match its constant name"
+      message_parts << "- A constant is defined in the wrong namespace"
+      message_parts << "- A file exists but doesn't define the expected constant"
+      message_parts << ""
+    end
+
+    # Add helpful debugging information
+    message_parts << "To debug this issue:"
+    message_parts << "1. Check that all files in lib/ follow zeitwerk naming conventions"
+    message_parts << "2. Ensure each file defines a constant matching its file path"
+    message_parts << "3. Verify modules/classes are in the correct namespace"
+
+    message_parts.join("\n")
+  end
+end