decidim-forms 0.22.0 → 0.23.0

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

@@ -4,6 +4,9 @@ module Decidim
   module Forms
     # The data store for a QuestionMatrix in the Decidim::Forms component.
     class QuestionMatrixRow < Forms::ApplicationRecord
+      include Decidim::TranslatableResource
+
+      translatable_fields :body
       belongs_to :question, class_name: "Question", foreign_key: "decidim_question_id"
 
       delegate :answer_options, :mandatory, :max_choices, to: :question

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

@@ -4,6 +4,11 @@ module Decidim
   module Forms
     # The data store for a Questionnaire in the Decidim::Forms component.
     class Questionnaire < Forms::ApplicationRecord
+      include Decidim::Templates::Templatable if defined? Decidim::Templates::Templatable
+      include Decidim::Publicable
+      include Decidim::TranslatableResource
+
+      translatable_fields :title, :description, :tos
       belongs_to :questionnaire_for, polymorphic: true
 
       has_many :questions, -> { order(:position) }, class_name: "Question", foreign_key: "decidim_questionnaire_id", dependent: :destroy
@@ -11,7 +16,8 @@ module Decidim
 
       # Public: returns whether the questionnaire questions can be modified or not.
       def questions_editable?
-        answers.empty?
+        has_component = questionnaire_for.respond_to? :component
+        (has_component && !questionnaire_for.component.published?) || answers.empty?
       end
 
       # Public: returns whether the questionnaire is answered by the user or not.
@@ -19,6 +25,10 @@ module Decidim
         query = user.is_a?(String) ? { session_token: user } : { user: user }
         answers.where(query).any? if questions.present?
       end
+
+      def pristine?
+        created_at.to_i == updated_at.to_i && questions.empty?
+      end
     end
   end
 end

data/app/presenters/decidim/forms/admin/questionnaire_answer_presenter.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    module Admin
+      #
+      # Presenter for questionnaire answer
+      #
+      class QuestionnaireAnswerPresenter < Rectify::Presenter
+        include Decidim::TranslatableAttributes
+
+        attribute :answer, Decidim::Forms::Answer
+
+        def question
+          translated_attribute(answer.question.body)
+        end
+
+        def body
+          return answer.body if answer.body.present?
+          return "-" if answer.choices.empty?
+
+          choices = answer.choices.map do |choice|
+            choice.try(:custom_body) || choice.try(:body)
+          end
+
+          return choices.first if answer.question.question_type == "single_option"
+
+          content_tag(:ul) do
+            safe_join(choices.map { |c| choice(c) })
+          end
+        end
+
+        private
+
+        def choice(choice_body)
+          content_tag :li do
+            choice_body
+          end
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/forms/admin/questionnaire_participant_presenter.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    module Admin
+      #
+      # Presenter for questionnaire response
+      #
+      class QuestionnaireParticipantPresenter < Rectify::Presenter
+        attribute :participant, Decidim::Forms::Answer
+
+        def session_token
+          participant.session_token || "-"
+        end
+
+        def ip_hash
+          participant.ip_hash || "-"
+        end
+
+        def answered_at
+          participant.created_at
+        end
+
+        delegate :questionnaire, to: :participant
+
+        def registered?
+          participant.decidim_user_id.present?
+        end
+
+        def status
+          t(registered? ? "registered" : "unregistered", scope: "decidim.forms.user_answers_serializer")
+        end
+
+        def answers
+          sibilings.map { |answer| QuestionnaireAnswerPresenter.new(answer: answer) }
+        end
+
+        def first_short_answer
+          short = sibilings.where("decidim_forms_questions.question_type in (?)", %w(short_answer))
+          short.first
+        end
+
+        def completion
+          with_body = sibilings.where("decidim_forms_questions.question_type in (?)", %w(short_answer long_answer))
+                               .where.not(body: "").count
+          with_choices = sibilings.where.not("decidim_forms_questions.question_type in (?)", %w(short_answer long_answer))
+                                  .where("decidim_forms_answers.id IN (SELECT decidim_answer_id FROM decidim_forms_answer_choices)").count
+
+          (with_body + with_choices).to_f / questionnaire.questions.count * 100
+        end
+
+        private
+
+        def sibilings
+          Answer.where(session_token: participant.session_token).joins(:question).order("decidim_forms_questions.position ASC")
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/forms/answer_option_presenter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    #
+    # Decorator for answer_options
+    #
+    class AnswerOptionPresenter < SimpleDelegator
+      include Decidim::TranslationsHelper
+
+      def translated_body
+        @translated_body ||= translated_attribute body
+      end
+
+      def as_json(*_args)
+        { id: id, body: translated_body }
+      end
+    end
+  end
+end

