decidim-extra_user_fields 0.24.3

data/README.md

@@ -0,0 +1,27 @@
+# Decidim::ExtraUserFields
+
+* Allows to collect and manage some extra user fields on registration and profile edition.
+* Adds a link in admin participants panel to download users of organization in several formats.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+For Decidim 0.24:
+```ruby
+gem "decidim-extra_user_fields", git: "https://github.com/PopulateTools/decidim-module-extra_user_fields", branch: "release/0.24-stable"
+```
+
+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/assets/images/decidim/extra_user_fields/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/commands/concerns/decidim/extra_user_fields/commands_overrides.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module ExtraUserFields
+    # Changes in methods to store extra fields in user profile
+    module CommandsOverrides
+      extend ActiveSupport::Concern
+
+      private
+
+      def create_user
+        @user = User.create!(
+          email: @form.email,
+          name: @form.name,
+          nickname: @form.nickname,
+          password: @form.password,
+          password_confirmation: @form.password_confirmation,
+          organization: @form.current_organization,
+          tos_agreement: @form.tos_agreement,
+          newsletter_notifications_at: @form.newsletter_at,
+          email_on_notification: true,
+          accepted_tos_version: @form.current_organization.tos_version,
+          locale: @form.current_locale,
+          extended_data: extended_data
+        )
+      end
+
+      def update_personal_data
+        @user.name = @form.name
+        @user.nickname = @form.nickname
+        @user.email = @form.email
+        @user.personal_url = @form.personal_url
+        @user.about = @form.about
+        @user.extended_data = extended_data
+      end
+
+      def extended_data
+        @extended_data ||= (@user&.extended_data || {}).merge(
+          country: @form.country,
+          postal_code: @form.postal_code,
+          date_of_birth: @form.date_of_birth,
+          gender: @form.gender
+        )
+      end
+    end
+  end
+end

data/app/commands/concerns/decidim/extra_user_fields/omniauth_commands_overrides.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module ExtraUserFields
+    # Changes in methods to store extra fields in user profile
+    module OmniauthCommandsOverrides
+      extend ActiveSupport::Concern
+
+      private
+
+      def create_or_find_user
+        generated_password = SecureRandom.hex
+
+        @user = User.find_or_initialize_by(
+          email: verified_email,
+          organization: organization
+        )
+
+        if @user.persisted?
+          # If user has left the account unconfirmed and later on decides to sign
+          # in with omniauth with an already verified account, the account needs
+          # to be marked confirmed.
+          @user.skip_confirmation! if !@user.confirmed? && @user.email == verified_email
+        else
+          @user.email = (verified_email || form.email)
+          @user.name = form.name
+          @user.nickname = form.normalized_nickname
+          @user.newsletter_notifications_at = nil
+          @user.email_on_notification = true
+          @user.password = generated_password
+          @user.password_confirmation = generated_password
+          @user.remote_avatar_url = form.avatar_url if form.avatar_url.present?
+          @user.skip_confirmation! if verified_email
+        end
+
+        @user.tos_agreement = "1"
+        @user.extended_data = extended_data
+        @user.save!
+      end
+
+      def extended_data
+        @extended_data ||= (@user&.extended_data || {}).merge(
+          country: form.country,
+          postal_code: form.postal_code,
+          date_of_birth: form.date_of_birth,
+          gender: form.gender
+        )
+      end
+    end
+  end
+end

data/app/commands/decidim/extra_user_fields/admin/export_users.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ExtraUserFields
+    module Admin
+      # Command to export organization users from the participants admin panel.
+      class ExportUsers < Rectify::Command
+        # format - a string representing the export format
+        # current_user - the user performing the action
+        def initialize(format, current_user)
+          @format = format
+          @current_user = current_user
+        end
+
+        # Exports the current organization not deleted users.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          broadcast(:ok, export_data)
+        end
+
+        private
+
+        attr_reader :current_user, :format
+
+        def export_data
+          Decidim.traceability.perform_action!(
+            :export_users,
+            current_organization,
+            current_user
+          ) do
+            Decidim::Exporters
+              .find_exporter(format)
+              .new(collection, Decidim::ExtraUserFields::UserExportSerializer)
+              .export
+          end
+        end
+
+        def collection
+          current_organization.users.not_deleted
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ExtraUserFields
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      class ApplicationController < Decidim::Admin::ApplicationController
+      end
+    end
+  end
+end

