sevencop 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed778fc5bb1459cd5c3c35812b5274177e48515b434b2581c897f40ae6d47448
-  data.tar.gz: 179393f59351517e7d510cdf5a1a4c0762d2b2f64186f0f8470017125ae42d77
+  metadata.gz: 5b95d5ba5dafb534e8e3a9e5c49bd9724db92840e1ca00543251c48a6b0f74f5
+  data.tar.gz: c6f7822017c94416417238387b5e16b76b00e401a8819a27c0d6df40ac1373c2
 SHA512:
-  metadata.gz: cc12be9dc75e7507094a9349560ce08f8e9d5e61755837d2747fd101763b51885383b4d4f3416571303ea9e8e593ed0dc99cc6581206c248a82a41c5ce53a874
-  data.tar.gz: 96286dac7849f571eac18cfde45e76b81044f0381246943082f003abab28109b9f1b19c9127e013a260d1deb7654b6e67a03133714caa9d86b02dc6830645660
+  metadata.gz: 131bb0495d50ebd37c0c03aa81b22d79d3488d8428697cd3af4263342f884b1857363920c40fa6794ba99e1de3e118bf94cf205cee96cc0aad77525f040072ee
+  data.tar.gz: f49be306dde9d6fda9db8d79a653c7814a4b43059265ceaf42fb4bbad2eee61fe112cb0ad56cdb152f626c26da9b54302f89f51f98652aa5ef37574ffcb06d45

data/.rubocop.yml

@@ -3,6 +3,7 @@ require:
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
+  - sevencop
 
 AllCops:
   NewCops: enable
@@ -25,5 +26,11 @@ RSpec/ExampleLength:
 RSpec/MultipleExpectations:
   Enabled: false
 
+Sevencop/MethodDefinitionOrdered:
+  Enabled: true
+
 Style/Documentation:
   Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.13.0)
+    sevencop (0.14.0)
       rubocop
 
 GEM

data/README.md

