decidim-surveys 0.29.5 → 0.30.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 167c9c8f41b00ed573fca7db5fce31ddd794fdbf8d0909032bbb7b78eb6f75d3
-  data.tar.gz: 7c29f0c46adba931cc4f11987d10f273cd736839820834f65da02868500e842d
+  metadata.gz: ffdd328a9f3ffc27f800eeddab2eeb74147dbba087d115935ef4375f4b37ac05
+  data.tar.gz: ad666098738e64d72e8ad3db69e6eef2df873625dd2d582571748c4600498e32
 SHA512:
-  metadata.gz: 2964b34f89df7c5f8f84aef5ac6b54f4e5b7208e043b00e22f9fd3e0c072055a6a507c5a09dd84e937b17086d873a43eecc64d4fc8820ed2dfdd40776f22de4b
-  data.tar.gz: 8cc249b536f8252fc255d91a2e58d4552c93c78b8bfdf663591a6366ea447ca0583860e17f4f950dc932aad1054fa495a2ac97fb2ce0e6f5006be46b3e7a4d35
+  metadata.gz: ccba07af7e2dcf5b98785d371dd4889aed0d7f1622f360b71a5334ee7d5ae0ef8478e2e1229fdb083843661bf383acd89172d6ee2f4df7a4daf8df36a80b33dc
+  data.tar.gz: abff712aafc743f2f216ebadf7746ac90033deaecbe982fb242e81ed3059ceb05c114edd8691a26dff78a05901344216d9c5fc8b20a5cdd6122765808e2ab115

data/app/cells/decidim/surveys/survey_card_metadata_cell.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This cell renders metadata for an instance of a Survey
+    class SurveyCardMetadataCell < Decidim::CardMetadataCell
+      include Decidim::LayoutHelper
+      include ActionView::Helpers::DateHelper
+
+      alias survey model
+
+      def initialize(*)
+        super
+
+        @items.prepend(*survey_items)
+      end
+
+      private
+
+      def survey_items
+        [duration, questions_count_item]
+      end
+
+      def duration
+        text = survey.open? ? t("open", scope: "decidim.surveys.surveys.show") : t("closed", scope: "decidim.surveys.surveys.show")
+
+        {
+          text:,
+          icon: "time-line"
+        }
+      end
+
+      def questions_count_item
+        text = "#{survey.questionnaire.questions.size} #{t("questions", scope: "decidim.surveys.surveys.show")}"
+
+        {
+          text:,
+          icon: "survey-line"
+        }
+      end
+    end
+  end
+end

data/app/cells/decidim/surveys/survey_cell.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This cell renders the proposal card for an instance of a Survey
+    # the default size is the Medium Card (:m)
+    class SurveyCell < Decidim::ViewModel
+      include Cell::ViewModel::Partial
+
+      def show
+        cell card_size, model, options
+      end
+
+      private
+
+      def card_size
+        case @options[:size]
+        when :s
+          "decidim/surveys/survey_s"
+        else
+          "decidim/surveys/survey_l"
+        end
+      end
+    end
+  end
+end

data/app/cells/decidim/surveys/survey_l_cell.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module Surveys
+    # This cell renders the List (:l) survey card
+    # for a given instance of a Survey
+    class SurveyLCell < Decidim::CardLCell
+      include Decidim::SanitizeHelper
+
+      def has_description?
+        true
+      end
+
+      def title
+        decidim_sanitize_translated(model.title)
+      end
+
+      def description
+        attribute = model.try(:short_description) || model.try(:body) || model.description
+        text = translated_attribute(attribute)
+
+        decidim_sanitize(html_truncate(text, length: 240), strip_tags: true)
+      end
+
+      private
+
+      def metadata_cell
+        "decidim/surveys/survey_card_metadata"
+      end
+    end
+  end
+end

