decidim-participatory_documents 0.2.0 → 0.2.2

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 {

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

@@ -19,6 +19,31 @@
   margin: 12px;
 }
 
+#toolbarViewerMiddle {
+  padding-left: 0;
+  padding-right: 0;
+
+  @media(min-width: 940px) {
+    transform: translateX(-75%);
+  }
+
+  @media(max-width: 680px) {
+    padding-left: 1em;
+  }
+}
+
+#toolbarViewerLeft {
+  @media(max-width: 680px) {
+    display: none;
+  }
+}
+
+#toolbarViewerRight {
+  @media(max-width: 380px) {
+    display: none;
+  }
+}
+
 .secondaryToolbar,
 .findbar {
   top: 53px;
@@ -49,6 +74,18 @@
   margin-top: 8px;
 }
 
+.hiddenSmallView {
+  @media(max-width: 800px) {
+    display: none;
+  }
+}
+
+.toolbarButtonSpacer {
+  @media(max-width: 980px) {
+    width: 0;
+  }
+}
+
 .toolbarField {
   margin-top: 9px;
 }
@@ -64,13 +101,19 @@
     background: #fff;
     border: 1px solid #000;
   }
+
+  @media(max-width: 940px) {
+    display: none;
+  }
+
+  @media(min-width: 941px) {
+    display: block;
+  }
 }
 
 .decidimButton {
-  display: inline-block;
-  vertical-align: middle;
-  margin: 0 0 1rem;
-  padding: .85em 1em;
+  margin: 0 0 0 1rem;
+  padding: .65em;
   border-radius: 4px;
   transition: background-color .25s ease-out, color .25s ease-out;
   font-family: inherit;
@@ -83,16 +126,42 @@
   border: transparent solid 1px;
   color: var(--box-text-color);
   text-shadow: 0 0 0 #fff;
+
+  &:first-child {
+    margin-left: 0;
+  }
+
+  &.muted {
+    background: #ddd;
+    color: #333;
+  }
+
+  @media(max-width: 900px) {
+    margin-top: 12px;
+  }
 }
 
 #globalSuggestionTrigger {
-  min-width: 160px;
-
   &::before {
     display: none;
   }
 }
 
+#exportSuggestionsTrigger {
+  background-image: url(../images/export_suggestions.svg);
+  background-repeat: no-repeat;
+  background-size: 20px 20px;
+  background-position: 8px 9px;
+  padding-left: 34px;
+
+  @media(max-width: 900px) {
+    width: 28px;
+    height: 36px;
+    overflow: hidden;
+    font-size: 0;
+  }
+}
+
 #fullscreenButton {
   background-image: url(../images/fullscreen.svg);
   background-repeat: no-repeat;
@@ -115,7 +184,7 @@
     background-image: url(../images/fullscreen_exit.svg);
   }
 
