rubocop-obsession 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b1e6edfacbf86e2ac264de49f2ac818af6ee693c6cabe9865894b556953e3ad
-  data.tar.gz: 9d523c4878734ef93c3b0052622ffe49e1a3913505963a91fe10327ddac17660
+  metadata.gz: d393d8af056f32d108c9c0f272cf6a6ccf2158d33caf91a950ca317f9da2a9cb
+  data.tar.gz: 822e9f0697a1559eb91755d9f2702a9d121727c89e9715e9c48ab447ff702220
 SHA512:
-  metadata.gz: eed54a03536307d0bfdda7b43b8346306420d1037068921b238f67fbd938c276d84f5802f70ce42bc0a26f3d46f399a5db9e3864ac73adfc01e6e5911f8f5f83
-  data.tar.gz: bc7e712ec48bbe05f8419754a9b9d1f443973e154ca4525dc0712a3c0576be840b66c65e67c8a206a12a628af97d703c7b84d50a15951dc8446dc1bda5c5461e
+  metadata.gz: 9dc017470f824de21567bf7ec06ea9e372f5edc147932f715e8bdb3a8b60ef6cdfb1a84905b33c9ae0e340cf8515455e59374ec22121c6b4b36296204527918d
+  data.tar.gz: d4a5f84c5714d34ae2733e4f13fb58a089955d83c546ff411a34614bf2178a749f8acd1fc31bd4cbacb3d6fd5d85b24a0648fb7545f44a7a60110d1aa194494f

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

@@ -11,18 +11,21 @@ module RuboCop
       # 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. 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.
+      # 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.
       #
       # 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.
       #
-      # Note 3: for more information on this style of method ordering, see
+      # 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.
@@ -62,7 +65,7 @@ module RuboCop
 
         MSG = 'Method `%<after>s` should appear below `%<previous>s`.'
 
-        def_node_search :private_node, <<~PATTERN
+        def_node_search :private_nodes, <<~PATTERN
           (send nil? {:private :protected})
         PATTERN
 
@@ -103,7 +106,24 @@ module RuboCop
         private
 
         def find_private_node
-          @private_node = private_node(@class_node)&.first
+          private_nodes = private_nodes(@class_node).to_a
+          return nil if private_nodes.empty?
+
+          visibilities = private_nodes.map(&:method_name)
+          @ignore_protected = visibilities.include?(:protected) && visibilities.include?(:private)
+
+          @private_node = private_nodes.find { |node| !ignore_visibility?(node.method_name) }
+        end
+
+        def ignore_visibility?(visibility)
+          case visibility
+          when :public
+            true
+          when :protected
+            @ignore_protected
+          when :private
+            false
+          end
         end
 
         def build_methods
@@ -174,7 +194,7 @@ module RuboCop
         end
 
         def should_ignore?(ast_node)
-          ast_node.nil? || node_visibility(ast_node) == :public ||
+          ast_node.nil? || ignore_visibility?(node_visibility(ast_node)) ||
             !@called_methods.include?(ast_node)
         end
 
@@ -213,7 +233,7 @@ module RuboCop
             previous_method_range = previous_method_range.adjust(end_pos: 1)
           end
 
-          method_range = source_range_with_comment(method)
+          method_range = source_range_with_signature(method)
           if buffer.source[method_range.begin_pos - 1] == "\n"
             method_range = method_range.adjust(end_pos: 1)
           end
@@ -221,6 +241,20 @@ module RuboCop
           corrector.insert_after(previous_method_range, method_range.source)
           corrector.remove(method_range)
         end
+
+        def source_range_with_signature(method)
+          previous_node = method.left_sibling
+          begin_node = sorbet_signature?(previous_node) ? previous_node : method
+
+          begin_pos = begin_pos_with_comment(begin_node)
+          end_pos = end_position_for(method)
+
+          Parser::Source::Range.new(buffer, begin_pos, end_pos)
+        end
+
+        def sorbet_signature?(node)
+          node && node.method_name == :sig && node.type == :block
+        end
       end
     end
   end

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

@@ -11,8 +11,8 @@ module RuboCop
       # - For small loops, you can just use normal conditions instead of `next`.
       # `break` is allowed.
       #
-      # Note: Sometimes loops can also be rethought, like transforming a `loop`
-      # + `break` into a `while`.
+      # Note: Sometimes loops can also be rethought, like transforming a
+      # `loop` + `break` into a `while`.
       #
       # @example
       #

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

