rubocop-ordered_methods 0.3 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33871b68e39c03de6c12f462dc732d282489b190bdaedca681f955c60a27c20c
-  data.tar.gz: c9c22948ef1db00f774d8fcfdf0cd2f60422da6c44b16a3e9430bdef42c86efb
+  metadata.gz: fc5f933eab16f22d4ce9e90bac7b7da25af7af45f7fd1204974ea26d98287476
+  data.tar.gz: c3e5a535a8667acf2c88e8c127219b8b8e330d10e6575df5748391ec1c7758ba
 SHA512:
-  metadata.gz: 571d2b28004397aff91256be2d4b153255870d5b7a4bd8877c3956003e3d73959e5bca95fa7b26901ccf43ee343a5b722eae24dea79540948cbe48a3d016d3bb
-  data.tar.gz: 3fe6b38928ed8c4ee6b5c08d27e3ba4e84277f98e7dfa9fe2e74cca570874b4f63caed8ba40ef5e8799d22bd6ae39db4a619beaddde5cc5328d9685e02525809
+  metadata.gz: c83ba399a7357517935466f59e4be28b75fbb399a571041b54ba4be1c387797b1867be69fcac2abe8e60e89572b34d35d9a327a171880cec2d9807ee258766ca
+  data.tar.gz: dc2897b646af1eb6e2b84dbe2e693be8a0a48de8645caf9551557c6dfe36809a34c92c4166428f9f0b17bd541c3a5c8bf60d349ea3db3286c09ebb4897467e7e

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 
 Gemfile.lock
+.ruby-version

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build rubocop-ordered_methods-0.5.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install rubocop-ordered_methods-0.5.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install rubocop-ordered_methods-0.5.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.5 and build and push rubocop-ordered_methods-0.5.gem to rubygems.org" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run RuboCop" fullCmd="rubocop" taksId="rubocop" /><RakeGroup description="" fullCmd="" taksId="rubocop"><RakeTask description="Auto-correct RuboCop offenses" fullCmd="rubocop:auto_correct" taksId="auto_correct" /></RakeGroup><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.rubocop.yml

@@ -2,10 +2,19 @@ inherit_from: .rubocop_todo.yml
 
 require: rubocop-ordered_methods
 
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.4
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
+Metrics/MethodLength:
+  Exclude:
+    - spec/**/*
+
 Naming/FileName:
   Exclude:
     - lib/rubocop-ordered_methods.rb

data/.rubocop_todo.yml

@@ -1,21 +1,24 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-02-17 13:54:25 -0500 using RuboCop version 0.64.0.
+# on 2021-01-05 20:47:55 UTC using RuboCop version 1.7.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-Metrics/AbcSize:
-  Max: 17
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 11
 
 # Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 101
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/rubocop/cop/layout/ordered_methods.rb'
 
 # Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/MethodLength:
-  Max: 11
+# Cop supports --auto-correct.
+Style/RedundantFreeze:
+  Exclude:
+    - 'lib/rubocop/cop/layout/ordered_methods.rb'

data/.travis.yml

@@ -3,9 +3,10 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.2
   - 2.3
   - 2.4
   - 2.5
   - 2.6
-before_install: gem install bundler -v 1.17.2
+script: bundle exec rake
+before_install:
+  - gem install bundler || gem install bundler --version '< 2'

