sevencop 0.41.0 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb5397adad61614b94d14106b30c1ca48a436ca36fa4154986e0ff37127e5c54
-  data.tar.gz: ef34c4ac93d16b2396abd8a61947c5fa317e0b0639bbb40ee61d186d3fa90f83
+  metadata.gz: 3948e119b6a873e0226f93921268a1120b1c0bd8067c6dd2eedf80cd449db92d
+  data.tar.gz: bd864bf33c85003b21ac7a14dd88bfb581f383edc3f1b072d1b59f4b14739e9d
 SHA512:
-  metadata.gz: a602e9e8e23e56a86f99b5cededd1fa3e8cdd002fba5a5bb0de3534fd5fc219d5c793dc61024a4d4ab8d45fbf45c645f197b24da9a58a4eb97a97b0c8947921e
-  data.tar.gz: 3b8868e249ab3e426b691a1ad287e1803f1ce854925d4b195e31bf20f49cb2a135e425579671a374ced892ee653ae0b3e7af156451553ec5d23439cb8cc160e8
+  metadata.gz: c25ad4ee15137b961661fc5ec92a3e930116c53fd19c01d28a5886448668c0307d30448b990367f3890d2bfc2f4c2aaafc4b1e5f9fb8143b8c54822071d5005e
+  data.tar.gz: 2815ccf2f38067606967043985d1aa898c3220694a20098fc3e28fdb7ca5faa9456363579a69a5bc7decf4c3e61fe571ea4579f7115bcf71864194636fd5c4e0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.41.0)
+    sevencop (0.42.0)
       activesupport
       rubocop
 

data/README.md

@@ -39,6 +39,8 @@ 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)
 - [Sevencop/RailsWhereNot](lib/rubocop/cop/sevencop/rails_where_not.rb)

data/config/default.yml

@@ -63,6 +63,17 @@ 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.
+  Enabled: false
+  Safe: false
+
 Sevencop/RailsSpecificActionName:
   Description: |
     Use only specific action names.

data/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

data/lib/rubocop/cop/sevencop/rails_route_ordered.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Sort routes by path and HTTP method.
+      #
+      # @example
+      #   # bad
+      #   get "/users/:id" => "users#show"
+      #   get "/users" => "users#index"
+      #
+      #   # good
+      #   get "/users" => "users#index"
+      #   get "/users/:id" => "users#show"
+      #
+      #   # bad
+      #   post "/users" => "users#create"
+      #   get  "/users" => "users#index"
+      #
+      #   # good
+      #   get  "/users" => "users#index"
+      #   post "/users" => "users#create"
+      class RailsRouteOrdered < Base
+        extend AutoCorrector
+
+        include RangeHelp
+
+        MSG = 'Sort routes by path and HTTP method.'
+
+        RESTRICT_ON_SEND = %i[
+          delete
+          get
+          head
+          options
+          patch
+          post
+          put
+        ].freeze
+
+        # @param [RuboCop::AST::SendNode] node
+        # @return [void]
+        def on_send(node)
+          previous_older_sibling = find_previous_older_sibling(node)
+          return unless previous_older_sibling
+
+          add_offense(node) do |corrector|
+            corrector.swap(
+              range_with_comments_and_lines(previous_older_sibling),
+              range_with_comments_and_lines(node)
+            )
+          end
+        end
+
+        private
+
+        # @param [RuboCop::AST::SendNode] node
+        # @return [Array<String>]
+        def convert_to_comparison_key(node)
+          [
+            find_path_node(node).source.tr(':', '~'),
+            node.method_name
+          ]
+        end
+
+        # Find path node from both of the following styles:
+        #   `get "/users" => "users#index`
+        #   `get "/users", to: "users#index`
+        # @param [RuboCop::AST::SendNode] node
+        # @return [RuboCop::AST::Node, nil]
+        def find_path_node(node)
+          if node.first_argument.hash_type?
+            node.first_argument.keys.first
+          else
+            node.first_argument
+          end
+        end
+
+        # @param [RuboCop::AST::SendNode] node
+        # @return [RuboCop::AST::SendNode, nil]
+        def find_previous_older_sibling(node)
+          node.left_siblings.grep(::RuboCop::AST::SendNode).reverse.find do |sibling|
+            RESTRICT_ON_SEND.include?(sibling.method_name) &&
+              (convert_to_comparison_key(sibling) <=> convert_to_comparison_key(node)).positive?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sevencop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sevencop
-  VERSION = '0.41.0'
+  VERSION = '0.42.0'
 end

data/lib/sevencop.rb

@@ -15,6 +15,8 @@ require_relative 'rubocop/cop/sevencop/rails_belongs_to_optional'
 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'
 require_relative 'rubocop/cop/sevencop/rails_where_not'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.41.0
+  version: 0.42.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -67,6 +67,8 @@ files:
 - lib/rubocop/cop/sevencop/rails_date_and_time_calculation.rb
 - lib/rubocop/cop/sevencop/rails_order_field_arel_sql.rb
 - lib/rubocop/cop/sevencop/rails_order_field_in_order_of.rb
+- lib/rubocop/cop/sevencop/rails_route_as.rb
+- lib/rubocop/cop/sevencop/rails_route_ordered.rb
 - lib/rubocop/cop/sevencop/rails_specific_action_name.rb
 - lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb
 - lib/rubocop/cop/sevencop/rails_where_not.rb