# Arel Assist

[![Gem Version](https://badge.fury.io/rb/arel_asssist.svg)](https://badge.fury.io/rb/arel_assist)
[![Contribute](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/coderberry/arel_assist)
[![Maintainability](https://api.codeclimate.com/v1/badges/7f616d89b47b56f132cc/maintainability)](https://codeclimate.com/github/coderberry/arel_assist/maintainability)
[![Test Coverage](https://codecov.io/gh/coderberry/arel_assist/branch/main/graph/badge.svg?token=64VN84C475)](https://codecov.io/gh/coderberry/arel_assist)
[![Tests](https://github.com/coderberry/arel_assist/actions/workflows/tests.yml/badge.svg)](https://github.com/coderberry/arel_assist/actions/workflows/tests.yml)
[![CodeQL](https://github.com/coderberry/arel_assist/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/coderberry/arel_assist/actions/workflows/codeql-analysis.yml)
[![StandardRB](https://github.com/coderberry/arel_assist/actions/workflows/standardrb.yml/badge.svg)](https://github.com/coderberry/arel_assist/actions/workflows/standardrb.yml)
[![GEM Version](https://img.shields.io/gem/v/arel_assist?color=168AFE&include_prereleases&logo=ruby&logoColor=FE1616)](https://rubygems.org/gems/arel_assist)
[![GEM Downloads](https://img.shields.io/gem/dt/arel_assist?color=168AFE&logo=ruby&logoColor=FE1616)](https://rubygems.org/gems/arel_assist)
[![Ruby Style](https://img.shields.io/badge/style-standard-168AFE?logo=ruby&logoColor=FE1616)](https://github.com/testdouble/standard)
[![Twitter Follow](https://img.shields.io/twitter/follow/coderberry?logo=twitter&style=social)](https://twitter.com/coderberry)

Arel helper methods to assist in creating clean, sexy database queries using ActiveRecord and Arel.

## Installation

Install the gem and add to the application's Gemfile by executing:

```bash
$ bundle add arel_assist
```

If bundler is not being used to manage dependencies, install the gem by executing:

```bash
$ gem install arel_assist
```

## Usage

```ruby
require "arel_assist"
```

TODO: Coming soon

## Requirements

Requires ActiveRecord >= 6, < 8

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/[USERNAME]/arel_assist. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/arel_assist/blob/main/CODE_OF_CONDUCT.md).

## License

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

## Code of Conduct

Everyone interacting in the ArelAssist project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/arel_assist/blob/main/CODE_OF_CONDUCT.md).