Module: Decidim::ResourceHelper

Included in:
DownloadYourDataSerializers::DownloadYourDataConversationSerializer, DownloadYourDataSerializers::DownloadYourDataFollowSerializer, DownloadYourDataSerializers::DownloadYourDataIdentitySerializer, DownloadYourDataSerializers::DownloadYourDataNotificationSerializer, DownloadYourDataSerializers::DownloadYourDataParticipatorySpacePrivateUserSerializer, DownloadYourDataSerializers::DownloadYourDataReportSerializer, DownloadYourDataSerializers::DownloadYourDataUserGroupSerializer, DownloadYourDataSerializers::DownloadYourDataUserSerializer, EndorsementButtonsCell, Exporters::ParticipatorySpaceComponentsSerializer, FingerprintCell, FollowButtonCell, ResourceVersionsHelper, ViewModel
Defined in:
app/helpers/decidim/resource_helper.rb

Overview

A Helper to render and link to resources.

Instance Method Summary collapse

Instance Method Details

#linked_classes_filter_values_for(klass) ⇒ Object

Uses the ‘linked_classes_for(klass)` helper method to find the linked classes, and adds a default value to it so that it can be used directly in a form.

Example:

<% if linked_classes_for(klass).any? %>
  <%= form.collection_check_boxes :related_to, linked_classes_filter_values_for(klass), :first, :last %>
<% end %>

klass - The class that will have its linked resources formatted.

Returns an Array of Arrays of Strings.



64
65
66
 
# File 'app/helpers/decidim/resource_helper.rb', line 64

def linked_classes_filter_values_for(klass)
  [["", t("all", scope: "decidim.filters.linked_classes")]] + linked_classes_for(klass)
end

#linked_classes_for(klass) ⇒ Object

Gets the classes linked to the given class for the ‘current_component`, and formats them in a nice way so that they can be used in a form. Resulting format looks like this, considering the given class is related to `Decidim::Meetings::Meeting`:

[["decidim/meetings/meeting", "Meetings"]]

This method is intended to be used as a check to render the filter or not. Use the ‘linked_classes_filter_values_for(klass)` method to get the form filter collection values.

klass - The class that will have its linked resources formatted.

Returns an Array of Arrays of Strings. Returns an empty Array if no links are found.



44
45
46
47
48
49
50
 
# File 'app/helpers/decidim/resource_helper.rb', line 44

def linked_classes_for(klass)
  return [] unless klass.respond_to?(:linked_classes_for)

  klass.linked_classes_for(current_component).map do |k|
    [k.underscore, t(k.demodulize.underscore, scope: "decidim.filters.linked_classes")]
  end
end

#linked_resources_for(resource, type, link_name) ⇒ Object

Renders a collection of linked resources for a resource.

resource - The resource to get the links from. type - The String type fo the resources we want to render. link_name - The String name of the link between the resources.

Example to render the proposals in a meeting view:

linked_resources_for(:meeting, :proposals, "proposals_from_meeting")

Returns nothing.



17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'app/helpers/decidim/resource_helper.rb', line 17

def linked_resources_for(resource, type, link_name)
  linked_resources = resource.linked_resources(type, link_name).group_by { |linked_resource| linked_resource.class.name }

  safe_join(linked_resources.map do |klass, resources|
    resource_manifest = klass.constantize.resource_manifest
    content_tag(:div, class: "section") do
      i18n_name = "#{resource.class.name.demodulize.underscore}_#{resource_manifest.name}"
      content_tag(:h3, I18n.t(i18n_name, scope: "decidim.resource_links.#{link_name}"), class: "section-heading") +
        render(partial: resource_manifest.template, locals: { resources: resources })
    end
  end)
end

#resource_locator(resource) ⇒ Object

Returns an instance of ResourceLocatorPresenter with the given resource



69
70
71
 
# File 'app/helpers/decidim/resource_helper.rb', line 69

def resource_locator(resource)
  ::Decidim::ResourceLocatorPresenter.new(resource)
end

#resource_title(resource) ⇒ Object

Returns a descriptive title for the resource



74
75
76
77
78
 
# File 'app/helpers/decidim/resource_helper.rb', line 74

def resource_title(resource)
  title = resource.try(:title) || resource.try(:name) || resource.try(:subject) || "#{resource.model_name.human} ##{resource.id}"
  title = translated_attribute(title) if title.is_a?(Hash)
  title
end