decidim-forms 0.16.0

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # This class holds a Form to answer a questionnaire from Decidim's public page.
+    class QuestionnaireForm < Decidim::Form
+      attribute :answers, Array[AnswerForm]
+
+      attribute :tos_agreement, Boolean
+      validates :tos_agreement, allow_nil: false, acceptance: true
+
+      # Private: Create the answers from the questionnaire questions
+      #
+      # Returns nothing.
+      def map_model(model)
+        self.answers = model.questions.map do |question|
+          AnswerForm.from_model(Decidim::Forms::Answer.new(question: question))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    module Admin
+      # Custom helpers, scoped to the forms engine.
+      #
+      module ApplicationHelper
+        def tabs_id_for_question(question)
+          "questionnaire_question_#{question.to_param}"
+        end
+
+        def tabs_id_for_question_answer_option(question, answer_option)
+          "questionnaire_question_#{question.to_param}_answer_option_#{answer_option.to_param}"
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/decidim/forms/has_questionnaire.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Forms
+    # A concern with the components needed when you want a model to be have a questionnaire attached
+    module HasQuestionnaire
+      extend ActiveSupport::Concern
+
+      included do
+        has_one :questionnaire,
+                class_name: "Decidim::Forms::Questionnaire",
+                dependent: :destroy,
+                inverse_of: :questionnaire_for,
+                as: :questionnaire_for
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # The data store for an Answer in the Decidim::Forms
+    class Answer < Forms::ApplicationRecord
+      include Decidim::DataPortability
+
+      belongs_to :user, class_name: "Decidim::User", foreign_key: "decidim_user_id"
+      belongs_to :questionnaire, class_name: "Questionnaire", foreign_key: "decidim_questionnaire_id"
+      belongs_to :question, class_name: "Question", foreign_key: "decidim_question_id"
+
+      has_many :choices,
+               class_name: "AnswerChoice",
+               foreign_key: "decidim_answer_id",
+               dependent: :destroy,
+               inverse_of: :answer
+
+      validates :body, presence: true, if: -> { question.mandatory_body? }
+      validates :choices, presence: true, if: -> { question.mandatory_choices? }
+
+      validate :user_questionnaire_same_organization
+      validate :question_belongs_to_questionnaire
+
+      def self.user_collection(user)
+        where(decidim_user_id: user.id)
+      end
+
+      def self.export_serializer
+        Decidim::Forms::DataPortabilityUserAnswersSerializer
+      end
+
+      private
+
+      def user_questionnaire_same_organization
+        return if user&.organization == questionnaire.questionnaire_for&.organization
+        errors.add(:user, :invalid)
+      end
+
+      def question_belongs_to_questionnaire
+        errors.add(:questionnaire, :invalid) if question&.questionnaire != questionnaire
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    class AnswerChoice < Forms::ApplicationRecord
+      belongs_to :answer,
+                 class_name: "Answer",
+                 foreign_key: "decidim_answer_id"
+
+      belongs_to :answer_option,
+                 class_name: "AnswerOption",
+                 foreign_key: "decidim_answer_option_id"
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    class AnswerOption < Forms::ApplicationRecord
+      default_scope { order(arel_table[:id].asc) }
+
+      belongs_to :question, class_name: "Question", foreign_key: "decidim_question_id"
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # The data store for a Question in the Decidim::Forms component.
+    class Question < Forms::ApplicationRecord
+      TYPES = %w(short_answer long_answer single_option multiple_option sorting).freeze
+
+      belongs_to :questionnaire, class_name: "Questionnaire", foreign_key: "decidim_questionnaire_id"
+
+      has_many :answer_options,
+               class_name: "AnswerOption",
+               foreign_key: "decidim_question_id",
+               dependent: :destroy,
+               inverse_of: :question
+
+      validates :question_type, inclusion: { in: TYPES }
+
+      def multiple_choice?
+        %w(single_option multiple_option sorting).include?(question_type)
+      end
+
+      def mandatory_body?
+        mandatory? && !multiple_choice?
+      end
+
+      def mandatory_choices?
+        mandatory? && multiple_choice?
+      end
+
+      def number_of_options
+        answer_options.size
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # The data store for a Questionnaire in the Decidim::Forms component.
+    class Questionnaire < Forms::ApplicationRecord
+      belongs_to :questionnaire_for, polymorphic: true
+
+      has_many :questions, -> { order(:position) }, class_name: "Question", foreign_key: "decidim_questionnaire_id", dependent: :destroy
+      has_many :answers, class_name: "Answer", foreign_key: "decidim_questionnaire_id", dependent: :destroy
+
+      # Public: returns whether the questionnaire questions can be modified or not.
+      def questions_editable?
+        answers.empty?
+      end
+
+      # Public: returns whether the questionnaire is answered by the user or not.
+      def answered_by?(user)
+        answers.where(user: user).any? if questions.present?
+      end
+    end
+  end
+end

data/app/queries/decidim/forms/questionnaire_user_answers.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # A class used to collect user answers for a questionnaire
+    class QuestionnaireUserAnswers < Rectify::Query
+      # Syntactic sugar to initialize the class and return the queried objects.
+      #
+      # questionnaire - a Questionnaire object
+      def self.for(questionnaire)
+        new(questionnaire).query
+      end
+
+      # Initializes the class.
+      #
+      # questionnaire = a Questionnaire object
+      def initialize(questionnaire)
+        @questionnaire = questionnaire
+      end
+
+      # Finds and group answers by user for each questionnaire's question.
+      def query
+        answers = Answer.where(questionnaire: @questionnaire)
+        answers.sort_by { |answer| answer.question.position }.group_by(&:user).values
+      end
+    end
+  end
+end

data/app/views/decidim/forms/admin/questionnaires/_answer_option.html.erb

@@ -0,0 +1,44 @@
+<% answer_option = form.object %>
+
+<div class="card questionnaire-question-answer-option">
+  <div class="card-divider">
+    <h2 class="card-title">
+    <span><%= t(".answer_option") %></span>
+    <% if editable %>
+      <button class="button small alert hollow remove-answer-option button--title">
+        <%= t(".remove") %>
+      </button>
+    <% end %>
+    </h2>
+  </div>
+
+  <div class="card-section">
+    <div class="row column">
+      <%=
+        form.translated(
+          :text_field,
+          :body,
+          tabs_id: tabs_id_for_question_answer_option(question, answer_option),
+          label: t(".statement"),
+          disabled: !editable
+        )
+      %>
+    </div>
+
+    <div class="row column">
+      <%=
+        form.check_box(
+          :free_text,
+          label: t(".free_text"),
+          disabled: !questionnaire.questions_editable?
+        )
+      %>
+    </div>
+  </div>
+
+  <% if answer_option.persisted? %>
+    <%= form.hidden_field :id, disabled: !editable %>
+  <% end %>
+
+  <%= form.hidden_field :deleted, disabled: !editable %>
+</div>

data/app/views/decidim/forms/admin/questionnaires/_form.html.erb

@@ -0,0 +1,51 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title">
+      <%= title %>
+      <div class="button--title">
+        <%= export_dropdown if allowed_to? :export_answers, :questionnaire %>
+      </div>
+    </h2>
+  </div>
+  <div class="card-section">
+    <div class="row column">
+      <%= form.translated :text_field, :title, autofocus: true %>
+    </div>
+    <div class="row column">
+      <%= form.translated :editor, :description, toolbar: :full, lines: 30, label: t("models.components.description", scope: "decidim.forms.admin") %>
+    </div>
+    <div class="row column">
+      <%= form.translated :editor, :tos, toolbar: :full, lines: 10, label: t("models.components.tos", scope: "decidim.forms.admin") %>
+    </div>
+  </div>
+</div>
+
+<div class="questionnaire-questions">
+  <% if questionnaire.questions_editable? %>
+    <template>
+      <%= fields_for "questionnaire[questions][#{blank_question.to_param}]", blank_question do |question_form| %>
+        <%= render "decidim/forms/admin/questionnaires/question", form: question_form, id: tabs_id_for_question(blank_question), editable: questionnaire.questions_editable? %>
+      <% end %>
+    </template>
+  <% else %>
+    <div class="callout warning">
+      <%= t(".already_answered_warning") %>
+    </div>
+  <% end %>
+
+  <div class="questionnaire-questions-list">
+    <% @form.questions.each do |question| %>
+      <%= fields_for "questionnaire[questions][]", question do |question_form| %>
+        <%= render "decidim/forms/admin/questionnaires/question", form: question_form, id: tabs_id_for_question(question), editable: questionnaire.questions_editable? %>
+      <% end %>
+    <% end %>
+  </div>
+
+  <% if questionnaire.questions_editable? %>
+    <button class="button add-question"><%= t(".add_question") %></button>
+  <% end %>
+</div>
+
+<% if questionnaire.questions_editable? %>
+  <%= javascript_include_tag "decidim/forms/admin/forms" %>
+<% end %>