data/app/presenters/decidim/forms/question_presenter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    #
+    # Decorator for questions
+    #
+    class QuestionPresenter < SimpleDelegator
+      include Decidim::TranslationsHelper
+
+      def translated_body
+        @translated_body ||= translated_attribute body
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # A class used to collect user answers for a questionnaire
+    class QuestionnaireParticipant < Rectify::Query
+      # Syntactic sugar to initialize the class and return the queried objects.
+      #
+      # questionnaire - a Questionnaire object
+      # session_token = the session_token used by the questionnaire participant
+      def self.for(questionnaire, session_token)
+        new(questionnaire, session_token).query
+      end
+
+      # Initializes the class.
+      #
+      # questionnaire = a Questionnaire object
+      # session_token = the session_token used by the questionnaire participant
+      def initialize(questionnaire, session_token)
+        @questionnaire = questionnaire
+        @token = session_token
+      end
+
+      # Returns query with participant info
+      def query
+        answers.select(:session_token, :decidim_user_id, :ip_hash).first
+      end
+
+      # Finds the participant's answers.
+      def answers
+        Answer.where(questionnaire: @questionnaire, session_token: @token)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # A class used to collect user answers for a questionnaire
+    class QuestionnaireParticipants < 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 all Answers for the questionnaire (unique session_tokens).
+      # Because exporters only have access to the Answers this
+      # is used as an indirect way to access the participants
+      # (see #participants and #participant)
+      def query
+        Answer.where(questionnaire: @questionnaire)
+      end
+
+      def participant(session_token)
+        query.find_by(session_token: session_token)
+      end
+
+      def participants
+        subquery = query.select("DISTINCT ON (decidim_forms_answers.session_token) decidim_forms_answers.*")
+        Answer.select("*").from(subquery).order(:created_at)
+      end
+
+      def count_participants
+        query.select(:session_token).distinct.count
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+<% display_condition = form.object %>
+
+<div class="card questionnaire-question-display-condition">
+  <div class="card-divider">
+    <h2 class="card-title">
+    <span><%= t(".display_condition") %></span>
+    <% if editable %>
+      <button class="button small alert hollow remove-display-condition button--title">
+        <%= t(".remove") %>
+      </button>
+    <% end %>
+    </h2>
+  </div>
+  <div class="card-section">
+    <div class="row column">
+      <small class="text-muted">
+        <%= t(".save_warning") %>
+      </small>
+    </div>
+  </div>
+  <div class="card-section">
+    <div class="row column questionnaire-question-display-condition-condition-question">
+      <%=
+        form.select(
+          :decidim_condition_question_id,
+          options_for_select(display_condition.questions_for_select(questionnaire, question.id), selected: display_condition.decidim_condition_question_id),
+          { prompt: t(".select_condition_question"), label: t(".condition_question") },
+          disabled: !editable,
+          data: { url: answer_options_url(id: question.id) }
+        )
+      %>
+    </div>
+    <div class="row column">
+      <%=
+        form.select(
+          :condition_type,
+          options_from_collection_for_select(display_condition_types, :first, :last, display_condition.condition_type),
+          { prompt: t(".select_condition_type"), label: t(".condition_type") },
+          disabled: !editable,
+        )
+      %>
+    </div>
+    <div class="row column questionnaire-question-display-condition-answer-option">
+      <%=
+        form.select(
+          :decidim_answer_option_id,
+          options_from_collection_for_select(display_condition.answer_options, :id, :translated_body, display_condition.answer_option),
+          { prompt: t(".select_answer_option"), label: t(".answer_option") },
+          disabled: !editable,
+          data: { selected: display_condition.answer_option&.id }
+        )
+      %>
+    </div>
+    <div class="row column questionnaire-question-display-condition-value">
+      <%=
+        form.translated(
+          :text_field,
+          :condition_value,
+          tabs_id: tabs_id_for_question_display_condition(question, display_condition),
+          label: t(".condition_value"),
+          disabled: !editable
+        )
+      %>
+    </div>
+    <div class="row column">
+      <%=
+        form.check_box(
+          :mandatory,
+          label: t(".mandatory"),
+          disabled: !questionnaire.questions_editable?
+        )
+      %>
+    </div>
+    <div class="row column">
+      <% display_condition.errors.full_messages.each do |msg| %>
+        <small class="form-error is-visible"><%= msg %></small>
+      <% end %>
+    </div>
+  </div>
+
+  <%= form.hidden_field :decidim_question_id, value: question.id, disabled: !editable %>
+
+  <% if display_condition.persisted? %>
+    <%= form.hidden_field :id, disabled: !editable %>
+  <% end %>
+
+  <%= form.hidden_field :deleted, disabled: !editable %>
+</div>

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

