rubocop-ordered_methods 0.9 → 0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f2d2e3b61a0a11602f8fe67a27acf70a93494ca9cab1356f69b8acd88021f1f
-  data.tar.gz: bbf8c175b74c26ea08440b0283fab7a97437475757cb9ff0275e1d241777dc75
+  metadata.gz: 8136e162c37c297ad3e2eee09364841551f447b6854ada050b165d0286fda95d
+  data.tar.gz: 595fd69b9114f9122920cf5c8f15a1cb6a43b22f4c31ab9665a11bf2411ff91d
 SHA512:
-  metadata.gz: 8bdb062792695cb201c3fc2311f2ab4f990e0bbc809d1c5930ced67b456661335db31268d283a7e009ede8f872ba41fc601293dd2fb14fab59b3430f80b01bbb
-  data.tar.gz: 50c1683cd8866ef961612a48be343896da74a5a03c269802fc1ac1e1aae2cee91d360be7bd553d694b72ce8cce9eba32fd8f126afb30e4d4d421820abc8e9794
+  metadata.gz: ab8b3c4ae74ac44dc4ee43af04cdb3854f8df847113e499dc2d429843c4276a34084316edc3c0aca41fd4174fdd6c3a508a642ec8dbc19302e6c015bc65ee16e
+  data.tar.gz: 96347af9d20819c73c485e5a985702097ab5507ec86774ab144bf8f9fa54363461dc0a53f993429a6321e0e8fea6d0b4bcf244c9159b17a03fcf7f503b41ec75

data/.github/workflows/main.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+
+    name: "Ruby ${{ matrix.ruby }}: run rspec"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "${{ matrix.ruby }}"
+          bundler-cache: true
+      - run:  bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+
+    name: "Ruby ${{ matrix.ruby }}: run rubocop"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "${{ matrix.ruby }}"
+          bundler-cache: true
+      - run:  bundle exec rubocop

data/.rubocop.yml

@@ -5,7 +5,7 @@ require: rubocop-ordered_methods
 AllCops:
   NewCops: enable
   SuggestExtensions: false
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
 
 # Subtle, left to author's discretion. In a long method with many guard clauses,
 # a blank line may help. But, in a short method, especially with only a single
@@ -13,6 +13,9 @@ AllCops:
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
+Layout/LineEndStringConcatenationIndentation:
+  EnforcedStyle: indented
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*

data/CHANGELOG.md

