rubocop-obsession 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bfae7e0b1e495fad34ada943845fd9399fe6763dd0b6eca0a946f87754ba4a2
-  data.tar.gz: 1651b96c4cd6ace35e62dfc968ec4dd8b690118c1b7e8aa5432abd59e5e0b8ad
+  metadata.gz: 53d3c586b21811a0a13b55a84253df3c26febb690ea9585b960c9c93d08a982e
+  data.tar.gz: 00e2f95178bd563b816a8b961b25470115ad2d25249c5b0c9f2921cd23d6df74
 SHA512:
-  metadata.gz: a0dd211e0748686195f25c2505aeef9baecae83e1648a4c7ddddf011a31e1de94e5e6cb239a6d8e67e3bf55b39c766af8e5d19f55aec70213993f7d7ae0dbea8
-  data.tar.gz: 2e427f1f22dca52e0c417b53c8e5b390aaaf801335d379e888a8131dd7b3e005abe0a32628e1efd9dbe9af4ab3ef749edb38ebb4143c634b74c5ffeff0385bd8
+  metadata.gz: 5c5f2748fc138701c397c0952250f3a42a7f810e2830ba2421b7cfc526511bd31ad1f788ab7863ef86546848c8c18586d9e45feef025d14bdec12b232304a401
+  data.tar.gz: 07c03a46b82ee6038f9ed5cdc7cb1358c58334a183827bb4b8908c2634a819aec88cc938dd451fc2b8182d734765dc284ce4059ea70d4e87a8b8b8e8ed3b98b6

data/README.md

@@ -9,6 +9,9 @@ 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!
+
 ## Installation
 
 Install the gem:

data/config/default.yml

@@ -66,8 +66,6 @@ Obsession/Rails/ServiceName:
     - 'app/jobs/**/*'
   Exclude:
     - 'app/jobs/application_job.rb'
-    - 'app/jobs/scheduled/scheduled_job.rb'
-    - '**/*events/**'
 Obsession/Rails/ServicePerformMethod:
   Enabled: true
   Include:

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.
@@ -56,13 +59,13 @@ module RuboCop
       #   def method_c; ...; end
       class MethodOrder < Base
         include Helpers
-        include RangeHelp
+        include CommentsHelp
         include VisibilityHelp
         extend AutoCorrector
 
         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
 
@@ -209,39 +229,31 @@ module RuboCop
 
         def autocorrect(corrector, method, previous_method)
           previous_method_range = source_range_with_comment(previous_method)
-          method_range = source_range_with_comment(method)
+          if buffer.source[previous_method_range.end_pos + 1] == "\n"
+            previous_method_range = previous_method_range.adjust(end_pos: 1)
+          end
+
+          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
 
           corrector.insert_after(previous_method_range, method_range.source)
           corrector.remove(method_range)
         end
 
-        def source_range_with_comment(node)
-          range_between(start_position_with_comment(node), end_position(node) + 1)
-        end
-
-        def start_position_with_comment(node)
-          first_comment = nil
-
-          (node.first_line - 1).downto(1) do |annotation_line|
-            comment = processed_source.comment_at_line(annotation_line)
-            break if !comment
-            first_comment = comment if whole_line_comment_at_line?(annotation_line)
-          end
-
-          start_line_position(first_comment || node)
-        end
+        def source_range_with_signature(method)
+          previous_node = method.left_sibling
+          begin_node = sorbet_signature?(previous_node) ? previous_node : method
 
-        def whole_line_comment_at_line?(line)
-          /\A\s*#/.match?(processed_source.lines[line - 1])
-        end
+          begin_pos = begin_pos_with_comment(begin_node)
+          end_pos = end_position_for(method)
 
-        def start_line_position(node)
-          processed_source.buffer.line_range(node.loc.line).begin_pos - 1
+          Parser::Source::Range.new(buffer, begin_pos, end_pos)
         end
 
-        def end_position(node)
-          end_line = processed_source.buffer.line_for_position(node.loc.expression.end_pos)
-          processed_source.buffer.line_range(end_line).end_pos
+        def sorbet_signature?(node)
+          node && node.method_name == :sig && node.type == :block
         end
       end
     end

data/lib/rubocop/obsession/version.rb

@@ -1,5 +1,5 @@
 module Rubocop
   module Obsession
-    VERSION = '0.1.5'
+    VERSION = '0.1.7'
   end
 end

metadata

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