decidim-survey_results 0.0.2

data/README.md

@@ -0,0 +1,30 @@
+# Decidim::SurveyResults
+
+This module enables the admins to show survey results to participants through a new survey results page.
+WARNING: This module is in Beta, use it at your own risk.
+
+## Usage
+
+SurveyResults will be available as a Component for a Participatory Space.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "decidim-survey_results"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+
+This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+desc "Generates a dummy app for testing"
+task test_app: "decidim:generate_external_test_app"
+
+desc "Generates a development app."
+task development_app: "decidim:generate_external_development_app"

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # 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
+      end
+    end
+  end
+end

data/app/controllers/decidim/survey_results/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Components::BaseController
+    end
+  end
+end

data/app/controllers/decidim/survey_results/survey_results_controller.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    class SurveyResultsController < ApplicationController
+      include Decidim::ApplicationHelper
+      include Decidim::SurveyResults::SurveyResultsHelper
+
+      def show
+        @full_questionnaire = FullQuestionnaire.new(questionnaire)
+      end
+
+      def current_component
+        @current_component ||= Decidim::Component.find(params[:component_id])
+      end
+
+      def current_participatory_space
+        @current_participatory_space ||= current_component.participatory_space
+      end
+
+      private
+
+      def survey
+         @survey ||= ::Decidim::Surveys::Survey.find_by(component: current_component)
+      end
+
+      def questionnaire
+         @questionnaire ||= ::Decidim::Forms::Questionnaire.find_by(questionnaire_for: survey)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    # Custom helpers, scoped to the survey_results engine.
+    #
+    module ApplicationHelper
+    end
+  end
+end

data/app/helpers/decidim/survey_results/survey_results_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    module SurveyResultsHelper
+
+      def render_question_results(full_questionnaire, question)
+        if question.question_type == "title_and_description"
+          render partial: question.question_type, locals: { question: question }
+        else
+          results= Results.for(full_questionnaire, question)
+          render partial: results.partial_name, locals: {
+            full_questionnaire:,
+            results:,
+            labels: results.x_labels,
+            datasets: results.datasets
+          }
+        end
+      end
+
+      def conditioned_question?(question)
+        Decidim::Forms::DisplayCondition.where(decidim_question_id: question).present?
+      end
+
+      def title_and_description_question?(question)
+        question.question_type == "title_and_description"
+      end
+    end
+  end
+end

data/app/models/decidim/survey_results/application_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/survey_results/files_question_results.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    class FilesQuestionResults < Results
+
+      def initialize(full_questionnaire, question)
+        super(full_questionnaire, question, "files_question_results")
+      end
+
+      def compute_results
+        data= {
+          labels: [
+            I18n.t("survey_results.question_results.answered"),
+            I18n.t("survey_results.question_results.not_answered")
+          ],
+          datasets: [
+            {data: [answered_count, not_answered_count]}
+          ]
+        }
+      end
+
+      def answered_percentage
+        (total_answers_files_count[:with_attachments] * 100)/full_questionnaire.total_participants
+      end
+
+      def not_answered_percentage
+        (total_answers_files_count[:without_attachments] * 100)/full_questionnaire.total_participants
+      end
+
+      def answered_count
+        total_answers_files_count[:with_attachments]
+      end
+
+      def not_answered_count
+        total_answers_files_count[:without_attachments]
+      end
+
+      def total_answers_files_count
+        total_answers_files_count||= begin
+          
+          total_answers_files = {
+            with_attachments: 0,
+            without_attachments: 0
+          }
+          
+          full_questionnaire.answers.where(question: question).each do |answer|
+            if answer.attachments.present?
+              total_answers_files[:with_attachments] += 1
+            else
+              total_answers_files[:without_attachments] += 1
+            end
+          end
+
+          total_answers_files
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/survey_results/full_questionnaire.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    class FullQuestionnaire
+
+      delegate :title, to: :questionnaire
+
+      def initialize(questionnaire)
+        @questionnaire= questionnaire
+      end
+
+      def questionnaire
+        @questionnaire
+      end
+
+      def questions
+        @questions ||= Decidim::Forms::Question.includes([:matrix_rows, :answer_options]).where(questionnaire: questionnaire).order(:position, :id)
+      end
+
+      def pages
+        pages = []
+        current_page = []
+        pages << current_page
+
+        questions.each do |question|
+          if question.question_type != "separator"
+            current_page << question
+          else
+            current_page = []
+            pages << current_page
+          end
+        end
+
+        pages
+      end
+
+      def participants
+        @participants ||= ::Decidim::Forms::QuestionnaireParticipants.new(questionnaire).participants
+      end
+
+      def answers
+        @answers ||= Decidim::Forms::Answer.not_separator
+                           .not_title_and_description
+                           .joins(:question)
+                           .where(questionnaire: questionnaire)
+      end
+
+      def total_participants
+        @total_participants||= participants.count
+      end
+    end
+  end
+end

data/app/models/decidim/survey_results/matrix_question_results.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    class MatrixQuestionResults < Results
+
+      def initialize(full_questionnaire, question)
+        super(full_questionnaire, question, "matrix_question_results")
+      end
+
+      #-----------------------------------------------
+
+      private
+
+      #-----------------------------------------------
+
+      # labels: data_rows body
+      # datasets: An array of hashes with two fields, label and data.
+      # Each dataset contains the results of a column in its `data` field.
+      # This is, each dataset contains and array with the count of
+      # choices on each row of the column.
+      #
+      # For example, dataset data for column A: [
+      #  1, <- one user voted A on row 1
+      #  5, <- five users voted A on row 2
+      #  3, <- three users voted A on row 3
+      # ]
+      #
+      # NOTE: Correspondence between Decidim models and the matrix
+      # question.answer_options -> columns
+      # question.matrix_rows -> rows
+      # answers -> each is a user response to a question
+      # Answer has many choices (AnswerChoices)
+      #
+      # See the chart expected data here:
+      # https://www.chartjs.org/docs/latest/samples/bar/floating.html
+      def compute_results
+        user_question_answers= full_questionnaire.answers
+        choices_sums= Decidim::Forms::AnswerChoice.where("decidim_answer_id IN (#{user_question_answers.select(:id).where(question: question).to_sql})").group(:decidim_question_matrix_row_id, :decidim_answer_option_id).count
+
+        # labels: appear at the x axis
+        # datasets: one dataset for the columns of each row
+        data= {
+          labels: question.matrix_rows.map {|r| translated_attribute(r.body) },
+          datasets: []
+        }
+        question.answer_options.each do |answer_option|
+          dataset = {data: []}
+          dataset[:label]= translated_attribute(answer_option.body)
+          question.matrix_rows.each do |row|
+            key= [row.id, answer_option.id]
+            dataset[:data] << (choices_sums[key] || 0)
+          end
+          data[:datasets] << dataset
+        end
+
+        data
+      end
+    end
+  end
+end

data/app/models/decidim/survey_results/options_question_results.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    class OptionsQuestionResults < Results
+
+      def initialize(full_questionnaire, question)
+        super(full_questionnaire, question, "options_question_results")
+      end
+
+      #-----------------------------------------------
+
+      private
+
+      #-----------------------------------------------
+
+      # labels: each anwer_option/column is a label.
+      # datasets: Returns only one dataset with the results of each column.
+      def compute_results
+        user_question_answers= full_questionnaire.answers
+        choices_sums= Decidim::Forms::AnswerChoice.where("decidim_answer_id IN (#{user_question_answers.select(:id).where(question: question).to_sql})").group(:decidim_answer_option_id).count
+
+        x_labels = []
+        dataset = {label: I18n.t("survey_results.question_results.number_of_votes"), data: []}
+        question.answer_options.map do |answer_option|
+          x_labels << translated_attribute(answer_option.body)
+
+          dataset[:data] << (choices_sums[answer_option.id] || 0)
+        end
+
+        { labels: x_labels, datasets: [dataset] }
+      end
+    end
+  end
+end

