decidim-core 0.5.1 → 0.6.0

data/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/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/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/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/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/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/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/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/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

data/app/services/decidim/events_manager.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class acts as a wrapper of `ActiveSupport::Notifications`, so that if
+  # we ever need to change the API we just have to change it in a single point.
+  class EventsManager
+    # Publishes a event through the events channel. It requires  the name of an
+    # event, a class that handles the event and the resource that received the action.
+    #
+    # event - a String representing the event that has happened. Ideally, it should
+    #   start with `decidim.events` and include the name of the engine that publishes
+    #   it.
+    # event_class - The event class must be a class that wraps the event name and
+    #   the resource and builds the needed information to publish the event to
+    #   the different subscribers in the system.
+    # resource - an instance of a class that received the event.
+    # recipient_ids - an Array of IDs of the users that will receive the event
+    # extra - a Hash with extra information to be included in the notification.
+    #
+    # Returns nothing.
+    def self.publish(event:, event_class: Decidim::Events::BaseEvent, resource:, recipient_ids:, extra: {})
+      ActiveSupport::Notifications.publish(
+        event,
+        event_class: event_class.name,
+        resource: resource,
+        recipient_ids: recipient_ids,
+        extra: extra
+      )
+    end
+
+    # Subscribes to the given event, and runs the block every time that event
+    # is received.
+    #
+    # event - a String or a RegExp to match against event names.
+    #
+    # Returns nothing.
+    def self.subscribe(event, &block)
+      ActiveSupport::Notifications.subscribe(event, &block)
+    end
+  end
+end

data/app/services/decidim/notification_generator.rb

@@ -0,0 +1,51 @@
+# 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::NotificationGeneratorForRecipientJob` 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 NotificationGenerator
+    # 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 for the event.
+    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 create the notification. 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?(:notification)
+
+      recipient_ids.each do |recipient_id|
+        generate_notification_for(recipient_id)
+      end
+    end
+
+    private
+
+    attr_reader :event, :event_class, :resource, :recipient_ids, :extra
+
+    def generate_notification_for(recipient_id)
+      NotificationGeneratorForRecipientJob.perform_later(
+        event,
+        event_class.name,
+        resource,
+        recipient_id,
+        extra
+      )
+    end
+  end
+end

data/app/services/decidim/notification_generator_for_recipient.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class generates a notification based on the given event, for the given
+  # resource/recipient couple. It is intended to be used by the
+  # `Decidim::NotificationGenerator` class, which schedules a job for each recipient
+  # of the event, so that we can easily control which jobs fail.
+  class NotificationGeneratorForRecipient
+    # Initializes the class.
+    #
+    # event - A String with the name of the event.
+    # event_class - The class that wraps the event, in order to decorate it.
+    # resource - an instance of a class implementing the `Decidim::Resource` concern.
+    # recipient - the ID of the User that will receive the notification.
+    # extra - a Hash with extra information to be included in the notification.
+    def initialize(event, event_class, resource, recipient_id, extra)
+      @event = event
+      @event_class = event_class
+      @resource = resource
+      @recipient_id = recipient_id
+      @extra = extra
+    end
+
+    # Generates the notification. Returns `nil` if the resource is not resource
+    # or if the resource or the user are not present.
+    #
+    # Returns a Decidim::Notification.
+    def generate
+      return unless event_class
+      return unless resource
+      return unless recipient
+
+      Notification.create!(
+        user: recipient,
+        event_class: event_class,
+        resource: resource,
+        event_name: event,
+        extra: extra
+      )
+    end
+
+    private
+
+    attr_reader :event, :event_class, :resource, :recipient_id, :extra
+
+    def recipient
+      @recipient ||= User.where(id: recipient_id).first
+    end
+  end
+end

data/app/uploaders/decidim/attachment_uploader.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Decidim
-  # This class deals with uploading attachments to a ParticipatoryProcess.
+  # This class deals with uploading attachments to a participatory space.
   class AttachmentUploader < ApplicationUploader
     include CarrierWave::MiniMagick
 

