https://github.com/dsalahutdinov/activerecord-data_integrity
Check data integrity for your ActiveRecord models
https://github.com/dsalahutdinov/activerecord-data_integrity
activerecord activerecord-models consistency constraints dataintegrity foreign-keys notnull rails ruby
Last synced: 9 months ago
JSON representation
Check data integrity for your ActiveRecord models
- Host: GitHub
- URL: https://github.com/dsalahutdinov/activerecord-data_integrity
- Owner: dsalahutdinov
- License: mit
- Created: 2018-10-17T03:38:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-19T13:28:43.000Z (almost 4 years ago)
- Last Synced: 2025-08-28T11:20:46.402Z (10 months ago)
- Topics: activerecord, activerecord-models, consistency, constraints, dataintegrity, foreign-keys, notnull, rails, ruby
- Language: Ruby
- Homepage:
- Size: 91.8 KB
- Stars: 11
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/rb/activerecord-data_integrity)
[](https://travis-ci.org/dsalahutdinov/activerecord-data_integrity.svg?branch=master)
# ActiveRecord::DataIntegrity
Checks your ActiveRecord models to match data integrity principles and rules.
Out of the box it detects many issues such as the lack of foreign keys.
## Intallation
```ruby
group :development do
...
gem 'activerecord-data_integrity', require: false
end
```
## Quickstart
Run `data_integrity` CLI-tool in your Rails project's folder:
```bash
cd ~/amplifr
bundle exec data_integrity
```
It will load the Rails application, check the data integrity issues and give the similar output:
```
BelongsTo/ForeignKey: Label belongs_to project but has no foreign key to projects.id
Accordance/TablePresence: Stat::Hourly has no underlying table hourly_stats
...
```
## Options
Check only specified database rules with `--only` options:
```
bundle exec data_integrity --only HasMany/ForeignKey,BelongsTo/ForeignKey
```
Check only specified model with the list of the model full with:
```sh
bundle exec data_integrity --only HasMany/ForeignKye Billing::Account User
```
## Supported Issues
For now tool checks the following issues:
- [x] The lack of database foreign keys for belongs_to/has_many associations (`HasMany/ForeignKey` and `BelongsTo/ForeignKey` rule)
- [x] The lack of not-null constraint for the columns with presence validation (`Validation/Presence` rule)
- [x] Inclusion validated colums should have `enum` data type (`Validation/Inclusion` rule)
## Roadmap (TODO & Help Wanted)
1) Support extra database issues, such as:
- [ ] presence of `dependend` option set for association and not confliction with underlying `ON DELETE` option of foreign key contraint
- [ ] check for foreign keys to have bigint data type
- [ ] presence of index for the foreign keys search
- [ ] checks for paranoia models and indexes exclusion "removed" rows
2) Config for exluding some rules for the specific models (rubocop like)
3) Autofix for the fixing the issue, mostly by generating safe migrations
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activerecord-data_integrity.
## Run tests
The easiest way to tests up and running is to use handy [dip](https://github.com/bibendi/dip) gem with Docker and Docker Compose:
```bash
gem install dip
git checkout git@github.com:dsalahutdinov/activerecord-data_integrity.git
cd activerecord-data_integrity
dip provision
dip rspec
```
Otherwise (without Docker) set up environment manually:
```bash
git checkout git@github.com:dsalahutdinov/activerecord-data_integrity.git
cd activerecord-data_integrity
bundle install
bundle appraisal
DB_HOST=localhost DB_NAME=testdb DB_USERNAME=postgres bundle appraisal rspec
```
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).