sevencop 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8acc90d7c82f23729f66dce9a0376410c1cdd2f01d71592b9c3575a4a9d9c416
-  data.tar.gz: 3d49905a627a5cfd72a00e73328a898fddb0c3a9f78942a32932486e87182eff
+  metadata.gz: c55fa975db18f38f073127cff1b736321d599328040959966ca3c7ee68e576f4
+  data.tar.gz: a976b6455cf9083a81dca72c0ecd2b7df79e963ca1fd49124d6c756799975ee3
 SHA512:
-  metadata.gz: 80f9368358f530ff0eceef9a9a071b26a772b28aee8c8fe3199d8e9fc53571205c94ad2be9af4f8485c5c91f7de6934c7e16773fb3c460ed4ac5a9d68525a74a
-  data.tar.gz: d79f8f27058781abde3fb6773aa427714edb95deff385dc5777ca4d3b069d6bbd62d6b21178786a6f9b7ca9dad3745bbf46f78b40b1e737b5006ab5b4dda9028
+  metadata.gz: 8f9f873aead1ae719deb96b16f46850fb8daa55a81dbb7709f548352b624bffdb34f639176f5580bbc25bd279c8acd679b175b0a9755c89260c23ef303975a18
+  data.tar.gz: 43e716bfb540bfa7a607aeefae2bef61334518b636d277fcff4155af7145734d17f6eec10494a72b09e40b3d6736175f28b84db18091f89dad4c179bd5479320

data/.rubocop.yml

@@ -26,6 +26,18 @@ RSpec/ExampleLength:
 RSpec/MultipleExpectations:
   Enabled: false
 
+Sevencop/AutoloadOrdered:
+  Enabled: true
+
+Sevencop/HashElementOrdered:
+  Enabled: true
+
+Sevencop/MethodDefinitionArgumentsMultiline:
+  Enabled: true
+
+Sevencop/MethodDefinitionKeywordArgumentOrdered:
+  Enabled: true
+
 Sevencop/MethodDefinitionOrdered:
   Enabled: true
 

data/Gemfile.lock

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

data/README.md

