rubocop-ordered_methods 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 711dd4dc7c13df5dc95040f2824dc88868fc3ebc5996088630d0a13638853308
-  data.tar.gz: 4b9e74bb42389db5ac593b9194e5e6138b9d01f174c1d165fc4949e33d6da4b2
+  metadata.gz: 5666abbd94c131384aa150fd5d1065c26a17c937b924b0bac4bc7142055a4528
+  data.tar.gz: dc127d1fe270e7c41037218ccfd7cba20297dee56fc59b1998188530ce3ef564
 SHA512:
-  metadata.gz: 3b427b3dec7ba7f85f291da04d988f0bad8981b4db54ebf769fbf29de2e170abc200a0daf1297ebd92e6dcc5d4a3eb6fb8a058f7d72eae8ba06a412434886b5f
-  data.tar.gz: 03fe372de5334f2b6c25c1a0b78a8047d7cecd8f010eb441ea2d649b39f58228574b65f4eb64a14611072473329c7f1a4cc6a4c21ef62d59da3d2187950f797f
+  metadata.gz: 3cfbc383385af0d961764fa99886da093636f26a17271541fae6aa050a1dfc65518fe4a0c9a1ec0c069e86cad3838d2394e22ae2630a2b547e4bd8bb0f823e81
+  data.tar.gz: 56e6d697ee553d9a362b12f009154b0df809dbc67b1a4232082dfe1a03e1401591231cbbffea68d5e1515886151827c54eb47476c9c542e28b6692bf777a0a73

data/.rubocop.yml

@@ -2,6 +2,9 @@ inherit_from: .rubocop_todo.yml
 
 require: rubocop-ordered_methods
 
+AllCops:
+  TargetRubyVersion: 2.3
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*

data/.travis.yml

@@ -3,7 +3,6 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.2
   - 2.3
   - 2.4
   - 2.5

data/CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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

data/README.md

@@ -3,33 +3,33 @@
 
 # RuboCop OrderedMethods
 
-Check that methods are defined alphabetically. Note [caveats](#caveats) for
-autocorrection.
+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

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,120 +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
-          module_function
-          private_class_method
-          public_class_method
-          private
-          protected
-          public
-        ].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 = join_surroundings(@current_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
+      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
+      private
 
-        def found_qualifier?(node, next_sibling)
-          return false if next_sibling.nil?
+      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])
 
-          (qualifier?(next_sibling) || alias?(next_sibling)) == node.method_name
+          last_qualifier_index -= 1
         end
 
-        def join_comments(node, source_range)
-          @processed_source.ast_with_comments[node].each do |comment|
-            source_range = source_range.join(comment.loc.expression)
-          end
-          source_range
-        end
+        last_qualifier_index
+      end
 
-        def join_modifiers_and_aliases(node, source_range)
-          siblings = node.parent.children
-          preceding_qualifier_index = node.sibling_index
-          while found_qualifier?(node, siblings[preceding_qualifier_index + 1])
-            source_range = source_range.join(
-              siblings[preceding_qualifier_index + 1].source_range
-            )
-            preceding_qualifier_index += 1
-          end
-          source_range
-        end
+      def found_qualifier?(node, next_sibling)
+        return false if next_sibling.nil?
 
-        def join_surroundings(node)
-          with_modifiers_and_aliases = join_modifiers_and_aliases(
-            node,
-            node.source_range
-          )
-          join_comments(node, with_modifiers_and_aliases)
-        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 = 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?
+        (qualifier?(next_sibling) || alias?(next_sibling)) == node.method_name
+      end
 
-          current_node_aliases.any? do |cna|
-            previous_node.sibling_index > cna.sibling_index
-          end
+      def join_comments(node, source_range)
+        @comments[node].each do |comment|
+          source_range = source_range.join(comment.loc.expression)
         end
+        source_range
+      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
+      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
-        # rubocop:enable Metrics/MethodLength, Style/GuardClause
+        source_range
+      end
+
+      def join_surroundings(node)
+        with_modifiers_and_aliases = join_modifiers_and_aliases(
+          node,
+          node.source_range
+        )
+        join_comments(node, with_modifiers_and_aliases)
       end
     end
   end

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

@@ -42,15 +42,12 @@ module RuboCop
           "#{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(
@@ -70,6 +67,20 @@ module RuboCop
             (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
+            if @options[:auto_correct]
+              comments = processed_source.ast_with_comments
+              @corrector = OrderedMethodsCorrector.new(comments, @siblings)
+            end
+          end
+        end
+
         def consecutive_methods(nodes)
           filtered = filter_relevant_nodes(nodes)
           filtered_and_grouped = group_methods_by_access_modifier(filtered)

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/rubocop-ordered_methods.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name = 'rubocop-ordered_methods'
-  spec.version = '0.4'
+  spec.version = '0.5'
   spec.authors = ['Shane Cavanaugh']
   spec.email = ['shane@shanecav.net']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ordered_methods
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Shane Cavanaugh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-11 00:00:00.000000000 Z
+date: 2019-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -86,8 +86,10 @@ 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