@@ -0,0 +1,7 @@
+<% question = form.object %>
+
+<script type="text/template" class="decidim-template" id="<%= template_id %>">
+  <%= fields_for "questionnaire[questions][#{question.to_param}][display_conditions][]", blank_display_condition do |display_condition_form| %>
+    <%= render "decidim/forms/admin/questionnaires/display_condition", form: display_condition_form, question: question, editable: editable %>
+  <% end %>
+</script>

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

@@ -1,10 +1,26 @@
 <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>
+      <%= t(".title") %>
+      <% unless template? questionnaire.questionnaire_for %>
+        <% if allowed_to? :preview, :questionnaire %>
+          <div class="button--title">
+            <%= link_to t(".preview"), public_url, class: "button tiny button--simple", target: :_blank %>
+          </div>
+        <% end %>
+        <% if questionnaire.answers.any? %>
+          <div class="button--title">
+            <%= export_dropdown if allowed_to? :export_answers, :questionnaire %>
+          </div>
+          <div class="button--title">
+            <% if allowed_to? :show, :questionnaire_answers %>
+              <%= link_to t("actions.show", scope: "decidim.forms.admin.questionnaires"), questionnaire_participants_url, class: "button tiny button--title new" %>
+            <% end %>
+          </div>
+        <% else %>
+          <button class="button tiny button--title" disabled><%= t("empty", scope: "decidim.forms.admin.questionnaires.answers") %></a>
+        <% end %>
+      <% end %>
     </h2>
   </div>
   <div class="card-section">
@@ -27,6 +43,12 @@
   </div>
 
   <% if questionnaire.questions_editable? %>
+    <% if questionnaire.answers.any? && !questionnaire.published? %>
+      <div class="callout warning">
+        <%= t(".unpublished_warning") %>
+      </div>
+    <% end %>
+
     <%= fields_for "questionnaire[questions][#{blank_question.to_param}]", blank_question do |question_form| %>
       <script type="text/template" class="decidim-question-template decidim-template" id="question-template">
         <%= render "decidim/forms/admin/questionnaires/question",
@@ -34,6 +56,7 @@
               id: tabs_id_for_question(blank_question),
               editable: questionnaire.questions_editable?,
               answer_option_template_selector: "#answer-option-template-dummy",
+              display_condition_template_selector: "#display-condition-template-dummy",
               matrix_row_template_selector: "#matrix-row-template-dummy" %>
       </script>
       <script type="text/template" class="decidim-separator-template decidim-template" id="separator-template">
