decidim-core 0.28.1 → 0.29.0.rc1

data/app/helpers/decidim/layout_helper.rb

@@ -3,6 +3,7 @@
 module Decidim
   # View helpers related to the layout.
   module LayoutHelper
+    include Decidim::OrganizationHelper
     include Decidim::ModalHelper
     include Decidim::TooltipHelper
 
@@ -129,28 +130,6 @@ module Decidim
       }
     end
 
-    # Renders a view with the customizable CSS variables in two flavours:
-    # 1. as a hexadecimal valid CSS color (ie: #ff0000)
-    # 2. as a disassembled RGB components (ie: 255 0 0)
-    #
-    # Example:
-    #
-    # --primary: #ff0000;
-    # --primary-rgb: 255 0 0
-    #
-    # Hexadecimal variables can be used as a normal CSS color:
-    #
-    # color: var(--primary)
-    #
-    # While the disassembled variant can be used where you need to manipulate
-    # the color somehow (ie: adding a background transparency):
-    #
-    # background-color: rgba(var(--primary-rgb), 0.5)
-    def organization_colors
-      css = current_organization.colors.each.map { |k, v| "--#{k}: #{v};--#{k}-rgb: #{v[1..2].hex} #{v[3..4].hex} #{v[5..6].hex};" }.join
-      render partial: "layouts/decidim/organization_colors", locals: { css: }
-    end
-
     def current_user_unread_data
       return {} if current_user.blank?
 
@@ -161,22 +140,8 @@ module Decidim
       end
     end
 
-    def organization_description_label
-      @organization_description_label ||= if empty_organization_description?
-                                            t("decidim.pages.home.footer_sub_hero.footer_sub_hero_body_html")
-                                          else
-                                            decidim_sanitize_admin(translated_attribute(current_organization.description))
-                                          end
-    end
-
     private
 
-    def empty_organization_description?
-      organization_description = translated_attribute(current_organization.description)
-
-      organization_description.blank? || organization_description == "<p></p>"
-    end
-
     def tag_builder
       @tag_builder ||= ActionView::Helpers::TagHelper::TagBuilder.new(self)
     end

data/app/helpers/decidim/localized_locales_helper.rb

@@ -21,7 +21,7 @@ module Decidim
     # locales.
     #
     # collection - an Array of Strings. By default it uses all the available
-    #   locales in Decidim, but you can passa nother collection of locales (for
+    #   locales in Decidim, but you can pass another collection of locales (for
     #   example, the available locales for an organization)
     def localized_locales(collection = Decidim.available_locales)
       klass = Class.new do

data/app/helpers/decidim/menu_helper.rb

@@ -43,6 +43,14 @@ module Decidim
       )
     end
 
