rubocop-ordered_methods 0.8 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc5f933eab16f22d4ce9e90bac7b7da25af7af45f7fd1204974ea26d98287476
-  data.tar.gz: c3e5a535a8667acf2c88e8c127219b8b8e330d10e6575df5748391ec1c7758ba
+  metadata.gz: 2f2d2e3b61a0a11602f8fe67a27acf70a93494ca9cab1356f69b8acd88021f1f
+  data.tar.gz: bbf8c175b74c26ea08440b0283fab7a97437475757cb9ff0275e1d241777dc75
 SHA512:
-  metadata.gz: c83ba399a7357517935466f59e4be28b75fbb399a571041b54ba4be1c387797b1867be69fcac2abe8e60e89572b34d35d9a327a171880cec2d9807ee258766ca
-  data.tar.gz: dc2897b646af1eb6e2b84dbe2e693be8a0a48de8645caf9551557c6dfe36809a34c92c4166428f9f0b17bd541c3a5c8bf60d349ea3db3286c09ebb4897467e7e
+  metadata.gz: 8bdb062792695cb201c3fc2311f2ab4f990e0bbc809d1c5930ced67b456661335db31268d283a7e009ede8f872ba41fc601293dd2fb14fab59b3430f80b01bbb
+  data.tar.gz: 50c1683cd8866ef961612a48be343896da74a5a03c269802fc1ac1e1aae2cee91d360be7bd553d694b72ce8cce9eba32fd8f126afb30e4d4d421820abc8e9794

data/.rubocop.yml

@@ -7,6 +7,12 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 2.4
 
+# 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
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
@@ -18,3 +24,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,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.9] - 2021-03-10
+
+### Added
+
+- Autocorrection support for Sorbet signatures
+
 ## [0.8] - 2021-02-01
 
 ### Fixed

data/README.md

@@ -74,8 +74,19 @@ rubocop --require rubocop-ordered_methods
 
 Name | Default value | Configurable values
 --- | --- | ---
-EnforcedStyle | `alphabetical` | `alphabetical`
-IgnoredMethods | `initialize` | Array
+EnforcedStyle | `'alphabetical'` | `'alphabetical'`
+IgnoredMethods | `['initialize']` | Array
+Signature | `nil` | `'sorbet'`, `nil`
+
+#### Example
+
+```
+# .rubocop.yml
+Layout/OrderedMethods:
+  EnforcedStyle: alphabetical
+  IgnoredMethods: initialize
+  Signature: sorbet
+```
 
 ### Corrector
 
@@ -125,6 +136,13 @@ protected :instance_a
 public :instance_a
 ```
 
+#### 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

@@ -74,12 +74,17 @@ module RuboCop
             @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)
+            # 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)
           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.8'
+  spec.version = '0.9'
   spec.authors = ['Shane Cavanaugh']
   spec.email = ['shane@shanecav.net']
 
@@ -29,6 +29,7 @@ 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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ordered_methods
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '0.9'
 platform: ruby
 authors:
 - Shane Cavanaugh
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !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
@@ -66,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description:
+description: 
 email:
 - shane@shanecav.net
 executables: []
@@ -97,7 +111,7 @@ homepage: https://github.com/shanecav84/rubocop-ordered_methods
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -112,8 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Checks that methods are ordered alphabetically.
 test_files: []