decidim-collaborative_texts 0.31.0.rc1

data/app/packs/stylesheets/decidim/collaborative_texts/collaborative_texts.scss

@@ -0,0 +1,287 @@
+.collaborative-texts {
+  &-toc {
+    @apply w-full py-8 lg:sticky top-0;
+
+    .spinner-container::after {
+      @apply bg-transparent;
+    }
+
+    ul {
+      @apply list-none;
+
+      li {
+        @apply flex items-center gap-2 text-secondary text-lg leading-8 cursor-pointer;
+      }
+    }
+  }
+
+  &-container {
+    @apply relative mb-8 md:mr-[18rem] pr-4;
+
+    h2 {
+      @apply mt-8;
+    }
+  }
+
+  &-hidden:not(&-highlight-shown),
+  &-highlight-hidden {
+    @apply hidden;
+  }
+
+  &-manager {
+    @apply sticky top-4 drop-shadow z-10 p-4 bg-background rounded border border-black;
+
+    > div {
+      @apply flex justify-between gap-2 mb-4;
+    }
+
+    &.hidden {
+      display: none;
+    }
+
+    &-applied,
+    &-pending {
+      @apply font-bold;
+    }
+  }
+
+  &-alert {
+    @apply fixed top-8 border-alert z-[40] bg-white rounded;
+
+    > div {
+      @apply flex items-center gap-2 p-4 bg-alert/20 rounded;
+    }
+  }
+
+  &-selection {
+    @apply hidden;
+  }
+
+  &-highlight {
+    @apply relative outline-dashed outline-1 outline-offset-2 outline-gray;
+
+    &:not(.applied) .collaborative-texts-hidden {
+      @apply block;
+    }
+  }
+
+  &-editor {
+    @apply bg-gray-5 mb-4 p-2 pt-1 rounded;
+
+    &-header {
+      @apply flex gap-2 border-b border-gray-6 justify-between items-baseline;
+
+      > svg {
+        @apply fill-secondary text-md;
+      }
+    }
+
+    &-profile {
+      @apply mt-4;
+
+      a {
+        @apply text-black;
+      }
+
+      img {
+        @apply my-0;
+      }
+    }
+
+    &-container {
+      @apply px-2 pt-2 pb-4 my-4 bg-white rounded border border-gray-2 text-md;
+
+      &:focus-visible {
+        @apply outline-none;
+      }
+    }
+
+    &-menu {
+      @apply flex justify-end;
+    }
+  }
+
+  &-menu {
+    @apply absolute top-0 right-0 z-[9] flex gap-2;
+  }
+
+  &-suggestions-box {
+    @apply bg-gray-5 shadow outline outline-gray-3 outline-1 text-xs rounded px-2 pb-2 pt-1 md:pt-0 md:absolute md:top-0 md:right-[-18rem] md:w-[18rem] md:transition-all ease-in-out duration-300;
+
+    .icon {
+      @apply inline-block text-md mr-2;
+
+      &-hover,
+      &-applied {
+        @apply hidden;
+      }
+    }
+
+    &:has([aria-hidden="false"]) {
+      @apply z-[9] shadow-lg;
+
+      &:has(.collaborative-texts-suggestions-box-item:hover) {
+        .icon-pending {
+          @apply hidden;
+        }
+
+        .icon-applied {
+          @apply hidden;
+        }
+
+        .icon-hover {
+          @apply inline-block;
+        }
+      }
+
+      &:has(.applied.collaborative-texts-suggestions-box-item:hover) {
+        .icon-hover {
+          @apply hidden;
+        }
+
+        .icon-applied {
+          @apply inline-block;
+        }
+      }
+    }
+
+    &:has(.applied) {
+      .icon-applied {
+        @apply inline-block;
+      }
+
+      .icon-pending {
+        @apply hidden;
+      }
+
+      .icon-hover {
+        @apply hidden;
+      }
+    }
+
+    &:hover {
+      @apply z-10;
+    }
+
+    &-header {
+      @apply flex items-center justify-between text-secondary mb-4 fill-secondary;
+    }
+
+    &-item {
+      @apply p-2 pr-0 mb-4 rounded w-full;
+
+      &:hover {
+        @apply bg-white drop-shadow relative z-[1];
+      }
+
+      .button-restore {
+        @apply hidden;
+      }
+
+      &.applied {
+        @apply bg-white drop-shadow;
+
+        .button-restore {
+          @apply flex;
+        }
+
+        .button-apply {
+          @apply hidden;
+        }
+      }
+
+      img {
+        @apply m-0;
+      }
+
+      .text {
+        @apply font-semibold;
+      }
+    }
+
+    &-item-header {
+      @apply flex items-center justify-between;
+    }
+
+    [data-controller="accordion"] {
+      @apply relative bg-gray-5;
+
+      > button {
+        @apply flex outline-none w-full justify-between;
+
+        svg {
+          @apply fill-secondary;
+        }
+      }
+
+      [id*="panel"][aria-hidden="false"] {
+        @apply z-10 relative;
+      }
+
+      [aria-expanded="false"] > svg:last-of-type,
+      [aria-expanded="false"] > span:last-of-type,
+      [aria-expanded="true"] > span:first-of-type,
+      [aria-expanded="true"] > svg:first-of-type {
+        @apply hidden;
+      }
+
+      [aria-expanded="true"] > svg:last-of-type,
+      [aria-expanded="true"] > span:last-of-type,
+      [aria-expanded="false"] > span:first-of-type,
+      [aria-expanded="false"] > svg:first-of-type {
+        @apply block;
+      }
+    }
+
+    /* overwrite default dropdown styles */
+    [id*="dropdown-trigger"] {
+      @apply flex pr-1;
+
+      > svg {
+        @apply h-3 w-3;
+      }
+    }
+
+    [id*="dropdown-menu"] {
+      @apply cursor-auto w-auto;
+
+      &[aria-hidden="true"] {
+        @apply hidden;
+      }
+
+      ul {
+        @apply list-none;
+      }
+
+      &[aria-hidden="false"] {
+        animation-name: fadeIn;
+        animation-duration: 300ms;
+        animation-fill-mode: forwards;
+      }
+
+      @keyframes fadeIn {
+        from {
+          opacity: 0;
+          visibility: hidden;
+        }
+
+        to {
+          opacity: 1;
+          visibility: visible;
+        }
+      }
+
+      @keyframes fadeOut {
+        from {
+          opacity: 1;
+          visibility: visible;
+        }
+
+        to {
+          opacity: 0;
+          visibility: hidden;
+        }
+      }
+    }
+  }
+}

