rubocop-ordered_methods 0.8 → 0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc5f933eab16f22d4ce9e90bac7b7da25af7af45f7fd1204974ea26d98287476
-  data.tar.gz: c3e5a535a8667acf2c88e8c127219b8b8e330d10e6575df5748391ec1c7758ba
+  metadata.gz: c43226dde578a4844ba7c579a7fa5dfb52f05dce2e84d9a68f1e250e272d4e58
+  data.tar.gz: 636542d7c4be5982d3424703ba2062c72c4fdbfcf4f289a5b593050b68c16969
 SHA512:
-  metadata.gz: c83ba399a7357517935466f59e4be28b75fbb399a571041b54ba4be1c387797b1867be69fcac2abe8e60e89572b34d35d9a327a171880cec2d9807ee258766ca
-  data.tar.gz: dc2897b646af1eb6e2b84dbe2e693be8a0a48de8645caf9551557c6dfe36809a34c92c4166428f9f0b17bd541c3a5c8bf60d349ea3db3286c09ebb4897467e7e
+  metadata.gz: 1eced8a7bb0e4a33bf58cae6b0b0d90fd9814318635689450ee34646905a5a41fbd97189c51d9763706f307d4ed4c3032e3eb02af2aa5ce79c373f12bd5f1019
+  data.tar.gz: 4c528b7368611c20b2ab790f28502f3c44e4e6546bcbff35b199c749932583bdea36cc5d441e598efb7b7e199b63fbac97f50a6534b206052f60474ebe24147a

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,16 @@ 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
+# guard clause, a blank line can be disruptive.
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/LineEndStringConcatenationIndentation:
+  EnforcedStyle: indented
 
 Metrics/BlockLength:
   Exclude:
@@ -18,3 +27,9 @@ Metrics/MethodLength:
 Naming/FileName:
   Exclude:
     - lib/rubocop-ordered_methods.rb
+
+# Use the semantic style. If a block has side effects use `do`, and if it is
+# pure use `{}`. This style is too nuanced for a linter, so the cop is
+# disabled.
+Style/BlockDelimiters:
+  Enabled: false

data/.travis.yml

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

data/CHANGELOG.md

@@ -6,6 +6,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+
+- Autocorrection support for Sorbet signatures
+
 ## [0.8] - 2021-02-01
 
 ### Fixed

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

@@ -74,8 +74,23 @@ rubocop --require rubocop-ordered_methods
 
 Name | Default value | Configurable values
 --- | --- | ---
-EnforcedStyle | `alphabetical` | `alphabetical`
-IgnoredMethods | `initialize` | Array
+EnforcedStyle | `'alphabetical'` | `'alphabetical'`
+IgnoredMethods | `['initialize']` | Array
+MethodQualifiers | `[]` | Array
+Signature | `nil` | `'sorbet'`, `nil`
+
+#### Example
+
+```
+# .rubocop.yml
+Layout/OrderedMethods:
+  EnforcedStyle: alphabetical
+  IgnoredMethods:
+    - initialize
+  MethodQualifiers:
+    - memoize
+  Signature: sorbet
+```
 
 ### Corrector
 
@@ -125,6 +140,23 @@ 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
+[#7](https://github.com/shanecav84/rubocop-ordered_methods/pull/7).
+It is off by default due to performance concerns (not yet benchmarked). Enable
+with `Signature: sorbet`.
+
 #### Caveats
 
 * The corrector will warn and refuse to order a method if it were to be

data/config/default.yml

@@ -4,3 +4,4 @@ Layout/OrderedMethods:
   EnforcedStyle: 'alphabetical'
   IgnoredMethods:
     - initialize
+  Signature: ~

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

@@ -10,9 +10,11 @@ module RuboCop
     class OrderedMethodsCorrector
       include QualifierNodeMatchers
 
-      def initialize(comments, siblings)
-        @comments = comments
+      # @param cop_config ::RuboCop::Config
+      def initialize(comment_locations, siblings, cop_config)
+        @comment_locations = comment_locations
         @siblings = siblings
+        @cop_config = cop_config
       end
 
       def correct(node, previous_node)
@@ -45,13 +47,19 @@ module RuboCop
         (qualifier?(next_sibling) || alias?(next_sibling)) == node.method_name
       end
 
+      # @param node RuboCop::AST::DefNode
+      # @param source_range Parser::Source::Range
+      # @return Parser::Source::Range
       def join_comments(node, source_range)
-        @comments[node].each do |comment|
+        @comment_locations[node.loc].each do |comment|
           source_range = source_range.join(comment.loc.expression)
         end
         source_range
       end
 
+      # @param node RuboCop::AST::DefNode
+      # @param source_range Parser::Source::Range
+      # @return Parser::Source::Range
       def join_modifiers_and_aliases(node, source_range)
         preceding_qualifier_index = node.sibling_index
         last_qualifier_index = find_last_qualifier_index(node)
@@ -64,12 +72,46 @@ module RuboCop
         source_range
       end
 
+      # @param node RuboCop::AST::DefNode
+      # @param source_range Parser::Source::Range
+      # @return Parser::Source::Range
+      def join_signature(node, source_range)
+        sib = node.left_sibling
+        if signature?(sib)
+          # If there is a comment directly above the sig, first calculate the
+          # range that covers both.
+          with_comment = join_comments(sib, sib.source_range)
+          source_range.join(with_comment)
+        else
+          source_range
+        end
+      end
+
+      def join_signature?
+        @cop_config['Signature'] == 'sorbet'
+      end
+
+      # @param node RuboCop::AST::DefNode
+      # @return Parser::Source::Range
       def join_surroundings(node)
         with_modifiers_and_aliases = join_modifiers_and_aliases(
           node,
           node.source_range
         )
-        join_comments(node, with_modifiers_and_aliases)
+        with_comments = join_comments(node, with_modifiers_and_aliases)
+        if join_signature?
+          join_signature(node, with_comments)
+        else
+          with_comments
+        end
+      end
+
+      # https://sorbet.org/docs/sigs
+      # @param node RuboCop::AST::Node
+      def signature?(node)
+        return false unless node&.type == :block
+        child = node.children.first
+        child&.type == :send && child.method_name == :sig
       end
     end
   end

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

@@ -35,20 +35,27 @@ 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|
+          siblings, _corrector = cache(node)
+          consecutive_methods(siblings) do |previous, current|
             unless ordered?(previous, current)
               @previous_node = previous
               add_offense(
@@ -68,20 +75,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]".
-            comments = processed_source.ast_with_comments
-            @corrector = OrderedMethodsCorrector.new(comments, @siblings)
+          @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
@@ -99,10 +119,7 @@ module RuboCop
 
         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?)
+            relevant_node?(node) || (node.send_type? && qualifier_macro?(node))
           end
         end
 
@@ -134,6 +151,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.8'
+  spec.version = '0.10'
   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,7 +28,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'rubocop', '>= 1.0'
 
-  spec.add_development_dependency 'bundler'
-  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.8'
+  version: '0.10'
 platform: ruby
 authors:
 - Shane Cavanaugh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2023-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,48 +24,6 @@ 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: 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:
 email:
 - shane@shanecav.net
@@ -73,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rakeTasks"
 - ".rubocop.yml"
@@ -96,7 +55,8 @@ files:
 homepage: https://github.com/shanecav84/rubocop-ordered_methods
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -105,14 +65,14 @@ 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.2
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Checks that methods are ordered alphabetically.