decidim-core 0.15.2 → 0.16.0

data/app/helpers/decidim/translations_helper.rb

@@ -11,12 +11,13 @@ module Decidim
     # key     - The key to translate.
     # locales - A list of locales to scope the translations to. Picks up all the
     #           available locales by default.
+    # 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)
+    def multi_translation(key, locales = Decidim.available_locales, *options)
       locales.each_with_object({}) do |locale, result|
         I18n.with_locale(locale) do
-          result[locale.to_sym] = I18n.t(key)
+          result[locale.to_sym] = I18n.t(key, *options)
         end
       end
     end

data/app/jobs/decidim/email_notification_generator_job.rb

@@ -4,9 +4,11 @@ module Decidim
   class EmailNotificationGeneratorJob < ApplicationJob
     queue_as :events
 
-    def perform(event, event_class_name, resource, recipient_ids, extra)
+    # rubocop:disable Metrics/ParameterLists
+    def perform(event, event_class_name, resource, followers, affected_users, extra)
       event_class = event_class_name.constantize
-      EmailNotificationGenerator.new(event, event_class, resource, recipient_ids, extra).generate
+      EmailNotificationGenerator.new(event, event_class, resource, followers, affected_users, extra).generate
     end
+    # rubocop:enable Metrics/ParameterLists
   end
 end

data/app/jobs/decidim/metric_job.rb

@@ -7,7 +7,7 @@ module Decidim
     def perform(manager_class, organization_id, day = nil)
       organization = Decidim::Organization.find_by(id: organization_id)
       return unless organization
-      metric = manager_class.constantize.for(day, organization)
+      metric = manager_class.constantize.new(day, organization)
       metric.save if metric.valid?
     end
   end

data/app/jobs/decidim/notification_generator_for_recipient_job.rb

@@ -4,10 +4,10 @@ module Decidim
   class NotificationGeneratorForRecipientJob < ApplicationJob
     queue_as :events
 
-    def perform(event, event_class_name, resource, recipient_id, extra)
+    def perform(event, event_class_name, resource, recipient, user_role, extra) # rubocop:disable Metrics/ParameterLists
       event_class = event_class_name.constantize
       NotificationGeneratorForRecipient
-        .new(event, event_class, resource, recipient_id, extra)
+        .new(event, event_class, resource, recipient, user_role, extra)
         .generate
     end
   end

data/app/jobs/decidim/notification_generator_job.rb

@@ -4,9 +4,11 @@ module Decidim
   class NotificationGeneratorJob < ApplicationJob
     queue_as :events
 
-    def perform(event, event_class_name, resource, recipient_ids, extra)
+    # rubocop:disable Metrics/ParameterLists
+    def perform(event, event_class_name, resource, followers, affected_users, extra)
       event_class = event_class_name.constantize
-      NotificationGenerator.new(event, event_class, resource, recipient_ids, extra).generate
+      NotificationGenerator.new(event, event_class, resource, followers, affected_users, extra).generate
     end
+    # rubocop:enable Metrics/ParameterLists
   end
 end

data/app/jobs/decidim/open_data_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  class OpenDataJob < ApplicationJob
+    queue_as :default
+
+    def perform(organization)
+      path = Rails.root.join("tmp/#{organization.open_data_file_path}")
+
+      exporter = OpenDataExporter.new(organization, path)
+      raise "Couldn't generate Open Data export" unless exporter.export.positive?
+
+      OpenDataUploader.new.store!(File.open(path, "rb"))
+    end
+  end
+end

data/app/mailers/decidim/messaging/conversation_mailer.rb

@@ -10,27 +10,30 @@ module Decidim
           from: originator,
           to: user,
           conversation: conversation,
+          message: conversation.messages.first.body,
           action: "new_conversation"
         )
       end
 
-      def new_message(sender, user, conversation)
+      def new_message(sender, user, conversation, message)
         notification_mail(
           from: sender,
           to: user,
           conversation: conversation,
+          message: message.body,
           action: "new_message"
         )
       end
 
       private
 
-      def notification_mail(from:, to:, conversation:, action:)
+      def notification_mail(from:, to:, conversation:, action:, message: nil)
         with_user(to) do
           @organization = to.organization
           @conversation = conversation
           @sender = from.name
           @recipient = to.name