data/app/permissions/decidim/collaborative_texts/admin/permissions.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    module Admin
+      class Permissions < Decidim::DefaultPermissions
+        def permissions
+          return permission_action if permission_action.scope != :admin
+
+          return permission_action if permission_action.subject != :collaborative_text
+
+          case permission_action.action
+          when :update, :read, :create, :destroy
+            allow!
+          end
+
+          permission_action
+        end
+
+        private
+
+        def document
+          @document ||= context.fetch(:document, nil)
+        end
+      end
+    end
+  end
+end

data/app/permissions/decidim/collaborative_texts/permissions.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    class Permissions < Decidim::DefaultPermissions
+      def permissions
+        # Delegate the admin permission checks to the admin permissions class
+        return Decidim::CollaborativeTexts::Admin::Permissions.new(user, permission_action, context).permissions if permission_action.scope == :admin
+        return permission_action if permission_action.scope != :public
+
+        return permission_action if permission_action.subject != :collaborative_text
+
+        case permission_action.action
+        when :suggest
+          allow! if user
+        when :rollout
+          allow! if user && (user.admin? || space_allows_admin_access?)
+        end
+
+        permission_action
+      end
+
+      private
+
+      def document
+        @document ||= context.fetch(:document, nil) || context.fetch(:resource, nil)
+      end
+
+      def space_allows_admin_access?
+        return false unless document.participatory_space.respond_to?(:admins)
+
+        document.participatory_space.admins.exists?(id: user.id)
+      end
+    end
+  end
+end

