rubocop omakase

Author: sebyx07

.github/workflows/ci.yml

@@ -27,5 +27,6 @@ jobs:
       - name: Install dependencies
         run: bundle install
       - name: Run tests
-        run:
-          bundle exec rspec
+        run: bundle exec rspec
+      - name: Rubocop
+        run: bundle exec rubocop --parallel

.rubocop.yml

@@ -0,0 +1,49 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+AllCops:
+  TargetRubyVersion: 3.1
+
+Layout/AssignmentIndentation:
+  Enabled: true
+
+Layout/DefEndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: def
+  AutoCorrect: true
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+  NumberOfEmptyLines: 1
+
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/HeredocIndentation:
+  Enabled: true
+
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: normal
+
+Layout/IndentationStyle:
+  Enabled: true
+
+Layout/IndentationWidth:
+  Enabled: true
+  Width: 2
+
+Style/ClassAndModuleChildren:
+  Enabled: true
+  EnforcedStyle: nested
+
+Lint/Debugger:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes

Gemfile

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gem "activerecord", ">=7"
-gem "sqlite3", "~> 1.4"
+gem 'activerecord', '>=7'
+gem 'sqlite3', '~> 1.4'
+gem 'rubocop-rails-omakase', '~> 1.1', require: false
 # Specify your gem's dependencies in jit_preloader.gemspec
 gemspec

README.md

@@ -90,16 +90,16 @@ This gem will publish an `n_plus_one_query` event via ActiveSupport::Notificatio
 
 You could implement some basic tracking. This will let you measure the extent of the N+1 query problems in your app:
 ```ruby
-ActiveSupport::Notifications.subscribe("n_plus_one_query") do |event, data|
+ActiveSupport::Notifications.subscribe('n_plus_one_query') do |event, data|
   statsd.increment "web.#{Rails.env}.n_plus_one_queries.global"
 end
 ```
 
 You could log the N+1 queries. In your development environment, you could throw N+1 queries into the logs along with a stack trace:
 ```ruby
-ActiveSupport::Notifications.subscribe("n_plus_one_query") do |event, data|
+ActiveSupport::Notifications.subscribe('n_plus_one_query') do |event, data|
   message = "N+1 Query detected: #{data[:association]} on #{data[:source].class}"
-  backtrace = caller.select{|r| r.starts_with?(Rails.root.to_s) }
+  backtrace = caller.select { |r| r.starts_with?(Rails.root.to_s) }
   Rails.logger.debug("\n\n#{message}\n#{backtrace.join("\n")}\n".red)
 end
 ```
@@ -113,7 +113,7 @@ config.around(:each) do |example|
       raise QueryError.new(message)
     end
   end
-  ActiveSupport::Notifications.subscribed(callback, "n_plus_one_query") do
+  ActiveSupport::Notifications.subscribed(callback, 'n_plus_one_query') do
     example.run
   end
 end
@@ -144,7 +144,7 @@ There is now a `has_many_aggregate` method available for ActiveRecord::Base. Thi
 ```ruby
 # old
 Contact.all.each do |contact|
-  contact.addresses.maximum("LENGTH(street)")
+  contact.addresses.maximum('LENGTH(street)')
   contact.addresses.count
 end
 # SELECT * FROM contacts
@@ -159,8 +159,8 @@ end
 #new
 class Contact < ActiveRecord::Base
   has_many :addresses
-  has_many_aggregate :addresses, :max_street_length, :maximum, "LENGTH(street)", default: nil
-  has_many_aggregate :addresses, :count_all, :count, "*"
+  has_many_aggregate :addresses, :max_street_length, :maximum, 'LENGTH(street)', default: nil
+  has_many_aggregate :addresses, :count_all, :count, '*'
 end
 
 Contact.jit_preload.each do |contact|
@@ -177,7 +177,7 @@ Furthermore, there is an argument `max_ids_per_query` setting max ids per query.
 ```ruby
 class Contact < ActiveRecord::Base
   has_many :addresses
-  has_many_aggregate :addresses, :count_all, :count, "*", max_ids_per_query: 10
+  has_many_aggregate :addresses, :count_all, :count, '*', max_ids_per_query: 10
 end
 
 Contact.jit_preload.each do |contact|
@@ -197,26 +197,26 @@ This is a method `preload_scoped_relation` that is available that can handle thi
 #old
 class Contact < ActiveRecord::Base
   has_many :addresses
-  has_many :usa_addresses, ->{ where(country: Country.find_by_name("USA")) }
+  has_many :usa_addresses, -> { where(country: Country.find_by_name('USA')) }
 end
 
 Contact.jit_preload.all.each do |contact|
   # This will preload the association as expected, but it must be defined as an association in advance
   contact.usa_addresses
 
   # This will preload as the entire addresses association, and filters it in memory
-  contact.addresses.select{|address| address.country == Country.find_by_name("USA") }
+  contact.addresses.select { |address| address.country == Country.find_by_name('USA') }
 
   # This is an N+1 query
