decidim-participatory_documents 0.2.0 → 0.2.1

data/README.md

@@ -8,12 +8,17 @@
 
 This module allows to upload PDF (and possibilty other formats) and define areas on top of it that will become spaces for suggestions, improvements and other participative activities.
 
-> NOTE: in development, not ready for production.
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
+```ruby
+gem 'decidim-participatory_documents
+```
+
+Or, if you want to stay up to date with the latest changes use this line instead:
+
+
 ```ruby
 gem 'decidim-participatory_documents', git: "https://github.com/openpoke/decidim-module-participatory-documents"
 ```
@@ -23,45 +28,44 @@ And then execute:
 ```
 bundle
 bundle exec rails decidim_participatory_documents:install:migrations
+bundle exec rails decidim_participatory_documents:install_pdf_js
+bundle exec rails db:migrate
 ```
 
+Depending on your Decidim version, you can choose the corresponding version to ensure compatibility:
+
+| Version | Compatible Decidim versions |
+|---|---|
+| 0.2.x | 0.27.x |
+
+
 ## Usage
 
 TODO...
 
 
-Options such as `:max_suggestion_length`, `:min_suggestion_length` and etc. are configured at the component level in 
-the application. Defaults to the configured in the module:
-```ruby
-# lib/decidim/participatory_documents.rb
-
-module Decidim
-  # This namespace holds the logic of the `decidim-participatory_documents` module.
-  module ParticipatoryDocuments
-    include ActiveSupport::Configurable
-
-    # Public: The minimum length of a suggestion to be considered valid.
-    config_accessor :min_suggestion_length do
-      5
-    end
-    
-    # Public: The maximum length of a suggestion to be considered valid.
-    config_accessor :max_suggestion_length do
-      500
-    end
-  end
-end
-```
+## Configuration
 
-```ruby
-# config/initializers/participatory_documents.rb
+By default, the module is configured to read the configuration from ENV variables.
+
+Currently, the following ENV variables are supported:
 
+| ENV variable | Description | Default value |
+| ------------ | ----------- |-------|
+| MAX_EXPORT_TEXT_LENGTH | If a positive number, it will truncate the exported suggestions before sending them by email | `0` |
+| MIN_SUGGESTION_LENGTH | Minimum characters in a suggestion to be valid (this setting can be configured in each component as well by the admins) | `5` |
+| MAX_SUGGESTION_LENGTH | Maximum characters in a suggestion to be valid (this setting can be configured in each component as well by the admins) | `1000` |
+
+It is also possible to configure the module using the `decidim-participatory_documents` initializer:
+
+```ruby
 Decidim::ParticipatoryDocuments.configure do |config|
