rubocop-obsession 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47b14b8bd67398fccc5f92ba6e3e5b30bd76a47ec28a38694183cac973de17e4
-  data.tar.gz: bc60b8d77b8a2353abf4d0d3025161b5c581405507ecbe946f6401e9e3665951
+  metadata.gz: 4b1e6edfacbf86e2ac264de49f2ac818af6ee693c6cabe9865894b556953e3ad
+  data.tar.gz: 9d523c4878734ef93c3b0052622ffe49e1a3913505963a91fe10327ddac17660
 SHA512:
-  metadata.gz: db8e7698d91d0ab2ef5cb95236164ac2bb0dc754944082c3705d88d87cf99ed1d8bb620cefba7e7817dcfc622d951aca9ee38be76fec566d7a6644a9a1bed111
-  data.tar.gz: 744cc5411803bdf92075645b9aa53d50133078f8491c0edc6bbade699805141b72297b1acabc85ed5321a1cc70a86282d5458bd5eb7df0483174211f153f7250
+  metadata.gz: eed54a03536307d0bfdda7b43b8346306420d1037068921b238f67fbd938c276d84f5802f70ce42bc0a26f3d46f399a5db9e3864ac73adfc01e6e5911f8f5f83
+  data.tar.gz: bc7e712ec48bbe05f8419754a9b9d1f443973e154ca4525dc0712a3c0576be840b66c65e67c8a206a12a628af97d703c7b84d50a15951dc8446dc1bda5c5461e

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

@@ -3,7 +3,7 @@ Obsession/MethodOrder:
 Obsession/NoBreakOrNext:
   Enabled: false
   Exclude:
-    - 'script/db/**/*'
+    - 'script/**/*'
 Obsession/NoParagraphs:
   Enabled: false
   Exclude:
@@ -15,7 +15,7 @@ Obsession/TooManyParagraphs:
   Enabled: false
   Exclude:
     - 'db/migrate/*'
-    - 'script/db/**/*'
+    - 'script/**/*'
     - 'spec/**/*'
 
 Obsession/Graphql/MutationName:
@@ -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/graphql/mutation_name.rb

@@ -22,7 +22,7 @@ module RuboCop
         #     class TrackEvent < Base
         #     end
         #   end
-        class MutationName < Cop
+        class MutationName < Base
           include Helpers
 
           MSG = 'Mutation name should start with a verb.'

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

@@ -56,7 +56,7 @@ module RuboCop
       #   def method_c; ...; end
       class MethodOrder < Base
         include Helpers
-        include RangeHelp
+        include CommentsHelp
         include VisibilityHelp
         extend AutoCorrector
 