data/app/views/decidim/forms/admin/questionnaires/_question.html.erb

@@ -0,0 +1,115 @@
+<% question = form.object %>
+
+<div class="card questionnaire-question" id="<%= id %>-field">
+  <div class="card-divider question-divider">
+    <h2 class="card-title">
+    <span>
+      <% if editable %>
+        <%== "#{icon("move")} #{t(".question")}" %>
+      <% else %>
+        <%= t(".question") %>
+      <% end %>
+    </span>
+
+    <% if editable %>
+      <button class="button small alert hollow move-up-question button--title">
+        <%== "#{icon("arrow-top")} #{t(".up")}" %>
+      </button>
+
+      <button class="button small alert hollow move-down-question button--title">
+        <%== "#{icon("arrow-bottom")} #{t(".down")}" %>
+      </button>
+
+      <button class="button small alert hollow remove-question button--title">
+        <%= t(".remove") %>
+      </button>
+    <% end %>
+    </h2>
+  </div>
+
+  <div class="card-section">
+    <div class="row column">
+      <%=
+        form.translated(
+          :text_field,
+          :body,
+          tabs_id: id,
+          label: t(".statement"),
+          disabled: !editable
+        )
+      %>
+    </div>
+
+    <div class="row column">
+      <%=
+        form.translated(
+          :editor,
+          :description,
+          toolbar: :full,
+          tabs_id: id,
+          label: t(".description"),
+          disabled: !editable
+        )
+      %>
+    </div>
+
+    <div class="row column">
+      <%=
+        form.check_box(
+          :mandatory,
+          disabled: !editable,
+          label: t("activemodel.attributes.questionnaire_question.mandatory")
+        )
+      %>
+    </div>
+
+    <div class="row column">
+      <%=
+        form.select(
+          :question_type,
+          options_from_collection_for_select(question_types, :first, :last, question.question_type),
+          {},
+          disabled: !editable
+        )
+      %>
+    </div>
+
+    <% if question.persisted? %>
+      <%= form.hidden_field :id, disabled: !editable %>
+    <% end %>
+
+    <%= form.hidden_field :position, value: question.position || 0, disabled: !editable %>
+    <%= form.hidden_field :deleted, disabled: !editable %>
+
+    <div class="questionnaire-question-answer-options">
+      <template>
+        <%= fields_for "questionnaire[questions][#{question.to_param}][answer_options][]", blank_answer_option do |answer_option_form| %>
+          <%= render "decidim/forms/admin/questionnaires/answer_option", form: answer_option_form, question: question, editable: editable %>
+        <% end %>
+      </template>
+
+      <div class="questionnaire-question-answer-options-list">
+        <% question.answer_options.each do |answer_option| %>
+          <%= fields_for "questionnaire[questions][#{question.to_param}][answer_options][]", answer_option do |answer_option_form| %>
+            <%= render "decidim/forms/admin/questionnaires/answer_option", form: answer_option_form, question: question, editable: editable %>
+          <% end %>
+        <% end %>
+      </div>
+
+      <% if editable %>
+        <button class="button add-answer-option"><%= t(".add_answer_option") %></button>
+      <% end %>
+    </div>
+
+    <div class="row column questionnaire-question-max-choices">
+      <%=
+        form.select(
+          :max_choices,
+          (2..question.number_of_options),
+          { prompt: t(".any") },
+          disabled: !editable
+        )
+      %>
+    </div>
+  </div>
+</div>