+  config.max_export_text_length = 0
+  config.min_suggestion_length = 5
+  config.max_suggestion_length = 1000
 end
 ```
 
-And, of course, having these values in your `config/secrets.yml` file.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/openpoke/decidim-module-participatory-documents.

data/app/commands/decidim/participatory_documents/create_suggestion.rb

@@ -29,10 +29,12 @@ module Decidim
       attr_reader :form, :suggestion, :suggestable
 
       def create_suggestion
+        sanitized_body = Decidim::ContentProcessor.sanitize(form.body)
+
         @suggestion = Decidim.traceability.create!(
           Decidim::ParticipatoryDocuments::Suggestion,
           form.current_user,
-          { body: { I18n.locale => form.body },
+          { body: { I18n.locale => sanitized_body },
             suggestable: suggestable,
             author: form.current_user },
           visibility: "public-only"

data/app/controllers/concerns/decidim/participatory_documents/needs_pdf_document.rb

@@ -7,7 +7,7 @@ module Decidim
       extend ActiveSupport::Concern
 
       included do
-        helper_method :document, :box_color_as_rgba, :pdf_custom_style
+        helper_method :document, :box_color_as_rgba, :pdf_custom_style, :all_suggestions
 
         protected
 
@@ -22,6 +22,13 @@ module Decidim
           @document ||= Decidim::ParticipatoryDocuments::Document.find_by(component: current_component)
         end
 
+        def all_suggestions
+          @all_suggestions ||= begin
+            manifest = document.component.manifest.export_manifests.find { |man| man.name == :suggestions }
+            manifest.collection.call(document.component, current_user, :my_suggestions)
+          end
+        end
+
         def box_color_as_rgba(document, opacity: nil)
           opacity ||= document.box_opacity
           return "rgba(30, 152, 215, 0.12);" unless document.box_color.present? && opacity.present?

data/app/controllers/decidim/participatory_documents/admin/documents_controller.rb

@@ -6,6 +6,7 @@ module Decidim
       # This controller allows admins to manage documents in a participatory process.
       class DocumentsController < Admin::ApplicationController
         include Decidim::ApplicationHelper
+        include Decidim::ComponentPathHelper
         include NeedsAdminSnippets
 
         helper Decidim::LayoutHelper
@@ -13,7 +14,6 @@ module Decidim
 
         before_action except: [:index, :new, :create] do
           redirect_to(documents_path) if document.blank?
-          redirect_to(edit_document_path(document)) unless document.file.attached?
         end
 
         def index
@@ -32,7 +32,9 @@ module Decidim
           CreateDocument.call(@form) do
             on(:ok) do |document|
               flash[:notice] = I18n.t("documents.create.success", scope: "decidim.participatory_documents.admin")
-              redirect_to edit_pdf_documents_path(id: document.id)
+
+              redirect_to(edit_pdf_documents_path(id: document.id)) && return if document.file.attached?
+              redirect_to(manage_component_path(document.component)) && return unless document.file.attached?
             end
 
             on(:invalid) do
@@ -69,7 +71,7 @@ module Decidim
         end
 
         def pdf_viewer
-          @form = form(SectionForm).from_params({})
+          @form = form(SectionForm).instance
           render layout: false
         end
 

data/app/controllers/decidim/participatory_documents/admin/suggestions_controller.rb

@@ -14,6 +14,8 @@ module Decidim
         helper_method :suggestions, :suggestion, :notes_form, :find_valuators_for_select, :suggestion_ids, :suggestion_find
 
         def show
+          enforce_permission_to :show, :suggestion, suggestion: suggestion
+
           @form = form(Decidim::ParticipatoryDocuments::Admin::AnswerSuggestionForm).from_model(suggestion)
         end
 
@@ -133,11 +135,29 @@ module Decidim
         end
 
         def base_query
+          valuator_roles_exist? ? suggestions_for_valuator : all_document_suggestions
+        end
+
+        def all_document_suggestions
           Suggestion.where(suggestable: document).or(Suggestion.where(suggestable: document.sections))
         end
 
+        def suggestions_for_valuator
+          valuator_suggestions_ids = Decidim::ParticipatoryDocuments::ValuationAssignment
+                                     .where(valuator_role: valuator_roles).pluck(:decidim_participatory_documents_suggestion_id)
+          Suggestion.where(id: valuator_suggestions_ids)
+        end
+
+        def valuator_roles
+          current_participatory_space.user_roles(:valuator).where(user: current_user)
+        end
+
+        def valuator_roles_exist?
+          valuator_roles.exists?
+        end
+
         def suggestion
-          base_query.find(params[:id])
+          base_query.find_by(id: params[:id])
         end
 
         # Internal: A method to cache to queries to find the valuators for the

data/app/controllers/decidim/participatory_documents/admin/valuation_assignments_controller.rb

@@ -30,7 +30,11 @@ module Decidim
           Admin::UnassignSuggestionsFromValuator.call(@form) do
             on(:ok) do |_proposal|
               flash.keep[:notice] = I18n.t("valuation_assignments.delete.success", scope: "decidim.participatory_documents.admin")
-              redirect_back fallback_location: EngineRouter.admin_proxy(current_component).root_path
+              if current_user == @form.valuator_user
+                redirect_to EngineRouter.admin_proxy(current_component).root_path
+              else
+                redirect_back fallback_location: EngineRouter.admin_proxy(current_component).root_path
+              end
             end
 
             on(:invalid) do

data/app/controllers/decidim/participatory_documents/document_suggestions_controller.rb

@@ -10,10 +10,14 @@ module Decidim
       layout false
 
       def index
+        enforce_permission_to :create, :suggestion
+
         @form = form(Decidim::ParticipatoryDocuments::SuggestionForm).instance
       end
 
       def create
+        enforce_permission_to :create, :suggestion
+
         @form = form(Decidim::ParticipatoryDocuments::SuggestionForm).from_params(params)
 
         CreateSuggestion.call(@form, section) do
@@ -26,6 +30,16 @@ module Decidim
         end
       end
 
+      def export
+        enforce_permission_to :create, :suggestion
+
+        return render json: { message: t(".empty") }, status: :unprocessable_entity unless all_suggestions.any?
+
+        ExportMySuggestionsJob.perform_later(current_user, document, "Excel")
+
+        render json: { message: t(".success", count: all_suggestions&.count, email: current_user&.email) }
+      end
+
       private
 
       def suggestions

data/app/controllers/decidim/participatory_documents/section_suggestions_controller.rb

@@ -10,10 +10,14 @@ module Decidim
       layout false
 
       def index
+        enforce_permission_to :create, :suggestion
+
         @form = form(Decidim::ParticipatoryDocuments::SuggestionForm).instance
       end
 
       def create
+        enforce_permission_to :create, :suggestion
+
         @form = form(Decidim::ParticipatoryDocuments::SuggestionForm).from_params(params)
 
         CreateSuggestion.call(@form, section) do

data/app/forms/decidim/participatory_documents/admin/document_form.rb

@@ -15,9 +15,10 @@ module Decidim
         attribute :box_color, String, default: "#1e98d7"
         attribute :box_opacity, Integer, default: 12
 
-        attribute :file
+        attribute :file, Decidim::Attributes::Blob
         attribute :remove_file, Boolean, default: false
 
+        validates :file, file_content_type: { allow: ["application/pdf"] }
         # ensure color and opacity are present
         def map_model(doc)
           self.box_color = doc.box_color.presence || "#1e98d7"

data/app/jobs/decidim/participatory_documents/export_my_suggestions_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    class ExportMySuggestionsJob < Decidim::ExportJob
+      def perform(user, document, format)
+        export_manifest = document.component.manifest.export_manifests.find { |manifest| manifest.name == :suggestions }
+        collection = export_manifest.collection.call(document.component, user, :my_suggestions)
+
+        export_data = Decidim::Exporters.find_exporter(format).new(collection, MySuggestionSerializer).export
+
+        ExportMailer.export(user, :suggestions, export_data).deliver_now
+      end
+    end
+  end
+end

data/app/models/decidim/participatory_documents/suggestion.rb

@@ -29,6 +29,8 @@ module Decidim
       scope :missing_answer, -> { where(answered_at: nil) }
       scope :not_published, -> { where(answer_is_published: false) }
 
+      validate :validate_file_type, if: :attached?
+
       POSSIBLE_STATES = %w(not_answered evaluating accepted rejected withdrawn).freeze
 
       POSSIBLE_STATES.each do |possible|
@@ -162,6 +164,16 @@ module Decidim
       def self.export_serializer
         Decidim::ParticipatoryDocuments::SuggestionSerializer
       end
+
+      def validate_file_type
+        allowed_extensions = organization.file_upload_settings["allowed_file_extensions"]["default"]
+        allowed_content_types = organization.file_upload_settings["allowed_content_types"]["default"]
+
+        file_extension = File.extname(file.blob.filename.to_s)[1..]
+        file_content_type = file.blob.content_type
+
+        errors.add(:file, :invalid) if allowed_extensions.exclude?(file_extension) || allowed_content_types.exclude?(file_content_type)
+      end
     end
   end
 end

data/app/packs/entrypoints/decidim_participatory_documents.scss

@@ -2,10 +2,18 @@
 @import "stylesheets/decidim/variables";
 @import "stylesheets/decidim/utils/mixins";
 
+#loginModal-label {
+  outline: none;
+}
+
 .pdf-viewer-container {
   height: calc(100vh - 30rem);
   min-height: 50em;
   padding: 0;
+
+  @media(max-width: 680px) {
+    margin-left: -1.6rem;
+  }
 }
 
 pdf-iframe {

data/app/packs/entrypoints/decidim_participatory_documents_editor.js

@@ -1,10 +1,8 @@
 import "../src/decidim/participatory_documents/pdf_admin.js"
-
-import "entrypoints/decidim_participatory_documents_editor.scss";
-
 import $ from "jquery"; // eslint-disable-line id-length
 import "foundation-sites";
 
+import "entrypoints/decidim_participatory_documents_editor.scss";
 
 const csrfToken = document.getElementsByName("csrf-token");
 $.ajaxSetup({

data/app/packs/entrypoints/decidim_participatory_documents_viewer_off.js

@@ -0,0 +1,6 @@
+import "../src/decidim/participatory_documents/pdf_off.js"
+
+// Images
+require.context("../images", true)
+
+import "entrypoints/decidim_participatory_documents_viewer.scss";

data/app/packs/images/export_suggestions.svg

@@ -0,0 +1 @@
+<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 122.88 106.08"><defs><style>.cls-1{fill-rule:evenodd;}</style></defs><title>chat-download</title><path class="cls-1" d="M71.54,54.18A30.15,30.15,0,0,1,94.8,45.43V9a1.54,1.54,0,0,0-.47-1.1,1.59,1.59,0,0,0-1.1-.48H9A1.64,1.64,0,0,0,7.41,9V75.47a1.58,1.58,0,0,0,.47,1.11l.1.1A1.64,1.64,0,0,0,9,77H23.66a3.71,3.71,0,0,1,3.71,3.71v13L43.65,78.09a3.68,3.68,0,0,1,2.56-1H62.78a30,30,0,0,1,8.76-22.88Zm30.67-7.3A30.07,30.07,0,1,1,71.54,96.71a30.48,30.48,0,0,1-7.43-12.25H47.68L26.44,104.83a3.76,3.76,0,0,1-2.78,1.25,3.71,3.71,0,0,1-3.7-3.71V84.46H9a9,9,0,0,1-6.06-2.39l-.28-.26A9,9,0,0,1,0,75.47V9A9,9,0,0,1,9,0H93.23a9,9,0,0,1,9,9V46.88ZM25.42,33.31a3.71,3.71,0,0,1,0-7.41H76.79a3.71,3.71,0,1,1,0,7.41Zm0,21.93a3.71,3.71,0,0,1,0-7.41H59.81a3.71,3.71,0,1,1,0,7.41Zm80.2,18.59a2.56,2.56,0,0,1,2.17,1c1.14,1.72-.42,3.41-1.5,4.59-3.07,3.37-10,9.46-11.52,11.24a2.5,2.5,0,0,1-3.93,0C89.28,88.86,82,82.39,79.05,79.12c-1-1.14-2.27-2.69-1.21-4.27a2.57,2.57,0,0,1,2.17-1h5.46V64.05A3.08,3.08,0,0,1,88.55,61H97.1a3.08,3.08,0,0,1,3.08,3.07v9.78Z"/></svg>

data/app/packs/src/decidim/participatory_documents/pdf/pdf_modal_manager.js

@@ -8,6 +8,7 @@ export default class PdfModalManager {
     this.csrfToken = options.csrfToken;
     // UI
     this.modalLayout = document.getElementById("decidim");
+    this.modalLayout.addEventListener("click", this._closeHandler.bind(this));
     // events
     this.onSave = () => {};
     this.onDestroy = () => {};
@@ -29,6 +30,7 @@ export default class PdfModalManager {
   }
 
   displayModal(box) {
+    const modal = document.getElementById("editor-modal");
     const uiSave = document.getElementById("editor-modal-save");
     const uiClose = document.getElementById("editor-modal-close");
     const uiTitle = document.getElementById("editor-modal-title");
@@ -38,6 +40,7 @@ export default class PdfModalManager {
     this.modalLayout.classList.add("show");
     $(this.modalLayout).foundation();
 
+    modal.addEventListener("click", (evt) => evt.stopPropagation(), { once: true });
     uiClose.addEventListener("click", this._closeHandler.bind(this), { once: true });
     uiRemove.addEventListener("click", (evt) => this._removeHandler(box, evt), { once: true });
     uiSave.addEventListener("click", (evt) => this._saveHandler(box, evt), { once: true });
@@ -61,7 +64,7 @@ export default class PdfModalManager {
         if (response.ok) {
           return response.json();
         }
-        throw new Error(" ");
+        throw new Error(response.statusText);
       }).
       then((resp) => {
         box.setInfo();

data/app/packs/src/decidim/participatory_documents/pdf/suggestion_form.js

@@ -31,7 +31,7 @@ export default class SuggestionForm {
   }
 
   getCSRFToken() {
-    const token =  document.getElementsByName("csrf-token")
+    const token = document.getElementsByName("csrf-token");
 
     return token.length && token[0].content;
   }

data/app/packs/src/decidim/participatory_documents/pdf.js

@@ -15,12 +15,58 @@ window.InitDocumentManagers = (options) => {
       window.currentSuggestionForm.open();
     }
   });
+
+  const decidim = document.getElementById("decidim");
+  options.exportModal.addEventListener("click", (evt) => {
+    evt.stopPropagation();
+  });
+  options.exportButton.addEventListener("click", (evt) => {
+    evt.stopPropagation();
+    const uiClose = decidim.querySelector(".close-button");
+    uiClose.addEventListener("click", () => decidim.classList.remove("show"), { once: true });
+    decidim.addEventListener("click", () => decidim.classList.remove("show"), { once: true });
+
+    decidim.classList.add("show");
+  });
+  options.exportModal.querySelector(".export-button").addEventListener("click", (evt) => {
+    evt.stopPropagation();
+    fetch(evt.target.dataset.url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "Accept": "application/json",
+        "X-CSRF-Token": document.getElementsByName("csrf-token").item(0).content
+      },
+      credentials: "include"
+    }).
+      then((response) => {
+        if (response.ok) {
+          return response.json();
+        }
+        return response.json().then((json) => { 
+          throw new Error(json.message) 
+        });
+      }).
+      then((resp) => {
+        // console.log("response ok", resp);
+        options.exportModal.querySelector(".content").innerHTML = `<div class="callout success">${resp.message}</div>`;
+      }).
+      catch((message) => {
+        options.exportModal.querySelector(".content").innerHTML = `<div class="callout alert">${message}</div>`;
+        // console.error("Error exporting", message);
+      });
+  });
 };
 
 // Call this on an annotation layer to initialize the polygon viewer (public side)
 window.InitPolygonViewer = (layer, boxes, options) => {
   let viewer = new PolygonViewer(layer, boxes, { i18n: options.i18n});
 
+  // prevent hiding the layout due onBoxBlur
+  options.participationLayout.addEventListener("click", (evt) => {
+    evt.stopPropagation();
+  });
+
   viewer.onBoxClick = (box, evt) => {
     console.log("click on box", box, evt);
     window.currentSuggestionForm = new SuggestionForm(options.participationLayout, options.documentPath, box.section);

data/app/packs/src/decidim/participatory_documents/pdf_off.js

@@ -0,0 +1,39 @@
+/* eslint-disable no-alert */
+
+import PolygonViewer from "src/decidim/participatory_documents/pdf/polygon_viewer";
+import "src/decidim/participatory_documents/pdf_notifications";
+import "src/decidim/participatory_documents/global";
+
+const openLogin = (evt) => {
+  evt.stopPropagation();
+  if (!window.parent) {
+    // This shouldn't appear because is in a iframe, but just in case (or for developing)
+    alert("Login required");
+  }
+
+  // add the rediret_to otherwise is going to be the iframe url and the user will lose the context
+  const loginForm = window.parent.document.getElementById("login_new_user");
+  let parts = loginForm.action.split("?")
+  let params = new URLSearchParams(parts[1]);
+  params.append("redirect_url", window.parent.location.href);
+  loginForm.action = `${parts[0]}?${params.toString()}`;
+
+  window.parent.$("#loginModal").foundation("open")
+};
+
+window.InitDocumentManagers = (options) => {
+  options.globalSuggestionsButton.addEventListener("click", openLogin);
+
+  options.exportButton.addEventListener("click", openLogin);
+};
+
+// Call this on an annotation layer to initialize the polygon viewer (public side)
+window.InitPolygonViewer = (layer, boxes, options) => {
+  let viewer = new PolygonViewer(layer, boxes, { i18n: options.i18n});
+
+  viewer.onBoxClick = (box, evt) => {
+    openLogin(evt);
+  }
+
+  return viewer;
+};

data/app/packs/stylesheets/decidim/participatory_documents/pdf/admin_modals.scss

@@ -4,10 +4,8 @@
 @import "stylesheets/decidim/utils/fontface";
 @import "stylesheets/decidim/admin/utils/settings";
 
-@keyframes blinker {
-  50% {
-    background-color: rgba(var(--primary-rgb), .6);
-  }
+.reveal-overlay {
+  z-index: 100000;
 }
 
 #decidim {
@@ -25,7 +23,7 @@
   line-height: $global-lineheight;
   color: $body-font-color;
 
-  @include meta.load-css("stylesheets/decidim/participatory_documents/decidim_admin_classes.scss");
+  @include meta.load-css("stylesheets/decidim/participatory_documents/pdf/decidim_admin_styles.scss");
 
   &.show {
     display: block;
@@ -39,3 +37,9 @@
     }
   }
 }
+
+@keyframes blinker {
+  50% {
+    background-color: rgba(var(--primary-rgb), .6);
+  }
+}

data/app/packs/stylesheets/decidim/participatory_documents/pdf/admin_tweaks.scss

@@ -20,25 +20,4 @@
       vertical-align: middle;
     }
   }
-
-  @media(max-width: 900px) {
-    margin-top: 12px;
-  }
-}
-
-#fullscreenButton {
-  @media(max-width: 900px) {
-    width: 28px;
-    height: 28px;
-    margin-right: 0;
-    padding-right: 0;
-    overflow: hidden;
-    font-size: 0;
-  }
-}
-
-#scaleSelectContainer {
-  @media(max-width: 900px) {
-    display: none;
-  }
 }

data/app/packs/stylesheets/decidim/participatory_documents/{decidim_admin_classes.scss → pdf/decidim_admin_styles.scss}

@@ -1,9 +1,6 @@
 @import "stylesheets/decidim/admin/variables";
 @import "stylesheets/decidim/utils/fontface";
 @import "stylesheets/decidim/admin/utils/settings";
-
-// @import "stylesheets/decidim/admin/utils/helpers";
-// @import "stylesheets/decidim/admin/utils/keyframes";
 @import "foundation-sites/scss/foundation";
 @import "stylesheets/foundation-overrides/components/button-group";
 

data/app/packs/stylesheets/decidim/participatory_documents/pdf/modals.scss

@@ -5,12 +5,45 @@
 @import "foundation-sites/scss/foundation";
 @import "stylesheets/decidim/modules/icons";
 @import "stylesheets/decidim/modules/margins";
+@import "stylesheets/decidim/modules/callout";
 @import "stylesheets/decidim/utils/helpers";
 
 @include foundation-everything();
 
 @import "stylesheets/decidim/modules/comments";
 
+.reveal-overlay {
+  z-index: 100000;
+}
+
+#decidim {
+  position: fixed;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  z-index: 100000;
+  display: none;
+  margin: 0;
+  padding: 0;
+  font-family: $body-font-family;
+  font-weight: $global-weight-normal;
+  line-height: $global-lineheight;
+  color: $body-font-color;
+
+  &.show {
+    display: block;
+
+    .reveal-overlay {
+      display: block;
+
+      .reveal {
+        display: block;
+      }
+    }
+  }
+}
+
 #participation-modal {
   width: 0;
   height: 0;
@@ -56,6 +89,14 @@
 
     &.active {
       width: 50vw;
+
+      @media(max-width: 900px) {
+        width: 75vw;
+      }
+
+      @media(max-width: 680px) {
+        width: 100vw;
+      }
     }
   }
 
@@ -107,6 +148,14 @@
     display: flex;
     align-items: center;
     justify-content: space-between;
+
+    strong {
+      margin-left: 1rem;
+
+      &:first-child {
+        margin-left: 0;
+      }
+    }
   }
 
   .author__info {