data/app/views/decidim/authorizations/first_login.html.erb

@@ -11,9 +11,9 @@
         <div class="card">
           <div class="card__content">
             <% handlers.each do |handler| %>
-              <%= link_to t(handler.handler_name, scope: "decidim.authorizations.first_login.actions"), new_authorization_path(handler: handler.handler_name), class: "button expanded" %>
+              <%= link_to t("authorizations.first_login.actions.#{handler.handler_name}", scope: "decidim"), new_authorization_path(handler: handler.handler_name), class: "button expanded" %>
             <% end %>
-            <p class="text-center skip"><%= t("decidim.authorizations.skip_verification", link: link_to(t("decidim.authorizations.current_participatory_processes"), participatory_processes_path).html_safe).html_safe %>.</p>
+            <p class="text-center skip"><%= t("decidim.authorizations.skip_verification", link: link_to(t("decidim.authorizations.current_participatory_processes"), decidim_participatory_processes.participatory_processes_path).html_safe).html_safe %>.</p>
           </div>
         </div>
       </div>

data/app/views/decidim/follows/update_button.js.erb

@@ -0,0 +1,3 @@
+var $followResource = $("#follow-resource");
+
+morphdom($followResource[0], "<%= j(render partial: "decidim/shared/follow_button", locals: { followable: resource } ).strip.html_safe %>");

data/app/views/decidim/notification_mailer/event_received.html.erb

@@ -0,0 +1,9 @@
+<p><%= @event_instance.email_greeting %></p>
+
+<p><%= @event_instance.email_intro %></p>
+
+<p>
+  <%= link_to @event_instance.resource_url, @event_instance.resource_url %>
+</p>
+
+<p><%= @event_instance.email_outro %></p>

data/app/views/decidim/notifications/_notification.html.erb

@@ -0,0 +1,18 @@
+<div class="card--list__item">
+  <div class="card--list__text">
+    <%= link_to notification.event_class_instance.resource_path do %>
+      <%= resource_icon notification.resource, class: "icon--chat card--list__icon" %>
+    <% end %>
+    <div>
+      <h5 class="card--list__heading">
+        <%= notification.event_class_instance.notification_title %>
+      </h5>
+      <span class="text-small"><%= l notification.created_at.to_date, format: :long %></span>
+    </div>
+  </div>
+  <div class="card--list__data">
+    <%= link_to notification, class: "mark-as-read-button card--list__data__icon", remote: true, method: :delete do %>
+      <%= icon "check", class: "icon icon--chevron-right" %>
+    <% end %>
+  </div>
+</div>

data/app/views/decidim/notifications/index.html.erb

@@ -0,0 +1,32 @@
+<main class="wrapper" id="notifications">
+  <div class="row">
+    <div class="columns">
+      <div class="title-action" >
+        <h1 class="heading1 title-action__title"><%= t("title", scope: "layouts.decidim.notifications_dashboard") %></h1>
+        <%= link_to(
+          t("mark_all_as_read", scope: "layouts.decidim.notifications_dashboard"),
+          decidim.read_all_notifications_path,
+          class: "button title-action__action hollow mark-all-as-read-button",
+          method: :delete,
+          data: { disable: true },
+          remote: true
+        ) %>
+      </div>
+    </div>
+  </div>
+  <div class="row">
+    <div class="columns mediumlarge-12 large-12">
+      <p class="empty-notifications hide"><%= t("no_notifications", scope: "layouts.decidim.notifications_dashboard") %></p>
+      <% if notifications.any? %>
+        <section class="section" id="notifications-list">
+          <div class="card card--list">
+            <%= render notifications %>
+          </div>
+        </section>
+        <%= decidim_paginate notifications %>
+      <% end %>
+    </div>
+  </div>
+</main>
+
+<%= javascript_include_tag "decidim/notifications" %>