sevencop 0.40.1 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9d291c9bf0ec6bb349a6f7a70ebca387c933ddb9ca4a84bfa34f8906b044d68
-  data.tar.gz: 3d005e1c0636815cf76667e80866a48f6279bfbbbe251f58920f356728ad96ec
+  metadata.gz: 3948e119b6a873e0226f93921268a1120b1c0bd8067c6dd2eedf80cd449db92d
+  data.tar.gz: bd864bf33c85003b21ac7a14dd88bfb581f383edc3f1b072d1b59f4b14739e9d
 SHA512:
-  metadata.gz: be809d23bb893cbbff03f3bdd6a95f79db7aac41f3920defba5f55393b71f24b44cb0fd178f4e2920e00e94fbc9f724b73d7ee4d76c53bbca43a266cb053e1ca
-  data.tar.gz: 66342ee1af89275c848a4c8c11ff06337fbfefb53a659c350621cdc5b0bc7fb784a1ee58cf77fcf1556bb2e1b8ca8e7ac896c10a02eee67ab6d3716850004a66
+  metadata.gz: c25ad4ee15137b961661fc5ec92a3e930116c53fd19c01d28a5886448668c0307d30448b990367f3890d2bfc2f4c2aaafc4b1e5f9fb8143b8c54822071d5005e
+  data.tar.gz: 2815ccf2f38067606967043985d1aa898c3220694a20098fc3e28fdb7ca5faa9456363579a69a5bc7decf4c3e61fe571ea4579f7115bcf71864194636fd5c4e0

data/Gemfile.lock

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

data/README.md

@@ -29,8 +29,6 @@ Note that all cops are `Enabled: false` by default.
 ## Cops
 
 - [Sevencop/AutoloadOrdered](lib/rubocop/cop/sevencop/autoload_ordered.rb)
-- [Sevencop/FactoryBotAssociationOption](lib/rubocop/cop/sevencop/factory_bot_association_option.rb)
-- [Sevencop/FactoryBotAssociationStyle](lib/rubocop/cop/sevencop/factory_bot_association_style.rb)
 - [Sevencop/HashElementOrdered](lib/rubocop/cop/sevencop/hash_element_ordered.rb)
 - [Sevencop/MapMethodChain](lib/rubocop/cop/sevencop/map_method_chain.rb)
 - [Sevencop/MethodDefinitionArgumentsMultiline](lib/rubocop/cop/sevencop/method_definition_arguments_multiline.rb)
@@ -41,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

@@ -4,30 +4,6 @@ Sevencop/AutoloadOrdered:
   Enabled: false
   Safe: false
 
-Sevencop/FactoryBotAssociationOption:
-  Description: |
-    Avoid redundant options on FactoryBot associations.
-  Enabled: false
-
-Sevencop/FactoryBotAssociationStyle:
-  Description: |
-    Use consistent style in FactoryBot associations.
-  Enabled: false
-  Safe: false
-  EnforcedStyle: implicit
-  SupportedStyles:
-    - explicit
-    - implicit
-  inherit_mode:
-    merge:
-      - NonImplicitAssociationMethodNames
-  NonImplicitAssociationMethodNames:
-    - skip_create
-  Include:
-    - "**/factories.rb"
-    - "**/spec/factories/*.rb"
-    - "**/test/factories/*.rb"
-
 Sevencop/HashElementOrdered:
   Description: |
     Sort Hash elements by key.
@@ -87,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.40.1'
+  VERSION = '0.42.0'
 end

data/lib/sevencop.rb

@@ -5,8 +5,6 @@ require_relative 'sevencop/rubocop_extension'
 require_relative 'sevencop/version'
 
 require_relative 'rubocop/cop/sevencop/autoload_ordered'
-require_relative 'rubocop/cop/sevencop/factory_bot_association_option'
-require_relative 'rubocop/cop/sevencop/factory_bot_association_style'
 require_relative 'rubocop/cop/sevencop/hash_element_ordered'
 require_relative 'rubocop/cop/sevencop/map_method_chain'
 require_relative 'rubocop/cop/sevencop/method_definition_arguments_multiline'
@@ -17,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.40.1
+  version: 0.42.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -57,8 +57,6 @@ files:
 - config/default.yml
 - data/reserved_words_mysql.txt
 - lib/rubocop/cop/sevencop/autoload_ordered.rb
-- lib/rubocop/cop/sevencop/factory_bot_association_option.rb
-- lib/rubocop/cop/sevencop/factory_bot_association_style.rb
 - lib/rubocop/cop/sevencop/hash_element_ordered.rb
 - lib/rubocop/cop/sevencop/map_method_chain.rb
 - lib/rubocop/cop/sevencop/method_definition_arguments_multiline.rb
