Using Rails 5 enum with PG array

Question

I'm trying to use Rails' enum with PostgreSQL's array column.

class Post < ActiveRecord::Base
  enum tags: { a: 0, b: 1, c: 2 }, array: true
end

However the above code does not work

Is there any way to using enum on array column like arrtibute supporting array: true?

EDIT

I would like to see that the following test case passes, but actually it fails.

# frozen_string_literal: true

begin
  require "bundler/inline"
rescue LoadError => e
  $stderr.puts "Bundler version 1.10 or later is required. Please update your Bundler"
  raise e
end

gemfile(true) do
  source "https://rubygems.org"

  git_source(:github) { |repo| "https://github.com/#{repo}.git" }

  # Activate the gem you are reporting the issue against.
  gem "activerecord", "5.1.4"
  gem "pg"
end

require "active_record"
require "minitest/autorun"
require "logger"

# Ensure backward compatibility with Minitest 4
Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)

# This connection will do for database-independent bug reports.
ActiveRecord::Base.establish_connection(adapter: "postgresql", database: "test")
ActiveRecord::Base.logger = Logger.new(STDOUT)

ActiveRecord::Schema.define do
  create_table :products, force: true do |t|
    t.integer :type_delivery, default: [], array: true, limit: 8
  end
end

class Product < ActiveRecord::Base
  enum type_delivery: { a: 1, b: 2, c: 3, d: 5 }, array: true
end

class BugTest < Minitest::Test
  def test_array_enum
    product = Product.create!(type_delivery: %w[a b c])
    assert_equal products.type_delivery, %w[a b c]
  end
end

error is:

/usr/local/var/rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.1.4/lib/active_record/enum.rb:172:in `block (2 levels) in enum': undefined method `each_with_index' for true:TrueClass (NoMethodError)
    from /usr/local/var/rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.1.4/lib/active_record/enum.rb:171:in `module_eval'
    from /usr/local/var/rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.1.4/lib/active_record/enum.rb:171:in `block in enum'
    from /usr/local/var/rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.1.4/lib/active_record/enum.rb:154:in `each'
    from /usr/local/var/rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.1.4/lib/active_record/enum.rb:154:in `enum'
    from guides/bug_report_templates/active_record_gem.rb:38:in `<class:Product>'
    from guides/bug_report_templates/active_record_gem.rb:37:in `<main>'

Did you find a solution to this?

user3033467
– user3033467

2018-02-02 17:03:37 +00:00
Commented Feb 2, 2018 at 17:03 — user3033467
– user3033467, Commented Feb 2, 2018 at 17:03

morgoth · Accepted Answer · 2019-01-02 13:32:25Z

7

You can use array_enum gem that was created just for this usecase https://github.com/freeletics/array_enum

answered Jan 2, 2019 at 13:32

morgoth

1,4501 gold badge15 silver badges25 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Marcus Ilgner · Accepted Answer · 2018-10-07 18:35:02Z

2

Since this question is still without answer, this is how it can be done:

First, there is no array: true option on the enum method, just leave it out.

Second, add a custom scope to retrieve the products matching the delivery

scope :with_delivery_type, ->(*delivery_types) do
  normalized = Array(delivery_types).flatten
  where('delivery_types @> ?', "{#{normalized.join(',')}}")
end

Last but not least, I'd recommend using a string or Postgres enum type instead of integer columns. Integer columns are problematic because for one, to read it, one needs the source code of the application that wrote the record (the version at the time of insertion) and second it is unnecessarily hard to remove or replace values.

answered Oct 7, 2018 at 18:35

Marcus Ilgner

7,3093 gold badges34 silver badges46 bronze badges

Comments

codenamev · Accepted Answer · 2018-10-07 19:36:11Z

1

Rails' enum api maps attributes to a single integer column. If you wanted, you could create your own bit mask to support multiple attributes (like is often done with user roles).

I think what you're looking for is the attributes api and you could even implement a custom ActiveRecord::Type to handle validation.

answered Oct 7, 2018 at 19:36

codenamev

2,20818 silver badges25 bronze badges

Comments

gilcierweb · Accepted Answer · 2017-10-26 19:52:31Z

-3

Rails 5++

rails generate migration AddTypeDeliveryToProducts type_delivery:integer

class AddTypeDeliveryToProducts < ActiveRecord::Migration[5.1]
  def change
    add_column :products, :type_delivery, :integer, array:true, default: [], limit: 8
  end
end

class Product < ApplicationRecord
  enum type_delivery: { a: 1, b: 2, c: 3, d: 4 }
end

edited Oct 26, 2017 at 19:52

answered Oct 26, 2017 at 4:26

gilcierweb

2,7621 gold badge18 silver badges16 bronze badges

1 Comment

yskkin Over a year ago

Your code does not work. Please see my edit on the question.

Collectives™ on Stack Overflow

Using Rails 5 enum with PG array

4 Answers 4

Comments

Comments

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related