data/app/models/decidim/survey_results/results.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    class Results
+      include Decidim::TranslatableAttributes
+
+      def self.for(full_questionnaire, question)
+        case question.question_type
+        when 'single_option', 'multiple_option'
+          OptionsQuestionResults.new(full_questionnaire, question)
+        when 'short_answer', 'long_answer'
+          TextQuestionResults.new(full_questionnaire, question)
+        when "files"
+          FilesQuestionResults.new(full_questionnaire, question)
+        when "matrix_single"
+          MatrixQuestionResults.new(full_questionnaire, question)
+        when "matrix_multiple"
+          MatrixQuestionResults.new(full_questionnaire, question)
+        when "sorting"
+          SortingQuestionResults.new(full_questionnaire, question)
+        when "separator"
+          SeparatorQuestionResults.new(full_questionnaire, question)
+        end
+      end
+
+      def initialize(full_questionnaire, question, partial_name)
+        @full_questionnaire= full_questionnaire
+        @question= question
+        @partial_name= partial_name
+      end
+
+      attr_reader :question, :partial_name
+      attr :full_questionnaire
+      delegate :question_type, to: :question
+
+      def x_labels
+        results[:labels]
+      end
+
+      def datasets
+        results[:datasets]
+      end
+
+      # A Hash with the labels and datasets resulting from the current Question.
+      # In the format expected by Charts.js in the `data` json field.
+      #
+      # labels: main labels of the chart.
+      # datasets: data to be plotted.
+      def results
+        @results||= compute_results
+      end
+
+      def compute_results
+        fail NotImplementedError, "To be implemented by subclasses"
+      end
+
+      def total_answers
+        @total_answers||= full_questionnaire.answers.where(question: question).count
+      end
+
+      def answers_percentage(data)
+        return 0 if total_answers == 0
+        (data * 100)/total_answers
+      end
+    end
+  end
+end

data/app/models/decidim/survey_results/separator_question_results.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    class SeparatorQuestionResults < Results
+
+      def initialize(full_questionnaire, question)
+        super(full_questionnaire, question, "separator_question_results")
+      end
+
+      def compute_results
+        {}
+      end
+    end
+  end
+end

data/app/models/decidim/survey_results/sorting_question_results.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    class SortingQuestionResults < Results
+
+      def initialize(full_questionnaire, question)
+        super(full_questionnaire, question, "sorting_question_results")
+      end
+
+      #---------------------------------------------------------------
+
+      private
+
+      #---------------------------------------------------------------
+
+      # labels: I18n position names, same number as available options to order.
+      # datasets: Each dataset is an Array where each item is the number of choices for the given option in that position.
+      def compute_results
+        user_question_answers= full_questionnaire.answers
+        choices_sums= Decidim::Forms::AnswerChoice.where("decidim_answer_id IN (#{user_question_answers.select(:id).where(question: question).to_sql})").group(:decidim_answer_option_id, :position).count
+
+        labels= []
+        datasets= []
+        positions= 0...question.answer_options.size
+        question.answer_options.each_with_index do |answer_option, idx|
+          position= idx + 1
+          labels << I18n.t("survey_results.question_results.position", position: position)
+
+          values= positions.map {|n| choices_sums[[answer_option.id, n]] || 0}
+          datasets << {label: translated_attribute(answer_option.body), data: values}
+        end
+
+        {labels: labels, datasets: datasets}
+      end
+
+      def sorting_question(question)
+        positions = question.answer_options.count
+        values = []
+        all_data = []
+
+        counts = []
+        question.answer_options.map do |answer_option|
+          values << translated_attribute(answer_option.body)
+ 
+          answers.where(question: question).each do |answer|
+            positions_count = []
+            positions.times do |position|
+              positions_count << {position: position, position_count: 0}
+            end
+
+            
+            choice = answer.choices.find_by(decidim_answer_option_id: answer_option.id)
+            position_choice = choice.position
+            data = {choice: answer_option.id, positions_count: positions_count}
+          
+            positions.times do |position|
+              if position_choice == position
+                data[:positions_count][position][:position_count] += 1
+              end
+            end
+            all_data << data
+          end
+        end
+
+        { positions: positions, values: values, data: data }
+      end
+
+    end
+  end
+end

