serialize_attributes

Serialize ActiveModel attributes in JSON using type casting:

class MyModel
  serialize_attributes :settings do
    attribute :user_name, :string
    attribute :subscribed, :boolean, default: false
    attribute :subscriptions, :string, array: true
  end
end

Unlike similar projects like ActiveRecord::TypedStore, underneath this library doesn't use the store interface and instead uses the native type coercion provided by ActiveModel (as long as you have an attribute recognised as a Hash-like object).

Quickstart

Add serialized_atributes to your Gemfile:

$ bundle add serialized_atributes

Next, include SerializeAttributes in your model class (or ApplicationRecord if you want to make it available everywhere). Your model should have a JSON (or JSONB) attribute, for example this one is called settings:

create_table :my_models do |t|
  t.json :settings, null: false, default: {}
end

Then, tell the model what attributes we'll be storing there:

class MyModel < ActiveRecord::Base
  include SerializeAttributes

  serialize_attributes :settings do
    attribute :user_name, :string
    attribute :subscribed, :boolean, default: false
  end
end

Now you can read/write values on the model and they will be automatically cast to and from database values:

record = MyModel.create!(user_name: "Nick")
#=> #<MyModel id: 1, settings: { user_name: "Nick" }>

record.subscribed
#=> false

record.subscribed = true
record
#=> #<MyModel id: 1, settings: { user_name: "Nick", subscribed: true }>

Additionally you can use predicated methods the same way you do with an ActiveRecord's attribute. Indeed behind the curtain we use ActiveRecord::AttributeMethods::Query.

record.subscribed?
#=> false
record.user_name?
#=> true

Getting all of the stored attributes

Default values are not automatically persisted to the database, so there is a helper method to get the full object including default values:

record = MyModel.new(user_name: "Nick")
record.serialized_attributes_on(:settings)
#=> { user_name: "Nick", subscribed: false }

Getting a list of attribute names

If you wish to programmatically get the list of attributes known to a store, you can use .serialized_attribute_names. The list is returned in order of definition:

MyModel.serialized_attribute_names(:settings)
#=> [:user_name, :subscribed]

You can also get a list of the attributes filtered by a type specifier:

MyModel.serialized_attribute_names(:settings, :boolean)
#=> [:subscribed]

Complex types

Underneath, we use the ActiveModel::Type mechanism for type coercion, which means that more complex and custom types are also supported. For an example, take a look at ActiveModel::Type::Value.

The #attribute method has the same interface as ActiveRecord, and supports both symbols and objects for the cast_type:

# An example from the Rails docs:
class MoneyType < ActiveRecord::Type::Integer
  def cast(value)
    if !value.kind_of?(Numeric) && value.include?('$')
      price_in_dollars = value.gsub(/\$/, '').to_f
      super(price_in_dollars * 100)
    else
      super
    end
  end
end

ActiveRecord::Type.register(:money, MoneyType)

class MyModel
  serialize_attributes :settings do
    attribute :price_in_cents, :money
  end
end

Array types

By default, ActiveModel::Attribute does not support Array types, however this library does. The syntax is the same as ActiveRecord::Attribute when using the Postgres adapter:

class MyModel
  serialize_attributes :settings do
    attribute :emails, :string, array: true
  end
end

Please note that the default value for an array attribute is always [].

Enumerated ("enum") types

Since enum types are a common thing when managing external data, there is a special enum type defined by the library:

class MyModel
  serialize_attributes :settings do
    attribute :state, :enum, of: ["open", "closed"]
  end
end

Unlike ActiveRecord::Enum, enums here work by attaching an inclusion validator to your model. So for example, with the above code, I'll get a validation failure by default:

MyModel.new(state: nil).tap(&:valid?).errors
#=> { state: "is not included in the list" }

If you wish to allow nil values in your enum, you should add it to the of collection:

attribute :state, :enum, of: [nil, "open", "closed"]

The column is probably now the source of truth for correct values, so you can also introspect the store to fetch these from elsewhere (e.g. for building documentation):

MyModel.serialized_attributes_store(:settings).enum_options(:state)
#=> ["open", "closed"]

Finally, you can also use complex types within the enum itself, by passing an additional type: attribute. Values will then be cast or deserialized per that type, and the result of the casting is what is validated, e.g:

attribute :state, :enum, of: [nil, true, false], type: :boolean

MyModel.new(state: "f").state
#=> false

Usage with ActiveModel alone

It's also possible to use this library without ActiveRecord:

class MyModel
  include ActiveModel::Model
  include ActiveModel::Attributes
  include SerializeAttributes

  # ActiveModel doesn't include a native Hash type, we can just use the Value
  # type here for demo purposes:
  attribute :settings, ActiveModel::Type::Value

  serialize_attributes :settings do
    attribute :user_name, :string
  end
end

License

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