decidim-decidim_awesome 0.7.2 → 0.8.0

data/app/jobs/decidim/decidim_awesome/migrate_legacy_images_job.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    class MigrateLegacyImagesJob < ApplicationJob
+      queue_as :default
+
+      def perform(organization_id, mappings = [], logger = Rails.logger)
+        @organization_id = organization_id
+        @routes_mappings = mappings
+        @logger = logger
+
+        migrate_all!
+        transform_images_urls
+      end
+
+      private
+
+      attr_reader :routes_mappings, :logger
+
+      def migrate_all!
+        Decidim::CarrierWaveMigratorService.migrate_attachment!(
+          klass: Decidim::DecidimAwesome::EditorImage,
+          cw_attribute: "image",
+          cw_uploader: Decidim::Cw::DecidimAwesome::ImageUploader,
+          as_attribute: "file",
+          logger: @logger,
+          routes_mappings: routes_mappings
+        )
+      end
+
+      def transform_images_urls
+        mappings = routes_mappings.map do |mapping|
+          klass, id = mapping[:instance].split("#")
+          next unless klass == "Decidim::DecidimAwesome::EditorImage"
+
+          instance = Decidim::DecidimAwesome::EditorImage.find_by(id: id)
+
+          next if instance.blank?
+
+          mapping.merge!(instance: instance)
+        end.compact
+
+        editor_images_available_attributes.each do |model, attributes|
+          model.all.each do |item|
+            attributes.each do |attribute|
+              item.update(attribute => rewrite_value(item.send(attribute), mappings))
+            end
+          end
+          @logger.info "Updated model #{model.name} (attributes: #{attributes.join(", ")})"
+        end
+      end
+
+      def rewrite_value(value, mappings)
+        if value.is_a?(Hash)
+          value.transform_values do |nested_value|
+            rewrite_value(nested_value, mappings)
+          end
+        else
+          parser = Decidim::DecidimAwesome::ContentParsers::EditorImagesParser.new(value, routes_mappings: mappings)
+          parser.rewrite
+        end
+      end
+
+      def editor_images_available_attributes
+        {
+          "Decidim::Accountability::Result" => %w(description),
+          "Decidim::Proposals::Proposal" => %w(body answer cost_report execution_period),
+          "Decidim::Votings::Voting" => %w(description),
+          "Decidim::Elections::Question" => %w(description),
+          "Decidim::Elections::Answer" => %w(description),
+          "Decidim::Elections::Election" => %w(description),
+          "Decidim::Initiative" => %w(description answer),
+          "Decidim::InitiativesType" => %w(description extra_fields_legal_information),
+          "Decidim::Assembly" => %w(short_description description purpose_of_action composition internal_organisation announcement closing_date_reason special_features),
+          "Decidim::Forms::Questionnaire" => %w(description tos),
+          "Decidim::Forms::Question" => %w(description),
+          "Decidim::Organization" => %w(welcome_notification_body admin_terms_of_use_body description highlighted_content_banner_short_description id_documents_explanation_text),
+          "Decidim::StaticPage" => %w(content),
+          "Decidim::ContextualHelpSection" => %w(content),
+          "Decidim::Category" => %w(description),
+          "Decidim::Blogs::Post" => %w(body),
+          "Decidim::Pages::Page" => %w(body),
+          "Decidim::Sortitions::Sortition" => %w(additional_info witnesses cancel_reason),
+          "Decidim::Consultations::Question" => %w(title question_context what_is_decided instructions),
+          "Decidim::Consultation" => %w(description),
+          "Decidim::Debates::Debate" => %w(description instructions information_updates conclusions),
+          "Decidim::Budgets::Budget" => %w(description),
+          "Decidim::Budgets::Project" => %w(description),
+          "Decidim::ConferenceSpeaker" => %w(short_bio),
+          "Decidim::Conferences::RegistrationType" => %w(description),
+          "Decidim::Conference" => %w(short_description description objectives registration_terms),
+          "Decidim::ParticipatoryProcessGroup" => %w(description),
+          "Decidim::ParticipatoryProcess" => %w(short_description description announcement),
+          "Decidim::ParticipatoryProcessStep" => %w(description),
+          "Decidim::Meetings::AgendaItem" => %w(description),
+          "Decidim::Meetings::Meeting" => %w(registration_terms description registration_email_custom_content closing_report)
+        }.each_with_object({}) do |(main_model, attributes), hash|
+          hash[main_model.constantize] = attributes
+        rescue NameError
+          hash
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/decidim_awesome/editor_image.rb

