rubocop-ordered_methods 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33871b68e39c03de6c12f462dc732d282489b190bdaedca681f955c60a27c20c
-  data.tar.gz: c9c22948ef1db00f774d8fcfdf0cd2f60422da6c44b16a3e9430bdef42c86efb
+  metadata.gz: 711dd4dc7c13df5dc95040f2824dc88868fc3ebc5996088630d0a13638853308
+  data.tar.gz: 4b9e74bb42389db5ac593b9194e5e6138b9d01f174c1d165fc4949e33d6da4b2
 SHA512:
-  metadata.gz: 571d2b28004397aff91256be2d4b153255870d5b7a4bd8877c3956003e3d73959e5bca95fa7b26901ccf43ee343a5b722eae24dea79540948cbe48a3d016d3bb
-  data.tar.gz: 3fe6b38928ed8c4ee6b5c08d27e3ba4e84277f98e7dfa9fe2e74cca570874b4f63caed8ba40ef5e8799d22bd6ae39db4a619beaddde5cc5328d9685e02525809
+  metadata.gz: 3b427b3dec7ba7f85f291da04d988f0bad8981b4db54ebf769fbf29de2e170abc200a0daf1297ebd92e6dcc5d4a3eb6fb8a058f7d72eae8ba06a412434886b5f
+  data.tar.gz: 03fe372de5334f2b6c25c1a0b78a8047d7cecd8f010eb441ea2d649b39f58228574b65f4eb64a14611072473329c7f1a4cc6a4c21ef62d59da3d2187950f797f

data/.rubocop_todo.yml

@@ -1,21 +1,26 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-02-17 13:54:25 -0500 using RuboCop version 0.64.0.
+# on 2019-06-10 10:39:16 -0400 using RuboCop version 0.71.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
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'rubocop-ordered_methods.gemspec'
 
 # Offense count: 1
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 11
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantFreeze:
+  Exclude:
+    - 'lib/rubocop/cop/correctors/ordered_methods_corrector.rb'
+    - 'lib/rubocop/cop/layout/ordered_methods.rb'

data/.travis.yml

@@ -8,4 +8,6 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
-before_install: gem install bundler -v 1.17.2
+script: bundle exec rake
+before_install:
+  - gem install bundler || gem install bundler --version '< 2'

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.4] - 2019-06-11
+
+### Changed
+
+- More robust autocorrection of a method and its surroundings (see `Corrector` in the `README`).
+
+## [0.3] - 2019-02-17
+
+### Added
+
+- Configuration defaults
+
+## [0.2] - 2019-02-17
+
+### Added
+
+- Autocorrector
+
+## [0.1] - 2019-02-17
+
+Initial release.
+
+[Unreleased]: https://github.com/shanecav84/rubocop-ordered_methods/compare/v0.3...HEAD
+[0.3]: https://github.com/shanecav84/rubocop-ordered_methods/compare/v0.2...v0.3
+[0.2]: https://github.com/shanecav84/rubocop-ordered_methods/compare/v0.1...v0.2
+[0.1]: https://github.com/shanecav84/rubocop-ordered_methods/releases/tag/v0.1

data/Gemfile

@@ -1,6 +1,5 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in rubocop-ordered_methods.gemspec
 gemspec

data/README.md

