decidim-surveys 0.29.1 → 0.30.0.rc1

data/config/locales/zh-CN.yml

@@ -15,16 +15,10 @@ zh-CN:
       surveys:
         actions:
           answer: 答案
-        name: 调查
         settings:
           global:
             announcement: 通 知
-            clean_after_publish: 在发布调查时删除答案
-            scope_id: 范围
-            scopes_enabled: 范围已启用
           step:
-            allow_answers: 允许答案
-            allow_unregistered: 允许未注册用户回答调查
             announcement: 通 知
     events:
       surveys:

data/config/locales/zh-TW.yml

@@ -15,21 +15,10 @@ zh-TW:
       surveys:
         actions:
           answer: 回答
-        name: 調查
         settings:
           global:
             announcement: 公告
-            clean_after_publish: 當發佈調查問卷時刪除回答
-            ends_at: 接受回答直到
-            ends_at_help: 不指定日期則留空
-            scope_id: 範圍
-            scopes_enabled: 啟用的範圍
-            starts_at: 回答接受開始日期
-            starts_at_help: 不指定日期請留空
           step:
-            allow_answers: 允許回答
-            allow_unregistered: 允許未註冊的使用者回答問卷
-            allow_unregistered_help: 若啟用此功能，回答問卷時將無需登錄。這可能導致資料品質不佳或不可靠，並增加遭受自動攻擊的風險。請謹慎使用！請注意，參與者可以使用不同的瀏覽器或「私人瀏覽」功能多次回答同一份問卷。
             announcement: 公告
     events:
       surveys:

data/db/migrate/20240828103030_add_deleted_at_to_decidim_surveys_surveys.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddDeletedAtToDecidimSurveysSurveys < ActiveRecord::Migration[7.0]
+  def change
+    add_column :decidim_surveys_surveys, :deleted_at, :datetime
+    add_index :decidim_surveys_surveys, :deleted_at
+  end
+end

data/db/migrate/20240925124312_add_settings_to_decidim_surveys_surveys.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class AddSettingsToDecidimSurveysSurveys < ActiveRecord::Migration[7.0]
+  class Survey < ApplicationRecord
+    include Decidim::HasComponent
+
+    self.table_name = :decidim_surveys_surveys
+  end
+
+  def change
+    reversible do |dir|
+      dir.up do
+        add_column :decidim_surveys_surveys, :starts_at, :datetime
+        add_column :decidim_surveys_surveys, :ends_at, :datetime
+        add_column :decidim_surveys_surveys, :announcement, :jsonb
+        add_column :decidim_surveys_surveys, :allow_answers, :boolean
+        add_column :decidim_surveys_surveys, :allow_unregistered, :boolean
+        add_column :decidim_surveys_surveys, :clean_after_publish, :boolean
+        add_column :decidim_surveys_surveys, :published_at, :datetime
+        add_index :decidim_surveys_surveys, :published_at
+
+        Survey.where(published_at: nil).find_each do |survey|
+          published_at = survey.component&.published_at
+          next if published_at.nil?
+
+          survey.update(published_at:)
+        end
+      end
+
+      dir.down do
+        remove_index :decidim_surveys_surveys, :published_at
+        remove_column :decidim_surveys_surveys, :starts_at
+        remove_column :decidim_surveys_surveys, :ends_at
+        remove_column :decidim_surveys_surveys, :announcement
+        remove_column :decidim_surveys_surveys, :allow_answers
+        remove_column :decidim_surveys_surveys, :allow_unregistered
+        remove_column :decidim_surveys_surveys, :clean_after_publish
+        remove_column :decidim_surveys_surveys, :published_at
+      end
+    end
+  end
+end

data/db/migrate/20250115193836_add_allow_survey_editing.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddAllowSurveyEditing < ActiveRecord::Migration[7.0]
+  def up
+    add_column :decidim_surveys_surveys, :allow_editing_answers, :boolean
+  end
+end

data/decidim-surveys.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.version = Decidim::Surveys.version
   s.authors = ["Josep Jaume Rey Peroy", "Marc Riera Casals", "Oriol Gual Oliva"]
   s.email = ["josepjaume@gmail.com", "mrc2407@gmail.com", "oriolgual@gmail.com"]
-  s.license = "AGPL-3.0"
+  s.license = "AGPL-3.0-or-later"
   s.homepage = "https://decidim.org"
   s.metadata = {
     "bug_tracker_uri" => "https://github.com/decidim/decidim/issues",
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
     "homepage_uri" => "https://decidim.org",
     "source_code_uri" => "https://github.com/decidim/decidim"
   }
