rubocop-obsession 0.1.0

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Obsession
+      # 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,
+      # 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.
+      #
+      # @example
+      #
+      #   # bad
+      #   def set_seo_content
+      #     return if seo_content.present?
+      #
+      #     template = SeoTemplate.find_by(template_type: 'BlogPost')
+      #
+      #     return if template.blank?
+      #
+      #     self.seo_content = build_seo_content(seo_template: template, slug: slug)
+      #
+      #     Rails.logger.info('Content has been set')
+      #   end
+      #
+      #   # good
+      #   def set_seo_content
+      #     return if seo_content.present?
+      #     template = SeoTemplate.find_by(template_type: 'BlogPost')
+      #     return if template.blank?
+      #
+      #     self.seo_content = build_seo_content(seo_template: template, slug: slug)
+      #
+      #     Rails.logger.info('Content has been set')
+      #   end
+      class TooManyParagraphs < Cop
+        MSG = 'Organize method into 2 to 3 paragraphs (init, action, result).'
+        MAX_PARAGRAPHS = 3
+
+        def on_def(node)
+          lines = processed_source.lines[node.first_line..(node.last_line - 2)]
+          blank_lines_count = lines.count(&:blank?)
+
+          add_offense(node) if blank_lines_count >= MAX_PARAGRAPHS
+        end
+        alias_method :on_defs, :on_def
+      end
+    end
+  end
+end

data/lib/rubocop/obsession/version.rb

@@ -0,0 +1,5 @@
+module Rubocop
+  module Obsession
+    VERSION = '0.1.0'
+  end
+end

data/lib/rubocop/obsession.rb

@@ -0,0 +1,9 @@
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+require 'rubocop'
+
+require_relative 'cop/mixin/helpers'
+Dir["#{__dir__}/cop/obsession/**/*.rb"].sort.each { |file| require file }
+require_relative 'obsession/version'
+
+RuboCop::ConfigLoader.inject_defaults!("#{__dir__}/../..")

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-obsession
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jerome Dalbert
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+description: A collection of RuboCop cops I have been obsessed with.
+email:
+- jerome.dalbert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- config/default.yml
+- lib/rubocop/cop/mixin/files/verbs.txt
+- lib/rubocop/cop/mixin/helpers.rb
+- lib/rubocop/cop/obsession/graphql/mutation_name.rb
+- lib/rubocop/cop/obsession/method_order.rb
+- lib/rubocop/cop/obsession/no_break_or_next.rb
+- lib/rubocop/cop/obsession/no_paragraphs.rb
+- lib/rubocop/cop/obsession/no_todos.rb
+- lib/rubocop/cop/obsession/rails/callback_one_method.rb
+- lib/rubocop/cop/obsession/rails/fully_defined_json_field.rb
+- lib/rubocop/cop/obsession/rails/migration_belongs_to.rb
+- lib/rubocop/cop/obsession/rails/no_callback_conditions.rb
+- lib/rubocop/cop/obsession/rails/private_callback.rb
+- lib/rubocop/cop/obsession/rails/safety_assured_comment.rb
+- lib/rubocop/cop/obsession/rails/service_name.rb
+- lib/rubocop/cop/obsession/rails/service_perform_method.rb
+- lib/rubocop/cop/obsession/rails/short_after_commit.rb
+- lib/rubocop/cop/obsession/rails/short_validate.rb
+- lib/rubocop/cop/obsession/rails/validate_one_field.rb
+- lib/rubocop/cop/obsession/rails/validation_method_name.rb
+- lib/rubocop/cop/obsession/rspec/describe_public_method.rb
+- lib/rubocop/cop/obsession/rspec/empty_line_after_final_let.rb
+- lib/rubocop/cop/obsession/too_many_paragraphs.rb
+- lib/rubocop/obsession.rb
+- lib/rubocop/obsession/version.rb
+homepage: https://github.com/jeromedalbert/rubocop-obsession
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jeromedalbert/rubocop-obsession
+  source_code_uri: https://github.com/jeromedalbert/rubocop-obsession
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Code style checking for Ruby files.
+test_files: []