decidim-debates 0.9.0

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    # This class holds a Form to create/update debates from Decidim's admin panel.
+    class DebateForm < Decidim::Form
+      include TranslatableAttributes
+
+      attribute :title, String
+      attribute :description, String
+      attribute :category_id, Integer
+      attribute :user_group_id, Integer
+
+      validates :title, presence: true
+      validates :description, presence: true
+
+      validates :category, presence: true, if: ->(form) { form.category_id.present? }
+
+      def category
+        return unless current_feature
+        @category ||= current_feature.categories.where(id: category_id).first
+      end
+    end
+  end
+end

data/app/helpers/decidim/debates/application_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    # Custom helpers, scoped to the debates engine.
+    #
+    module ApplicationHelper
+      include PaginateHelper
+      include Decidim::Comments::CommentsHelper
+    end
+  end
+end

data/app/models/decidim/debates/abilities/admin/admin_ability.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Abilities
+      module Admin
+        # Defines the abilities related to debates for an admin user.
+        # Intended to be used with `cancancan`.
+        class AdminAbility < Decidim::Abilities::AdminAbility
+          def define_abilities
+            can :manage, Debate do |debate|
+              debate.author.blank?
+            end
+            can :unreport, Debate
+            can :hide, Debate
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/debates/abilities/admin/participatory_process_admin_ability.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Abilities
+      module Admin
+        # Defines the abilities related to debates for a logged in process admin user.
+        # Intended to be used with `cancancan`.
+        class ParticipatoryProcessAdminAbility < Decidim::Abilities::ParticipatoryProcessAdminAbility
+          def define_participatory_process_abilities
+            super
+
+            can :manage, Debate do |debate|
+              debate.author.blank?
+            end
+            can :unreport, Debate
+            can :hide, Debate
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/debates/abilities/admin/participatory_process_moderator_ability.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Abilities
+      module Admin
+        # Defines the abilities related to Debate for a logged in process admin user.
+        # Intended to be used with `cancancan`.
+        class ParticipatoryProcessModeratorAbility < Decidim::Abilities::ParticipatoryProcessModeratorAbility
+          def define_participatory_process_abilities
+            super
+
+            can [:unreport, :hide], Debate do |debate|
+              can_manage_process?(debate.feature.participatory_space)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/debates/abilities/current_user_ability.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Abilities
+      # Defines the abilities related to debates for a logged in user.
+      # Intended to be used with `cancancan`.
+      class CurrentUserAbility
+        include CanCan::Ability
+
+        attr_reader :user, :context
+
+        def initialize(user, context)
+          return unless user
+
+          @user = user
+          @context = context
+
+          can :create, Debate if authorized?(:create) && creation_enabled?
+          can :report, Debate
+        end
+
+        private
+
+        def authorized?(action)
+          return unless feature
+
+          ActionAuthorizer.new(user, feature, action).authorize.ok?
+        end
+
+        def creation_enabled?
+          return unless current_settings
+          current_settings.creation_enabled?
+        end
+
+        def current_settings
+          context.fetch(:current_settings, nil)
+        end
+
+        def feature
+          feature = context.fetch(:current_feature, nil)
+          return nil unless feature && feature.manifest.name == :debates
+
+          feature
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/debates/application_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/debates/debate.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    # The data store for a Debate in the Decidim::Debates component. It stores a
+    # title, description and any other useful information to render a custom
+    # debate.
+    class Debate < Debates::ApplicationRecord
+      include Decidim::HasFeature
+      include Decidim::HasCategory
+      include Decidim::Resourceable
+      include Decidim::Followable
+      include Decidim::Comments::Commentable
+      include Decidim::HasScope
+      include Decidim::Authorable
+      include Decidim::Reportable
+      include Decidim::HasReference
+
+      feature_manifest_name "debates"
+
+      validates :title, presence: true
+
+      # Public: Checks whether the debate is official or not.
+      #
+      # Returns a boolean.
+      def official?
+        author.blank?
+      end
+
+      # Public: Overrides the `reported_content_url` Reportable concern method.
+      def reported_content_url
+        ResourceLocatorPresenter.new(self).url
+      end
+
+      # Public: Calculates whether the current debate is an AMA-styled one or not.
+      # AMA-styled debates are those that have a start and end time set, and comments
+      # are only open during that timelapse. AMA stands for Ask Me Anything, a type
+      # of debate inspired by Reddit.
+      #
+      # Returns a Boolean.
+      def ama?
+        start_time.present? && end_time.present?
+      end
+
+      # Public: Checks whether the debate is an AMA-styled one and is open.
+      #
+      # Returns a boolean.
+      def open_ama?
+        ama? && Time.current.between?(start_time, end_time)
+      end
+
+      # Public: Checks if the debate is open or not.
+      #
+      # Returns a boolean.
+      def open?
+        (ama? && open_ama?) || !ama?
+      end
+
+      # Public: Overrides the `commentable?` Commentable concern method.
+      def commentable?
+        feature.settings.comments_enabled?
+      end
+
+      # Public: Overrides the `accepts_new_comments?` Commentable concern method.
+      def accepts_new_comments?
+        return false unless open?
+        commentable? && !comments_blocked?
+      end
+
+      # Public: Overrides the `comments_have_alignment?` Commentable concern method.
+      def comments_have_alignment?
+        true
+      end
+
+      # Public: Overrides the `comments_have_votes?` Commentable concern method.
+      def comments_have_votes?
+        true
+      end
+
+      # Public: Identifies the commentable type in the API.
+      def commentable_type
+        self.class.name
+      end
+
+      # Public: Overrides the `notifiable?` Notifiable concern method.
+      def notifiable?(_context)
+        false
+      end
+
+      # Public: Override Commentable concern method `users_to_notify_on_comment_created`
+      def users_to_notify_on_comment_created
+        return (followers | feature.participatory_space.admins).uniq if official?
+        followers
+      end
+
+      private
+
+      def comments_blocked?
+        feature.current_settings.comments_blocked
+      end
+    end
+  end
+end

