rubocop-obsession 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37b348efda2df448308744549f3a30181b44839d436a5219356579ef319ce8a4
-  data.tar.gz: 3ad138c089db20056117e20650f844de403253b147a35c2286eebbaef7c06faf
+  metadata.gz: be68e2beb303a311848858498767c76c03cc98031d8716bc27a702c3e2d0bb01
+  data.tar.gz: 0e867c196f843e6c206794e9938e0e88a779b8b231f51b43f4aeed02d6331efa
 SHA512:
-  metadata.gz: ee4ef4d270d3c6a33592370ada26298c81a8a1319fde90ae047bec81c87fe1732ed20a5bacc8ec969bcb52b9e2adfa2f440a28e7454f65f370bb225b91b75143
-  data.tar.gz: 378bf2513dedcb169400b5d0028775a3d330b576f5c520e3b4ff1e9ca27a658f8c15a7ab5ef3bc282e950527559d7d37b93eeba9c842dd77a4b667273d9ef170
+  metadata.gz: dfa035279001455509c1a4ee73d1aeae9e418733471691270c0c9627371f3ebd24415db377985ca6ff1f583e9843a65712be9ff9d640cc60643b2197b12f3e51
+  data.tar.gz: 90a7ed2c98377e3367ac0a177629c8e83a19b56cc294ddbadd260a3d67ce941a95b26f626401904078753822a00ae17babbb95f1c88bd6c128646917423c5908

data/README.md

@@ -9,8 +9,8 @@ There are some lower-level cops as well.
 Use the provided cops as is, or as inspiration to build custom cops aligned
 with your project's best practices.
 
-Does your project have any cool custom cops that you think others might benefit
-from? Then please open a PR!
+Does your project have any cool custom cops that others might benefit from?
+Then please open a PR!
 
 ## Installation
 

data/config/default.yml

@@ -1,5 +1,9 @@
 Obsession/MethodOrder:
   Enabled: true
+  EnforcedStyle: drill_down
+  SupportedStyles:
+    - drill_down
+    - step_down
 Obsession/NoBreakOrNext:
   Enabled: false
   Exclude:

data/lib/rubocop/cop/obsession/graphql/mutation_name.rb

@@ -10,7 +10,6 @@ module RuboCop
         # and actions are best described with verbs.
         #
         # @example
-        #
         #   # bad
         #   module Mutations
         #     class Event < Base

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

@@ -6,9 +6,8 @@ module RuboCop
       # This cop checks for private/protected methods that are not ordered
       # correctly. It supports autocorrect.
       #
-      # Code should read from top to bottom: methods should be defined in the
-      # same order as the order when they are first mentioned.
-      # Private/protected methods should follow that rule.
+      # 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
       # defined in any order the developer wants, like by order of importance.
@@ -20,44 +19,121 @@ module RuboCop
       # 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 kinds of edge cases.
+      # 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 4: for more information on this style of method ordering, see
-      # Robert C. Martin's "Clean Code" book > "Chapter 3: Functions" > "One
-      # level of abstraction per function" > "Reading Code from Top to Bottom:
-      # The Stepdown Rule" chapter.
+      # @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.
       #
-      # @example
+      #   This style is similar to the code example provided in the "Reading
+      #   Code from Top to Bottom: The Stepdown Rule" chapter from Robert C.
+      #   Martin's "Clean Code" book, but diverges from it in that it drills
+      #   down to the bottom of the call tree as much as possible.
       #
       #   # bad
-      #   def perform
-      #     return if method_a?
-      #     method_b
-      #     method_c
+      #   class Foo
+      #     def perform
+      #       return if method_a?
+      #       method_b
+      #       method_c
+      #     end
+      #
+      #     private
+      #
+      #     def method_c; ...; end
+      #     def method_b; ...; end
+      #     def method_a?; ...; end
+      #   end
+      #
+      #   # good
+      #   class Foo
+      #     def perform
+      #       return if method_a?
+      #       method_b
+      #       method_c
+      #     end
+      #
+      #     private
+      #
+      #     def method_a?; ...; end
+      #     def method_b; ...; end
+      #     def method_c; ...; end
       #   end
       #
-      #   private
+      #   # bad
+      #   class Foo
+      #     def perform
+      #       method_a
+      #       method_b
+      #     end
+      #
+      #     private
       #
-      #   def method_c; ...; end
-      #   def method_b; ...; end
-      #   def method_a?; ...; end
+      #     def method_a; method_c; end
+      #     def method_b; method_c; end
+      #     def method_c; ...; end
+      #   end
       #
       #   # good
-      #   def perform
-      #     return if method_a?
-      #     method_b
-      #     method_c
+      #   class Foo
+      #     def perform
+      #       method_a
+      #       method_b
+      #     end
+      #
+      #     private
+      #
+      #     def method_a; method_c; end
+      #     def method_c; ...; end
+      #     def method_b; method_c; end
       #   end
       #
-      #   private
+      # @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
+      #   abstraction). The idea is to gradually descend one level of
+      #   abstraction at a time.
+      #
+      #   This style adheres more strictly to the code example provided in the
+      #   "Reading Code from Top to Bottom: The Stepdown Rule" chapter from
+      #   Robert C. Martin's "Clean Code" book.
       #
-      #   def method_a?; ...; end
-      #   def method_b; ...; end
-      #   def method_c; ...; end
+      #   # bad
+      #   class Foo
+      #     def perform
+      #       method_a
+      #       method_b
+      #     end
+      #
+      #     private
+      #
+      #     def method_a; method_c; end
+      #     def method_c; ...; end
+      #     def method_b; method_c; end
+      #   end
+      #
+      #   # good
+      #   class Foo
+      #     def perform
+      #       method_a
+      #       method_b
+      #     end
+      #
+      #     private
+      #
+      #     def method_a; method_c; end
+      #     def method_b; method_c; end
+      #     def method_c; ...; end
+      #   end
       class MethodOrder < Base