data/app/controllers/decidim/extra_user_fields/admin/extra_user_fields_controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ExtraUserFields
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      class ExtraUserFieldsController < Admin::ApplicationController
+        def export_users
+          enforce_permission_to :read, :officialization
+
+          ExportUsers.call(params[:format], current_user) do
+            on(:ok) do |export_data|
+              send_data export_data.read, type: "text/#{export_data.extension}", filename: export_data.filename("participants")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/forms/concerns/decidim/extra_user_fields/forms_definitions.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module ExtraUserFields
+    # Extra user fields definitions for forms
+    module FormsDefinitions
+      extend ActiveSupport::Concern
+
+      included do
+        include ::Decidim::ExtraUserFields::ApplicationHelper
+
+        attribute :country, String
+        attribute :postal_code, String
+        attribute :date_of_birth, Decidim::Attributes::LocalizedDate
+        attribute :gender, String
+
+        validates :country, presence: true
+        validates :postal_code, presence: true
+        validates :date_of_birth, presence: true
+        validates :gender, presence: true
+      end
+
+      def map_model(model)
+        extended_data = model.extended_data.with_indifferent_access
+
+        self.country = extended_data[:country]
+        self.postal_code = extended_data[:postal_code]
+        self.date_of_birth = Date.parse(extended_data[:date_of_birth]) if extended_data[:date_of_birth].present?
+        self.gender = extended_data[:gender]
+      end
+    end
+  end
+end

data/app/helpers/decidim/extra_user_fields/admin/application_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ExtraUserFields
+    module Admin
+      # Custom helpers, scoped to the meetings admin engine.
+      #
+      module ApplicationHelper
+        def extra_user_fields_export_users_dropdown
+          content_tag(:ul, class: "vertical menu add-components") do
+            Decidim::ExtraUserFields::AdminEngine::DEFAULT_EXPORT_FORMATS.map do |format|
+              content_tag(:li, class: "exports--format--#{format.downcase} export--users") do
+                link_to(
+                  t("decidim.admin.exports.export_as", name: t("decidim.extra_user_fields.admin.exports.users"), export_format: format.upcase),
+                  AdminEngine.routes.url_helpers.extra_user_fields_export_users_path(format: format)
+                )
+              end
+            end.join.html_safe
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ExtraUserFields
+    # Custom helpers, scoped to the extra_user_fields engine.
+    #
+    module ApplicationHelper
+      def gender_options_for_select
+        Decidim::ExtraUserFields::Engine::DEFAULT_GENDER_OPTIONS.map do |gender|
+          [gender, I18n.t(gender, scope: "decidim.extra_user_fields.genders")]
+        end
+      end
+    end
+  end
+end

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

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

data/app/overrides/decidim/account/show/extra_user_fields.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- insert_after "erb[loud]:contains('email_field')" original "d629550ba83d41a6d1c41553b7adbed311549633" -->
+
+<%= render partial: "/decidim/extra_user_fields/profile_form", locals: { f: f } %>

data/app/overrides/decidim/admin/officializations/index/_export_users_dropdown.html.erb.deface

@@ -0,0 +1,5 @@
+<!-- insert_bottom "h2.card-title" -->
+
+<div class="button--title">
+  <%= render partial: "decidim/extra_user_fields/admin/export_users/dropdown" %>
+</div>

data/app/overrides/decidim/devise/omniauth_registrations/new/extra_user_fields.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- insert_after "erb[loud]:contains('email_field')" -->
+
+<%= render partial: "/decidim/extra_user_fields/registration_form", locals: { f: f } %>

data/app/overrides/decidim/devise/registrations/new/extra_user_fields.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- insert_after "erb[loud]:contains('email_field')" -->
+
+<%= render partial: "/decidim/extra_user_fields/registration_form", locals: { f: f } %>

