rubocop-callback_checker 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e884e5e21fa07e119f9f4b418e405be6611d2d5c0b696da5bdded094dd31455
-  data.tar.gz: a86502267af368a6d0922a46984190fb68b9f1e7a6523516b9695ce63c23f5b8
+  metadata.gz: b18d1882a23fe18befff3bb4fe0760099a3903fee3af4e960fe76ea4fdf8e099
+  data.tar.gz: 641a5f598be2759bb728a30e4cc409f747c932849327f4ea7b0be1f6439f5e3c
 SHA512:
-  metadata.gz: 6b893a0fe683cee9c9d8d8e636a10198b6fcd16c23358598c6983cb800cc7d68424a40dc334e9947853db463f8ceca043c6786b42b46a172ef1379802055a7de
-  data.tar.gz: 33aea6ae0240e55f7dfb902079679d704059ae2e00fa04f2a7b0968e1a73fa3a8ea3e51ef0bfa5d7d550d38bac804113aec35cc0254fac8a7737291a0ee73a13
+  metadata.gz: 762044ec4f25d593b2244bf72530c13f21841472a9ead75fd05a245f83755b580338edf96d10dae9497685d6a5595fe97deb5dab9f31c75f3ab173cbc910f621
+  data.tar.gz: bc79ee42e225d79eff6afbc277139b137f8c03231958dacb3d8921d4b59c3bcac26f3e43239b357dfc41f7e18b07aa54c468b90ed058cd5206b6514394612b96

data/.rubocop.yml

@@ -1,2 +1,61 @@
-require:
+plugins:
   - rubocop-callback_checker
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+# The entry point file must be named rubocop-callback_checker.rb to match the gem name
+Naming/FileName:
+  Exclude:
+    - 'lib/rubocop-callback_checker.rb'
+
+# Allow longer blocks in spec files
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'rubocop-callback_checker.gemspec'
+
+# Allow some cops to have longer methods due to RuboCop's pattern matching requirements
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/rubocop/cop/**/*'
+    - 'lib/callback_checker/prism_analyzer.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/rubocop/cop/**/*'
+    - 'lib/callback_checker/cli.rb'
+    - 'lib/callback_checker/prism_analyzer.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/rubocop/cop/**/*'
+    - 'lib/callback_checker/prism_analyzer.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/rubocop/cop/**/*'
+    - 'lib/callback_checker/prism_analyzer.rb'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/rubocop/cop/**/*'
+    - 'lib/callback_checker/prism_analyzer.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/callback_checker/prism_analyzer.rb'
+
+Lint/UselessMethodDefinition:
+  Exclude:
+    - 'lib/callback_checker/prism_analyzer.rb'
+
+Layout/LineLength:
+  Max: 160
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/README.md

@@ -12,14 +12,12 @@ Install the gem and add to the application's Gemfile by executing:
 
 ```bash
 bundle add rubocop-callback_checker
-
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
 gem install rubocop-callback_checker
-
 ```
 
 ---
@@ -29,16 +27,38 @@ gem install rubocop-callback_checker
 In your `.rubocop.yml`, add the following:
 
 ```yaml
-require:
+# Modern method (RuboCop 1.72+)
+plugins:
   - rubocop-callback_checker
 
+# Alternative method (older RuboCop versions)
+require:
+  - rubocop-callback_checker
 ```
 
 You can then run RuboCop as usual:
 
 ```bash
 bundle exec rubocop
+```
+
+The gem will automatically load all callback checker cops with their default configurations.
+
+---
 
+## Configuration
+
+All cops are enabled by default with reasonable settings. You can customize them in your `.rubocop.yml`:
+
+```yaml
+plugins:
+  - rubocop-callback_checker
+
+CallbackChecker/CallbackMethodLength:
+  Max: 10  # Default is 5
+
+CallbackChecker/NoSideEffectsInCallbacks:
+  Enabled: false  # Disable if needed
 ```
 
 ---
