decidim-debates 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c8c3f04834fe68d8d8f398651df6a90dd7c723f783630cd7e448289a46a020c
+  data.tar.gz: c39f1fd9a58bfa76f7a92a5afef691882e2799b90b7f0c9967d9bc3e638b423e
+SHA512:
+  metadata.gz: 406ad27d7b9841e2a78bcfc6cbeb4177c6335c556252d83e4cdee5b06c2e3afe567e71c25e15bd4eb2ecba188bc019dadd20e74bbba9b9f275e6f3cc4a3b4326
+  data.tar.gz: 013e15cde4c7431c8853dcf00a38c38db94e3f833c3784928d0e12a7e2bbb909090e0ddfbfdf86531a13c55d6c66c97f49f1483621762703058d99f25e94e59f

data/README.md

@@ -0,0 +1,15 @@
+# Decidim::Debates
+
+The Debates module adds debate to any participatory process. It adds a CRUD engine to the admin and public view scoped inside the participatory process.
+
+## Usage
+
+Debates will be available as a Component for any participatory space.
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+
+See [Decidim](https://github.com/decidim/decidim).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"

data/app/assets/images/decidim/debates/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 35 35"><path d="M17.5 35A17.5 17.5 0 1 1 35 17.5 17.52 17.52 0 0 1 17.5 35zm0-33.06A15.56 15.56 0 1 0 33.06 17.5 15.57 15.57 0 0 0 17.5 1.94zm6.44 24.29a1 1 0 0 1-.34-.06l-3.78-1.42a10.75 10.75 0 0 1-2.32.25c-4.95 0-9-3.36-9-7.5s4-7.5 9-7.5 9 3.36 9 7.5a6.75 6.75 0 0 1-1.88 4.6l.32 3.06a1 1 0 0 1-1 1.07zm-4.06-3.47a1 1 0 0 1 .34.06l2.59 1-.2-2a1 1 0 0 1 .3-.8 4.91 4.91 0 0 0 1.62-3.54c0-3.06-3.15-5.55-7-5.55s-7 2.49-7 5.55 3.15 5.55 7 5.55a8.74 8.74 0 0 0 2.14-.26 1 1 0 0 1 .21-.01z"/></svg>

data/app/commands/decidim/debates/admin/create_debate.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Admin
+      # This command is executed when the user creates a Debate from the admin
+      # panel.
+      class CreateDebate < Rectify::Command
+        def initialize(form)
+          @form = form
+        end
+
+        # Creates the debate if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          transaction do
+            create_debate
+            send_notification_to_space_followers
+          end
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :debate, :form
+
+        def create_debate
+          @debate = Debate.create!(
+            category: form.category,
+            title: form.title,
+            description: form.description,
+            information_updates: form.information_updates,
+            instructions: form.instructions,
+            end_time: form.end_time,
+            start_time: form.start_time,
+            feature: form.current_feature
+          )
+        end
+
+        def send_notification_to_space_followers
+          Decidim::EventsManager.publish(
+            event: "decidim.events.debates.debate_created",
+            event_class: Decidim::Debates::CreateDebateEvent,
+            resource: debate,
+            recipient_ids: form.current_feature.participatory_space.followers.pluck(:id),
+            extra: {
+              type: "participatory_space"
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/debates/admin/update_debate.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Admin
+      # This command is executed when the user changes a Debate from the admin
+      # panel.
+      class UpdateDebate < Rectify::Command
+        # Initializes a UpdateDebate Command.
+        #
+        # form - The form from which to get the data.
+        # debate - The current instance of the page to be updated.
+        def initialize(form, debate)
+          @form = form
+          @debate = debate
+        end
+
+        # Updates the debate if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          update_debate
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :debate, :form
+
+        def update_debate
+          debate.update_attributes!(
+            category: form.category,
+            title: form.title,
+            description: form.description,
+            information_updates: form.information_updates,
+            instructions: form.instructions,
+            end_time: form.end_time,
+            start_time: form.start_time
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/debates/create_debate.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    # This command is executed when the user creates a Debate from the public
+    # views.
+    class CreateDebate < Rectify::Command
+      def initialize(form)
+        @form = form
+      end
+
+      # Creates the debate if valid.
+      #
+      # Broadcasts :ok if successful, :invalid otherwise.
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        transaction do
+          create_debate
+          send_notifications
+        end
+        broadcast(:ok, debate)
+      end
+
+      private
+
+      attr_reader :debate, :form
+
+      def organization
+        @organization = form.current_feature.organization
+      end
+
+      def i18n_field(field)
+        organization.available_locales.inject({}) do |i18n, locale|
+          i18n.update(locale => field)
+        end
+      end
+
+      def create_debate
+        @debate = Debate.create!(
+          author: form.current_user,
+          decidim_user_group_id: form.user_group_id,
+          category: form.category,
+          title: i18n_field(form.title),
+          description: i18n_field(form.description),
+          feature: form.current_feature
+        )
+      end
+
+      def send_notifications
+        send_notification(debate.author.followers.pluck(:id), :user)
+        send_notification(debate.participatory_space.followers.pluck(:id), :participatory_space)
+      end
+
+      def send_notification(recipient_ids, type)
+        Decidim::EventsManager.publish(
+          event: "decidim.events.debates.debate_created",
+          event_class: Decidim::Debates::CreateDebateEvent,
+          resource: debate,
+          recipient_ids: recipient_ids,
+          extra: {
+            type: type.to_s
+          }
+        )
+      end
+    end
+  end
+end

data/app/controllers/decidim/debates/admin/application_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Features::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::Features::BaseController
+      end
+    end
+  end
+end

data/app/controllers/decidim/debates/admin/debates_controller.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Admin
+      # This controller allows an admin to manage debates from a Participatory Space
+      class DebatesController < Admin::ApplicationController
+        helper_method :debates
+
+        def new
+          @form = form(Decidim::Debates::Admin::DebateForm).instance
+        end
+
+        def create
+          @form = form(Decidim::Debates::Admin::DebateForm).from_params(params, current_feature: current_feature)
+
+          CreateDebate.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("debates.create.success", scope: "decidim.debates.admin")
+              redirect_to debates_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("debates.create.invalid", scope: "decidim.debates.admin")
+              render action: "new"
+            end
+          end
+        end
+
+        def edit
+          authorize! :edit, debate
+          @form = form(DebateForm).from_model(debate)
+        end
+
+        def update
+          authorize! :edit, debate
+          @form = form(DebateForm).from_params(params, current_feature: current_feature)
+
+          UpdateDebate.call(@form, debate) do
+            on(:ok) do
+              flash[:notice] = I18n.t("debates.update.success", scope: "decidim.debates.admin")
+              redirect_to debates_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("debates.update.invalid", scope: "decidim.debates.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        def destroy
+          authorize! :destroy, debate
+          debate.destroy!
+
+          flash[:notice] = I18n.t("debates.destroy.success", scope: "decidim.debates.admin")
+
+          redirect_to debates_path
+        end
+
+        private
+
+        def debates
+          @debates ||= Debate.where(feature: current_feature)
+        end
+
+        def debate
+          @debate ||= debates.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/debates/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Features::BaseController
+    end
+  end
+end

data/app/controllers/decidim/debates/debates_controller.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    # Exposes the debate resource so users can view them
+    class DebatesController < Decidim::Debates::ApplicationController
+      helper Decidim::ApplicationHelper
+      helper Decidim::Messaging::ConversationHelper
+      include FormFactory
+      include FilterResource
+      include Paginable
+
+      helper_method :debates, :debate, :paginated_debates, :report_form
+
+      def new
+        authorize! :create, Debate
+
+        @form = form(DebateForm).instance
+      end
+
+      def create
+        authorize! :create, Debate
+        @form = form(DebateForm).from_params(params, current_feature: current_feature)
+
+        CreateDebate.call(@form) do
+          on(:ok) do |debate|
+            flash[:notice] = I18n.t("debates.create.success", scope: "decidim.debates")
+            redirect_to Decidim::ResourceLocatorPresenter.new(debate).path
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("debates.create.invalid", scope: "decidim.debates")
+            render action: "new"
+          end
+        end
+      end
+
+      private
+
+      def paginated_debates
+        @paginated_debates ||= paginate(debates)
+                               .includes(:category)
+      end
+
+      def debates
+        @debates ||= search.results
+      end
+
+      def debate
+        @debate ||= debates.find(params[:id])
+      end
+
+      def report_form
+        @report_form ||= form(Decidim::ReportForm).from_params(reason: "spam")
+      end
+
+      def search_klass
+        DebateSearch
+      end
+
+      def default_search_params
+        {
+          page: params[:page],
+          per_page: 12
+        }
+      end
+
+      def default_filter_params
+        {
+          search_text: "",
+          order_start_time: "asc",
+          origin: "all",
+          category_id: ""
+        }
+      end
+    end
+  end
+end

data/app/events/decidim/debates/create_debate_event.rb

@@ -0,0 +1,42 @@
+# frozen-string_literal: true
+
+module Decidim
+  module Debates
+    # Notifies users about a new debate. Accepts a Hash in the `extra`
+    # field with the key `:type`, which can hold two different values:
+    #
+    # "user" - The event is being sent to the followers of the debate
+    #          author
+    # "participatory_space" - The event is being sento to the followers
+    #                         of the event's participatory space.
+    class CreateDebateEvent < Decidim::Events::SimpleEvent
+      include Decidim::Events::AuthorEvent
+
+      i18n_attributes :space_title, :space_path
+
+      delegate :author, to: :resource
+
+      private
+
+      def space
+        @space ||= resource.participatory_space
+      end
+
+      def space_path
+        Decidim::ResourceLocatorPresenter.new(space).path
+      end
+
+      def space_title
+        space.title.is_a?(Hash) ? space.title[I18n.locale.to_s] : space.title
+      end
+
+      def i18n_scope
+        @scope ||= if extra[:type].to_s == "user"
+                     "decidim.events.debates.create_debate_event.user_followers"
+                   else
+                     "decidim.events.debates.create_debate_event.space_followers"
+                   end
+      end
+    end
+  end
+end

data/app/forms/decidim/debates/admin/debate_form.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Admin
+      # This class holds a Form to create/update debates from Decidim's admin panel.
+      class DebateForm < Decidim::Form
+        include TranslatableAttributes
+
+        translatable_attribute :title, String
+        translatable_attribute :description, String
+        translatable_attribute :instructions, String
+        translatable_attribute :information_updates, String
+        attribute :start_time, DateTime
+        attribute :end_time, DateTime
+        attribute :decidim_category_id, Integer
+
+        validates :title, translatable_presence: true
+        validates :description, translatable_presence: true
+        validates :instructions, translatable_presence: true
+        validates :start_time, presence: { if: ->(object) { object.end_time.present? } }, date: { before: :end_time, allow_blank: true }
+        validates :end_time, presence: { if: ->(object) { object.start_time.present? } }, date: { after: :start_time, allow_blank: true }
+
+        validates :category, presence: true, if: ->(form) { form.decidim_category_id.present? }
+
+        def category
+          return unless current_feature
+          @category ||= current_feature.categories.where(id: decidim_category_id).first
+        end
+      end
+    end
+  end
+end