-  contact.addresses.where(country: Country.find_by_name("USA"))
+  contact.addresses.where(country: Country.find_by_name('USA'))
 end
 
 # New
 Contact.jit_preload.all.each do |contact|
   contact.preload_scoped_relation(
-    name: "USA Addresses",
+    name: 'USA Addresses',
     base_association: :addresses,
-    preload_scope: Address.where(country: Country.find_by_name("USA"))
+    preload_scope: Address.where(country: Country.find_by_name('USA'))
   )
 end
 # SELECT * FROM contacts
@@ -236,14 +236,14 @@ JitPreloader.globally_enabled = true
 # Can also be given anything that responds to `call`.
 # You could build a kill switch with Redis (or whatever you'd like)
 # so that you can turn it on or off dynamically.
-JitPreloader.globally_enabled = ->{ $redis.get('always_jit_preload') == 'on' }
+JitPreloader.globally_enabled = -> { $redis.get('always_jit_preload') == 'on' }
 
 # Setting global max ids constraint on all aggregation methods.
 JitPreloader.max_ids_per_query = 10
 
 class Contact < ActiveRecord::Base
   has_many :emails
-  has_many_aggregate :emails, :count_all, :count, "*"
+  has_many_aggregate :emails, :count_all, :count, '*'
 end
 
 # When enabled globally, this would not generate an N+1 query.

Rakefile

@@ -1,2 +1,3 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'

jit_preloader.gemspec

@@ -1,34 +1,38 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jit_preloader/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "jit_preloader"
+  spec.name          = 'jit_preloader'
   spec.version       = JitPreloader::VERSION
-  spec.authors       = ["Kyle d'Oliveira"]
-  spec.email         = ["[email protected]"]
-  spec.summary       = %q{Tool to understand N+1 queries and to remove them}
-  spec.description   = %q{The JitPreloader has the ability to send notifications when N+1 queries occur to help guage how problematic they are for your code base and a way to remove all of the commons explicitly or automatically}
-  spec.homepage      = "https://github.com/clio/jit_preloader"
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.authors       = [ "Kyle d'Oliveira" ]
+  spec.email         = [ '[email protected]' ]
+  spec.summary       = 'Tool to understand N+1 queries and to remove them'
+  spec.description   = 'The JitPreloader has the ability to send notifications when N+1 queries occur to help guage how problematic they are for your code base and a way to remove all of the commons explicitly or automatically'
+  spec.homepage      = 'https://github.com/clio/jit_preloader'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.required_ruby_version = '>= 3.0.0'
 
-  spec.license       = "MIT"
+  spec.license = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files = Dir.glob('lib/**/*.rb') + [ File.basename(__FILE__) ]
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = [ 'lib' ]
 
-  spec.add_dependency "activerecord", "< 8"
-  spec.add_dependency "activesupport"
+  spec.add_dependency 'activerecord', '< 8'
+  spec.add_dependency 'activesupport'
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "database_cleaner"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "db-query-matchers"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rubocop-rails_config'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'db-query-matchers'
 end

lib/jit_preloader.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/notifications'
 require 'active_record'
 
-require "jit_preloader/version"
+require 'jit_preloader/version'
 require 'jit_preloader/active_record/base'
 require 'jit_preloader/active_record/relation'
 require 'jit_preloader/active_record/associations/collection_association'
 require 'jit_preloader/active_record/associations/singular_association'
-if Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new("7.0.0")
+if Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new('7.0.0')
   require 'jit_preloader/active_record/associations/preloader/ar7_association'
   require 'jit_preloader/active_record/associations/preloader/ar7_branch'
-elsif Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new("6.1.0")
+elsif Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new('6.1.0')
   require 'jit_preloader/active_record/associations/preloader/ar6_association'
 else
   require 'jit_preloader/active_record/associations/preloader/collection_association'
@@ -41,5 +43,4 @@ def self.globally_enabled?
       @enabled
     end
   end
-
 end

lib/jit_preloader/active_record/associations/collection_association.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module JitPreloader
   module ActiveRecordAssociationsCollectionAssociation
-
     def load_target
       was_loaded = loaded?
 
@@ -17,10 +18,10 @@ def load_target
           JitPreloader::Preloader.attach(records) if records.any? && !jit_loaded && JitPreloader.globally_enabled?
 
           # If the records were not pre_loaded
-          records.each{ |record| record.jit_n_plus_one_tracking = true }
+          records.each { |record| record.jit_n_plus_one_tracking = true }
 
           if !jit_loaded && owner.jit_n_plus_one_tracking
-            ActiveSupport::Notifications.publish("n_plus_one_query",
+            ActiveSupport::Notifications.publish('n_plus_one_query',
                                                  source: owner, association: reflection.name)
           end
         end

lib/jit_preloader/active_record/associations/preloader/ar6_association.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module JitPreloader
   module PreloaderAssociation
-
     # A monkey patch to ActiveRecord. The old method looked like the snippet
     # below. Our changes here are that we remove records that are already
     # part of the target, then attach all of the records to a new jit preloader.

lib/jit_preloader/active_record/associations/preloader/ar7_association.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module JitPreloader
   module PreloaderAssociation
-
     # A monkey patch to ActiveRecord. The old method looked like the snippet
     # below. Our changes here are that we remove records that are already
     # part of the target, then attach all of the records to a new jit preloader.