rubocop-callback_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27a8d5e0a0b8d6c92ccabe6a928f106fc80a3d438ed07002686f07bf5c3c07c9
+  data.tar.gz: 1bad8a7bb9dcf33f5758655bbdfc208f9849dc75cde2b534dbaedef18e7e31ad
+SHA512:
+  metadata.gz: 222120c9a2df85dc84fd57709c17b52b494f9e05b21a9ae64fc7f94d058595f6aebb3a9a821daad78707de021ff796c7039c73710760fd1c410f43e04a07e04f
+  data.tar.gz: 29893d82a5f907f2d7cf88781864963e169f6c0e22b1bbc0f5615c0101773aa12f6a53a7e6dc5363c61a6849680090aa4edecd33e3edbe01af3130b47fc63bf6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+require:
+  - rubocop-rspec
+
+plugins:
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-12-13
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 rahsheen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# RuboCop::CallbackChecker
+
+A collection of RuboCop cops to ensure your ActiveRecord callbacks are safe, performant, and maintainable.
+
+Banning callbacks entirely is a blunt instrument that slows down development. This gem provides a "surgical" approach—allowing callbacks for internal state management while preventing the most common architectural "gotchas" like recursive loops, phantom API calls, and bloated models.
+
+---
+
+## Installation
+
+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
+
+```
+
+---
+
+## Usage
+
+In your `.rubocop.yml`, add the following:
+
+```yaml
+require:
+  - rubocop-callback_checker
+
+```
+
+You can then run RuboCop as usual:
+
+```bash
+bundle exec rubocop
+
+```
+
+---
+
+## Cops Included
+
+### 1. `CallbackChecker/NoSideEffectsInCallbacks`
+
+**Goal:** Prevent external side effects from running inside a database transaction.
+
+If a side effect (like sending an email) triggers in an `after_save` but the transaction later rolls back, the email is sent for data that doesn't exist.
+
+* **Bad:** Calling `UserMailer.welcome.deliver_now` in `after_create`.
+* **Good:** Use `after_commit` or `after_create_commit`.
+
+### 2. `CallbackChecker/NoSelfPersistence`
+
+**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'`.
+
+### 3. `CallbackChecker/AttributeAssignmentOnly`
+
+**Goal:** Reduce unnecessary database I/O.
+
+Callbacks that run "before" persistence should only modify the object's memory state, not trigger a secondary database write.
+
+* **Bad:** `before_validation { update(attr: 'val') }`
+* **Good:** `before_validation { self.attr = 'val' }`
+
+### 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.
+
+### 5. `CallbackChecker/SymbolicConditionals`
+
+**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?`
+
+---
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/](https://github.com/)[USERNAME]/rubocop-callback_checker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/config/default.yml

@@ -0,0 +1,30 @@
+CallbackChecker:
+  Exclude:
+    - 'db/**/*'
+    - 'config/**/*'
+
+CallbackChecker/NoSideEffectsInCallbacks:
+  Description: 'Disallows logic with side effects (like external APIs or mailers) in before_* and after_save callbacks.'
+  Enabled: true
+  Severity: warning
+
+CallbackChecker/AvoidSelfPersistence:
+  Description: 'Avoid calling persistence methods on self within callbacks to prevent infinite loops.'
+  Enabled: true
+  Severity: warning
+
+CallbackChecker/AttributeAssignmentOnly:
+  Description: 'Use attribute assignment instead of persistence methods in before_* callbacks.'
+  Enabled: true
+  Severity: warning
+
+CallbackChecker/CallbackMethodLength:
+  Description: 'Callback methods should be short. Complex logic belongs in service objects.'
+  Enabled: true
+  Severity: warning
+  Max: 5
+
+CallbackChecker/ConditionalStyle:
+  Description: 'Use named methods instead of procs/strings for callback conditionals.'
+  Enabled: true
+  Severity: warning

data/exe/rubocop-callback-checker

@@ -0,0 +1,6 @@
+#!/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

@@ -0,0 +1,104 @@
+# 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 > 0 ? 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