@@ -54,13 +74,53 @@ If a side effect (like sending an email) triggers in an `after_save` but the tra
 * **Bad:** Calling `UserMailer.welcome.deliver_now` in `after_create`.
 * **Good:** Use `after_commit` or `after_create_commit`.
 
-### 2. `CallbackChecker/NoSelfPersistence`
+**Example:**
+
+```ruby
+# bad
+class User < ApplicationRecord
+  after_create { UserMailer.welcome(self).deliver_now }
+end
+
+# good
+class User < ApplicationRecord
+  after_create_commit { UserMailer.welcome(self).deliver_now }
+end
+```
+
+---
+
+### 2. `CallbackChecker/AvoidSelfPersistence`
 
 **Goal:** Prevent infinite recursion and "Stack Level Too Deep" errors.
 
 * **Bad:** Calling `self.save` or `update(status: 'active')` inside a `before_save`.
 * **Good:** Assign attributes directly: `self.status = 'active'`.
 
+**Example:**
+
+```ruby
+# bad
+class User < ApplicationRecord
+  before_save :activate
+  
+  def activate
+    self.update(status: 'active')  # triggers before_save again!
+  end
+end
+
+# good
+class User < ApplicationRecord
+  before_save :activate
+  
+  def activate
+    self.status = 'active'  # will be saved automatically
+  end
+end
+```
+
+---
+
 ### 3. `CallbackChecker/AttributeAssignmentOnly`
 
 **Goal:** Reduce unnecessary database I/O.
@@ -70,21 +130,94 @@ Callbacks that run "before" persistence should only modify the object's memory s
 * **Bad:** `before_validation { update(attr: 'val') }`
 * **Good:** `before_validation { self.attr = 'val' }`
 
+**Example:**
+
+```ruby
+# bad
+class User < ApplicationRecord
+  before_save :normalize_email
+  
+  def normalize_email
+    update(email: email.downcase)  # unnecessary extra query
+  end
+end
+
+# good
+class User < ApplicationRecord
+  before_save :normalize_email
+  
+  def normalize_email
+    self.email = email.downcase  # just modifies in memory
+  end
+end
+```
+
+---
+
 ### 4. `CallbackChecker/CallbackMethodLength`
 
 **Goal:** Prevent "Fat Models" and maintain testability.
 
 Callbacks should be "post-it notes," not "instruction manuals." If a callback method is too long, it should be moved to a Service Object.
 
-* **Default Max:** 10 lines.
+* **Default Max:** 5 lines (configurable).
+
+**Example:**
+
+```ruby
+# bad
+class User < ApplicationRecord
+  after_create :setup_account
+  
+  def setup_account
+    # 20 lines of complex logic...
+    create_default_settings
+    send_welcome_email
+    notify_admin
+    create_billing_account
+    # ...
+  end
+end
+
+# good
+class User < ApplicationRecord
+  after_create_commit :setup_account
+  
+  def setup_account
+    AccountSetupService.new(self).call
+  end
+end
+```
+
+---
 
-### 5. `CallbackChecker/SymbolicConditionals`
+### 5. `CallbackChecker/ConditionalStyle`
 
 **Goal:** Improve readability and allow for easier debugging.
 
 * **Bad:** `before_save :do_thing, if: -> { status == 'active' && !deleted? }`
 * **Good:** `before_save :do_thing, if: :active_and_present?`
 
+**Example:**
+
+```ruby
+# bad
+class User < ApplicationRecord
+  before_save :do_thing, if: -> { status == 'active' && !deleted? }
+end
+
+# good
+class User < ApplicationRecord
+  before_save :do_thing, if: :active_and_present?
+  
+  private
+  
+  def active_and_present?
+    status == 'active' && !deleted?
+  end
+end
+```
+
 ---
 
 ## Development
