decidim-surveys 0.15.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 456abaa3819f7e7dad7766b90392d85931776ebe67110e7f6ee958f34acc9f9a
-  data.tar.gz: 2482df90ea48a9423a29f29113daa19be48612de0e235e1043979b0b151d9c6a
+  metadata.gz: 802d9b890c4116757f30979e77e8f963b9509b52fa63fd75c39e0000fa5132b9
+  data.tar.gz: 9226d46d3ef0ec8179464f0b6a5bf7614ebefcd8943820dfe882f14762c88de8
 SHA512:
-  metadata.gz: d038df597b9a3abc085a540326a576e450f7d63aabb8c42b473e5f8907777f04d0ba8d1adae251304c59bbe9a2506ee5f0287a96c525d7717c645b407bd0c3a0
-  data.tar.gz: 1c6df4394f9ec9f30da2ec705a5a8c8183a5dcbc1e8f23dd22ff56997936b778703f87809dbb227192ce51e80971b57f3fe25f83a34dff1a76f48b6aa800e216
+  metadata.gz: a779af11e0c17451457aa074ea390a5e53ea2662acbf5564c8691581712659ead5f99ff9a81f745fe188bf63164a768a77d52963bafe9cd1f1b29aee0f46bdde
+  data.tar.gz: b818cdf9d3359489f10df016707eaf9859d283f67cec4b2449e1fb8a680110ffafeae9476a2ce392f7650de976fd7ab0381bb270fc35ad42e322d70a77c7df06

data/README.md

@@ -1,6 +1,12 @@
 # Decidim::Surveys
 
-The Surveys module adds one of the main components 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.
+The Surveys module adds one new component to Decidim: defining and answering surveys.
+
+The main features are:
+
+* Admins can define a Survey.
+* Users can participate on these surveys by answering from the public page.
+* Admins can download the answers by CSV.
 
 ## Usage
 
@@ -8,17 +14,17 @@ Surveys will be available as a Component for a Participatory Process.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+This is on the default Decidim installation so you shouldn't change anything to use this component.
+
+## Screenshots
+
+![Add survey](docs/screenshot01.png)
 
-```ruby
-gem 'decidim-surveys'
-```
+![Use survey](docs/screenshot02.png)
 
-And then execute:
+## Documentation
 
