decidim-surveys 0.30.1 → 0.31.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2b110a5bf9317b4ed4274fc2ea61be0d99ee17031c0c799d412622aa7576bb4
-  data.tar.gz: 8e00ee9095790d83bc096063974df71e703d8c231973526835780cd632d97c28
+  metadata.gz: e206d9a7b9769b02f5a4098f8ccfdef11030d5f895bd0d53fab94942f00e7a02
+  data.tar.gz: 1a55fa9ebebe3de7e07c585b6b09fe75acf7b0128ec1d18a0c7774300c68b775
 SHA512:
-  metadata.gz: 47fd4a7a885e9ca01316650582e6fe21b6b3f1bc7249ee8adb66f2caa810e5ccc6d384e0fbc83a014386d35327d93d4d76ee98f2f28ba138671f5a049f388ce2
-  data.tar.gz: d2de6170f18bf62ff71e86dbc72e0e01a30fa90754bb67df1c275a9ee5dbf92965594f0d32af62a4377e68ec16798797b06f00682207138ffbfea3e7f6bad05e
+  metadata.gz: df2e36649d389cf3738d8b2b9a157bfb97d741ca65e26e8fe8606cc1c86fcecf60a96bbfd4defb7b04994766bd23058bfe05007edf8daa6d2fbac08b21e5105a
+  data.tar.gz: e278e5f6e92b90694833d5f2f2f6ee80b42bb11795e68397e6b784619f4cad07b8a5c0ba24a4069c541f87be3383b2d6d7afdaa2b79a2cd24193eafb1547f768

data/README.md

@@ -1,12 +1,12 @@
 # Decidim::Surveys
 
-The Surveys module adds one new component to Decidim: defining and answering surveys.
+The Surveys module adds one new component to Decidim: defining and responding 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.
+* Users can participate on these surveys by responding from the public page.
+* Admins can download the responses by CSV.
 
 ## Usage
 

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

@@ -6,12 +6,24 @@ module Decidim
       # Command that gets called whenever a component's survey has to be created. It
       # usually happens as a callback when the component itself is created.
       class CreateSurvey < Decidim::Command
-        def initialize(component)
+        def initialize(component, form)
           @component = component
+          @form = form
         end
 
+        attr_reader :form
+
         def call
-          @survey = Survey.new(component: @component, questionnaire: Decidim::Forms::Questionnaire.new)
+          return broadcast(:invalid) if form.invalid?
+
+          @survey = Survey.new(
+            component: @component,
+            questionnaire: Decidim::Forms::Questionnaire.new(
+              title: form.title,
+              description: form.description,
+              tos: form.tos
+            )
+          )
 
           @survey.save ? broadcast(:ok, @survey) : broadcast(:invalid)
         end

data/app/commands/decidim/surveys/admin/publish_survey.rb

@@ -27,7 +27,7 @@ module Decidim
 
           transaction do
             publish_survey
-            delete_answers if @survey.clean_after_publish?
+            delete_responses if @survey.clean_after_publish?
           end
 
           broadcast(:ok, survey)
@@ -49,8 +49,8 @@ module Decidim
           end
         end
 
-        def delete_answers
-          @questionnaire.answers.destroy_all
+        def delete_responses
+          @questionnaire.responses.destroy_all
         end
       end
     end

data/app/commands/decidim/surveys/admin/update_survey.rb

@@ -25,7 +25,6 @@ module Decidim
 
           Decidim.traceability.perform_action!("update", @survey, @user) do
             transaction do
-              update_survey_attributes
               update_questionnaire_attributes
             end
           rescue ActiveRecord::RecordInvalid
@@ -37,18 +36,6 @@ module Decidim
 
         private
 