@@ -95,11 +228,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/](https://github.com/)[USERNAME]/rubocop-callback_checker.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rahsheen/rubocop-callback_checker.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ---
-

data/lib/rubocop/callback_checker/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module CallbackChecker
+    # A plugin that integrates RuboCop CallbackChecker with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-callback_checker',
+          version: VERSION,
+          homepage: 'https://github.com/rahsheen/rubocop-callback_checker',
+          description: 'A RuboCop extension focused on avoiding callback hell in Rails.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/callback_checker/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module CallbackChecker
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/lib/rubocop/callback_checker.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'callback_checker/version'
+require_relative 'callback_checker/plugin'
 require 'pathname'
 
 module RuboCop

data/lib/rubocop/cop/cops.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'callback_checker/no_side_effects_in_callbacks'
 require_relative 'callback_checker/avoid_self_persistence'
 require_relative 'callback_checker/attribute_assignment_only'

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-callback_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - rahsheen
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2026-03-14 00:00:00.000000000 Z
+date: 2026-03-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  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.0'
+        version: 1.72.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.72.0
 - !ruby/object:Gem::Dependency
   name: rubocop-ast
   requirement: !ruby/object:Gem::Requirement
@@ -111,8 +125,7 @@ dependencies:
 description: A RuboCop extension focused on avoiding callback hell in Rails.
 email:
 - rahsheen.porter@gmail.com
-executables:
-- rubocop-callback-checker
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -124,11 +137,9 @@ files:
 - README.md
 - Rakefile
 - config/default.yml
-- exe/rubocop-callback-checker
-- lib/callback_checker/cli.rb
-- lib/callback_checker/prism_analyzer.rb
 - lib/rubocop-callback_checker.rb
 - lib/rubocop/callback_checker.rb
+- lib/rubocop/callback_checker/plugin.rb
 - lib/rubocop/callback_checker/version.rb
 - lib/rubocop/cop/callback_checker/attribute_assignment_only.rb
 - lib/rubocop/cop/callback_checker/avoid_self_persistence.rb
@@ -146,6 +157,8 @@ metadata:
   homepage_uri: https://github.com/rahsheen/rubocop-callback_checker
   source_code_uri: https://github.com/rahsheen/rubocop-callback_checker
   changelog_uri: https://github.com/rahsheen/rubocop-callback_checker/blob/main/CHANGELOG.md
+  default_lint_roller_plugin: RuboCop::CallbackChecker::Plugin
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -164,5 +177,5 @@ requirements: []
 rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: rubocop
+summary: RuboCop extension for checking ActiveRecord callbacks
 test_files: []

data/exe/rubocop-callback-checker

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative '../lib/callback_checker/cli'
-
-exit CallbackChecker::CLI.run(ARGV)

data/lib/callback_checker/cli.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'prism_analyzer'
-require_relative '../rubocop/callback_checker/version'
-require 'optparse'
-
-module CallbackChecker
-  VERSION = RuboCop::CallbackChecker::VERSION
-
-  class CLI
-    def self.run(argv)
-      new(argv).run
-    end
-
-    def initialize(argv)
-      @argv = argv
-      @paths = []
-      @options = {}
-    end
-
-    def run
-      parse_options
-
-      if @paths.empty?
-        puts 'Usage: rubocop-callback-checker [options] FILE...'
-        puts "Try 'rubocop-callback-checker --help' for more information."
-        return 1
-      end
-
-      files = collect_files(@paths)
-
-      if files.empty?
-        puts 'No Ruby files found to analyze.'
-        return 1
-      end
-
-      total_offenses = 0
-
-      files.each do |file|
-        offenses = PrismAnalyzer.analyze_file(file)
-
-        if offenses.any?
-          total_offenses += offenses.size
-          print_offenses(file, offenses)
-        end
-      end
-
-      print_summary(files.size, total_offenses)
-
-      total_offenses.positive? ? 1 : 0
-    end
-
-    private
-
-    def parse_options
-      OptionParser.new do |opts|
-        opts.banner = 'Usage: rubocop-callback-checker [options] FILE...'
-
-        opts.on('-h', '--help', 'Print this help') do
-          puts opts
-          exit 0
-        end
-
-        opts.on('-v', '--version', 'Print version') do
-          puts "rubocop-callback-checker version #{VERSION}"
-          exit 0
-        end
-      end.parse!(@argv)
-
-      @paths = @argv
-    end
-
-    def collect_files(paths)
-      files = []
-
-      paths.each do |path|
-        if File.file?(path)
-          files << path if path.end_with?('.rb')
-        elsif File.directory?(path)
-          files.concat(Dir.glob(File.join(path, '**', '*.rb')))
-        else
-          warn "Warning: #{path} is not a file or directory"
-        end
-      end
-
-      files
-    end
-
-    def print_offenses(file, offenses)
-      puts "\n#{file}"
-
-      offenses.each do |offense|
-        location = offense[:location]
-        puts "  #{location[:start_line]}:#{location[:start_column]}: #{offense[:message]}"
-        puts "    #{offense[:code]}"
-      end
-    end
-
-    def print_summary(file_count, offense_count)
-      puts "\n#{'=' * 80}"
-      puts "#{file_count} file(s) inspected, #{offense_count} offense(s) detected"
-    end
-  end
-end

data/lib/callback_checker/prism_analyzer.rb

@@ -1,246 +0,0 @@
-# frozen_string_literal: true
-
-require 'prism'
-
-module CallbackChecker
-  class PrismAnalyzer < Prism::Visitor
-    attr_reader :offenses
-
-    SIDE_EFFECT_SENSITIVE_CALLBACKS = %i[
-      before_validation before_save after_save
-      before_create after_create
-      before_update after_update
-      before_destroy after_destroy
-      around_save around_create around_update around_destroy
-    ].freeze
-
-    SAFE_CALLBACKS = %i[
-      after_commit after_create_commit after_update_commit
-      after_destroy_commit after_save_commit after_rollback
-    ].freeze
-
-    SUSPICIOUS_CONSTANTS = %w[
-      RestClient Faraday HTTParty Net Sidekiq ActionCable
-    ].freeze
-
-    SIDE_EFFECT_METHODS = %i[
-      deliver_later deliver_now perform_later broadcast_later
-      save save! update update! destroy destroy! create create!
-      delete delete_all destroy_all update_all update_columns touch
-    ].freeze
-
-    def initialize(source)
-      @source = source
-      @offenses = []
-      @current_class = nil
-      @callback_methods = {}
-      @current_callback_type = nil
-    end
-
-    def visit_class_node(node)
-      previous_class = @current_class
-      previous_methods = @callback_methods.dup
-
-      @current_class = node
-      @callback_methods = {}
-
-      # First pass: collect all method definitions
-      collect_methods(node)
-
-      # Second pass: check callbacks
-      super
-
-      @current_class = previous_class
-      @callback_methods = previous_methods
-    end
-
-    def visit_call_node(node)
-      if callback_declaration?(node)
-        check_callback(node)
-      elsif @current_callback_type && side_effect_call?(node)
-        add_offense(node, @current_callback_type)
-      end
-
-      super
-    end
-
-    def visit_if_node(node)
-      # Make sure we visit all branches of conditionals
-      super
-    end
-
-    def visit_unless_node(node)
-      # Make sure we visit all branches of unless statements
-      super
-    end
-
-    private
-
-    def collect_methods(class_node)
-      class_node.body&.body&.each do |statement|
-        @callback_methods[statement.name] = statement if statement.is_a?(Prism::DefNode)
-      end
-    end
-
-    def callback_declaration?(node)
-      return false unless node.receiver.nil?
-      return false unless node.name
-
-      callback_name = node.name
-      SIDE_EFFECT_SENSITIVE_CALLBACKS.include?(callback_name) ||
-        SAFE_CALLBACKS.include?(callback_name)
-    end
-
-    def check_callback(node)
-      callback_name = node.name
-
-      # Skip safe callbacks
-      return if SAFE_CALLBACKS.include?(callback_name)
-
-      if node.block
-        # Block form: before_save do ... end
-        check_block_callback(node, callback_name)
-      elsif node.arguments
-        # Symbol form: before_save :method_name
-        check_symbol_callback(node, callback_name)
-      end
-    end
-
-    def check_block_callback(node, callback_name)
-      previous_callback = @current_callback_type
-      @current_callback_type = callback_name
-
-      visit(node.block)
-
-      @current_callback_type = previous_callback
-    end
-
-    def check_symbol_callback(node, callback_name)
-      return unless node.arguments&.arguments
-
-      node.arguments.arguments.each do |arg|
-        next unless arg.is_a?(Prism::SymbolNode)
-
-        method_name = arg.value
-        method_def = @callback_methods[method_name.to_sym]
-
-        next unless method_def
-
-        check_method_for_side_effects(method_def, callback_name)
-      end
-    end
-
-    def check_method_for_side_effects(method_node, callback_name)
-      previous_callback = @current_callback_type
-      @current_callback_type = callback_name
-
-      visit(method_node.body) if method_node.body
-
-      @current_callback_type = previous_callback
-    end
-
-    def side_effect_call?(node)
-      return false unless node.is_a?(Prism::CallNode)
-
-      # Check for suspicious constant calls (RestClient.get, etc.)
-      if node.receiver.is_a?(Prism::ConstantReadNode)
-        constant_name = node.receiver.name.to_s
-        return true if SUSPICIOUS_CONSTANTS.include?(constant_name)
-
-        # Check for any constant that isn't a known safe pattern
-        # This catches things like NewsletterSDK, CustomAPI, etc.
-        return true if constant_appears_to_be_external_service?(constant_name)
-      end
-
-      # Check for side effect methods
-      method_name = node.name
-      return true if SIDE_EFFECT_METHODS.include?(method_name)
-
-      # Check for mailer patterns (anything ending with Mailer)
-      if node.receiver.is_a?(Prism::ConstantReadNode)
-        constant_name = node.receiver.name.to_s
-        return true if constant_name.end_with?('Mailer')
-      end
-
-      # Check for method chains that end with deliver_now
-      return true if method_name == :deliver_now && node.receiver.is_a?(Prism::CallNode)
-
-      # Check for calls on associations or other objects (not self)
-      return true if node.receiver && !self_reference?(node.receiver) && persistence_method?(method_name)
-
-      # Check for save/update on self or implicit self
-      if (node.receiver.nil? || self_reference?(node.receiver)) && %i[save save! update update!].include?(method_name)
-        return true
-      end
-
-      false
-    end
-
-    def constant_appears_to_be_external_service?(constant_name)
-      # Heuristic: if it's all caps or ends with SDK, API, Client, Service
-      # it's probably an external service
-      return true if constant_name.end_with?('SDK', 'API', 'Client', 'Service')
-      return true if constant_name == constant_name.upcase && constant_name.length > 1
-
-      false
-    end
-
-    def self_reference?(node)
-      node.is_a?(Prism::SelfNode)
-    end
-
-    def persistence_method?(method_name)
-      %i[
-        save save! update update! destroy destroy! create create!
-        delete delete_all destroy_all update_all update_columns touch
-      ].include?(method_name)
-    end
-
-    def add_offense(node, callback_type)
-      location = node.location
-      start_line = location.start_line
-      start_column = location.start_column
-      end_line = location.end_line
-      end_column = location.end_column
-
-      # Extract the source code for this node
-      source_range = location.start_offset...location.end_offset
-      code = @source[source_range]
-
-      @offenses << {
-        message: "Avoid side effects (API calls, mailers, background jobs, or modifying other records) in #{callback_type}. Use `after_commit` instead.",
-        location: {
-          start_line: start_line,
-          start_column: start_column,
-          end_line: end_line,
-          end_column: end_column
-        },
-        code: code,
-        callback_type: callback_type
-      }
-    end
-
-    class << self
-      def analyze_file(path)
-        source = File.read(path)
-        analyze_source(source, path)
-      end
-
-      def analyze_source(source, path = nil)
-        result = Prism.parse(source)
-
-        if result.errors.any?
-          warn "Parse errors in #{path}:" if path
-          result.errors.each do |error|
-            warn "  #{error.message}"
-          end
-          return []
-        end
-
-        analyzer = new(source)
-        analyzer.visit(result.value)
-        analyzer.offenses
-      end
-    end
-  end
-end