@@ -1,7 +1,6 @@
 # sevencop
 
 [![test](https://github.com/r7kamura/sevencop/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/sevencop/actions/workflows/test.yml)
-[![Gem Version](https://badge.fury.io/rb/sevencop.svg)](https://rubygems.org/gems/sevencop)
 
 Custom cops for [RuboCop](https://github.com/rubocop/rubocop).
 
@@ -45,174 +44,16 @@ Sevencop/BelongsToOptional:
 
 ## Cops
 
-All cops are `Enabled: false` by default.
+See YARD comments in each cop class for details:
 
-### Sevencop/AutoloadOrdered
+- [Sevencop/BelongsToOptional](lib/rubocop/cop/sevencop/belongs_to_optional.rb)
+- [Sevencop/HashElementOrdered](lib/rubocop/cop/sevencop/hash_element_ordered.rb)
+- [Sevencop/InferredSpecType](lib/rubocop/cop/sevencop/inferred_spec_type.rb)
+- [Sevencop/MethodDefinitionArgumentsMultiline](lib/rubocop/cop/sevencop/method_definition_arguments_multiline.rb)
+- [Sevencop/MethodDefinitionKeywordArgumentsOrdered](lib/rubocop/cop/sevencop/method_definition_keyword_arguments_ordered.rb)
+- [Sevencop/MethodDefinitionOrdered](lib/rubocop/cop/sevencop/method_definition_ordered.rb)
+- [Sevencop/OrderField](lib/rubocop/cop/sevencop/order_field.rb)
+- [Sevencop/UniquenessValidatorExplicitCaseSensitivity](lib/rubocop/cop/sevencop/uniqueness_validator_explicit_case_sensitivity.rb)
+- [Sevencop/WhereNot](lib/rubocop/cop/sevencop/where_not.rb)
 
-Sort `autoload` in alphabetical order within their section.
-
-```ruby
-# bad
-autoload :B, 'b'
-autoload :A, 'a'
-
-# good
-autoload :A, 'a'
-autoload :B, 'b'
-
-# good
-autoload :B, 'b'
-autoload :D, 'd'
-
-autoload :A, 'a'
-autoload :C, 'a'
-```
-
-### Sevencop/BelongsToOptional
-
-Force `belongs_to` with `optional: true` option.
-
-```ruby
-# bad
-belongs_to :group
-
-# good
-belongs_to :group, optional: true
-
-# good
-belongs_to :group, optional: false
-
-# good
-belongs_to :group, options
-```
-
-This is useful for migration of `config.active_record.belongs_to_required_by_default`.
-
-### Sevencop/HashLiteralOrder
-
-Sort Hash literal entries by key.
-
-```ruby
-# bad
-{
-  b: 1,
-  a: 1,
-  c: 1
-}
-
-# good
-{
-  a: 1,
-  b: 1,
-  c: 1
-}
-```
-
-### Sevencop/InferredSpecType
-
-Identifies redundant spec type.
-
-```ruby
-# bad
-# spec/models/user_spec.rb
-RSpec.describe User, type: :model
-
-# good
-# spec/models/user_spec.rb
-RSpec.describe User
-
-# good
-# spec/models/user_spec.rb
-RSpec.describe User, type: :request
-```
-
-### Sevencop/MethodDefinitionKeywordArgumentsOrdered
-
-Sort method definition keyword arguments in alphabetical order.
-
-```ruby
-# bad
-def foo(b:, a:); end
-
-# good
-def foo(a:, b:); end
-
-# bad
-def foo(c:, d:, b: 1, a: 2); end
-
-# good
-def foo(c:, d:, a: 2, b: 1); end
-```
-
-### Sevencop/MethodDefinitionMultilineArguments
-
-Inserts new lines between method definition parameters.
-
-```ruby
-# bad
-def foo(a, b)
-end
-
-# good
-def foo(
-  a,
-  b
-)
-
-# good
-def foo(a)
-end
-```
-
-### Sevencop/OrderField
-
-Identifies a String including "field" is passed to `order` or `reorder`.
-
-```ruby
-# bad
-articles.order('field(id, ?)', a)
-
-# good
-articles.order(Arel.sql('field(id, ?)'), a)
-
-# bad
-reorder('field(id, ?)', a)
-
-# good
-reorder(Arel.sql('field(id, ?)'), a)
-```
-
-### Sevencop/UniquenessValidatorExplicitCaseSensitivity
-
-Identifies use of UniquenessValidator without :case_sensitive option.
-
-```ruby
-# bad
-validates :name, uniqueness: true
-
-# good
-validates :name, uniqueness: { case_sensitive: true }
-
-# good
-validates :name, uniqueness: { case_sensitive: false }
-
-# bad
-validates :name, uniqueness: { allow_nil: true, scope: :user_id }
-
-# good
-validates :name, uniqueness: { allow_nil: true, scope: :user_id, case_sensitive: true }
-```
-
-Useful to keep the same behavior between Rails 6.0 and 6.1 where case insensitive collation is used in MySQL.
-
-### Sevencop/WhereNot
-
-Identifies passing multi-elements Hash literal to `where.not`.
-
-```ruby
-# bad
-where.not(key1: value1, key2: value2)
-
-# good
-where.not(key1: value1).where.not(key2: value2)
-```
+Note that all cops are `Enabled: false` by default.

data/config/default.yml

@@ -11,9 +11,9 @@ Sevencop/BelongsToOptional:
   Safe: false
   VersionAdded: '0.5'
 
-Sevencop/HashLiteralOrder:
+Sevencop/HashElementOrdered:
   Description: |
-    Sort Hash literal entries by key.
+    Sort Hash elements by key.
   Enabled: false
   VersionAdded: '0.6'
 
@@ -23,31 +23,30 @@ Sevencop/InferredSpecType:
   Enabled: false
   VersionAdded: '0.9'
 
-Sevencop/MethodDefinitionKeywordArgumentsOrdered:
+Sevencop/MethodDefinitionArgumentsMultiline:
   Description: |
-    Sort method definition keyword arguments in alphabetical order.
+    Inserts new lines between method definition arguments.
   Enabled: false
-  VersionAdded: '0.13'
+  VersionAdded: '0.11'
 
-Sevencop/MethodDefinitionMultilineArguments:
+Sevencop/MethodDefinitionOrdered:
   Description: |
-    Inserts new lines between method definition parameters.
+    Sort method definitions in alphabetical order.
   Enabled: false
-  VersionAdded: '0.11'
+  VersionAdded: '0.14'
 
-Sevencop/OrderField:
+Sevencop/MethodDefinitionKeywordArgumentsOrdered:
   Description: |
-    Wrap safe SQL String by `Arel.sql`.
+    Sort method definition keyword arguments in alphabetical order.
   Enabled: false
-  Safe: false
-  VersionAdded: '0.4'
+  VersionAdded: '0.13'
 
-Sevencop/ToSWithArgument:
+Sevencop/OrderField:
   Description: |
-    Identifies passing any argument to `#to_s`.
+    Wrap safe SQL String by `Arel.sql`.
   Enabled: false
   Safe: false
-  VersionAdded: '0.8'
+  VersionAdded: '0.4'
 
 Sevencop/UniquenessValidatorExplicitCaseSensitivity:
   Description: |

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Sevencop
-      # Sort `autoload` in alphabetical order within their section.
+      # Sort `autoload` in alphabetical order.
       #
       # @example
       #   # bad
@@ -25,7 +25,7 @@ module RuboCop
 
         include RangeHelp
 
-        MSG = 'Sort `autoload` in alphabetical order within their section.'
+        MSG = 'Sort `autoload` in alphabetical order.'
 
         RESTRICT_ON_SEND = %i[
           autoload

data/lib/rubocop/cop/sevencop/{hash_literal_order.rb → hash_element_ordered.rb}

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Sevencop
-      # Sort Hash literal entries by key.
+      # Sort Hash elements by key.
       #
       # @example
       #
@@ -21,10 +21,10 @@ module RuboCop
       #     c: 1
       #   }
       #
-      class HashLiteralOrder < Base
+      class HashElementOrdered < Base
         extend AutoCorrector
 
-        MSG = 'Sort Hash literal entries by key.'
+        MSG = 'Sort Hash elements by key.'
 
         # @!method hash_literal?(node)
         def_node_matcher :hash_literal?, <<~PATTERN
@@ -64,6 +64,16 @@ module RuboCop
           parts.join
         end
 
+        # @param [RuboCop::AST::HashNode] node
+        # @return [Integer]
+        def offset_for(node)
+          if node.braces?
+            1
+          else
+            0
+          end
+        end
+
         # @param [Array<RuboCop::AST::PairNode>] pairs
         # @return [Array<RuboCop::AST::PairNode>]
         def sort(pairs)
@@ -95,32 +105,22 @@ module RuboCop
         # @param [RuboCop::AST::HashNode] node
         # @return [String]
         #   {    a: 1,   b: 1  }
-        #                    ^^
-        def whitespace_trailing(node)
+        #    ^^^^
+        def whitespace_leading(node)
           processed_source.raw_source[
-            node.pairs[-1].location.expression.end_pos...node.location.expression.end.begin_pos - offset_for(node)
+            node.location.expression.begin.end_pos + offset_for(node)...node.pairs[0].location.expression.begin_pos
           ]
         end
 
         # @param [RuboCop::AST::HashNode] node
         # @return [String]
         #   {    a: 1,   b: 1  }
-        #    ^^^^
-        def whitespace_leading(node)
+        #                    ^^
+        def whitespace_trailing(node)
           processed_source.raw_source[
-            node.location.expression.begin.end_pos + offset_for(node)...node.pairs[0].location.expression.begin_pos
+            node.pairs[-1].location.expression.end_pos...node.location.expression.end.begin_pos - offset_for(node)
           ]
         end
-
-        # @param [RuboCop::AST::HashNode] node
-        # @return [Integer]
-        def offset_for(node)
-          if node.braces?
-            1
-          else
-            0
-          end
-        end
       end
     end
   end

data/lib/rubocop/cop/sevencop/{method_definition_multiline_arguments.rb → method_definition_arguments_multiline.rb}

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Sevencop
-      # Inserts new lines between method definition parameters.
+      # Inserts new lines between method definition arguments.
       #
       # @example
       #   # bad
@@ -19,10 +19,10 @@ module RuboCop
       #   # good
       #   def foo(a)
       #   end
-      class MethodDefinitionMultilineArguments < Base
+      class MethodDefinitionArgumentsMultiline < Base
         extend AutoCorrector
 
-        MSG = 'Insert new lines between method definition parameters.'
+        MSG = 'Insert new lines between method definition arguments.'
 
         # @param node [RuboCop::AST::ArgsNode]
         def on_args(node)
@@ -54,6 +54,11 @@ module RuboCop
           )
         end
 
+        # @return [Boolean]
+        def method_args?(node)
+          !node.parent.nil? && node.parent.def_type?
+        end
+
         # @param node [RuboCop::AST::ArgsNode]
         # @return [Boolean]
         def multilined?(node)
@@ -61,11 +66,6 @@ module RuboCop
             child.location.expression.line
           end.uniq.length == node.children.length
         end
-
-        # @return [Boolean]
-        def method_args?(node)
-          !node.parent.nil? && node.parent.def_type?
-        end
       end
     end
   end

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Sort method definition in alphabetical order.
+      #
+      # @example
+      #   # bad
+      #   def b; end
+      #   def a; end
+      #
+      #   # good
+      #   def a; end
+      #   def b; end
+      #
+      #   # good
+      #   def b; end
+      #   def c; end
+      #   private
+      #   def a; end
+      #   def d; end
+      #
+      #   # good
+      #   def initialize; end
+      #   def a; end
+      class MethodDefinitionOrdered < Base
+        extend AutoCorrector
+
+        include RangeHelp
+        include VisibilityHelp
+
+        MSG = 'Sort method definition in alphabetical order.'
+
+        # @param node [RuboCop::AST::DefNode]
+        def on_def(node)
+          previous_older_sibling = find_previous_older_sibling(node)
+          return unless previous_older_sibling
+
+          add_offense(node) do |corrector|
+            swap(
+              range_by_whole_lines(
+                range_with_comments(previous_older_sibling),
+                include_final_newline: true
+              ),
+              range_by_whole_lines(
+                range_with_comments(node),
+                include_final_newline: true
+              ),
+              corrector: corrector
+            )
+          end
+        end
+        alias on_defs on_def
+
+        private
+
+        # @param node [RuboCop::AST::DefNode]
+        # @return [RuboCop::AST::DefNode]
+        def find_previous_older_sibling(node)
+          previous_siblings_in_same_section_of(node).find do |sibling|
+            next if sibling.type != node.type
+
+            (sort_key_of(sibling) <=> sort_key_of(node)) == 1
+          end
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Array<RuboCop::AST::Node>]
+        def previous_siblings_in_same_section_of(node)
+          return node.left_siblings if node.defs_type?
+
+          node.left_siblings.reverse.take_while do |sibling|
+            !visibility_block?(sibling)
+          end.reverse
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Paresr::Source::Range]
+        def range_with_comments(node)
+          comment = processed_source.ast_with_comments[node].first
+          if comment
+            node.location.expression.with(begin_pos: comment.location.expression.begin_pos)
+          else
+            node.location.expression
+          end
+        end
+
+        # @param node [RuboCop::AST::DefNode]
+        # @return [#<=>]
+        def sort_key_of(node)
+          [
+            node.method?(:initialize) ? 0 : 1,
+            node.method_name
+          ]
+        end
+
+        # @param range1 [Paresr::Source::Range]
+        # @param range2 [Paresr::Source::Range]
+        # @param corrector [RuboCop::AST::Corrector]
+        def swap(range1, range2, corrector:)
+          corrector.insert_before(
+            range1,
+            "#{range2.source}\n"
+          )
+          corrector.remove(range2)
+        end
+      end
+    end
+  end
+end

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

@@ -65,6 +65,11 @@ module RuboCop
           )
         PATTERN
 
+        # @param [RuboCop::AST::SendNode] node
+        def find_uniqueness_value(node)
+          node.arguments[1].pairs.find { |pair| pair.key.value == :uniqueness }.value
+        end
+
         # @param [RuboCop::AST::SendNode] node
         def on_send(node)
           return unless validates_uniqueness?(node) && !validates_uniqueness_with_case_sensitivity?(node)
@@ -84,11 +89,6 @@ module RuboCop
             end
           end
         end
-
-        # @param [RuboCop::AST::SendNode] node
-        def find_uniqueness_value(node)
-          node.arguments[1].pairs.find { |pair| pair.key.value == :uniqueness }.value
-        end
       end
     end
   end

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -5,11 +5,11 @@ require_relative 'sevencop/version'
 
 require_relative 'rubocop/cop/sevencop/autoload_ordered'
 require_relative 'rubocop/cop/sevencop/belongs_to_optional'
-require_relative 'rubocop/cop/sevencop/hash_literal_order'
+require_relative 'rubocop/cop/sevencop/hash_element_ordered'
 require_relative 'rubocop/cop/sevencop/inferred_spec_type'
+require_relative 'rubocop/cop/sevencop/method_definition_arguments_multiline'
 require_relative 'rubocop/cop/sevencop/method_definition_keyword_arguments_ordered'
-require_relative 'rubocop/cop/sevencop/method_definition_multiline_arguments'
+require_relative 'rubocop/cop/sevencop/method_definition_ordered'
 require_relative 'rubocop/cop/sevencop/order_field'
-require_relative 'rubocop/cop/sevencop/to_s_with_argument'
 require_relative 'rubocop/cop/sevencop/uniqueness_validator_explicit_case_sensitivity'
 require_relative 'rubocop/cop/sevencop/where_not'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-24 00:00:00.000000000 Z
+date: 2022-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -43,12 +43,12 @@ files:
 - config/default.yml
 - lib/rubocop/cop/sevencop/autoload_ordered.rb
 - lib/rubocop/cop/sevencop/belongs_to_optional.rb
-- lib/rubocop/cop/sevencop/hash_literal_order.rb
+- lib/rubocop/cop/sevencop/hash_element_ordered.rb
 - lib/rubocop/cop/sevencop/inferred_spec_type.rb
+- lib/rubocop/cop/sevencop/method_definition_arguments_multiline.rb
 - lib/rubocop/cop/sevencop/method_definition_keyword_arguments_ordered.rb
-- lib/rubocop/cop/sevencop/method_definition_multiline_arguments.rb
+- lib/rubocop/cop/sevencop/method_definition_ordered.rb
 - lib/rubocop/cop/sevencop/order_field.rb
-- lib/rubocop/cop/sevencop/to_s_with_argument.rb
 - lib/rubocop/cop/sevencop/uniqueness_validator_explicit_case_sensitivity.rb
 - lib/rubocop/cop/sevencop/where_not.rb
 - lib/sevencop.rb

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Identifies passing any argument to `#to_s`.
-      #
-      # @example
-      #
-      #   # bad
-      #   to_s(:delimited)
-      #
-      #   # good
-      #   to_formatted_s(:delimited)
-      #
-      class ToSWithArgument < Base
-        extend AutoCorrector
-
-        MSG = 'Use `to_formatted_s(...)` instead of `to_s(...)`.'
-
-        RESTRICT_ON_SEND = %i[to_s].freeze
-
-        # @!method to_s_with_any_argument?(node)
-        def_node_matcher :to_s_with_any_argument?, <<~PATTERN
-          (call _ :to_s _+)
-        PATTERN
-
-        def on_send(node)
-          return unless to_s_with_any_argument?(node)
-
-          add_offense(node) do |rewriter|
-            rewriter.replace(
-              node.loc.selector,
-              'to_formatted_s'
-            )
-          end
-        end
-        alias on_csend on_send
-      end
-    end
-  end
-end