decidim 0.0.4 → 0.0.5

data/decidim-admin/app/commands/decidim/admin/deliver_newsletter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # Delivers the newsletter to its recipients.
+    class DeliverNewsletter < Rectify::Command
+      # Initializes the command.
+      #
+      # newsletter - The newsletter to deliver.
+      def initialize(newsletter)
+        @newsletter = newsletter
+      end
+
+      def call
+        @newsletter.with_lock do
+          return broadcast(:invalid) if @newsletter.sent?
+          send_newsletter!
+        end
+
+        broadcast(:ok, @newsletter)
+      end
+
+      private
+
+      def send_newsletter!
+        NewsletterJob.perform_later(@newsletter)
+      end
+    end
+  end
+end

data/decidim-admin/app/commands/decidim/admin/destroy_participatory_process_step.rb

@@ -22,8 +22,17 @@ module Decidim
         return broadcast(:invalid, :active_step) if @step.active?
 
         @step.destroy!
+        reorder_steps
         broadcast(:ok)
       end
+
+      private
+
+      def reorder_steps
+        ReorderParticipatoryProcessSteps
+          .new(@participatory_process.steps, @participatory_process.steps.map(&:id))
+          .call
+      end
     end
   end
 end

data/decidim-admin/app/commands/decidim/admin/update_newsletter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # Updates the newsletter given form data.
+    class UpdateNewsletter < Rectify::Command
+      # Initializes the command.
+      #
+      # newsletter - The Newsletter to update.
+      # form       - The form object containing the data to update.
+      # user       - The user that updates the newsletter.
+      def initialize(newsletter, form, user)
+        @newsletter = newsletter
+        @form = form
+        @user = user
+        @organization = user.organization
+      end
+
+      def call
+        return broadcast(:invalid) unless @form.valid?
+        return broadcast(:invalid) if @newsletter.sent?
+        return broadcast(:invalid) unless @organization == @newsletter.organization
+
+        @newsletter.update_attributes!(
+          subject: @form.subject,
+          body: @form.body,
+          author: @user
+        )
+
+        broadcast(:ok, @newsletter)
+      end
+    end
+  end
+end

data/decidim-admin/app/constraints/decidim/admin/organization_dashboard_constraint.rb

@@ -15,7 +15,7 @@ module Decidim
       #
       # Returns boolean.
       def matches?
-        user.organization == organization && ability.can?(:read, :admin_dashboard)
+        user && user.organization == organization && ability.can?(:read, :admin_dashboard)
       end
 
       private

data/decidim-admin/app/controllers/decidim/admin/features_controller.rb

@@ -95,7 +95,7 @@ module Decidim
         @feature.update_attribute(:published_at, Time.current)
 
         flash[:notice] = I18n.t("features.publish.success", scope: "decidim.admin")
-        redirect_to :back
+        redirect_to action: :index
       end
 
       def unpublish
@@ -105,7 +105,7 @@ module Decidim
         @feature.update_attribute(:published_at, nil)
 
         flash[:notice] = I18n.t("features.unpublish.success", scope: "decidim.admin")
-        redirect_to :back
+        redirect_to action: :index
       end
 
       private

data/decidim-admin/app/controllers/decidim/admin/newsletters_controller.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    # Controller that allows managing user groups at the admin panel.
+    #
+    class NewslettersController < ApplicationController
+      def index
+        authorize! :index, Newsletter
+        @newsletters = collection.order(Newsletter.arel_table[:created_at].desc)
+      end
+
+      def new
+        authorize! :create, Newsletter
+        @form = form(NewsletterForm).instance
+      end
+
+      def show
+        @newsletter = collection.find(params[:id])
+        @email = NewsletterMailer.newsletter(current_user, @newsletter)
+        authorize! :read, @newsletter
+      end
+
+      def preview
+        @newsletter = collection.find(params[:id])
+        authorize! :read, @newsletter
+
+        email = NewsletterMailer.newsletter(current_user, @newsletter)
+        Premailer::Rails::Hook.perform(email)
+
+        render text: email.html_part.body.decoded
+      end
+
+      def create
+        authorize! :create, Newsletter
+        @form = form(NewsletterForm).from_params(params)
+
+        CreateNewsletter.call(@form, current_user) do
+          on(:ok) do |newsletter|
+            flash.now[:notice] = I18n.t("newsletters.create.success", scope: "decidim.admin")
+            redirect_to action: :show, id: newsletter.id
+          end
+
+          on(:invalid) do |newsletter|
+            @newsletter = newsletter
+            flash.now[:error] = I18n.t("newsletters.create.error", scope: "decidim.admin")
+            render action: :new
+          end
+        end
+      end
+
+      def edit
+        @newsletter = collection.find(params[:id])
+        authorize! :update, @newsletter
+        @form = form(NewsletterForm).from_model(@newsletter)
+      end
+
+      def update
+        @newsletter = collection.find(params[:id])
+        authorize! :update, Newsletter
+        @form = form(NewsletterForm).from_params(params)
+
+        UpdateNewsletter.call(@newsletter, @form, current_user) do
+          on(:ok) do |newsletter|
+            flash.now[:notice] = I18n.t("newsletters.update.success", scope: "decidim.admin")
+            redirect_to action: :show, id: newsletter.id
+          end
+
+          on(:invalid) do |newsletter|
+            @newsletter = newsletter
+            flash.now[:error] = I18n.t("newsletters.update.error", scope: "decidim.admin")
+            render action: :edit
+          end
+        end
+      end
+
+      def destroy
+        @newsletter = collection.find(params[:id])
+        authorize! :destroy, @newsletter
+
+        if @newsletter.sent?
+          flash.now[:error] = I18n.t("newsletters.destroy.error_already_sent", scope: "decidim.admin")
+          redirect_to :back
+        else
+          @newsletter.destroy!
+          flash[:notice] = I18n.t("newsletters.destroy.success", scope: "decidim.admin")
+          redirect_to action: :index
+        end
+      end
+
+      def deliver
+        @newsletter = collection.find(params[:id])
+        authorize! :update, @newsletter
+
+        DeliverNewsletter.call(@newsletter) do
+          on(:ok) do
+            flash[:notice] = I18n.t("newsletters.deliver.success", scope: "decidim.admin")
+            redirect_to action: :index
+          end
+
+          on(:invalid) do
+            flash[:error] = I18n.t("newsletters.deliver.error", scope: "decidim.admin")
+            redirect_to action: :show
+          end
+        end
+      end
+
+      private
+
+      def collection
+        Newsletter.where(organization: current_organization)
+      end
+    end
+  end
+end