@@ -11,6 +11,19 @@ module RuboCop
       # stale TODOs. Sometimes developers really mean to work on their TODOs
       # soon, but then Product re-prioritizes their work, or the developer
       # 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
+      #     ...
+      #   end
+      #
+      #   # good
+      #   def my_method
+      #     ...
+      #   end
       class NoTodos < Base
         MSG = 'Avoid TODO comment, create a task in your project management tool instead.'
         KEYWORD_REGEX = /(^|[^\w])(TODO|FIXME|OPTIMIZE|HACK)($|[^\w])/i

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

@@ -18,14 +18,18 @@ module RuboCop
         # @example
         #
         #   # bad
-        #   add_column :languages, :items, :jsonb
+        #   def change
+        #     add_column :languages, :items, :jsonb
+        #   end
         #
         #   # good
-        #   add_column :languages,
-        #              :items,
-        #              :jsonb,
-        #              default: [],
-        #              comment: "Example: [{ 'name': 'ruby' }, { 'name': 'python' }]"
+        #   def change
+        #     add_column :languages,
+        #                :items,
+        #                :jsonb,
+        #                default: [],
+        #                comment: "Example: [{ 'name': 'ruby' }, { 'name': 'python' }]"
+        #   end
         class FullyDefinedJsonField < Base
           def_node_matcher :json_field?, <<~PATTERN
             (send nil? :add_column _ _ (sym {:json :jsonb}) ...)

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

@@ -19,12 +19,14 @@ module RuboCop
         #
         #   # bad
         #   after_update_commit :crawl_rss, if: :rss_changed?
+        #
         #   def crawl_rss
         #     ...
         #   end
         #
         #   # good
         #   after_update_commit :crawl_rss
+        #
         #   def crawl_rss
         #     return if !rss_changed?
         #     ...

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

@@ -13,6 +13,23 @@ module RuboCop
         # of the DB migration. The reason should be detailed and reviewed by a
         # knowledgeable PR reviewer. Failure to follow instructions may bring your
         # app down.
+        #
+        # @example
+        #
+        #   # bad
+        #   class RemoveSourceUrlFromBlogPosts < ActiveRecord::Migration[8.0]
+        #     def change
+        #       safety_assured { remove_column :blog_posts, :source_url }
+        #     end
+        #   end
+        #
+        #   # good
+        #   class RemoveSourceUrlFromBlogPosts < ActiveRecord::Migration[8.0]
+        #     # Safe because this column was ignored with self.ignored_columns in PR #1234
+        #     def change
+        #       safety_assured { remove_column :blog_posts, :source_url }
+        #     end
+        #   end
         class SafetyAssuredComment < Base
           MSG =
             'Add `# Safe because <reason>` comment above safety_assured. ' \

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

@@ -8,15 +8,17 @@ if defined?(RuboCop::RSpec)
           #
           # @example
           #
-          #   describe '#domain' do
-          #     context do
-          #       let(:url) { Url.new('http://www.some-site.com/some-page') }
-          #       it { expect(url.domain).to eq 'some-site.com' }
-          #     end
+          #   describe Url do
+          #     describe '#domain' do
+          #       context do
+          #         let(:url) { Url.new('http://www.some-site.com/some-page') }
+          #         it { expect(url.domain).to eq 'some-site.com' }
+          #       end
           #
-          #     context do
-          #       let(:url) { Url.new('some-site.com') }
-          #       it { expect(url.domain).to eq 'some-site.com' }
+          #       context do
+          #         let(:url) { Url.new('some-site.com') }
+          #         it { expect(url.domain).to eq 'some-site.com' }
+          #       end
           #     end
           #   end
           class EmptyLineAfterFinalLet < RSpec::EmptyLineAfterFinalLet

data/lib/rubocop/obsession/version.rb

@@ -1,5 +1,5 @@
 module Rubocop
   module Obsession
-    VERSION = '0.1.6'
+    VERSION = '0.1.8'
   end
 end

data/lib/rubocop/obsession.rb

@@ -1,5 +1,6 @@
 require 'active_support'
 require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
 require 'rubocop'
 
 require_relative 'cop/mixin/helpers'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-obsession
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Jerome Dalbert
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-02 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport