Module: Decidim::Debates::ApplicationHelper

Includes:
CheckBoxesTreeHelper, Comments::CommentsHelper, Decidim::DateRangeHelper, EndorsableHelper, FollowableHelper, PaginateHelper, RichTextEditorHelper
Defined in:
decidim-debates/app/helpers/decidim/debates/application_helper.rb

Overview

Custom helpers, scoped to the debates engine.

Instance Method Summary collapse

Methods included from Decidim::DateRangeHelper

#format_date_range

Methods included from CheckBoxesTreeHelper

#check_boxes_tree_options, #filter_areas_values, #filter_global_scopes_values, #filter_taxonomy_values_children, #filter_taxonomy_values_for, #filter_text_for, #filter_tree_from_array, #flat_filter_values

Methods included from SanitizeHelper

#decidim_escape_translated, #decidim_html_escape, #decidim_rich_text, #decidim_sanitize, #decidim_sanitize_admin, #decidim_sanitize_editor, #decidim_sanitize_editor_admin, #decidim_sanitize_newsletter, #decidim_sanitize_translated, #decidim_url_escape, included

Methods included from FollowableHelper

#follow_button_for

Methods included from EndorsableHelper

#current_user_can_endorse?, #endorsements_blocked?, #endorsements_enabled?, #path_to_create_endorsement, #path_to_destroy_endorsement, #show_endorsements_card?

Methods included from RichTextEditorHelper

included, #text_editor_for

Methods included from Comments::CommentsHelper

#comments_for, #inline_comments_for

Methods included from PaginateHelper

#decidim_paginate

Instance Method Details

#activity_filter_values ⇒ Object

Options to filter Debates by activity.



55
56
57
 
# File 'decidim-debates/app/helpers/decidim/debates/application_helper.rb', line 55

def activity_filter_values
  %w(all my_debates commented).map { |k| [k, t(k, scope: "decidim.debates.debates.filters")] }
end

#all_filter_text ⇒ Object 



67
68
69
 
# File 'decidim-debates/app/helpers/decidim/debates/application_helper.rb', line 67

def all_filter_text
  t("all", scope: "decidim.debates.debates.filters")
end

#component_name ⇒ Object 



95
96
97
 
# File 'decidim-debates/app/helpers/decidim/debates/application_helper.rb', line 95

def component_name
  (defined?(current_component) && translated_attribute(current_component&.name).presence) || t("decidim.components.debates.name")
end

#filter_debates_state_values ⇒ Object

Returns a TreeNode to be used in the list filters to filter debates by its state.



61
62
63
64
65
 
# File 'decidim-debates/app/helpers/decidim/debates/application_helper.rb', line 61

def filter_debates_state_values
  %w(open closed).map { |k| [k, t(k, scope: "decidim.debates.debates.filters.state_values")] }.prepend(
    ["all", all_filter_text]
  )
end

#filter_origin_values ⇒ Object

Returns a TreeNode to be used in the list filters to filter debates by its origin.



45
46
47
48
49
50
51
52
 
# File 'decidim-debates/app/helpers/decidim/debates/application_helper.rb', line 45

def filter_origin_values
  origin_keys = %w(official participants)

  origin_values = origin_keys.map { |key| [key, t(key, scope: "decidim.debates.debates.filters")] }
  origin_values.prepend(["", all_filter_text])

  filter_tree_from_array(origin_values)
end

#filter_sections ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'decidim-debates/app/helpers/decidim/debates/application_helper.rb', line 71

def filter_sections
  @filter_sections ||= begin
    items = [{
      method: :with_any_state,
      collection: filter_debates_state_values,
      label: t("decidim.meetings.meetings.filters.date"),
      id: "date",
      type: :radio_buttons
    }]
    current_component.available_taxonomy_filters.each do |taxonomy_filter|
      items.append(method: "with_any_taxonomies[#{taxonomy_filter.root_taxonomy_id}]",
                   collection: filter_taxonomy_values_for(taxonomy_filter),
                   label: decidim_sanitize_translated(taxonomy_filter.name),
                   id: "taxonomy-#{taxonomy_filter.root_taxonomy_id}")
    end
    items.append(method: :with_any_origin, collection: filter_origin_values, label: t("decidim.debates.debates.filters.origin"), id: "origin")
    items.append(method: :activity, collection: activity_filter_values, label: t("decidim.debates.debates.filters.activity"), id: "activity") if current_user

    items.reject { |item| item[:collection].blank? }
  end
end

#render_debate_description(debate) ⇒ Object

If the content is safe, HTML tags are sanitized, otherwise, they are stripped.



29
30
31
32
33
34
35
36
 
# File 'decidim-debates/app/helpers/decidim/debates/application_helper.rb', line 29

def render_debate_description(debate)
  sanitized = render_sanitized_content(debate, :description)
  if safe_content?
    Decidim::ContentProcessor.render_without_format(sanitized).html_safe
  else
    Decidim::ContentProcessor.render(sanitized, "div")
  end
end

#safe_content? ⇒ Boolean

If the debate is official or the rich text editor is enabled on the frontend, the debate description is considered as safe content.

Returns:

  • (Boolean) 


18
19
20
 
# File 'decidim-debates/app/helpers/decidim/debates/application_helper.rb', line 18

def safe_content?
  rich_text_editor_in_public_views? || safe_content_admin?
end

#safe_content_admin? ⇒ Boolean

For admin entered content, the debate body can contain certain extra tags, such as iframes.

Returns:

  • (Boolean) 


24
25
26
 
# File 'decidim-debates/app/helpers/decidim/debates/application_helper.rb', line 24

def safe_content_admin?
  debate&.official?
end

#search_variable ⇒ Object 



93
 
# File 'decidim-debates/app/helpers/decidim/debates/application_helper.rb', line 93

def search_variable = :search_text_cont

#text_editor_for_debate_description(form) ⇒ Object

Returns :text_area or :editor based on current_component settings.



39
40
41
 
# File 'decidim-debates/app/helpers/decidim/debates/application_helper.rb', line 39

def text_editor_for_debate_description(form)
  text_editor_for(form, :description)
end