decidim-demographics 0.31.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2572bda270734d954964af2fc083221aa83af70d7455b5527a865a969b71f7e7
+  data.tar.gz: 604ec62cd5b07aa7ac8539f9a9d21e988eb3e7e4d49a194c0decae258038a93f
+SHA512:
+  metadata.gz: 917f79eef27f12df2f0962e76d1dc8d54ac9fce118279b276dbf287f505da9172c560e0ae245360715055be6e7eccaf5a58cb05b089bae601811e51063be400a
+  data.tar.gz: 83f708b0437594f145095e68a8bbffc2c5b31a17f307953661f197e5ab97351c152b6d48ca70122ed21ab7099deda62030a11012cbd8a2000adc0451c0533dea

data/README.md

@@ -0,0 +1,26 @@
+# Decidim::Demographics
+
+The demographic data module allows participants to voluntarily donate their demographic information for statistical purposes. The collected data will be anonymized, aggregated, and visualized in compliance with GDPR regulations. This feature aims to enhance the understanding of participant demographics while ensuring transparency and data privacy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "decidim-demographics"
+```
+
+And then execute:
+
+```bash
+bundle
+bin/rails decidim_demographics:install:migrations
+```
+
+## 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,3 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"

data/app/commands/decidim/demographics/admin/update_demographics_settings.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    module Admin
+      class UpdateDemographicsSettings < Decidim::Command
+        # Initializes an UpdateDemographicsSettings Command.
+        #
+        # @param form - The form from which to get the data.
+        def initialize(form)
+          @form = form
+        end
+
+        attr_reader :form
+
+        delegate :current_organization, to: :form
+        delegate :current_user, to: :form
+
+        # Updates the demographic data if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          Decidim.traceability.perform_action!("update", demographic, current_user) do
+            update_demographic_settings
+          end
+
+          broadcast(:ok)
+        rescue ActiveRecord::RecordInvalid
+          broadcast(:invalid)
+        end
+
+        private
+
+        def demographic
+          @demographic ||= Decidim::Demographics::Demographic.where(organization: current_organization).first_or_create!
+        end
+
+        def update_demographic_settings
+          demographic.update!(collect_data: form.collect_data)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/demographics/delete_demographic_data.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    class DeleteDemographicData < Decidim::Command
+      # Initializes a DeleteDemographicData Command.
+      #
+      # @param questionnaire [Decidim::Forms::Questionnaire] The questionnaire containing demographic data
+      # @param user [Decidim::User] The user whose demographic data should be deleted
+      def initialize(questionnaire, user)
+        @questionnaire = questionnaire
+        @user = user
+      end
+
+      def call
+        @questionnaire.responses.where(user: @user).destroy_all
+
+        broadcast(:ok)
+      rescue ActiveRecord::RecordInvalid
+        broadcast(:invalid)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::ApplicationController`, which
+      # overrides its layout and provides all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::ApplicationController
+        register_permissions(::Decidim::Demographics::Admin::ApplicationController,
+                             ::Decidim::Demographics::Admin::Permissions,
+                             ::Decidim::Admin::Permissions)
+
+        layout "decidim/admin/insights"
+
+        add_breadcrumb_item_from_menu :admin_settings_menu
+
+        private
+
+        def questionnaire
+          @questionnaire ||= Decidim::Forms::Questionnaire.where(questionnaire_for:).first_or_create
+          @questionnaire.override_edit!
+          @questionnaire
+        end
+
+        def questionnaire_for
+          demographic
+        end
+
+        def permission_class_chain
+          ::Decidim.permissions_registry.chain_for(::Decidim::Demographics::Admin::ApplicationController)
+        end
+
+        def demographic
+          @demographic ||= Decidim::Demographics::Demographic.where(organization: current_organization).first_or_create!
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/demographics/admin/publish_responses_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    module Admin
+      # Mind that even though the name of the controller, currently we do not allow the publication.
+      # This is only for showing to the admin the visualization of the responses
+      class PublishResponsesController < Admin::ApplicationController
+        include Decidim::Forms::Admin::Concerns::HasQuestionnaireResponsesUrlHelper
+
+        helper PublishResponsesHelper
+        helper_method :questionnaire_for, :questionnaire
+
+        def index
+          enforce_permission_to(:index, :demographics)
+        end
+
+        def questionnaire_url
+          responses_path
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/demographics/admin/questions_controller.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    module Admin
+      class QuestionsController < Admin::ApplicationController
+        include Decidim::Forms::Admin::Concerns::HasQuestionnaire
+        include Decidim::Forms::Admin::Concerns::HasQuestionnaireResponsesUrlHelper
+
+        def edit_questions_template = "decidim/demographics/admin/questions/edit"
+
+        def after_update_url = edit_questions_questions_path
+
+        def questionnaire_participants_url = decidim_admin_demographics.responses_path
+
+        def update_url = update_questions_questions_path
+
+        def response_options_url(_params) = decidim_admin_demographics.responses_path
+
+        def questionnaire
+          @questionnaire ||= Decidim::Forms::Questionnaire.where(questionnaire_for:).first_or_initialize
+          @questionnaire.override_edit!
+          Decidim::Demographics.create_default_questionnaire!(@questionnaire)
+          @questionnaire
+        end
+
+        def questionnaire_for = demographic
+
+        def edit_questionnaire_title = t(:title, scope: "decidim.demographics.admin.questions.edit")
+      end
+    end
+  end
+end

