decidim-surveys 0.10.1 → 0.11.0.pre1

data/app/models/decidim/surveys/survey_answer.rb

@@ -8,7 +8,15 @@ module Decidim
       belongs_to :survey, class_name: "Survey", foreign_key: "decidim_survey_id"
       belongs_to :question, class_name: "SurveyQuestion", foreign_key: "decidim_survey_question_id"
 
-      validates :body, presence: true, if: -> { question.mandatory? }
+      has_many :choices,
+               class_name: "SurveyAnswerChoice",
+               foreign_key: "decidim_survey_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_survey_same_organization
       validate :question_belongs_to_survey
 

data/app/models/decidim/surveys/survey_answer_choice.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    class SurveyAnswerChoice < Surveys::ApplicationRecord
+      belongs_to :answer,
+                 class_name: "SurveyAnswer",
+                 foreign_key: "decidim_survey_answer_id"
+
+      belongs_to :answer_option,
+                 class_name: "SurveyAnswerOption",
+                 foreign_key: "decidim_survey_answer_option_id"
+    end
+  end
+end

data/app/models/decidim/surveys/survey_answer_option.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    class SurveyAnswerOption < Surveys::ApplicationRecord
+      belongs_to :question, class_name: "SurveyQuestion", foreign_key: "decidim_survey_question_id"
+    end
+  end
+end

data/app/models/decidim/surveys/survey_question.rb

@@ -4,16 +4,32 @@ module Decidim
   module Surveys
     # The data store for a SurveyQuestion in the Decidim::Surveys component.
     class SurveyQuestion < Surveys::ApplicationRecord
-      TYPES = %w(short_answer long_answer single_option multiple_option).freeze
+      TYPES = %w(short_answer long_answer single_option multiple_option sorting).freeze
 
       belongs_to :survey, class_name: "Survey", foreign_key: "decidim_survey_id"
 
+      has_many :answer_options,
+               class_name: "SurveyAnswerOption",
+               foreign_key: "decidim_survey_question_id",
+               dependent: :destroy,
+               inverse_of: :question
+
       validates :question_type, inclusion: { in: TYPES }
 
-      # Rectify can't handle a hash when using the from_model method so
-      # the answer options must be converted to struct.
-      def answer_options
-        self[:answer_options].map { |option| OpenStruct.new(option) }
+      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

data/app/views/decidim/surveys/admin/surveys/_answer_option.html.erb

@@ -1,9 +1,13 @@
+<% answer_option = form.object %>
+
 <div class="card survey-question-answer-option">
   <div class="card-divider">
     <h2 class="card-title">
     <span><%= t(".answer_option") %></span>
-    <% if survey.questions_editable? %>
-      <button class="button small alert hollow remove-answer-option button--title"><%= t('.remove_answer_option') %></button>
+    <% if editable %>
+      <button class="button small alert hollow remove-answer-option button--title">
+        <%= t(".remove") %>
+      </button>
     <% end %>
     </h2>
   </div>
@@ -11,17 +15,30 @@
   <div class="card-section">
     <div class="row column">
       <%=