@@ -3,6 +3,8 @@
 module Decidim
   module DecidimAwesome
     class EditorImage < ApplicationRecord
+      include Decidim::HasUploadValidations
+
       self.table_name = "decidim_awesome_editor_images"
 
       belongs_to :author, foreign_key: :decidim_author_id, class_name: "Decidim::User"
@@ -11,15 +13,8 @@ module Decidim
       validates :organization, presence: true
       validates :author, presence: true
 
-      validates :image, presence: true
-      # validates :image,
-      #           file_size: { less_than_or_equal_to: ->(_record) { Decidim.maximum_attachment_size } },
-      #           file_content_type: { allow: ["image/jpeg", "image/png"] }
-
-      mount_uploader :image, Decidim::DecidimAwesome::ImageUploader
-
-      delegate :url, to: :image
-      delegate :thumbnail, to: :image
+      has_one_attached :file
+      validates_upload :file, uploader: Decidim::DecidimAwesome::ImageUploader
     end
   end
 end

data/app/packs/entrypoints/decidim_admin_decidim_awesome.js

@@ -0,0 +1,5 @@
+import "src/decidim/decidim_awesome/awesome_admin"
+import "jquery-ui/ui/widgets/sortable" // This is needed by custom fields builder but if loader there duplicates the jQuery inclusion
+
+// CSS
+import "entrypoints/decidim_admin_decidim_awesome.scss";

data/app/packs/entrypoints/decidim_admin_decidim_awesome.scss

@@ -0,0 +1 @@
+@import "stylesheets/decidim/decidim_awesome/awesome_admin";

data/app/packs/entrypoints/decidim_admin_decidim_awesome_custom_fields.js

@@ -0,0 +1,2 @@
+import "src/decidim/decidim_awesome/proposals/custom_fields"
+import "src/decidim/decidim_awesome/admin/custom_fields_builder"

data/app/packs/entrypoints/decidim_decidim_awesome.js

@@ -0,0 +1,9 @@
+import "src/decidim/decidim_awesome/awesome_application.js"
+
+// Images
+require.context("../images", true)
+
+// CSS
+import "entrypoints/decidim_decidim_awesome.scss";
+
+

data/app/packs/entrypoints/decidim_decidim_awesome.scss

@@ -0,0 +1 @@
+@import "stylesheets/decidim/decidim_awesome/awesome_application";

data/app/packs/entrypoints/decidim_decidim_awesome_admin_form_exit_warn.js

@@ -0,0 +1 @@
+import "src/decidim/decidim_awesome/admin/form_exit_warn"

data/app/packs/entrypoints/decidim_decidim_awesome_custom_fields.js

@@ -0,0 +1 @@
+import "src/decidim/decidim_awesome/proposals/custom_fields"

data/app/packs/entrypoints/decidim_decidim_awesome_iframe.scss

@@ -0,0 +1 @@
+@import "stylesheets/decidim/decidim_awesome/awesome_iframe/iframe";

data/app/packs/entrypoints/decidim_decidim_awesome_map.js

@@ -0,0 +1,5 @@
+import "src/decidim/decidim_awesome/awesome_map/load_map.js"
+
+// CSS
+import "entrypoints/decidim_decidim_awesome_map.scss";
+

data/app/packs/entrypoints/decidim_decidim_awesome_map.scss

@@ -0,0 +1 @@
+@import "stylesheets/decidim/decidim_awesome/awesome_map/map"

