decidim 0.5.1 → 0.6.0

data/decidim-core/app/jobs/decidim/notification_generator_job.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  class NotificationGeneratorJob < ApplicationJob
+    queue_as :decidim_events
+
+    def perform(event, event_class_name, resource, recipient_ids, extra)
+      event_class = event_class_name.constantize
+      NotificationGenerator.new(event, event_class, resource, recipient_ids, extra).generate
+    end
+  end
+end

data/decidim-core/app/mailers/decidim/export_mailer.rb

@@ -8,22 +8,21 @@ module Decidim
     # zipped file.
     #
     # user        - The user to be notified.
-    # name        - The name of the export.
+    # export_name - The name of the export.
     # export_data - The data containing the result of the export.
     #
     # Returns nothing.
-    def export(user, name, export_data)
+    def export(user, export_name, export_data)
       @user = user
       @organization = user.organization
 
-      original_file_name = "#{name}.#{export_data.extension}"
+      filename = export_data.filename(export_name)
+      filename_without_extension = export_data.filename(export_name, extension: false)
 
-      attachments["#{name}.zip"] = FileZipper.new(
-        original_file_name, export_data.read
-      ).zip
+      attachments["#{filename_without_extension}.zip"] = FileZipper.new(filename, export_data.read).zip
 
       with_user(user) do
-        mail(to: "#{user.name} <#{user.email}>", subject: I18n.t("decidim.export_mailer.subject", name: original_file_name))
+        mail(to: "#{user.name} <#{user.email}>", subject: I18n.t("decidim.export_mailer.subject", name: filename))
       end
     end
   end

data/decidim-core/app/mailers/decidim/notification_mailer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  # A custom mailer for sending notifications to users when
+  # a events are received.
+  class NotificationMailer < Decidim::ApplicationMailer
+    helper Decidim::ResourceHelper
+
+    def event_received(event, event_class_name, resource, user, extra)
+      with_user(user) do
+        @organization = resource.organization
+        event_class = event_class_name.constantize
+        @event_instance = event_class.new(resource: resource, event_name: event, user: user, extra: extra)
+        subject = @event_instance.email_subject
+
+        mail(to: user.email, subject: subject)
+      end
+    end
+  end
+end

data/decidim-core/app/mailers/decidim/reported_mailer.rb

@@ -10,7 +10,7 @@ module Decidim
     def report(user, report)
       with_user(user) do
         @report = report
-        @participatory_process = @report.moderation.participatory_process
+        @participatory_space = @report.moderation.participatory_space
         @organization = user.organization
         @user = user
         subject = I18n.t("report.subject", scope: "decidim.reported_mailer")
@@ -21,7 +21,7 @@ module Decidim
     def hide(user, report)
       with_user(user) do
         @report = report
-        @participatory_process = @report.moderation.participatory_process
+        @participatory_space = @report.moderation.participatory_space
         @organization = user.organization
         @user = user
         subject = I18n.t("hide.subject", scope: "decidim.reported_mailer")
@@ -36,7 +36,7 @@ module Decidim
     end
 
     def manage_moderations_url
-      @manage_moderations_url ||= decidim_admin.moderations_url(@participatory_process.id, host: @organization.host)
+      @manage_moderations_url ||= EngineRouter.admin_proxy(@participatory_space).moderations_url(host: @organization.host)
     end
   end
 end

data/decidim-core/app/models/decidim/abilities/admin_ability.rb

@@ -17,7 +17,6 @@ module Decidim
 
       def define_abilities
         can :read, :admin_dashboard
-        can :read, ParticipatoryProcess
         can :read, Feature
         can :impersonate, :managed_users
       end

data/decidim-core/app/models/decidim/abilities/base_ability.rb

@@ -28,6 +28,14 @@ module Decidim
         can :manage, Authorization do |authorization|
           authorization.user == user
         end
+
+        can :manage, Follow do |follow|
+          follow.user == user
+        end
+
+        can :manage, Notification do |notification|
+          notification.user == user
+        end
       end
     end
   end

data/decidim-core/app/models/decidim/abilities/everyone_ability.rb

@@ -8,8 +8,6 @@ module Decidim
       include CanCan::Ability
 
       def initialize(user, _context)
