String to integer mapping for PostgreSQL array columns
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
test
.gitignore
.travis.yml
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
array_enum.gemspec

README.md

ArrayEnum

Extension for ActiveRecord that adds support for PostgreSQL array columns, mapping string values to integers.

Installation

gem install array_enum or use Gemfile with bundler

Usage

ActiveRecord extension

Database will store integers that after reading will map to string values. Additionally scope is generated with with_ prefix that will query database for any matching passed value.

ActiveRecord::Schema.define do
  create_table :users, force: true do |t|
    t.integer :favourite_colors, array: true, null: false, default: []
  end
end

class User < ActiveRecord::Base
  extend ArrayEnum

  array_enum favourite_colors: {"red" => 1, "blue" => 2}
end

user = User.create!(favourite_colors: ["red", "green"])
user.favourite_colors # => ["red", "green"]
User.with_favourite_colors("red") # => [user]

Subset Validator

Additionally subset validator is provided that can help to ensure correct values are passed during validation.

class CreateUser
  include ActiveModel::Model

  attr_accessor :favourite_colors

  validates :favourite_colors, subset: ["green", "blue"]
end

CreateUser.new(favourite_colors: ["black"]).valid? # => false

Development

Build Status

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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/freeletics/array_enum.

License

The gem is available as open source under the terms of the MIT License.