@@ -43,6 +66,7 @@
               editable: questionnaire.questions_editable? %>
       </script>
       <%= render "decidim/forms/admin/questionnaires/answer_option_template", form: question_form, editable: questionnaire.questions_editable?, template_id: "answer-option-template-dummy" %>
+      <%= render "decidim/forms/admin/questionnaires/display_condition_template", form: question_form, editable: questionnaire.questions_editable?, template_id: "display-condition-template-dummy" %>
       <%= render "decidim/forms/admin/questionnaires/matrix_row_template", form: question_form, editable: questionnaire.questions_editable?, template_id: "matrix-row-template-dummy" %>
     <% end %>
   <% else %>
@@ -64,8 +88,10 @@
                 form: question_form,
                 id: tabs_id_for_question(question),
                 editable: questionnaire.questions_editable?,
+                display_condition_template_selector: "#display-condition-template-#{index}",
                 answer_option_template_selector: "#answer-option-template-#{index}",
                 matrix_row_template_selector: "#matrix-row-template-#{index}" %>
+          <%= render "decidim/forms/admin/questionnaires/display_condition_template", form: question_form, editable: questionnaire.questions_editable?, template_id: "display-condition-template-#{index}" %>
           <%= render "decidim/forms/admin/questionnaires/answer_option_template", form: question_form, editable: questionnaire.questions_editable?, template_id: "answer-option-template-#{index}" %>
           <%= render "decidim/forms/admin/questionnaires/matrix_row_template", form: question_form, editable: questionnaire.questions_editable?, template_id: "matrix-row-template-#{index}" %>
         <% end %>

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

@@ -1,4 +1,5 @@
 <% question = form.object %>
+<% is_expanded = question.errors.any? %>
 
 <div class="card questionnaire-question" id="<%= id %>-field">
   <div class="card-divider question-divider">
@@ -11,11 +12,11 @@
     </span>
 
     <button type="button" class="button small secondary button--title question--collapse" data-toggle="<%= id %>-question-card button--collapse-question-<%= id %> button--expand-question-<%= id %>">
-      <span id="button--collapse-question-<%= id %>" data-toggler=".hide" class="icon-collapse hide">
+      <span id="button--collapse-question-<%= id %>" data-toggler=".hide" class="icon-collapse <%= "hide" unless is_expanded %>">
         <%== icon("caret-top", aria_label: t(".collapse"), role: "img") %>
       </span>
 
-      <span id="button--expand-question-<%= id %>" data-toggler=".hide" class="icon-expand">
+      <span id="button--expand-question-<%= id %>" data-toggler=".hide" class="icon-expand <%= "hide" if is_expanded %>">
         <%== icon("caret-bottom", aria_label: t(".expand"), role: "img") %>
       </span>
     </button>
@@ -36,7 +37,7 @@
     </h2>
   </div>
 
-  <div class="card-section collapsible hide" data-toggler=".hide" id="<%= id %>-question-card">
+  <div class="card-section collapsible <%= "hide" unless is_expanded %>" data-toggler=".hide" id="<%= id %>-question-card">
     <div class="row column">
       <%=
         form.translated(
@@ -128,5 +129,20 @@
         )
       %>
     </div>
+
+    <div class="questionnaire-question-display-conditions" data-template="<%= display_condition_template_selector %>">
+      <div class="questionnaire-question-display-conditions-list">
+        <% question.display_conditions.each do |display_condition| %>
+          <%= fields_for "questionnaire[questions][#{question.to_param}][display_conditions][]", display_condition do |display_condition_form| %>
+            <%= render "decidim/forms/admin/questionnaires/display_condition", form: display_condition_form, question: question, editable: editable %>
+          <% end %>
+        <% end %>
+      </div>
+
+      <% if editable %>
+        <% disabled = !question.persisted? %>
+        <button <%= "disabled" if disabled %> title="<%= disabled ? t(".add_display_condition_info") : t(".add_display_condition_info") %>" class="button add-display-condition"><%= t(".add_display_condition") %></button>
+      <% end %>
+    </div>
   </div>
 </div>