-        can :read, ParticipatoryProcessGroup
-        can :read, ParticipatoryProcess, &:published?
         can :read, :public_pages
         can :manage, :locales
 

data/decidim-core/app/models/decidim/abilities/participatory_process_admin_ability.rb

@@ -20,7 +20,7 @@ module Decidim
         end
 
         can :read, Feature do |feature|
-          can_manage_process?(feature.participatory_process)
+          can_manage_process?(feature.participatory_space)
         end
       end
     end

data/decidim-core/app/models/decidim/abilities/participatory_process_collaborator_ability.rb

@@ -20,7 +20,7 @@ module Decidim
         end
 
         can :read, Feature do |feature|
-          can_manage_process?(feature.participatory_process)
+          can_manage_process?(feature.participatory_space)
         end
       end
     end

data/decidim-core/app/models/decidim/category.rb

@@ -4,13 +4,13 @@ module Decidim
   # Categories serve as a taxonomy for components to use for while in the
   # context of a participatory process.
   class Category < ApplicationRecord
-    belongs_to :participatory_process, foreign_key: "decidim_participatory_process_id", class_name: "Decidim::ParticipatoryProcess", inverse_of: :categories
+    belongs_to :participatory_space, foreign_key: "decidim_participatory_space_id", foreign_type: "decidim_participatory_space_type", polymorphic: true
     has_many :subcategories, foreign_key: "parent_id", class_name: "Decidim::Category", dependent: :destroy, inverse_of: :parent
     belongs_to :parent, class_name: "Decidim::Category", foreign_key: "parent_id", inverse_of: :subcategories, optional: true
     has_many :categorizations, foreign_key: "decidim_category_id", class_name: "Decidim::Categorization", dependent: :destroy
 
     validate :forbid_deep_nesting
-    before_validation :subcategories_have_same_process
+    before_validation :subcategories_have_same_participatory_space
 
     # Scope to return only the first-class categories, that is, those that are
     # not subcategories.
@@ -33,9 +33,9 @@ module Decidim
       errors.add(:parent_id, :nesting_too_deep)
     end
 
-    def subcategories_have_same_process
+    def subcategories_have_same_participatory_space
       return unless parent
-      self.participatory_process = parent.participatory_process
+      self.participatory_space = parent.participatory_space
     end
   end
 end

data/decidim-core/app/models/decidim/feature.rb

@@ -8,13 +8,13 @@ module Decidim
     include HasSettings
     include Publicable
 
-    belongs_to :participatory_process, foreign_key: "decidim_participatory_process_id"
-    has_one :organization, through: :participatory_process
-    has_many :categories, through: :participatory_process
-    has_many :scopes, through: :organization
+    belongs_to :participatory_space, polymorphic: true
 
     default_scope { order(arel_table[:weight].asc) }
 
+    delegate :organization, :categories, to: :participatory_space
+    delegate :scopes, to: :organization
+
     # Public: Finds the manifest this feature is associated to.
     #
     # Returns a FeatureManifest.
@@ -31,9 +31,34 @@ module Decidim
       self.manifest_name = manifest.name
     end
 
+    # Public: The name of the engine the feature is mounted to.
+    def mounted_engine
+      "decidim_#{participatory_space_name}_#{manifest_name}"
+    end
+
+    # Public: The name of the admin engine the feature is mounted to.
+    def mounted_admin_engine
+      "decidim_admin_#{participatory_space_name}_#{manifest_name}"
+    end
+
+    # Public: The hash of contextual params when the feature is mounted.
+    def mounted_params
+      {
+        host: organization.host,
+        feature_id: id,
+        participatory_space.foreign_key.to_sym => participatory_space.id
+      }
+    end
+
     # Public: Returns the value of the registered primary stat.
     def primary_stat
       @primary_stat ||= manifest.stats.filter(primary: true).with_context([self]).map { |name, value| [name, value] }.first&.last
     end
+
+    private
+
+    def participatory_space_name
+      participatory_space.underscored_name
+    end
   end
 end