data/app/presenters/decidim/debates/debate_presenter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    #
+    # Decorator for debates
+    #
+    class DebatePresenter < SimpleDelegator
+      def author
+        @author ||= if official?
+                      Decidim::Debates::OfficialAuthorPresenter.new
+                    elsif user_group
+                      Decidim::UserGroupPresenter.new(user_group)
+                    else
+                      Decidim::UserPresenter.new(super)
+                    end
+      end
+    end
+  end
+end

data/app/presenters/decidim/debates/official_author_presenter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    #
+    # A dummy presenter to abstract out the author of an official debate.
+    #
+    class OfficialAuthorPresenter
+      def name
+        I18n.t("decidim.debates.models.debate.fields.official_debate")
+      end
+
+      def nickname
+        ""
+      end
+
+      def badge
+        ""
+      end
+
+      def profile_path
+        ""
+      end
+
+      def avatar_url
+        ActionController::Base.helpers.asset_path("decidim/default-avatar.svg")
+      end
+
+      def deleted?
+        false
+      end
+    end
+  end
+end

data/app/services/decidim/debates/debate_search.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    # This class handles search and filtering of debates. Needs a
+    # `current_feature` param with a `Decidim::Feature` in order to
+    # find the debates.
+    class DebateSearch < ResourceSearch
+      # Public: Initializes the service.
+      # feature     - A Decidim::Feature to get the debates from.
+      # page        - The page number to paginate the results.
+      # per_page    - The number of proposals to return per page.
+      def initialize(options = {})
+        super(Debate.not_hidden, options)
+      end
+
+      # Handle the search_text filter. We have to cast the JSONB columns
+      # into a `text` type so that we can search.
+      def search_search_text
+        query
+          .where("title::text ILIKE ?", "%#{search_text}%")
+          .or(query.where("description::text ILIKE ?", "%#{search_text}%"))
+      end
+
+      # Handle the origin filter
+      # The 'official' debates don't have an author ID
+      def search_origin
+        if origin == "official"
+          query.where(decidim_author_id: nil)
+        elsif origin == "citizens"
+          query.where.not(decidim_author_id: nil)
+        else # Assume 'all'
+          query
+        end
+      end
+    end
+  end
+end