@@ -209,40 +209,18 @@ module RuboCop
 
         def autocorrect(corrector, method, previous_method)
           previous_method_range = source_range_with_comment(previous_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_comment(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 whole_line_comment_at_line?(line)
-          /\A\s*#/.match?(processed_source.lines[line - 1])
-        end
-
-        def start_line_position(node)
-          processed_source.buffer.line_range(node.loc.line).begin_pos - 1
-        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
-        end
       end
     end
   end

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

@@ -59,7 +59,7 @@ module RuboCop
       #       end
       #     end
       #   end
-      class NoBreakOrNext < Cop
+      class NoBreakOrNext < Base
         BIG_LOOP_MSG =
           'Avoid `break`/`next` in big loop, decompose into private method or rethink loop.'
         NO_NEXT_MSG = 'Avoid `next` in loop, use conditions or rethink loop.'

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

@@ -8,7 +8,7 @@ module RuboCop
       # If your method code has many instructions that are not organized into
       # paragraphs, you should break it up into multiple paragraphs to make the
       # code more breathable and readable. The 3 possible paragraphs themes
-      # always are: initialization, action, and result.
+      # could be: initialization, action, and result.
       #
       # @example
       #
@@ -33,7 +33,7 @@ module RuboCop
       #
       #     Rails.logger.info('Content has been set')
       #   end
-      class NoParagraphs < Cop
+      class NoParagraphs < Base
         MSG = 'Method has many instructions and should be broken up into paragraphs.'
         MAX_CONSECUTIVE_INSTRUCTIONS_ALLOWED = 5
 

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

@@ -11,7 +11,7 @@ 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.
-      class NoTodos < Cop
+      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/callback_one_method.rb

@@ -16,7 +16,7 @@ module RuboCop
         #   # good
         #   after_create :notify_followers
         #   after_create :send_stats
-        class CallbackOneMethod < Cop
+        class CallbackOneMethod < Base
           include Helpers
 
           MSG = 'Declare only one method per callback definition.'

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

@@ -26,7 +26,7 @@ module RuboCop
         #              :jsonb,
         #              default: [],
         #              comment: "Example: [{ 'name': 'ruby' }, { 'name': 'python' }]"
-        class FullyDefinedJsonField < Cop
+        class FullyDefinedJsonField < Base
           def_node_matcher :json_field?, <<~PATTERN
             (send nil? :add_column _ _ (sym {:json :jsonb}) ...)
           PATTERN

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

@@ -21,7 +21,7 @@ module RuboCop
         #   def change
         #     add_belongs_to :blog_posts, :user
         #   end
-        class MigrationBelongsTo < Cop
+        class MigrationBelongsTo < Base
           def_node_matcher :add_reference?, <<~PATTERN
             (send nil? :add_reference ...)
           PATTERN

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

@@ -29,7 +29,7 @@ module RuboCop
         #     return if !rss_changed?
         #     ...
         #   end
-        class NoCallbackConditions < Cop
+        class NoCallbackConditions < Base
           MSG =
             'Avoid condition in callback declaration, move it inside the callback method instead.'
 

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

@@ -27,7 +27,7 @@ module RuboCop
         #   def load_blog_post
         #     ...
         #   end
-        class PrivateCallback < Cop
+        class PrivateCallback < Base
           include VisibilityHelp
           include Helpers
 

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

@@ -13,7 +13,7 @@ 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.
-        class SafetyAssuredComment < Cop
+        class SafetyAssuredComment < Base
           MSG =
             'Add `# Safe because <reason>` comment above safety_assured. ' \
               'An invalid reason may bring the site down.'

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

@@ -13,7 +13,7 @@ module RuboCop
         #
         #   # good
         #   after_create_commit :send_email
-        class ShortAfterCommit < Cop
+        class ShortAfterCommit < Base
           MSG = 'Use shorter %<prefer>s'
 
           def_node_matcher :after_commit?, '(send nil? :after_commit ...)'

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

@@ -13,7 +13,7 @@ module RuboCop
         #
         #   # good
         #   validate :validate_url
-        class ShortValidate < Cop
+        class ShortValidate < Base
           MSG = 'The `on:` argument is not needed in this validate.'
 
           def_node_matcher :validate_with_unneeded_on?, <<~PATTERN

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

@@ -16,7 +16,7 @@ module RuboCop
         #   # good
         #   validates :name, presence: true
         #   validates :status, presence: true
-        class ValidateOneField < Cop
+        class ValidateOneField < Base
           MSG = 'Validate only one field per line.'
 
           def_node_matcher :validates_with_more_than_one_field?, <<~PATTERN

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

@@ -13,7 +13,7 @@ module RuboCop
         #
         #   # good
         #   validate :validate_at_least_one_admin
-        class ValidationMethodName < Cop
+        class ValidationMethodName < Base
           MSG = 'Prefix custom validation method with validate_'
 
           def_node_matcher :on_validate_callback, <<~PATTERN

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

@@ -37,7 +37,7 @@ module RuboCop
         #       ...
         #     end
         #   end
-        class DescribePublicMethod < Cop
+        class DescribePublicMethod < Base
           MSG = 'Only test public methods.'
 
           def_node_matcher :on_context_method, <<-PATTERN

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

@@ -6,13 +6,13 @@ module RuboCop
       # This cop checks for methods with too many paragraphs.
       #
       # You should organize your method code into 2 to 3 paragraphs maximum.
-      # The 3 possible paragraphs themes always are: initialization, action,
+      # The 3 possible paragraphs themes could be: initialization, action,
       # and result. Shape your paragraph according to those themes. Spec code
       # should also be organized into 2 to 3 paragraphs
       # (initialization/action/result or given/when/then paragraphs).
       #
-      # After organizing your paragraphs, if they are too long or dense, it is
-      # a sign that you should break your code into smaller methods.
+      # After organizing your paragraphs, if they are too long or dense, it
+      # could be a sign that they should be broken into smaller methods.
       #
       # @example
       #
@@ -39,7 +39,7 @@ module RuboCop
       #
       #     Rails.logger.info('Content has been set')
       #   end
-      class TooManyParagraphs < Cop
+      class TooManyParagraphs < Base
         MSG = 'Organize method into 2 to 3 paragraphs (init, action, result).'
         MAX_PARAGRAPHS = 3
 

data/lib/rubocop/obsession/version.rb

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

metadata

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