comply with rubocop

Author: davidsiaw

.rubocop.yml

@@ -1,31 +1,36 @@
 inherit_from: .rubocop_todo.yml
 
+require:
+  - rubocop-capybara
+  - rubocop-factory_bot
+  - rubocop-rails
+  - rubocop-rspec
+  - rubocop-rspec_rails
+
 AllCops:
+  NewCops: enable
+
   TargetRubyVersion: 3.3
   Exclude:
     - 'db/migrate/*.rb'
-    - 'db/schema.rb'
-    - 'bin/setup'
-    - 'bin/update'
     - 'lib/templates/**/*'
     - 'vendor/**/*'
+    - bin/setup
+    - bin/update
 
 Style/Documentation:
   Exclude:
-    - 'spec/**/*'
     - 'Gemfile'
     - 'Rakefile'
 
 Metrics/BlockLength:
   Exclude:
-    - 'app/apis/**/*'
     - 'config/**/*'
-    - 'spec/**/*'
+    - 'db/schema.rb'
 
-Metrics/LineLength:
+Layout/LineLength:
   Exclude:
     - 'config/**/*'
-    - 'spec/**/*'
     - 'Gemfile'
     - 'Rakefile'
 

.rubocop_todo.yml

@@ -1,7 +1,13 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-12-31 12:20:36 UTC using RuboCop version 1.24.0.
+# on 2024-05-26 04:54:19 UTC using RuboCop version 1.64.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/browser/restricted_area_spec.rb'

Dangerfile

@@ -20,7 +20,7 @@ end
 # Mainly to encourage writing up some reasoning about the PR, rather than
 # just leaving a title
 # ------------------------------------------------------------------------------
-fail 'Please provide a summary in the Pull Request description' if github.pr_body.length < 5
+raise 'Please provide a summary in the Pull Request description' if github.pr_body.length < 5
 
 # ------------------------------------------------------------------------------
 # You've made changes to specs, but no library code has changed?
@@ -42,8 +42,8 @@ end
 
   contents = File.read(file)
   if file.start_with?('spec')
-    fail("`xit` or `fit` left in tests (#{file})") if contents =~ /^\w*[xf]it/
-    fail("`fdescribe` left in tests (#{file})") if contents =~ /^\w*fdescribe/
+    raise("`xit` or `fit` left in tests (#{file})") if contents =~ /^\w*[xf]it/
+    raise("`fdescribe` left in tests (#{file})") if contents =~ /^\w*fdescribe/
   end
 end
 
@@ -76,6 +76,6 @@ message(':tada:') if github.pr_author != 'davidsiaw'
 # Ensure a clean commits history
 # ------------------------------------------------------------------------------
 branch = github.branch_for_base
-if git.commits.any? { |c| c.message =~ /^Merge branch '#{branch}'/ }
-  fail('Please rebase to get rid of the merge commits in this PR')
+raise('Please rebase to get rid of the merge commits in this PR') if git.commits.any? do |c|
+  c.message =~ /^Merge branch '#{branch}'/
 end

Gemfile

@@ -72,6 +72,11 @@ group :development do
   gem 'web-console', '>= 3.3.0'
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
   gem 'rubocop'
+  gem 'rubocop-capybara'
+  gem 'rubocop-factory_bot'
+  gem 'rubocop-rails'
+  gem 'rubocop-rspec'
+  gem 'rubocop-rspec_rails'
   gem 'spring'
   gem 'spring-watcher-listen', '~> 2.1.0'
 end

Gemfile.lock