-  s.required_ruby_version = "~> 3.2.0"
+  s.required_ruby_version = "~> 3.3.0"
 
   s.name = "decidim-surveys"
   s.summary = "Decidim surveys module"

data/lib/decidim/api/survey_type.rb

@@ -3,12 +3,21 @@
 module Decidim
   module Surveys
     class SurveyType < Decidim::Api::Types::BaseObject
+      implements Decidim::Core::TimestampsInterface
+
       description "A survey"
 
       field :id, GraphQL::Types::ID, "The internal ID for this survey", null: false
-      field :created_at, Decidim::Core::DateTimeType, "The time this survey was created", null: true
-      field :updated_at, Decidim::Core::DateTimeType, "The time this survey was updated", null: true
       field :questionnaire, Decidim::Forms::QuestionnaireType, "The questionnaire for this survey", null: true
+
+      def self.authorized?(object, context)
+        context[:survey] = object
+        context[:current_settings] = object.component.current_settings
+
+        super
+      rescue Decidim::PermissionAction::PermissionNotSetError
+        false
+      end
     end
   end
 end

data/lib/decidim/api/surveys_type.rb

@@ -2,22 +2,19 @@
 
 module Decidim
   module Surveys
-    class SurveysType < Decidim::Api::Types::BaseObject
-      implements Decidim::Core::ComponentInterface
-
+    class SurveysType < Decidim::Core::ComponentType
       graphql_name "Surveys"
       description "A surveys component of a participatory space."
 
-      field :surveys, Decidim::Surveys::SurveyType.connection_type, null: true, connection: true
+      field :survey, Decidim::Surveys::SurveyType, "A single Survey object", null: true do
+        argument :id, GraphQL::Types::ID, "The id of the Survey requested", required: true
+      end
+      field :surveys, Decidim::Surveys::SurveyType.connection_type, "A collection of Surveys", null: true, connection: true
 
       def surveys
         Survey.where(component: object).includes(:component)
       end
 
-      field :survey, Decidim::Surveys::SurveyType, null: true do
-        argument :id, GraphQL::Types::ID, required: true
-      end
-
       def survey(**args)
         Survey.where(component: object).find_by(id: args[:id])
       end

data/lib/decidim/surveys/admin_engine.rb

@@ -10,12 +10,22 @@ module Decidim
       paths["lib/tasks"] = nil
 
       routes do
-        get "/answer/:session_token", to: "surveys#show", as: :show_survey
-        get "/answer/:session_token/export", to: "surveys#export_response", as: :export_response_survey
-        get "/answers", to: "surveys#index", as: :index_survey
         get "/answer_options", to: "surveys#answer_options", as: :answer_options_survey
-        put "/", to: "surveys#update", as: :survey
-        root to: "surveys#edit"
+        resources :surveys, except: [:new] do
+          member do
+            get :edit_questions
+            patch :update_questions
+            put :publish
+            put :unpublish
+          end
+          resources :answers, only: [:index, :show] do
+            member do
+              get :export_response
+            end
+          end
+          resources :publish_answers, only: [:index, :update, :destroy]
+        end
+        root to: "surveys#index"
       end
 
       initializer "decidim_surveys_admin.notifications.components" do

data/lib/decidim/surveys/component.rb

@@ -12,18 +12,6 @@ Decidim.register_component(:surveys) do |component|
   component.specific_data_importer_class_name = "Decidim::Surveys::DataImporter"
   component.query_type = "Decidim::Surveys::SurveysType"
 
-  component.on(:copy) do |context|
-    Decidim::Surveys::CreateSurvey.call(context[:new_component]) do
-      on(:invalid) { raise "Cannot create survey" }
-    end
-  end
-
-  component.on(:create) do |instance|
-    Decidim::Surveys::CreateSurvey.call(instance) do
-      on(:invalid) { raise "Cannot create survey" }
-    end
-  end
-
   component.data_portable_entities = ["Decidim::Forms::Answer"]
 
   component.newsletter_participant_entities = ["Decidim::Forms::Answer"]
@@ -37,20 +25,22 @@ Decidim.register_component(:surveys) do |component|
 
   component.register_resource(:survey) do |resource|
     resource.model_class_name = "Decidim::Surveys::Survey"
+    resource.card = "decidim/surveys/survey"
+    resource.actions = %w(answer)
   end
 
-  component.register_stat :surveys_count do |components, start_at, end_at|
+  component.register_stat :surveys_count, primary: true, priority: Decidim::StatsRegistry::HIGH_PRIORITY do |components, start_at, end_at|
     surveys = Decidim::Surveys::Survey.where(component: components)