data/decidim-core/app/models/decidim/follow.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  class Follow < ApplicationRecord
+    belongs_to :followable, foreign_key: "decidim_followable_id", foreign_type: "decidim_followable_type", polymorphic: true
+    belongs_to :user, foreign_key: "decidim_user_id", class_name: "Decidim::User"
+
+    validates :user, uniqueness: { scope: [:followable] }
+  end
+end

data/decidim-core/app/models/decidim/moderation.rb

@@ -4,7 +4,7 @@ module Decidim
   # A moderation belongs to a reportable and includes many reports
   class Moderation < ApplicationRecord
     belongs_to :reportable, foreign_key: "decidim_reportable_id", foreign_type: "decidim_reportable_type", polymorphic: true
-    belongs_to :participatory_process, foreign_key: "decidim_participatory_process_id", class_name: "Decidim::ParticipatoryProcess"
+    belongs_to :participatory_space, foreign_key: "decidim_participatory_space_id", foreign_type: "decidim_participatory_space_type", polymorphic: true
     has_many :reports, foreign_key: "decidim_moderation_id", class_name: "Decidim::Report"
 
     delegate :feature, :organization, to: :reportable

data/decidim-core/app/models/decidim/notification.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  class Notification < ApplicationRecord
+    belongs_to :resource, foreign_key: "decidim_resource_id", foreign_type: "decidim_resource_type", polymorphic: true
+    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)
+    end
+  end
+end

data/decidim-core/app/models/decidim/scope.rb

@@ -46,11 +46,11 @@ module Decidim
       organization.scopes.where("? = ANY(decidim_scopes.part_of)", id)
     end
 
-    # Gets the scopes from the part_of list
+    # Gets the scopes from the part_of list in descending order (first the top level scope, last itself)
     #
-    # Returns an ActiveRecord::Relation.
+    # Returns an array of Scope objects
     def part_of_scopes
-      organization.scopes.where(id: part_of)
+      organization.scopes.where(id: part_of).sort { |s1, s2| part_of.index(s2.id) <=> part_of.index(s1.id) }
     end
 
     private
@@ -60,19 +60,19 @@ module Decidim
     end
 
     def create_part_of
-      self[:part_of] = calculate_part_of
+      build_part_of
       save if changed?
     end
 
     def update_part_of
-      self[:part_of] = calculate_part_of
+      build_part_of
     end
 
-    def calculate_part_of
+    def build_part_of
       if parent
-        [id] + parent.part_of
+        part_of.clear.append(id).concat(parent.reload.part_of)
       else
-        [id]
+        part_of.clear.append(id)
       end
     end
   end

data/decidim-core/app/models/decidim/user.rb

@@ -18,9 +18,11 @@ module Decidim
     has_many :identities, foreign_key: "decidim_user_id", class_name: "Decidim::Identity"
     has_many :memberships, class_name: "Decidim::UserGroupMembership", foreign_key: :decidim_user_id
     has_many :user_groups, through: :memberships, class_name: "Decidim::UserGroup", foreign_key: :decidim_user_group_id
+    has_many :follows, foreign_key: "decidim_user_id", class_name: "Decidim::Follow", dependent: :destroy
+    has_many :notifications, foreign_key: "decidim_user_id", class_name: "Decidim::Notification", dependent: :destroy
 
     validates :name, presence: true, unless: -> { deleted? }
-    validates :locale, inclusion: { in: Decidim.available_locales.map(&:to_s) }, allow_blank: true
+    validates :locale, inclusion: { in: :available_locales }, allow_blank: true
     validates :tos_agreement, acceptance: true, allow_nil: false, on: :create
     validates :avatar, file_size: { less_than_or_equal_to: MAXIMUM_AVATAR_FILE_SIZE }
     validates :email, uniqueness: { scope: :organization }, unless: -> { deleted? || managed? }
@@ -62,6 +64,10 @@ module Decidim
       deleted_at.present?
     end
 
+    def follows?(followable)
+      Decidim::Follow.where(user: self, followable: followable).any?
+    end
+
     # Check if the user exists with the given email and the current organization
     #
     # warden_conditions - A hash with the authentication conditions
@@ -102,5 +108,9 @@ module Decidim
     def all_roles_are_valid
       errors.add(:roles, :invalid) unless roles.all? { |role| ROLES.include?(role) }
     end
+
+    def available_locales
+      Decidim.available_locales.map(&:to_s)
+    end
   end
 end

