Merge pull request #307 from plural/fix-lint-errors-aug-2024

Update rubocop settings and fix all open rubocop errors.

Author: plural

.rubocop.yml

@@ -6,6 +6,8 @@ require:
 
 Metrics/AbcSize:
   Enabled: false
+Metrics/BlockLength:
+  Enabled: false
 Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/MethodLength:

Gemfile

@@ -1,22 +1,24 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby "~> 3.1"
+ruby '~> 3.1'
 
 # Gems that have trouble with native packages on alpine.
 gem 'google-protobuf', force_ruby_platform: true
 gem 'nokogiri', force_ruby_platform: true
 
 # Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
-gem "rails", ">= 7.0.7.1"
+gem 'rails', '>= 7.0.7.1'
 
 # Use postgresql as the database for Active Record
-gem "pg", "~> 1.1"
+gem 'pg', '~> 1.1'
 
 # Use the Puma web server [https://github.com/puma/puma]
-gem "puma", "~> 5.6"
+gem 'puma', '~> 5.6'
 
-gem "parslet"
+gem 'parslet'
 
 # Build JSON APIs with ease [https://github.com/rails/jbuilder]
 # gem "jbuilder"
@@ -31,54 +33,52 @@ gem "parslet"
 # gem "bcrypt", "~> 3.1.7"
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ]
+gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
 
 # Reduces boot times through caching; required in config/boot.rb
-gem "bootsnap", require: false
+gem 'bootsnap', require: false
 
 # Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
 # gem "image_processing", "~> 1.2"
 
 gem 'rack', '~> 2.2'
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
-gem "rack-cors", '2.0.0'
+gem 'rack-cors', '2.0.0'
 
 # Used for our import of the card data.
-gem "activerecord-import"
+gem 'activerecord-import'
 
 # Base for our JSON API.
 gem 'graphiti', '~> 1.2'
 gem 'graphiti-rails', '~> 0.2'
 gem 'kaminari', '~> 1.0'
-gem 'responders'
 gem 'ostruct'
-group :development, :test do
-  gem 'graphiti_spec_helpers'
-end
+gem 'responders'
 
 # Views
 gem 'scenic'
 
-gem "sprockets-rails"
-gem 'rspec_api_documentation'
-gem "apitome"
+gem 'apitome'
 gem 'jwt'
+gem 'rspec_api_documentation'
+gem 'sprockets-rails'
 
 # Observability and monitoring via OpenTelemetry.
-gem 'opentelemetry-sdk'
 gem 'opentelemetry-exporter-otlp'
 gem 'opentelemetry-instrumentation-all'
+gem 'opentelemetry-sdk'
 
 # for review imports from NRDBc
 gem 'reverse_markdown'
 
 group :development, :test do
-  gem "brakeman", "~> 5.2"
-  gem "bundler-audit", "~> 0.9.0"
+  gem 'brakeman', '~> 5.2'
+  gem 'bundler-audit', '~> 0.9.0'
   # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
-  gem "debug", platforms: %i[ mri mingw x64_mingw ]
+  gem 'debug', platforms: %i[mri mingw x64_mingw]
   gem 'factory_bot_rails'
   gem 'faker'
+  gem 'graphiti_spec_helpers'
   gem 'rspec-rails'
   gem 'rubocop'
   gem 'rubocop-factory_bot'

Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require_relative "config/application"
+require_relative 'config/application'
 
 Rails.application.load_tasks

app/models/card_pool.rb

@@ -18,7 +18,8 @@ def num_cards
     cards.size
   end
 