data/app/controllers/decidim/demographics/admin/responses_controller.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    module Admin
+      class ResponsesController < Admin::ApplicationController
+        include Decidim::Forms::Admin::Concerns::HasQuestionnaireResponses
+        helper_method :questionnaire_for, :questionnaire
+
+        def index
+          enforce_permission_to :index, permission_subject
+
+          @query = paginate(collection)
+          @participants = participants(@query)
+          @total = questionnaire.count_participants
+          @survey = questionnaire_for
+
+          render template: "decidim/demographics/admin/responses/index"
+        end
+
+        def permission_subject = :demographics_responses
+
+        def questionnaire_for = demographic
+
+        def questionnaire_export_response_url(id) = export_response_response_path(id:)
+
+        def questionnaire_url = edit_questions_questions_path
+
+        # Specify where to redirect after exporting a user response
+        def questionnaire_participant_responses_url(id) = response_path(id:)
+
+        def questionnaire_participants_url = decidim_admin_demographics.responses_path
+      end
+    end
+  end
+end

data/app/controllers/decidim/demographics/admin/settings_controller.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    module Admin
+      class SettingsController < Decidim::Demographics::Admin::ApplicationController
+        def show
+          enforce_permission_to(:update, :demographics)
+
+          @form = form(Admin::DemographicsSettingsForm).from_model(demographic)
+        end
+
+        def update
+          enforce_permission_to(:update, :demographics)
+
+          @form = form(Admin::DemographicsSettingsForm).from_params(params)
+
+          Admin::UpdateDemographicsSettings.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("update.success", scope: "decidim.demographics.admin.settings")
+              redirect_to decidim_admin_demographics.settings_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("update.invalid", scope: "decidim.demographics.admin.settings")
+              render action: "edit", status: :unprocessable_entity
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    class ApplicationController < Decidim::ApplicationController
+      include FormFactory
+      register_permissions(::Decidim::Demographics::ApplicationController,
+                           ::Decidim::Demographics::Permissions,
+                           ::Decidim::Admin::Permissions,
+                           ::Decidim::Permissions)
+
+      def permission_class_chain
+        ::Decidim.permissions_registry.chain_for(::Decidim::Demographics::ApplicationController)
+      end
+    end
+  end
+end