+        include ConfigurableEnforcedStyle
         include Helpers
         include CommentsHelp
         include VisibilityHelp
@@ -183,10 +259,14 @@ module RuboCop
         def 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) }
 
-          ([method_name] + next_names).compact.uniq
+          common_methods =
+            drill_down_style? ? [] : next_names.tally.select { |_, size| size > 1 }.keys
+
+          unique_methods = next_names - common_methods
+
+          ([method_name] + unique_methods + common_methods).compact.uniq
         end
 
         def should_ignore?(ast_node)
@@ -194,6 +274,10 @@ 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/cop/obsession/no_break_or_next.rb

@@ -15,7 +15,6 @@ module RuboCop
       # `loop` + `break` into a `while`.
       #
       # @example
-      #
       #   # bad
       #   github_teams.each do |github_team|
       #     next if github_team['size'] == 0

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

@@ -11,7 +11,6 @@ module RuboCop
       # could be: initialization, action, and result.
       #
       # @example
-      #
       #   # bad
       #   def set_seo_content
       #     return if slug.blank?

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

@@ -13,7 +13,6 @@ module RuboCop
       # leaves the company, and never gets a chance to tackle them.
       #
       # @example
-      #
       #   # bad
       #   # TODO: remove this method when we ship the new signup flow
       #   def my_method

data/lib/rubocop/cop/obsession/rails/callback_one_method.rb

@@ -9,7 +9,6 @@ module RuboCop
         # One method per callback definition makes the definition extra clear.
         #
         # @example
-        #
         #   # bad
         #   after_create :notify_followers, :send_stats
         #

data/lib/rubocop/cop/obsession/rails/fully_defined_json_field.rb

@@ -16,7 +16,6 @@ module RuboCop
         #   defining the field.
         #
         # @example
-        #
         #   # bad
         #   def change
         #     add_column :languages, :items, :jsonb

data/lib/rubocop/cop/obsession/rails/migration_belongs_to.rb

@@ -11,7 +11,6 @@ module RuboCop
         # declarations that you find in model code.
         #
         # @example
-        #
         #   # bad
         #   def change
         #     add_reference :blog_posts, :user

data/lib/rubocop/cop/obsession/rails/no_callback_conditions.rb

@@ -16,7 +16,6 @@ module RuboCop
         # custom validation callbacks.
         #
         # @example
-        #
         #   # bad
         #   after_update_commit :crawl_rss, if: :rss_changed?
         #

data/lib/rubocop/cop/obsession/rails/private_callback.rb

@@ -11,7 +11,6 @@ module RuboCop
         # be private.
         #
         # @example
-        #
         #   # bad
         #   before_action :load_blog_post
         #

data/lib/rubocop/cop/obsession/rails/safety_assured_comment.rb

@@ -15,7 +15,6 @@ module RuboCop
         # app down.
         #
         # @example
-        #
         #   # bad
         #   class RemoveSourceUrlFromBlogPosts < ActiveRecord::Migration[8.0]
         #     def change

data/lib/rubocop/cop/obsession/rails/service_name.rb

@@ -11,7 +11,6 @@ module RuboCop
         # one action, and the best way to describe an action is with a verb.
         #
         # @example
-        #
         #   # bad
         #   class Company
         #     def perform

data/lib/rubocop/cop/obsession/rails/service_perform_method.rb

@@ -13,7 +13,6 @@ module RuboCop
         # interchangeable.
         #
         # @example
-        #
         #   # bad
         #   class ImportCompany
         #     def import

data/lib/rubocop/cop/obsession/rails/short_after_commit.rb

@@ -7,7 +7,6 @@ module RuboCop
         # This cop checks for `after_commit` declarations that could be shorter.
         #
         # @example
-        #
         #   # bad
         #   after_commit :send_email, on: :create
         #

data/lib/rubocop/cop/obsession/rails/short_validate.rb

@@ -7,7 +7,6 @@ module RuboCop
         # This cop checks for `validate` declarations that could be shorter.
         #
         # @example
-        #
         #   # bad
         #   validate :validate_url, on: %i(create update)
         #

data/lib/rubocop/cop/obsession/rails/validate_one_field.rb

@@ -9,7 +9,6 @@ module RuboCop
         # One field per `validates` makes the validation extra clear.
         #
         # @example
-        #
         #   # bad
         #   validates :name, :status, presence: true
         #

data/lib/rubocop/cop/obsession/rails/validation_method_name.rb

@@ -7,7 +7,6 @@ module RuboCop
         # This cop checks for validation methods that do not start with `validate_`.
         #
         # @example
-        #
         #   # bad
         #   validate :at_least_one_admin
         #

data/lib/rubocop/cop/obsession/rspec/describe_public_method.rb

@@ -15,7 +15,6 @@ module RuboCop
         # corresponding Rails public method, e.g. #create, #save, etc.
         #
         # @example
-        #
         #   class Comment < ApplicationRecord
         #     after_create_commit :notify_users
         #

data/lib/rubocop/cop/obsession/rspec/empty_line_after_final_let.rb

@@ -7,7 +7,6 @@ if defined?(RuboCop::RSpec)
           # by `it` with no new line, to allow for this style of spec:
           #
           # @example
-          #
           #   describe Url do
           #     describe '#domain' do
           #       context do

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

@@ -15,7 +15,6 @@ module RuboCop
       # could be a sign that they should be broken into smaller methods.
       #
       # @example
-      #
       #   # bad
       #   def set_seo_content
       #     return if seo_content.present?

data/lib/rubocop/obsession/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-obsession
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Jerome Dalbert
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport