decidim 0.2.0 → 0.3.0

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # The data store for a SurveyAnswer in the Decidim::Surveys component.
+    class SurveyAnswer < Surveys::ApplicationRecord
+      belongs_to :user, class_name: "Decidim::User", foreign_key: "decidim_user_id"
+      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? }
+      validate :user_survey_same_organization
+      validate :question_belongs_to_survey
+
+      private
+
+      def user_survey_same_organization
+        return if user&.organization == survey&.organization
+        errors.add(:user, :invalid)
+      end
+
+      def question_belongs_to_survey
+        errors.add(:survey, :invalid) if question&.survey != survey
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+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
+
+      belongs_to :survey, class_name: "Survey", foreign_key: "decidim_survey_id"
+
+      # 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) }
+      end
+    end
+  end
+end

data/decidim-surveys/app/queries/decidim/surveys/survey_user_answers.rb

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

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

@@ -0,0 +1,23 @@
+<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>
+    <% end %>
+    </h2>
+  </div>
+
+  <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?
+        }
+      %>
+    </div>
+  </div>
+</div>

data/decidim-surveys/app/views/decidim/surveys/admin/surveys/_form.html.erb

@@ -0,0 +1,47 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title">
+      <%= title %>
+      <div class="button--title">
+        <%= export_dropdown %>
+      </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.surveys.admin")  %>
+    </div>
+    <div class="row column">
+      <%= 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>
+  <% else %>
+    <div class="callout warning">
+      <%= t('.already_answered_warning') %>
+    </div>
+  <% end %>
+
+  <div class="survey-questions-list">
+    <% @form.questions.each_with_index do |question, idx| %>
+      <%= render "question", question: question %>
+    <% end %>
+  </div>
+</div>
+
+<%= javascript_include_tag "decidim/surveys/admin/surveys" %>

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

@@ -0,0 +1,57 @@
+<div class="card survey-question" id="survey-question-<%= question.id %>-field">
+  <div class="card-divider question-divider">
+    <h2 class="card-title">
+    <span><%= label_for_question(survey, question) %></span>
+    <% if survey.questions_editable? %>
+      <button class="button small alert hollow remove-question button--title"><%= t('.remove_question') %></button>
+    <% end %>
+    </h2>
+  </div>
+
+  <div class="card-section">
+    <div class="row column">
+      <%=
+        translated_field_tag :text_field_tag, "survey[questions][]", "body", question.body, {
+          tabs_id: tabs_id_for_question(question),
+          label: t('.statement'),
+          disabled: disabled_for_question(survey, question),
+          enable_tabs: question.persisted?
+        }
+      %>
+    </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)
+        }
+      %>
+      <%= 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) %>
+    </div>
+
+    <% if question.persisted? %>
+      <%= hidden_field_tag "survey[questions][][id]", question.id, disabled: disabled_for_question(survey, question) %>
+    <% 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) %>
+
+    <div class="survey-question-answer-options">
+      <% if survey.questions_editable? %>
+        <button class="button add-answer-option"><%= t('.add_answer_option') %></button>
+      <% end %>
+
+      <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 %>
+        <% end %>
+      </div>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,7 @@
+<%= 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') }  %>
+
+  <div class="button--double form-general-submit">
+    <%= form.submit t(".save"), class: "button" %>
+  </div>
+<% end %>

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

@@ -0,0 +1,102 @@
+<% add_decidim_meta_tags({
+  title: translated_attribute(survey.title),
+  description: translated_attribute(survey.description),
+}) %>
+
+<div class="row columns">
+  <h2 class="section-heading"><%= translated_attribute survey.title %></h2>
+  <div class="row">
+    <div class="columns large-6 medium-centered lead">
+      <%== translated_attribute survey.description %>
+    </div>
+  </div>
+</div>
+
+<div class="row">
+  <div class="columns large-6 medium-centered">
+    <div class="card">
+      <div class="card__content">
+        <% if current_settings.allow_answers? %>
+          <% if current_user %>
+            <% 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>
+                </div>
+              </div>
+            <% else %>
+              <div class="answer-survey">
+                <%= 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?}" %>
+
+                      <% 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" %>
+                      <% end %>
+                    </div>
+                  <% end %>
+
+                  <% if translated_attribute(survey.tos).present? %>
+                    <div class="row column">
+                      <%= form.check_box :tos_agreement, label: t(".tos_agreement"), id: "survey_tos_agreement" %>
+                      <div class="tos-agreement-help-text help-text">
+                        <%== translated_attribute survey.tos %>
+                      </div>
+                    </div>
+                  <% end %>
+
+                  <div class="button--double form-general-submit">
+                    <%= form.submit t(".submit"), class: "button", data: { confirm: t('.are_you_sure') } %>
+                  </div>
+                <% end %>
+              </div>
+            <% end %>
+          <% else %>
+            <div class="answer-survey">
+              <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 %>
+              </p>
+            </div>
+          <% end %>
+        <% else %>
+          <div class="section">
+            <div class="callout warning">
+              <h5><%= t('.survey_closed.title') %></h5>
+              <p><%= t('.survey_closed.body') %></p>
+            </div>
+          </div>
+        <% end %>
+    </div>
+  </div>
+</div>

data/decidim-surveys/bin/rails

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/decidim/surveys/engine", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

data/decidim-surveys/config/i18n-tasks.yml

@@ -0,0 +1,11 @@
+base_locale: en
+locales: [en]
+ignore_unused:
+- "decidim.features.surveys.name"
+- "decidim.features.surveys.actions.*"
+- "decidim.features.surveys.settings.*"
+- "decidim.surveys.admin.surveys.question.question"
+- "decidim.surveys.admin.exports.*"
+- "activemodel.attributes.survey_answer.*"
+ignore_missing:
+  - decidim.participatory_processes.scopes.global

data/decidim-surveys/config/locales/ca.yml

@@ -0,0 +1,69 @@
+ca:
+  activemodel:
+    attributes:
+      survey_answer:
+        body: Resposta
+      survey_question:
+        mandatory: Obligatori
+        question_type: Tipus
+  decidim:
+    features:
+      surveys:
+        actions:
+          answer: Resposta
+        name: Enquesta
+        settings:
+          step:
+            allow_answers: Permetre respostes
+    surveys:
+      admin:
+        application_helper:
+          label_for_question:
+            question: Pregunta
+        exports:
+          survey_user_answers: Respostes dels usuaris
+        models:
+          components:
+            description: Descripció
+            tos: Termes del servei
+        surveys:
+          answer_option:
+            answer_option: Opció de resposta
+            remove_answer_option: Elimina l'opció de resposta
+            statement: Enunciat
+          edit:
+            save: Desar
+            title: Títol
+          form:
+            add_question: Afegir pregunta
+            already_answered_warning: L'enquesta ja està contestada per alguns usuaris i per tant no pots modificar les seves preguntes.
+          question:
+            add_answer_option: Afegir opció de resposta
+            question: Pregunta
+            remove_question: Elimina pregunta
+            statement: Enunciat
+          update:
+            invalid: Hi ha hagut errors en desar l'enquesta.
+            success: Enquesta desada correctament.
+      question_types:
+        long_answer: Resposta llarga
+        multiple_option: Opció múltiple
+        short_answer: Resposta curta
+        single_option: Única opció
+      surveys:
+        answer:
+          invalid: Hi ha hagut errors en respondre a l'enquesta.
+          success: Enquesta resposta correctament.
+        show:
+          answer_survey:
+            anonymous_user_message: <a href="%{sign_in_link}">Entra amb el teu compte</a> o <a href="%{sign_up_link}">dona't d'alta</a> per contestar l'enquesta.
+            title: Respon a l'enquesta
+          are_you_sure: Aquesta acció no es pot desfer i no podràs editar les respostes. N'estàs segur?
+          submit: Enviar
+          survey_answered:
+            body: Ja ha respost a aquesta enquesta.
+            title: Enquesta resposta
+          survey_closed:
+            body: L'enquesta està tancada i no s'hi pot participar.
+            title: Enquesta tancada
+          tos_agreement: En participar en aquesta enquesta acceptes els Termes de Servei

data/decidim-surveys/config/locales/en.yml

@@ -0,0 +1,73 @@
+---
+en:
+  activemodel:
+    attributes:
+      survey_answer:
+        body: Answer
+      survey_question:
+        mandatory: Mandatory
+        question_type: Type
+  decidim:
+    features:
+      surveys:
+        actions:
+          answer: Answer
+        name: Survey
+        settings:
+          step:
+            allow_answers: Allow answers
+    surveys:
+      admin:
+        application_helper:
+          label_for_question:
+            question: Question
+        exports:
+          survey_user_answers: Survey user answers
+        models:
+          components:
+            description: Description
+            tos: Terms of service
+        surveys:
+          answer_option:
+            answer_option: Answer option
+            remove_answer_option: Remove answer option
+            statement: Statement
+          edit:
+            save: Save
+            title: Title
+          form:
+            add_question: Add question
+            already_answered_warning: The survey is already answered by some users
+              so you cannot modify its questions.
+          question:
+            add_answer_option: Add answer option
+            question: Question
+            remove_question: Remove question
+            statement: Statement
+          update:
+            invalid: There's been errors when saving the survey.
+            success: Survey saved successfully.
+      question_types:
+        long_answer: Long answer
+        multiple_option: Multiple option
+        short_answer: Short answer
+        single_option: Single option
+      surveys:
+        answer:
+          invalid: There's been errors when answering the survey.
+          success: Survey answered successfully.
+        show:
+          answer_survey:
+            anonymous_user_message: <a href="%{sign_in_link}">Sign in with your account</a>
+              or <a href="%{sign_up_link}">sign up</a> to answer the survey.
+            title: Answer the survey
+          are_you_sure: This action cannot be undone and you will not be able to edit
+            your answers. Are you sure?
+          submit: Submit
+          survey_answered:
+            body: You have already answered this survey.
+            title: Survey answered
+          survey_closed:
+            body: The survey is closed and cannot be answered.
+            title: Survey closed
+          tos_agreement: By participating in this survey you accept its Terms of Service