-    surveys = surveys.where("created_at >= ?", start_at) if start_at.present?
-    surveys = surveys.where("created_at <= ?", end_at) if end_at.present?
+    surveys = surveys.where(created_at: start_at..) if start_at.present?
+    surveys = surveys.where(created_at: ..end_at) if end_at.present?
     surveys.count
   end
 
   component.register_stat :answers_count, primary: true, priority: Decidim::StatsRegistry::MEDIUM_PRIORITY do |components, start_at, end_at|
     surveys = Decidim::Surveys::Survey.includes(:questionnaire).where(component: components)
     answers = Decidim::Forms::Answer.where(questionnaire: surveys.map(&:questionnaire))
-    answers = answers.where("created_at >= ?", start_at) if start_at.present?
-    answers = answers.where("created_at <= ?", end_at) if end_at.present?
+    answers = answers.where(created_at: start_at..) if start_at.present?
+    answers = answers.where(created_at: ..end_at) if end_at.present?
     answers.group(:session_token).count.size
   end
 
@@ -58,17 +48,10 @@ Decidim.register_component(:surveys) do |component|
   component.actions = %w(answer)
 
   component.settings(:global) do |settings|
-    settings.attribute :scopes_enabled, type: :boolean, default: false
-    settings.attribute :scope_id, type: :scope
-    settings.attribute :starts_at, type: :time
-    settings.attribute :ends_at, type: :time
     settings.attribute :announcement, type: :text, translated: true, editor: true
-    settings.attribute :clean_after_publish, type: :boolean, default: true
   end
 
   component.settings(:step) do |settings|
-    settings.attribute :allow_answers, type: :boolean, default: false
-    settings.attribute :allow_unregistered, type: :boolean, default: false
     settings.attribute :announcement, type: :text, translated: true, editor: true
   end
 

data/lib/decidim/surveys/engine.rb

@@ -9,12 +9,12 @@ module Decidim
       isolate_namespace Decidim::Surveys
 
       routes do
-        resources :surveys, only: [:show] do
+        resources :surveys, only: [:index, :show, :edit] do
           member do
             post :answer
           end
         end
-        root to: "surveys#show"
+        root to: "surveys#index"
       end
 
       initializer "decidim_surveys.settings_changes" do

data/lib/decidim/surveys/seeds.rb

@@ -4,7 +4,7 @@ require "decidim/components/namer"
 
 module Decidim
   module Surveys
-    class Seeds
+    class Seeds < Decidim::Seeds
       attr_reader :participatory_space
 
       def initialize(participatory_space:)
@@ -12,11 +12,19 @@ module Decidim
       end
 
       def call
-        admin_user = Decidim::User.find_by(
-          organization: participatory_space.organization,
-          email: "admin@example.org"
-        )
+        component = create_component!
+
+        3.times do
+          questionnaire = create_questionnaire!(component:)
+          create_questions!(questionnaire:)
+
+          next if questionnaire.questionnaire_for.allow_answers
 
+          rand(200).times { create_answers!(questionnaire:) }
+        end
+      end
+
+      def create_component!
         params = {
           name: Decidim::Components::Namer.new(participatory_space.organization.available_locales, :surveys).i18n_name,
           manifest_name: :surveys,
@@ -24,7 +32,7 @@ module Decidim
           participatory_space:
         }
 
-        component = Decidim.traceability.perform_action!(
+        Decidim.traceability.perform_action!(
           "publish",
           Decidim::Component,
           admin_user,
@@ -32,7 +40,9 @@ module Decidim
         ) do
           Decidim::Component.create!(params)
         end
+      end
 
+      def create_questionnaire!(component:)
         questionnaire = Decidim::Forms::Questionnaire.new(
           title: Decidim::Faker::Localized.paragraph,
           description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
@@ -45,7 +55,9 @@ module Decidim
 
         params = {
           component:,
-          questionnaire:
+          questionnaire:,
+          allow_answers: [true, false].sample,
+          published_at: Time.current
         }
 
         Decidim.traceability.create!(
@@ -55,16 +67,22 @@ module Decidim
           visibility: "all"
         )
 
-        %w(short_answer long_answer).each_with_index do |text_question_type, index|
+        questionnaire
+      end
+
+      def create_questions!(questionnaire:)
+        %w(short_answer long_answer files).each_with_index do |text_question_type, index|
           Decidim::Forms::Question.create!(
+            mandatory: text_question_type == "short_answer",
             questionnaire:,
             body: Decidim::Faker::Localized.paragraph,
             question_type: text_question_type,
             position: index
           )
+          next if text_question_type == "files"
         end
 
-        %w(single_option multiple_option).each_with_index do |multiple_choice_question_type, index|
+        %w(single_option multiple_option sorting).each_with_index do |multiple_choice_question_type, index|
           question = Decidim::Forms::Question.create!(
             questionnaire:,
             body: Decidim::Faker::Localized.paragraph,
@@ -76,8 +94,12 @@ module Decidim
             question.answer_options.create!(body: Decidim::Faker::Localized.sentence)
           end
 
+          # Files type questions do not support being conditionals for another questions
+          files_question = questionnaire.questions.where(question_type: "files")
+          possible_condition_questions = questionnaire.questions.excluding(files_question)
+
           question.display_conditions.create!(
-            condition_question: questionnaire.questions.find_by(position: question.position - 2),
+            condition_question: possible_condition_questions.sample,
             question:,
             condition_type: :answered,
             mandatory: true
@@ -97,6 +119,89 @@ module Decidim
             question.matrix_rows.create!(body: Decidim::Faker::Localized.sentence, position:)
           end
         end
+
+        Decidim::Forms::Question.create!(
+          questionnaire:,
+          body: nil,
+          question_type: "separator",
+          position: 3
+        )
+      end
+
+      def create_answers!(questionnaire:, user: nil)
+        user = find_or_initialize_user_by(email: "survey-#{questionnaire.id}-#{rand(1_000_000)}@example.org") if user.nil?
+
+        answer_options = {
+          user:,
+          questionnaire:,
+          session_token: Digest::MD5.hexdigest("#{user.id}-#{Rails.application.secret_key_base}"),
+          ip_hash: Faker::Internet.device_token.slice(0, 24)
+        }
+
+        questionnaire.questions.each do |question|
+          case question.question_type
+          when "short_answer", "long_answer"
+            create_answer_for_text_question_type!(answer_options.merge({ question: }))
+          when "single_option", "multiple_option"
+            create_answer_for_multiple_choice_question_type(answer_options.merge({ question: }))
+          when "sorting"
+            create_answer_for_sorting_question_type(answer_options.merge({ question: }))
+          when "matrix_single", "matrix_multiple"
+            create_answer_for_matrix_question_type(answer_options.merge({ question: }))
+          end
+        end
+      rescue ActiveRecord::RecordInvalid
+        # Silently ignore the error as we do not care if the user already exists
+      end
+
+      def create_answer_for_text_question_type!(options)
+        Decidim::Forms::Answer.create!(
+          **options, body: ::Faker::Lorem.paragraph(sentence_count: 1)
+        )
+      end
+
+      def create_answer_for_sorting_question_type(options)
+        answer = Decidim::Forms::Answer.create!(**options)
+        answer_options = options[:question].answer_options
+        available_positions = (0..(answer_options.size - 1)).to_a
+
+        answer_options.each do |answer_option|
+          position = available_positions.sample
+          body = answer_option[I18n.locale]
+
+          Decidim::Forms::AnswerChoice.create!(
+            answer:,
+            answer_option:,
+            body:,
+            position:
+          )
+        end
+      end
+
+      def create_answer_for_multiple_choice_question_type(options)
+        answer = Decidim::Forms::Answer.create!(**options)
+        answer_option = options[:question].answer_options.sample
+        body = answer_option[I18n.locale]
+
+        Decidim::Forms::AnswerChoice.create!(
+          answer:,
+          answer_option:,
+          body:
+        )
+      end
+
+      def create_answer_for_matrix_question_type(options)
+        answer = Decidim::Forms::Answer.create!(**options)
+        answer_option = options[:question].answer_options.sample
+        matrix_row = options[:question].matrix_rows.sample
+        body = answer_option[I18n.locale]
+
+        Decidim::Forms::AnswerChoice.create!(
+          answer:,
+          answer_option:,
+          matrix_row:,
+          body:
+        )
       end
     end
   end

data/lib/decidim/surveys/test/factories.rb

@@ -21,5 +21,29 @@ FactoryBot.define do
     end
     questionnaire { build(:questionnaire, :with_questions, skip_injection:) }
     component { build(:surveys_component, skip_injection:) }
+
+    trait :published do
+      published_at { Time.current }
+    end
+
+    trait :allow_edit do
+      allow_editing_answers { true }
+    end
+
+    trait :allow_answers do
+      allow_answers { true }
+    end
+
+    trait :allow_unregistered do
+      allow_unregistered { true }
+    end
+
+    trait :clean_after_publish do
+      clean_after_publish { true }
+    end
+
+    trait :announcement do
+      announcement { "This is a custom announcement." }
+    end
   end
 end

data/lib/decidim/surveys/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-surveys version.
   module Surveys
     def self.version
-      "0.29.1"
+      "0.30.0.rc1"
     end
   end
 end