decidim-surveys 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d69c74665668b67e559573ca50ba753023f7730
+  data.tar.gz: 197812b81fe85469d40b6a4eb9e26904dc8321b8
+SHA512:
+  metadata.gz: 105ca8bc419db8b649bb4c1afcd3cf3fdd2b960a5e92f40073a17f05d1cff5bebcfb5a70c66ccebf69d025dc4ed56ee2be476c0cf174a06b0973478e9be8d2b9
+  data.tar.gz: 6689cceacf3b2814e764894a022afb799e93af0073f8bbbf498c8de65187a8b8264960bc6a126581d76cb5ef518e373eac7a15f775af0cdd79d58ca27fbb45ef

data/README.md

@@ -0,0 +1,24 @@
+# Decidim::Surveys
+
+The Surveys module adds one of the main features of Decidim: allows admins to contribute to a participatory process by creating surveys. Users can participate in the surveys answering their questions from the public page.
+
+## Usage
+Surveys will be available as a Feature for a Participatory Process.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-surveys'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Contributing
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+See [Decidim](https://github.com/decidim/decidim).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"

data/app/assets/config/admin/decidim_surveys_manifest.js

@@ -0,0 +1 @@
+//= link decidim/surveys/admin/surveys.js

data/app/assets/images/decidim/surveys/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 36.02 36.02"><path d="M373,545.54a18,18,0,1,1,18-18A18,18,0,0,1,373,545.54Zm0-34a16,16,0,1,0,16,16A16,16,0,0,0,373,511.53Z" transform="translate(-354.99 -509.53)"/><path d="M377.73,536.41h-9.46a1,1,0,1,1,0-2h9.46A1,1,0,0,1,377.73,536.41Z" transform="translate(-354.99 -509.53)"/><path d="M375,525.54h-6.73a1,1,0,1,1,0-2H375A1,1,0,1,1,375,525.54Z" transform="translate(-354.99 -509.53)"/><path d="M375,535.41a1,1,0,0,1-1-1v-9.87a1,1,0,1,1,2,0v9.87A1,1,0,0,1,375,535.41Z" transform="translate(-354.99 -509.53)"/><path d="M373,523a3,3,0,1,1,3-3A3,3,0,0,1,373,523Zm0-4a1,1,0,1,0,1,1A1,1,0,0,0,373,519Z" transform="translate(-354.99 -509.53)"/><path d="M371,535.41a1,1,0,0,1-1-1v-9.87a1,1,0,1,1,2,0v9.87A1,1,0,0,1,371,535.41Z" transform="translate(-354.99 -509.53)"/></svg>

data/app/assets/javascripts/decidim/surveys/admin/auto_label_by_position.component.js.es6

@@ -0,0 +1,33 @@
+((exports) => {
+  class AutoLabelByPositionComponent {
+    constructor(options = {}) {
+      this.listSelector = options.listSelector;
+      this.labelSelector = options.labelSelector;
+      this.onPositionComputed = options.onPositionComputed;
+
+      this.run();
+    }
+
+    run() {
+      const $list = $(this.listSelector);
+
+      $list.each((idx, el) => {
+        const $label = $(el).find(this.labelSelector);
+        const labelContent = $label.html();
+
+        if (labelContent.match(/#(\d+)/)) {
+          $label.html(labelContent.replace(/#(\d+)/, `#${idx + 1}`));
+        } else {
+          $label.html(`${labelContent} #${idx + 1}`);
+        }
+
+        if (this.onPositionComputed) {
+          this.onPositionComputed(el, idx);
+        }
+      });
+    }
+  }
+
+  exports.DecidimAdmin = exports.DecidimAdmin || {};
+  exports.DecidimAdmin.AutoLabelByPositionComponent = AutoLabelByPositionComponent;
+})(window);

data/app/assets/javascripts/decidim/surveys/admin/dynamic_fields.component.js.es6

@@ -0,0 +1,95 @@
+((exports) => {
+  class DynamicFieldsComponent {
+    constructor(options = {}) {
+      this.templateId = options.templateId;
+      this.wrapperSelector = options.wrapperSelector;
+      this.containerSelector = options.containerSelector;
+      this.fieldSelector = options.fieldSelector;
+      this.addFieldButtonSelector = options.addFieldButtonSelector;
+      this.removeFieldButtonSelector = options.removeFieldButtonSelector;
+      this.onAddField = options.onAddField;
+      this.onRemoveField = options.onRemoveField;
+      this.tabsPrefix = options.tabsPrefix;
+      this._compileTemplate();
+      this._bindEvents();
+    }
+
+    _compileTemplate() {
+      $.template(this.templateId, $(`#${this.templateId}`).html());
+    }
+
+    _bindEvents() {
+      $(this.wrapperSelector).on('click', this.addFieldButtonSelector, (event) =>
+        this._bindSafeEvent(event, () => this._addField())
+      );
+
+      $(this.wrapperSelector).on('click', this.removeFieldButtonSelector, (event) =>
+        this._bindSafeEvent(event, (target) => this._removeField(target))
+      );
+    }
+
+    _bindSafeEvent(event, cb) {
+      event.preventDefault();
+      event.stopPropagation();
+
+      try {
+        return cb(event.target);
+      } catch (error) {
+        console.error(error); // eslint-disable-line no-console
+        return error;
+      }
+    }
+
+    _addField() {
+      const $container = $(this.wrapperSelector).find(this.containerSelector);
+      const uid = this._getUID();
+      const tabsId = `${this.tabsPrefix}-${uid}`;
+
+      const $newField = $.tmpl(this.templateId, { tabsId });
+
+      $newField.attr('id', `${tabsId}-field`);
+      $newField.find('[disabled]').attr('disabled', false);
+      $newField.find('ul.tabs').attr('data-tabs', true);
+
+      $newField.appendTo($container);
+      $newField.foundation();
+
+      if (this.onAddField) {
+        this.onAddField($newField);
+      }
+    }
+
+    _removeField(target) {
+      const $target = $(target);
+      const $removedField = $target.parents(this.fieldSelector);
+      const idInput = $removedField.find('input').filter((idx, input) => input.name.match(/id/));
+
+      if (idInput.length > 0) {
+        const deletedInput = $removedField.find('input').filter((idx, input) => input.name.match(/delete/));
+
+        if (deletedInput.length > 0) {
+          $(deletedInput[0]).val(true);
+        }
+
+        $removedField.addClass('hidden');
+        $removedField.hide();
+      } else {
+        $removedField.remove();
+      }
+
+      if (this.onRemoveField) {
+        this.onRemoveField($removedField);
+      }
+    }
+
+    _getUID() {
+      return `${new Date().getTime()}-${Math.floor(Math.random() * 1000000)}`;
+    }
+  }
+
+  exports.DecidimAdmin = exports.DecidimAdmin || {};
+  exports.DecidimAdmin.DynamicFieldsComponent = DynamicFieldsComponent;
+  exports.DecidimAdmin.createDynamicFields = (options) => {
+    return new DynamicFieldsComponent(options);
+  };
+})(window);

data/app/assets/javascripts/decidim/surveys/admin/surveys.js.es6

@@ -0,0 +1,85 @@
+// = require jquery-tmpl
+// = require ./auto_label_by_position.component
+// = require ./dynamic_fields.component
+
+((exports) => {
+  const { AutoLabelByPositionComponent, createDynamicFields, createSortList } = exports.DecidimAdmin;
+
+  const wrapperSelector = '.survey-questions';
+  const fieldSelector = '.survey-question';
+  const questionTypeSelector = '[name="survey[questions][][question_type]"]';
+  const answerOptionsWrapperSelector = '.survey-question-answer-options';
+
+  const autoLabelByPosition = new AutoLabelByPositionComponent({
+    listSelector: '.survey-question:not(.hidden)',
+    labelSelector: '.card-title span:first',
+    onPositionComputed: (el, idx) => {
+      $(el).find('input[name="survey[questions][][position]"]').val(idx);
+    }
+  });
+
+  const createSortableList = () => {
+    createSortList('.survey-questions-list:not(.published)', {
+      handle: '.question-divider',
+      placeholder: '<div style="border-style: dashed; border-color: #000"></div>',
+      forcePlaceholderSize: true,
+      onSortUpdate: () => { autoLabelByPosition.run() }
+    });
+  };
+
+  const createDynamicFieldsForAnswerOptions = (fieldId) => {
+    createDynamicFields({
+      templateId: `survey-question-answer-option-tmpl`,
+      tabsPrefix: `survey-question-answer-option`,
+      wrapperSelector: `#${fieldId} ${answerOptionsWrapperSelector}`,
+      containerSelector: `.survey-question-answer-options-list`,
+      fieldSelector: `.survey-question-answer-option`,
+      addFieldButtonSelector: `.add-answer-option`,
+      removeFieldButtonSelector: `.remove-answer-option`
+    });
+  };
+
+  const setAnswerOptionsWrapperVisibility = ($target) => {
+    const $answerOptionsWrapper = $target.parents(fieldSelector).find(answerOptionsWrapperSelector);
+    const value = $target.val();
+
+    $answerOptionsWrapper.hide();
+
+    if (value === 'single_option' || value === 'multiple_option') {
+      $answerOptionsWrapper.show();
+    }
+  };
+
+  createDynamicFields({
+    templateId: 'survey-question-tmpl',
+    tabsPrefix: 'survey-question',
+    wrapperSelector: wrapperSelector,
+    containerSelector: '.survey-questions-list',
+    fieldSelector: fieldSelector,
+    addFieldButtonSelector: '.add-question',
+    removeFieldButtonSelector: '.remove-question',
+    onAddField: ($field) => {
+      const fieldId = $field.attr('id');
+
+      createSortableList();
+      autoLabelByPosition.run();
+      createDynamicFieldsForAnswerOptions(fieldId);
+      setAnswerOptionsWrapperVisibility($field.find(questionTypeSelector));
+    },
+    onRemoveField: () => {
+      autoLabelByPosition.run();
+    }
+  });
+
+  createSortableList();
+
+  $(fieldSelector).each((idx, el) => {
+    createDynamicFieldsForAnswerOptions($(el).attr('id'));
+    setAnswerOptionsWrapperVisibility($(el).find(questionTypeSelector));
+  });
+
+  $(wrapperSelector).on('change', questionTypeSelector, (ev) => {
+    const $target = $(ev.target);
+    setAnswerOptionsWrapperVisibility($target);
+  });
+})(window);

data/app/assets/stylesheets/decidim/surveys/surveys.scss

@@ -0,0 +1,9 @@
+form.answer-survey {
+  .radio-button-collection, .check-box-collection {
+    margin: 0 0 1rem;
+  }
+
+  .tos-agreement-help-text {
+    margin: 0.2rem 0 0;
+  }
+}

data/app/commands/decidim/surveys/admin/update_survey.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # This command is executed when the user changes a Survey from the admin
+      # panel.
+      class UpdateSurvey < Rectify::Command
+        # Initializes a UpdateSurvey Command.
+        #
+        # form - The form from which to get the data.
+        # survey - The current instance of the survey to be updated.
+        def initialize(form, survey)
+          @form = form
+          @survey = survey
+        end
+
+        # Updates the survey if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if @form.invalid?
+
+          Survey.transaction do
+            update_survey_questions if @survey.questions_editable?
+            update_survey
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        def update_survey_questions
+          @form.questions.each do |form_question|
+            question_attributes = {
+              body: form_question.body,
+              position: form_question.position,
+              mandatory: form_question.mandatory,
+              question_type: form_question.question_type,
+              answer_options: form_question.answer_options.map { |answer| { "body" => answer.body } }
+            }
+
+            if form_question.id.present?
+              question = @survey.questions.where(id: form_question.id).first
+              if form_question.deleted?
+                question.destroy!
+              else
+                question.update_attributes!(question_attributes)
+              end
+            else
+              @survey.questions.create!(question_attributes)
+            end
+          end
+        end
+
+        def update_survey
+          @survey.update_attributes!(title: @form.title,
+                                     description: @form.description,
+                                     tos: @form.tos)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/surveys/answer_survey.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This command is executed when the user answers a Survey.
+    class AnswerSurvey < Rectify::Command
+      # Initializes a AnswerSurvey Command.
+      #
+      # form - The form from which to get the data.
+      # survey - The current instance of the survey to be answered.
+      def initialize(form, current_user, survey)
+        @form = form
+        @current_user = current_user
+        @survey = survey
+      end
+
+      # Answers a survey if it is valid
+      #
+      # Broadcasts :ok if successful, :invalid otherwise.
+      def call
+        return broadcast(:invalid) if @form.invalid?
+
+        answer_survey
+        broadcast(:ok)
+      end
+
+      private
+
+      def answer_survey
+        SurveyAnswer.transaction do
+          @form.answers.each do |form_answer|
+            SurveyAnswer.create!(
+              user: @current_user,
+              survey: @survey,
+              question: form_answer.question,
+              body: form_answer.body
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/surveys/create_survey.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # Command that gets called whenever a feature's survey has to be created. It
+    # usually happens as a callback when the feature itself is created.
+    class CreateSurvey < Rectify::Command
+      def initialize(feature)
+        @feature = feature
+      end
+
+      def call
+        @survey = Survey.new(feature: @feature)
+
+        @survey.save ? broadcast(:ok) : broadcast(:invalid)
+      end
+    end
+  end
+end

data/app/controllers/decidim/surveys/admin/application_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::Features::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::Features::BaseController
+      end
+    end
+  end
+end

data/app/controllers/decidim/surveys/admin/surveys_controller.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # This controller allows the user to update a Page.
+      class SurveysController < Admin::ApplicationController
+        helper_method :survey, :blank_question, :blank_answer_option, :question_types
+
+        def edit
+          authorize! :edit, Survey
+          @form = form(Admin::SurveyForm).from_model(survey)
+        end
+
+        def update
+          authorize! :update, Survey
+          params["published_at"] = Time.current if params.has_key? "save_and_publish"
+          @form = form(Admin::SurveyForm).from_params(params)
+
+          Admin::UpdateSurvey.call(@form, survey) do
+            on(:ok) do
+              flash[:notice] = I18n.t("surveys.update.success", scope: "decidim.surveys.admin")
+              redirect_to parent_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("surveys.update.invalid", scope: "decidim.surveys.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        private
+
+        def survey
+          @survey ||= Survey.find_by(feature: current_feature)
+        end
+
+        def blank_question
+          @blank_question ||= survey.questions.build(body: {}, answer_options: [])
+        end
+
+        def blank_answer_option
+          @blank_answer_option ||= OpenStruct.new(body: {})
+        end
+
+        def question_types
+          @question_types ||= SurveyQuestion::TYPES.map do |question_type|
+            [question_type, I18n.t("decidim.surveys.question_types.#{question_type}")]
+          end
+        end
+      end
+    end
+  end
+end