Class: Decidim::Proposals::ProposalSerializer

Inherits:
Exporters::Serializer show all
Includes:
ApplicationHelper, ResourceHelper, TranslationsHelper, HtmlToPlainText
Defined in:
decidim-proposals/lib/decidim/proposals/proposal_serializer.rb

Overview

This class serializes a Proposal so can be exported to CSV, JSON or other formats.

Direct Known Subclasses

DownloadYourDataProposalSerializer

Constant Summary

Constants included from AmendmentsHelper

AmendmentsHelper::TOTAL_STEPS

Instance Method Summary collapse

Methods included from TranslationsHelper

empty_translatable, ensure_translatable, multi_translation, translated_in_current_locale?

Methods included from TranslatableAttributes

#attachment?, #default_locale?

Methods included from ResourceHelper

#linked_classes_filter_values_for, #linked_classes_for, #resource_locator

Methods included from ApplicationHelper

#add_body_classes, #cell, #edit_link, #extra_admin_link, #html_truncate, #layout_item_classes, #present, #prevent_timeout_seconds, #resolve_presenter_class, #text_initials

Methods included from CacheHelper

#cache

Methods included from AmendmentsHelper

#accept_and_reject_buttons_for, #action_button_card_for, #allowed_to_accept_and_reject?, #allowed_to_promote?, #amendments_enabled?, #amendments_form_field_for, #amendments_form_fields_label, #amendments_form_fields_value, #can_participate_in_private_space?, #can_react_to_emendation?, #current_step, #emendation_actions_for, #emendation_announcement_for, #promote_button_for, #render_emendation_body, #total_steps, #wizard_aside_back_url, #wizard_header_title

Methods included from RichTextEditorHelper

included, #text_editor_for

Methods included from ContextualHelpHelper

#floating_help

Methods included from DecidimFormHelper

#areas_for_select, #base_error_messages, #decidim_form_for, #decidim_form_slug_url, #editor_field_tag, #form_field_has_error?, #form_required_explanation, #name_with_locale, #tab_element_class_for, #translated_field_tag

Methods included from OmniauthHelper

#normalize_provider_name, #oauth_icon, #provider_name

Methods inherited from Exporters::Serializer

#event_name, #finalize, #run

Constructor Details

#initialize(proposal) ⇒ ProposalSerializer

Public: Initializes the serializer with a proposal.



14
15
16
 
# File 'decidim-proposals/lib/decidim/proposals/proposal_serializer.rb', line 14

def initialize(proposal)
  @proposal = proposal
end

Instance Method Details

#serialize ⇒ Object

Public: Exports a hash with the serialized data for this proposal.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'decidim-proposals/lib/decidim/proposals/proposal_serializer.rb', line 19

def serialize
  {
    id: proposal.id,
    author: {
      **author_fields
    },
    taxonomies:,
    participatory_space: {
      id: proposal.participatory_space.id,
      url: Decidim::ResourceLocatorPresenter.new(proposal.participatory_space).url
    },
    component: { id: component.id },
    title: proposal.title,
    body: convert_to_plain_text(proposal.body),
    address: proposal.address,
    latitude: proposal.latitude,
    longitude: proposal.longitude,
    state: proposal.state.to_s,
    state_published_at: proposal.state_published_at,
    reference: proposal.reference,
    answer: ensure_translatable(proposal.answer),
    answered_at: proposal.answered_at,
    votes: (proposal.proposal_votes_count unless
    proposal.component.current_settings.votes_hidden?),
    endorsements: {
      total_count: proposal.endorsements.size,
      user_endorsements:
    },
    comments: proposal.comments_count,
    attachments: proposal.attachments.size,
    follows_count: proposal.follows_count,
    published_at: proposal.published_at,
    url:,
    meeting_urls: meetings,
    related_proposals:,
    is_amend: proposal.emendation?,
    original_proposal: {
      title: proposal&.amendable&.title,
      url: original_proposal_url
    },
    withdrawn: proposal.withdrawn?,
    withdrawn_at: proposal.withdrawn_at,
    created_at: proposal.created_at,
    updated_at: proposal.updated_at,
    created_in_meeting: proposal.created_in_meeting,
    coauthorships_count: proposal.coauthorships_count,
    cost: proposal.cost,
    cost_report: proposal.cost_report,
    execution_period: proposal.execution_period
  }
end