-        translated_field_tag(
-          :text_field_tag,
-          "survey[questions][][answer_options][]",
-          "body",
-          answer_option.body,
-          tabs_id: tabs_id_for_question_answer_option(question, idx),
-          label: t('.statement'),
-          disabled: question.nil? || disabled_for_question(survey, question),
-          enable_tabs: question.present?
+        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: !survey.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/surveys/admin/surveys/_form.html.erb

@@ -12,36 +12,40 @@
       <%= 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.surveys.admin")  %>
+      <%= form.translated :editor, :description, toolbar: :full, lines: 30, label: t("models.components.description", scope: "decidim.surveys.admin") %>
     </div>
     <div class="row column">
-      <%= form.translated :editor, :tos, toolbar: :full, lines: 10, label: t("models.components.tos", scope: "decidim.surveys.admin")  %>
+      <%= form.translated :editor, :tos, toolbar: :full, lines: 10, label: t("models.components.tos", scope: "decidim.surveys.admin") %>
     </div>
   </div>
 </div>
 
 <div class="survey-questions">
   <% if survey.questions_editable? %>
-    <button class="button add-question"><%= t('.add_question') %></button>
-
-    <template id="survey-question-tmpl">
-      <%= render "question", question: blank_question %>
-    </template>
-
-    <template id="survey-question-answer-option-tmpl">
-      <%= render "answer_option", answer_option: blank_answer_option, question: nil, idx: nil %>
+    <template>
+      <%= fields_for "survey[questions][#{blank_question.to_param}]", blank_question do |question_form| %>
+        <%= render "question", form: question_form, id: tabs_id_for_question(blank_question), editable: survey.questions_editable? %>
+      <% end %>
     </template>
   <% else %>
     <div class="callout warning">
-      <%= t('.already_answered_warning') %>
+      <%= t(".already_answered_warning") %>
     </div>
   <% end %>
 
   <div class="survey-questions-list">
-    <% @form.questions.each_with_index do |question, idx| %>
-      <%= render "question", question: question %>
+    <% @form.questions.each do |question| %>
+      <%= fields_for "survey[questions][]", question do |question_form| %>
+        <%= render "question", form: question_form, id: tabs_id_for_question(question), editable: survey.questions_editable? %>
+      <% end %>
     <% end %>
   </div>
+
+  <% if survey.questions_editable? %>
+    <button class="button add-question"><%= t(".add_question") %></button>
+  <% end %>
 </div>
 
-<%= javascript_include_tag "decidim/surveys/admin/surveys" %>
+<% if survey.questions_editable? %>
+  <%= javascript_include_tag "decidim/surveys/admin/surveys" %>
+<% end %>

data/app/views/decidim/surveys/admin/surveys/_question.html.erb

@@ -1,16 +1,28 @@
-<div class="card survey-question" id="survey-question-<%= question.id %>-field">
+<% question = form.object %>
+
+<div class="card survey-question" id="<%= id %>-field">
   <div class="card-divider question-divider">
     <h2 class="card-title">
     <span>
-      <% if survey.questions_editable? %>
+      <% if editable %>
         <%== "#{icon("move")} #{t(".question")}" %>
       <% else %>
         <%= t(".question") %>
       <% end %>
     </span>
 
-    <% if survey.questions_editable? %>
-      <button class="button small alert hollow remove-question button--title"><%= t('.remove_question') %></button>
+    <% 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>
@@ -18,55 +30,86 @@
   <div class="card-section">
     <div class="row column">
       <%=
-        translated_field_tag(
-          :text_field_tag,
-          "survey[questions][]",
-          "body",
-          question.body.with_indifferent_access,
-          object: question,
-          tabs_id: tabs_id_for_question(question),
-          label: t('.statement'),
-          disabled: disabled_for_question(survey, question),
-          enable_tabs: question.persisted?
+        form.translated(
+          :text_field,
+          :body,
+          tabs_id: id,
+          label: t(".statement"),
+          disabled: !editable
         )
       %>
     </div>
 
     <div class="row column">
       <%=
-        check_box_tag(
-          "survey[questions][][mandatory]",
-          "1",
-          question.mandatory,
-          id: mandatory_id_for_question(question),
-          disabled: disabled_for_question(survey, question)
+        form.translated(
+          :editor,
+          :description,
+          toolbar: :full,
+          tabs_id: id,
+          label: t(".description"),
+          disabled: !editable
         )
       %>
-      <%= label_tag "", t('activemodel.attributes.survey_question.mandatory'), for: mandatory_id_for_question(question) %>
     </div>
 
     <div class="row column">
-      <%= label_tag "", t('activemodel.attributes.survey_question.question_type'), for: question_type_id_for_question(question) %>
-      <%= select_tag "survey[questions][][question_type]", options_from_collection_for_select(question_types, :first, :last, question.question_type), id: question_type_id_for_question(question), disabled: disabled_for_question(survey, question) %>
+      <%=
+        form.check_box(
+          :mandatory,
+          disabled: !editable,
+          label: t("activemodel.attributes.survey_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? %>
-      <%= hidden_field_tag "survey[questions][][id]", question.id, disabled: disabled_for_question(survey, question) %>
+      <%= form.hidden_field :id, disabled: !editable %>
     <% end %>
 
-    <%= hidden_field_tag "survey[questions][][position]", question.position || 0, disabled: disabled_for_question(survey, question) %>
-    <%= hidden_field_tag "survey[questions][][deleted]", false, disabled: disabled_for_question(survey, question) %>
+    <%= form.hidden_field :position, value: question.position || 0, disabled: !editable %>
+    <%= form.hidden_field :deleted, disabled: !editable %>
 
     <div class="survey-question-answer-options">
-      <% if survey.questions_editable? %>
-        <button class="button add-answer-option"><%= t('.add_answer_option') %></button>
-      <% end %>
+      <template>
+        <%= fields_for "survey[questions][#{question.to_param}][answer_options][]", blank_answer_option do |answer_option_form| %>
+          <%= render "answer_option", form: answer_option_form, question: question, editable: editable %>
+        <% end %>
+      </template>
 
       <div class="survey-question-answer-options-list">
-        <% question.answer_options.each_with_index do |answer_option, idx| %>
-          <%= render "answer_option", question: question, answer_option: answer_option, idx: idx %>
+        <% question.answer_options.each do |answer_option| %>
+          <%= fields_for "survey[questions][#{question.to_param}][answer_options][]", answer_option do |answer_option_form| %>
+            <%= render "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 survey-question-max-choices">
+      <%=
+        form.select(
+          :max_choices,
+          (2..question.number_of_options),
+          { prompt: t(".any") },
+          disabled: !editable
+        )
+      %>
     </div>
   </div>
 </div>

data/app/views/decidim/surveys/admin/surveys/edit.html.erb

@@ -1,5 +1,5 @@
 <%= decidim_form_for(@form, url: survey_path, method: :post, html: { class: "form edit_survey" }) do |form| %>
-  <%= render partial: 'form', object: form, locals: { title: t('.title') }  %>
+  <%= render partial: "form", object: form, locals: { title: t(".title") } %>
 
   <div class="button--double form-general-submit">
     <%= form.submit t(".save"), class: "button" %>

data/app/views/decidim/surveys/surveys/_answer.html.erb

@@ -0,0 +1,94 @@
+<% field_id = "survey_answers_#{answer_idx}" %>
+<%= label_tag field_id, answer.label(answer_idx), class: "survey-question" %>
+
+<% if translated_attribute(answer.question.description).present? %>
+  <div class="help-text">
+    <%= decidim_sanitize translated_attribute(answer.question.description) %>
+  </div>
+<% end %>
+
+<% case answer.question.question_type %>
+<% when "short_answer" %>
+  <%= answer_form.text_field :body, label: false, id: field_id %>
+<% when "long_answer" %>
+  <%= answer_form.text_area :body, label: false, id: field_id, rows: 10 %>
+<% when "single_option" %>
+  <div class="radio-button-collection">
+    <% choice = answer.choices.first %>
+
+    <% answer.question.answer_options.each_with_index do |answer_option, idx| %>
+      <% choice_id = "#{field_id}_choices_#{idx}" %>
+
+      <%= label_tag "#{choice_id}_body" do %>
+        <%= radio_button_tag "survey[answers][#{answer_idx}][choices][][body]",
+                             translated_attribute(answer_option.body),
+                             choice.try(:body),
+                             id: "#{choice_id}_body" %>
+
+        <%= translated_attribute(answer_option.body) %>
+
+        <% if answer_option.free_text %>
+          <%= text_field_tag "survey[answers][#{answer_idx}][choices][][custom_body]",
+                             choice.try(:custom_body),
+                             id: "#{choice_id}_custom_body",
+                             disabled: true %>
+        <% end %>
+
+        <%= hidden_field_tag "survey[answers][#{answer_idx}][choices][][answer_option_id]",
+                             answer_option.id,
+                             id: "#{choice_id}_answer_option",
+                             disabled: true %>
+      <% end %>
+    <% end %>
+  </div>
+<% when "multiple_option" %>
+  <div class="check-box-collection">
+    <% answer.question.answer_options.each_with_index do |answer_option, idx| %>
+      <% choice = answer.selected_choices.find { |choice| choice.answer_option_id == answer_option.id } %>
+
+      <%= label_tag do %>
+        <%= check_box_tag "survey[answers][#{answer_idx}][choices][#{idx}][body]",
+                          translated_attribute(answer_option.body),
+                          choice.present? %>
+
+        <%= translated_attribute(answer_option.body) %>
+
+        <% if answer_option.free_text %>
+          <%= text_field_tag "survey[answers][#{answer_idx}][choices][#{idx}][custom_body]",
+                             choice.try(:custom_body),
+                             disabled: true %>
+        <% end %>
+
+        <%= hidden_field_tag "survey[answers][#{answer_idx}][choices][#{idx}][answer_option_id]", answer_option.id %>
+      <% end %>
+    <% end %>
+  </div>
+<% when "sorting" %>
+  <div class="sortable-check-box-collection">
+    <% answer.question.answer_options.each_with_index do |answer_option, idx| %>
+      <% choice = answer.selected_choices.find { |choice| choice.answer_option_id == answer_option.id } %>
+
+      <%= label_tag do %>
+        <%= check_box_tag "survey[answers][#{answer_idx}][choices][#{idx}][body]",
+                          translated_attribute(answer_option.body),
+                          choice.present? %>
+
+        <span class="position"><%= choice.try(:position) %></span>
+
+        <%= translated_attribute(answer_option.body) %>
+
+        <%= hidden_field_tag "survey[answers][#{answer_idx}][choices][#{idx}][position]",
+                             choice.try(:position),
+                             disabled: true %>
+
+        <%= hidden_field_tag "survey[answers][#{answer_idx}][choices][#{idx}][answer_option_id]", answer_option.id %>
+      <% end %>
+    <% end %>
+  </div>
+<% end %>
+
+<%= answer_form.hidden_field :question_id %>
+
+<% answer.errors.full_messages.each do |msg| %>
+  <small class="form-error is-visible"><%= msg %></small>
+<% end %>

data/app/views/decidim/surveys/surveys/show.html.erb

@@ -3,7 +3,7 @@
   description: translated_attribute(survey.description),
 }) %>
 
-<%= render partial: "decidim/shared/feature_announcement" %>
+<%= render partial: "decidim/shared/component_announcement" %>
 
 <div class="row columns">
   <h2 class="section-heading"><%= translated_attribute survey.title %></h2>
@@ -23,8 +23,8 @@
             <% if survey.answered_by?(current_user) %>
               <div class="section">
                 <div class="callout success">
-                  <h5><%= t('.survey_answered.title') %></h5>
-                  <p><%= t('.survey_answered.body') %></p>
+                  <h5><%= t(".survey_answered.title") %></h5>
+                  <p><%= t(".survey_answered.body") %></p>
                 </div>
               </div>
             <% else %>
@@ -32,71 +32,44 @@
                 <%= decidim_form_for(@form, url: answer_survey_path(survey), method: :post, html: { class: "form answer-survey" }) do |form| %>
                   <% @form.answers.each_with_index do |answer, answer_idx| %>
                     <div class="row column">
-                      <% field_id = "survey_#{survey.id}_question_#{answer.question.id}_answer_body" %>
-                      <%= label_tag field_id , "#{answer_idx + 1}. #{translated_attribute(answer.question.body)} #{'*' if answer.question.mandatory?}", class: 'survey-question' %>
-
-                      <% case answer.question.question_type %>
-                        <% when "short_answer" %>
-                          <%= text_field_tag "survey[answers][#{answer_idx}][body][]", answer.body.try(:first), id: field_id, class: "#{'is-invalid-input' unless answer.errors.empty?}" %>
-                        <% when "long_answer" %>
-                          <%= text_area_tag "survey[answers][#{answer_idx}][body][]", answer.body.try(:first), id: field_id, class: "#{'is-invalid-input' unless answer.errors.empty?}", rows: 10 %>
-                        <% when "single_option" %>
-                          <div id="<%= field_id %>_answer_options" class="radio-button-collection">
-                            <% answer.question.answer_options.each_with_index do |answer_option, idx| %>
-                              <%= label_tag "#{field_id}_option_#{idx}" do %>
-                                <%= radio_button_tag "survey[answers][#{answer_idx}][body][]", translated_attribute(answer_option["body"]), answer.body.try(:include?, translated_attribute(answer_option["body"])), id: "#{field_id}_option_#{idx}" %>
-                                <%= translated_attribute(answer_option["body"]) %>
-                              <% end %>
-                            <% end %>
-                          </div>
-                        <% when "multiple_option" %>
-                          <div id="<%= field_id %>_answer_options" class="check-box-collection">
-                            <% answer.question.answer_options.each_with_index do |answer_option, idx| %>
-                              <%= label_tag "#{field_id}_option_#{idx}" do %>
-                                <%= check_box_tag "survey[answers][#{answer_idx}][body][]", translated_attribute(answer_option["body"]), answer.body.try(:include?, translated_attribute(answer_option["body"])), id: "#{field_id}_option_#{idx}" %>
-                                <%= translated_attribute(answer_option["body"]) %>
-                              <% end %>
-                            <% end %>
-                          </div>
-                      <% end %>
-
-                      <%= hidden_field_tag "survey[answers][#{answer_idx}][question_id]", answer.question.id %>
-
-                      <% answer.errors.full_messages.each do |msg| %>
-                        <%= content_tag :small, msg, class: "form-error is-visible" %>
+                      <%= fields_for "survey[answers][#{answer_idx}]", answer do |answer_form| %>
+                        <%= render "answer", answer_form: answer_form, answer: answer, answer_idx: answer_idx %>
                       <% end %>
                     </div>
                   <% end %>
 
-                  <div class="row column">
+                  <div class="row column tos-agreement">
                     <%= form.check_box :tos_agreement, label: t(".tos_agreement"), id: "survey_tos_agreement" %>
-                    <div class="tos-agreement-help-text help-text">
+                    <div class="help-text">
                       <%= decidim_sanitize translated_attribute survey.tos %>
                     </div>
                   </div>
 
                   <div class="button--double form-general-submit">
-                    <%= form.submit t(".submit"), class: "button", data: { confirm: t('.are_you_sure'), disable: true } %>
+                    <%= form.submit t(".submit"), class: "button", data: { confirm: t(".are_you_sure"), disable: true } %>
                   </div>
                 <% end %>
               </div>
             <% end %>
           <% else %>
             <div class="answer-survey">
-              <h5 class="section-heading"><%= t('.answer_survey.title') %></h5>
+              <h5 class="section-heading"><%= t(".answer_survey.title") %></h5>
               <p>
-                <%= t('.answer_survey.anonymous_user_message', sign_in_link: decidim.new_user_session_path, sign_up_link: decidim.new_user_registration_path).html_safe %>
+                <%= t(".answer_survey.anonymous_user_message", sign_in_link: decidim.new_user_session_path, sign_up_link: decidim.new_user_registration_path).html_safe %>
               </p>
             </div>
           <% end %>
         <% else %>
           <div class="section">
             <div class="callout warning">
-              <h5><%= t('.survey_closed.title') %></h5>
-              <p><%= t('.survey_closed.body') %></p>
+              <h5><%= t(".survey_closed.title") %></h5>
+              <p><%= t(".survey_closed.body") %></p>
             </div>
           </div>
         <% end %>
+      </div>
     </div>
   </div>
 </div>
+
+<%= javascript_include_tag "decidim/surveys/surveys" %>