-        def update_survey_attributes
-          @survey.update!(
-            allow_answers: @form.allow_answers,
-            allow_editing_answers: @form.allow_editing_answers,
-            allow_unregistered: @form.allow_unregistered,
-            starts_at: @form.starts_at,
-            ends_at: @form.ends_at,
-            clean_after_publish: @form.clean_after_publish,
-            announcement: @form.announcement
-          )
-        end
-
         def update_questionnaire_attributes
           @questionnaire.update!(
             title: @form.title,

data/app/commands/decidim/surveys/admin/update_survey_settings.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # This command is executed when the user changes a Survey Settings (also known as their attributes) from the admin
+      # panel.
+      class UpdateSurveySettings < Decidim::Forms::Admin::UpdateQuestionnaire
+        # Initializes a UpdateSurveySettings Command.
+        #
+        # form - The form from which to get the data.
+        # survey - The current instance of the survey to be updated.
+        # user - The user doing the update
+        def initialize(form, survey, user)
+          @form = form
+          @survey = survey
+          @user = user
+        end
+
+        attr_reader :form, :survey, :user
+
+        # Updates the survey questionnaire if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          Decidim.traceability.perform_action!("update", survey, user) do
+            transaction do
+              update_survey_settings
+            end
+          rescue ActiveRecord::RecordInvalid
+            broadcast(:invalid)
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        def update_survey_settings
+          survey.update!(
+            allow_responses: form.allow_responses,
+            allow_editing_responses: form.allow_editing_responses,
+            allow_unregistered: form.allow_unregistered,
+            starts_at: form.starts_at,
+            ends_at: form.ends_at,
+            clean_after_publish: form.clean_after_publish,
+            announcement: form.announcement
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/surveys/{publish_answers.rb → publish_responses.rb}

@@ -2,24 +2,24 @@
 
 module Decidim
   module Surveys
-    # This command is executed when the admin publishes the Answers from the admin
+    # This command is executed when the admin publishes the Responses from the admin
     # panel.
-    class PublishAnswers < Decidim::Command
+    class PublishResponses < Decidim::Command
       include Decidim::TranslatableAttributes
 
-      # Initializes a PublishAnswers Command.
+      # Initializes a PublishResponses Command.
       #
       def initialize(question_id, current_user)
         @question_id = question_id
         @current_user = current_user
       end
 
-      # Publishes the questions' answers
+      # Publishes the questions' responses
       #
       # Broadcasts :ok if successful, :invalid otherwise.
       def call
         transaction do
-          publish_survey_answer
+          publish_survey_response
           create_action_log
         end
 
@@ -32,8 +32,8 @@ module Decidim
 
       attr_reader :question_id, :current_user
 
-      def publish_survey_answer
-        question.update(survey_answers_published_at: Time.current)
+      def publish_survey_response
+        question.update(survey_responses_published_at: Time.current)
       end
 
       def question
@@ -42,7 +42,7 @@ module Decidim
 
       def create_action_log
         Decidim::ActionLogger.log(
-          "publish_answers",
+          "publish_responses",
           current_user,
           question,
           nil,

data/app/commands/decidim/surveys/{unpublish_answers.rb → unpublish_responses.rb}

@@ -2,24 +2,24 @@
 
 module Decidim
   module Surveys
-    # This command is executed when the admin unpublishes the Answers from the admin
+    # This command is executed when the admin unpublishes the Responses from the admin
     # panel.
-    class UnpublishAnswers < Decidim::Command
+    class UnpublishResponses < Decidim::Command
       include Decidim::TranslatableAttributes
 
-      # Initializes a UnpublishAnswers Command.
+      # Initializes a UnpublishResponses Command.
       #
       def initialize(question_id, current_user)
         @question_id = question_id
         @current_user = current_user
       end
 
-      # Unpublishes the questions' answers
+      # Unpublishes the questions' responses
       #
       # Broadcasts :ok if successful, :invalid otherwise.
       def call
         transaction do
-          unpublish_survey_answer
+          unpublish_survey_response
           create_action_log
         end
 
@@ -32,8 +32,8 @@ module Decidim
 
       attr_reader :question_id, :current_user
 
-      def unpublish_survey_answer
-        question.update(survey_answers_published_at: nil)
+      def unpublish_survey_response
+        question.update(survey_responses_published_at: nil)
       end
 
       def question
@@ -42,7 +42,7 @@ module Decidim
 
       def create_action_log
         Decidim::ActionLogger.log(
-          "unpublish_answers",
+          "unpublish_responses",
           current_user,
           question,
           nil,

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

@@ -9,6 +9,19 @@ module Decidim
       # Note that it inherits from `Decidim::Admin::Components::BaseController`, which
       # override its layout and provide all kinds of useful methods.
       class ApplicationController < Decidim::Admin::Components::BaseController
+        helper_method :public_url
+
+        layout :layout_for_action
+
+        private
+
+        def layout_for_action
+          "decidim/admin/surveys" unless %w(index new create).include?(action_name) && controller_name == "surveys"
+        end
+
+        def public_url
+          Decidim::EngineRouter.main_proxy(current_component).survey_path(survey)
+        end
       end
     end
   end

data/app/controllers/decidim/surveys/admin/{publish_answers_controller.rb → publish_responses_controller.rb}

@@ -3,22 +3,22 @@
 module Decidim
   module Surveys
     module Admin
-      # This controller allows the user to see which questions' answers can be published, and publish or unpublish them
-      class PublishAnswersController < Admin::ApplicationController
-        include Decidim::Forms::Admin::Concerns::HasQuestionnaireAnswersUrlHelper
+      # This controller allows the user to see which questions' responses can be published, and publish or unpublish them
+      class PublishResponsesController < Admin::ApplicationController
+        include Decidim::Forms::Admin::Concerns::HasQuestionnaireResponsesUrlHelper
 
-        helper PublishAnswersHelper
+        helper PublishResponsesHelper
 
         def index
-          enforce_permission_to(:index, :questionnaire_publish_answers, survey:)
+          enforce_permission_to(:index, :questionnaire_publish_responses, survey:)
 
           @survey ||= survey
         end
 
         def update
-          enforce_permission_to(:update, :questionnaire_publish_answers, survey:)
+          enforce_permission_to(:update, :questionnaire_publish_responses, survey:)
 
-          Decidim::Surveys::PublishAnswers.call(params[:id], current_user) do
+          Decidim::Surveys::PublishResponses.call(params[:id], current_user) do
             on(:ok) do
               render json: {}
             end
@@ -30,9 +30,9 @@ module Decidim
         end
 
         def destroy
-          enforce_permission_to(:destroy, :questionnaire_publish_answers, survey:)
+          enforce_permission_to(:destroy, :questionnaire_publish_responses, survey:)
 
-          Decidim::Surveys::UnpublishAnswers.call(params[:id], current_user) do
+          Decidim::Surveys::UnpublishResponses.call(params[:id], current_user) do
             on(:ok) do
               render json: {}
             end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      module Questions
+        # This controller allows the user create and edit questionnaires for Surveys.
+        class SurveysController < Admin::ApplicationController
+          include Decidim::Forms::Admin::Concerns::HasQuestionnaire
+          include Decidim::Forms::Admin::Concerns::HasQuestionnaireResponsesUrlHelper
+
+          helper_method :surveys
+
+          def edit_questions_template
+            "decidim/surveys/admin/questions/surveys/edit"
+          end
+
+          def questionnaire_for
+            survey
+          end
+
+          def after_update_url
+            edit_questions_questions_survey_path(survey)
+          end
+
+          def questionnaire_participants_url
+            Decidim::EngineRouter.admin_proxy(survey.component).survey_responses_path(survey)
+          end
+
+          # Specify the public url from which the survey can be viewed and responded
+          def public_url
+            Decidim::EngineRouter.main_proxy(current_component).survey_path(survey)
+          end
+
+          def edit_questionnaire_title
+            t(:title, scope: "decidim.forms.admin.questionnaires.form", questionnaire_for: translated_attribute(current_component.name))
+          end
+
+          private
+
+          def survey
+            @survey ||= Decidim::Surveys::Survey.where(component: current_component).find(params[:id])
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/surveys/admin/{answers_controller.rb → responses_controller.rb}

@@ -4,25 +4,26 @@ module Decidim
   module Surveys
     module Admin
       # This controller allows the user to update a Page.
-      class AnswersController < Admin::ApplicationController
-        include Decidim::Forms::Admin::Concerns::HasQuestionnaireAnswers
+      class ResponsesController < Admin::ApplicationController
+        include Decidim::Forms::Admin::Concerns::HasQuestionnaireResponses
 
         def index
-          enforce_permission_to :index, :questionnaire_answers
+          enforce_permission_to :index, :questionnaire_responses
 
           @query = paginate(collection)
           @participants = participants(@query)
           @total = questionnaire.count_participants
+          @survey = questionnaire_for
 
-          render template: "decidim/surveys/admin/answers/index"
+          render template: "decidim/surveys/admin/responses/index"
         end
 
         def show
-          enforce_permission_to :show, :questionnaire_answers
+          enforce_permission_to :show, :questionnaire_responses
 
           @participant = participant(participants_query.participant(params[:id]))
 
-          render template: "decidim/surveys/admin/answers/show"
+          render template: "decidim/surveys/admin/responses/show"
         end
 
         def questionnaire_for
@@ -30,7 +31,7 @@ module Decidim
         end
 
         def questionnaire_export_response_url(id)
-          Decidim::EngineRouter.admin_proxy(questionnaire_for.component).export_response_survey_answer_path(questionnaire_for, id:)
+          Decidim::EngineRouter.admin_proxy(questionnaire_for.component).export_response_survey_response_path(questionnaire_for, id:)
         end
 
         def questionnaire_url
@@ -38,16 +39,20 @@ module Decidim
         end
 
         # Specify where to redirect after exporting a user response
-        def questionnaire_participant_answers_url(id)
-          Decidim::EngineRouter.admin_proxy(questionnaire_for.component).survey_answer_path(questionnaire_for, id:)
+        def questionnaire_participant_responses_url(id)
+          Decidim::EngineRouter.admin_proxy(questionnaire_for.component).survey_response_path(questionnaire_for, id:)
         end
 
         def questionnaire_participants_url
-          Decidim::EngineRouter.admin_proxy(questionnaire_for.component).survey_answers_path(questionnaire_for)
+          Decidim::EngineRouter.admin_proxy(questionnaire_for.component).survey_responses_path(questionnaire_for)
         end
 
         private
 
+        def survey
+          questionnaire.questionnaire_for
+        end
+
         def questionnaire
           @questionnaire ||= Decidim::Forms::Questionnaire.find_by(questionnaire_for:)
         end
@@ -60,12 +65,12 @@ module Decidim
           @collection ||= participants_query.participants
         end
 
-        def participant(answer)
-          Decidim::Forms::Admin::QuestionnaireParticipantPresenter.new(participant: answer)
+        def participant(response)
+          Decidim::Forms::Admin::QuestionnaireParticipantPresenter.new(participant: response)
         end
 
         def participants(query)
-          query.map { |answer| participant(answer) }
+          query.map { |response| participant(response) }
         end
       end
     end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      module Settings
+        # This controller allows the user to update the settings for a Survey.
+        class SurveysController < Admin::ApplicationController
+          def edit
+            enforce_permission_to(:update, :questionnaire)
+
+            @form = form(Admin::SurveySettingsForm).from_model(survey)
+          end
+
+          def update
+            enforce_permission_to(:update, :questionnaire)
+
+            @form = form(Admin::SurveySettingsForm).from_params(params)
+
+            Admin::UpdateSurveySettings.call(@form, survey, current_user) do
+              on(:ok) do
+                flash[:notice] = I18n.t("update.success", scope: "decidim.surveys.admin.surveys")
+                redirect_to edit_settings_survey_path(survey)
+              end
+
+              on(:invalid) do
+                flash.now[:alert] = I18n.t("update.invalid", scope: "decidim.surveys.admin.surveys")
+                render action: "edit", status: :unprocessable_entity
+              end
+            end
+          end
+
+          private
+
+          def survey
+            @survey ||= Decidim::Surveys::Survey.where(component: current_component).find(params[:id])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,19 +3,25 @@
 module Decidim
   module Surveys
     module Admin
-      # This controller allows the user create and edit questionnaires for Surveys.
+      # This controller allows to index, create, update, destroy, publish and unpublish a Survey.
       class SurveysController < Admin::ApplicationController
-        include Decidim::Forms::Admin::Concerns::HasQuestionnaire
-        include Decidim::Forms::Admin::Concerns::HasQuestionnaireAnswersUrlHelper
         include Decidim::Surveys::Admin::Filterable
 
         helper_method :surveys
 
         def index; end
 
+        def new
+          enforce_permission_to(:create, :questionnaire)
+
+          @form = form(Admin::SurveyForm).instance
+        end
+
         def create
           enforce_permission_to(:create, :questionnaire)
-          Decidim::Surveys::Admin::CreateSurvey.call(current_component) do
+
+          @form = form(Admin::SurveyForm).from_params(params)
+          Decidim::Surveys::Admin::CreateSurvey.call(current_component, @form) do
             on(:ok) do |survey|
               flash[:notice] = I18n.t("create.success", scope: "decidim.surveys.admin.surveys")
               redirect_to edit_survey_path(survey)
@@ -23,35 +29,35 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("create.invalid", scope: "decidim.surveys.admin.surveys")
-              render action: "index"
+              render action: "new", status: :unprocessable_entity
             end
           end
         end
 
         def edit
-          enforce_permission_to(:update, :questionnaire, questionnaire:)
+          enforce_permission_to(:update, :questionnaire, questionnaire: survey)
           @form = form(Admin::SurveyForm).from_model(survey)
         end
 
         def update
-          enforce_permission_to(:update, :questionnaire, questionnaire:)
+          enforce_permission_to(:update, :questionnaire, questionnaire: survey)
           @form = form(Admin::SurveyForm).from_params(params)
 
           Admin::UpdateSurvey.call(@form, survey, current_user) do
             on(:ok) do
               flash[:notice] = I18n.t("update.success", scope: "decidim.surveys.admin.surveys")
-              redirect_to(surveys_path) && return
+              redirect_to edit_survey_path(survey)
             end
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("update.invalid", scope: "decidim.surveys.admin.surveys")
-              render action: "edit"
+              render action: "edit", status: :unprocessable_entity
             end
           end
         end
 
         def publish
-          enforce_permission_to(:update, :questionnaire, questionnaire:)
+          enforce_permission_to(:update, :questionnaire, questionnaire: survey)
           Decidim::Surveys::Admin::PublishSurvey.call(survey, current_user) do
             on(:ok) do
               flash[:notice] = I18n.t("publish.success", scope: "decidim.surveys.admin.surveys")
@@ -60,13 +66,13 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("publish.invalid", scope: "decidim.surveys.admin.surveys")
-              render action: "index"
+              render action: "index", status: :unprocessable_entity
             end
           end
         end
 
         def unpublish
-          enforce_permission_to(:update, :questionnaire, questionnaire:)
+          enforce_permission_to(:update, :questionnaire, questionnaire: survey)
           Decidim::Surveys::Admin::UnpublishSurvey.call(survey, current_user) do
             on(:ok) do
               flash[:notice] = I18n.t("unpublish.success", scope: "decidim.surveys.admin.surveys")
@@ -75,13 +81,13 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("unpublish.invalid", scope: "decidim.surveys.admin.surveys")
-              render action: "index"
+              render action: "index", status: :unprocessable_entity
             end
           end
         end
 
         def destroy
-          enforce_permission_to(:destroy, :questionnaire, questionnaire:)
+          enforce_permission_to(:destroy, :questionnaire, questionnaire: survey)
           Decidim::Commands::DestroyResource.call(survey, current_user) do
             on(:ok) do
               flash[:notice] = I18n.t("destroy.success", scope: "decidim.surveys.admin.surveys")
@@ -91,31 +97,6 @@ module Decidim
           end
         end
 
-        def edit_questions_template
-          "decidim/surveys/admin/surveys/edit_questions"
-        end
-
-        def questionnaire_for
-          survey
-        end
-
-        def after_update_url
-          surveys_path
-        end
-
-        def questionnaire_participants_url
-          Decidim::EngineRouter.admin_proxy(survey.component).survey_answers_path(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
-
-        def edit_questionnaire_title
-          t(:title, scope: "decidim.forms.admin.questionnaires.form", questionnaire_for: translated_attribute(current_component.name))
-        end
-
         private
 
         def surveys