@@ -395,6 +395,22 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rails (2.25.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (2.29.2)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
@@ -507,6 +523,11 @@ DEPENDENCIES
   rspec-rails
   rspec_junit_formatter
   rubocop
+  rubocop-capybara
+  rubocop-factory_bot
+  rubocop-rails
+  rubocop-rspec
+  rubocop-rspec_rails
   sass-rails (~> 6.0)
   selenium-webdriver
   shoulda-matchers

app/models/paper_trail/version.rb

@@ -2,7 +2,7 @@
 
 module PaperTrail
   # Extension to allow papertrail versions to use ULID
-  class Version < ActiveRecord::Base
+  class Version < ApplicationRecord
     include PaperTrail::VersionConcern
     include ULID::Rails
     ulid :id

config/application.rb

@@ -37,7 +37,7 @@ class Application < Rails::Application
     config.generators.system_tests = nil
 
     config.paths.add File.join('app', 'apis'), glob: File.join('**', '*.rb')
-    config.autoload_paths += Dir[Rails.root.join('app', 'apis', '*')]
+    config.autoload_paths += Dir[Rails.root.join('app/apis/*')]
     config.active_job.queue_adapter = :sidekiq
 
     # Use default logging formatter so that PID and timestamp are not suppressed.

config/environments/development.rb

@@ -21,7 +21,7 @@
     config.action_controller.perform_caching = true
     config.cache_store = :redis_cache_store, { url: ENV['REDIS_URL'] }
 
-  elsif Rails.root.join('tmp', 'caching-dev.txt').exist?
+  elsif Rails.root.join('tmp/caching-dev.txt').exist?
     config.action_controller.perform_caching = true
 
     config.cache_store = :memory_store

config/initializers/sidekiq.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 Sidekiq.configure_server do |config|
-  config.redis = { url: ENV['REDIS_URL'] }
+  config.redis = { url: ENV.fetch('REDIS_URL', nil) }
 end

db/migrate/20190204152040_enable_extensions.rb

@@ -3,6 +3,6 @@
 class EnableExtensions < ActiveRecord::Migration[5.2]
   def change
     enable_extension('pgcrypto')
-  	enable_extension('citext')
+    enable_extension('citext')
   end
 end

db/migrate/20190219160906_devise_create_admins.rb

@@ -4,8 +4,8 @@ class DeviseCreateAdmins < ActiveRecord::Migration[5.2]
   def change
     create_table :admins, id: :uuid do |t|
       ## Database authenticatable
-      t.string :email,              null: false, default: ""
-      t.string :encrypted_password, null: false, default: ""
+      t.string :email,              null: false, default: ''
+      t.string :encrypted_password, null: false, default: ''
 
       ## Recoverable
       t.string   :reset_password_token

db/schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -10,46 +12,45 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.1].define(version: 2019_02_19_160906) do
+ActiveRecord::Schema[7.1].define(version: 20_190_219_160_906) do
   # These are extensions that must be enabled in order to support this database
-  enable_extension "citext"
-  enable_extension "pgcrypto"
-  enable_extension "plpgsql"
+  enable_extension 'citext'
+  enable_extension 'pgcrypto'
+  enable_extension 'plpgsql'
 
-  create_table "admins", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
-    t.string "email", default: "", null: false
-    t.string "encrypted_password", default: "", null: false
-    t.string "reset_password_token"
-    t.datetime "reset_password_sent_at", precision: nil
-    t.datetime "remember_created_at", precision: nil
-    t.integer "sign_in_count", default: 0, null: false
-    t.datetime "current_sign_in_at", precision: nil
-    t.datetime "last_sign_in_at", precision: nil
-    t.inet "current_sign_in_ip"
-    t.inet "last_sign_in_ip"
-    t.string "confirmation_token"
-    t.datetime "confirmed_at", precision: nil
-    t.datetime "confirmation_sent_at", precision: nil
-    t.string "unconfirmed_email"
-    t.integer "failed_attempts", default: 0, null: false
-    t.string "unlock_token"
-    t.datetime "locked_at", precision: nil
-    t.datetime "updated_at", precision: nil
-    t.index ["confirmation_token"], name: "index_admins_on_confirmation_token", unique: true
-    t.index ["email"], name: "index_admins_on_email", unique: true
-    t.index ["reset_password_token"], name: "index_admins_on_reset_password_token", unique: true
-    t.index ["unlock_token"], name: "index_admins_on_unlock_token", unique: true
+  create_table 'admins', id: :uuid, default: -> { 'gen_random_uuid()' }, force: :cascade do |t|
+    t.string 'email', default: '', null: false
+    t.string 'encrypted_password', default: '', null: false
+    t.string 'reset_password_token'
+    t.datetime 'reset_password_sent_at', precision: nil
+    t.datetime 'remember_created_at', precision: nil
+    t.integer 'sign_in_count', default: 0, null: false
+    t.datetime 'current_sign_in_at', precision: nil
+    t.datetime 'last_sign_in_at', precision: nil
+    t.inet 'current_sign_in_ip'
+    t.inet 'last_sign_in_ip'
+    t.string 'confirmation_token'
+    t.datetime 'confirmed_at', precision: nil
+    t.datetime 'confirmation_sent_at', precision: nil
+    t.string 'unconfirmed_email'
+    t.integer 'failed_attempts', default: 0, null: false
+    t.string 'unlock_token'
+    t.datetime 'locked_at', precision: nil
+    t.datetime 'updated_at', precision: nil
+    t.index ['confirmation_token'], name: 'index_admins_on_confirmation_token', unique: true
+    t.index ['email'], name: 'index_admins_on_email', unique: true
+    t.index ['reset_password_token'], name: 'index_admins_on_reset_password_token', unique: true
+    t.index ['unlock_token'], name: 'index_admins_on_unlock_token', unique: true
   end
 