data/decidim-core/app/presenters/decidim/home_stats_presenter.rb

@@ -75,7 +75,7 @@ module Decidim
     end
 
     def published_features
-      @published_features ||= Feature.where(participatory_process: OrganizationPublishedParticipatoryProcesses.new(organization).query).published
+      @published_features ||= Feature.where(participatory_space: ParticipatoryProcesses::OrganizationPublishedParticipatoryProcesses.new(organization).query).published
     end
   end
 end

data/decidim-core/app/presenters/decidim/resource_locator_presenter.rb

@@ -42,14 +42,14 @@ module Decidim
     #
     # Returns a String.
     def member_route(route_type, options)
-      route_proxy.send("#{member_route_name}_#{route_type}", member_params.merge(options))
+      route_proxy.send("#{member_route_name}_#{route_type}", @resource, options)
     end
 
     # Private: Build the route to the associated collection of resources.
     #
     # Returns a String.
     def collection_route(route_type, options)
-      route_proxy.send("#{collection_route_name}_#{route_type}", collection_params.merge(options))
+      route_proxy.send("#{collection_route_name}_#{route_type}", options)
     end
 
     def manifest
@@ -60,21 +60,6 @@ module Decidim
       @resource.feature
     end
 
-    def engine
-      manifest.feature_manifest.engine
-    end
-
-    def member_params
-      collection_params.merge(id: @resource.id)
-    end
-
-    def collection_params
-      {
-        feature_id: feature.id,
-        participatory_process_id: feature.participatory_process.id
-      }
-    end
-
     def member_route_name
       manifest.route_name
     end
@@ -84,7 +69,7 @@ module Decidim
     end
 
     def route_proxy
-      @route_proxy ||= engine.routes.url_helpers
+      @route_proxy ||= EngineRouter.main_proxy(feature)
     end
   end
 end

data/decidim-core/app/queries/decidim/participatory_processes_with_user_role.rb

@@ -28,7 +28,7 @@ module Decidim
     # Returns an ActiveRecord::Relation.
     def query
       # Admin users have all role privileges for all organization processes
-      return OrganizationParticipatoryProcesses.new(user.organization).query if user.admin?
+      return ParticipatoryProcesses::OrganizationParticipatoryProcesses.new(user.organization).query if user.admin?
 
       ParticipatoryProcess.where(id: process_ids)
     end

data/decidim-core/app/services/decidim/email_notification_generator.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class handles system events affecting resources and generates a
+  # notification for each recipient by scheduling a new
+  # `Decidim::NotificationMailer` job for each of them. This way we can
+  # easily control which jobs fail and retry them, so that we don't have
+  # duplicated notifications.
+  class EmailNotificationGenerator
+    # Initializes the class.
+    #
+    # event - A String with the name of the event.
+    # event_class - A class that wraps the event.
+    # resource - an instance of a class implementing the `Decidim::Resource` concern.
+    # extra - a Hash with extra information to be included in the notification.
+    def initialize(event, event_class, resource, recipient_ids, extra)
+      @event = event
+      @event_class = event_class
+      @resource = resource
+      @recipient_ids = recipient_ids
+      @extra = extra
+    end
+
+    # Schedules a job for each recipient to send the email. Returns `nil`
+    # if the resource is not resource or if it is not present.
+    #
+    # Returns nothing.
+    def generate
+      return unless resource
+      return unless event_class.types.include?(:email)
+
+      recipient_ids.each do |recipient_id|
+        send_email_to(recipient_id)
+      end
+    end
+
+    private
+
+    attr_reader :event, :event_class, :resource, :recipient_ids, :extra
+
+    # Private: sends the notification email to the user if they have the
+    # `email_on_notification` flag active.
+    #
+    # recipient_id - The ID of the user that will receive the email.
+    #
+    # Returns nothing.
+    def send_email_to(recipient_id)
+      recipient = Decidim::User.where(id: recipient_id).first
+      return unless recipient
+      return unless recipient.email_on_notification?
+
+      NotificationMailer
+        .event_received(
+          event,
+          event_class.name,
+          resource,
+          recipient,
+          extra
+        )
+        .deliver_later
+    end
+  end
+end