@@ -1,7 +1,10 @@
+[![Gem Version](https://badge.fury.io/rb/rubocop-ordered_methods.svg)](https://badge.fury.io/rb/rubocop-ordered_methods)
+[![Build Status](https://travis-ci.org/shanecav84/rubocop-ordered_methods.svg?branch=master)](https://travis-ci.org/shanecav84/rubocop-ordered_methods)
+
 # RuboCop OrderedMethods
 
 Check that methods are defined alphabetically. Note [caveats](#caveats) for
-autocorrector.
+autocorrection.
 
 ```ruby
 # bad
@@ -47,7 +50,7 @@ Or install it yourself as:
 
 ## Usage
 
-You need to tell RuboCop to load the OrderedMethods extension. There are three
+You need to tell RuboCop to load the OrderedMethods extension. There are two
 ways to do this:
 
 ### RuboCop configuration file
@@ -71,17 +74,70 @@ rubocop --require rubocop-ordered_methods
 
 Name | Default value | Configurable values
 --- | --- | ---
+EnforcedStyle | `alphabetical` | `alphabetical`
 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`.
+The corrector will attempt to order methods based on the `EnforcedStyle`. It attempts to
+include surrounding comments and the qualifiers (e.g., aliases) listed in
+`::RuboCop::Cop::OrderedMethodsCorrector::QUALIFIERS`. The following (monstrous)
+source is able to be correctly ordered:
+
+```ruby
+# Long
+# Preceding
+# Comment
+# class_b
+def self.class_b; end
+private_class_method :class_b
+
+def self.class_a; end
+# Long
+# Succeeding
+# Comment
+# class_a
+public_class_method :class_a
+
+# Preceding comment for instance_b
+def instance_b; end
+# Long
+# Succeeding
+# Comment
+# instance_b
+alias_method :orig_instance_b, :instance_b
+module_function :instance_b
+private :instance_b
+protected :instance_b
+public :instance_b
+
+# Long
+# Preceding
+# Comment
+# instance_a
+def instance_a; end
+# Succeeding comment for instance_a
+alias :new_instance_a :instance_a
+alias_method :orig_instance_a, :instance_a
+module_function :instance_a
+private :instance_a
+protected :instance_a
+public :instance_a
+```
 
 #### Caveats
-The corrector can fail to include surrounding comments and qualifiers for some
-methods.
+
+* The corrector will warn and refuse to order a method if it were to be
+  defined before its alias
+* If there's ambiguity about which method a comment or qualifier belongs to,
+  the corrector might fail to order correctly. For example, in the following, 
+  the corrector would incorrectly order the comment as a comment of `a`:
+
+  ```ruby
+  def b; end
+  # Comment b
+  def a; end
+  ```
 
 ## Development
 
@@ -94,12 +150,19 @@ bundle exec rake
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/shanecav84/rubocop-ordered_methods. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at 
+https://github.com/shanecav84/rubocop-ordered_methods. This project is intended 
+to be a safe, welcoming space for collaboration, and contributors are expected 
+to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+ conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the 
+[MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the RuboCop OrderedMethods project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shanecav84/rubocop-ordered_methods/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RuboCop OrderedMethods project’s codebases, issue 
+trackers, chat rooms and mailing lists is expected to follow the 
+[code of conduct](https://github.com/shanecav84/rubocop-ordered_methods/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
 require 'rspec/core/rake_task'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'rubocop/ordered_methods'

data/config/default.yml

@@ -1,4 +1,6 @@
 ---
 Layout/OrderedMethods:
+  Enabled: true
+  EnforcedStyle: 'alphabetical'
   IgnoredMethods:
     - initialize

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

@@ -14,11 +14,15 @@ module RuboCop
           '%<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
+        QUALIFIERS = %i[
+          alias_method
+          module_function
+          private_class_method
+          public_class_method
+          private
+          protected
+          public
+        ].freeze
 
         def_node_matcher :alias?, '(:alias ... (sym $_method_name))'
         def_node_matcher :qualifier?, <<-PATTERN
@@ -32,8 +36,8 @@ module RuboCop
           @previous_node = previous_node
 
           verify_alias_method_order
-          current_range = with_surroundings(@current_node)
-          previous_range = with_surroundings(@previous_node)
+          current_range = join_surroundings(@current_node)
+          previous_range = join_surroundings(@previous_node)
           lambda do |corrector|
             corrector.replace(current_range, previous_range.source)
             corrector.replace(previous_range, current_range.source)
@@ -43,9 +47,38 @@ module RuboCop
         private
 
         def found_qualifier?(node, next_sibling)
+          return false if next_sibling.nil?
+
           (qualifier?(next_sibling) || alias?(next_sibling)) == node.method_name
         end
 
+        def join_comments(node, source_range)
+          @processed_source.ast_with_comments[node].each do |comment|
+            source_range = source_range.join(comment.loc.expression)
+          end
+          source_range
+        end
+
+        def join_modifiers_and_aliases(node, source_range)
+          siblings = node.parent.children
+          preceding_qualifier_index = node.sibling_index
+          while found_qualifier?(node, siblings[preceding_qualifier_index + 1])
+            source_range = source_range.join(
+              siblings[preceding_qualifier_index + 1].source_range
+            )
+            preceding_qualifier_index += 1
+          end
+          source_range
+        end
+
+        def join_surroundings(node)
+          with_modifiers_and_aliases = join_modifiers_and_aliases(
+            node,
+            node.source_range
+          )
+          join_comments(node, with_modifiers_and_aliases)
+        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
@@ -82,47 +115,6 @@ module RuboCop
           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

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

@@ -3,9 +3,9 @@
 module RuboCop
   module Cop
     module Layout
-      # Check that methods are defined alphabetically.
+      # @example EnforcedStyle: alphabetical (default)
+      #   # Check that methods are defined alphabetically.
       #
-      # @example
       #   # bad
       #   def self.b; end
       #   def self.a; end
@@ -33,19 +33,13 @@ module RuboCop
         include IgnoredMethods
         include RangeHelp
 
-        MSG = 'Methods should be sorted alphabetically.'.freeze
-        VISIBILITY_MODIFIERS = %i[
-          module_function
-          private
-          protected
-          public
-        ].freeze
-
-        def_node_matcher :class_def?, 'defs'
-        def_node_matcher :instance_def?, 'def'
-        def_node_matcher :visibility_modifier?, <<-PATTERN
-          (send nil? { #{VISIBILITY_MODIFIERS.map(&:inspect).join(' ')} })
-        PATTERN
+        COMPARISONS = {
+          'alphabetical' => lambda do |left_method, right_method|
+            (left_method.method_name <=> right_method.method_name) != 1
+          end
+        }.freeze
+        ERR_INVALID_COMPARISON = 'Invalid "Comparison" config for ' \
+          "#{cop_name}. Expected one of: #{COMPARISONS.keys.join(', ')}".freeze
 
         def autocorrect(node)
           OrderedMethodsCorrector.correct(
@@ -59,15 +53,27 @@ module RuboCop
           consecutive_methods(node.children) do |previous, current|
             unless ordered?(previous, current)
               @previous_node = previous
-              add_offense(current)
+              add_offense(
+                current,
+                message: 'Methods should be sorted in ' \
+                  "#{cop_config['EnforcedStyle']} order."
+              )
             end
           end
         end
 
         private
 
-        def consecutive_methods(ast)
-          filtered_and_grouped(ast).each do |method_group|
+        def access_modified?(node, is_class_method_block)
+          (node.defs_type? && !is_class_method_block) ||
+            (node.def_type? && is_class_method_block) ||
+            (node.send_type? && node.bare_access_modifier?)
+        end
+
+        def consecutive_methods(nodes)
+          filtered = filter_relevant_nodes(nodes)
+          filtered_and_grouped = group_methods_by_access_modifier(filtered)
+          filtered_and_grouped.each do |method_group|
             method_group.each_cons(2) do |left_method, right_method|
               yield left_method, right_method
             end
@@ -77,54 +83,39 @@ module RuboCop
         def filter_relevant_nodes(nodes)
           nodes.select do |node|
             (
-              class_def?(node) ||
-                instance_def?(node) ||
-                visibility_modifier?(node)
-            ) && !ignored_method?(node.method_name)
+              (node.defs_type? || node.def_type?) &&
+                !ignored_method?(node.method_name)
+            ) || (node.send_type? && node.bare_access_modifier?)
           end
         end
 
-        def filtered_and_grouped(ast)
-          group_methods_by_visiblity_block(filter_relevant_nodes(ast))
-        end
-
-        # Group methods by the visiblity block they are declared in. Multiple
-        # blocks of the same visiblity will have their methods grouped
+        # Group methods by the access modifier block they are declared in.
+        # Multiple blocks of the same modifier will have their methods grouped
         # separately; for example, the following would be separated into two
         # groups:
         #   private
         #   def a; end
         #   private
         #   def b; end
-        # rubocop:disable Metrics/MethodLength
-        def group_methods_by_visiblity_block(nodes)
+        def group_methods_by_access_modifier(nodes)
           is_class_method_block = false
+
           nodes.each_with_object([[]]) do |node, grouped_methods|
-            if new_visiblity_block?(node, is_class_method_block)
+            if access_modified?(node, is_class_method_block)
               grouped_methods << []
             end
-
-            is_class_method_block = true if class_def?(node)
-            is_class_method_block = false if instance_def?(node)
-
-            if visibility_modifier?(node)
-              is_class_method_block = false
-              next
-            end
+            is_class_method_block = node.defs_type?
+            next if node.send_type? && node.bare_access_modifier?
 
             grouped_methods.last << node
           end
         end
-        # rubocop:enable Metrics/MethodLength
-
-        def new_visiblity_block?(node, is_class_method_block)
-          (class_def?(node) && !is_class_method_block) ||
-            (instance_def?(node) && is_class_method_block) ||
-            visibility_modifier?(node)
-        end
 
         def ordered?(left_method, right_method)
-          (left_method.method_name <=> right_method.method_name) != 1
+          comparison = COMPARISONS[cop_config['EnforcedStyle']]
+          raise Error, ERR_INVALID_COMPARISON if comparison.nil?
+
+          comparison.call(left_method, right_method)
         end
       end
     end

data/lib/rubocop/ordered_methods.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module RuboCop
+  # Our namespace
   module OrderedMethods
     PROJECT_ROOT = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
 
     def self.inject_defaults!
       path = CONFIG_DEFAULT.to_s

data/lib/rubocop-ordered_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop'
 require_relative 'rubocop/ordered_methods'
 require_relative 'rubocop/cop/layout/ordered_methods'

data/rubocop-ordered_methods.gemspec

@@ -1,31 +1,34 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = 'rubocop-ordered_methods'
-  spec.version       = '0.3'
-  spec.authors       = ['Shane Cavanaugh']
-  spec.email         = ['shane@shanecav.net']
+  spec.name = 'rubocop-ordered_methods'
+  spec.version = '0.4'
+  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.summary = 'Checks that methods are ordered alphabetically.'
+  spec.homepage = 'https://github.com/shanecav84/rubocop-ordered_methods'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.2.2'
 
   # 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
   # into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
       f.match(%r{^(test|spec|features)/})
     end
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rubocop', '~> 0.6'
+  spec.add_runtime_dependency 'rubocop', '>= 0.60'
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ordered_methods
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Shane Cavanaugh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-17 00:00:00.000000000 Z
+date: 2019-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.60'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.60'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +77,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -101,14 +102,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Checks that methods are ordered alphabetically.