data/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.8] - 2021-02-01
+
+### Fixed
+
+- Fix NoMethodError and the "\[Correctable\]" label ([#6](https://github.com/shanecav84/rubocop-ordered_methods/pull/6)). Thanks @jaredbeck.
+
+## [0.7] - 2021-01-11
+
+### Removed
+
+- Drop Ruby 2.3 support
+- Drop support for rubocop < 1.0
+
+### Changed
+
+- Support for rubocop >= 1.0 ([#5](https://github.com/shanecav84/rubocop-ordered_methods/pull/5)). Thanks @jaredbeck.
+
+## [0.6] - 2020-03-01
+
+### Security
+
+- Upgrade rake to avoid vulnerability https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-8130
+    - rake is a development dependency for this gem, so shouldn't have been a risk for production
+
+## [0.5] - 2019-11-05
+
+### Removed
+
+- Drop Ruby 2.2 support
+
+### Changed
+
+- Nonadjacent qualifiers are now autocorrected (#4). Thanks @adamkiczula.
+- Cache AST traversals for significant speed up on large files
+
+## [0.4] - 2019-06-11
+
+### Changed
+
+- More robust autocorrection of a method and its surroundings (see `Corrector` in the `README`).
+
+## [0.3] - 2019-02-17
+
+### Added
+
+- Configuration defaults
+
+## [0.2] - 2019-02-17
+
+### Added
+
+- Autocorrector
+
+## [0.1] - 2019-02-17
+
+Initial release.
+
+[Unreleased]: https://github.com/shanecav84/rubocop-ordered_methods/compare/v0.3...HEAD
+[0.3]: https://github.com/shanecav84/rubocop-ordered_methods/compare/v0.2...v0.3
+[0.2]: https://github.com/shanecav84/rubocop-ordered_methods/compare/v0.1...v0.2
+[0.1]: https://github.com/shanecav84/rubocop-ordered_methods/releases/tag/v0.1

data/Gemfile

@@ -1,6 +1,5 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in rubocop-ordered_methods.gemspec
 gemspec

data/README.md

@@ -1,32 +1,35 @@
+[![Gem Version](https://badge.fury.io/rb/rubocop-ordered_methods.svg)](https://badge.fury.io/rb/rubocop-ordered_methods)
+[![Build Status](https://travis-ci.org/shanecav84/rubocop-ordered_methods.svg?branch=master)](https://travis-ci.org/shanecav84/rubocop-ordered_methods)
+
 # RuboCop OrderedMethods
 
-Check that methods are defined alphabetically. Note [caveats](#caveats) for
-autocorrector.
+Check that methods are defined alphabetically per access modifier block (class, 
+public, private, protected). Includes [autocorrection](#corrector).
 
 ```ruby
 # bad
-def self.b; end
-def self.a; end
+def self.b_class; end
+def self.a_class; end
 
-def b; end
-def a; end
+def b_public; end
+def a_public; end
 
 private
 
-def d; end
-def c; end
+def b_private; end
+def a_private; end
 
 # good
-def self.a; end
-def self.b; end
+def self.a_class; end
+def self.b_class; end
 
-def a; end
-def b; end
+def a_public; end
+def b_public; end
 
 private
 
-def c; end
-def d; end
+def a_private; end
+def b_private; end
 ```
 
 ## Installation
@@ -47,7 +50,7 @@ Or install it yourself as:
 
 ## Usage
 
-You need to tell RuboCop to load the OrderedMethods extension. There are three
+You need to tell RuboCop to load the OrderedMethods extension. There are two
 ways to do this:
 
 ### RuboCop configuration file
@@ -71,17 +74,70 @@ rubocop --require rubocop-ordered_methods
 
 Name | Default value | Configurable values
 --- | --- | ---
+EnforcedStyle | `alphabetical` | `alphabetical`
 IgnoredMethods | `initialize` | Array
 
 ### Corrector
 
-The corrector will attempt to order methods alphabetically. It attempts to
-include surrounding comments and the qualifiers listed in
-`::RuboCop::Cop::Layout::OrderedMethods::QUALIFIERS`.
+The corrector will attempt to order methods based on the `EnforcedStyle`. It attempts to
+include surrounding comments and the qualifiers (e.g., aliases) listed in
+`::RuboCop::Cop::OrderedMethodsCorrector::QUALIFIERS`. The following (monstrous)
+source is able to be correctly ordered:
+
+```ruby
+# Long
+# Preceding
+# Comment
+# class_b
+def self.class_b; end
+private_class_method :class_b
+
+def self.class_a; end
+# Long
+# Succeeding
+# Comment
+# class_a
+public_class_method :class_a
+
+# Preceding comment for instance_b
+def instance_b; end
+# Long
+# Succeeding
+# Comment
+# instance_b
+alias_method :orig_instance_b, :instance_b
+module_function :instance_b
+private :instance_b
+protected :instance_b
+public :instance_b
+
+# Long
+# Preceding
+# Comment
+# instance_a
+def instance_a; end
+# Succeeding comment for instance_a
+alias :new_instance_a :instance_a
+alias_method :orig_instance_a, :instance_a
+module_function :instance_a
+private :instance_a
+protected :instance_a
+public :instance_a
+```
 
 #### Caveats
-The corrector can fail to include surrounding comments and qualifiers for some
-methods.
+
+* The corrector will warn and refuse to order a method if it were to be
+  defined before its alias
+* If there's ambiguity about which method a comment or qualifier belongs to,
+  the corrector might fail to order correctly. For example, in the following, 
+  the corrector would incorrectly order the comment as a comment of `a`:
+
+  ```ruby
+  def b; end
+  # Comment b
+  def a; end
+  ```
 
 ## Development
 
@@ -94,12 +150,19 @@ bundle exec rake
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/shanecav84/rubocop-ordered_methods. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at 
+https://github.com/shanecav84/rubocop-ordered_methods. This project is intended 
+to be a safe, welcoming space for collaboration, and contributors are expected 
+to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+ conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the 
+[MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the RuboCop OrderedMethods project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shanecav84/rubocop-ordered_methods/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RuboCop OrderedMethods project’s codebases, issue 
+trackers, chat rooms and mailing lists is expected to follow the 
+[code of conduct](https://github.com/shanecav84/rubocop-ordered_methods/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
 require 'rspec/core/rake_task'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'rubocop/ordered_methods'

data/config/default.yml

@@ -1,4 +1,6 @@
 ---
 Layout/OrderedMethods:
+  Enabled: true
+  EnforcedStyle: 'alphabetical'
   IgnoredMethods:
     - initialize

data/lib/rubocop-ordered_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop'
 require_relative 'rubocop/ordered_methods'
 require_relative 'rubocop/cop/layout/ordered_methods'

data/lib/rubocop/cop/alias_method_order_verifier.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative 'qualifier_node_matchers'
+
+module RuboCop
+  module Cop
+    # This verifies a method is defined before its alias
+    class AliasMethodOrderVerifier
+      class << self
+        include IgnoredNode
+        include QualifierNodeMatchers
+
+        # Disable cop for freezing on Ruby 2.2
+        # rubocop:disable Style/RedundantFreeze
+        ALIAS_BEFORE_METHOD_WARNING_FMT = "Won't reorder " \
+          '%<first_method_name>s and %<second_method_name>s because ' \
+          'alias for %<first_method_name>s would be declared before ' \
+          'its method definition.'.freeze
+        # rubocop:enable Style/RedundantFreeze
+
+        # rubocop:disable Style/GuardClause
+        def verify!(current_node, previous_node)
+          if moving_after_alias?(current_node, previous_node)
+            ignore_node(current_node)
+            raise_warning!(current_node.method_name, previous_node.method_name)
+          end
+          if moving_after_alias?(previous_node, current_node)
+            ignore_node(previous_node)
+            raise_warning!(previous_node.method_name, current_node.method_name)
+          end
+        end
+        # rubocop:enable Style/GuardClause
+
+        private
+
+        def find_aliases(current_node, siblings)
+          siblings.select do |sibling|
+            (alias?(sibling) || alias_method?(sibling)) ==
+              current_node.method_name
+          end
+        end
+
+        # We don't want a method to be defined after its alias
+        def moving_after_alias?(current_node, previous_node)
+          siblings = current_node.parent.children
+          current_node_aliases = find_aliases(current_node, siblings)
+          filter = current_node_aliases.delete_if do |cna|
+            cna.sibling_index > current_node.sibling_index
+          end
+          return false if filter.empty?
+
+          current_node_aliases.any? do |cna|
+            previous_node.sibling_index > cna.sibling_index
+          end
+        end
+
+        def raise_warning!(first_method_name, second_method_name)
+          raise Warning, format(
+            ALIAS_BEFORE_METHOD_WARNING_FMT,
+            first_method_name: first_method_name,
+            second_method_name: second_method_name
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/correctors/ordered_methods_corrector.rb

@@ -1,128 +1,75 @@
 # frozen_string_literal: true
 
 require_relative '../layout/ordered_methods'
+require_relative '../alias_method_order_verifier'
+require_relative '../qualifier_node_matchers'
 
 module RuboCop
   module Cop
     # This auto-corrects method order
     class OrderedMethodsCorrector
-      class << self
-        include IgnoredNode
-        extend NodePattern::Macros
+      include QualifierNodeMatchers
 
-        ALIAS_BEFORE_METHOD_WARNING_FMT = "Won't reorder " \
-          '%<first_method_name>s and %<second_method_name>s because ' \
-          'alias for %<first_method_name>s would be declared before ' \
-          'its method definition.'.freeze
-        QUALIFIERS = (
-            %i[alias_method private_class_method public_class_method] +
-                       ::RuboCop::Cop::Layout::OrderedMethods::
-                         VISIBILITY_MODIFIERS
-          ).freeze
-
-        def_node_matcher :alias?, '(:alias ... (sym $_method_name))'
-        def_node_matcher :qualifier?, <<-PATTERN
-          (send nil? {#{QUALIFIERS.map(&:inspect).join(' ')}}
-            ... (sym $_method_name))
-        PATTERN
-
-        def correct(processed_source, node, previous_node)
-          @processed_source = processed_source
-          @current_node = node
-          @previous_node = previous_node
+      def initialize(comments, siblings)
+        @comments = comments
+        @siblings = siblings
+      end
 
-          verify_alias_method_order
-          current_range = with_surroundings(@current_node)
-          previous_range = with_surroundings(@previous_node)
-          lambda do |corrector|
-            corrector.replace(current_range, previous_range.source)
-            corrector.replace(previous_range, current_range.source)
-          end
+      def correct(node, previous_node)
+        AliasMethodOrderVerifier.verify!(node, previous_node)
+        current_range = join_surroundings(node)
+        previous_range = join_surroundings(previous_node)
+        lambda do |corrector|
+          corrector.replace(current_range, previous_range.source)
+          corrector.replace(previous_range, current_range.source)
         end
+      end
 
-        private
-
-        def found_qualifier?(node, next_sibling)
-          (qualifier?(next_sibling) || alias?(next_sibling)) == node.method_name
-        end
+      private
 
-        # We don't want a method to be defined after its alias
-        def moving_after_alias?(current_node, previous_node)
-          siblings = current_node.parent.children
-          current_node_aliases = siblings.select do |sibling|
-            alias?(sibling) == current_node.method_name
-          end
-          filter = current_node_aliases.delete_if do |cna|
-            cna.sibling_index == current_node.sibling_index + 1
-          end
-          return false if filter.empty?
+      def find_last_qualifier_index(node)
+        preceding_qualifier_index = node.sibling_index
+        last_qualifier_index = @siblings.length - 1
+        while preceding_qualifier_index < last_qualifier_index
+          break if found_qualifier?(node, @siblings[last_qualifier_index])
 
-          current_node_aliases.any? do |cna|
-            previous_node.sibling_index > cna.sibling_index
-          end
+          last_qualifier_index -= 1
         end
 
-        # rubocop:disable Metrics/MethodLength, Style/GuardClause
-        def verify_alias_method_order
-          if moving_after_alias?(@current_node, @previous_node)
-            ignore_node(@current_node)
-            raise Warning, format(
-              ALIAS_BEFORE_METHOD_WARNING_FMT,
-              first_method_name: @current_node.method_name,
-              second_method_name: @previous_node.method_name
-            )
-          end
-          if moving_after_alias?(@previous_node, @current_node)
-            ignore_node(@previous_node)
-            raise Warning, format(
-              ALIAS_BEFORE_METHOD_WARNING_FMT,
-              first_method_name: @previous_node.method_name,
-              second_method_name: @current_node.method_name
-            )
-          end
-        end
-        # rubocop:enable Metrics/MethodLength, Style/GuardClause
+        last_qualifier_index
+      end
 
-        def with_comments(node)
-          node.source_range
-              .join(with_preceding_comments(node))
-              .join(with_succeeding_comments(node))
-        end
+      def found_qualifier?(node, next_sibling)
+        return false if next_sibling.nil?
 
-        def with_modifiers_and_aliases(node)
-          surrounding_range = node.source_range
-          siblings = node.parent.children
-          qualifier_index = node.sibling_index
-          while found_qualifier?(node, siblings[qualifier_index + 1])
-            qualifier_index += 1
-          end
-          found_node_range = with_comments(siblings[qualifier_index])
-          surrounding_range.join(found_node_range)
-        end
+        (qualifier?(next_sibling) || alias?(next_sibling)) == node.method_name
+      end
 
-        def with_preceding_comments(node)
-          surrounding_range = node.source_range
-          @processed_source.ast_with_comments[node].each do |comment|
-            surrounding_range = surrounding_range.join(comment.loc.expression)
-          end
-          surrounding_range
+      def join_comments(node, source_range)
+        @comments[node].each do |comment|
+          source_range = source_range.join(comment.loc.expression)
         end
+        source_range
+      end
 
-        def with_succeeding_comments(node)
-          surrounding_range = node.source_range
-          @processed_source.each_comment do |comment|
-            if comment.loc.expression.begin_pos == surrounding_range.end_pos + 1
-              surrounding_range = surrounding_range.join(comment.loc.expression)
-            end
-          end
-          surrounding_range
+      def join_modifiers_and_aliases(node, source_range)
+        preceding_qualifier_index = node.sibling_index
+        last_qualifier_index = find_last_qualifier_index(node)
+        while preceding_qualifier_index < last_qualifier_index
+          source_range = source_range.join(
+            @siblings[preceding_qualifier_index + 1].source_range
+          )
+          preceding_qualifier_index += 1
         end
+        source_range
+      end
 
-        def with_surroundings(node)
+      def join_surroundings(node)
+        with_modifiers_and_aliases = join_modifiers_and_aliases(
+          node,
           node.source_range
-              .join(with_comments(node))
-              .join(with_modifiers_and_aliases(node))
-        end
+        )
+        join_comments(node, with_modifiers_and_aliases)
       end
     end
   end

data/lib/rubocop/cop/layout/ordered_methods.rb

@@ -3,9 +3,9 @@
 module RuboCop
   module Cop
     module Layout
-      # Check that methods are defined alphabetically.
+      # @example EnforcedStyle: alphabetical (default)
+      #   # Check that methods are defined alphabetically.
       #
-      # @example
       #   # bad
       #   def self.b; end
       #   def self.a; end
@@ -30,101 +30,109 @@ module RuboCop
       #   def c; end
       #   def d; end
       class OrderedMethods < Cop
+        # TODO: Extending Cop is deprecated. Should extend Cop::Base.
         include IgnoredMethods
         include RangeHelp
 
-        MSG = 'Methods should be sorted alphabetically.'.freeze
-        VISIBILITY_MODIFIERS = %i[
-          module_function
-          private
-          protected
-          public
-        ].freeze
-
-        def_node_matcher :class_def?, 'defs'
-        def_node_matcher :instance_def?, 'def'
-        def_node_matcher :visibility_modifier?, <<-PATTERN
-          (send nil? { #{VISIBILITY_MODIFIERS.map(&:inspect).join(' ')} })
-        PATTERN
+        COMPARISONS = {
+          'alphabetical' => lambda do |left_method, right_method|
+            (left_method.method_name <=> right_method.method_name) != 1
+          end
+        }.freeze
+        ERR_INVALID_COMPARISON = 'Invalid "Comparison" config for ' \
+          "#{cop_name}. Expected one of: #{COMPARISONS.keys.join(', ')}".freeze
 
         def autocorrect(node)
-          OrderedMethodsCorrector.correct(
-            processed_source,
-            node,
-            @previous_node
-          )
+          @corrector.correct(node, @previous_node)
         end
 
         def on_begin(node)
-          consecutive_methods(node.children) do |previous, current|
+          cache(node)
+          consecutive_methods(@siblings) do |previous, current|
             unless ordered?(previous, current)
               @previous_node = previous
-              add_offense(current)
+              add_offense(
+                current,
+                message: 'Methods should be sorted in ' \
+                  "#{cop_config['EnforcedStyle']} order."
+              )
             end
           end
         end
 
         private
 
-        def consecutive_methods(ast)
-          filtered_and_grouped(ast).each do |method_group|
+        def access_modified?(node, is_class_method_block)
+          (node.defs_type? && !is_class_method_block) ||
+            (node.def_type? && is_class_method_block) ||
+            (node.send_type? && node.bare_access_modifier?)
+        end
+
+        # Cache to avoid traversing the AST multiple times
+        def cache(node)
+          @cache ||= begin
+            @siblings = node.children
+
+            # Init the corrector with the cache to avoid traversing the AST in
+            # the corrector. We always init the @corrector, even if
+            # @options[:auto_correct] is nil, because `add_offense` always
+            # attempts correction. This correction attempt is how RuboCop knows
+            # if the offense can be labeled "[Correctable]".
+            comments = processed_source.ast_with_comments
+            @corrector = OrderedMethodsCorrector.new(comments, @siblings)
+          end
+        end
+
+        # We disable `Style/ExplicitBlockArgument` for performance. See
+        # https://github.com/shanecav84/rubocop-ordered_methods/pull/5#pullrequestreview-562957146
+        # rubocop:disable Style/ExplicitBlockArgument
+        def consecutive_methods(nodes)
+          filtered = filter_relevant_nodes(nodes)
+          filtered_and_grouped = group_methods_by_access_modifier(filtered)
+          filtered_and_grouped.each do |method_group|
             method_group.each_cons(2) do |left_method, right_method|
               yield left_method, right_method
             end
           end
         end
+        # rubocop:enable Style/ExplicitBlockArgument
 
         def filter_relevant_nodes(nodes)
           nodes.select do |node|
             (
-              class_def?(node) ||
-                instance_def?(node) ||
-                visibility_modifier?(node)
-            ) && !ignored_method?(node.method_name)
+              (node.defs_type? || node.def_type?) &&
+                !ignored_method?(node.method_name)
+            ) || (node.send_type? && node.bare_access_modifier?)
           end
         end
 
-        def filtered_and_grouped(ast)
-          group_methods_by_visiblity_block(filter_relevant_nodes(ast))
-        end
-
-        # Group methods by the visiblity block they are declared in. Multiple
-        # blocks of the same visiblity will have their methods grouped
+        # Group methods by the access modifier block they are declared in.
+        # Multiple blocks of the same modifier will have their methods grouped
         # separately; for example, the following would be separated into two
         # groups:
         #   private
         #   def a; end
         #   private
         #   def b; end
-        # rubocop:disable Metrics/MethodLength
-        def group_methods_by_visiblity_block(nodes)
+        def group_methods_by_access_modifier(nodes)
           is_class_method_block = false
+
           nodes.each_with_object([[]]) do |node, grouped_methods|
-            if new_visiblity_block?(node, is_class_method_block)
+            if access_modified?(node, is_class_method_block)
               grouped_methods << []
             end
-
-            is_class_method_block = true if class_def?(node)
-            is_class_method_block = false if instance_def?(node)
-
-            if visibility_modifier?(node)
-              is_class_method_block = false
-              next
-            end
+            is_class_method_block = node.defs_type?
+            next if node.send_type? && node.bare_access_modifier?
 
             grouped_methods.last << node
           end
         end
-        # rubocop:enable Metrics/MethodLength
-
-        def new_visiblity_block?(node, is_class_method_block)
-          (class_def?(node) && !is_class_method_block) ||
-            (instance_def?(node) && is_class_method_block) ||
-            visibility_modifier?(node)
-        end
 
         def ordered?(left_method, right_method)
-          (left_method.method_name <=> right_method.method_name) != 1
+          comparison = COMPARISONS[cop_config['EnforcedStyle']]
+          raise Error, ERR_INVALID_COMPARISON if comparison.nil?
+
+          comparison.call(left_method, right_method)
         end
       end
     end

data/lib/rubocop/cop/qualifier_node_matchers.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # defines matchers for qualifier nodes
+    module QualifierNodeMatchers
+      extend NodePattern::Macros
+
+      QUALIFIERS = %i[
+        alias_method
+        module_function
+        private_class_method
+        public_class_method
+        private
+        protected
+        public
+      ].freeze
+
+      def_node_matcher :alias?, '(:alias ... (sym $_method_name))'
+      def_node_matcher :alias_method?,
+                       '(send nil? {:alias_method} ... (sym $_method_name))'
+      def_node_matcher :qualifier?, <<-PATTERN
+          (send nil? {#{QUALIFIERS.map(&:inspect).join(' ')}}
+            ... (sym $_method_name))
+      PATTERN
+    end
+  end
+end

data/lib/rubocop/ordered_methods.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module RuboCop
+  # Our namespace
   module OrderedMethods
     PROJECT_ROOT = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
 
     def self.inject_defaults!
       path = CONFIG_DEFAULT.to_s

data/rubocop-ordered_methods.gemspec

@@ -1,31 +1,34 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = 'rubocop-ordered_methods'
-  spec.version       = '0.3'
-  spec.authors       = ['Shane Cavanaugh']
-  spec.email         = ['shane@shanecav.net']
+  spec.name = 'rubocop-ordered_methods'
+  spec.version = '0.8'
+  spec.authors = ['Shane Cavanaugh']
+  spec.email = ['shane@shanecav.net']
 
-  spec.summary       = 'Checks that methods are ordered alphabetically.'
-  spec.homepage      = 'https://github.com/shanecav84/rubocop-ordered_methods'
-  spec.license       = 'MIT'
+  spec.summary = 'Checks that methods are ordered alphabetically.'
+  spec.homepage = 'https://github.com/shanecav84/rubocop-ordered_methods'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.4'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added
   # into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
       f.match(%r{^(test|spec|features)/})
     end
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rubocop', '~> 0.6'
+  spec.add_runtime_dependency 'rubocop', '>= 1.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ordered_methods
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.8'
 platform: ruby
 authors:
 - Shane Cavanaugh
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-02-17 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - shane@shanecav.net
 executables: []
@@ -74,9 +74,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rakeTasks"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -85,15 +87,17 @@ files:
 - bin/console
 - config/default.yml
 - lib/rubocop-ordered_methods.rb
+- lib/rubocop/cop/alias_method_order_verifier.rb
 - lib/rubocop/cop/correctors/ordered_methods_corrector.rb
 - lib/rubocop/cop/layout/ordered_methods.rb
+- lib/rubocop/cop/qualifier_node_matchers.rb
 - lib/rubocop/ordered_methods.rb
 - rubocop-ordered_methods.gemspec
 homepage: https://github.com/shanecav84/rubocop-ordered_methods
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,15 +105,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Checks that methods are ordered alphabetically.
 test_files: []