data/app/cells/decidim/surveys/survey_s_cell.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module Surveys
+    # This cell renders the Search (:s) survey card
+    # for a given instance of a Survey
+    class SurveySCell < Decidim::CardSCell
+      private
+
+      def title
+        present(model).title(html_escape: true)
+      end
+
+      def metadata_cell
+        "decidim/surveys/survey_card_metadata"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # 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)
+          @component = component
+        end
+
+        def call
+          @survey = Survey.new(component: @component, questionnaire: Decidim::Forms::Questionnaire.new)
+
+          @survey.save ? broadcast(:ok, @survey) : broadcast(:invalid)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # A command with all the business logic that publishes an
+      # existing survey.
+      class PublishSurvey < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # survey - Decidim::Surveys::Survey
+        # current_user - the user performing the action
+        def initialize(survey, current_user)
+          @survey = survey
+          @current_user = current_user
+          @questionnaire = survey.questionnaire
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form was not valid and we could not proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if survey.published?
+
+          transaction do
+            publish_survey
+            delete_answers if @survey.clean_after_publish?
+          end
+
+          broadcast(:ok, survey)
+        end
+
+        private
+
+        attr_reader :survey, :current_user
+
+        def publish_survey
+          @survey = Decidim.traceability.perform_action!(
+            :publish,
+            survey,
+            current_user,
+            visibility: "all"
+          ) do
+            survey.publish!
+            survey
+          end
+        end
+
+        def delete_answers
+          @questionnaire.answers.destroy_all
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # A command with all the business logic that unpublishes an
+      # existing survey.
+      class UnpublishSurvey < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # survey - Decidim::Surveys::Survey
+        # current_user - the user performing the action
+        def initialize(survey, current_user)
+          @survey = survey
+          @current_user = current_user
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form was not valid and we could not proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) unless survey.published?
+
+          @survey = Decidim.traceability.perform_action!(
+            :unpublish,
+            survey,
+            current_user
+          ) do
+            survey.unpublish!
+            survey
+          end
+          broadcast(:ok, survey)
+        end
+
+        private
+
+        attr_reader :survey, :current_user
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      # This command is executed when the user changes a Survey Questionnaire from the admin
+      # panel.
+      class UpdateSurvey < Decidim::Forms::Admin::UpdateQuestionnaire
+        # Initializes a UpdateSurvey Command.
+        #
+        # form - The form from which to get the data.
+        # survey questionnaire - The current instance of the questionnaire to be updated.
+        def initialize(form, survey, user)
+          @form = form
+          @survey = survey
+          @questionnaire = survey.questionnaire
+          @user = user
+        end
+
+        # Updates the survey questionnaire if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if @form.invalid?
+
+          Decidim.traceability.perform_action!("update", @survey, @user) do
+            transaction do
+              update_survey_attributes
+              update_questionnaire_attributes
+            end
+          rescue ActiveRecord::RecordInvalid
+            broadcast(:invalid)
+          end
+
+          broadcast(:ok)
+        end
+
+        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,
+            description: @form.description,
+            tos: @form.tos
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This command is executed when the admin publishes the Answers from the admin
+    # panel.
+    class PublishAnswers < Decidim::Command
+      include Decidim::TranslatableAttributes
+
+      # Initializes a PublishAnswers Command.
+      #
+      def initialize(question_id, current_user)
+        @question_id = question_id
+        @current_user = current_user
+      end
+
+      # Publishes the questions' answers
+      #
+      # Broadcasts :ok if successful, :invalid otherwise.
+      def call
+        transaction do
+          publish_survey_answer
+          create_action_log
+        end
+
+        broadcast(:ok)
+      rescue StandardError
+        broadcast(:invalid)
+      end
+
+      private
+
+      attr_reader :question_id, :current_user
+
+      def publish_survey_answer
+        question.update(survey_answers_published_at: Time.current)
+      end
+
+      def question
+        Decidim::Forms::Question.find(question_id)
+      end
+
+      def create_action_log
+        Decidim::ActionLogger.log(
+          "publish_answers",
+          current_user,
+          question,
+          nil,
+          resource: { title: translated_attribute(question.body) },
+          participatory_space: { title: question.questionnaire.questionnaire_for.title }
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This command is executed when the admin unpublishes the Answers from the admin
+    # panel.
+    class UnpublishAnswers < Decidim::Command
+      include Decidim::TranslatableAttributes
+
+      # Initializes a UnpublishAnswers Command.
+      #
+      def initialize(question_id, current_user)
+        @question_id = question_id
+        @current_user = current_user
+      end
+
+      # Unpublishes the questions' answers
+      #
+      # Broadcasts :ok if successful, :invalid otherwise.
+      def call
+        transaction do
+          unpublish_survey_answer
+          create_action_log
+        end
+
+        broadcast(:ok)
+      rescue StandardError
+        broadcast(:invalid)
+      end
+
+      private
+
+      attr_reader :question_id, :current_user
+
+      def unpublish_survey_answer
+        question.update(survey_answers_published_at: nil)
+      end
+
+      def question
+        Decidim::Forms::Question.find(question_id)
+      end
+
+      def create_action_log
+        Decidim::ActionLogger.log(
+          "unpublish_answers",
+          current_user,
+          question,
+          nil,
+          resource: { title: translated_attribute(question.body) },
+          participatory_space: { title: question.questionnaire.questionnaire_for.title }
+        )
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/surveys/admin/filterable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Surveys
+    module Admin
+      module Filterable
+        extend ActiveSupport::Concern
+
+        included do
+          include Decidim::Admin::Filterable
+
+          private
+
+          def base_query
+            collection
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+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
+
+        def index
+          enforce_permission_to :index, :questionnaire_answers
+
+          @query = paginate(collection)
+          @participants = participants(@query)
+          @total = participants_query.count_participants
+
+          render template: "decidim/surveys/admin/answers/index"
+        end
+
+        def show
+          enforce_permission_to :show, :questionnaire_answers
+
+          @participant = participant(participants_query.participant(params[:id]))
+
+          render template: "decidim/surveys/admin/answers/show"
+        end
+
+        def questionnaire_for
+          @questionnaire_for ||= Decidim::Surveys::Survey.where(component: current_component).find_by(id: params[:survey_id])
+        end
+
+        def questionnaire_export_response_url(id)
+          Decidim::EngineRouter.admin_proxy(questionnaire_for.component).export_response_survey_answer_path(questionnaire_for, id:)
+        end
+
+        def questionnaire_url
+          Decidim::EngineRouter.admin_proxy(questionnaire_for.component).edit_questions_survey_path(questionnaire_for)
+        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:)
+        end
+
+        def questionnaire_participants_url
+          Decidim::EngineRouter.admin_proxy(questionnaire_for.component).survey_answers_path(questionnaire_for)
+        end
+
+        private
+
+        def questionnaire
+          @questionnaire ||= Decidim::Forms::Questionnaire.find_by(questionnaire_for:)
+        end
+
+        def participants_query
+          Decidim::Forms::QuestionnaireParticipants.new(questionnaire)
+        end
+
+        def collection
+          @collection ||= participants_query.participants
+        end
+
+        def participant(answer)
+          Decidim::Forms::Admin::QuestionnaireParticipantPresenter.new(participant: answer)
+        end
+
+        def participants(query)
+          query.map { |answer| participant(answer) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+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
+
+        helper PublishAnswersHelper
+
+        def index
+          enforce_permission_to(:index, :questionnaire_publish_answers, survey:)
+
+          @survey ||= survey
+        end
+
+        def update
+          enforce_permission_to(:update, :questionnaire_publish_answers, survey:)
+
+          Decidim::Surveys::PublishAnswers.call(params[:id], current_user) do
+            on(:ok) do
+              render json: {}
+            end
+
+            on(:invalid) do
+              render json: {}, status: :unprocessable_entity
+            end
+          end
+        end
+
+        def destroy
+          enforce_permission_to(:destroy, :questionnaire_publish_answers, survey:)
+
+          Decidim::Surveys::UnpublishAnswers.call(params[:id], current_user) do
+            on(:ok) do
+              render json: {}
+            end
+
+            on(:invalid) do
+              render json: {}, status: :unprocessable_entity
+            end
+          end
+        end
+
+        def questionnaire
+          @questionnaire ||= Decidim::Forms::Questionnaire.find_by(questionnaire_for:)
+        end
+
+        def questionnaire_for
+          survey
+        end
+
+        def questionnaire_url
+          Decidim::EngineRouter.admin_proxy(questionnaire_for.component).edit_questions_survey_path(questionnaire_for)
+        end
+
+        private
+
+        def survey
+          @survey ||= Survey.where(component: current_component).find(params[:survey_id])
+        end
+      end
+    end
+  end
+end