Merge pull request #203 from r7kamura/rails-route-as

Add `Sevencop/RailsRouteAs` cop

README.md

@@ -39,6 +39,7 @@ Note that all cops are `Enabled: false` by default.
 - [Sevencop/RailsDateAndTimeCalculation](lib/rubocop/cop/sevencop/rails_date_and_time_calculation.rb)
 - [Sevencop/RailsOrderFieldArelSql](lib/rubocop/cop/sevencop/rails_order_field_arel_sql.rb)
 - [Sevencop/RailsOrderFieldInOrderOf](lib/rubocop/cop/sevencop/rails_order_field_in_order_of.rb)
+- [Sevencop/RailsRouteAs](lib/rubocop/cop/sevencop/rails_route_as.rb)
 - [Sevencop/RailsRouteOrdered](lib/rubocop/cop/sevencop/rails_route_ordered.rb)
 - [Sevencop/RailsSpecificActionName](lib/rubocop/cop/sevencop/rails_specific_action_name.rb)
 - [Sevencop/RailsUniquenessValidatorExplicitCaseSensitivity](lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb)

config/default.yml

@@ -63,6 +63,11 @@ Sevencop/RailsOrderFieldInOrderOf:
   Enabled: false
   Safe: false
 
+Sevencop/RailsRouteAs:
+  Description: |
+    Always use `as` option on routing methods.
+  Enabled: false
+
 Sevencop/RailsRouteOrdered:
   Description: |
     Sort routes by path and HTTP method.

lib/rubocop/cop/sevencop/rails_route_as.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Always use `as` option on routing methods.
+      #
+      # @example
+      #   # bad
+      #   delete "/users/:id" => "users#destroy"
+      #   get    "/users/:id" => "users#show"
+      #
+      #   # good
+      #   delete "/users/:id" => "users#destroy", as: "user"
+      #   get    "/users/:id" => "users#show", as: nil
+      class RailsRouteAs < Base
+        MSG = "Always use `as` option on routing methods. Use `as: nil` if you don't need named routes."
+
+        RESTRICT_ON_SEND = %i[
+          delete
+          get
+          head
+          patch
+          post
+          put
+        ].freeze
+
+        # @param [RuboCop::AST::SendNode] node
+        # @return [void]
+        def on_send(node)
+          last_argument = node.last_argument
+          return unless last_argument&.hash_type?
+          return if last_argument.pairs.any? { |pair| pair.key.value == :as }
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

lib/sevencop.rb

@@ -15,6 +15,7 @@
 require_relative 'rubocop/cop/sevencop/rails_date_and_time_calculation'
 require_relative 'rubocop/cop/sevencop/rails_order_field_arel_sql'
 require_relative 'rubocop/cop/sevencop/rails_order_field_in_order_of'
+require_relative 'rubocop/cop/sevencop/rails_route_as'
 require_relative 'rubocop/cop/sevencop/rails_route_ordered'
 require_relative 'rubocop/cop/sevencop/rails_specific_action_name'
 require_relative 'rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity'

spec/rubocop/cop/sevencop/rails_route_as_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RuboCop::Cop::Sevencop::RailsRouteAs, :config do
+  context 'when `as` option is used' do
+    it 'registers no offense' do
+      expect_no_offenses(<<~RUBY)
+        get "/users" => "users#index", as: "users"
+      RUBY
+    end
+  end
+
+  context 'when `as` option is not used' do
+    it 'registers offense' do
+      expect_offense(<<~RUBY)
+        get "/users" => "users#index"
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Always use `as` option on routing methods. Use `as: nil` if you don't need named routes.
+      RUBY
+    end
+  end
+end