data/app/controllers/decidim/demographics/demographics_controller.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    class DemographicsController < Decidim::Demographics::ApplicationController
+      include Decidim::Forms::Concerns::HasQuestionnaire
+      include Decidim::UserProfile
+
+      helper_method :allow_editing_responses?, :demographic
+
+      def show
+        @form = form(Decidim::Forms::QuestionnaireForm).from_model(questionnaire)
+        @form.add_responses!(questionnaire:, session_token:, ip_hash:)
+        @form.allow_editing_responses = true
+
+        render template:
+      end
+
+      def destroy
+        DeleteDemographicData.call(questionnaire, current_user) do
+          on(:ok) do
+            flash[:notice] = I18n.t("destroy.success", scope: "decidim.demographics")
+            redirect_to demographics_engine.demographics_path
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("destroy.error", scope: "decidim.demographics")
+            redirect_to demographics_engine.demographics_path
+          end
+        end
+      end
+
+      def template
+        "decidim/demographics/demographics/show"
+      end
+
+      private
+
+      def after_response_path = demographics_path
+
+      def form_path = demographics_path
+
+      def update_url = respond_demographics_path
+
+      def allow_responses?
+        demographic.collect_data?
+      end
+
+      def allow_editing_responses?
+        demographic.collect_data?
+      end
+
+      def questionnaire_for = demographic
+
+      def demographic
+        @demographic ||= Decidim::Demographics::Demographic.where(organization: current_organization).first_or_create!
+      end
+
+      def enforce_permission_to_respond_questionnaire
+        enforce_permission_to :respond, :demographics
+      end
+
+      def questionnaire
+        @questionnaire ||= Decidim::Forms::Questionnaire.where(questionnaire_for:).first_or_initialize
+        Decidim::Demographics.create_default_questionnaire!(@questionnaire)
+        @questionnaire
+      end
+    end
+  end
+end

data/app/forms/decidim/demographics/admin/demographics_settings_form.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    module Admin
+      class DemographicsSettingsForm < Decidim::Form
+        attribute :collect_data, Boolean
+      end
+    end
+  end
+end

