Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jhollinger/otr-activerecord
Off The Rails: Use ActiveRecord with Grape, Sinatra, Rack, or anything else!
https://github.com/jhollinger/otr-activerecord
activerecord database-connection
Last synced: 10 days ago
JSON representation
Off The Rails: Use ActiveRecord with Grape, Sinatra, Rack, or anything else!
- Host: GitHub
- URL: https://github.com/jhollinger/otr-activerecord
- Owner: jhollinger
- License: mit
- Created: 2016-07-31T15:08:51.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-08-30T21:04:21.000Z (2 months ago)
- Last Synced: 2024-10-01T08:18:35.991Z (about 1 month ago)
- Topics: activerecord, database-connection
- Language: Ruby
- Size: 84 KB
- Stars: 118
- Watchers: 3
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# otr-activerecord
An easy way to use ActiveRecord "off the rails." Works with Grape, Sinatra, plain old Rack, or even in a boring little script! The defaults are all very Railsy (`config/database.yml`, `db/seeds.rb`, `db/migrate`, etc.), but you can easily change them. (Formerly known as `grape-activerecord`.) Supports:
* ActiveRecord 7.2
* ActiveRecord 7.1
* ActiveRecord 7.0 (new AR features, like encryption, not tested)
* ActiveRecord 6.1
* See older versions of this library for older versions of ActiveRecord
## How to use
#### 1. Add it to your Gemfile
```ruby
gem "otr-activerecord"
```
#### 2. Configure your database connection
After loading your gems, tell `OTR::ActiveRecord` about your database config using *one* of the following examples:
```ruby
OTR::ActiveRecord.configure_from_file! "config/database.yml"
OTR::ActiveRecord.configure_from_url! ENV['DATABASE_URL'] # e.g. postgres://user:pass@host/db
OTR::ActiveRecord.configure_from_hash!(adapter: "postgresql", host: "localhost", database: "db", username: "user", password: "pass", encoding: "utf8", pool: 10, timeout: 5000)
```
**Important note**: `configure_from_file!` won't work as expected if you have already `DATABASE_URL` set as part of your environment variables.
This is because in ActiveRecord when that env variable is set it will merge its properties into the current connection configuration.
#### 3. Connect to your database(s)
If you have a single database (most apps), use this helper:
```ruby
OTR::ActiveRecord.establish_connection!
```
If you're using multiple databases, call your base class(es) instead:
```ruby
MyBase.establish_connection :primary
MyBase.establish_connection :primary_replica
...
```
#### 4. Enable middleware for Rack apps
Add these middlewares in `config.ru`:
```ruby
# Clean up database connections after every request (required)
use OTR::ActiveRecord::ConnectionManagement
# Enable ActiveRecord's QueryCache for every request (optional)
use OTR::ActiveRecord::QueryCache
```
#### 5. Import ActiveRecord tasks into your Rakefile
This will give you most of the standard `db:` tasks you get in Rails. Add it to your `Rakefile`.
```ruby
require "bundler/setup"
load "tasks/otr-activerecord.rake"
namespace :db do
# Some db tasks require your app code to be loaded; they'll expect to find it here
task :environment do
require_relative "app"
end
end
```
Unlike in Rails, creating a new migration is also a rake task. Run `bundle exec rake -T` to get a full list of tasks.
```bash
bundle exec rake db:create_migration[create_widgets]
```
## Advanced options
The defaults for db-related files like migrations, seeds, and fixtures are the same as Rails. If you want to override them, use the following options in your `Rakefile`:
```ruby
OTR::ActiveRecord.db_dir = 'db'
OTR::ActiveRecord.migrations_paths = ['db/migrate']
OTR::ActiveRecord.fixtures_path = 'test/fixtures'
OTR::ActiveRecord.seed_file = 'seeds.rb'
```
## Testing
Testing is fully scripted under the `bin/` directory. Appraisal is used to test against various ActiveRecord versions, and Docker or Podman is used to test against various Ruby versions. The combinations to test are defined in [test/matrix](https://github.com/jhollinger/otr-activerecord/blob/main/test/matrix).
```bash
# Run all tests
bin/testall
# Filter tests
bin/testall ruby-3.3
bin/testall ar-7.1
bin/testall ruby-3.3 ar-7.1
# Run one specific line from test/matrix
bin/test ruby-3.3 ar-7.1 sqlite3
# Run a specific file
bin/test ruby-3.3 ar-7.1 sqlite3 test/configure_test.rb
# Run a specific test
bin/test ruby-3.3 ar-7.1 sqlite3 N=test_configure_from_file
# Use podman
PODMAN=1 bin/testall
```
## License
Licensed under the MIT License
Copyright 2024 Jordan Hollinger