-```bash
-bundle
-```
+Read more about this component on [Admin Manual](https://docs.decidim.org/admin-manual/en/processess/#surveys).
 
 ## Contributing
 

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

@@ -1,4 +1,4 @@
-form.answer-survey{
+form.answer-questionnaire{
   .radio-button-collection,
   .check-box-collection,
   .sortable-check-box-collection{
@@ -13,7 +13,7 @@ form.answer-survey{
     }
   }
 
-  label.survey-question{
+  label.questionnaire-question{
     font-weight: bold;
   }
 

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

@@ -10,7 +10,7 @@ module Decidim
       end
 
       def call
-        @survey = Survey.new(component: @component)
+        @survey = Survey.new(component: @component, questionnaire: Decidim::Forms::Questionnaire.new)
 
         @survey.save ? broadcast(:ok) : broadcast(:invalid)
       end

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

@@ -5,52 +5,21 @@ module Decidim
     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
+        include Decidim::Forms::Admin::Concerns::HasQuestionnaire
 
-        def edit
-          enforce_permission_to :update, :survey, survey: survey
-
-          @form = form(Admin::SurveyForm).from_model(survey)
+        def questionnaire_for
+          survey
         end
 
-        def update
-          enforce_permission_to :update, :survey, survey: 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
+        private
 
-            on(:invalid) do
-              flash.now[:alert] = I18n.t("surveys.update.invalid", scope: "decidim.surveys.admin")
-              render action: "edit"
-            end
-          end
+        def i18n_flashes_scope
+          "decidim.surveys.admin.surveys"
         end
 
-        private
-
         def survey
           @survey ||= Survey.find_by(component: current_component)
         end
-
-        def blank_question
-          @blank_question ||= Admin::SurveyQuestionForm.new
-        end
-
-        def blank_answer_option
-          @blank_answer_option ||= Admin::SurveyAnswerOptionForm.new
-        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

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

@@ -4,36 +4,22 @@ module Decidim
   module Surveys
     # Exposes the survey resource so users can view and answer them.
     class SurveysController < Decidim::Surveys::ApplicationController
-      include FormFactory
+      include Decidim::Forms::Concerns::HasQuestionnaire
 
-      helper_method :survey
+      delegate :allow_answers?, to: :current_settings
 
-      def show
-        @form = form(SurveyForm).from_model(survey)
+      def questionnaire_for
+        survey
       end
 
-      def answer
-        enforce_permission_to :answer, :survey
-
-        @form = form(SurveyForm).from_params(params)
-
-        AnswerSurvey.call(@form, current_user, survey) do
-          on(:ok) do
-            flash[:notice] = I18n.t("surveys.answer.success", scope: "decidim.surveys")
-            redirect_to survey_path(survey)
-          end
+      private
 
-          on(:invalid) do
-            flash.now[:alert] = I18n.t("surveys.answer.invalid", scope: "decidim.surveys")
-            render action: "show"
-          end
-        end
+      def i18n_flashes_scope
+        "decidim.surveys.surveys"
       end
 
-      private
-
       def survey
-        @survey ||= Survey.includes(questions: :answer_options).find_by(component: current_component)
+        @survey ||= Survey.find_by(component: current_component)
       end
     end
   end

data/app/jobs/decidim/surveys/settings_change_job.rb

@@ -16,11 +16,12 @@ module Decidim
           event_class = Decidim::Surveys::ClosedSurveyEvent
         end
 
+        return unless event && event_class
         Decidim::EventsManager.publish(
           event: event,
           event_class: event_class,
           resource: component,
-          recipient_ids: component.participatory_space.followers.pluck(:id)
+          followers: component.participatory_space.followers
         )
       end
 
@@ -30,15 +31,17 @@ module Decidim
         current_settings[:allow_answers] == previous_settings[:allow_answers]
       end
 
+      # rubocop:disable Style/DoubleNegation
       def survey_opened?(previous_settings, current_settings)
         current_settings[:allow_answers] == true &&
-          previous_settings[:allow_answers] == false
+          !!previous_settings[:allow_answers] == false
       end
 
       def survey_closed?(previous_settings, current_settings)
-        current_settings[:allow_answers] == false &&
+        !!current_settings[:allow_answers] == false &&
           previous_settings[:allow_answers] == true
       end
+      # rubocop:enable Style/DoubleNegation
     end
   end
 end

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

@@ -4,22 +4,12 @@ module Decidim
   module Surveys
     # The data store for a Survey in the Decidim::Surveys component.
     class Survey < Surveys::ApplicationRecord
+      include Decidim::Forms::HasQuestionnaire
       include Decidim::HasComponent
 
       component_manifest_name "surveys"
 
-      has_many :questions, -> { order(:position) }, class_name: "SurveyQuestion", foreign_key: "decidim_survey_id", dependent: :destroy
-      has_many :answers, class_name: "SurveyAnswer", foreign_key: "decidim_survey_id", dependent: :destroy
-
-      # Public: returns whether the survey questions can be modified or not.
-      def questions_editable?
-        answers.empty?
-      end
-
-      # Public: returns whether the survey is answered by the user or not.
-      def answered_by?(user)
-        answers.where(user: user).count == questions.length
-      end
+      validates :questionnaire, presence: true
     end
   end
 end

data/app/permissions/decidim/surveys/admin/permissions.rb

@@ -9,7 +9,7 @@ module Decidim
 
           return permission_action if permission_action.scope != :admin
 
-          return permission_action if permission_action.subject != :survey
+          return permission_action if permission_action.subject != :questionnaire
 
           case permission_action.action
           when :export_answers, :update

data/app/permissions/decidim/surveys/permissions.rb

@@ -9,7 +9,7 @@ module Decidim
         return Decidim::Surveys::Admin::Permissions.new(user, permission_action, context).permissions if permission_action.scope == :admin
         return permission_action if permission_action.scope != :public
 
-        return permission_action if permission_action.subject != :survey
+        return permission_action if permission_action.subject != :questionnaire
 
         permission_action.allow! if permission_action.action == :answer
 

data/app/queries/decidim/surveys/metrics/answers_metric_manage.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Metrics
+      class AnswersMetricManage < Decidim::MetricManage
+        def metric_name
+          "survey_answers"
+        end
+
+        def save
+          return @registry if @registry
+
+          @registry = []
+          query.each do |key, results|
+            cumulative_value = results[:cumulative]
+            next if cumulative_value.zero?
+            quantity_value = results[:quantity] || 0
+            space_type, space_id, survey_id = key
+            record = Decidim::Metric.find_or_initialize_by(day: @day.to_s, metric_type: @metric_name,
+                                                           organization: @organization, decidim_category_id: nil,
+                                                           participatory_space_type: space_type, participatory_space_id: space_id,
+                                                           related_object_type: Decidim::Surveys::Survey.name, related_object_id: survey_id)
+            record.assign_attributes(cumulative: cumulative_value, quantity: quantity_value)
+            @registry << record
+          end
+          @registry.each(&:save!)
+          @registry
+        end
+
+        private
+
+        def query
+          return @query if @query
+
+          @query = retrieve_surveys.each_with_object({}) do |survey, grouped_answers|
+            answers = Decidim::Forms::Answer.joins(:questionnaire)
+                                            .where(questionnaire: retrieve_questionnaires(survey))
+                                            .where("decidim_forms_answers.created_at <= ?", end_time)
+            next grouped_answers unless answers
+
+            group_key = generate_group_key(survey)
+            grouped_answers[group_key] ||= { cumulative: 0, quantity: 0 }
+            grouped_answers[group_key][:cumulative] += answers.count
+            grouped_answers[group_key][:quantity] += answers.where("decidim_forms_answers.created_at >= ?", start_time).count
+          end
+          @query
+        end
+
+        def retrieve_surveys
+          components = Decidim::Component.where(participatory_space: retrieve_participatory_spaces).published
+          Decidim::Surveys::Survey.where(component: components)
+        end
+
+        def retrieve_questionnaires(survey)
+          Decidim::Forms::Questionnaire.includes(:questionnaire_for)
+                                       .where(questionnaire_for: survey)
+        end
+
+        def generate_group_key(survey)
+          participatory_space = survey.participatory_space
+          group_key = []
+          group_key += [participatory_space.class.name, participatory_space.id]
+          group_key += [survey.id]
+          group_key
+        end
+      end
+    end
+  end
+end

data/app/queries/decidim/surveys/metrics/survey_participants_metric_measure.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Metrics
+      # Searches for Participants in the following actions
+      #  - Answer a survey (Surveys)
+      class SurveyParticipantsMetricMeasure < Decidim::MetricMeasure
+        def valid?
+          super && @resource.is_a?(Decidim::Component)
+        end
+
+        def calculate
+          surveys = Decidim::Surveys::Survey.joins(:component, :questionnaire).where(component: @resource)
+          questionnaires = Decidim::Forms::Questionnaire.includes(:questionnaire_for)
+                                                        .where(questionnaire_for_type: Decidim::Surveys::Survey.name, questionnaire_for_id: surveys.pluck(:id))
+
+          answers = Decidim::Forms::Answer.joins(:questionnaire)
+                                          .where(questionnaire: questionnaires)
+                                          .where("decidim_forms_answers.created_at <= ?", end_time)
+
+          {
+            cumulative_users: answers.pluck(:decidim_user_id).uniq,
+            quantity_users: answers.where("decidim_forms_answers.created_at >= ?", start_time).pluck(:decidim_user_id).uniq
+          }
+        end
+      end
+    end
+  end
+end

data/config/locales/ca.yml

@@ -1,19 +1,5 @@
 ca:
   activemodel:
-    attributes:
-      survey_answer:
-        body: Resposta
-      survey_question:
-        mandatory: Obligatori
-        max_choices: Nombre màxim d'opcions
-        question_type: Tipus
-    errors:
-      models:
-        survey_answer:
-          attributes:
-            choices:
-              missing: no estan complets
-              too_many: són massa
     models:
       decidim/surveys/closed_survey_event: S'ha acabat l'enquesta
       decidim/surveys/opened_survey_event: S'ha iniciat l'enquesta
@@ -49,69 +35,22 @@ ca:
           email_outro: Has rebut aquesta notificació perquè estàs seguint %{participatory_space_title}. Pots deixar de rebre notificacions seguint l'enllaç anterior.
           email_subject: Una nova enquesta a %{participatory_space_title}
           notification_title: L'enquesta <a href="%{resource_path}">%{resource_title}</a> en <a href="%{participatory_space_url}">%{participatory_space_title}</a> ja està oberta.
-    forms:
-      errors:
-        survey_answer:
-          body: El cos no pot estar en blanc
+    metrics:
+      survey_answers:
+        description: Nombre d'enquestes contestades pels usuaris
+        object: respostes a enquestes
+        title: Respostes a enquestes
     surveys:
       admin:
         exports:
           survey_user_answers: Respostes dels usuaris
-        models:
-          components:
-            description: Descripció
-            tos: Termes del servei
         surveys:
-          answer_option:
-            answer_option: Opció de resposta
-            free_text: Text lliure
-            remove: Eliminar
-            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
-            any: Qualsevol
-            description: Descripció
-            down: Avall
-            question: Pregunta
-            remove: Elimina
-            statement: Enunciat
-            up: Pujar
           update:
             invalid: Hi ha hagut errors en desar l'enquesta.
             success: Enquesta desada correctament.
       last_activity:
         new_survey_at_html: "<span>Nova enquesta a %{link}</span>"
-      question_types:
-        long_answer: Resposta llarga
-        multiple_option: Opció múltiple
-        short_answer: Resposta curta
-        single_option: Única opció
-        sorting: Ordenació
       surveys:
         answer:
           invalid: Hi ha hagut errors en respondre a l'enquesta.
           success: Enquesta resposta correctament.
-        question:
-          max_choices: 'Opcions màximes: %{n}'
-        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. Segur que vols seguir?
-          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
-          survey_for_private_users:
-            body: L'enquesta només està disponible per a usuaris privats
-            title: Enquesta tancada
-          tos_agreement: En participar en aquesta enquesta acceptes els Termes de Servei