BrokenRecord
Provides a rake task for scanning your ActiveRecord models and detecting validation errors.
Installation
Add this line to your application's Gemfile:
gem 'broken_record'And then execute:
bundleOr install it yourself as:
gem install broken_recordUsage
To scan all records of all models in your project:
rake broken_record:scanIf you want to scan all records of a specific model (e.g. the User model):
rake broken_record:scan[User]You can also specify a list of models to scan:
rake broken_record:scan[Product,User]Configuration
BrokenRecord provides a configure method with multiple options. Here's an example:
BrokenRecord.configure do |config|
# Skip the Foo and Bar models when scanning.
config.classes_to_skip = [Foo, Bar]
# Set a scope for which models should be validated
config.default_scopes = { Foo => proc { with_bars } }
# The follow block will be called before scanning your records.
# This is useful for skipping validations you want to ignore.
config.before_scan do
User.skip_callback :validate, :before, :user_must_be_active
end
# BrokenRecord uses the parallelize gem to distribute work across
# multiple cores. The following block will be called every time
# the process is forked (useful for re-establishing connections).
config.after_fork do
Rails.cache.reconnect if Rails.cache.respond_to? :reconnect
end
# The compact_output option will report the ids of invalid records
# but it will omit any relevant messages or backtraces.
config.compact_output = true
endContributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request