-  validates :name, uniqueness: true
+  # TODO(plural): Add an index for this uniqueness constraint.
+  validates :name, uniqueness: true # rubocop:disable Rails/UniqueValidationWithoutIndex
 
   scope :by_printing_ids, lambda { |printing_ids|
     joins(:card_pool_cards).joins(:printings).where(unified_printings: { id: printing_ids }).distinct

app/models/deck.rb

@@ -32,5 +32,4 @@ def num_cards
       .reject { |c| c.card_id == identity_card_id }
       .map(&:quantity).sum
   end
-
 end

app/models/decklist.rb

@@ -7,7 +7,7 @@ class Decklist < ApplicationRecord
   # TODO(plural): Add a relationship to a public user object.
   belongs_to :side
 
-  has_one :identity_card,
+  has_one :identity_card, # rubocop:disable Rails/InverseOf
           class_name: 'Card',
           foreign_key: 'id',
           primary_key: 'identity_card_id'

app/models/format.rb

@@ -25,5 +25,6 @@ def active_restriction_id
     s.restriction_id
   end
 
-  validates :name, uniqueness: true
+  # TODO(plural): Add an index for this uniqueness constraint.
+  validates :name, uniqueness: true # rubocop:disable Rails/UniqueValidationWithoutIndex
 end

app/models/raw_printing.rb

@@ -19,6 +19,6 @@ class RawPrinting < ApplicationRecord
   has_many :illustrators, through: :illustrator_printings
 
   has_many :unified_restrictions, inverse_of: :resriction, primary_key: :card_id, foreign_key: :card_id
-  has_many :card_pool_cards, primary_key: :card_id, foreign_key: :card_id
+  has_many :card_pool_cards, primary_key: :card_id, foreign_key: :card_id # rubocop:disable Rails/InverseOf
   has_many :card_pools, through: :card_pool_cards
 end

app/models/restriction.rb

@@ -24,7 +24,8 @@ class Restriction < ApplicationRecord
   has_one :restriction_card_subtype_banned
   has_many :banned_subtypes, through: :restriction_card_subtype_banned, source: :card_subtype
 
-  validates :name, uniqueness: true
+  # TODO(plural): Add an index for this uniqueness constraint.
+  validates :name, uniqueness: true # rubocop:disable Rails/UniqueValidationWithoutIndex
 
   # TODO(plural): Make date_start a proper date type.
 

app/models/review.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# Model for reviews of cards.
 class Review < ApplicationRecord
   belongs_to :card
   has_many :review_comments

app/models/review_comment.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# Model for comments on reviews.
 class ReviewComment < ApplicationRecord
   belongs_to :review
 end

app/models/review_vote.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# Model for votes on reviews.
 class ReviewVote < ApplicationRecord
   belongs_to :review
 end

config.ru

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # This file is used by Rack-based servers to start the application.
 
-require_relative "config/environment"
+require_relative 'config/environment'
 
 run Rails.application
 Rails.application.load_server

config/application.rb

@@ -1,8 +1,10 @@
-require_relative "boot"
+# frozen_string_literal: true
 
-require "rails/all"
+require_relative 'boot'
 
-require "sprockets/railtie"
+require 'rails/all'
+
+require 'sprockets/railtie'
 
 # TODO(plural): See if there is a different solution here.
 # Requied by Graphiti but not included in their for top-level Gem for some reason.
@@ -13,7 +15,7 @@
 Bundler.require(*Rails.groups)
 
 module NrdbApi
-  class Application < Rails::Application
+  class Application < Rails::Application # rubocop:disable Style/Documentation
     routes.default_url_options[:host] = ENV.fetch('HOST', 'http://localhost:3000')
 
     # Initialize configuration defaults for originally generated Rails version.
@@ -25,7 +27,7 @@ class Application < Rails::Application
     # in config/environments, which are processed later.
     #
     # config.time_zone = "Central Time (US & Canada)"
-    config.eager_load_paths << Rails.root.join("lib")
+    config.eager_load_paths << Rails.root.join('lib')
 
     # Only loads a smaller set of middleware suitable for API only apps.
     # Middleware like session, flash, cookies can be added back manually.

config/boot.rb

@@ -1,4 +1,6 @@
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+# frozen_string_literal: true
 
-require "bundler/setup" # Set up gems listed in the Gemfile.
-require "bootsnap/setup" # Speed up boot time by caching expensive operations.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.
+require 'bootsnap/setup' # Speed up boot time by caching expensive operations.

config/environment.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Load the Rails application.
-require_relative "application"
+require_relative 'application'
 
 # Initialize the Rails application.
 Rails.application.initialize!

config/environments/development.rb

@@ -1,4 +1,6 @@
-require "active_support/core_ext/integer/time"
+# frozen_string_literal: true
+
+require 'active_support/core_ext/integer/time'
 
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
@@ -18,10 +20,10 @@
 
   # Enable/disable caching. By default caching is disabled.
   # Run rails dev:cache to toggle caching.
-  if Rails.root.join("tmp/caching-dev.txt").exist?
+  if Rails.root.join('tmp/caching-dev.txt').exist?
     config.cache_store = :memory_store
     config.public_file_server.headers = {
-      "Cache-Control" => "public, max-age=#{2.days.to_i}"
+      'Cache-Control' => "public, max-age=#{2.days.to_i}"
     }
   else
     config.action_controller.perform_caching = false
@@ -52,7 +54,6 @@
   # Highlight code that triggered database queries in logs.
   config.active_record.verbose_query_logs = true
 
-
   # Raises error for missing translations.
   # config.i18n.raise_on_missing_translations = true
 
@@ -61,6 +62,6 @@
 
   # Uncomment if you wish to allow Action Cable access from any origin.
   # config.action_cable.disable_request_forgery_protection = true
-  config.hosts << "api-preview.netrunnerdb.com"
-  config.hosts << "nrdb_api_server"
+  config.hosts << 'api-preview.netrunnerdb.com'
+  config.hosts << 'nrdb_api_server'
 end

config/environments/production.rb

@@ -1,4 +1,6 @@
-require "active_support/core_ext/integer/time"
+# frozen_string_literal: true
+
+require 'active_support/core_ext/integer/time'
 
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
@@ -13,7 +15,7 @@
   config.eager_load = true
 
   # Full error reports are disabled and caching is turned on.
-  config.consider_all_requests_local       = false
+  config.consider_all_requests_local = false
 
   # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
   # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
@@ -46,7 +48,7 @@
   config.log_level = :info
 
   # Prepend all log lines with the following tags.
-  config.log_tags = [ :request_id ]
+  config.log_tags = [:request_id]
 
   # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
@@ -75,8 +77,8 @@
   # require "syslog/logger"
   # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new "app-name")
 
-  if ENV["RAILS_LOG_TO_STDOUT"].present?
-    logger           = ActiveSupport::Logger.new(STDOUT)
+  if ENV['RAILS_LOG_TO_STDOUT'].present?
+    logger           = ActiveSupport::Logger.new($stdout)
     logger.formatter = config.log_formatter
     config.logger    = ActiveSupport::TaggedLogging.new(logger)
   end

config/environments/test.rb

@@ -1,4 +1,6 @@
-require "active_support/core_ext/integer/time"
+# frozen_string_literal: true
+
+require 'active_support/core_ext/integer/time'
 
 # The test environment is used exclusively to run your application's
 # test suite. You never need to work with it otherwise. Remember that
@@ -19,7 +21,7 @@
   # Configure public file server for tests with Cache-Control for performance.
   config.public_file_server.enabled = true
   config.public_file_server.headers = {
-    "Cache-Control" => "public, max-age=#{1.hour.to_i}"
+    'Cache-Control' => "public, max-age=#{1.hour.to_i}"
   }
 
   # Show full error reports and disable caching.