Contents

# frozen_string_literal: true

module Decidim
  # A Helper to render scopes, including a global scope, for forms.
  module ScopesHelper
    Option = Struct.new(:id, :name)

    # Checks if the resource should show its scope or not.
    # resource - the resource to analize
    #
    # Returns boolean.
    def has_visible_scopes?(resource)
      try(:current_participatory_space)&.try(:scopes_enabled?) && resource.scope.present? && current_participatory_space.try(:scope)&.id != resource.scope&.id
    end

    # Retrieves the translated name and type for an scope.
    # scope - a Decidim::Scope
    # global_name - text to use when scope is nil
    #
    # Returns a string
    def scope_name_for_picker(scope, global_name)
      if scope
        name = translated_attribute(scope.name)
        name << " (#{translated_attribute(scope.scope_type.name)})" if scope.scope_type
        name
      else
        global_name
      end
    end

    # Renders a scopes picker field in a form.
    # form - FormBuilder object
    # name - attribute name
    #
    # Returns nothing.
    def scopes_picker_field(form, name, root: false)
      root = try(:current_participatory_space)&.scope if root == false
      form.scopes_picker name do |scope|
        { url: decidim.scopes_picker_path(root: root, current: scope&.id, field: form.label_for(name)),
          text: scope_name_for_picker(scope, I18n.t("decidim.scopes.global")) }
      end
    end

    # Renders a scopes picker field in a filter form.
    # form - FilterFormBuilder object
    # name - attribute name
    #
    # Returns nothing.
    def scopes_picker_filter(form, name)
      form.scopes_picker name, multiple: true, legend_title: I18n.t("decidim.scopes.scopes"), label: false do |scope|
        { url: decidim.scopes_picker_path(root: try(:current_participatory_space)&.scope, current: scope&.id, title: I18n.t("decidim.scopes.prompt"), global_value: "global"),
          text: scope_name_for_picker(scope, I18n.t("decidim.scopes.prompt")) }
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
decidim-core-0.9.3	app/helpers/decidim/scopes_helper.rb
decidim-core-0.9.2	app/helpers/decidim/scopes_helper.rb
decidim-core-0.9.1	app/helpers/decidim/scopes_helper.rb
decidim-core-0.9.0	app/helpers/decidim/scopes_helper.rb