THIS GEM IS NOW DEPRECATED. PLEASE DO NOT USE.

DatabaseSanityChecker

Common database sanity checks.

Installation

Add this line to your application's Gemfile:

gem 'database_sanity_checker', require: false

And then execute:

$ bundle

Or install it yourself as:

$ gem install database_sanity_checker

Usage

You need to write specs that calls the necessary shared example by the description:

# frozen_string_literal: true

require 'rails_helper'
require 'database_sanity_checker'

describe 'Unique indexes' do
  include_examples 'unique index sanity checks'
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tricycle/database_sanity_checker.git.