@@ -69,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

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

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Avoid redundant options on FactoryBot associations.
-      #
-      # @example
-      #   # bad
-      #   association :user, factory: :user
-      #
-      #   # good
-      #   association :user
-      class FactoryBotAssociationOption < RuboCop::Cop::Base
-        extend AutoCorrector
-
-        include RangeHelp
-
-        MSG = 'Avoid redundant options on FactoryBot associations.'
-
-        RESTRICT_ON_SEND = %i[association].freeze
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def on_send(node)
-          association_name = association_name_from(node)
-          factory_option = factory_option_from(node)
-          return if !factory_option || association_name != factory_option.value.value
-
-          add_offense(factory_option) do |corrector|
-            autocorrect(corrector, factory_option)
-          end
-        end
-
-        private
-
-        # @!method association_name_from(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Symbol, nil]
-        def_node_matcher :association_name_from, <<~PATTERN
-          (send
-            nil?
-            _
-            (sym $_)
-            ...
-          )
-        PATTERN
-
-        # @!method factory_option_from(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::PairNode, nil]
-        def_node_matcher :factory_option_from, <<~PATTERN
-          (send
-            nil?
-            _
-            _
-            (hash
-              <
-                $(pair
-                  (sym :factory)
-                  sym
-                )
-                ...
-              >
-            )
-          )
-        PATTERN
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::PairNode]
-        # @return [void]
-        def autocorrect(
-          corrector,
-          node
-        )
-          corrector.remove(
-            range_with_surrounding_comma(
-              range_with_surrounding_space(
-                node.source_range,
-                side: :left
-              ),
-              :left
-            )
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,168 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Use consistent style in FactoryBot associations.
-      #
-      # @safety
-      #   This cop may cause false-positives in `EnforcedStyle: explicit` case.
-      #   It recognizes any method call that has no arguments as an implicit association
-      #   but it might be a user-defined trait call.
-      #
-      # @example EnforcedStyle: implicit (default)
-      #   # bad
-      #   association :user
-      #
-      #   # good
-      #   user
-      #
-      #   # good
-      #   association :author, factory: user
-      #
-      # @example EnforcedStyle: explicit
-      #   # bad
-      #   user
-      #
-      #   # good
-      #   association :user
-      #
-      #   # good (defined in NonImplicitAssociationMethodNames)
-      #   skip_create
-      class FactoryBotAssociationStyle < RuboCop::Cop::Base
-        extend AutoCorrector
-
-        include ConfigurableEnforcedStyle
-
-        MSG = 'Use consistent style in FactoryBot associations.'
-
-        RESTRICT_ON_SEND = %i[factory].freeze
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def on_send(node)
-          bad_associations_in(node).each do |association|
-            add_offense(association) do |corrector|
-              autocorrect(corrector, association)
-            end
-          end
-        end
-
-        private
-
-        # @!method explicit_association?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :explicit_association?, <<~PATTERN
-          (send
-            nil?
-            :association
-            ...
-          )
-        PATTERN
-
-        # @!method implicit_association?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :implicit_association?, <<~PATTERN
-          (send
-            nil?
-            !#non_implicit_association_method_name?
-          )
-        PATTERN
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::SendNode]
-        def autocorrect(
-          corrector,
-          node
-        )
-          case style
-          when :explicit
-            autocorrect_to_explicit_style(corrector, node)
-          when :implicit
-            autocorrect_to_implicit_style(corrector, node)
-          end
-        end
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def autocorrect_to_explicit_style(
-          corrector,
-          node
-        )
-          corrector.replace(node, "association :#{node.method_name}")
-        end
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def autocorrect_to_implicit_style(
-          corrector,
-          node
-        )
-          corrector.replace(node, node.first_argument.value.to_s)
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def autocorrectable_to_implicit_style?(node)
-          node.arguments.one?
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def bad?(node)
-          case style
-          when :explicit
-            bad_to_explicit_style?(node)
-          when :implicit
-            bad_to_implicit_style?(node)
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Array<RuboCop::AST::SendNode>]
-        def bad_associations_in(node)
-          children_of_factory_block(node).select do |child|
-            bad?(child)
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def bad_to_explicit_style?(node)
-          implicit_association?(node)
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def bad_to_implicit_style?(node)
-          explicit_association?(node) && autocorrectable_to_implicit_style?(node)
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Array<RuboCop::AST::Node>]
-        def children_of_factory_block(node)
-          block = node.parent
-          return [] unless block
-          return [] unless block.block_type?
-          return [] unless block.body
-
-          if block.body.begin_type?
-            block.body.children
-          else
-            [block.body]
-          end
-        end
-
-        # @param method_name [Symbol]
-        # @return [Boolean]
-        def non_implicit_association_method_name?(method_name)
-          cop_config['NonImplicitAssociationMethodNames'].include?(method_name.to_s)
-        end
-      end
-    end
-  end
-end