rubocop-ordered_methods 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ade6d192050ac40f268177e3ede23b40f57d569041c6191baa855bfcef87a2c2
-  data.tar.gz: b39ded0724baf7c35b2d48506bebbe0924a04be6fe0c300a75090bf7e9deb7af
+  metadata.gz: efe0a069919334996c9317cf8d9dd03bb19fe984a9d8d7a294f017dcb361ec96
+  data.tar.gz: b8c6b15fbfa6d2b44c99b051ebfb4a2ba047c2958f16cf9015b4f2d87f674fe5
 SHA512:
-  metadata.gz: 79368459e3709585a1741e6d5374b5e9d5176562f494a344ceed58208c512bf8c9f324ef8200bd9de9645b95a2d6a05d4bc584af97329997328bad44db2426ff
-  data.tar.gz: 1c3dcbf99709710ad10fec4e0085f1fd8caf9094082d27cb8a8b77fc6e081d0942bbfd41953b2bd715d184d3430a92ee463665913c51fcfcdac483c141a69f89
+  metadata.gz: cca41398955b51c5d968fc84b4ec0833339224c696de865d6421834491da2113b12d7e4bfce8fe1771b53f18a0ae872e350ffff96fccce4610b71eca38b3583d
+  data.tar.gz: 57f61650ad8df63193aa45f9fa35133c85698a134d9a6ee3bfa305b9de074763cc45d7fc26a64da216ba79f86d5b19e5fec84084ee989f266e82dc56251f00fd

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 require: rubocop-ordered_methods
 
 Metrics/BlockLength:

data/.rubocop_todo.yml

@@ -0,0 +1,21 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-02-17 13:54:25 -0500 using RuboCop version 0.64.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
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 101
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 11

data/README.md

@@ -1,6 +1,7 @@
 # RuboCop OrderedMethods
 
-Check that methods are defined alphabetically.
+Check that methods are defined alphabetically. Note [caveats](#caveats) for
+autocorrector.
 
 ```ruby
 # bad
@@ -72,6 +73,16 @@ Name | Default value | Configurable values
 --- | --- | ---
 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`.
+
+#### Caveats
+The corrector can fail to include surrounding comments and qualifiers for some
+methods.
+
 ## Development
 
 ### Setup

data/lib/rubocop-ordered_methods.rb

@@ -1,2 +1,3 @@
 require 'rubocop'
 require_relative 'rubocop/cop/layout/ordered_methods'
+require_relative 'rubocop/cop/correctors/ordered_methods_corrector'

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require_relative '../layout/ordered_methods'
+
+module RuboCop
+  module Cop
+    # This auto-corrects method order
+    class OrderedMethodsCorrector
+      class << self
+        include IgnoredNode
+        extend NodePattern::Macros
+
+        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
+
+          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
+        end
+
+        private
+
+        def found_qualifier?(node, next_sibling)
+          (qualifier?(next_sibling) || alias?(next_sibling)) == node.method_name
+        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?
+
+          current_node_aliases.any? do |cna|
+            previous_node.sibling_index > cna.sibling_index
+          end
+        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
+
+        def with_comments(node)
+          node.source_range
+              .join(with_preceding_comments(node))
+              .join(with_succeeding_comments(node))
+        end
+
+        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
+
+        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
+        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
+        end
+
+        def with_surroundings(node)
+          node.source_range
+              .join(with_comments(node))
+              .join(with_modifiers_and_aliases(node))
+        end
+      end
+    end
+  end
+end

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

@@ -47,9 +47,20 @@ module RuboCop
           (send nil? { #{VISIBILITY_MODIFIERS.map(&:inspect).join(' ')} })
         PATTERN
 
+        def autocorrect(node)
+          OrderedMethodsCorrector.correct(
+            processed_source,
+            node,
+            @previous_node
+          )
+        end
+
         def on_begin(node)
           consecutive_methods(node.children) do |previous, current|
-            add_offense(current) unless ordered?(previous, current)
+            unless ordered?(previous, current)
+              @previous_node = previous
+              add_offense(current)
+            end
           end
         end
 

data/rubocop-ordered_methods.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ordered_methods
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Shane Cavanaugh
@@ -75,15 +75,16 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - lib/rubocop-ordered_methods.rb
+- lib/rubocop/cop/correctors/ordered_methods_corrector.rb
 - lib/rubocop/cop/layout/ordered_methods.rb
 - rubocop-ordered_methods.gemspec
 homepage: https://github.com/shanecav84/rubocop-ordered_methods