data/app/models/decidim/survey_results/text_question_results.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SurveyResults
+    class TextQuestionResults < Results
+
+      def initialize(full_questionnaire, question)
+        super(full_questionnaire, question, "text_question_results")
+      end
+
+      def answered_count
+        @answered_count ||= @full_questionnaire.answers.where(question: @question).where.not(body: "").count
+      end
+
+      def not_answered_count
+        @not_answered_count||= full_questionnaire.total_participants - answered_count
+      end
+
+      def answered_percentage
+        @answered_percentage||= begin
+          if full_questionnaire.total_participants > 0
+            (answered_count * 100)/full_questionnaire.total_participants
+          else
+            0
+          end
+        end
+      end
+
+      def not_answered_percentage
+        @not_answered_percentage||= begin
+          if full_questionnaire.total_participants > 0
+            ((full_questionnaire.total_participants - answered_count) * 100)/full_questionnaire.total_participants
+          else
+            0
+          end
+        end
+      end
+
+
+      #--------------------------------------------
+
+      private
+
+      #--------------------------------------------
+
+      # labels: Corresponding translation for "Answered" and "Not Answered"
+      # datasets: Returns only one dataset with the results of each column.
+      def compute_results
+        data= {
+          labels: [
+            I18n.t("survey_results.question_results.answered"),
+            I18n.t("survey_results.question_results.not_answered")
+          ],
+          datasets: [
+            {data: [answered_count, not_answered_count]}
+          ]
+        }
+      end
+    end
+  end
+end

data/app/overrides/decidim/forms/questionnaires/questionnaire_show.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Deface::Override.new(virtual_path: "decidim/forms/questionnaires/show",
+  name: "add_button_to_questionnaire_answers",
+  original: "f2fe5ee7066f632fb4a930c922c680ddfbdc1520",
+  insert_after: "div.card",
+  text: "
+    <%= link_to I18n.t('survey_results.questionnaire_show.see_results'), decidim_survey_results.survey_results_path(component_id: current_component.id) %>
+  ")

data/app/packs/entrypoints/decidim_survey_results.js

@@ -0,0 +1,6 @@
+import "src/decidim/survey_results/application.js";
+
+// Images
+require.context("../images", true)
+
+import "entrypoints/decidim_survey_results.scss"

data/app/packs/entrypoints/decidim_survey_results.scss

@@ -0,0 +1 @@
+@import "stylesheets/decidim/survey_results/survey_results";

data/app/packs/images/decidim/survey_results/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 35 35"><path d="M17.5 35A17.5 17.5 0 1 1 35 17.5 17.52 17.52 0 0 1 17.5 35zm0-33.06A15.56 15.56 0 1 0 33.06 17.5 15.57 15.57 0 0 0 17.5 1.94zm9.5 13.7H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zm0 3.68H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zM22.26 23H8a1 1 0 0 1 0-1.94h14.26a1 1 0 0 1 0 1.94z"/></svg>

data/app/packs/src/decidim/survey_results/application.js

@@ -0,0 +1,2 @@
+import "../survey_results/chart_helper.js";
+import "../survey_results/charts.js";

data/app/packs/src/decidim/survey_results/chart_helper.js

@@ -0,0 +1,24 @@
+export function normalizeLabels(labels) {
+  labels.forEach((label, index) => {
+    if (label.length > 28) {
+      let newLabel = splitLargeLabel(label);
+      labels[index] = newLabel
+    }
+  })
+
+  return labels;
+};
+
+function splitLargeLabel(label) {
+  let middle = Math.floor(label.length / 2);
+  let before = label.lastIndexOf(' ', middle);
+  let after = label.indexOf(' ', middle + 1);
+
+  if (middle - before < after - middle) {
+    middle = before;
+  } else {
+    middle = after;
+  }
+
+  return [label.substr(0, middle), label.substr(middle + 1)];
+}