decidim-surveys 0.29.1 → 0.30.0.rc1

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

@@ -3,43 +3,131 @@
 module Decidim
   module Surveys
     module Admin
-      # This controller allows the user to update a Page.
+      # 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::HasQuestionnaireAnswers
+        include Decidim::Forms::Admin::Concerns::HasQuestionnaireAnswersUrlHelper
+        include Decidim::Surveys::Admin::Filterable
+
+        helper_method :surveys
+
+        def index; end
+
+        def create
+          enforce_permission_to(:create, :questionnaire)
+          Decidim::Surveys::Admin::CreateSurvey.call(current_component) do
+            on(:ok) do |survey|
+              flash[:notice] = I18n.t("create.success", scope: "decidim.surveys.admin.surveys")
+              redirect_to edit_survey_path(survey)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("create.invalid", scope: "decidim.surveys.admin.surveys")
+              render action: "index"
+            end
+          end
+        end
 
         def edit
           enforce_permission_to(:update, :questionnaire, questionnaire:)
+          @form = form(Admin::SurveyForm).from_model(survey)
+        end
+
+        def update
+          enforce_permission_to(:update, :questionnaire, questionnaire:)
+          @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
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("update.invalid", scope: "decidim.surveys.admin.surveys")
+              render action: "edit"
+            end
+          end
+        end
+
+        def publish
+          enforce_permission_to(:update, :questionnaire, questionnaire:)
+          Decidim::Surveys::Admin::PublishSurvey.call(survey, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("publish.success", scope: "decidim.surveys.admin.surveys")
+              redirect_to surveys_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("publish.invalid", scope: "decidim.surveys.admin.surveys")
+              render action: "index"
+            end
+          end
+        end
+
+        def unpublish
+          enforce_permission_to(:update, :questionnaire, questionnaire:)
+          Decidim::Surveys::Admin::UnpublishSurvey.call(survey, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("unpublish.success", scope: "decidim.surveys.admin.surveys")
+              redirect_to surveys_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("unpublish.invalid", scope: "decidim.surveys.admin.surveys")
+              render action: "index"
+            end
+          end
+        end
 
-          @form = form(Decidim::Forms::Admin::QuestionnaireForm).from_model(questionnaire)
+        def destroy
+          enforce_permission_to(:destroy, :questionnaire, questionnaire:)
+          Decidim::Commands::DestroyResource.call(survey, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("destroy.success", scope: "decidim.surveys.admin.surveys")
+
+              redirect_to surveys_path
+            end
+          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
 
-        # 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:)
-        end
-
         def edit_questionnaire_title
           t(:title, scope: "decidim.forms.admin.questionnaires.form", questionnaire_for: translated_attribute(current_component.name))
         end
 
         private
 
-        def i18n_flashes_scope
-          "decidim.surveys.admin.surveys"
+        def surveys
+          @surveys ||= filtered_collection
         end
 
         def survey
-          @survey ||= Survey.find_by(component: current_component)
+          @survey ||= collection.find(params[:id])
+        end
+
+        def collection
+          @collection ||= Decidim::Surveys::Survey.where(component: current_component)
         end
       end
     end

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

@@ -7,12 +7,24 @@ module Decidim
       include Decidim::Forms::Concerns::HasQuestionnaire
       include Decidim::ComponentPathHelper
       include Decidim::Surveys::SurveyHelper
+      include FilterResource
+      include Paginable
 
-      helper_method :authorizations
+      helper PublishAnswersHelper
+      helper_method :authorizations, :surveys, :show_published_questions_answers?
 
-      delegate :allow_unregistered?, to: :current_settings
+      before_action :check_permissions, except: [:index]
+      before_action :check_editable, only: [:edit]
 
-      before_action :check_permissions
+      def index; end
+
+      def edit
+        @form = form(Decidim::Forms::QuestionnaireForm).from_model(questionnaire)
+        @form.add_answers!(questionnaire:, session_token:, ip_hash:)
+        @form.allow_editing_answers = questionnaire.questionnaire_for&.allow_editing_answers?
+
+        render template: "decidim/forms/questionnaires/edit"
+      end
 
       def check_permissions
         render :no_permission unless action_authorized_to(:answer, resource: survey).ok?
@@ -24,8 +36,27 @@ module Decidim
 
       protected
 
+      def check_editable
+        return if allow_editing_answers?
+
+        flash.now[:error] = t("decidim.forms.step_navigation.show.disallowed")
+        render :not_allowed
+      end
+
+      def allow_editing_answers?
+        visitor_can_edit_answers? && survey.open?
+      end
+
+      def show_published_questions_answers?
+        survey.closed? && survey.questionnaire.questions.pluck(:survey_answers_published_at).any?
+      end
+
       def allow_answers?
-        !current_component.published? || (current_settings.allow_answers? && survey.open?)
+        !current_component.published? || survey.open?
+      end
+
+      def allow_unregistered?
+        survey.allow_unregistered
       end
 
       def form_path
@@ -38,8 +69,22 @@ module Decidim
         "decidim.surveys.surveys"
       end
 
+      def surveys
+        paginate(search.result).published
+      end
+
       def survey
-        @survey ||= Survey.find_by(component: current_component)
+        @survey ||= search_collection.find_by(id: params[:id])
+      end
+
+      def search_collection
+        @search_collection ||= Decidim::Surveys::Survey.where(component: current_component)
+      end
+
+      def default_filter_params
+        {
+          with_any_state: %w(open)
+        }
       end
     end
   end

data/app/forms/decidim/surveys/admin/survey_form.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module Admin
+      class SurveyForm < Decidim::Forms::Admin::QuestionnaireForm
+        translatable_attribute :announcement, String
+
+        attribute :allow_answers, Boolean
+        attribute :allow_unregistered, Boolean
+        attribute :clean_after_publish, Boolean
+        attribute :allow_editing_answers, Boolean
+        attribute :starts_at, Decidim::Attributes::TimeWithZone
+        attribute :ends_at, Decidim::Attributes::TimeWithZone
+      end
+    end
+  end
+end

data/app/helpers/decidim/surveys/application_helper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # Custom helpers, scoped to the surveys engine.
+    #
+    module ApplicationHelper
+      include PaginateHelper
+      include Decidim::SanitizeHelper
+      include Decidim::CheckBoxesTreeHelper
+      include Decidim::RichTextEditorHelper
+
+      # Returns a TreeNode to be used in the list filters to filter surveys by
+      # its state.
+      def filter_surveys_date_values
+        [
+          ["all", t("all", scope: "decidim.surveys.surveys.filters")],
+          ["open", { checked: true }, t("open", scope: "decidim.surveys.surveys.filters.state_values")],
+          ["closed", t("closed", scope: "decidim.surveys.surveys.filters.state_values")]
+        ]
+      end
+
+      def filter_sections
+        @filter_sections ||= [{
+          method: :with_any_state,
+          collection: filter_surveys_date_values,
+          label: t("decidim.proposals.proposals.filters.state"),
+          id: "state",
+          type: :radio_buttons
+        }]
+      end
+    end
+  end
+end

data/app/helpers/decidim/surveys/publish_answers_helper.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module PublishAnswersHelper
+      def question_answer_is_publicable(question_type)
+        ignored_question_types = %w(short_answer long_answer separator files).freeze
+
+        ignored_question_types.exclude?(question_type)
+      end
+
+      # Renders the chart for the given question.
+      # Uses chartkick to render the chart.
+      #
+      # @param question_id [Integer] the question id for Decidim:
+      def chart_for_question(question_id)
+        question = Decidim::Forms::Question.includes(answers: { choices: [:answer_option, :matrix_row] }).find(question_id)
+
+        Chartkick.options = {
+          library: { animation: { easing: "easeOutQuart" } },
+          colors: colors_list
+        }
+
+        case question.question_type
+        when "single_option", "multiple_option"
+          options_column_chart_wrapper(question)
+        when "matrix_single", "matrix_multiple"
+          matrix_stack_chart_wrapper(question)
+        when "sorting"
+          sorting_stack_chart_wrapper(question)
+        else
+          "Unknown question type"
+        end
+      end
+
+      private
+
+      def sorting_stack_chart_wrapper(question)
+        counts = Hash.new { |hash, key| hash[key] = Hash.new(0) }
+
+        question.answers.each do |answer|
+          answer.choices.each do |choice|
+            name = translated_attribute(choice.answer_option.body)
+            row = choice.position + 1
+
+            counts[row][name] += 1
+          end
+        end
+
+        tally = counts.map do |name, row_data|
+          {
+            name:,
+            data: row_data.map { |row, count| [row, count] }
+          }
+        end
+
+        bar_chart(tally.sort_by { |data| data[:name] }, stacked: true, download: true)
+      end
+
+      def matrix_stack_chart_wrapper(question)
+        counts = Hash.new { |hash, key| hash[key] = Hash.new(0) }
+
+        question.answers.each do |answer|
+          answer.choices.each do |choice|
+            name = translated_attribute(choice.answer_option.body)
+            row = translated_attribute(choice.matrix_row.body)
+
+            counts[name][row] += 1
+          end
+        end
+
+        tally = counts.map do |name, row_data|
+          {
+            name:,
+            data: row_data.map { |row, count| [row, count] }
+          }
+        end
+
+        column_chart(tally, stacked: true, legend: :right, download: true)
+      end
+
+      def options_column_chart_wrapper(question)
+        tally = question.answers.map { |answer| answer.choices.map { |choice| translated_attribute(choice.answer_option.body) } }.tally
+
+        column_chart(tally, download: true)
+      end
+
+      def colors_list
+        %w(
+          #3366CC
+          #DC3912
+          #FF9900
+          #109618
+          #3B3EAC
+          #0099C6
+          #DD4477
+          #66AA00
+          #B82E2E
+          #316395
+        )
+      end
+    end
+  end
+end

data/app/helpers/decidim/surveys/survey_helper.rb

@@ -26,6 +26,10 @@ module Decidim
       def authorizations
         @authorizations ||= action_authorized_to(:answer, resource: questionnaire_for)
       end
+
+      def filter_date_values
+        flat_filter_values(:all, :open, :closed, scope: "decidim.surveys.surveys.filters.date_values")
+      end
     end
   end
 end

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

@@ -7,33 +7,88 @@ module Decidim
       include Decidim::Resourceable
       include Decidim::Forms::HasQuestionnaire
       include Decidim::HasComponent
+      include Decidim::FilterableResource
+      include Decidim::Publicable
 
       component_manifest_name "surveys"
 
       delegate :title, to: :questionnaire
+      delegate :description, to: :questionnaire
+      delegate :tos, to: :questionnaire
 
       validates :questionnaire, presence: true
 
-      def clean_after_publish?
-        component.settings.clean_after_publish?
+      scope :open, lambda {
+        where(allow_answers: true)
+          .where(starts_at: nil, ends_at: nil).or(
+            where("starts_at <= ? AND (ends_at IS NULL OR ends_at > ?)", Time.current, Time.current)
+          ).or(
+            where("ends_at > ? AND (starts_at IS NULL OR starts_at <= ?)", Time.current, Time.current)
+          )
+      }
+      scope :closed, lambda {
+        where(allow_answers: false).or(
+          where("starts_at > ?", Time.current).or(
+            where(ends_at: ...Time.current)
+          )
+        )
+      }
+      scope :published, -> { where.not(published_at: nil) }
+
+      scope_search_multi :with_any_state, [:open, :closed]
+
+      def open?
+        return false if allow_answers.blank?
+        return true if time_indefinite?
+        return true if started_but_no_end?
+        return true if no_start_but_ends_later?
+
+        return within_time_range? if time_range_defined?
+
+        false
       end
 
-      def starts_at
-        component.settings.starts_at
+      def closed?
+        !open?
       end
 
-      def ends_at
-        component.settings.ends_at
+      def self.ransackable_scopes(_auth_object = nil)
+        [:with_any_state]
       end
 
-      def open?
-        return true if starts_at.blank? && ends_at.blank?
-        return true if ends_at.blank? && starts_at.past?
-        return true if starts_at.blank? && ends_at.future?
+      def self.ransackable_attributes(_auth_object = nil)
+        %w(ends_at starts_at allow_answers)
+      end
 
-        return Time.zone.now.between?(starts_at, ends_at) if starts_at.present? && ends_at.present?
+      def self.log_presenter_class_for(_log)
+        Decidim::Surveys::AdminLog::SurveyPresenter
+      end
 
-        false
+      # Public: Overrides the `allow_resource_permissions?` Resourceable concern method.
+      def allow_resource_permissions?
+        true
+      end
+
+      private
+
+      def time_indefinite?
+        starts_at.blank? && ends_at.blank?
+      end
+
+      def started_but_no_end?
+        ends_at.blank? && starts_at.past?
+      end
+
+      def no_start_but_ends_later?
+        starts_at.blank? && ends_at.future?
+      end
+
+      def time_range_defined?
+        starts_at.present? && ends_at.present?
+      end
+
+      def within_time_range?
+        Time.zone.now.between?(starts_at, ends_at)
       end
     end
   end

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

@@ -12,7 +12,7 @@ module Decidim
           case permission_action.subject
           when :questionnaire
             case permission_action.action
-            when :export_answers, :update
+            when :export_answers, :update, :create, :destroy
               permission_action.allow!
             end
           when :questionnaire_answers
@@ -20,6 +20,15 @@ module Decidim
             when :index, :show, :export_response
               permission_action.allow!
             end
+          when :questionnaire_publish_answers
+            case permission_action.action
+            when :index, :update, :destroy
+              if context.fetch(:survey).allow_answers
+                permission_action.disallow!
+              else
+                permission_action.allow!
+              end
+            end
           end
 
           permission_action

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

@@ -4,8 +4,6 @@ module Decidim
   module Surveys
     class Permissions < Decidim::DefaultPermissions
       def permissions
-        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/presenters/decidim/surveys/admin_log/survey_presenter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    module AdminLog
+      # This class holds the logic to present a `Decidim::Surveys::Survey`
+      # for the `AdminLog` log.
+      #
+      # Usage should be automatic and you should not need to call this class
+      # directly, but here is an example:
+      #
+      #    action_log = Decidim::ActionLog.last
+      #    view_helpers # => this comes from the views
+      #    SurveyPresenter.new(action_log, view_helpers).present
+      class SurveyPresenter < Decidim::Log::BasePresenter
+        private
+
+        # i18n-tasks-use t("decidim.surveys.admin_log.survey.create")
+        # i18n-tasks-use t("decidim.surveys.admin_log.survey.delete")
+        # i18n-tasks-use t("decidim.surveys.admin_log.survey.publish")
+        # i18n-tasks-use t("decidim.surveys.admin_log.survey.unpublish")
+        # i18n-tasks-use t("decidim.surveys.admin_log.survey.update")
+        def action_string
+          case action
+          when "delete", "create", "update", "publish", "unpublish"
+            "decidim.surveys.admin_log.survey.#{action}"
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,7 +16,7 @@ module Decidim
             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,
+                                                           organization: @organization, decidim_taxonomy_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)
@@ -32,13 +32,13 @@ module Decidim
           @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)
+                                            .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
+            grouped_answers[group_key][:quantity] += answers.where(decidim_forms_answers: { created_at: start_time.. }).count
           end
           @query
         end

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

@@ -17,11 +17,11 @@ module Decidim
 
           answers = Decidim::Forms::Answer.joins(:questionnaire)
                                           .where(questionnaire: questionnaires)
-                                          .where("decidim_forms_answers.created_at <= ?", end_time)
+                                          .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
+            quantity_users: answers.where(decidim_forms_answers: { created_at: start_time.. }).pluck(:decidim_user_id).uniq
           }
         end
       end

