Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brightcommerce/attr_array
A high performance concern for Rails using the PostgreSQL array type.
https://github.com/brightcommerce/attr_array
activerecord activesupport array concern postgresql tags
Last synced: 9 days ago
JSON representation
A high performance concern for Rails using the PostgreSQL array type.
- Host: GitHub
- URL: https://github.com/brightcommerce/attr_array
- Owner: brightcommerce
- License: mit
- Created: 2017-11-06T08:03:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-23T13:08:16.000Z (almost 7 years ago)
- Last Synced: 2024-04-23T13:18:47.227Z (7 months ago)
- Topics: activerecord, activesupport, array, concern, postgresql, tags
- Language: Ruby
- Size: 5.86 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# AttrArray
A high performance ActiveRecord concern for Rails using the PostgreSQL array type.
## Installation
To install add the line to your Gemfile:
```ruby
gem 'attr_array'
```
And `bundle install`.
## Dependencies
AttrArray is developed as a ActiveRecord model concern, therefore it is dependent upon ActiveSupport. It is also developed only for use with PostgreSQL. It may work with other databases, but I haven't tried them.
## How To Use
To add AttrArray to a model, include the concern:
```ruby
class Post < ActiveRecord::Base
include AttrArray
attr_array :tags
end
```
To autoload AttrArray for all models, add the following to an initializer:
```ruby
require 'attr_array/active_record'
```
You then don't need to `include AttrArray` in any model.
### Scopes
```ruby
with_any_#{tag_name}
with_all_#{tag_name}
without_any_#{tag_name}
without_all_#{tag_name}
```
### Class methods
```ruby
all_#{tag_name}
{tag_name}_cloud
```
### Setup
Add the model attributes you want to use with AttrArray in your migration:
```ruby
class CreatePost < ActiveRecord::Migration[5.1]
def change
create_table :posts do |table|
table.column :tags, :string, array: true, default: [], index: {using: 'gin'}
table.column :authors, :string, array: true, default: [], index: {using: 'gin'}
table.timestamps
end
end
end
```
You can nominate multiple attributes in the `attr_array` class method:
```ruby
class Post < ApplicationRecord
include AttrArray
attr_array :tags, :authors
end
```
### Usage
```ruby
@post.tags = ["awesome", "slick"]
@post.authors = ["Roald Dahl"]
Post.with_any_authors("Roald Dahl")
Post.without_any_tags("slick")
```
## Acknowledgements
This gem is based on code from [pg_tags](https://github.com/yosriady/pg_tags). Modified to use ActiveSupport::Concern and doesn't automatically hook into ActiveRecord.
This gem is maintained by [Jurgen Jocubeit](https://github.com/JurgenJocubeit).
## Copyright
Copyright 2017 Brightcommerce, Inc. All rights reserved.