data/app/serializers/decidim/extra_user_fields/user_export_serializer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class serializes a User so can be exported to CSV
+  module ExtraUserFields
+    class UserExportSerializer < Decidim::DataPortabilitySerializers::DataPortabilityUserSerializer
+      # Public: Exports a hash with the serialized data for the user including
+      # extra user fields
+      def serialize
+        super.merge(extra_user_fields)
+      end
+
+      def extra_user_fields
+        extended_data = resource.extended_data.symbolize_keys
+
+        [:gender, :country, :postal_code, :date_of_birth].each_with_object({}) do |key, fields|
+          fields[key] = extended_data[key]
+        end
+      end
+    end
+  end
+end

data/app/views/decidim/extra_user_fields/_profile_form.html.erb

@@ -0,0 +1,4 @@
+<%= f.date_field :date_of_birth %>
+<%= f.collection_select :gender, f.object.gender_options_for_select, :first, :last %>
+<%= f.custom_country_select :country %>
+<%= f.text_field :postal_code %>

data/app/views/decidim/extra_user_fields/_registration_form.html.erb

@@ -0,0 +1,15 @@
+<div class="field">
+    <%= f.date_field :date_of_birth %>
+</div>
+
+<div class="field">
+  <%= f.collection_select :gender, f.object.gender_options_for_select, :first, :last %>
+</div>
+
+<div class="field">
+  <%= f.custom_country_select :country %>
+</div>
+
+<div class="field">
+  <%= f.text_field :postal_code %>
+</div>

data/app/views/decidim/extra_user_fields/admin/export_users/_dropdown.html.erb

@@ -0,0 +1,4 @@
+<span class="exports dropdown tiny button button--simple" data-toggle="export-dropdown"><%= t "actions.export", scope: "decidim.admin" %></span>
+<div class="dropdown-pane" id="export-dropdown" data-dropdown data-position=bottom data-alignment=right data-auto-focus="true" data-close-on-click="true">
+  <%= extra_user_fields_export_users_dropdown %>
+</div>

data/config/i18n-tasks.yml

@@ -0,0 +1,10 @@
+---
+
+base_locale: en
+locales: [en]
+
+ignore_unused:
+  - "decidim.components.extra_user_fields.name"
+
+ignore_missing:
+  - decidim.participatory_processes.scopes.global

data/config/locales/ca.yml

@@ -0,0 +1,21 @@
+---
+ca:
+  activemodel:
+    attributes:
+      user:
+        country: País
+        date_of_birth: Data de naixement
+        gender: Gènere
+        postal_code: Codi postal
+  decidim:
+    components:
+      extra_user_fields:
+        name: ExtraUserFields
+    extra_user_fields:
+      admin:
+        exports:
+          users: Participants
+      genders:
+        female: Dona
+        male: Home
+        other: Altre

data/config/locales/en.yml

@@ -0,0 +1,21 @@
+---
+en:
+  activemodel:
+    attributes:
+      user:
+        country: Country
+        date_of_birth: Date of birth
+        gender: Gender
+        postal_code: Postal code
+  decidim:
+    components:
+      extra_user_fields:
+        name: ExtraUserFields
+    extra_user_fields:
+      admin:
+        exports:
+          users: Participants
+      genders:
+        female: Female
+        male: Male
+        other: Other

data/config/locales/es.yml

@@ -0,0 +1,21 @@
+---
+es:
+  activemodel:
+    attributes:
+      user:
+        country: País
+        date_of_birth: Fecha de nacimiento
+        gender: Género
+        postal_code: Código postal
+  decidim:
+    components:
+      extra_user_fields:
+        name: ExtraUserFields
+    extra_user_fields:
+      admin:
+        exports:
+          users: Participantes
+      genders:
+        female: Mujer
+        male: Hombre
+        other: Otro

