decidim-surveys 0.19.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5bf3b75387df3baa5f23a051b8c6c3141e4de0b50a318b598ddf921bc16c68e
-  data.tar.gz: a49fcdd21d45cbcd42c0a8b87a97fd44e6c4ab0f5fe862ff68520fc569fd6715
+  metadata.gz: 438c473b61d9bc07cad2c8e3ce3c6c56f900ae0a4aaade52db7dffbcb1e4a433
+  data.tar.gz: 182793a9e4e0fee42249e40ec2862f4a756344656f5010c055167c0477240559
 SHA512:
-  metadata.gz: 58e2ec2f61f751056ec1f0f4337a3dfe10bef9916f9c8f13c309fde6b95b3b15e3bdf9db116138ce651bb67ccda829af2bc43ea27e4d585500d706b415590396
-  data.tar.gz: 1734f209975336d6af102216a05554eb857154b2825974a67498f50c7e0373d82e5011c7b6cfcd93507fb3ecf4204ae55ff273d0d9b3ab3ff2096b009f8473af
+  metadata.gz: fd718b0903ddd737e42ea62e71039e4fdc34bf7c5cc13444f8b1f4353a5d197dd0b95cbd20434d1c52cbefe6c74d82ed64fb590732fddbe6f1f1a17ea5df685d
+  data.tar.gz: 92a9f208813e602e656b27f7549da9aafbfb88da073f2d2280d5eddde519fd0756a95223f5860cdbb4f3c207406a0420e4e0dbac8a19f6b5ae32129485dab7c0

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

@@ -1,6 +1,10 @@
 @import "decidim/forms/forms";
 