+    def mobile_breadcrumb_root_menu
+      @mobile_breadcrumb_root_menu ||= ::Decidim::BreadcrumbRootMenuPresenter.new(
+        :mobile_menu,
+        self,
+        container_options: { class: "menu-bar__main-dropdown__menu" }
+      )
+    end
+
     def footer_menu
       @footer_menu ||= ::Decidim::FooterMenuPresenter.new(
         :menu,

data/app/helpers/decidim/meta_tags_helper.rb

@@ -3,13 +3,13 @@
 module Decidim
   # Helper that provides convenient methods to deal with the page meta tags.
   module MetaTagsHelper
-    # Public: Sets the given metatags for the page. It is a wrapper for the individual
+    # Sets the given metatags for the page. It is a wrapper for the individual
     # methods, so that you can set multiple values with a single call. See the docs for
     # the other methods to see how they work.
     #
-    # tags - A Hash containing the meta tag name as keys and its content as values.
+    # @param [Hash] tags - A Hash containing the meta tag name as keys and its content as values.
     #
-    # Returns nothing.
+    # @return [nil]
     def add_decidim_meta_tags(tags)
       add_decidim_page_title(tags[:title])
       add_decidim_meta_description(tags[:description])
@@ -18,9 +18,11 @@ module Decidim
       add_decidim_meta_image_url(add_base_url_to(tags[:image_url]))
     end
 
-    # Public: Add base url to path if path does not include host.
-    # path - A String containing path (e.g. "/proposals/1" )
-    # Returns a String of URL including base URL and path, or path if it is blank.
+    # Add base url to path if path does not include host.
+    #
+    # @parma [String] path - A String containing path (e.g. "/proposals/1" )
+    #
+    # @return [String] - a String of URL including base URL and path, or path if it is blank.
     def add_base_url_to(path)
       return path if path.blank?
       return path if URI.parse(path).host.present?
@@ -28,8 +30,9 @@ module Decidim
       "#{resolve_base_url}#{path}"
     end
 
-    # Public: Resolve base url (example: https://www.decidim.org) without url params
-    # Returns a String of base URL
+    # Resolve base url (example: https://www.decidim.org) without url params
+    #
+    # @return [String] -  a String of base URL
     def resolve_base_url
       return request.base_url if respond_to?(:request) && request&.base_url.present?
 
@@ -41,20 +44,20 @@ module Decidim
       end
     end
 
-    # Public: Accumulates the given `title` so that they can be chained. Since Rails views
-    # are rendered inside-out, `title` is appended to an array. This way the beggining of
+    #  Accumulates the given `title` so that they can be chained. Since Rails views
+    # are rendered inside-out, `title` is appended to an array. This way the beginning of
     # the title will be the most specific one. Use the `decidim_page_title` method to
     # render the title whenever you need to (most surely, in the `<title>` tag in the HTML
     # head and in some `title` metatags).
     #
-    # Example:
+    # @example
     #   add_decidim_page_title("My Process")
     #   add_decidim_page_title("My Organization")
     #   decidim_page_title # => "My Process - My Organization"
     #
-    # title - A String to be added to the title
+    # @param [String] title - A String to be added to the title
     #
-    # Returns an Array of Strings.
+    # @return [Array<String>]
     def add_decidim_page_title(title)
       @decidim_page_title ||= []
       return @decidim_page_title if title.blank?
@@ -62,11 +65,11 @@ module Decidim
       @decidim_page_title << title
     end
 
-    # Public: Renders the title for a page. Use the `add_decidim_page_title` method to
+    # Renders the title for a page. Use the `add_decidim_page_title` method to
     # accumulate elements for the title. Basically, it joins the elements of the title
     # array with `" - "`.
     #
-    # Returns a String.
+    # @return [String]
     def decidim_page_title
       (@decidim_page_title || []).join(" - ")
     end
@@ -80,9 +83,9 @@ module Decidim
     # is the last one to be rendered. You can put there a basic content and override it
     # in other layers.
     #
-    # description - The String to be set as description
+    # @param [String] description - The String to be set as description
     #
-    # Returns nothing.
+    # @return [nil]
     def add_decidim_meta_description(description)
       @decidim_meta_description ||= strip_tags(description)
     end
@@ -93,9 +96,9 @@ module Decidim
     # is the last one to be rendered. You can put there a basic content and override it
     # in other layers.
     #
-    # twitter_handler - The String to be set as Twitter handler
+    # @param [String] twitter_handler - The String to be set as Twitter handler
     #
-    # Returns nothing.
+    # @return [nil]
     def add_decidim_meta_twitter_handler(twitter_handler)
       @decidim_meta_twitter_handler ||= twitter_handler
     end
@@ -106,9 +109,9 @@ module Decidim
     # is the last one to be rendered. You can put there a basic content and override it
     # in other layers.
     #
-    # url - The String to be set as URL
+    # @param [String] url - The String to be set as URL
     #
-    # Returns nothing.
+    # @return [nil]
     def add_decidim_meta_url(url)
       @decidim_meta_url ||= url
     end
@@ -119,9 +122,9 @@ module Decidim
     # is the last one to be rendered. You can put there a basic content and override it
     # in other layers.
     #
-    # image_url - The String to be set as image URL
+    # @param [String] image_url - The String to be set as image URL
     #
-    # Returns nothing.
+    # @return [nil]
     def add_decidim_meta_image_url(image_url)
       @decidim_meta_image_url ||= image_url
     end

data/app/helpers/decidim/modal_helper.rb

@@ -8,7 +8,7 @@ module Decidim
   # you also can add your custom close button through data-dialog-close="<seed>"
   #
   # Options available:
-  #  - id: String. Unique identificator for the dialog, if the page has distinct modal windows (default: "")
+  #  - id: String. Unique identifier for the dialog, if the page has distinct modal windows (default: "")
   #  - class: String. CSS classes for the modal content.
   #  - closable: Boolean. Whether the modal can be closed or not (default: true)
   module ModalHelper

data/app/helpers/decidim/orders_helper.rb

@@ -7,7 +7,7 @@ module Decidim
     # (Note) This method requires the javascript 'decidim/orders' to be
     # present in the page.
     #
-    # orders - An array of order criterias
+    # orders - An array of order criteria
     # options - An optional hash of options
     #         * i18n_scope - The scope of the i18n translations
     def order_selector(orders, options = {})

data/app/helpers/decidim/organization_helper.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Decidim
+  # View helpers related to the organization.
+
+  module OrganizationHelper
+    include Decidim::TranslatableAttributes
+
+    # Renders a view with the customizable CSS variables in two flavours:
+    # 1. as a hexadecimal valid CSS color (ie: #ff0000)
+    # 2. as a disassembled RGB components (ie: 255 0 0)
+    #
+    # Example:
+    #
+    # --primary: #ff0000;
+    # --primary-rgb: 255 0 0
+    #
+    # Hexadecimal variables can be used as a normal CSS color:
+    #
+    # color: var(--primary)
+    #
+    # While the disassembled variant can be used where you need to manipulate
+    # the color somehow (ie: adding a background transparency):
+    #
+    # background-color: rgba(var(--primary-rgb), 0.5)
+    def organization_colors
+      css = current_organization.colors.each.map { |k, v| "--#{k}: #{v};--#{k}-rgb: #{v[1..2].hex} #{v[3..4].hex} #{v[5..6].hex};" }.join
+      render partial: "layouts/decidim/organization_colors", locals: { css: }
+    end
+
+    def organization_description_label
+      @organization_description_label ||= if empty_organization_description?
+                                            t("decidim.pages.home.footer_sub_hero.footer_sub_hero_body_html")
+                                          else
+                                            decidim_sanitize_admin(translated_attribute(current_organization.description))
+                                          end
+    end
+
+    def organization_name(organization = current_organization)
+      translated_attribute(organization.name, organization)
+    end
+
+    def current_organization_name
+      organization_name(current_organization)
+    end
+
+    private
+
+    def empty_organization_description?
+      organization_description = translated_attribute(current_organization.description)
+
+      organization_description.blank? || organization_description == "<p></p>"
+    end
+  end
+end

data/app/helpers/decidim/paginate_helper.rb

@@ -13,7 +13,7 @@ module Decidim
 
       content_tag :div, class: "flex flex-col-reverse md:flex-row items-center justify-between gap-1 py-8 md:py-16", data: { pagination: "" } do
         template = ""
-        template += render partial: "decidim/shared/results_per_page", formats: ["html"] if collection.total_pages.positive?
+        template += render(partial: "decidim/shared/results_per_page", formats: [:html]) if collection.total_pages.positive?
         template += paginate collection, window: 2, outer_window: 1, theme: "decidim", params: paginate_params
         template.html_safe
       end

data/app/helpers/decidim/resource_helper.rb

@@ -47,12 +47,5 @@ module Decidim
 
       ::Decidim::ResourceLocatorPresenter.new(resource)
     end
-
-    # Returns a descriptive title for the resource
-    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
   end
 end

data/app/helpers/decidim/scopes_helper.rb

@@ -9,7 +9,7 @@ module Decidim
     Option = Struct.new(:id, :name)
 
     # Checks if the resource should show its scope or not.
-    # resource - the resource to analize
+    # resource - the resource to analyze
     #
     # Returns boolean.
     def has_visible_scopes?(resource)
@@ -54,10 +54,12 @@ module Decidim
     #
     # Returns nothing.
     def scopes_select_field(form, name, root: false, options: {})
+      options = options.merge(include_blank: I18n.t("decidim.scopes.prompt")) unless options.has_key?(:include_blank)
+
       form.select(
         name,
         ordered_scopes_descendants_for_select(root),
-        options.merge(include_blank: I18n.t("decidim.scopes.prompt"))
+        options
       )
     end
 

data/app/helpers/decidim/searches_helper.rb

@@ -7,7 +7,7 @@ module Decidim
     #
     # klass_name - a String representing the class name of the resource to render
     # count - (optional) the number of resources so that the I18n backend
-    #         can decide to translate into singluar or plural form.
+    #         can decide to translate into singular or plural form.
     def searchable_resource_human_name(resource, count: 5)
       resource = if resource.is_a?(String)
                    resource.constantize

data/app/helpers/decidim/short_link_helper.rb

@@ -15,14 +15,14 @@ module Decidim
     # @option kwargs [Float] :params the URL query parameters that should be
     #   included in the URL where the short link redirects to
     # @return [String] The short URL
-    def short_url(**kwargs)
+    def short_url(**)
       target = respond_to?(:current_component) && current_component
       target ||= respond_to?(:current_participatory_space) && current_participatory_space
       target ||= respond_to?(:current_organization) && current_organization
       target ||= Rails.application
 
       mounted_engine = target.try(:mounted_engine) || EngineResolver.new(_routes).mounted_name
-      ShortLink.to(target, mounted_engine, **kwargs).short_url
+      ShortLink.to(target, mounted_engine, **).short_url
     end
   end
 end

data/app/helpers/decidim/translations_helper.rb

@@ -14,10 +14,10 @@ module Decidim
     # options - Any other option to delegate to the individual I18n.t calls
     #
     # Returns a Hash with the locales as keys and the translations as values.
-    def multi_translation(key, locales = Decidim.available_locales, **options)
+    def multi_translation(key, locales = Decidim.available_locales, **)
       locales.each_with_object({}) do |locale, result|
         I18n.with_locale(locale) do
-          result[locale.to_sym] = I18n.t(key, **options)
+          result[locale.to_sym] = I18n.t(key, **)
         end
       end
     end

data/app/helpers/decidim/twitter_search_helper.rb

@@ -4,7 +4,7 @@ module Decidim
   module TwitterSearchHelper
     # Builds the URL for Twitter's hashtag search.
     #
-    # @param hashtag [String] The hasthag to search
+    # @param hashtag [String] The hashtag to search
     #
     # @return [String]
     def twitter_hashtag_url(hashtag)

data/app/helpers/decidim/user_profile_helper.rb

@@ -14,7 +14,6 @@ module Decidim
     #
     # Returns a String with the menu tab.
     def user_profile_tab(text, link, options = {})
-      cls = %w(tabs-title)
       aria = {}
       if is_active_link?(link, (options[:aria_link_type] || :inclusive))
         cls << "is-active"

data/app/jobs/decidim/email_notifications_digest_generator_job.rb

@@ -8,10 +8,10 @@ module Decidim
       user = Decidim::User.find_by(id: user_id)
       return if user.blank?
 
-      should_notify = force || NotificationsDigestSendingDecider.must_notify?(user, time:)
+      should_notify = force || NotificationsDigestSendingDecider.must_notify?(user, time)
       return unless should_notify
 
-      notification_ids = user.notifications.try(frequency, time:).pluck(:id)
+      notification_ids = user.notifications.try(frequency, time).pluck(:id)
       return if notification_ids.blank?
 
       NotificationsDigestMailer.digest_mail(user, notification_ids).deliver_later

data/app/mailers/decidim/application_mailer.rb

@@ -6,24 +6,62 @@ module Decidim
   class ApplicationMailer < ActionMailer::Base
     include LocalisedMailer
     include MultitenantAssetHost
+    include Decidim::SanitizeHelper
+    include Decidim::OrganizationHelper
+    helper_method :organization_name, :decidim_escape_translated, :decidim_sanitize_translated, :translated_attribute, :decidim_sanitize, :decidim_sanitize_newsletter
+
     after_action :set_smtp
+    after_action :set_from
 
     default from: Decidim.config.mailer_sender
     layout "decidim/mailer"
 
     private
 
+    attr_reader :organization
+
     def set_smtp
-      return if @organization.nil? || @organization.smtp_settings.blank?
+      return if organization.nil? || organization.smtp_settings.blank? || organization.smtp_settings.except("from", "from_label", "from_email").all?(&:blank?)
 
-      mail.from = @organization.smtp_settings["from"].presence || mail.from
       mail.reply_to = mail.reply_to || Decidim.config.mailer_reply
       mail.delivery_method.settings.merge!(
-        address: @organization.smtp_settings["address"],
-        port: @organization.smtp_settings["port"],
-        user_name: @organization.smtp_settings["user_name"],
-        password: Decidim::AttributeEncryptor.decrypt(@organization.smtp_settings["encrypted_password"])
+        address: organization.smtp_settings["address"],
+        port: organization.smtp_settings["port"],
+        user_name: organization.smtp_settings["user_name"],
+        password: Decidim::AttributeEncryptor.decrypt(organization.smtp_settings["encrypted_password"])
       ) { |_k, o, v| v.presence || o }.compact_blank!
     end
+
+    def set_from
+      return if organization.nil?
+      return if already_defined_name_in_mail?(mail.from.first)
+
+      mail.from = sender
+    end
+
+    def sender
+      return Decidim.config.mailer_sender if return_mailer_sender?
+      return default_sender if organization.smtp_settings.blank?
+      return default_sender if organization.smtp_settings["from"].nil?
+      return default_sender if organization.smtp_settings["from"].empty?
+
+      smtp_settings_from = organization.smtp_settings["from"]
+      return smtp_settings_from if already_defined_name_in_mail?(smtp_settings_from)
+
+      email_address_with_name(smtp_settings_from, organization_name(organization))
+    end
+
+    def default_sender
+      email_address_with_name(Decidim.config.mailer_sender, organization_name(organization))
+    end
+
+    def already_defined_name_in_mail?(mail_address)
+      # if there is an space, there is already a name in the address
+      mail_address.match?(/ /)
+    end
+
+    def return_mailer_sender?
+      already_defined_name_in_mail?(Decidim.config.mailer_sender) && organization.smtp_settings.present?
+    end
   end
 end

data/app/mailers/decidim/block_user_mailer.rb

@@ -11,7 +11,7 @@ module Decidim
         @justification = justification
         subject = I18n.t(
           "decidim.block_user_mailer.notify.subject",
-          organization_name: @organization.name,
+          organization_name: organization_name(@organization),
           justification: @justification
         )
 

data/app/mailers/decidim/decidim_devise_mailer.rb

@@ -5,6 +5,8 @@ module Decidim
   # each role and use a localised version.
   class DecidimDeviseMailer < ::Devise::Mailer
     include LocalisedMailer
+    include Decidim::SanitizeHelper
+    helper_method :decidim_escape_translated, :decidim_sanitize_translated, :translated_attribute
 
     layout "decidim/mailer"
 
@@ -19,7 +21,11 @@ module Decidim
         @organization = user.organization
         @opts = opts
 
-        opts[:subject] = I18n.t("devise.mailer.#{opts[:invitation_instructions]}.subject", organization: user.organization.name) if opts[:invitation_instructions]
+        if opts[:invitation_instructions]
+          opts[:subject] =
+            I18n.t("devise.mailer.#{opts[:invitation_instructions]}.subject",
+                   organization: organization_name(user.organization))
+        end
       end
 
       devise_mail(user, opts[:invitation_instructions] || :invitation_instructions, opts)

data/app/mailers/decidim/newsletter_mailer.rb

@@ -2,16 +2,13 @@
 
 module Decidim
   class NewsletterMailer < ApplicationMailer
-    helper Decidim::SanitizeHelper
-    helper Decidim::TranslationsHelper
-
     include Decidim::NewslettersHelper
 
     layout "decidim/newsletter_base"
 
     helper_method :cell
 
-    def newsletter(user, newsletter, preview: false)
+    def newsletter(user, newsletter, preview = nil)
       return if user.email.blank?
 
       @organization = user.organization

data/app/mailers/decidim/newsletters_opt_in_mailer.rb

@@ -2,7 +2,7 @@
 
 module Decidim
   # A custom mailer for Decidim so we can notify users to verify
-  # their own newsletter notifications settings. GDPR releated
+  # their own newsletter notifications settings. GDPR related
   class NewslettersOptInMailer < ApplicationMailer
     def notify(user, token)
       with_user(user) do
@@ -10,7 +10,7 @@ module Decidim
         @organization = user.organization
         @token = token
 
-        mail(to: user.email, subject: I18n.t("decidim.newsletters_opt_in_mailer.notify.subject", organization_name: @organization.name))
+        mail(to: user.email, subject: I18n.t("decidim.newsletters_opt_in_mailer.notify.subject", organization_name: organization_name(@organization)))
       end
     end
   end

data/app/mailers/decidim/notification_mailer.rb

@@ -5,7 +5,6 @@ module Decidim
   # a events are received.
   class NotificationMailer < Decidim::ApplicationMailer
     helper Decidim::ResourceHelper
-    helper Decidim::SanitizeHelper
 
     def event_received(event, event_class_name, resource, user, user_role, extra) # rubocop:disable Metrics/ParameterLists
       with_user(user) do

data/app/mailers/decidim/notifications_digest_mailer.rb

@@ -5,7 +5,6 @@ module Decidim
   # a events are received.
   class NotificationsDigestMailer < Decidim::ApplicationMailer
     helper Decidim::ResourceHelper
-    helper Decidim::SanitizeHelper
     SIZE_LIMIT = 10
 
     def digest_mail(user, notification_ids)

data/app/mailers/decidim/reported_mailer.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 module Decidim
-  # A custom mailer for sending notifications to an admin when a report is created..
+  # A custom mailer for sending notifications to an admin when a report is created.
   class ReportedMailer < Decidim::ApplicationMailer
     helper Decidim::ResourceHelper
-    helper Decidim::TranslationsHelper
 
     helper_method :reported_content_url, :report_url, :manage_moderations_url, :author_profile_url, :reported_content_cell
 
@@ -38,6 +37,10 @@ module Decidim
       @organization
     end
 
+    def current_user
+      @user
+    end
+
     private
 
     def reported_content_url
@@ -63,7 +66,7 @@ module Decidim
     end
 
     # This is needed to be able to use a cell in an ActionMailer, which is not supported out of the box by cells-rails.
-    # We are are passing the current object as if it was a controller.
+    # We are passing the current object as if it was a controller.
     # We also need to define a 'current_organization' method, which is expected by Decidim::ViewModel.
     # A similar approach is used in Decidim::NewsletterMailer
     def reported_content_cell

data/app/mailers/decidim/user_report_mailer.rb

@@ -11,7 +11,7 @@ module Decidim
       with_user(admin) do
         mail(to: admin.email, subject: I18n.t(
           "decidim.user_report_mailer.notify.subject",
-          organization_name: report.moderation.user.organization.name,
+          organization_name: organization_name(report.moderation.user.organization),
           reason: @report.reason
         ))
       end

data/app/models/decidim/action_log.rb

@@ -194,7 +194,7 @@ module Decidim
     # as a regular object.
     def participatory_space_lazy(cache: true)
       return if participatory_space_id.blank? || participatory_space_type.blank?
-      return resouce_lazy if participatory_space_id == resource_id && participatory_space_type == resource_type
+      return resource_lazy if participatory_space_id == resource_id && participatory_space_type == resource_type
 
       self.class.lazy_relation(participatory_space_id, participatory_space_type, cache)
     end

data/app/models/decidim/area_type.rb

@@ -2,7 +2,7 @@
 
 module Decidim
   # Area types allows to use different types of areas in participatory space
-  # (terriotrial, sectorial, etc.)
+  # (territorial, sectorial, etc.)
   class AreaType < ApplicationRecord
     include Decidim::TranslatableResource
     include Decidim::Traceable