Add new Rails/ArelStar cop

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 * [#362](https://github.com/rubocop-hq/rubocop-rails/pull/362): Add new `Rails/WhereEquals` cop. ([@eugeneius][])
 * [#339](https://github.com/rubocop-hq/rubocop-rails/pull/339): Add new `Rails/AttributeDefaultBlockValue` cop. ([@cilim][])
+* [#344](https://github.com/rubocop-hq/rubocop-rails/pull/344): Add new `Rails/ArelStar` cop which checks for quoted literal asterisks in `arel_table` calls. ([@flanger001][])
 
 ### Bug fixes
 
@@ -300,3 +301,4 @@
 [@dvandersluis]: https://github.com/dvandersluis
 [@Tietew]: https://github.com/Tietew
 [@cilim]: https://github.com/cilim
+[@flanger001]: https://github.com/flanger001

config/default.yml

@@ -98,6 +98,12 @@ Rails/ApplicationRecord:
   VersionAdded: '0.49'
   VersionChanged: '2.5'
 
+Rails/ArelStar:
+  Description: 'Enforces `Arel.star` instead of `"*"` for expanded columns.'
+  Enabled: true
+  Safe: false
+  VersionAdded: '2.9'
+
 Rails/AssertNot:
   Description: 'Use `assert_not` instead of `assert !`.'
   Enabled: true

docs/modules/ROOT/pages/cops.adoc

@@ -26,6 +26,7 @@ based on the https://rails.rubystyle.guide/[Rails Style Guide].
 * xref:cops_rails.adoc#railsapplicationjob[Rails/ApplicationJob]
 * xref:cops_rails.adoc#railsapplicationmailer[Rails/ApplicationMailer]
 * xref:cops_rails.adoc#railsapplicationrecord[Rails/ApplicationRecord]
+* xref:cops_rails.adoc#railsarelstar[Rails/ArelStar]
 * xref:cops_rails.adoc#railsassertnot[Rails/AssertNot]
 * xref:cops_rails.adoc#railsattributedefaultblockvalue[Rails/AttributeDefaultBlockValue]
 * xref:cops_rails.adoc#railsbelongsto[Rails/BelongsTo]

docs/modules/ROOT/pages/cops_rails.adoc

@@ -374,6 +374,42 @@ class Rails4Model < ActiveRecord::Base
 end
 ----
 
+== Rails/ArelStar
+
+|===
+| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+
+| Enabled
+| No
+| Yes (Unsafe)
+| 2.9
+| -
+|===
+
+This cop prevents usage of `"*"` on an Arel::Table column reference.
+
+Using `arel_table["*"]` causes the outputted string to be a literal
+quoted asterisk (e.g. <tt>`my_model`.`*`</tt>). This causes the
+database to look for a column named <tt>`*`</tt> (or `"*"`) as opposed
+to expanding the column list as one would likely expect.
+
+This cop is unsafe because it checks for `["*"]`.
+```
+hsh = { "*" => true }
+hsh["*"] # This would get corrected to `hsh[Arel.star]`.
+```
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+MyTable.arel_table["*"]
+
+# good
+MyTable.arel_table[Arel.star]
+----
+
 == Rails/AssertNot
 
 |===

lib/rubocop/cop/rails/arel_star.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop prevents usage of `"*"` on an Arel::Table column reference.
+      #
+      # Using `arel_table["*"]` causes the outputted string to be a literal
+      # quoted asterisk (e.g. <tt>`my_model`.`*`</tt>). This causes the
+      # database to look for a column named <tt>`*`</tt> (or `"*"`) as opposed
+      # to expanding the column list as one would likely expect.
+      #
+      # This cop is unsafe because it checks for `["*"]`.
+      # ```
+      # hsh = { "*" => true }
+      # hsh["*"] # This would get corrected to `hsh[Arel.star]`.
+      # ```
+      #
+      # @example
+      #   # bad
+      #   MyTable.arel_table["*"]
+      #
+      #   # good
+      #   MyTable.arel_table[Arel.star]
+      #
+      class ArelStar < Cop
+        MSG = 'Use `Arel.star` instead of `"*"` for expanded column lists.'
+
+        RESTRICT_ON_SEND = %i[[]].freeze
+
+        def_node_matcher :star_bracket?, <<~PATTERN
+          (send {const {send _ :arel_table}} :[] $(str "*"))
+        PATTERN
+
+        def on_send(node)
+          return unless (star = star_bracket?(node))
+
+          add_offense(star)
+        end
+
+        def autocorrect(node)
+          ->(corrector) { corrector.replace(node.loc.expression, 'Arel.star') }
+        end
+      end
+    end
+  end
+end

lib/rubocop/cop/rails_cops.rb

@@ -14,6 +14,7 @@
 require_relative 'rails/application_job'
 require_relative 'rails/application_mailer'
 require_relative 'rails/application_record'
+require_relative 'rails/arel_star'
 require_relative 'rails/assert_not'
 require_relative 'rails/attribute_default_block_value'
 require_relative 'rails/belongs_to'

spec/rubocop/cop/rails/arel_star_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Rails::ArelStar do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offense and corrects when an asterisk is used on an Arel::Table column reference' do
+    expect_offense(<<~RUBY)
+      class MyModel < ApplicationRecord
+        scope :my_scope, -> { select(arel_table["*"]) }
+                                                ^^^ Use `Arel.star` instead of `"*"` for expanded column lists.
+      end
+    RUBY
+
+    expect_correction(<<~RUBY)
+      class MyModel < ApplicationRecord
+        scope :my_scope, -> { select(arel_table[Arel.star]) }
+      end
+    RUBY
+  end
+
+  it 'registers an offense on the `arel_table` object in a void' do
+    expect_offense(<<~RUBY)
+      arel_table["*"]
+                 ^^^ Use `Arel.star` instead of `"*"` for expanded column lists.
+    RUBY
+
+    expect_correction(<<~RUBY)
+      arel_table[Arel.star]
+    RUBY
+  end
+
+  it 'registers an offense on the `arel_table` object on a model' do
+    expect_offense(<<~RUBY)
+      MyModel.arel_table["*"]
+                         ^^^ Use `Arel.star` instead of `"*"` for expanded column lists.
+    RUBY
+
+    expect_correction(<<~RUBY)
+      MyModel.arel_table[Arel.star]
+    RUBY
+  end
+
+  it 'registers an offense for ArelExtensions asterisks' do
+    expect_offense(<<~RUBY)
+      MyModel["*"]
+              ^^^ Use `Arel.star` instead of `"*"` for expanded column lists.
+    RUBY
+
+    expect_correction(<<~RUBY)
+      MyModel[Arel.star]
+    RUBY
+  end
+end