-form.answer-questionnaire{
+.answer-questionnaire{
+  label{
+    font-size: inherit;
+  }
+
   .radio-button-collection,
   .check-box-collection,
   .sortable-check-box-collection{
@@ -15,8 +19,10 @@ form.answer-questionnaire{
     }
   }
 
-  label.questionnaire-question{
-    font-weight: bold;
+  .questionnaire-question{
+    font-weight: 600;
+    line-height: 1.4;
+    margin-bottom: .3em;
   }
 
   .help-text{
@@ -30,4 +36,15 @@ form.answer-questionnaire{
   .last-sorted{
     margin-bottom: 1rem;
   }
+
+  &__steps{
+    font-size: .8rem;
+  }
+
+  &__submit{
+    display: flex;
+    align-items: baseline;
+    justify-content: space-between;
+    margin-top: 2rem;
+  }
 }

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

@@ -6,11 +6,22 @@ module Decidim
       # This controller allows the user to update a Page.
       class SurveysController < Admin::ApplicationController
         include Decidim::Forms::Admin::Concerns::HasQuestionnaire
+        include Decidim::Forms::Admin::Concerns::HasQuestionnaireAnswers
 
         def questionnaire_for
           survey
         end
 
+        # Specify the public url from which the survey can be viewed and answered
+        def public_url
+          Decidim::EngineRouter.main_proxy(current_component).survey_path(survey)
+        end
+
+        # Specify where to redirect after exporting a user response
+        def questionnaire_participant_answers_url(session_token)
+          Decidim::EngineRouter.admin_proxy(survey.component).show_survey_path(session_token: session_token)
+        end
+
         private
 
         def i18n_flashes_scope

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

@@ -5,9 +5,10 @@ module Decidim
     # Exposes the survey resource so users can view and answer them.
     class SurveysController < Decidim::Surveys::ApplicationController
       include Decidim::Forms::Concerns::HasQuestionnaire
+      include Decidim::ComponentPathHelper
       helper Decidim::Surveys::SurveyHelper
 
-      delegate :allow_answers?, to: :current_settings
+      delegate :allow_unregistered?, to: :current_settings
 
       before_action :check_permissions
 
@@ -19,6 +20,16 @@ module Decidim
         survey
       end
 
+      protected
+
+      def allow_answers?
+        !current_component.published? || current_settings.allow_answers?
+      end
+
+      def form_path
+        main_component_path(current_component)
+      end
+
       private
 
       def i18n_flashes_scope

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    class CleanSurveyAnswersJob < ApplicationJob
+      def perform(_event_name, data)
+        @component = data[:resource]
+        return unless component&.manifest_name == "surveys"
+
+        @survey = Survey.find_by(component: component)
+        return unless survey&.questionnaire
+
+        case data[:event_class]
+        when "Decidim::ComponentPublishedEvent"
+          clean_answers
+        end
+      end
+
+      private
+
+      attr_reader :survey, :component
+
+      def clean_answers
+        return unless survey.clean_after_publish?
+
+        survey.questionnaire.answers.destroy_all
+        component.settings[:clean_after_publish] = false
+        component.save
+      end
+    end
+  end
+end

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

@@ -42,6 +42,10 @@ module Decidim
         !!current_settings[:allow_answers] == false &&
           previous_settings[:allow_answers] == true
       end
+
+      def clean_after_publish_changed?(previous_settings, current_settings)
+        current_settings[:clean_after_publish] != previous_settings[:clean_after_publish]
+      end
       # rubocop:enable Style/DoubleNegation
     end
   end

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

@@ -11,6 +11,10 @@ module Decidim
       component_manifest_name "surveys"
 
       validates :questionnaire, presence: true
+
+      def clean_after_publish?
+        component.settings.clean_after_publish?
+      end
     end
   end
 end

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

@@ -7,13 +7,19 @@ module Decidim
         def permissions
           return permission_action unless user
 
-          return permission_action if permission_action.scope != :admin
+          return permission_action unless permission_action.scope == :admin
 
-          return permission_action if permission_action.subject != :questionnaire
-
-          case permission_action.action
-          when :export_answers, :update
-            permission_action.allow!
+          case permission_action.subject
+          when :questionnaire
+            case permission_action.action
+            when :export_answers, :update
+              permission_action.allow!
+            end
+          when :questionnaire_answers
+            case permission_action.action
+            when :index, :show, :export_response
+              permission_action.allow!
+            end
           end
 
           permission_action

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

@@ -4,7 +4,7 @@ module Decidim
   module Surveys
     class Permissions < Decidim::DefaultPermissions
       def permissions
-        return permission_action unless user
+        return permission_action unless user || context[:current_settings].allow_unregistered?
 
         return Decidim::Surveys::Admin::Permissions.new(user, permission_action, context).permissions if permission_action.scope == :admin
         return permission_action if permission_action.scope != :public

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

@@ -9,9 +9,6 @@ module Decidim
         end
 
         def save
-          return @registry if @registry
-
-          @registry = []
           query.each do |key, results|
             cumulative_value = results[:cumulative]
             next if cumulative_value.zero?
@@ -23,10 +20,8 @@ module Decidim
                                                            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
+            record.save!
           end
-          @registry.each(&:save!)
-          @registry
         end
 
         private
@@ -49,8 +44,7 @@ module Decidim
         end
 
         def retrieve_surveys
-          components = Decidim::Component.where(participatory_space: retrieve_participatory_spaces).published
-          Decidim::Surveys::Survey.where(component: components)
+          Decidim::Surveys::Survey.where(component: visible_component_ids_from_spaces(retrieve_participatory_spaces))
         end
 
         def retrieve_questionnaires(survey)

data/app/serializers/decidim/surveys/data_importer.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # Importer for Surveys specific data (this is, its questionnaire).
+    class DataImporter < Decidim::Importers::Importer
+      def initialize(component)
+        @component = component
+      end
+
+      # Public: Creates a new Decidim::Surveys::Survey and Decidim::Forms::Questionnaire associated to the given +component+
+      #         for each serialized survey object.
+      # It imports the whole tree of Survey->Questionnaire->questions->answer_options.
+      #
+      # serialized        - The Hash of attributes for the Questionnaire and its relations.
+      # user              - The +user+ that is performing this action
+      #
+      # Returns the ser.
+      def import(serialized, user)
+        ActiveRecord::Base.transaction do
+          # we duplicate so that we can delete without affecting the received Hash
+          serialized.dup.collect do |serialized_survey|
+            import_survey(serialized_survey, user)
+          end
+        end
+      end
+
+      private
+
+      # Returns a persisted Survey instance build from +serialized_survey+.
+      def import_survey(serialized_survey, user)
+        serialized_survey = serialized_survey.with_indifferent_access
+        survey = build_survey(serialized_survey)
+        serialized_questionnaire = serialized_survey[:questionnaire]
+        serialized_questions = serialized_questionnaire.delete(:questions)
+
+        questionnaire = build_questionnaire(survey, serialized_questionnaire)
+        Decidim.traceability.perform_action!(:create, Decidim::Surveys::Survey, user) do
+          survey.save!
+          survey
+        end
+        import_questions(questionnaire, serialized_questions)
+        survey
+      end
+
+      def build_survey(_serialized)
+        Survey.new(component: @component)
+      end
+
+      # Builds a Decidim::Forms::Questionnaire with all its questions and answer_options.
+      def build_questionnaire(survey, serialized_questionnaire)
+        survey.build_questionnaire(serialized_questionnaire.except(:id, :published_at))
+      end
+
+      def import_questions(questionnaire, serialized_questions)
+        serialized_questions.each do |serialized_question|
+          serialized_answer_options = serialized_question.delete(:answer_options)
+          question = questionnaire.questions.create!(serialized_question.except(:id, :created_at, :updated_at))
+          serialized_answer_options.each do |serialized_answer_option|
+            question.answer_options.create!(serialized_answer_option.except(:id, :created_at, :updated_at))
+          end
+        end
+      end
+    end
+  end
+end

data/app/serializers/decidim/surveys/data_serializer.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This class serializes the specific data in each Survey.
+    # This is `Questionnaire->questions->answer_options` but not `answers`
+    # and `answer_choices`.
+    class DataSerializer < Decidim::Exporters::Serializer
+      # Returns: Array of Decidim::Forms::Questionnaire as a json hash,
+      #     or nil if none exists.
+      def serialize
+        component = resource
+        surveys = Decidim::Surveys::Survey.where(component: component)
+        surveys.collect do |survey|
+          next if survey.questionnaire.nil?
+
+          json = serialize_survey(survey)
+          json.with_indifferent_access.merge(survey_id: survey.id)
+        end
+      end
+
+      def serialize_survey(survey)
+        questionnaire = survey.questionnaire
+        questionnaire_json = questionnaire.attributes.as_json
+        questionnaire_json[:questions] = serialize_questions(questionnaire.questions.order(:position))
+        json = survey.attributes.as_json
+        json[:questionnaire] = questionnaire_json
+        json
+      end
+
+      def serialize_questions(questions)
+        questions.collect do |question|
+          json = question.attributes.as_json
+          json[:answer_options] = serialize_answer_options(question.answer_options)
+          json
+        end
+      end
+
+      def serialize_answer_options(answer_options)
+        answer_options.collect do |option|
+          option.attributes.as_json
+        end
+      end
+    end
+  end
+end

data/app/types/decidim/surveys/survey_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    SurveyType = GraphQL::ObjectType.define do
+      name "Survey"
+      description "A survey"
+
+      field :id, !types.ID, "The internal ID for this survey"
+      field :createdAt, Decidim::Core::DateTimeType, "The time this survey was created", property: :created_at
+      field :updatedAt, Decidim::Core::DateTimeType, "The time this survey was updated", property: :updated_at
+      field :questionnaire, Decidim::Forms::QuestionnaireType, "The questionnaire for this survey"
+    end
+  end
+end

data/app/types/decidim/surveys/surveys_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    SurveysType = GraphQL::ObjectType.define do
+      interfaces [-> { Decidim::Core::ComponentInterface }]
+
+      name "Surveys"
+      description "A surveys component of a participatory space."
+
+      connection :surveys, SurveyType.connection_type do
+        resolve ->(component, _args, _ctx) {
+                  SurveysTypeHelper.base_scope(component).includes(:component)
+                }
+      end
+
+      field(:survey, SurveyType) do
+        argument :id, !types.ID
+
+        resolve ->(component, args, _ctx) {
+          SurveysTypeHelper.base_scope(component).find_by(id: args[:id])
+        }
+      end
+    end
+
+    module SurveysTypeHelper
+      def self.base_scope(component)
+        Survey.where(component: component)
+      end
+    end
+  end
+end

data/config/locales/am-ET.yml

@@ -0,0 +1 @@
+am:

data/config/locales/ar.yml

@@ -30,6 +30,7 @@ ar:
             announcement: إعلان
           step:
             allow_answers: السماح بالإجابات
+            allow_unregistered: السماح للمستخدمين غير المسجَّلِين بالإجابة على استطلاع الرأي
             announcement: إعلان
     events:
       surveys:

data/config/locales/bg-BG.yml

@@ -0,0 +1,10 @@
+bg:
+  activemodel:
+    models:
+      decidim/surveys/closed_survey_event: Анкетата завърши
+      decidim/surveys/opened_survey_event: Анкетата започна
+  activerecord:
+    models:
+      decidim/surveys/survey:
+        one: Анкета
+        other: Анкети

data/config/locales/bg.yml

@@ -0,0 +1,10 @@
+bg:
+  activemodel:
+    models:
+      decidim/surveys/closed_survey_event: Анкетата завърши
+      decidim/surveys/opened_survey_event: Анкетата започна
+  activerecord:
+    models:
+      decidim/surveys/survey:
+        one: Анкета
+        other: Анкети

data/config/locales/ca.yml

@@ -20,8 +20,13 @@ ca:
         settings:
           global:
             announcement: Avís
+            clean_after_publish: Esborrar les respostes en publicar l'enquesta
+            scope_id: Àmbit
+            scopes_enabled: Àmbits habilitats
           step:
             allow_answers: Permetre respostes
+            allow_unregistered: Permet a usuàries no registrades contestar l'enquesta
+            allow_unregistered_help: Si s'activa, no caldrà iniciar sessió per a contestar l'enquesta. Això pot comportar que les dades siguin poc fiables i serà més vulnerable a atacs automatitzats. Feu-ho servir amb cura!
             announcement: Avís
     events:
       surveys:
@@ -53,4 +58,5 @@ ca:
       surveys:
         answer:
           invalid: S'ha produït un error en respondre l'enquesta.
+          spam_detected: Hi ha hagut un problema contestant el formulari. Potser has estat massa ràpid, ho pots tornar a intentar?
           success: Enquesta resposta correctament.