decidim-forms 0.24.3 → 0.25.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb0b91d5017ae65bea07ce4f4d7f8ce52d6100f25d67375c3f8b298e7814234f
-  data.tar.gz: 2e8b006412c4cb58b06062f8d6747c760a29167ba866a26cc51647a21ff2b4f0
+  metadata.gz: 6d6a89d9130f70f34752048e73c5326d2da80e71f44e3da9c70115ec4cb9bbc0
+  data.tar.gz: be2fcaae153df09c162d1b9878c1163042f4802968bd4626ce1a279a67830b20
 SHA512:
-  metadata.gz: 685c2eca4d5c9ff771b1bb699c08de24369705ccc7404b30a3e34ebf00536277963cfa1636e1757b3eb4365d14d4259e00d20b250f4a750392406b7d5e0b24d0
-  data.tar.gz: a5ba675fb9bb0e912435e2926d336f6ef05cee3d4db6d8d66eb29b6f6899ef8d0534997549c4aa8d0d3914b51942038604861cbf09d74c0b7a4be4cf345ff774
+  metadata.gz: 2f58f802c1bb233ef62fd86cb08fd382c4e67f95417759371f0685ae5ad92bdf00576d3b57854e3da73665822ea13918ef522aa980af1ea8fc918717df66b4a2
+  data.tar.gz: c6b772ae8123a55dc7f36ea3297984a91f7f81ba19fcb1fce27d1378e007c279a3edeec7970f984ebac720ae637f81a542ead1fb5bcfdbab4e8392fc5da4de11

data/app/cells/decidim/forms/step_navigation/show.erb

