rubocop-obsession 0.1.15 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be68e2beb303a311848858498767c76c03cc98031d8716bc27a702c3e2d0bb01
-  data.tar.gz: 0e867c196f843e6c206794e9938e0e88a779b8b231f51b43f4aeed02d6331efa
+  metadata.gz: 25c282866d6263936f722452957de83f65e35a9bd8be749b0776db3804735c99
+  data.tar.gz: dd25cf5b7c1ea78fa15160cd035d0bbb0a46c97358d5c71c5290f7ee44d97604
 SHA512:
-  metadata.gz: dfa035279001455509c1a4ee73d1aeae9e418733471691270c0c9627371f3ebd24415db377985ca6ff1f583e9843a65712be9ff9d640cc60643b2197b12f3e51
-  data.tar.gz: 90a7ed2c98377e3367ac0a177629c8e83a19b56cc294ddbadd260a3d67ce941a95b26f626401904078753822a00ae17babbb95f1c88bd6c128646917423c5908
+  metadata.gz: ec4f1c02a081f43198c0df82f8bc0676ffe7edc1abe6400082e0338f2aae9a83e2d77bafb5afa654d9d242af46116b2e230a8a00730cdb188fa6941a63a5d48c
+  data.tar.gz: 4276856a5304191f68345fc9527d9b2a5432ac8f78811803098f21a65863d08c5ca51d1053be59b72877e9ee6749477f11bd691708ec136d8998cb6745109021

data/README.md

@@ -38,13 +38,13 @@ to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-obsession
+plugins: rubocop-obsession
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-obsession
 ```
@@ -52,17 +52,20 @@ require:
 Now you can run `rubocop` and it will automatically load the Rubocop Obsession
 cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```bash