data/app/helpers/decidim/demographics/publish_responses_helper.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    module PublishResponsesHelper
+      def question_response_is_publicable(question_type)
+        ignored_question_types = %w(short_response long_response 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(responses: { choices: [:response_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
+
+      def options_column_chart_wrapper(question)
+        tally = question.responses.map { |response| response.choices.map { |choice| translated_attribute(choice.response_option.body) } }.tally
+
+        column_chart(tally, download: true)
+      end
+
+      def colors_list
+        %w(
+          #3366CC
+          #DC3912
+          #FF9900
+          #109618
+          #3B3EAC
+          #0099C6
+          #DD4477
+          #66AA00
+          #B82E2E
+          #316395
+        )
+      end
+
+      private
+
+      def matrix_stack_chart_wrapper(question)
+        counts = Hash.new { |hash, key| hash[key] = Hash.new(0) }
+
+        question.responses.each do |response|
+          response.choices.each do |choice|
+            name = translated_attribute(choice.response_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 sorting_stack_chart_wrapper(question)
+        counts = Hash.new { |hash, key| hash[key] = Hash.new(0) }
+
+        question.responses.each do |response|
+          response.choices.each do |choice|
+            name = translated_attribute(choice.response_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
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    # 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/demographics/demographic.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    class Demographic < ApplicationRecord
+      belongs_to :organization, foreign_key: :decidim_organization_id, class_name: "Decidim::Organization"
+    end
+  end
+end

data/app/packs/entrypoints/decidim_demographics.js

@@ -0,0 +1 @@
+import "stylesheets/decidim/demographics/demographics.scss"

data/app/packs/stylesheets/decidim/demographics/demographics.scss

@@ -0,0 +1,37 @@
+.demographic {
+  .response-questionnaire {
+    @apply border-t-0 border-background pt-8;
+
+    &__question-label {
+      @apply before:hidden;
+    }
+
+    &__step {
+      @apply space-y-6;
+    }
+
+    &__footer {
+      @apply flex flex-col gap-6 pt-6 border-t-2 border-background text-gray-2 only:border-t-0;
+    }
+
+    /* text-like inputs */
+    input[type="date"],
+    input[type="datetime-local"],
+    input[type="email"],
+    input[type="month"],
+    input[type="number"],
+    input[type="password"],
+    input[type="search"],
+    input[type="tel"],
+    input[type="text"],
+    input[type="time"],
+    input[type="url"],
+    input[type="week"],
+    select,
+    textarea {
+      &:not(.reset-defaults) {
+        @apply border border-gray;
+      }
+    }
+  }
+}

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    module Admin
+      class Permissions < Decidim::DefaultPermissions
+        def permissions
+          return permission_action unless user
+          return permission_action unless permission_action.scope == :admin
+
+          toggle_allow(user.admin?) if permission_action.subject == :demographics && permission_action.action == :index
+          toggle_allow(user.admin?) if permission_action.subject == :demographics && permission_action.action == :update
+          toggle_allow(user.admin?) if permission_action.subject == :demographics_responses && permission_action.action == :index
+          toggle_allow(user.admin?) if permission_action.subject == :demographics_responses && permission_action.action == :show
+          toggle_allow(user.admin?) if permission_action.subject == :demographics_responses && permission_action.action == :export_response
+
+          permission_action
+        end
+      end
+    end
+  end
+end

data/app/permissions/decidim/demographics/permissions.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Demographics
+    class Permissions < Decidim::DefaultPermissions
+      def permissions
+        return permission_action unless user
+        return permission_action unless permission_action.scope == :public
+        return permission_action unless permission_action.subject == :demographics
+
+        toggle_allow(demographic.collect_data?) if permission_action.action == :respond
+
+        permission_action
+      end
+
+      private
+
+      def demographic
+        @demographic ||= Decidim::Demographics::Demographic.where(organization: user.organization).first_or_initialize
+      end
+    end
+  end
+end

data/app/views/decidim/demographics/admin/demographics/_tabs_menu.html.erb

@@ -0,0 +1,15 @@
+<% add_decidim_page_title(t("decidim.demographics.admin.demographics.tabs_menu.title")) %>
+
+<div class="item_show__header">
+  <h1 class="item_show__header-title">
+    <%= t(".title") %>
+  </h1>
+</div>
+
+<div class="flex justify-between">
+  <div class="w-2/3">
+    <%= admin_tabs(:admin_demographics_menu).render %>
+  </div>
+
+  <%= yield if block_given? %>
+</div>

data/app/views/decidim/demographics/admin/publish_responses/index.html.erb

@@ -0,0 +1,36 @@
+<% add_decidim_page_title(t(".title")) %>
+
+<%= render "decidim/demographics/admin/demographics/tabs_menu" do %>
+    <%= link_to t("actions.back", scope: "decidim.forms.admin.questionnaires"), questionnaire_url, class: "main-tabs-menu__cta-button" %>
+<% end %>
+
+<h1 class="item_show__header-title">
+  <%= t(".description") %>
+</h1>
+
+<hr class="border-b border-t-0 border-gray mb-8 pb-4">
+
+<div class="item__edit item__edit-1col">
+  <div class="item__edit-form">
+    <ol class="list-decimal list-inside">
+      <% questionnaire.questions.each do |question| %>
+        <% next if question.question_type == "separator" %>
+        <% next if question.question_type == "title_and_description" %>
+
+        <li class="<%= "text-gray" unless question_response_is_publicable(question.question_type) %> mb-6">
+          <div class="inline">
+            <span><%= translated_attribute question.body %> (<%= I18n.t("decidim.surveys.admin.publish_responses.index.responses", count: question.responses.count) %>)</span>
+          </div>
+
+          <% if question_response_is_publicable(question.question_type) %>
+            <div class="m-4">
+              <%= chart_for_question(question.id) %>
+            </div>
+          <% end %>
+        </li>
+      <% end %>
+    </ol>
+  </div>
+</div>
+
+<%= append_javascript_pack_tag "decidim_forms_admin" %>