data/app/presenters/decidim/collaborative_texts/admin_log/document_presenter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    module AdminLog
+      # This class holds the logic to present a `Decidim::CollaborativeTexts::Document`
+      # for the `AdminLog` log.
+      class DocumentPresenter < Decidim::Log::BasePresenter
+        private
+
+        def action_string
+          case action
+          when "create", "delete", "update", "soft_delete", "restore", "publish", "unpublish"
+            "decidim.collaborative_texts.admin_log.document.#{action}"
+          else
+            super
+          end
+        end
+
+        def diff_fields_mapping
+          {
+            title: :string,
+            body: :string,
+            version_number: :integer
+          }
+        end
+
+        def i18n_labels_scope
+          "activemodel.attributes.collaborative_texts.document"
+        end
+
+        # adds the body from the version to the changeset
+        def changeset
+          Decidim::Log::DiffChangesetCalculator.new(
+            full_changeset,
+            diff_fields_mapping,
+            i18n_labels_scope
+          ).changeset
+        end
+
+        def full_changeset
+          action_log.version.changeset.tap do |changeset|
+            if action == "create"
+              changeset[:body] = [nil, action_log&.extra&.dig("extra", "body")]
+              changeset[:version_number] = [nil, "1"]
+            elsif (version_number = action_log&.extra&.dig("extra", "version_number"))
+              changeset[:version_number] = [nil, version_number]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/collaborative_texts/admin_log/suggestion_presenter.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    module AdminLog
+      # This class holds the logic to present a `Decidim::CollaborativeTexts::Suggestion`
+      # for the `AdminLog` log.
+      # Note that this is only used in updates, creation is handled by the document creation.
+      #
+      class SuggestionPresenter < Decidim::Log::BasePresenter
+        private
+
+        def action_string
+          case action
+          when "create"
+            "decidim.collaborative_texts.admin_log.suggestion.#{action}"
+          else
+            super
+          end
+        end
+
+        def i18n_labels_scope
+          "activemodel.attributes.collaborative_texts.suggestion"
+        end
+
+        def diff_fields_mapping
+          {
+            original: :array,
+            replace: :array,
+            nodes: :array
+          }
+        end
+
+        # Private: Caches the object that will be responsible of presenting the newsletter.
+        # Overwrites the method so that we can use a custom presenter to show the correct
+        # path for the newsletter.
+        #
+        # Returns an object that responds to `present`.
+        def resource_presenter
+          @resource_presenter ||= Decidim::CollaborativeTexts::AdminLog::SuggestionResourcePresenter.new(action_log.resource, h, action_log.extra["resource"])
+        end
+
+        #
+        # Currently, only the action "create" exists. Update this if other
+        # actions are added in the future.
+        def changeset
+          changeset = action_log.version.changeset
+          current = changeset.delete("changeset")[1]
+          changeset["original"] = [nil, current["original"]]
+          changeset["replace"] = [nil, current["replace"]]
+          changeset["nodes"] = [nil, (current["firstNode"]..current["lastNode"]).to_a]
+
+          Decidim::Log::DiffChangesetCalculator.new(
+            changeset,
+            diff_fields_mapping,
+            i18n_labels_scope
+          ).changeset
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/collaborative_texts/admin_log/suggestion_resource_presenter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    module AdminLog
+      # This class extends the default resource presenter for logs, so that
+      # it can properly link to the newsletter.
+      class SuggestionResourcePresenter < Decidim::Log::ResourcePresenter
+        private
+
+        # Private: Finds the admin link for the newsletter.
+        #
+        # Returns an HTML-safe String.
+        def resource_path
+          @resource_path ||= Decidim::ResourceLocatorPresenter.new(resource.document).path(anchor: "ct-node-#{resource.changeset["firstNode"]}")
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/collaborative_texts/admin_log/version_presenter.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    module AdminLog
+      # This class holds the logic to present a `Decidim::CollaborativeTexts::Version`
+      # for the `AdminLog` log.
+      # Note that this is only used in updates, creation is handled by the document creation.
+      #
+      class VersionPresenter < Decidim::Log::BasePresenter
+        private
+
+        def action_string
+          case action
+          when "delete", "update"
+            "decidim.collaborative_texts.admin_log.version.#{action}"
+          else
+            super
+          end
+        end
+
+        def i18n_labels_scope
+          "activemodel.attributes.collaborative_texts.version"
+        end
+
+        def diff_fields_mapping
+          {
+            body: :string,
+            draft: :boolean,
+            version_number: :integer
+          }
+        end
+
+        def changeset
+          Decidim::Log::DiffChangesetCalculator.new(
+            full_changeset,
+            diff_fields_mapping,
+            i18n_labels_scope
+          ).changeset
+        end
+
+        def full_changeset
+          action_log.version.changeset.tap do |changeset|
+            changeset[:version_number] = [
+              nil,
+              action_log.extra.dig("extra", "version_number")
+            ]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    #
+    # A dummy presenter to abstract out the author of an official post.
+    #
+    class OfficialAuthorPresenter < Decidim::OfficialAuthorPresenter
+    end
+  end
+end

