Detect a non-standard controller (#62)

See Betterment/the-book#250

Author: rzane

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    betterlint (1.15.1)
+    betterlint (1.16.0)
       rubocop (~> 1.62.0)
       rubocop-graphql (~> 1.5.0)
       rubocop-performance (~> 1.21.0)

betterlint.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name = "betterlint"
-  s.version = "1.15.1"
+  s.version = "1.16.0"
   s.authors = ["Development"]
   s.email = ["[email protected]"]
   s.summary = "Betterment rubocop configuration"

config/default.yml

@@ -64,6 +64,11 @@ Betterment/NonStandardActions:
     - update
   StyleGuide: '#bettermentnonstandardactions'
 
+Betterment/NonStandardController:
+  Description: Detects non-standard controller names.
+  Include:
+    - config/routes.rb
+
 Betterment/RedirectStatus:
   SafeAutoCorrect: false
   Description: Detect missing status codes when redirecting POST, PUT, PATCH, or DELETE responses

lib/rubocop/cop/betterment.rb

@@ -13,6 +13,7 @@
 require 'rubocop/cop/betterment/internals_protection'
 require 'rubocop/cop/betterment/memoization_with_arguments'
 require 'rubocop/cop/betterment/non_standard_actions'
+require 'rubocop/cop/betterment/non_standard_controller'
 require 'rubocop/cop/betterment/site_prism_loaded'
 require 'rubocop/cop/betterment/spec_helper_required_outside_spec_dir'
 require 'rubocop/cop/betterment/implicit_redirect_type'

lib/rubocop/cop/betterment/non_standard_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Betterment
+      class NonStandardController < RuboCop::Cop::Base
+        MSG = <<~END.gsub(/\s+/, " ")
+          `resources` and `resource` should not need to specify a `controller` option.
+          If your controller lives in a module, please use the `module` option. Otherwise,
+          please rename your controller to match your routes.
+        END
+
+        # @!method resources_with_controller(node)
+        def_node_matcher :resources_with_controller, <<~PATTERN
+          (send _ {:resources | :resource} _ (hash <$(pair (sym :controller) _) ...>))
+        PATTERN
+
+        def on_send(node)
+          resources_with_controller(node) { |option| add_offense(option) }
+        end
+      end
+    end
+  end
+end

spec/rubocop/cop/betterment/non_standard_controller_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RuboCop::Cop::Betterment::NonStandardController, :betterlint_config do
+  it 'adds an offense when a controller is specified' do
+    expect_offense(<<~RUBY)
+      resources :users, controller: 'non_standard'
+                        ^^^^^^^^^^^^^^^^^^^^^^^^^^ `resources` and `resource` [...]
+
+      resource :user, controller: 'non_standard'
+                      ^^^^^^^^^^^^^^^^^^^^^^^^^^ `resources` and `resource` [...]
+
+      resources :users, controller: 'non_standard', only: [:index]
+                        ^^^^^^^^^^^^^^^^^^^^^^^^^^ `resources` and `resource` [...]
+
+      resources :users, only: [:index], controller: 'non_standard'
+                                        ^^^^^^^^^^^^^^^^^^^^^^^^^^ `resources` and `resource` [...]
+    RUBY
+  end
+
+  it 'does not add an offense when a controller is not specified' do
+    expect_no_offenses(<<~RUBY)
+      resources :users
+      resources :users, only: [:index]
+      resource :user
+      resource :user, only: [:index]
+    RUBY
+  end
+end