data/app/{assets/javascripts/decidim/decidim_awesome/admin/auto_edit.js.es6 → packs/src/decidim/decidim_awesome/admin/auto_edit.js}

@@ -1,36 +1,36 @@
-// = require_self
-
-let formBuilderList = formBuilderList || [];
-let DecidimAwesome = DecidimAwesome || {};
 $(() => {
+  let CustomFieldsBuilders = window.CustomFieldsBuilders || [];
+
   $("body").on("click", "a.awesome-auto-edit", (e) => {
     e.preventDefault();
     const $link = $(e.currentTarget);
     const scope = $link.data("scope");
     const $target = $(`span.awesome-auto-edit[data-scope="${scope}"]`);
     const $constraints = $(`.constraints-editor[data-key="${scope}"]`);
-    if($target.length == 0) return;
-    
-    const key = $target.data('key');
-    const attribute = $target.data('var');
+    if ($target.length == 0) {
+      return;
+    }
+
+    const key = $target.data("key");
+    const attribute = $target.data("var");
     const $hidden = $(`[name="config[${attribute}][${key}]"]`);
     const $multiple = $(`[name="config[${attribute}][${key}][]"]`);
     const $container = $(`.${attribute}_container[data-key="${key}"]`);
-    const $delete = $('.delete-box', $container);
+    const $delete = $(".delete-box", $container);
 
-    const rebuildLabel = (text, scope) => {
+    const rebuildLabel = (text, withScope) => {
       $target.text(text);
       $target.attr("data-key", text);
       $target.data("key", text);
-      if(scope) {
-        $target.attr("data-scope", scope);
-        $target.data("scope", scope);
-        $link.attr("data-scope", scope);
-        $link.data("scope", scope);
+      if (withScope) {
+        $target.attr("data-scope", withScope);
+        $target.data("scope", withScope);
+        $link.attr("data-scope", withScope);
+        $link.data("scope", withScope);
       }
       $link.show();
     };
-    
+
     const rebuildHmtl = (result) => {
       rebuildLabel(result.key, result.scope);
       $constraints.replaceWith(result.html);
@@ -40,8 +40,8 @@ $(() => {
       $container.data("key", result.key);
       $container.attr("data-key", result.key);
       $delete.attr("href", $delete.attr("href").replace(`key=${key}`, `key=${result.key}`))
-      formBuilderList.forEach((builder) => {
-        if(builder.key == key) {
+      CustomFieldsBuilders.forEach((builder) => {
+        if (builder.key == key) {
           builder.key = result.key;
         }
       });
@@ -51,27 +51,32 @@ $(() => {
     const $input = $(`input.awesome-auto-edit[data-scope="${scope}"]`);
     $link.hide();
     $input.select();
-    $input.on("keypress", (e) => {
-      // if(e.code == "Space") {
-      //   e.preventDefault();
-      // }
-      if(e.code == "Enter") {
-        e.preventDefault();
-        $.post(DecidimAwesome.rename_scope_label_path, 
-          { key: key, 
-            scope: scope, 
-            attribute: attribute, 
-            text: $input.val() 
-          },
-          (result) => rebuildHmtl(result), 
-          "json").fail((err) => {
+    $input.on("keypress", (evt) => {
+      if (evt.code == "Enter" || evt.code == "13" || evt.code == "10") {
+        evt.preventDefault();
+        $.ajax(
+          {
+            type: "POST",
+            url: DecidimAwesome.rename_scope_label_path,
+            dataType: "json",
+            headers: {
+              "X-CSRF-Token": $("meta[name=csrf-token]").attr("content")
+            },
+            data: { key: key,
+              scope: scope,
+              attribute: attribute,
+              text: $input.val()
+            }
+          }).
+          done((result) => rebuildHmtl(result)).
+          fail((err) => {
             console.error("Error saving key", key, "ERR:", err);
             rebuildLabel(key);
-          })
+          });
       }
     });
     $input.on("blur", () => {
       rebuildLabel(key);
     });
   });
-});
+});

data/app/packs/src/decidim/decidim_awesome/admin/check_redirections.js

@@ -0,0 +1,48 @@
+$(() => {
+  $(".check-custom-redirections").on("click", (evt) => {
+    evt.preventDefault();
+    
+    if ($(evt.target).hasClass("disabled")) {
+      return;
+    }
+    
+    $(evt.target).addClass("disabled");
+
+    const getReport = (tr, response) => {
+      const item = $(tr).data("item");
+      const $td = $(tr).find(".redirect-status");
+
+      let type = response.type;
+      let status = response.status;
+      if (response.type == "opaqueredirect") {
+        type = "redirect";
+        status = "302";
+      }
+
+      if (item.active) {
+        if (type ==  "redirect") {
+          $td.addClass("success");
+        } else {
+          $td.addClass("alert");
+        }
+      } else {
+        $td.addClass("muted");
+      }
+
+      return `${type} (${status})`;
+    };
+
+    $("tr.custom-redirection").each((index, tr) => {
+      const $td = $(tr).find(".redirect-status");
+      $td.html('<span class="loading-spinner" />');
+      fetch($(tr).data("origin"), {method: "HEAD", redirect: "manual"}).
+        then((response) => {
+          $td.html(getReport(tr, response))
+        }).
+        catch((error) => {
+          console.error("ERROR", error)  
+          $td.removeClass("loading");
+        });
+    });
+  });
+});

data/app/{assets/javascripts/decidim/decidim_awesome/admin/codemirror.js.es6 → packs/src/decidim/decidim_awesome/admin/codemirror.js}

@@ -1,7 +1,7 @@
-// = require codemirror
-// = require mode/css/css
-// = require keymap/sublime
-// = require_self
+import CodeMirror from "codemirror"
+import "codemirror/mode/css/css"
+import "codemirror/keymap/sublime"
+import "stylesheets/decidim/decidim_awesome/admin/codemirror.scss";
 
 $(() => {
   $(".awesome-edit-config .scoped_styles_container textarea").each((_idx, el) => {

data/app/packs/src/decidim/decidim_awesome/admin/constraints.js

@@ -0,0 +1,55 @@
+$(() => {
+  const $modal = $("#constraintsModal");
+  if (!$modal.length) {
+    return;
+  }
+
+  $(".decidim_awesome-form").on("click", ".constraints-editor .add-condition,.constraints-editor .edit-condition", (e) => {
+    e.preventDefault();
+    const $this = $(e.target)
+    const url = $this.attr("href");
+    const $callout = $this.closest(".constraints-editor").find(".callout");
+    $callout.hide();
+    $callout.removeClass("alert success");
+    $modal.find(".modal-content").html("");
+    $modal.addClass("loading");
+    $modal.data("url", url);
+    $modal.foundation("open");
+    $modal.find(".modal-content").load(url, () => {
+      $modal.removeClass("loading");
+    });
+  });
+
+  // Custom event listener to reload the modal if needed
+  document.body.addEventListener("constraint:change", (e) => {
+    const vars = e.detail.map((setting) => `${setting.key}=${setting.value}`);
+    const url = `${$modal.data("url")}&${vars.join("&")}`;
+    // console.log("constraint:change vars:", vars, "url:", url)
+    $modal.addClass("loading");
+    $modal.find(".modal-content").load(url, () => {
+      $modal.removeClass("loading");
+    });
+  });
+
+  // Rails AJAX events
+  document.body.addEventListener("ajax:error", (responseText) => {
+    // console.log("ajax:error", responseText)
+    const $container = $(`.constraints-editor[data-key="${responseText.detail[0].key}"]`)
+    const $callout = $container.find(".callout");
+    $callout.show();
+    $callout.contents("p").html(`${responseText.detail[0].message}: <strong>${responseText.detail[0].error}</strong>`);
+    $callout.addClass("alert");
+  });
+
+  document.body.addEventListener("ajax:success", (responseText) => {
+    // console.log("ajax:success", responseText)
+    const $container = $(`.constraints-editor[data-key="${responseText.detail[0].key}"]`)
+    const $callout = $container.find(".callout");
+    $modal.foundation("close");
+    $callout.show();
+    $callout.contents("p").html(responseText.detail[0].message);
+    $callout.addClass("success");
+    // reconstruct list
+    $container.replaceWith(responseText.detail[0].html);
+  });
+});

data/app/{assets/javascripts/decidim/decidim_awesome/admin/form_builder.js.es6 → packs/src/decidim/decidim_awesome/admin/custom_fields_builder.js}

@@ -1,30 +1,27 @@
-// = require jquery-ui.min
-// = require decidim/decidim_awesome/editors/quill_editor
-// = require decidim/decidim_awesome/forms/rich_text_plugin
-// = require form-builder.min
-// = require_self
+require("formBuilder/dist/form-builder.min.js")
+import "src/decidim/decidim_awesome/forms/rich_text_plugin"
 
-let formBuilderList = [];
+window.CustomFieldsBuilders = window.CustomFieldsBuilders || [];
 
 $(() => {
   $(".awesome-edit-config .proposal_custom_fields_editor").each((_idx, el) => {
     const key = $(el).closest(".proposal_custom_fields_container").data("key");
     // DOCS: https://formbuilder.online/docs
-    formBuilderList.push({
+    window.CustomFieldsBuilders.push({
       el: el,
       key: key,
       config: {
         i18n: {
-          locale: 'en-US',
-          location: 'https://cdn.jsdelivr.net/npm/formbuilder-languages@1.1.0/'
+          locale: "en-US",
+          location: "https://cdn.jsdelivr.net/npm/formbuilder-languages@1.1.0/"
         },
         formData: $(`input[name="config[proposal_custom_fields][${key}]"]`).val(),
-        disableFields: ['button', 'file'],
-        disabledActionButtons: ['save', 'data', 'clear'],
+        disableFields: ["button", "file"],
+        disabledActionButtons: ["save", "data", "clear"],
         disabledAttrs: [
-          'access',
-          'inline',
-          'className'
+          "access",
+          "inline",
+          "className"
         ],
         controlOrder: [
           "text",
@@ -39,20 +36,21 @@ $(() => {
           "paragraph"
         ],
         disabledSubtypes: {
-          text: ['color'], // TODO: fix hashtag generator with this
-          // disable wysiwyg editors as they present problems
-          // TODO: create custom type to integrate decidim Quill Editor
-          textarea: ['tinymce', 'quill']
-        },
+          text: ["color"], // default color as it generate hashtags in decidim (TODO: fix hashtag generator with this)
+          // disable default wysiwyg editors as they present problems
+          textarea: ["tinymce", "quill"]
+        }
       },
       instance: null
     });
   });
 
   $(document).on("formBuilder.create", (_event, i, list) => {
-    if(!list[i]) return;
+    if (!list[i]) {
+      return;
+    }
 
-    $(list[i].el).formBuilder(list[i].config).promise.then(function(res){
+    $(list[i].el).formBuilder(list[i].config).promise.then(function(res) {
       list[i].instance = res;
       // Attach to DOM
       list[i].el.FormBuilder = res;
@@ -60,19 +58,18 @@ $(() => {
       $(list[i].el).find(".loading-spinner").remove();
       // for external use
       $(document).trigger("formBuilder.created", [list[i]]);
-      if(i < list.length) {
+      if (i < list.length) {
         $(document).trigger("formBuilder.create", [i + 1, list]);
       }
     });
   });
 
-  if(formBuilderList.length) {
-    $(document).trigger("formBuilder.create", [0, formBuilderList]);
+  if (window.CustomFieldsBuilders.length) {
+    $(document).trigger("formBuilder.create", [0, window.CustomFieldsBuilders]);
   }
 
   $("form.awesome-edit-config").on("submit", () => {
-    // e.preventDefault();
-    formBuilderList.forEach((builder) =>{
+    window.CustomFieldsBuilders.forEach((builder) => {
       $(`input[name="config[proposal_custom_fields][${builder.key}]"]`).val(builder.instance.actions.getData("json"));
     });
   });

data/app/{assets/javascripts/decidim/decidim_awesome/admin/form_exit_warn.js.es6 → packs/src/decidim/decidim_awesome/admin/form_exit_warn.js}

@@ -1,5 +1,3 @@
-// = require_self
-
 $(() => {
   const $form = $("form.awesome-edit-config");
   if ($form.length > 0) {

data/app/{assets/javascripts/decidim/decidim_awesome/admin/user_picker.js.es6 → packs/src/decidim/decidim_awesome/admin/user_picker.js}

@@ -1,8 +1,8 @@
-// = require select2
-// = require_self
+import "select2"
+import "stylesheets/decidim/decidim_awesome/admin/user_picker.scss"
 
 $(() => {
-    $('select.multiusers-select').each(function() {
+  $("select.multiusers-select").each(function() {
     const url = $(this).attr("data-url");
     $(this).select2({
       ajax: {

data/app/packs/src/decidim/decidim_awesome/awesome_admin.js

@@ -0,0 +1,23 @@
+// Webpack seems to "forgget" about certain libraries already being loaded 
+// if javascript_pack_tag is called two times, let's include the whole Decidim admin here instead
+import "entrypoints/decidim_admin"
+// Custom scripts for awesome
+import "src/decidim/decidim_awesome/admin/constraints"
+import "src/decidim/decidim_awesome/admin/auto_edit"
+import "src/decidim/decidim_awesome/admin/user_picker"
+import "src/decidim/decidim_awesome/editors/tabs_focus"
+import "src/decidim/decidim_awesome/admin/codemirror"
+import "src/decidim/decidim_awesome/admin/check_redirections"
+
+import {destroyQuillEditor, createQuillEditor, createMarkdownEditor} from "src/decidim/decidim_awesome/editors/editor"
+
+$(() => {
+  $(".editor-container").each((_idx, container) => {
+    destroyQuillEditor(container);
+    if (window.DecidimAwesome.use_markdown_editor) {
+      createMarkdownEditor(container);
+    } else {
+      createQuillEditor(container);
+    }
+  });
+});

data/app/packs/src/decidim/decidim_awesome/awesome_application.js

@@ -0,0 +1,17 @@
+import "src/decidim/decidim_awesome/proposals/images"
+import "src/decidim/decidim_awesome/forms/autosave"
+import {destroyQuillEditor, createQuillEditor, createMarkdownEditor} from "src/decidim/decidim_awesome/editors/editor"
+
+$(() => {
+  // rebuild editors
+  if (window.DecidimAwesome.allow_images_in_full_editor || window.DecidimAwesome.allow_images_in_small_editor || window.DecidimAwesome.use_markdown_editor) {
+    $(".editor-container").each((_idx, container) => {
+      destroyQuillEditor(container);
+      if (window.DecidimAwesome.use_markdown_editor) {
+        createMarkdownEditor(container);
+      } else {
+        createQuillEditor(container);
+      }
+    });
+  }
+});

data/app/{assets/javascripts/decidim/decidim_awesome/awesome_map/api_fetcher.js.es6 → packs/src/decidim/decidim_awesome/awesome_map/api/api_fetcher.js}

@@ -1,5 +1,4 @@
-class ApiFetcher { // eslint-disable-line no-unused-vars
-
+export default class ApiFetcher { // eslint-disable-line no-unused-vars
   constructor(query, variables) {
     this.query = query;
     this.variables = variables;
@@ -22,17 +21,4 @@ class ApiFetcher { // eslint-disable-line no-unused-vars
   fetchAll (callback) {
     this.fetch(callback);
   }
-
-  static findTranslation(translations) {
-    let text, lang = document.querySelector('html').getAttribute('lang');
-    
-    translations.forEach((t) => {
-      if(t.text) {
-        if(!text || t.locale == lang) {
-          text = t.text
-        }
-      }
-    });
-    return text;
-  }
 }