data/decidim-admin/app/controllers/decidim/admin/participatory_processes_controller.rb

@@ -24,9 +24,9 @@ module Decidim
         @form = form(ParticipatoryProcessForm).from_params(params)
 
         CreateParticipatoryProcess.call(@form) do
-          on(:ok) do
+          on(:ok) do |participatory_process|
             flash[:notice] = I18n.t("participatory_processes.create.success", scope: "decidim.admin")
-            redirect_to participatory_processes_path
+            redirect_to participatory_process_path(participatory_process)
           end
 
           on(:invalid) do
@@ -48,9 +48,9 @@ module Decidim
         @form = form(ParticipatoryProcessForm).from_params(params)
 
         UpdateParticipatoryProcess.call(@participatory_process, @form) do
-          on(:ok) do
+          on(:ok) do |participatory_process|
             flash[:notice] = I18n.t("participatory_processes.update.success", scope: "decidim.admin")
-            redirect_to participatory_processes_path
+            redirect_to participatory_process_path(participatory_process)
           end
 
           on(:invalid) do

data/decidim-admin/app/forms/decidim/admin/newsletter_form.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # The form that validates the data to construct a valid Newsletter.
+    class NewsletterForm < Decidim::Form
+      mimic :newsletter
+
+      include TranslatableAttributes
+
+      translatable_attribute :subject, String
+      translatable_attribute :body, String
+      validates :subject, :body, translatable_presence: true
+    end
+  end
+end

data/decidim-admin/app/jobs/decidim/admin/newsletter_delivery_job.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # Custom ApplicationJob scoped to the admin panel.
+    #
+    class NewsletterDeliveryJob < ApplicationJob
+      queue_as :newsletter
+
+      def perform(user, newsletter)
+        NewsletterMailer.newsletter(user, newsletter).deliver_now
+
+        newsletter.with_lock do
+          newsletter.increment!(:total_deliveries)
+        end
+      end
+    end
+  end
+end

data/decidim-admin/app/jobs/decidim/admin/newsletter_job.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # Custom ApplicationJob scoped to the admin panel.
+    #
+    class NewsletterJob < ApplicationJob
+      queue_as :newsletter
+
+      def perform(newsletter)
+        newsletter.with_lock do
+          raise "Newsletter already sent" if newsletter.sent?
+
+          newsletter.update_attributes!(
+            sent_at: Time.current,
+            total_recipients: recipients.count,
+            total_deliveries: 0
+          )
+        end
+
+        recipients.find_each do |user|
+          NewsletterDeliveryJob.perform_later(user, newsletter)
+        end
+      end
+
+      private
+
+      def recipients
+        @recipients ||= User.where(newsletter_notifications: true).where.not(email: nil)
+      end
+    end
+  end
+end

data/decidim-admin/app/models/decidim/admin/abilities/admin_user.rb

@@ -15,9 +15,11 @@ module Decidim
           can :manage, Category
           can :manage, ParticipatoryProcessUserRole
           can [:create, :update, :index, :new, :read], StaticPage
+
           can [:update_slug, :destroy], [StaticPage, StaticPageForm] do |page|
             !StaticPage.default?(page.slug)
           end
+
           can [:read, :update], Decidim::Organization do |organization|
             organization == user.organization
           end
@@ -27,7 +29,9 @@ module Decidim
           can :manage, :admin_users
           can :manage, Attachment
           can :manage, Scope