@@ -6,6 +6,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+
+- Drop support for Ruby 2.4, 2.5, and 2.6
+
+### Added
+
+- Support for custom method qualifiers ([#11](https://github.com/shanecav84/rubocop-ordered_methods/pull/11)). Thanks @Darhazer.
+- Setup CI ([#12](https://github.com/shanecav84/rubocop-ordered_methods/pull/12)). Thanks @Darhazer.
+
 ## [0.9] - 2021-03-10
 
 ### Added

data/Gemfile

@@ -2,4 +2,9 @@
 
 source 'https://rubygems.org'
 
+gem 'bundler'
+gem 'byebug'
+gem 'rake', '~> 12.3.3'
+gem 'rspec', '~> 3.0'
+
 gemspec

data/README.md

@@ -76,6 +76,7 @@ Name | Default value | Configurable values
 --- | --- | ---
 EnforcedStyle | `'alphabetical'` | `'alphabetical'`
 IgnoredMethods | `['initialize']` | Array
+MethodQualifiers | `[]` | Array
 Signature | `nil` | `'sorbet'`, `nil`
 
 #### Example
@@ -84,7 +85,10 @@ Signature | `nil` | `'sorbet'`, `nil`
 # .rubocop.yml
 Layout/OrderedMethods:
   EnforcedStyle: alphabetical
-  IgnoredMethods: initialize
+  IgnoredMethods:
+    - initialize
+  MethodQualifiers:
+    - memoize
   Signature: sorbet
 ```
 
@@ -136,6 +140,16 @@ protected :instance_a
 public :instance_a
 ```
 
+#### Method qualifiers
+Some gems (like `memery`, `memoist`, etc.) provide a DSL that modifies the method (e.g. for memoization).
+Those DSL methods can be added to the `MethodQualifiers` configuration, and they will be respected.
+
+E.g. the following source can be correctly ordered:
+```ruby
+def b; end;
+memoize def a;end
+```
+
 #### Method signatures
 
 Support for (Sorbet) method signatures was added to the corrector by

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

@@ -35,26 +35,34 @@ module RuboCop
         include RangeHelp
 
         COMPARISONS = {
-          'alphabetical' => lambda do |left_method, right_method|
-            (left_method.method_name <=> right_method.method_name) != 1
+          'alphabetical' => lambda do |left_node, right_node|
+            (method_name(left_node) <=> method_name(right_node)) != 1
           end
         }.freeze
         ERR_INVALID_COMPARISON = 'Invalid "Comparison" config for ' \
           "#{cop_name}. Expected one of: #{COMPARISONS.keys.join(', ')}".freeze
 
+        def self.method_name(node)
+          return node.method_name unless node.send_type?
+
+          node.first_argument.method_name
+        end
+
         def autocorrect(node)
-          @corrector.correct(node, @previous_node)
+          _siblings, corrector = cache(node)
+          corrector.correct(node, @previous_node)
         end
 
         def on_begin(node)
-          cache(node)
-          consecutive_methods(@siblings) do |previous, current|
+          start_node = node.children.find(&:class_type?)&.children&.last || node
+          siblings, _corrector = cache(start_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."
+                message: "Methods should be sorted in #{cop_config['EnforcedStyle']} order."
               )
             end
           end
@@ -68,25 +76,33 @@ 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 ||= 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)
+          @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
@@ -103,11 +119,9 @@ module RuboCop
         # rubocop:enable Style/ExplicitBlockArgument
 
         def filter_relevant_nodes(nodes)
-          nodes.select do |node|
-            (
-              (node.defs_type? || node.def_type?) &&
-                !ignored_method?(node.method_name)
-            ) || (node.send_type? && node.bare_access_modifier?)
+          nodes.compact.select do |node|
+            next unless node.is_a?(Parser::AST::Node)
+            relevant_node?(node) || (node.send_type? && qualifier_macro?(node))
           end
         end
 
@@ -139,6 +153,17 @@ module RuboCop
 
           comparison.call(left_method, right_method)
         end
+
+        def qualifier_macro?(node)
+          return true if node.bare_access_modifier?
+
+          cop_config['MethodQualifiers'].to_a.include?(node.method_name.to_s) &&
+            relevant_node?(node.first_argument)
+        end
+
+        def relevant_node?(node)
+          (node.defs_type? || node.def_type?) && !ignored_method?(node.method_name)
+        end
       end
     end
   end

data/lib/rubocop/cop/qualifier_node_matchers.rb

@@ -20,9 +20,16 @@ module RuboCop
       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))
+          (send nil? #method_qualifier? ... (sym $_method_name))
       PATTERN
+
+      def method_qualifier?(name)
+        qualifiers.include?(name)
+      end
+
+      def qualifiers
+        @qualifiers ||= QUALIFIERS + @cop_config['MethodQualifiers'].to_a.map(&:to_sym)
+      end
     end
   end
 end

data/rubocop-ordered_methods.gemspec

@@ -5,14 +5,14 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name = 'rubocop-ordered_methods'
-  spec.version = '0.9'
+  spec.version = '0.11'
   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.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.7'
 
   # 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
@@ -28,8 +28,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'rubocop', '>= 1.0'
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'rake', '~> 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.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.9'
+  version: '0.11'
 platform: ruby
 authors:
 - Shane Cavanaugh
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2023-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,69 +24,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-description: 
+description:
 email:
 - shane@shanecav.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rakeTasks"
 - ".rubocop.yml"
@@ -110,8 +55,9 @@ files:
 homepage: https://github.com/shanecav84/rubocop-ordered_methods
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,15 +65,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Checks that methods are ordered alphabetically.
 test_files: []