+          @message = message
           @host = @organization.host
 
           subject = I18n.t(

data/app/mailers/decidim/newsletter_mailer.rb

@@ -16,9 +16,13 @@ module Decidim
 
       @custom_url_for_mail_root = custom_url_for_mail_root(@organization, @newsletter.id) if Decidim.config.track_newsletter_links
       @encrypted_token = Decidim::NewsletterEncryptor.sent_at_encrypted(@user.id, @newsletter.sent_at)
+
       with_user(user) do
-        @subject = parse_interpolations(@newsletter.subject[I18n.locale.to_s], user, @newsletter.id)
-        @body = parse_interpolations(@newsletter.body[I18n.locale.to_s], user, @newsletter.id)
+        subject = @newsletter.subject[I18n.locale.to_s].presence || @newsletter.subject[@organization.default_locale]
+        body = @newsletter.body[I18n.locale.to_s].presence || @newsletter.body[@organization.default_locale]
+
+        @subject = parse_interpolations(subject, user, @newsletter.id)
+        @body = parse_interpolations(body, user, @newsletter.id)
 
         mail(to: "#{user.name} <#{user.email}>", subject: @subject)
       end

data/app/mailers/decidim/notification_mailer.rb

@@ -6,13 +6,13 @@ module Decidim
   class NotificationMailer < Decidim::ApplicationMailer
     helper Decidim::ResourceHelper
 
-    def event_received(event, event_class_name, resource, user, extra)
+    def event_received(event, event_class_name, resource, user, user_role, extra) # rubocop:disable Metrics/ParameterLists
       return if user.email.blank?
 
       with_user(user) do
         @organization = user.organization
         event_class = event_class_name.constantize
-        @event_instance = event_class.new(resource: resource, event_name: event, user: user, extra: extra)
+        @event_instance = event_class.new(resource: resource, event_name: event, user: user, extra: extra, user_role: user_role)
         subject = @event_instance.email_subject
 
         mail(to: user.email, subject: subject)

data/app/models/decidim/action_log.rb

@@ -5,6 +5,8 @@ module Decidim
   # for transparency reasons, to log all actions so all other users can
   # see the actions being performed.
   class ActionLog < ApplicationRecord
+    include Decidim::Scopable
+
     belongs_to :organization,
                foreign_key: :decidim_organization_id,
                class_name: "Decidim::Organization"
@@ -30,6 +32,11 @@ module Decidim
                optional: true,
                class_name: "PaperTrail::Version"
 
+    belongs_to :area,
+               foreign_key: "decidim_area_id",
+               class_name: "Decidim::Area",
+               optional: true
+
     validates :organization, :user, :action, presence: true
     validates :resource, presence: true, if: ->(log) { log.action != "delete" }
     validates :visibility, presence: true, inclusion: { in: %w(admin-only public-only all) }

data/app/models/decidim/amendment.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  class Amendment < ApplicationRecord
+    belongs_to :amendable, foreign_key: "decidim_amendable_id", foreign_type: "decidim_amendable_type", polymorphic: true
+    belongs_to :amender, foreign_key: "decidim_user_id", class_name: "Decidim::User"
+    belongs_to :emendation, foreign_key: "decidim_emendation_id", foreign_type: "decidim_emendation_type", polymorphic: true
+
+    STATES = %w(evaluating accepted rejected withdrawn).freeze
+
+    def evaluating?
+      state == "evaluating"
+    end
+
+    validates :amendable, :amender, :emendation, presence: true
+  end
+end

data/app/models/decidim/component.rb

@@ -65,6 +65,14 @@ module Decidim
       @primary_stat ||= manifest.stats.filter(primary: true).with_context([self]).map { |name, value| [name, value] }.first&.last
     end
 
+    # Public: Returns the component's name as resource title
+    def resource_title
+      name
+    end
+
+    # Public: Returns an empty description
+    def resource_description; end
+
     private
 
     def participatory_space_name

data/app/models/decidim/contextual_help_section.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  class ContextualHelpSection < ApplicationRecord
+    belongs_to :organization, class_name: "Decidim::Organization"
+    validates :organization, presence: true
+    validates :content, presence: true
+
+    # Public: Finds content given an id
+    #
+    # organization - The Organization to scope the content to
+    # id - A String with the id
+    #
+    # Returns a Hash with the localized content
+    def self.find_content(organization, id)
+      find_by(organization: organization, section_id: id).try(:content) || {}
+    end
+
+    # Public: Stores the content.
+    #
+    # organization - The Organization to scope the content to
+    # id           - A String with the id
+    # content      - A Hash with the content to store
+    #
+    # Returns a Hash with the localized content
+    def self.set_content(organization, id, content)
+      item = find_or_initialize_by(
+        organization: organization,
+        section_id: id
+      )
+
+      if content.present? && content.values.any?(&:present?)
+        item.update!(content: content)
+      else
+        item.destroy!
+      end
+
+      content
+    end
+  end
+end

data/app/models/decidim/follow.rb

@@ -9,6 +9,12 @@ module Decidim
 
     validates :user, uniqueness: { scope: [:followable] }
 
+    after_create :increase_following_counters
+    after_create :increase_followers_counter
+
+    after_destroy :decrease_following_counters
+    after_destroy :decrease_followers_counter
+
     def self.user_collection(user)
       where(decidim_user_id: user.id)
     end
@@ -16,5 +22,29 @@ module Decidim
     def self.export_serializer
       Decidim::DataPortabilitySerializers::DataPortabilityFollowSerializer
     end
+
+    private
+
+    # rubocop:disable Rails/SkipsModelValidations
+    def increase_following_counters
+      user.increment!(:following_count)
+    end
+
+    def increase_followers_counter
+      return unless followable.is_a?(Decidim::UserBaseEntity)
+      followable.increment!(:followers_count)
+    end
+
+    def decrease_following_counters
+      return unless user
+      user.decrement!(:following_count)
+    end
+
+    def decrease_followers_counter
+      return unless followable.is_a?(Decidim::UserBaseEntity)
+      return unless user
+      followable.decrement!(:followers_count)
+    end
+    # rubocop:enable Rails/SkipsModelValidations
   end
 end

data/app/models/decidim/notification.rb

@@ -8,7 +8,17 @@ module Decidim
     belongs_to :user, foreign_key: "decidim_user_id", class_name: "Decidim::User"
 
     def event_class_instance
-      @event_class_instance ||= event_class.constantize.new(resource: resource, event_name: event_name, user: user, extra: extra)
+      @event_class_instance ||= event_class.constantize.new(
+        resource: resource,
+        event_name: event_name,
+        user: user,
+        user_role: user_role,
+        extra: extra
+      )
+    end
+
+    def user_role
+      extra["received_as"]
     end
 
     def self.user_collection(user)

data/app/models/decidim/organization.rb

@@ -5,12 +5,14 @@ module Decidim
   # installation we can find many organizations and each of them can start
   # their own participatory processes.
   class Organization < ApplicationRecord
+    include TranslationsHelper
     include Decidim::Traceable
     include Decidim::Loggable
 
     SOCIAL_HANDLERS = [:twitter, :facebook, :instagram, :youtube, :github].freeze
 
     has_many :static_pages, foreign_key: "decidim_organization_id", class_name: "Decidim::StaticPage", inverse_of: :organization, dependent: :destroy
+    has_many :static_page_topics, foreign_key: "organization_id", class_name: "Decidim::StaticPageTopic", inverse_of: :organization, dependent: :destroy
     has_many :scopes, -> { order(name: :asc) }, foreign_key: "decidim_organization_id", class_name: "Decidim::Scope", inverse_of: :organization
     has_many :scope_types, -> { order(name: :asc) }, foreign_key: "decidim_organization_id", class_name: "Decidim::ScopeType", inverse_of: :organization
     has_many :areas, -> { order(name: :asc) }, foreign_key: "decidim_organization_id", class_name: "Decidim::Area", inverse_of: :organization
@@ -21,6 +23,12 @@ module Decidim
     has_many :oauth_applications, foreign_key: "decidim_organization_id", class_name: "Decidim::OAuthApplication", inverse_of: :organization, dependent: :destroy
     has_many :hashtags, foreign_key: "decidim_organization_id", class_name: "Decidim::Hashtag", dependent: :destroy
 
+    # Users registration mode. Whether users can register or access the system. Doesn't affect users that access through Omniauth integrations.
+    #  enabled: Users registration and sign in are enabled (default value).
+    #  existing: Users can't be registered in the system. Only existing users can sign in.
+    #  disable: Users can't register or sign in.
+    enum users_registration_mode: [:enabled, :existing, :disabled], _prefix: true
+
     validates :name, :host, uniqueness: true
     validates :reference_prefix, presence: true
     validates :default_locale, inclusion: { in: :available_locales }
@@ -55,5 +63,38 @@ module Decidim
     def published_components
       @published_components ||= Component.where(participatory_space: public_participatory_spaces).published
     end
+
+    def customize_welcome_notification
+      self[:welcome_notification_subject].present? || self[:welcome_notification_body].present?
+    end
+
+    def welcome_notification_subject
+      self[:welcome_notification_subject] ||
+        multi_translation("decidim.welcome_notification.default_subject", available_locales)
+    end
+
+    def welcome_notification_body
+      self[:welcome_notification_body] ||
+        multi_translation("decidim.welcome_notification.default_body", available_locales)
+    end
+
+    def sign_up_enabled?
+      users_registration_mode_enabled?
+    end
+
+    def sign_in_enabled?
+      !users_registration_mode_disabled?
+    end
+
+    def open_data_file
+      @open_data_file ||= OpenDataUploader.new.tap do |uploader|
+        uploader.retrieve_from_store! open_data_file_path
+        uploader.cache! open_data_file_path
+      end
+    end
+
+    def open_data_file_path
+      "#{host}-open-data.zip"
+    end
   end
 end

data/app/models/decidim/searchable_resource.rb

@@ -32,6 +32,9 @@ module Decidim
 
     pg_search_scope :global_search,
                     against: { content_a: "A", content_b: "B", content_c: "C", content_d: "D" },
+                    using: {
+                      tsearch: { prefix: true }
+                    },
                     order_within_rank: "datetime DESC"
   end
 end

data/app/models/decidim/static_page.rb

@@ -12,6 +12,7 @@ module Decidim
     include Decidim::Loggable
 
     belongs_to :organization, foreign_key: "decidim_organization_id", class_name: "Decidim::Organization", inverse_of: :static_pages
+    belongs_to :topic, foreign_key: "topic_id", class_name: "Decidim::StaticPageTopic", optional: true
 
     validates :slug, presence: true, uniqueness: { scope: :organization }
     validates :slug, format: { with: /\A[a-z0-9-]+/ }
@@ -20,9 +21,12 @@ module Decidim
     # and cannot be deleted.
     DEFAULT_PAGES = %w(faq terms-and-conditions accessibility).freeze
 
+    after_create :update_organization_tos_version
     before_destroy :can_be_destroyed?
     before_update :can_update_slug?
 
+    default_scope { order(arel_table[:weight].asc) }
+
     # Whether this is slug of a default page or not.
     #
     # slug - The String with the value of the slug.
@@ -57,6 +61,13 @@ module Decidim
 
     private
 
+    # When creating a terms-and-conditions page
+    # set the organization tos_version
+    def update_organization_tos_version
+      return unless slug == "terms-and-conditions"
+      organization.update!(tos_version: created_at)
+    end
+
     def can_be_destroyed?
       throw(:abort) if default?
     end

data/app/models/decidim/static_page_topic.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  class StaticPageTopic < ApplicationRecord
+    validates :title, presence: true
+
+    default_scope { order(arel_table[:weight].asc) }
+
+    belongs_to :organization, class_name: "Decidim::Organization"
+    has_many :pages, class_name: "Decidim::StaticPage", foreign_key: "topic_id", dependent: :nullify
+  end
+end

data/app/models/decidim/user.rb

@@ -138,9 +138,13 @@ module Decidim
     end
 
     def tos_accepted?
-      return true if managed || organization.tos_version.nil?
+      return true if managed
       return false if accepted_tos_version.nil?
-      accepted_tos_version >= organization.tos_version
+
+      # For some reason, if we don't use `#to_i` here we get some
+      # cases where the comparison returns false, but calling `#to_i` returns
+      # the same number :/
+      accepted_tos_version.to_i >= organization.tos_version.to_i
     end
 
     # Whether this user can be verified against some authorization or not.
@@ -152,6 +156,14 @@ module Decidim
       ImpersonationLog.active.where(user: self).exists?
     end
 
+    def interested_scopes_ids
+      extended_data["interested_scopes"] || []
+    end
+
+    def interested_scopes
+      @interested_scopes ||= organization.scopes.where(id: interested_scopes_ids)
+    end
+
     protected
 
     # Overrides devise email required validation.
@@ -168,6 +180,17 @@ module Decidim
       super
     end
 
+    def after_confirmation
+      return unless organization.send_welcome_notification?
+
+      Decidim::EventsManager.publish(
+        event: "decidim.events.core.welcome_notification",
+        event_class: WelcomeNotificationEvent,
+        resource: self,
+        affected_users: [self]
+      )
+    end
+
     private
 
     # Changes default Devise behaviour to use ActiveJob to send async emails.