+          can :manage, Newsletter
           can [:create, :index, :new, :read, :invite], User
+
           can [:destroy], [User] do |user_to_destroy|
             user != user_to_destroy
           end

data/decidim-admin/app/models/decidim/admin/abilities/base.rb

@@ -12,6 +12,10 @@ module Decidim
         def initialize(user, context)
           merge ::Decidim::Ability.new(user, context)
           merge ParticipatoryProcessAdmin.new(user, context)
+
+          Decidim.admin_abilities.each do |ability|
+            merge ability.constantize.new(user, context)
+          end
         end
       end
     end

data/decidim-admin/app/models/decidim/admin/abilities/collaborator_user.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    module Abilities
+      # Defines the abilities for a collaborator user in the admin
+      # section. Intended to be used with `cancancan`.
+      class CollaboratorUser
+        include CanCan::Ability
+
+        def initialize(user, _context)
+          return unless user && user.role?(:collaborator)
+
+          can :manage, :admin_dashboard
+          can :preview, ParticipatoryProcess
+        end
+      end
+    end
+  end
+end

data/decidim-admin/app/models/decidim/admin/abilities/participatory_process_admin.rb

@@ -14,7 +14,7 @@ module Decidim
         def initialize(user, _context)
           @user = user
 
-          return unless user && !user.role?(:admin)
+          return unless user && !user.role?(:admin) && !user.role?(:collaborator)
 
           can :read, :admin_dashboard do
             participatory_processes.any?

data/decidim-admin/app/queries/decidim/admin/manageable_participatory_processes_for_user.rb

@@ -22,7 +22,7 @@ module Decidim
       #
       # Returns an ActiveRecord::Relation.
       def query
-        return user.organization.participatory_processes if user.role?(:admin)
+        return user.organization.participatory_processes if user.role?(:admin) || user.role?(:collaborator)
 
         ParticipatoryProcess.where(id: process_ids)
       end

data/decidim-admin/app/views/decidim/admin/newsletters/_form.html.erb

@@ -0,0 +1,5 @@
+<div class="field">
+  <%= form.translated :text_field, :subject %>
+  <%= form.translated :editor, :body %>
+  <%= t('.interpolations_hint') %>
+</div>

data/decidim-admin/app/views/decidim/admin/newsletters/edit.html.erb

@@ -0,0 +1,11 @@
+<% provide :title do %>
+  <h2><%= t ".title" %></h2>
+<% end %>
+
+<%= decidim_form_for(@form) do |f| %>
+  <%= render partial: 'form', object: f %>
+
+  <div class="actions">
+    <%= f.submit t(".save_and_preview") %>
+  </div>
+<% end %>

data/decidim-admin/app/views/decidim/admin/newsletters/index.html.erb

@@ -0,0 +1,47 @@
+<div id="newsletters">
+  <% provide :title do %>
+    <h2><%= t ".title" %></h2>
+  <% end %>
+
+  <div class="actions title">
+    <%= link_to t("actions.new", scope: "decidim.admin", name: t("models.newsletter.name", scope: "decidim.admin").downcase), ['new', 'newsletter'], class: 'new' %>
+  </div>
+
+
+  <table class="stack newsletters">
+    <thead>
+      <tr>
+        <th><%= t("models.newsletter.fields.subject", scope: "decidim.admin") %></th>
+        <th><%= t("models.newsletter.fields.created_at", scope: "decidim.admin") %></th>
+        <th><%= t("models.newsletter.fields.sent_at", scope: "decidim.admin") %></th>
+        <th><%= t("models.newsletter.fields.progress", scope: "decidim.admin") %></th>
+        <th class="actions"><%= t("actions.title", scope: "decidim.admin") %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @newsletters.each do |newsletter| %>
+        <tr data-newsletter-id="<%= newsletter.id %>">
+          <td><%= translated_attribute newsletter.subject %></td>
+          <td><%= l newsletter.created_at, format: :long if newsletter.created_at %></td>
+          <td><%= l newsletter.sent_at, format: :long if newsletter.sent_at %></td>
+          <td>
+            <% if newsletter.sent? %>
+              <%= "#{newsletter.total_deliveries} / #{newsletter.total_recipients}" %>
+            <% end %>
+          </td>
+          <td class="actions">
+            <%= link_to t("actions.preview", scope: "decidim.admin"), decidim_admin.newsletter_path(newsletter) %>
+
+            <% if can?(:update, newsletter) && !newsletter.sent? %>
+              <%= link_to t("actions.edit", scope: "decidim.admin"), decidim_admin.edit_newsletter_path(newsletter) %>
+            <% end %>
+
+            <% if can?(:destroy, newsletter) && !newsletter.sent? %>
+              <%= link_to t("actions.destroy", scope: "decidim.admin"), decidim_admin.newsletter_path(newsletter), method: :delete, class: "button", data: { confirm: t(".confirm_delete") } %>
+            <% end %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>