thombruce/activerecord-chemistry

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# ActiveRecord::Chemistry

[![CircleCI](https://img.shields.io/circleci/project/github/thombruce/activerecord-chemistry.svg)](https://circleci.com/gh/thombruce/activerecord-chemistry) [![Coveralls](https://img.shields.io/coveralls/thombruce/activerecord-chemistry.svg)](https://coveralls.io/github/thombruce/activerecord-chemistry) [![Gemnasium](https://img.shields.io/gemnasium/thombruce/activerecord-chemistry.svg)](https://gemnasium.com/github.com/thombruce/activerecord-chemistry) [![Code Climate](https://img.shields.io/codeclimate/github/thombruce/activerecord-chemistry.svg)](https://codeclimate.com/github/thombruce/activerecord-chemistry) [![Beerpay](https://beerpay.io/thombruce/activerecord-chemistry/badge.svg?style=beer)](https://beerpay.io/thombruce/activerecord-chemistry)


Based on and inspired by [ActiveRecord::ActsAs](https://github.com/krautcomputing/active_record-acts_as). For simple multiple table inheritance, use that. ActiveRecord::Chemistry adds more complex relationships and aims to enforce referential integrity.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'activerecord-chemistry'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install activerecord-chemistry

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/thombruce/activerecord-chemistry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).