data/lib/decidim/extra_user_fields/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ExtraUserFields
+    # This module contains all the domain logic associated to Decidim's ExtraUserFields
+    # component admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/extra_user_fields/admin_engine.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ExtraUserFields
+    # This is the engine that runs on the public interface of `ExtraUserFields`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::ExtraUserFields::Admin
+
+      DEFAULT_EXPORT_FORMATS = %w(CSV JSON Excel).freeze
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        # Add admin engine routes here
+        namespace :extra_user_fields do
+          get :export_users
+        end
+      end
+
+      initializer "decidim_extra_user_fields.admin_mount_routes" do
+        Decidim::Core::Engine.routes do
+          mount Decidim::ExtraUserFields::AdminEngine, at: "/admin/extra_user_fields", as: "decidim_extra_user_fields"
+        end
+      end
+
+      initializer "decidim_extra_user_fields.admin_export_users" do
+        Decidim::Admin::ApplicationHelper.class_eval do
+          include ExtraUserFields::Admin::ApplicationHelper
+        end
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/extra_user_fields/engine.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "rails"
+require "decidim/core"
+require "country_select"
+require "deface"
+
+module Decidim
+  module ExtraUserFields
+    # This is the engine that runs on the public interface of extra_user_fields.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::ExtraUserFields
+
+      DEFAULT_GENDER_OPTIONS = [:male, :female, :other].freeze
+
+      routes do
+        # Add engine routes here
+        # resources :extra_user_fields
+        # root to: "extra_user_fields#index"
+      end
+
+      initializer "decidim_extra_user_fields.assets" do |app|
+        app.config.assets.precompile += %w(decidim_extra_user_fields_manifest.js decidim_extra_user_fields_manifest.css)
+      end
+
+      initializer "decidim_extra_user_fields.registration_additions" do
+        Decidim::RegistrationForm.class_eval do
+          include ExtraUserFields::FormsDefinitions
+        end
+
+        Decidim::OmniauthRegistrationForm.class_eval do
+          include ExtraUserFields::FormsDefinitions
+        end
+
+        Decidim::AccountForm.class_eval do
+          include ExtraUserFields::FormsDefinitions
+        end
+
+        Decidim::CreateRegistration.class_eval do
+          prepend ExtraUserFields::CommandsOverrides
+        end
+
+        Decidim::CreateOmniauthRegistration.class_eval do
+          prepend ExtraUserFields::OmniauthCommandsOverrides
+        end
+
+        Decidim::UpdateAccount.class_eval do
+          prepend ExtraUserFields::CommandsOverrides
+        end
+
+        Decidim::FormBuilder.class_eval do
+          include ExtraUserFields::FormBuilderMethods
+        end
+      end
+    end
+  end
+end

data/lib/decidim/extra_user_fields/form_builder_methods.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ExtraUserFields
+    # This module adds the FormBuilder methods for extra user fields
+    module FormBuilderMethods
+      def custom_country_select(name, options = {})
+        label_text = options[:label].to_s
+        label_text = label_for(name) if label_text.blank?
+
+        template = ""
+        template += label(name, label_text + required_for_attribute(name)) if options.fetch(:label, true)
+        template += country_select(name)
+        template.html_safe
+      end
+    end
+  end
+end

data/lib/decidim/extra_user_fields/test/factories.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "decidim/core/test/factories"
+
+FactoryBot.define do
+  factory :extra_user_fields_component, parent: :component do
+    name { Decidim::Components::Namer.new(participatory_space.organization.available_locales, :extra_user_fields).i18n_name }
+    manifest_name :extra_user_fields
+    participatory_space { create(:participatory_process, :with_steps) }
+  end
+
+  # Add engine factories here
+end

data/lib/decidim/extra_user_fields/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This holds the decidim-extra_user_fields version.
+  module ExtraUserFields
+    def self.version
+      "0.24.3"
+    end
+
+    def self.decidim_version
+      "0.24.3"
+    end
+  end
+end

data/lib/decidim/extra_user_fields.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "decidim/extra_user_fields/admin"
+require "decidim/extra_user_fields/engine"
+require "decidim/extra_user_fields/admin_engine"
+require "decidim/extra_user_fields/form_builder_methods"
+
+module Decidim
+  # This namespace holds the logic of the `ExtraUserFields` module.
+  module ExtraUserFields
+  end
+end