data/app/views/decidim/surveys/admin/answers/index.html.erb

@@ -0,0 +1,49 @@
+<div class="card" id="answers">
+  <div class="item_show__header">
+    <h1 class="item_show__header-title">
+      <%= t ".title", total: @total %>
+      <%= link_to t("actions.back", scope: "decidim.forms.admin.questionnaires"), questionnaire_url, class: "button button__sm button__secondary new" %>
+    </h1>
+  </div>
+  <div class="table-scroll">
+    <table class="table-list">
+      <thead>
+        <tr>
+          <th>#</th>
+          <th><%= first_table_th(@participants.first) %></th>
+          <th><%= t("user_status", scope: "decidim.forms.user_answers_serializer") %></th>
+          <th><%= t("ip_hash", scope: "decidim.forms.user_answers_serializer") %></th>
+          <th><%= t("completion", scope: "decidim.forms.user_answers_serializer") %></th>
+          <th><%= t("created_at", scope: "decidim.forms.user_answers_serializer") %></th>
+          <th></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @participants.each_with_index do |participant, idx| %>
+          <tr>
+            <td><%= idx + 1 + page_offset %></td>
+            <td>
+              <% if allowed_to? :show, :questionnaire_answers %>
+                <%= link_to first_table_td(participant), questionnaire_participant_answers_url(participant.session_token) %>
+              <% else %>
+                <%= first_table_td(participant) %></td>
+              <% end %>
+            <td><%= participant.status %></td>
+            <td><%= participant.ip_hash %></td>
+            <td><%= display_percentage(participant.completion) %></td>
+            <td><%= l participant.answered_at, format: :short %></td>
+            <td class="table-list__actions">
+              <% if allowed_to? :show, :questionnaire_answers %>
+                <%= icon_link_to "eye-line", questionnaire_participant_answers_url(participant.session_token), t("actions.show", scope: "decidim.forms.admin.questionnaires.answers"), class: "action-icon--eye", target: "_blank", data: { "external-link": false } %>
+              <% end %>
+              <% if allowed_to? :export_response, :questionnaire_answers %>
+                <%= icon_link_to "download-line", questionnaire_export_response_url(participant.session_token), t("actions.export", scope: "decidim.forms.admin.questionnaires.answers"), class: "action-icon--data-transfer-download" %>
+              <% end %>
+            </td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+<%= decidim_paginate @query %>