-  create_table "versions", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
-    t.string "item_type", null: false
-    t.uuid "item_id", null: false
-    t.string "event", null: false
-    t.string "whodunnit"
-    t.jsonb "object"
-    t.jsonb "object_changes"
-    t.datetime "created_at", precision: nil
-    t.index ["item_type", "item_id"], name: "index_versions_on_item_type_and_item_id"
+  create_table 'versions', id: :uuid, default: -> { 'gen_random_uuid()' }, force: :cascade do |t|
+    t.string 'item_type', null: false
+    t.uuid 'item_id', null: false
+    t.string 'event', null: false
+    t.string 'whodunnit'
+    t.jsonb 'object'
+    t.jsonb 'object_changes'
+    t.datetime 'created_at', precision: nil
+    t.index %w[item_type item_id], name: 'index_versions_on_item_type_and_item_id'
   end
-
 end

lib/generators/api/api_generator.rb

@@ -47,14 +47,14 @@ def pname_of(tokens)
   end
 
   def fields
-    @fields ||= member_list.map do |member|
+    @fields ||= member_list.to_h do |member|
       tokens = member.split(':')
       [tokens[0], {
         param_name: pname_of(tokens),
         param_type: ptype_of(tokens),
         full_type: tokens[1]
       }]
-    end.to_h
+    end
   end
 
   private
@@ -128,7 +128,7 @@ def mount_api
               "    #{mount_statement}",
               mount_end].map { |x| "#{x}\n" }
 
-    File.open(main_api_path, 'wb') { |file| file.write(result) }
+    File.binwrite(main_api_path, result)
   end
 
   def unmount_api
@@ -138,7 +138,7 @@ def unmount_api
               mount_list_sans_statement,
               mount_end].map { |x| "#{x}\n" }
 
-    File.open(main_api_path, 'wb') { |file| file.write(result) }
+    File.binwrite(main_api_path, result)
   end
 end
 # rubocop:enable Metrics/ClassLength

spec/apis/v1/health_api_spec.rb

@@ -10,6 +10,6 @@
 
   it 'returns ok status' do
     get '/api/v1/health'
-    expect(response.status).to eq 200
+    expect(response).to have_http_status :ok
   end
 end

spec/browser/restricted_area_spec.rb

@@ -4,21 +4,21 @@
 require 'browser_helper'
 
 RSpec.describe 'Restricted Area', :js, type: :browser do
-  let(:admin) { create :admin }
+  let(:admin) { create(:admin) }
 
   it 'sidekiq cannot be accessed without logging in' do
     visit('/sidekiq')
     fill_in 'Email', with: admin.email
     fill_in 'Password', with: admin.password
-    click_button
+    click_link_or_button
     expect(page.body).to match 'Sidekiq'
   end
 
   it 'swagger cannot be accessed without logging in' do
     visit('/swagger')
     fill_in 'Email', with: admin.email
     fill_in 'Password', with: admin.password
-    click_button
+    click_link_or_button
     expect(page.body).to match 'Swagger'
   end
 end

spec/rails_helper.rb

@@ -23,7 +23,7 @@
 # directory. Alternatively, in the individual `*_spec.rb` files, manually
 # require only the support files necessary.
 #
-Dir[Rails.root.join('spec', 'support', '**', '*.rb')].sort.each { |f| require f }
+Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
 
 # Checks for pending migrations and applies them before tests are run.
 # If you are not using ActiveRecord, you can remove these lines.
@@ -37,7 +37,7 @@
   # Remember to include global test helpers here
   include ConcernHelper
 
-  config.fixture_paths = ["#{::Rails.root}/spec/fixtures"]
+  config.fixture_paths = [Rails.root.join('spec/fixtures').to_s]
 
   DatabaseCleaner.allow_remote_database_url = true
   config.use_transactional_fixtures = false
@@ -59,7 +59,7 @@
     DatabaseCleaner.clean_with(:truncation)
   end
 
-  config.before(:each) do
+  config.before do
     DatabaseCleaner.strategy = :transaction
   end
 
@@ -76,11 +76,11 @@
     end
   end
 
-  config.before(:each) do
+  config.before do
     DatabaseCleaner.start
   end
 
-  config.after(:each) do
+  config.after do
     DatabaseCleaner.clean
   end
 

spec/support/helpers/concern_helper.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# helps us test concerns
 module ConcernHelper
   def spec_dir
     File.dirname metadata[:file_path]