@@ -3,7 +3,7 @@
     <a></a>
   <% else %>
     <%= link_to(
-      icon("caret-left", class: "icon--small", role: "img") + " " + t("decidim.forms.step_navigation.show.back"),
+      icon("caret-left", class: "icon--small", role: "img", "aria-hidden": true) + " " + t("decidim.forms.step_navigation.show.back"),
       "#",
       class: "hollow secondary",
       data: {

data/app/commands/decidim/forms/admin/update_questionnaire.rb

@@ -78,9 +78,10 @@ module Decidim
               update_nested_model(form_display_condition, display_condition_attributes, question.display_conditions)
             end
 
-            form_question.matrix_rows.each do |form_matrix_row|
+            form_question.matrix_rows_by_position.each_with_index do |form_matrix_row, idx|
               matrix_row_attributes = {
-                body: form_matrix_row.body
+                body: form_matrix_row.body,
+                position: form_matrix_row.position || idx
               }
 
               update_nested_model(form_matrix_row, matrix_row_attributes, question.matrix_rows)

data/app/forms/decidim/forms/admin/question_form.rb

@@ -42,6 +42,20 @@ module Decidim
           question_type == Decidim::Forms::Question::SEPARATOR_TYPE
         end
 
+        def matrix_rows_by_position
+          matrix_rows.sort do |a, b|
+            if a.position && b.position
+              a.position <=> b.position
+            elsif a.position
+              -1
+            elsif b.position
+              1
+            else
+              0
+            end
+          end
+        end
+
         private
 
         def matrix?

data/app/forms/decidim/forms/admin/question_matrix_row_form.rb

@@ -7,12 +7,12 @@ module Decidim
       class QuestionMatrixRowForm < Decidim::Form
         include TranslatableAttributes
 
-        attribute :position, Integer, default: 0
+        attribute :position, Integer
         attribute :deleted, Boolean, default: false
 
         translatable_attribute :body, String
 
-        validates :position, numericality: { greater_than_or_equal_to: 0 }
+        validates :position, numericality: { greater_than_or_equal_to: 0 }, if: -> { position.present? }
         validates :body, translatable_presence: true, unless: :deleted
 
         def to_param

data/app/forms/decidim/forms/questionnaire_form.rb

@@ -8,6 +8,7 @@ module Decidim
       # important not to use the same word here to avoid querying all the entries, resulting in a high performance penalty
       attribute :responses, Array[AnswerForm]
       attribute :user_group_id, Integer
+      attribute :public_participation, Boolean, default: false
 
       attribute :tos_agreement, Boolean
 

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

@@ -10,6 +10,7 @@ module Decidim
 
         permited_models.include?(model_name)
       end
+      alias show_public_participation? show_represent_user_group?
 
       def permited_models
         %(meeting)

data/app/jobs/decidim/forms/export_questionnaire_answers_job.rb

@@ -3,7 +3,7 @@
 module Decidim
   module Forms
     class ExportQuestionnaireAnswersJob < ApplicationJob
-      queue_as :default
+      queue_as :exports
 
       def perform(user, title, answers)
         return if user&.email.blank?

data/app/models/decidim/forms/question.rb

@@ -87,6 +87,10 @@ module Decidim
       def has_attachments?
         question_type.to_s == "files"
       end
+
+      def answers_count
+        questionnaire.answers.where(question: self).count
+      end
     end
   end
 end

data/app/models/decidim/forms/question_matrix_row.rb

@@ -10,6 +10,9 @@ module Decidim
       belongs_to :question, class_name: "Question", foreign_key: "decidim_question_id"
 
       delegate :answer_options, :mandatory, :max_choices, to: :question
+
+      scope :by_position, -> { order(:position) }
+      default_scope { by_position }
     end
   end
 end

data/app/packs/entrypoints/decidim_forms.js

@@ -0,0 +1,4 @@
+import "src/decidim/forms/forms"
+
+// Images
+require.context("../images", true)

data/app/packs/entrypoints/decidim_forms_admin.js

@@ -0,0 +1,4 @@
+import "src/decidim/forms/admin/collapsible_questions"
+
+import createEditableForm from "../src/decidim/forms/admin/forms"
+window.Decidim.createEditableForm = createEditableForm

data/app/packs/entrypoints/decidim_questionnaire_answers_pdf.js

@@ -0,0 +1 @@
+import "entrypoints/decidim_questionnaire_answers_pdf.scss"

data/app/packs/entrypoints/decidim_questionnaire_answers_pdf.scss

@@ -0,0 +1 @@
+@import "stylesheets/decidim/forms/questionnaire-answers-pdf.scss";

data/app/packs/src/decidim/forms/admin/auto_buttons_by_min_items.component.js

@@ -0,0 +1,20 @@
+export default class AutoButtonsByMinItemsComponent {
+  constructor(options = {}) {
+    this.listSelector = options.listSelector;
+    this.minItems = options.minItems;
+    this.hideOnMinItemsOrLessSelector = options.hideOnMinItemsOrLessSelector;
+
+    this.run();
+  }
+
+  run() {
+    const $list = $(this.listSelector);
+    const $items = $list.find(this.hideOnMinItemsOrLessSelector);
+
+    if ($list.length <= this.minItems) {
+      $items.hide();
+    } else {
+      $items.show();
+    }
+  }
+}

data/app/packs/src/decidim/forms/admin/auto_select_options_by_total_items.component.js

@@ -0,0 +1,18 @@
+export default class AutoSelectOptionsByTotalItemsComponent {
+  constructor(options = {}) {
+    this.wrapperSelector = options.wrapperSelector;
+    this.selectSelector = options.selectSelector;
+    this.listSelector = options.listSelector;
+  }
+
+  run() {
+    const $list = $(this.listSelector);
+    const $selectField = $list.parents(this.wrapperSelector).find(this.selectSelector);
+
+    $selectField.find("option").slice(1).remove();
+
+    for (let idx = 2; idx <= $list.length; idx += 1) {
+      $(`<option value="${idx}">${idx}</option>`).appendTo($selectField);
+    }
+  }
+}

data/app/packs/src/decidim/forms/admin/auto_select_options_from_url.component.js

@@ -0,0 +1,35 @@
+export default class AutoSelectOptionsFromUrl {
+  constructor(options = {}) {
+    this.$source = options.source;
+    this.$select = options.select;
+    this.sourceToParams = options.sourceToParams;
+    this.run();
+  }
+
+  run() {
+    this.$source.on("change", this._onSourceChange.bind(this));
+    this._onSourceChange();
+  }
+
+  _onSourceChange() {
+    const select = this.$select;
+    const params = this.sourceToParams(this.$source);
+    const url = this.$source.data("url");
+
+    $.getJSON(url, params, function (data) {
+      select.find("option:not([value=''])").remove();
+      const selectedValue = select.data("selected");
+
+      data.forEach((option) => {
+        let optionElement = $(`<option value="${option.id}">${option.body}</option>`).appendTo(select);
+        if (option.id === selectedValue) {
+          optionElement.attr("selected", true);
+        }
+      });
+
+      if (selectedValue) {
+        select.val(selectedValue);
+      }
+    });
+  }
+}

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

@@ -1,14 +1,18 @@
 /* eslint-disable max-lines */
-
-// = require ./auto_buttons_by_min_items.component
-// = require ./auto_select_options_by_total_items.component
-// = require ./auto_select_options_from_url.component
-// = require ./live_text_update.component
-
-((exports) => {
-  const { AutoLabelByPositionComponent, AutoButtonsByPositionComponent, AutoButtonsByMinItemsComponent, AutoSelectOptionsByTotalItemsComponent, AutoSelectOptionsFromUrl, createLiveTextUpdateComponent, createFieldDependentInputs, createDynamicFields, createSortList } = exports.DecidimAdmin;
-  const { createQuillEditor } = exports.Decidim;
-
+/* eslint-disable require-jsdoc */
+
+import AutoButtonsByMinItemsComponent from "src/decidim/forms/admin/auto_buttons_by_min_items.component"
+import AutoSelectOptionsByTotalItemsComponent from "src/decidim/forms/admin/auto_select_options_by_total_items.component"
+import AutoSelectOptionsFromUrl from "src/decidim/forms/admin/auto_select_options_from_url.component"
+import createLiveTextUpdateComponent from "src/decidim/forms/admin/live_text_update.component"
+import AutoButtonsByPositionComponent from "src/decidim/admin/auto_buttons_by_position.component"
+import AutoLabelByPositionComponent from "src/decidim/admin/auto_label_by_position.component"
+import createSortList from "src/decidim/admin/sort_list.component"
+import createDynamicFields from "src/decidim/admin/dynamic_fields.component"
+import createFieldDependentInputs from "src/decidim/admin/field_dependent_inputs.component"
+import createQuillEditor from "src/decidim/editor"
+
+export default function createEditableForm() {
   const wrapperSelector = ".questionnaire-questions";
   const fieldSelector = ".questionnaire-question";
   const questionTypeSelector = "select[name$=\\[question_type\\]]";
@@ -59,7 +63,7 @@
     listSelector: ".questionnaire-question:not(.hidden)",
     labelSelector: ".card-title span:first",
     onPositionComputed: (el, idx) => {
-      $(el).find("input[name$=\\[position\\]]").val(idx);
+      $(el).find("input[name$=\\[position\\]]:not([name*=\\[matrix_rows\\]])").val(idx);
 
       autoButtonsByPosition.run();
 
@@ -429,4 +433,4 @@
 
   autoLabelByPosition.run();
   autoButtonsByPosition.run();
-})(window);
+}

data/app/packs/src/decidim/forms/admin/live_text_update.component.js

@@ -0,0 +1,49 @@
+/* eslint-disable require-jsdoc */
+
+/**
+ * This component allows for an element's text value to be updated with the value
+ * of an input whenever this input's value is changed.
+ *
+ * @param {object} options
+ *
+ * Available options:
+ * {string} `inputSelector`:  The query selector to locate the input element
+ * {string} `targetSelector`: The query selector to locate the target element
+ * {number} `maxLength`: The maximum characters from the input value to be displayed in the target
+ * {string} `omission`: The string used to shorten the value to the given maxLength (e.g. "...")
+ * {string} `placeholder`: The string to be displayed in the target element when the input has no value
+ */
+class LiveTextUpdateComponent {
+  constructor(options = {}) {
+    this.inputSelector = options.inputSelector;
+    this.targetSelector = options.targetSelector;
+    this.maxLength = options.maxLength;
+    this.omission = options.omission;
+    this.placeholder = options.placeholder;
+    this._bindEvent();
+    this._run();
+  }
+
+  _run() {
+    const $input = $(this.inputSelector);
+    const $target = $(this.targetSelector);
+
+    let text = $input.val() || this.placeholder;
+
+    // truncate string
+    if (text.length > this.maxLength) {
+      text = text.substring(0, this.maxLength - this.omission.length) + this.omission;
+    }
+
+    $target.text(text);
+  }
+
+  _bindEvent() {
+    const $input = $(this.inputSelector);
+    $input.on("change", this._run.bind(this));
+  }
+}
+
+export default function createLiveTextUpdateComponent(options) {
+  return new LiveTextUpdateComponent(options);
+}

data/app/packs/src/decidim/forms/autosortable_checkboxes.component.js

@@ -0,0 +1,83 @@
+/* eslint-disable require-jsdoc */
+/* eslint-disable no-ternary */
+
+class AutosortableCheckboxesComponent {
+  constructor(options = {}) {
+    this.wrapperField = options.wrapperField;
+    this._bindEvent();
+    this._order();
+    this._normalize();
+  }
+
+  // Order by position
+  _order() {
+    const max = $(this.wrapperField).find(".collection-input").length;
+    $(this.wrapperField).find(".collection-input").each((idx, el) => {
+      const $positionField = $(el).find("input[name$=\\[position\\]]");
+      const position = $positionField.val()
+        ? parseInt($positionField.val(), 10)
+        : max;
+
+      let $next = $(el).next();
+      while ($next.length > 0) {
+        const $nextPositionField = $next.find("input[name$=\\[position\\]]");
+        const nextPosition = $nextPositionField.val()
+          ? parseInt($nextPositionField.val(), 10)
+          : max;
+
+        if (position > nextPosition) {
+          $next.insertBefore($(el));
+        }
+        $next = $next.next();
+      }
+    });
+  }
+
+  _findLastPosition() {
+    let lastPosition = 0;
+    $(this.wrapperField).find(".collection-input").each((idx, el) => {
+      const $positionField = $(el).find("input[name$=\\[position\\]]");
+      const position = parseInt($positionField.val(), 10);
+      if (position > lastPosition) {
+        lastPosition = position;
+      }
+    });
+    return lastPosition;
+  }
+
+  _normalize() {
+    $(this.wrapperField).find(".collection-input .position").each((idx, el) => {
+      const $positionField = $(el).parent().find("input[name$=\\[position\\]]");
+      if ($positionField.val()) {
+        $positionField.val(idx);
+        $positionField.prop("disabled", false);
+        $(el).html(`${idx + 1}. `);
+      }
+    });
+  }
+
+  _bindEvent() {
+    $(this.wrapperField).find("input[type=checkbox]").on("change", (el) => {
+      const $parentLabel = $(el.target).parents("label");
+      const $positionSelector = $parentLabel.find(".position");
+      const $positionField = $parentLabel.find("input[name$=\\[position\\]]");
+      const lastPosition = this._findLastPosition();
+
+      if (el.target.checked) {
+        $positionField.val(lastPosition + 1);
+        $positionField.prop("disabled", false);
+        $positionSelector.html(lastPosition + 1);
+      } else {
+        $positionField.val("");
+        $positionField.prop("disabled", true);
+        $positionSelector.html("");
+      }
+      this._order();
+      this._normalize();
+    });
+  }
+}
+
+export default function createAutosortableCheckboxes(options) {
+  return new AutosortableCheckboxesComponent(options);
+}

data/app/packs/src/decidim/forms/display_conditions.component.js

@@ -0,0 +1,200 @@
+/* eslint-disable no-ternary, no-plusplus, require-jsdoc */
+
+class DisplayCondition {
+  constructor(options = {}) {
+    this.wrapperField = options.wrapperField;
+    this.type = options.type;
+    this.conditionQuestion = options.conditionQuestion;
+    this.answerOption = options.answerOption;
+    this.mandatory = options.mandatory;
+    this.value = options.value;
+    this.onFulfilled = options.onFulfilled;
+    this.bindEvent();
+  }
+
+  bindEvent() {
+    this.checkCondition();
+    this.getInputsToListen().on("change", this.checkCondition.bind(this));
+  }
+
+  getInputValue() {
+    const $conditionWrapperField = $(`.question[data-question-id='${this.conditionQuestion}']`);
+    const $textInput = $conditionWrapperField.find("textarea, input[type='text']:not([name$=\\[custom_body\\]])");
+
+    if ($textInput.length) {
+      return $textInput.val();
+    }
+
+    let multipleInput = [];
+
+    $conditionWrapperField.find(".radio-button-collection, .check-box-collection").find(".collection-input").each((idx, el) => {
+      const $input = $(el).find("input[name$=\\[body\\]]");
+      const checked = $input.is(":checked");
+
+      if (checked) {
+        const text = $(el).find("input[name$=\\[custom_body\\]]").val();
+        const value = $input.val();
+        const id = $(el).find("input[name$=\\[answer_option_id\\]]").val();
+
+        multipleInput.push({ id, value, text });
+      }
+    });
+
+    return multipleInput;
+  }
+
+  getInputsToListen() {
+    const $conditionWrapperField = $(`.question[data-question-id='${this.conditionQuestion}']`);
+    const $textInput = $conditionWrapperField.find("textarea, input[type='text']:not([name$=\\[custom_body\\]])");
+
+    if ($textInput.length) {
+      return $textInput;
+    }
+
+    return $conditionWrapperField.find(".collection-input").find("input:not([type='hidden'])");
+  }
+
+  checkAnsweredCondition(value) {
+    if (typeof (value) !== "object") {
+      return Boolean(value);
+    }
+
+    return Boolean(value.some((it) => it.value));
+  }
+
+  checkNotAnsweredCondition(value) {
+    return !this.checkAnsweredCondition(value);
+  }
+
+  checkEqualCondition(value) {
+    if (value.length) {
+      return value.some((it) => it.id === this.answerOption.toString());
+    }
+    return false;
+  }
+
+  checkNotEqualCondition(value) {
+    if (value.length) {
+      return value.every((it) => it.id !== this.answerOption.toString());
+    }
+    return false;
+  }
+
+  checkMatchCondition(value) {
+    let regexp = new RegExp(this.value, "i");
+
+    if (typeof (value) !== "object") {
+      return Boolean(value.match(regexp));
+    }
+
+    return value.some(function (it) {
+      return it.text
+        ? it.text.match(regexp)
+        : it.value.match(regexp)
+    });
+  }
+
+  checkCondition() {
+    const value = this.getInputValue();
+    let fulfilled = false;
+
+    switch (this.type) {
+    case "answered":
+      fulfilled = this.checkAnsweredCondition(value);
+      break;
+    case "not_answered":
+      fulfilled = this.checkNotAnsweredCondition(value);
+      break;
+    case "equal":
+      fulfilled = this.checkEqualCondition(value);
+      break;
+    case "not_equal":
+      fulfilled = this.checkNotEqualCondition(value);
+      break;
+    case "match":
+      fulfilled = this.checkMatchCondition(value);
+      break;
+    default:
+      fulfilled = false;
+      break;
+    }
+
+    this.onFulfilled(fulfilled);
+  }
+}
+
+class DisplayConditionsComponent {
+  constructor(options = {}) {
+    this.wrapperField = options.wrapperField;
+    this.conditions = {};
+    this.showCount = 0;
+    this.initializeConditions();
+  }
+
+  initializeConditions() {
+    const $conditionElements = this.wrapperField.find(".display-condition");
+
+    $conditionElements.each((idx, el) => {
+      const $condition = $(el);
+      const id = $condition.data("id");
+      this.conditions[id] = {};
+
+      this.conditions[id] = new DisplayCondition({
+        wrapperField: this.wrapperField,
+        type: $condition.data("type"),
+        conditionQuestion: $condition.data("condition"),
+        answerOption: $condition.data("option"),
+        mandatory: $condition.data("mandatory"),
+        value: $condition.data("value"),
+        onFulfilled: (fulfilled) => {
+          this.onFulfilled(id, fulfilled);
+        }
+      });
+    });
+  }
+
+  mustShow() {
+    const conditions = Object.values(this.conditions);
+    const mandatoryConditions = conditions.filter((condition) => condition.mandatory);
+    const nonMandatoryConditions = conditions.filter((condition) => !condition.mandatory);
+
+    if (mandatoryConditions.length) {
+      return mandatoryConditions.every((condition) => condition.fulfilled);
+    }
+
+    return nonMandatoryConditions.some((condition) => condition.fulfilled);
+
+  }
+
+  onFulfilled(id, fulfilled) {
+    this.conditions[id].fulfilled = fulfilled;
+
+    if (this.mustShow()) {
+      this.showQuestion();
+    }
+    else {
+      this.hideQuestion();
+    }
+  }
+
+  showQuestion() {
+    this.wrapperField.fadeIn();
+    this.wrapperField.find("input, textarea").prop("disabled", null);
+    this.showCount++;
+  }
+
+  hideQuestion() {
+    if (this.showCount) {
+      this.wrapperField.fadeOut();
+    }
+    else {
+      this.wrapperField.hide();
+    }
+
+    this.wrapperField.find("input, textarea").prop("disabled", "disabled");
+  }
+}
+
+export default function createDisplayConditions(options) {
+  return new DisplayConditionsComponent(options);
+}