Class: Decidim::Exporters::Serializer

Inherits:

Object

• Object
• Decidim::Exporters::Serializer

Defined in:

app/serializers/decidim/exporters/serializer.rb

Overview

This is an abstract class with a very naive default implementation for the exporters to use. It can also serve as a superclass of your own implementation.

It is used to be run against each element of an exportable collection in order to extract relevant fields. Every export should specify their own serializer or this default will be used.

Direct Known Subclasses

DataPortabilitySerializers::DataPortabilityConversationSerializer, DataPortabilitySerializers::DataPortabilityFollowSerializer, DataPortabilitySerializers::DataPortabilityIdentitySerializer, DataPortabilitySerializers::DataPortabilityNotificationSerializer, DataPortabilitySerializers::DataPortabilityParticipatorySpacePrivateUserSerializer, DataPortabilitySerializers::DataPortabilityReportSerializer, DataPortabilitySerializers::DataPortabilityUserGroupSerializer, DataPortabilitySerializers::DataPortabilityUserSerializer, ParticipatorySpaceComponentsSerializer

Instance Attribute Summary

• #resource ⇒ Object readonly

  Returns the value of attribute resource.

Instance Method Summary

• #initialize(resource) ⇒ Serializer constructor

  Initializes the serializer with a resource.

• #serialize ⇒ Object

  Public: Returns a serialized view of the provided resource.

Constructor Details

#initialize(resource) ⇒ Serializer

Initializes the serializer with a resource.

resource - The Object to serialize.

# File 'app/serializers/decidim/exporters/serializer.rb', line 18

def initialize(resource)
  @resource = resource
end

Instance Attribute Details

#resource ⇒ Object (readonly)

Returns the value of attribute resource.

# File 'app/serializers/decidim/exporters/serializer.rb', line 13

def resource
  @resource
end

Instance Method Details

#serialize ⇒ Object

Public: Returns a serialized view of the provided resource.

Returns a nested Hash with the fields.

# File 'app/serializers/decidim/exporters/serializer.rb', line 25

def serialize
  @resource.to_h
end