https://github.com/hopsoft/tag_columns

Fast & simple Rails ActiveRecord model tagging using PostgreSQL's Array datatype
https://github.com/hopsoft/tag_columns

rails ruby ruby-gem ruby-on-rails

Last synced: 10 days ago
JSON representation

Fast & simple Rails ActiveRecord model tagging using PostgreSQL's Array datatype

• Host: GitHub
• URL: https://github.com/hopsoft/tag_columns
• Owner: hopsoft
• License: mit
• Created: 2017-04-13T14:24:55.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-02-12T18:03:34.000Z (almost 4 years ago)
• Last Synced: 2024-12-23T14:42:24.595Z (18 days ago)
• Topics: rails, ruby, ruby-gem, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 20.5 KB
• Stars: 52
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Lines of Code](http://img.shields.io/badge/lines_of_code-89-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)

[![Maintainability](https://api.codeclimate.com/v1/badges/7503486b1bb494b5d976/maintainability)](https://codeclimate.com/github/hopsoft/tag_columns/maintainability)

[![Build Status](http://img.shields.io/travis/hopsoft/tag_columns.svg?style=flat)](https://travis-ci.org/hopsoft/tag_columns)

[![Coverage Status](https://img.shields.io/coveralls/hopsoft/tag_columns.svg?style=flat)](https://coveralls.io/r/hopsoft/tag_columns?branch=master)

[![Downloads](http://img.shields.io/gem/dt/tag_columns.svg?style=flat)](http://rubygems.org/gems/tag_columns)

# TagColumns

Fast & simple Rails ActiveRecord model tagging using [PostgreSQL's](https://www.postgresql.org/) [Array datatype](https://www.postgresql.org/docs/current/static/arrays.html).

*Similar to [acts_as_taggable_on](https://github.com/mbleigh/acts-as-taggable-on) but lighter weight with fewer features.*

*Also, be sure to check out [acts_as_taggable_array_on](https://github.com/tmiyamon/acts-as-taggable-array-on).*

## Use Cases

Assign categories to your database records.

* Assign multiple groups to user records

* Assign categories to blog posts et al.

* etc...

## Quick Start

```ruby

# Gemfile

gem "tag_columns"

```

```ruby

# db/migrate/TIMESTAMP_add_groups_to_user.rb

class AddGroupsToUser < ActiveRecord::Migration[5.0]

  def change

    add_column :users, :groups, :string, array: true, default: [], null: false

    add_index :users, :groups, using: "gin"

  end

end

```

```ruby

# app/models/user.rb

class User < ApplicationRecord

  include TagColumns

  tag_columns :groups

end

```

```ruby

user = User.find(1)

# assigning tags

user.groups << :reader

user.groups << :writer

user.save

# checking tags

is_writer            = user.has_group?(:writer)

is_reader_or_writer  = user.has_any_groups?(:reader, :writer)

is_reader_and_writer = user.has_all_groups?(:reader, :writer)

# finding tagged records

assigned                = User.with_groups

unassigned              = User.without_groups

writers                 = User.with_any_groups(:writer)

non_writers             = User.without_any_groups(:writer)

readers_or_writers      = User.with_any_groups(:reader, :writer)

readers_and_writers     = User.with_all_groups(:reader, :writer)

non_readers_and_writers = User.without_all_groups(:reader, :writer)

# find unique tags across all users

User.unique_groups

# find unique tags for users with the last name 'Smith'

User.unique_groups(last_name: "Smith")

```