rubocop-obsession 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea07a822228dc1870028109392546cccbf654593eb89157fa80abc740352e147
-  data.tar.gz: 8bea104f48fc439020647ebc4977f6d0976e38b8fb94e694c85f32ab42ab5fc6
+  metadata.gz: 9bfae7e0b1e495fad34ada943845fd9399fe6763dd0b6eca0a946f87754ba4a2
+  data.tar.gz: 1651b96c4cd6ace35e62dfc968ec4dd8b690118c1b7e8aa5432abd59e5e0b8ad
 SHA512:
-  metadata.gz: 4f36ed167869d3721b235ffd3b3409edcba01bf831e392b1a0101116bd7335b50169e27706360f98234f35fde716c71f86aae49516f1a9aaa28a2c64442e77df
-  data.tar.gz: 5c2b64a0069763a6e073af41b784b4c3f0d08a79117d3045d96065c0eed4c4fd2e235de61a57877cd37401e2aeb03d0d7ac49619d0835a91103d85831b27be22
+  metadata.gz: a0dd211e0748686195f25c2505aeef9baecae83e1648a4c7ddddf011a31e1de94e5e6cb239a6d8e67e3bf55b39c766af8e5d19f55aec70213993f7d7ae0dbea8
+  data.tar.gz: 2e427f1f22dca52e0c417b53c8e5b390aaaf801335d379e888a8131dd7b3e005abe0a32628e1efd9dbe9af4ab3ef749edb38ebb4143c634b74c5ffeff0385bd8

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:

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

@@ -3,7 +3,8 @@
 module RuboCop
   module Cop
     module Obsession
-      # This cop checks for private/protected methods that are not ordered correctly.
+      # 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.

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

@@ -8,12 +8,12 @@ module RuboCop
         # defaults or comments.
         #
         # - json(b) fields should have a default value like {} or [] so code can
-        # do my_field['field'] or my_field.first without fear that my_field is
-        # nil.
+        #   do my_field['field'] or my_field.first without fear that my_field is
+        #   nil.
         # - It is impossible to know the structure of a json(b) field just by
-        # reading the schema, because json(b) is an unstructured type. That's why
-        # an "Example: ..." Postgres comment should always be present when
-        # defining the field.
+        #   reading the schema, because json(b) is an unstructured type. That's why
+        #   an "Example: ..." Postgres comment should always be present when
+        #   defining the field.
         #
         # @example
         #
@@ -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.3'
+    VERSION = '0.1.5'
   end
 end

metadata

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