data/app/presenters/decidim/collaborative_texts/suggestion_presenter.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    #
+    # Decorator for collaborative texts suggestions.
+    #
+    class SuggestionPresenter < Decidim::ResourcePresenter
+      include Decidim::ApplicationHelper
+
+      delegate :changeset, :status, :created_at, :author, to: :suggestion
+      # A summary to print in the UI
+      def summary
+        txt = type == :remove ? original : text
+        @summary ||= I18n.t("decidim.collaborative_texts.suggestion.#{type}_html", text: txt.truncate(150))
+      end
+
+      # A text representation of the changeset. Without HTML.
+      def text
+        @text ||= ActionView::Base.full_sanitizer.sanitize(changeset["replace"]&.join(" ")&.strip).to_s
+      end
+
+      def original
+        @original ||= ActionView::Base.full_sanitizer.sanitize(changeset["original"]&.join(" ")&.strip).to_s
+      end
+
+      def suggestion
+        __getobj__
+      end
+
+      # Render the suggestion title
+      #
+      # Returns a String.
+      def title(html_escape: false, all_locales: false)
+        super(suggestion.document.title, html_escape, all_locales)
+      end
+
+      def type
+        return :remove if text.blank?
+        return :add if text.include?(original.to_s)
+
+        :replace
+      end
+
+      def safe_json
+        {
+          id:,
+          changeset:,
+          summary:,
+          status:,
+          type:,
+          createdAt: created_at
+        }
+      end
+    end
+  end
+end

data/app/views/decidim/collaborative_texts/admin/documents/_actions.html.erb

@@ -0,0 +1,82 @@
+<button type="button" data-controller="dropdown" data-target="actions-post-<%= document.id %>" aria-label="<%= t("decidim.admin.actions.actions_label", resource: document.title) %>">
+  <%= icon "more-fill", class: "text-secondary" %>
+</button>
+
+<div class="inline-block relative">
+  <ul id="actions-post-<%= document.id %>" class="dropdown dropdown__action" aria-hidden="true">
+    <% if view == :deleted %>
+      <% if allowed_to? :restore, :collaborative_text, trashable_deleted_resource: document %>
+        <li class="dropdown__item">
+          <%= link_to restore_document_path(document), method: :patch, class: "dropdown__button" do %>
+            <%= icon "refresh-line" %>
+            <%= t("actions.restore", scope: "decidim.admin") %>
+          <% end %>
+        </li>
+      <% end %>
+    <% else %>
+      <% if allowed_to? :update, :collaborative_text, document: document %>
+        <li class="dropdown__item">
+          <%= link_to edit_document_path(document), class: "dropdown__button" do %>
+            <%= icon "pencil-line" %>
+            <%= t("actions.edit", scope: "decidim.collaborative_texts") %>
+          <% end %>
+        </li>
+        <li class="dropdown__item">
+          <%= link_to edit_settings_document_path(document), class: "dropdown__button" do %>
+            <%= icon "settings-4-line" %>
+            <%= t("actions.manage", scope: "decidim.collaborative_texts") %>
+          <% end %>
+        </li>
+      <% end %>
+
+      <% if allowed_to?(:update, :collaborative_text, document: document) %>
+        <hr>
+
+        <% if document.published? %>
+          <li class="dropdown__item">
+            <%= link_to unpublish_document_path(document), method: :put, class: "dropdown__button" do %>
+              <%= icon "close-circle-line" %>
+              <%= t("actions.unpublish", scope: "decidim.admin") %>
+            <% end %>
+          </li>
+        <% else %>
+          <li class="dropdown__item">
+            <%= link_to publish_document_path(document), method: :put, class: "dropdown__button" do %>
+              <%= icon "check-line" %>
+              <%= t("actions.publish", scope: "decidim.admin") %>
+            <% end %>
+          </li>
+        <% end %>
+      <% end %>
+
+      <hr>
+
+      <li class="dropdown__item">
+        <%= link_to resource_locator(document).path, target: :blank, data: { "external-link": false }, class: "dropdown__button" do %>
+          <%= icon "eye-line" %>
+          <%= t("actions.preview", scope: "decidim.admin") %>
+        <% end %>
+      </li>
+
+      <hr>
+
+      <li class="dropdown__item">
+        <% if allowed_to? :soft_delete, :collaborative_text, trashable_deleted_resource: document %>
+          <%= link_to soft_delete_document_path(document), method: :patch, data: { confirm: t("actions.confirm_delete_document", scope: "decidim.collaborative_texts") }, class: "dropdown__button" do %>
+            <%= icon "delete-bin-line" %>
+            <%= t("actions.soft_delete", scope: "decidim.admin") %>
+          <% end %>
+        <% else %>
+          <div class="dropdown__button-disabled">
+            <%= with_tooltip t("tooltips.deleted_collaborative_texts_info", scope: "decidim.admin") do %>
+              <%= icon "delete-bin-line", class: "text-gray" %>
+              <span>
+                <%= t("actions.soft_delete", scope: "decidim.admin") %>
+              </span>
+            <% end %>
+          </div>
+        <% end %>
+      </li>
+    <% end %>
+  </ul>
+</div>