data/app/views/decidim/debates/admin/debates/_form.html.erb

@@ -0,0 +1,36 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title"><%= title %></h2>
+  </div>
+
+  <div class="card-section">
+    <div class="row column" >
+      <%= form.translated :text_field, :title, autofocus: true %>
+    </div>
+
+    <div class="row column" >
+      <%= form.translated :editor, :description %>
+    </div>
+
+    <div class="row column" >
+      <%= form.translated :editor, :instructions %>
+    </div>
+
+    <div class="row column" >
+      <%= form.translated :editor, :information_updates %>
+    </div>
+
+    <div class="row" >
+      <div class="column xlarge-6">
+        <%= form.datetime_field :start_time %>
+      </div>
+      <div class="column xlarge-6">
+        <%= form.datetime_field :end_time %>
+      </div>
+    </div>
+
+    <div class="row column" >
+      <%= form.categories_select :decidim_category_id, current_participatory_space.categories, prompt: "", disable_parents: false %>
+    </div>
+  </div>
+</div>

data/app/views/decidim/debates/admin/debates/edit.html.erb

@@ -0,0 +1,7 @@
+<%= decidim_form_for(@form, html: { class: "form edit_debate" }) do |f| %>
+  <%= render partial: 'form', object: f, locals: { title: t('.title') } %>
+
+  <div class="button--double form-general-submit">
+    <%= f.submit t(".update") %>
+  </div>
+<% end %>

data/app/views/decidim/debates/admin/debates/index.html.erb

@@ -0,0 +1,52 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title">
+      <%= t(".title") %>
+
+      <%= link_to t("actions.new", scope: "decidim.debates", name: t("models.debate.name", scope: "decidim.debates.admin")), new_debate_path, class: 'button tiny button--title' if can? :manage, current_feature %>
+    </h2>
+  </div>
+
+  <div class="card-section">
+    <div class="table-scroll">
+      <table class="table-list">
+        <thead>
+          <tr>
+            <th><%= t("models.debate.fields.title", scope: "decidim.debates") %></th>
+            <th><%= t("models.debate.fields.start_time", scope: "decidim.debates") %></th>
+            <th><%= t("models.debate.fields.end_time", scope: "decidim.debates") %></th>
+            <th class="actions"><%= t("actions.title", scope: "decidim.debates") %></th>
+          </tr>
+        </thead>
+        <tbody>
+          <% debates.each do |debate| %>
+            <tr data-id="<%= debate.id %>">
+              <td>
+                <%= link_to translated_attribute(debate.title), resource_locator(debate).path, target: :blank %><br />
+              </td>
+              <td>
+                <% if debate.start_time %>
+                  <%= l debate.start_time, format: :long %>
+                <%  end%>
+              </td>
+              <td>
+                <% if debate.end_time %>
+                  <%= l debate.end_time, format: :long %>
+                <%  end%>
+              </td>
+              <td class="table-list__actions">
+                <% if can? :update, debate %>
+                  <%= icon_link_to "pencil", edit_debate_path(debate), t("actions.edit", scope: "decidim.debates"), class: "action-icon--edit" %>
+                <% end %>
+
+                <% if can? :destroy, debate %>
+                  <%= icon_link_to "circle-x", debate_path(debate), t("actions.destroy", scope: "decidim.debates"), method: :delete, class: "action-icon--remove", data: { confirm: t("actions.confirm_destroy", scope: "decidim.debates") } %>
+                <% end %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>