@@ -2,49 +2,31 @@
 
 [![test](https://github.com/r7kamura/sevencop/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/sevencop/actions/workflows/test.yml)
 
-Custom cops for [RuboCop](https://github.com/rubocop/rubocop).
+Opinionated custom cops for [RuboCop](https://github.com/rubocop/rubocop).
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Install `sevencop` gem:
 
 ```ruby
+# Gemfile
 gem 'sevencop', require: false
 ```
 
-And then execute:
-
-```
-bundle install
-```
-
-Or install it yourself as:
-
-```
-gem install sevencop
-```
-
-## Usage
-
-Require sevencop from your .rubocop.yml:
+then require `sevencop` and enable the cops you want to use on .rubocop.yml:
 
 ```yaml
 # .rubocop.yml
 require:
   - sevencop
-```
 
-then enable the cops you want to use:
-
-```yaml
-# .rubocop.yml
-Sevencop/RailsBelongsToOptional:
+Sevencop/MethodDefinitionOrdered:
   Enabled: true
 ```
 
 ## Cops
 
-See YARD comments in each cop class for details:
+Choose the cops you want to use and enable them on your .rubocop.yml.
 
 - [Sevencop/AutoloadOrdered](lib/rubocop/cop/sevencop/autoload_ordered.rb)
 - [Sevencop/HashElementOrdered](lib/rubocop/cop/sevencop/hash_element_ordered.rb)
@@ -56,5 +38,6 @@ See YARD comments in each cop class for details:
 - [Sevencop/RailsOrderField](lib/rubocop/cop/sevencop/rails_order_field.rb)
 - [Sevencop/RailsUniquenessValidatorExplicitCaseSensitivity](lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb)
 - [Sevencop/RailsWhereNot](lib/rubocop/cop/sevencop/rails_where_not.rb)
+- [Sevencop/RequireOrdered](lib/rubocop/cop/sevencop/require_ordered.rb)
 
 Note that all cops are `Enabled: false` by default.

data/config/default.yml

@@ -61,3 +61,9 @@ Sevencop/RailsWhereNot:
   Enabled: false
   Safe: false
   VersionAdded: '0.7'
+
+Sevencop/RequireOrdered:
+  Description: |
+    Sort `require` and `require_relative` in alphabetical order.
+  Enabled: false
+  VersionAdded: '0.16'

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

@@ -25,6 +25,8 @@ module RuboCop
 
         include RangeHelp
 
+        include ::Sevencop::CopConcerns::Ordered
+
         MSG = 'Sort `autoload` in alphabetical order.'
 
         RESTRICT_ON_SEND = %i[
@@ -32,14 +34,15 @@ module RuboCop
         ].freeze
 
         # @param node [RuboCop::AST::SendNode]
+        # @return [void]
         def on_send(node)
-          previous_older_autoload = find_previous_older_autoload(node)
-          return unless previous_older_autoload
+          previous_older_sibling = find_previous_older_sibling(node)
+          return unless previous_older_sibling
 
           add_offense(node) do |corrector|
             swap(
               range_by_whole_lines(
-                previous_older_autoload.location.expression,
+                previous_older_sibling.location.expression,
                 include_final_newline: true
               ),
               range_by_whole_lines(
@@ -54,12 +57,12 @@ module RuboCop
         private
 
         # @param node [RuboCop::AST::SendNode]
-        # @return [RuboCop::AST::SendNode]
-        def find_previous_older_autoload(node)
-          node.left_siblings.find do |sibling|
-            next unless sibling.send_type?
-            next unless sibling.method?(:autoload)
-            next unless in_same_section?(sibling, node)
+        # @return [RuboCop::AST::SendNode, nil]
+        def find_previous_older_sibling(node)
+          node.left_siblings.grep(::RuboCop::AST::Node).reverse.find do |sibling|
+            break unless sibling.send_type?
+            break unless sibling.method?(:autoload)
+            break unless in_same_section?(sibling, node)
 
             node.first_argument.source < sibling.first_argument.source
           end
@@ -68,7 +71,10 @@ module RuboCop
         # @param node1 [RuboCop::AST::SendNode]
         # @param node2 [RuboCop::AST::SendNode]
         # @return [Boolean]
-        def in_same_section?(node1, node2)
+        def in_same_section?(
+          node1,
+          node2
+        )
           !node1.location.expression.with(
             end_pos: node2.location.expression.end_pos
           ).source.include?("\n\n")
@@ -77,7 +83,11 @@ module RuboCop
         # @param range1 [Paresr::Source::Range]
         # @param range2 [Paresr::Source::Range]
         # @param corrector [RuboCop::AST::Corrector]
-        def swap(range1, range2, corrector:)
+        def swap(
+          range1,
+          range2,
+          corrector:
+        )
           corrector.insert_before(range1, range2.source)
           corrector.remove(range2)
         end

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

@@ -39,7 +39,10 @@ module RuboCop
         # @param corrector [RuboCop::AST::Corrector]
         # @param node [RuboCop::AST::ArgsNode]
         # @return [String]
-        def autocorrect(corrector, node)
+        def autocorrect(
+          corrector,
+          node
+        )
           indent = ' ' * node.parent.location.expression.column
 
           corrector.replace(

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

@@ -30,9 +30,12 @@ module RuboCop
         include RangeHelp
         include VisibilityHelp
 
+        include ::Sevencop::CopConcerns::Ordered
+
         MSG = 'Sort method definition in alphabetical order.'
 
         # @param node [RuboCop::AST::DefNode]
+        # @return [void]
         def on_def(node)
           previous_older_sibling = find_previous_older_sibling(node)
           return unless previous_older_sibling
@@ -43,7 +46,8 @@ module RuboCop
             swap(
               range_with_comments_and_lines(previous_older_sibling),
               range_with_comments_and_lines(node),
-              corrector: corrector
+              corrector: corrector,
+              newline: true
             )
           end
         end
@@ -52,7 +56,7 @@ module RuboCop
         private
 
         # @param node [RuboCop::AST::DefNode]
-        # @return [RuboCop::AST::DefNode]
+        # @return [RuboCop::AST::DefNode, nil]
         def find_previous_older_sibling(node)
           previous_siblings_in_same_section_of(node).find do |sibling|
             next if sibling.type != node.type
@@ -64,33 +68,14 @@ module RuboCop
         # @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?
+          siblings = node.left_siblings.grep(::RuboCop::AST::Node)
+          return siblings if node.defs_type?
 
-          node.left_siblings.reverse.take_while do |sibling|
+          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::Node]
-        # @return [Parser::Source::Range]
-        def range_with_comments_and_lines(node)
-          range_by_whole_lines(
-            range_with_comments(node),
-            include_final_newline: true
-          )
-        end
-
         # @param node [RuboCop::AST::DefNode]
         # @return [#<=>]
         def sort_key_of(node)
@@ -99,17 +84,6 @@ module RuboCop
             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

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

@@ -81,7 +81,10 @@ module RuboCop
 
         # @param [RuboCop::AST::Corrector] corrector
         # @param [RuboCop::AST::Node] node
-        def autocorrect(corrector, node)
+        def autocorrect(
+          corrector,
+          node
+        )
           corrector.remove(
             node.location.expression.with(
               begin_pos: node.left_sibling.location.expression.end_pos

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Sort `require` and `require_relative` in alphabetical order.
+      #
+      # @example
+      #   # bad
+      #   require 'b'
+      #   require 'a'
+      #
+      #   # good
+      #   require 'a'
+      #   require 'b'
+      #
+      #   # bad
+      #   require_relative 'b'
+      #   require_relative 'a'
+      #
+      #   # good
+      #   require_relative 'a'
+      #   require_relative 'b'
+      #
+      #   # good
+      #   require 'a'
+      #   require 'd'
+      #
+      #   require 'b'
+      #   require 'c'
+      #
+      #   # good
+      #   require 'b'
+      #   require_relative 'c'
+      #   require 'a'
+      class RequireOrdered < Base
+        extend AutoCorrector
+
+        include RangeHelp
+
+        include ::Sevencop::CopConcerns::Ordered
+
+        RESTRICT_ON_SEND = %i[
+          require
+          require_relative
+        ].freeze
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def on_send(node)
+          previous_older_sibling = find_previous_older_sibling(node)
+          return unless previous_older_sibling
+
+          add_offense(
+            range_with_comments(node),
+            message: "Sort `#{node.method_name}` in alphabetical order."
+          ) do |corrector|
+            swap(
+              range_with_comments_and_lines(previous_older_sibling),
+              range_with_comments_and_lines(node),
+              corrector: corrector
+            )
+          end
+        end
+
+        private
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [RuboCop::AST::SendNode, nil]
+        def find_previous_older_sibling(node)
+          node.left_siblings.reverse.find do |sibling|
+            break unless sibling.send_type?
+            break if sibling.method_name != node.method_name
+            break unless in_same_section?(sibling, node)
+
+            node.first_argument.source < sibling.first_argument.source
+          end
+        end
+
+        # @param node1 [RuboCop::AST::SendNode]
+        # @param node2 [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def in_same_section?(
+          node1,
+          node2
+        )
+          !node1.location.expression.with(
+            end_pos: node2.location.expression.end_pos
+          ).source.include?("\n\n")
+        end
+      end
+    end
+  end
+end

data/lib/sevencop/cop_concerns/ordered.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sevencop
+  module CopConcerns
+    module Ordered
+      private
+
+      # @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::Node]
+      # @return [Parser::Source::Range]
+      def range_with_comments_and_lines(node)
+        range_by_whole_lines(
+          range_with_comments(node),
+          include_final_newline: true
+        )
+      end
+
+      # @param range1 [Paresr::Source::Range]
+      # @param range2 [Paresr::Source::Range]
+      # @param corrector [RuboCop::AST::Corrector]
+      # @param newline [Boolean]
+      def swap(
+        range1,
+        range2,
+        corrector:,
+        newline: false
+      )
+        inserted = range2.source
+        inserted += "\n" if newline
+        corrector.insert_before(range1, inserted)
+        corrector.remove(range2)
+      end
+    end
+  end
+end

data/lib/sevencop/cop_concerns.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sevencop
+  module CopConcerns
+    autoload :Ordered, 'sevencop/cop_concerns/ordered'
+  end
+end

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'sevencop/cop_concerns'
 require_relative 'sevencop/rubocop_extension'
 require_relative 'sevencop/version'
 
@@ -13,3 +14,4 @@ require_relative 'rubocop/cop/sevencop/rails_inferred_spec_type'
 require_relative 'rubocop/cop/sevencop/rails_order_field'
 require_relative 'rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity'
 require_relative 'rubocop/cop/sevencop/rails_where_not'
+require_relative 'rubocop/cop/sevencop/require_ordered'

data/sevencop.gemspec

@@ -8,14 +8,14 @@ Gem::Specification.new do |spec|
   spec.authors = ['Ryo Nakamura']
   spec.email = ['r7kamura@gmail.com']
 
-  spec.summary = 'Custom cops for RuboCop.'
+  spec.summary = 'Opinionated custom cops for RuboCop.'
   spec.homepage = 'https://github.com/r7kamura/sevencop'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 2.6.0'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/releases"
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -51,8 +51,11 @@ files:
 - lib/rubocop/cop/sevencop/rails_order_field.rb
 - lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb
 - lib/rubocop/cop/sevencop/rails_where_not.rb
+- lib/rubocop/cop/sevencop/require_ordered.rb
 - lib/sevencop.rb
 - lib/sevencop/config_loader.rb
+- lib/sevencop/cop_concerns.rb
+- lib/sevencop/cop_concerns/ordered.rb
 - lib/sevencop/rubocop_extension.rb
 - lib/sevencop/version.rb
 - sevencop.gemspec
@@ -62,7 +65,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/r7kamura/sevencop
   source_code_uri: https://github.com/r7kamura/sevencop
-  changelog_uri: https://github.com/r7kamura/sevencop/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/r7kamura/sevencop/releases
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -82,5 +85,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Custom cops for RuboCop.
+summary: Opinionated custom cops for RuboCop.
 test_files: []