rubocop-ordered_methods 0.10 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c43226dde578a4844ba7c579a7fa5dfb52f05dce2e84d9a68f1e250e272d4e58
-  data.tar.gz: 636542d7c4be5982d3424703ba2062c72c4fdbfcf4f289a5b593050b68c16969
+  metadata.gz: a73cfd25f43f431101b9822358b1c59180d41a56f170bf614d7ec0149f4f2c3e
+  data.tar.gz: 3c470834560d76327fc38f4163284ab4131214d8b944f0ffe34ede2e4164caab
 SHA512:
-  metadata.gz: 1eced8a7bb0e4a33bf58cae6b0b0d90fd9814318635689450ee34646905a5a41fbd97189c51d9763706f307d4ed4c3032e3eb02af2aa5ce79c373f12bd5f1019
-  data.tar.gz: 4c528b7368611c20b2ab790f28502f3c44e4e6546bcbff35b199c749932583bdea36cc5d441e598efb7b7e199b63fbac97f50a6534b206052f60474ebe24147a
+  metadata.gz: a2600cc2de26566766baf34796941c5056340e3bd9ccc1e9eb30ee73b6d57aa315a2f290e641c2128e9089956415fc0f79d0a0b8dd300df02af5a73b238037e9
+  data.tar.gz: f7c14e935cbfae83760f4724292db502f9bed264e3c77c1d99c51d5d3ca4e6c948b46fedc8dbbbd32906d721dcaf310597160b2bc148b4bee06725f1c59119d3

data/CHANGELOG.md

@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.12] - 2024-07-16
+
+### Fixed
+
+- Add MethodQualifiers to the default config [#13](https://github.com/shanecav84/rubocop-ordered_methods/pull/13). Thanks, @Darhazer.
+- Fix rubocop 1.65 compatability [#16](https://github.com/shanecav84/rubocop-ordered_methods/pull/16). Thanks, @Darhazer.
+
+## [0.11] - 2023-12-19
+
+### Fixed
+
+- Fix handling require at the top of the file, nil nodes, and nodes that aren't of type AST::node ([#15](https://github.com/shanecav84/rubocop-ordered_methods/pull/15)). Thanks @rohitpaulk and @libmartinito
+
 ## [0.10] - 2021-03-10
 
 ### Removed

data/config/default.yml

@@ -4,4 +4,5 @@ Layout/OrderedMethods:
   EnforcedStyle: 'alphabetical'
   IgnoredMethods:
     - initialize
+  MethodQualifiers: []
   Signature: ~

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

@@ -17,14 +17,11 @@ module RuboCop
         @cop_config = cop_config
       end
 
-      def correct(node, previous_node)
+      def correct(node, previous_node, corrector)
         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
+        corrector.swap(current_range, previous_range)
       end
 
       private
@@ -51,7 +48,7 @@ module RuboCop
       # @param source_range Parser::Source::Range
       # @return Parser::Source::Range
       def join_comments(node, source_range)
-        @comment_locations[node.loc].each do |comment|
+        @comment_locations[node].each do |comment|
           source_range = source_range.join(comment.loc.expression)
         end
         source_range

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

@@ -29,9 +29,9 @@ module RuboCop
       #
       #   def c; end
       #   def d; end
-      class OrderedMethods < Cop
-        # TODO: Extending Cop is deprecated. Should extend Cop::Base.
-        include IgnoredMethods
+      class OrderedMethods < Base
+        extend AutoCorrector
+        include AllowedMethods
         include RangeHelp
 
         COMPARISONS = {
@@ -48,21 +48,15 @@ module RuboCop
           node.first_argument.method_name
         end
 
-        def autocorrect(node)
-          _siblings, corrector = cache(node)
-          corrector.correct(node, @previous_node)
-        end
-
         def on_begin(node)
-          siblings, _corrector = cache(node)
-          consecutive_methods(siblings) do |previous, current|
-            unless ordered?(previous, current)
-              @previous_node = previous
-              add_offense(
-                current,
-                message: 'Methods should be sorted in ' \
-                  "#{cop_config['EnforcedStyle']} order."
-              )
+          start_node = node.children.find(&:class_type?)&.children&.last || node
+          consecutive_methods(start_node.children) do |previous, current|
+            next if ordered?(previous, current)
+
+            add_offense(current, message: message) do |corrector|
+              OrderedMethodsCorrector.new(
+                processed_source.ast_with_comments, start_node.children, cop_config
+              ).correct(current, previous, corrector)
             end
           end
         end
@@ -75,34 +69,6 @@ module RuboCop
             (node.send_type? && node.bare_access_modifier?)
         end
 
-        # rubocop:disable Metrics/MethodLength
-        # Cache to avoid traversing the AST multiple times
-        def cache(node)
-          @cache ||= Hash.new do |h, key|
-            h[key.hash] = 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]".
-              comment_locations = ::Parser::Source::Comment.associate_locations(
-                processed_source.ast,
-                processed_source.comments
-              )
-              corrector = OrderedMethodsCorrector.new(comment_locations, siblings, cop_config)
-
-              [siblings, corrector]
-            end
-          end
-
-          @cache[node.hash]
-        end
-        # rubocop:enable Metrics/MethodLength
-
         # We disable `Style/ExplicitBlockArgument` for performance. See
         # https://github.com/shanecav84/rubocop-ordered_methods/pull/5#pullrequestreview-562957146
         # rubocop:disable Style/ExplicitBlockArgument
@@ -118,7 +84,8 @@ module RuboCop
         # rubocop:enable Style/ExplicitBlockArgument
 
         def filter_relevant_nodes(nodes)
-          nodes.select do |node|
+          nodes.compact.select do |node|
+            next unless node.is_a?(Parser::AST::Node)
             relevant_node?(node) || (node.send_type? && qualifier_macro?(node))
           end
         end
@@ -145,6 +112,10 @@ module RuboCop
           end
         end
 
+        def message
+          "Methods should be sorted in #{cop_config['EnforcedStyle']} order."
+        end
+
         def ordered?(left_method, right_method)
           comparison = COMPARISONS[cop_config['EnforcedStyle']]
           raise Error, ERR_INVALID_COMPARISON if comparison.nil?
@@ -160,7 +131,7 @@ module RuboCop
         end
 
         def relevant_node?(node)
-          (node.defs_type? || node.def_type?) && !ignored_method?(node.method_name)
+          (node.defs_type? || node.def_type?) && !allowed_method?(node.method_name)
         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.10'
+  spec.version = '0.12'
   spec.authors = ['Shane Cavanaugh']
   spec.email = ['shane@shanecav.net']
 
@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rubocop', '>= 1.0'
+  spec.add_dependency 'rubocop', '>= 1.0'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ordered_methods
 version: !ruby/object:Gem::Version
-  version: '0.10'
+  version: '0.12'
 platform: ruby
 authors:
 - Shane Cavanaugh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-14 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Checks that methods are ordered alphabetically.