-  @media(max-width: 560px) {
+  @media(max-width: 940px) {
     width: 28px;
     height: 28px;
     margin-right: 0;

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

@@ -7,38 +7,53 @@ module Decidim
         def permissions
           return permission_action if permission_action.scope != :admin
 
-          # Valuators can only perform these actions
-          if user_is_valuator?
-            if valuator_assigned_to_suggestion?
-              can_create_suggestion_note?
-              can_create_suggestion_answer?
-            end
-            valuator_can_unassign_valuator_from_suggestions?
-
-            return permission_action
+          handle_valuator_permissions if user_is_valuator?
+          handle_general_permissions unless user_is_valuator?
+
+          permission_action
+        end
+
+        private
+
+        def handle_valuator_permissions
+          if valuator_assigned_to_suggestion?
+            can_create_suggestion_note?
+            can_create_suggestion_answer?
+            valuator_can_assign_or_unassign_valuator_from_suggestions?
+            allow! if action_is_show_on_suggestion?
+          elsif action_is_show_on_suggestion?
+            disallow!
           end
+        end
 
+        def handle_general_permissions
+          allow! if action_is_show_on_suggestion?
           if create_permission_action?
             can_create_suggestion_note?
             can_create_suggestion_answer?
           end
-
           edit_suggestion_note?
+          can_edit_document_or_sections? if action_is_update_on_document?
+          allow_default_admin_actions
+        end
 
-          can_edit_document_or_sections? if permission_action.subject == :participatory_document && permission_action.action == :update
+        def action_is_show_on_suggestion?
+          permission_action.subject == :suggestion && permission_action.action == :show
+        end
+
+        def action_is_update_on_document?
+          permission_action.subject == :participatory_document && permission_action.action == :update
+        end
 
+        def allow_default_admin_actions
           allow! if permission_action.subject == :suggestion_note && permission_action.action == :create
           allow! if permission_action.subject == :suggestion_answer
           allow! if permission_action.subject == :document_section
           allow! if permission_action.subject == :document_annotations
           allow! if permission_action.subject == :participatory_document && permission_action.action == :create
           allow! if permission_action.subject == :suggestions
-
-          permission_action
         end
 
-        private
-
         def suggestion
           @suggestion ||= context.fetch(:suggestion, nil)
         end
@@ -69,16 +84,8 @@ module Decidim
           permission_action.action == :create
         end
 
-        def can_unassign_valuator_from_suggestions?
-          allow! if permission_action.subject == :suggestions && permission_action.action == :unassign_from_valuator
-        end
-
-        def valuator_can_unassign_valuator_from_suggestions?
-          can_unassign_valuator_from_suggestions? if user == context.fetch(:valuator, nil)
-
-          return unless permission_action.action == :assign_to_valuator && permission_action.subject == :suggestions
-
-          allow!
+        def valuator_can_assign_or_unassign_valuator_from_suggestions?
+          allow! if permission_action.action == :unassign_from_valuator || permission_action.action == :assign_to_valuator
         end
 
         def admin_suggestion_answering_is_enabled?

data/app/permissions/decidim/participatory_documents/permissions.rb

@@ -6,6 +6,8 @@ module Decidim
       def permissions
         return permission_action unless user
 
+        allow! if permission_action.subject == :suggestion && permission_action.action == :create
+
         # Delegate the admin permission checks to the admin permissions class
         return Decidim::ParticipatoryDocuments::Admin::Permissions.new(user, permission_action, context).permissions if permission_action.scope == :admin
 

data/app/serializers/decidim/participatory_documents/my_suggestion_serializer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    # This class serializes a Suggestion so can be exported to CSV, JSON or other
+    # formats.
+    class MySuggestionSerializer < SuggestionSerializer
+      # Public: Exports a hash with the serialized data for this suggestion.
+      def serialize
+        {
+          id: suggestion.id,
+          body: suggestion_body(suggestion),
+          author: suggestion.try(:normalized_author).try(:name),
+          state: humanize_suggestion_state(suggestion.state),
+          answer: answer_text(suggestion),
+          section: section(suggestion),
+          submitted_on: submitted_on(suggestion)
+        }
+      end
+    end
+  end
+end

data/app/serializers/decidim/participatory_documents/suggestion_serializer.rb

@@ -24,7 +24,7 @@ module Decidim
           state: humanize_suggestion_state(suggestion.state),
           answer: answer_text(suggestion),
           section: section(suggestion),
-          valuators: suggestion.valuation_assignments.count,
+          valuators: suggestion.valuation_assignments.map(&:valuator).map(&:name).join(", "),
           submitted_on: submitted_on(suggestion)
         }
       end

data/app/uploaders/decidim/participatory_documents/pdf_document_uploader.rb

@@ -6,6 +6,10 @@ module Decidim
       def content_type_allowlist
         %w(application/pdf)
       end
+
+      def extension_allowlist
+        %w(pdf)
+      end
     end
   end
 end

data/app/views/decidim/participatory_documents/admin/documents/_editor_modal.html.erb

@@ -1,3 +1,3 @@
 <div id="decidim">
-  <%= render partial: "decidim/participatory_documents/admin/sections/form" %>
+  <%= render "decidim/participatory_documents/admin/sections/form" %>
 </div>

data/app/views/decidim/participatory_documents/admin/documents/edit_pdf.html.erb

@@ -3,6 +3,7 @@
     <h2 class="card-title flex--sbc">
       <%= translated_attribute(current_component.name) %>
       <%= render "title", button: :back %>
+      <div class="flex--cc flex-gap--1"><%= preview_sections_btn %></div>
     </h2>
   </div>
   <div class="card-section pdf-viewer-container">

data/app/views/decidim/participatory_documents/admin/documents/pdf_viewer.html.erb

@@ -21,7 +21,7 @@
 </head>
 
 <body tabindex="1">
-  <%= render "decidim/participatory_documents/documents/pdfjs_base", displaySave: true, globalSuggestions: false %>
+  <%= render "decidim/participatory_documents/documents/pdfjs_base", display_save: true %>
 
   <%= render "decidim/participatory_documents/admin/documents/editor_modal" %>
 

data/app/views/decidim/participatory_documents/admin/sections/_form.html.erb

@@ -1,5 +1,3 @@
-
-
 <div class="reveal-overlay">
   <div class="reveal" id="editor-modal">
     <%= decidim_form_for([document, @form], html: { class: "form" }) do |form| %>
@@ -21,4 +19,3 @@
       <span aria-hidden="true">&times;</span>
     </button>
   </div>
-</div>

data/app/views/decidim/participatory_documents/admin/suggestions/_add_valuators.html.erb

@@ -1,4 +1,4 @@
-<% if allowed_to? :assign_to_valuator, :suggestions %>
+<% if valuator_assigned_to_suggestion? || current_user.admin? %>
   <div id="js-assign-suggestion-to-valuator-actions" class="form-single-suggestion"
        style="max-width:400px">
     <%= form_tag(document_valuation_assignment_path(document), method: :post, id: "js-form-assign-suggestion-to-valuator",

data/app/views/decidim/participatory_documents/admin/suggestions/_suggestion.html.erb

@@ -4,7 +4,7 @@
   </td>
   <td><%= suggestion.id %></td>
   <td>
-    <%= truncate(suggestion_content(suggestion)[:text], length: 50) %>
+    <%= link_to truncate(suggestion_content(suggestion)[:text], length: 50), document_suggestion_path(document, suggestion) %>
     <% if suggestion_content(suggestion)[:file_link] %>
       <%= suggestion_content(suggestion)[:file_link] %>
     <% end %>

data/app/views/decidim/participatory_documents/admin/suggestions/_valuators.html.erb

@@ -20,8 +20,7 @@
                       presented_valuator.profile_path,
                       target: :blank
                     ) %>
-
-                <% if allowed_to? :unassign_from_valuator, :suggestions, valuator: assignment.valuator %>
+                <% if valuator_assigned_to_suggestion? || current_user.admin? %>
                   <%= icon_link_to(
                         "circle-x",
                         document_suggestion_valuation_assignment_path(document, suggestion, assignment.valuator_role),

data/app/views/decidim/participatory_documents/documents/_export_modal.html.erb

@@ -0,0 +1,25 @@
+<div id="decidim">
+  <div class="reveal-overlay">
+    <div class="reveal" id="export-modal" data-reveal>
+      <div class="reveal__header">
+        <h2 class="reveal__title"><%= t(".title") %></h2>
+        <button class="close-button" data-close aria-label="close"
+          type="button">
+          <span aria-hidden="true">&times;</span>
+        </button>
+      </div>
+
+      <div class="content">
+        <div class="row">
+          <p><%= t(".description_html", email: current_user&.email, count: all_suggestions&.count) %></p>
+        </div>
+
+        <div class="row">
+          <div class="column flex-center">
+            <button type="button" class="export-button button primary expanded" data-url="<%= export_document_suggestions_path(document) %>"><%= t(".send") %></button>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/decidim/participatory_documents/documents/_pdfjs_base.html.erb

@@ -305,15 +305,18 @@ See https://github.com/adobe-type-tools/cmap-resources
             </button>
           </div>
           <div id="toolbarViewerMiddle">
-            <% if defined?(displaySave) && displaySave == true %>
+            <% if defined?(display_save) && display_save == true %>
               <button id="DecidimPDSaveButton" class="decidimButton" title="<%= t "save_changes", scope: "decidim.participatory_documents.document" %>">
                 <%= t "save_changes", scope: "decidim.participatory_documents.document" %>
               </button>
             <% end %>
-            <% if defined?(globalSuggestions) && globalSuggestions == true %>
+            <% if defined?(display_suggestions) && display_suggestions == true %>
               <button id="globalSuggestionTrigger" class="decidimButton" title="<%= t "global_suggestions", scope: "decidim.participatory_documents.document" %>">
                 <%= t "global_suggestions", scope: "decidim.participatory_documents.document" %>
               </button>
+              <button id="exportSuggestionsTrigger" class="decidimButton muted" title="<%= t "export_my_suggestions", scope: "decidim.participatory_documents.document" %>">
+                <%= t "export_my_suggestions", scope: "decidim.participatory_documents.document" %>
+              </button>
             <% end %>
           </div>
         </div>

data/app/views/decidim/participatory_documents/documents/index.html.erb

@@ -1,7 +1,7 @@
 <% if document.present? && document.file.attached? %>
   <div class="row">
-    <%= content_tag(:h3, translated_attribute(document.title), class: "title") if translated_attribute(document.title).present? %>
-    <%= content_tag(:p, translated_attribute(document.description).html_safe, class: "description") if translated_attribute(document.description).present? %>
+    <%= content_tag(:h3, sanitize(translated_attribute(document.title)), class: "title") if translated_attribute(document.title).present? %>
+    <%= content_tag(:p, sanitize(translated_attribute(document.description)), class: "description") if translated_attribute(document.description).present? %>
     <% if preview_mode? %>
       <div class="callout announcement mb-sm warning cell-announcement">
         <p class="heading5"><%= t("decidim.participatory_documents.documents.preview_title") %></p>

data/app/views/decidim/participatory_documents/documents/pdf_viewer.html.erb

@@ -13,51 +13,58 @@
   <!-- This snippet is used in production (included from viewer.html) -->
   <link rel="resource" type="application/l10n" href="/pdfjs/web/locale/locale.properties">
   <script src="/pdfjs/web/viewer.js"></script>
-  <%= javascript_pack_tag "decidim_participatory_documents_viewer" %>
   <%= stylesheet_pack_tag "decidim_participatory_documents_viewer" %>
+  <%= javascript_pack_tag "decidim_participatory_documents_viewer" if current_user %>
+  <%= javascript_pack_tag "decidim_participatory_documents_viewer_off" unless current_user %>
   <%= organization_colors %>
   <%= pdf_custom_style %>
   <%= csrf_meta_tags %>
 </head>
 
 <body tabindex="1">
-  <%= render "decidim/participatory_documents/documents/pdfjs_base", displaySave: false, globalSuggestions: true %>
+  <%= render "decidim/participatory_documents/documents/pdfjs_base", display_suggestions: true %>
 
   <div id="notifications"></div>
 
   <div id="participation-modal"></div>
 
-<script>
-
-  var I18n = <%= I18n.t("decidim.participatory_documents.ui_messages").to_json.html_safe %>;
-  var DocumentPath = '<%= document_path(document).split("?")[0] %>';
-  var CurrentBoxes = <%= document.annotations.collect(&:serialize).to_json.html_safe %>;
-  var pages = {};
-
-  PDFViewerApplication.initializedPromise.then(function() {
-    var options = {
-      i18n: I18n,
-      documentPath: DocumentPath,
-      globalSuggestionsButton: document.getElementById("globalSuggestionTrigger"),
-      participationLayout: document.getElementById("participation-modal")
-    };
-
-    window.InitDocumentManagers(options);
-
-    window.showInfo(I18n.startSuggesting, {delay: 5000});
-
-    PDFViewerApplication.eventBus.on('annotationeditorlayerrendered', function (doc) {
-      var page = PDFViewerApplication.pdfViewer._pages[doc.pageNumber - 1];
-      var annotationsLayer = page.annotationEditorLayer && page.annotationEditorLayer.div;
-      var savedPage = pages[doc.pageNumber];
-      // Let's render the object only if not already existing.
-      // Note that the PDF library might redraw the annotation layer, if this happens we need to re-render the areas.
-      if(annotationsLayer && (!savedPage || savedPage.boxEditor.div !== annotationsLayer)) {
-        page.boxEditor = window.InitPolygonViewer(annotationsLayer, CurrentBoxes.filter(box => box.page_number === doc.pageNumber), options);
-        pages[doc.pageNumber] = page;
-      }
+  <%= render "export_modal" %>
+
+  <script>
+
+    var I18n = <%= I18n.t("decidim.participatory_documents.ui_messages").to_json.html_safe %>;
+    var DocumentPath = '<%= document_path(document).split("?")[0] %>';
+    var CurrentBoxes = <%= document.annotations.collect(&:serialize).to_json.html_safe %>;
+    var pages = {};
+
+    PDFViewerApplication.initializedPromise.then(function() {
+      var options = {
+        i18n: I18n,
+        documentPath: DocumentPath,
+        globalSuggestionsButton: document.getElementById("globalSuggestionTrigger"),
+        participationLayout: document.getElementById("participation-modal"),
+        exportButton: document.getElementById("exportSuggestionsTrigger"),
+        exportModal: document.getElementById("export-modal")
+      };
+
+      window.InitDocumentManagers(options);
+
+      window.showInfo(I18n.startSuggesting, {delay: 5000});
+
+      PDFViewerApplication.eventBus.on('annotationeditorlayerrendered', function (doc) {
+        var page = PDFViewerApplication.pdfViewer._pages[doc.pageNumber - 1];
+        var annotationsLayer = page.annotationEditorLayer && page.annotationEditorLayer.div;
+        var savedPage = pages[doc.pageNumber];
+        // Let's render the object only if not already existing.
+        // Note that the PDF library might redraw the annotation layer, if this happens we need to re-render the areas.
+        if(annotationsLayer && (!savedPage || savedPage.boxEditor.div !== annotationsLayer)) {
+          page.boxEditor = window.InitPolygonViewer(annotationsLayer, CurrentBoxes.filter(box => box.page_number === doc.pageNumber), options);
+          pages[doc.pageNumber] = page;
+        }
+        // make all links with target blank to prevent open them inside the iframe
+        page.div.querySelectorAll("a[href]").forEach(anchor => anchor.target = "_blank")
+      });
     });
-  });
-</script>
+  </script>
 </body>
 </html>

data/config/assets.rb

@@ -6,6 +6,7 @@ Decidim::Webpacker.register_path("#{base_path}/app/packs")
 Decidim::Webpacker.register_entrypoints(
   decidim_participatory_documents_admin: "#{base_path}/app/packs/entrypoints/decidim_participatory_documents_admin.js",
   decidim_participatory_documents_viewer: "#{base_path}/app/packs/entrypoints/decidim_participatory_documents_viewer.js",
+  decidim_participatory_documents_viewer_off: "#{base_path}/app/packs/entrypoints/decidim_participatory_documents_viewer_off.js",
   decidim_participatory_documents_editor: "#{base_path}/app/packs/entrypoints/decidim_participatory_documents_editor.js",
   decidim_participatory_documents: "#{base_path}/app/packs/entrypoints/decidim_participatory_documents.js"
 )