-rubocop --require rubocop-obsession
+rubocop --plugin rubocop-obsession
 ```
 
 ### Rake task
 
 ```ruby
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-obsession'
+  task.plugins << 'rubocop-obsession'
 end
 ```
 

data/config/default.yml

@@ -4,6 +4,7 @@ Obsession/MethodOrder:
   SupportedStyles:
     - drill_down
     - step_down
+    - alphabetical
 Obsession/NoBreakOrNext:
   Enabled: false
   Exclude:

data/lib/rubocop/cop/obsession/method_order.rb

@@ -6,30 +6,27 @@ module RuboCop
       # This cop checks for private/protected methods that are not ordered
       # correctly. It supports autocorrect.
       #
-      # Code should read from top to bottom. Private/protected methods should
-      # follow that rule.
-      #
-      # Note 1: public methods do not have to follow that rule, and can be
+      # Note 1: the order of public methods is not enforced. They can be
       # defined in any order the developer wants, like by order of importance.
-      # This is because they are usually called outside of the class and often
-      # not called within the class at all. If possible though, developers
-      # should still try to order their public methods from top to bottom when
-      # it makes sense.
+      # This is because public methods are usually called outside of the class
+      # and often not called within the class at all. If possible though,
+      # developers should still try to order their public methods when it makes
+      # sense.
       #
-      # Note 2: method order cannot be computed for methods called by `send`,
-      # metaprogramming, private methods called by superclasses or modules,
-      # etc. This cop's suggestions and autocorrections may be slightly off for
-      # these cases.
+      # Note 2: for top to bottom styles, method order cannot be computed for
+      # methods called by `send`, metaprogramming, private methods called by
+      # superclasses or modules, etc. This cop's suggestions and
+      # autocorrections may be slightly off for these cases.
       #
-      # Note 3: for simplicity, protected methods do not have to follow that
-      # rule if there are both a protected section and a private section.
+      # Note 3: for simplicity, protected methods do not have to be ordered if
+      # there are both a protected section and a private section.
       #
       # @example EnforcedStyle: drill_down (default)
-      #   In this style, methods should be defined in the same order as the
-      #   order when they are first mentioned. This means that a called method
-      #   is defined below the caller method as immediately as possible. In
-      #   other words, you go to the bottom of the method call tree before
-      #   going back up. See the second example.
+      #   In this style, code should read from top to bottom. More
+      #   particularly, methods should be defined in the same order as the
+      #   order when they are first mentioned. Put another way, you go to the
+      #   bottom of the method call tree before going back up. See examples
+      #   below.
       #
       #   This style is similar to the code example provided in the "Reading
       #   Code from Top to Bottom: The Stepdown Rule" chapter from Robert C.
@@ -95,9 +92,10 @@ module RuboCop
       #   end
       #
       # @example EnforcedStyle: step_down
-      #   In this style, common called methods (which tend to have a lower
-      #   level of abstraction) are defined after the group of methods that
-      #   calls them (these caller methods tend to have a higher level of
+      #   In this style, code should read from top to bottom. More
+      #   particularly, common called methods (which tend to have a lower level
+      #   of abstraction) are defined after the group of methods that calls
+      #   them (these caller methods tend to have a higher level of
       #   abstraction). The idea is to gradually descend one level of
       #   abstraction at a time.
       #
@@ -132,6 +130,32 @@ module RuboCop
       #     def method_b; method_c; end
       #     def method_c; ...; end
       #   end
+      #
+      # @example EnforcedStyle: alphabetical
+      #   In this style, methods are ordered alphabetically. This style is
+      #   unambiguous and interpretation-free.
+      #
+      #   # bad
+      #   class Foo
+      #     def perform; ...; end
+      #
+      #     private
+      #
+      #     def method_c; ...; end
+      #     def method_b; ...; end
+      #     def method_a; ...; end
+      #   end
+      #
+      #   # good
+      #   class Foo
+      #     def perform; ...; end
+      #
+      #     private
+      #
+      #     def method_a; ...; end
+      #     def method_b; ...; end
+      #     def method_c; ...; end
+      #   end
       class MethodOrder < Base
         include ConfigurableEnforcedStyle
         include Helpers
@@ -166,9 +190,7 @@ module RuboCop
           @class_node = class_node
           find_private_node || return
           build_methods || return
-          build_callback_methods
 
-          build_method_call_tree
           build_ordered_private_methods
           build_private_methods
 
@@ -209,6 +231,25 @@ module RuboCop
           @methods.any?
         end
 
+        def build_ordered_private_methods
+          if style == :alphabetical
+            @ordered_private_methods = alphabetically_ordered_private_methods
+          else
+            build_callback_methods
+            build_method_call_tree
+            @ordered_private_methods = top_to_bottom_ordered_private_methods(@method_call_tree)
+          end
+        end
+
+        def alphabetically_ordered_private_methods
+          @methods
+            .values
+            .uniq
+            .reject { |method| ignore_visibility?(node_visibility(method)) }
+            .map(&:method_name)
+            .sort
+        end
+
         def build_callback_methods
           @callback_methods = []
 
@@ -252,18 +293,14 @@ module RuboCop
           called_methods
         end
 
-        def build_ordered_private_methods
-          @ordered_private_methods = ordered_private_methods(@method_call_tree)
-        end
-
-        def ordered_private_methods(node)
+        def top_to_bottom_ordered_private_methods(node)
           ast_node = node.value
           method_name = should_ignore?(ast_node) ? nil : ast_node.method_name
-          next_names = node.children.flat_map { |child| ordered_private_methods(child) }
+          next_names =
+            node.children.flat_map { |child| top_to_bottom_ordered_private_methods(child) }
 
           common_methods =
-            drill_down_style? ? [] : next_names.tally.select { |_, size| size > 1 }.keys
-
+            (style == :drill_down) ? [] : next_names.tally.select { |_, size| size > 1 }.keys
           unique_methods = next_names - common_methods
 
           ([method_name] + unique_methods + common_methods).compact.uniq
@@ -274,10 +311,6 @@ module RuboCop
             !@called_methods.include?(ast_node)
         end
 
-        def drill_down_style?
-          style == :drill_down
-        end
-
         def build_private_methods
           @private_methods = @methods.keys.intersection(@ordered_private_methods)
         end

data/lib/rubocop/obsession/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module Rubocop
+  module Obsession
+    # A plugin that integrates Rubocop Obsession with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-obsession',
+          version: VERSION,
+          homepage: 'https://github.com/jeromedalbert/rubocop-obsession',
+          description: 'A collection of RuboCop cops for enforcing higher-level code concepts.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/obsession/version.rb

@@ -1,5 +1,5 @@
 module Rubocop
   module Obsession
-    VERSION = '0.1.15'
+    VERSION = '0.2.0'
   end
 end

data/lib/rubocop/obsession.rb

@@ -6,5 +6,4 @@ require 'rubocop'
 require_relative 'cop/obsession/mixin/helpers'
 Dir["#{__dir__}/cop/obsession/**/*.rb"].sort.each { |file| require file }
 require_relative 'obsession/version'
-
-RuboCop::ConfigLoader.inject_defaults!("#{__dir__}/../..")
+require_relative 'obsession/plugin'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-obsession
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.2.0
 platform: ruby
 authors:
 - Jerome Dalbert
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-25 00:00:00.000000000 Z
+date: 2025-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: '1.72'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: '1.72'
 description: A collection of RuboCop cops for enforcing higher-level code concepts.
 email:
 - jerome.dalbert@gmail.com
@@ -71,6 +85,7 @@ files:
 - lib/rubocop/cop/obsession/rspec/empty_line_after_final_let.rb
 - lib/rubocop/cop/obsession/too_many_paragraphs.rb
 - lib/rubocop/obsession.rb
+- lib/rubocop/obsession/plugin.rb
 - lib/rubocop/obsession/version.rb
 homepage: https://github.com/jeromedalbert/rubocop-obsession
 licenses:
@@ -78,6 +93,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/jeromedalbert/rubocop-obsession
   source_code_uri: https://github.com/jeromedalbert/rubocop-obsession
+  default_lint_roller_plugin: Rubocop::Obsession::Plugin
 post_install_message:
 rdoc_options: []
 require_paths: