Class: ActiveJob::Serializers::ObjectSerializer

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
activejob/lib/active_job/serializers/object_serializer.rb

Overview

Base class for serializing and deserializing custom objects.

Example:

class MoneySerializer < ActiveJob::Serializers::ObjectSerializer
  def serialize(money)
    super("amount" => money.amount, "currency" => money.currency)
  end

  def deserialize(hash)
    Money.new(hash["amount"], hash["currency"])
  end

  private

    def klass
      Money
    end
end

Instance Method Summary collapse

Instance Method Details

#deserialize(json) ⇒ Object

Deserializes an argument from a JSON primitive type.

Raises:

  • (NotImplementedError)

42
43
44
# File 'activejob/lib/active_job/serializers/object_serializer.rb', line 42

def deserialize(json)
  raise NotImplementedError
end

#serialize(hash) ⇒ Object

Serializes an argument to a JSON primitive type.


37
38
39
# File 'activejob/lib/active_job/serializers/object_serializer.rb', line 37

def serialize(hash)
  { Arguments::OBJECT_SERIALIZER_KEY => self.class.name }.merge!(hash)
end

#serialize?(argument) ⇒ Boolean

Determines if an argument should be serialized by a serializer.

Returns:

  • (Boolean)

32
33
34
# File 'activejob/lib/active_job/serializers/object_serializer.rb', line 32

def serialize?(argument)
  argument.is_a?(klass)
end