decidim-user_fields 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d7b7ee3b6215fc3fb95f7d1501369650d051fe38e731492fc9ce5628ad75577
+  data.tar.gz: c4d1e5eb6e11d01ea3a61196a73ad107c34b96c43c52c6ab388ba733e98ad00d
+SHA512:
+  metadata.gz: 8adddf951a431b592d6062f04b31478c0ddeef718b492b78ddadaf995b1bf2b208f2fa8937a47bad2009f4410b4518845d264fff123477ab72c6622719a4b5d7
+  data.tar.gz: cfda033cd73225d2834d8617f8898f248a97ddae6a4f8d32a7997315340a2dec0bd133ba065c62b277a2806ddf96a31eafa082b10b1ef7a83ba815a644d3bb37

data/README.md

@@ -0,0 +1,121 @@
+<h1 align="center"><img src="https://github.com/octree-gva/meta/blob/main/decidim/static/header.png?raw=true" alt="Decidim - Octree Participatory democracy on a robust and open source solution" /></h1>
+<h4 align="center">
+    <a href="https://www.octree.ch">Octree</a> |
+    <a href="https://octree.ch/en/contact-us/">Contact Us</a> |
+    <a href="https://blog.octree.ch">Our Blog (FR)</a><br/><br/>
+    <a href="https://decidim.org">Decidim</a> |
+    <a href="https://docs.decidim.org/en/">Decidim Docs</a> |
+    <a href="https://meta.decidim.org">Participatory Governance (meta decidim)</a><br/><br/>
+    <a href="https://matrix.to/#/+decidim:matrix.org">Decidim Community (Matrix+Element.io)</a>
+</h4>
+<p align="center">
+    <a href="https://participe.gland.ch">
+        <img
+            src="https://github.com/octree-gva/meta/blob/main/decidim/static/participe_gland.png?raw=true"
+            alt="Participe Gland — Donnez vie à vos idées avec le budget participatif" />
+    </a>
+    <a href="https://mkutano.community"><img src="https://github.com/octree-gva/decidim-module-mkutano_custom_registration_flow/blob/main/mkutano-logo.png?raw=true" alt="MKUTANO is a participatory platform where black canadians can effectively & democratically organize at scale" /></a>
+    <a href="https://opencollective.com/voca">
+        <img
+            src="https://github.com/octree-gva/meta/blob/main/decidim/static/opencollective_chip.png?raw=true"
+            alt="Voca – Open-Source SaaS platform for Decidim" />
+    </a>
+</p>
+
+
+# Decidim User Fields
+Add custom user fields, through configuration file and without migration. 
+This module aims to configure in a blast new fields for subscription and profile edition. It supports: 
+
+- User registration
+- User profiles
+- User invitations.
+
+⚠️ It **does not support**:
+
+- Omniauth registrations
+
+## Setup the module
+Add the gem to your gemfile
+```
+gem "decidim-user_fields"
+```
+
+Run bundle
+```
+bundle install
+```
+
+Create an initializer `config/initializers/custom_user_fields.rb`
+```
+Decidim::CustomUserFields.configure do |config|
+    config.add_field :birthdate, type: :date, required: true
+    config.add_field :province, type: :select, options: [:vd, :vs, :ar], default: :vd, required: true
+    config.add_field :adress, type: :textarea, required: false, rows: 10
+    config.add_field :purpose, type: :text, required: false
+end
+```
+
+### Available field types
+
+**`:date`**
+
+parameters:
+* `required`: must choose a date
+* `min`: date in ISO8601 where the user can not select before
+* `max`: date in ISO8601 where the user can not select after
+
+**`:textarea`**
+
+parameters:
+* `required`: if the field is required
+* `min`: minimal length
+* `max`: maximal length
+* `rows`: how much rows the field should display
+
+**`:text`**
+
+parameters:
+* `required`: if the field is required
+
+### Labels
+Labels are translated, and are under the traduction scope `decidim.custom_user_fields`. 
+Example of a `fr.yml` file:
+
+```yml
+fr:
+  activemodel:
+    attributes:
+      user:
+        birthday: "Birthday"
+        adress: "Addresse"
+        purpose: "Raison d'être ici"
+        province: "Canton"
+  decidim:
+    custom_user_fields:
+      province:
+        options:
+          vd: "Vaud"
+          vs: "Valais"
+          ar: "Aarau"
+```
+
+## Run locally
+To run this module locally, we use docker-compose: 
+```
+docker-compose up
+```
+This will run a `decidim-user_fields` container, which sleeps.
+You can run any command you want in the running container, like: 
+
+- `docker-compose exec -it decidim-user_fields bundle exec rails db:seed`: seed the database (run on [`localhost:3000`](https://localhost:3000))
+- `docker-compose exec -it decidim-user_fields bin/webpack-dev-server`: compile assets and watch for changes
+- `docker-compose exec -it decidim-user_fields bin/rails s -b 0.0.0.0`: run rails server in development
+- `docker-compose exec -it decidim-user_fields bundle exec rspec /home/decidim/module/spec`: run tests for the module
+- `docker-compose exec -it decidim-user_fields bundle exec rubocop -a /home/decidim/module`: correct lint error with rubocop
+- `docker-compose exec -it decidim-user_fields bash`: navigate your container in bash
+
+While developping locally, you have two environments variables that can help you: 
+- `ROOT`: the root of the application using the module
+- `MODULE_ROOT`: the place where your gem code is.
+

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/custom_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/custom_user_fields/admin/export_users/dropdown" %>
+</div>

data/app/overrides/decidim/devise/invitations/edit/extra_user_fields.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- insert_bottom "div.user-nickname" -->
+<%= f.hidden_field :email %>
+<%= render partial: "/decidim/custom_user_fields/registration_form", locals: { f:f, resource: resource  } %>

data/app/overrides/decidim/devise/invitations/edit/extra_user_fields_form.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- replace "erb[loud]:contains('decidim_form_for')" -->
+<% form = @form || Decidim::RegistrationForm.from_model(resource).with_context(current_organization: current_organization, current_user: current_user) %>
+<%= decidim_form_for form, namespace: "invitation", as: resource_name, url: invitation_path(resource_name, invite_redirect: params[:invite_redirect]), html: { method: :put, class: "register-form new_user" } do |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/custom_user_fields/registration_form", locals: { f: f, resource: resource } %>

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

@@ -0,0 +1,5 @@
+<div class="custom-user-fields__section">
+    <% Decidim::CustomUserFields.custom_fields.collect do |field|
+        concat field.form_tag(f)
+    end %>
+</div>

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

@@ -0,0 +1,5 @@
+<div class="custom-user-fields__section">
+    <% Decidim::CustomUserFields.custom_fields.collect do |field|
+        concat field.form_tag(f)
+    end %>
+</div>

data/lib/decidim/custom_user_fields/custom_user_fields.rb

@@ -0,0 +1,27 @@
+module Decidim
+  module CustomUserFields
+    include ActiveSupport::Configurable
+
+    def self.configure
+      yield self
+    end
+
+    ##
+    # If users should receive emails on notification
+    # by default
+    config_accessor :default_email_on_notification do
+      false
+    end
+
+    def self.custom_fields
+      @custom_fields ||= []
+    end
+
+    def self.add_field(field_type, field_definition)
+      custom_fields.push(FieldDefinition.new(field_type, field_definition))
+      self
+    end
+
+    class Error < StandardError; end
+  end
+end

data/lib/decidim/custom_user_fields/engine.rb

@@ -0,0 +1,43 @@
+require 'rails'
+require 'decidim/core'
+require 'deface'
+
+module Decidim
+  module CustomUserFields
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::CustomUserFields
+      routes do
+        # Add engine routes here
+        # resources :custom_user_fields
+        # root to: "custom_user_fields#index"
+      end
+
+      initializer 'decidim_custom_user_fields.registration_additions' do
+        config.to_prepare do
+          Decidim::RegistrationForm.class_eval do
+            include CustomUserFields::FormsDefinition
+            def self.require_password_on_accepting
+              Decidim::User.require_password_on_accepting
+            end
+          end
+
+          Decidim::OmniauthRegistrationForm.class_eval do
+            include CustomUserFields::FormsDefinition
+          end
+
+          Decidim::AccountForm.class_eval do
+            include CustomUserFields::FormsDefinition
+          end
+
+          Decidim::CreateRegistration.class_eval do
+            prepend CustomUserFields::Command
+          end
+
+          Decidim::UpdateAccount.class_eval do
+            prepend CustomUserFields::Command
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/custom_user_fields/field_definition.rb

@@ -0,0 +1,34 @@
+require 'forwardable'
+
+module Decidim
+  module CustomUserFields
+    class FieldDefinition
+      extend Forwardable
+
+      attr_reader :type,
+                  :name,
+                  :field
+
+      def_delegators :@field,
+                     :configure_form,
+                     :map_model,
+                     :form_tag
+
+      def initialize(name, kwargs)
+        @name = name.to_s.to_sym
+        @type = kwargs[:type]
+        # TODO: parse kwargs
+        case type
+        when :text
+          @field = Fields::TextField.new(self, kwargs)
+        when :textarea
+          @field = Fields::TextAreaField.new(self, kwargs)
+        when :date
+          @field = Fields::DateField.new(self, kwargs)
+        else
+          raise Error, "field type #{type} is not supported"
+        end
+      end
+    end
+  end
+end

data/lib/decidim/custom_user_fields/fields/date_field.rb

@@ -0,0 +1,31 @@
+module Decidim
+    module CustomUserFields
+      module Fields
+        class DateField < GenericField
+          def configure_form(form)
+            form.attribute(name, String)
+            form.validates(name, presence: required?)
+          end
+  
+          def map_model(form, data)
+            form[name] = data[name] if data[name].present?
+          end
+  
+          def form_tag(form_tag)
+            field_options = {}
+            if options[:min].present? || options[:max].present?
+                field_options[:min] = options[:min]
+                field_options[:max] = options[:max]
+            end
+
+            content_tag(
+              :div, 
+              form_tag.date_field(name, **field_options), 
+              class: class_name
+            )
+          end
+        end
+      end
+    end
+  end
+  

data/lib/decidim/custom_user_fields/fields/generic_field.rb

@@ -0,0 +1,39 @@
+module Decidim
+  module CustomUserFields
+    module Fields
+      class GenericField
+        extend Forwardable
+        include ActionView::Helpers::TagHelper
+
+        def_delegators :@definition, :name, :type
+
+        attr_reader :definition, :options
+        def initialize(definition, options)
+          @definition = definition
+          @options = options
+        end
+
+        def configure_form(_form)
+          raise Error, "Configure Form is not implemented for #{definition.type} type"
+        end
+
+        def map_model(_form, _model_data)
+          raise Error, "Map Model is not implemented for #{definition.type} type"
+        end
+
+        def form_tag(_form)
+          raise Error, "Form Tag is not implemented for #{definition.type} type"
+        end
+
+        def class_name
+          class_specifier = name.to_s.underscore
+          "field field--#{type} field--#{class_specifier}"
+        end
+
+        def required?
+          options[:required].present? && options[:required]
+        end
+      end
+    end
+  end
+end

data/lib/decidim/custom_user_fields/fields/text_area_field.rb

@@ -0,0 +1,34 @@
+module Decidim
+    module CustomUserFields
+      module Fields
+        class TextAreaField < GenericField
+          def configure_form(form)
+            form.attribute(name, String)
+            form.validates(name, presence: required?)
+            if options[:min].present? || options[:max].present?
+                min_max_options = {}
+                min_max_options[:minimum] = options[:min].to_i
+                min_max_options[:maximum] = options[:max].to_i
+                form.validates(name, length: min_max_options, allow_blank: !required?)
+            end
+          end
+  
+          def map_model(form, data)
+            form[name] = data[name] if data[name].present?
+          end
+  
+          def form_tag(form_tag)
+            field_options = {
+                rows: options[:row] || 2
+            }
+            content_tag(
+              :div, 
+              form_tag.text_area(name, **field_options), 
+              class: class_name,
+            )
+          end
+        end
+      end
+    end
+  end
+  

data/lib/decidim/custom_user_fields/fields/text_field.rb

@@ -0,0 +1,24 @@
+module Decidim
+  module CustomUserFields
+    module Fields
+      class TextField < GenericField
+        def configure_form(form)
+          form.attribute(name, String)
+          form.validates(name, presence: required?)
+        end
+
+        def map_model(form, data)
+          form[name] = data[name] if data[name].present?
+        end
+
+        def form_tag(form_tag)
+          content_tag(
+            :div, 
+            form_tag.text_field(name), 
+            class: class_name
+          )
+        end
+      end
+    end
+  end
+end

data/lib/decidim/custom_user_fields/helpers/application_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CustomUserFields
+    module ApplicationHelper
+    end
+  end
+end

data/lib/decidim/custom_user_fields/overrides/command.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module Decidim
+  module CustomUserFields
+    # Changes in methods to store extra fields in user profile
+    module Command
+      extend ActiveSupport::Concern
+
+      private
+
+      def create_user
+        user_payload = {
+          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: Decidim::CustomUserFields.default_email_on_notification,
+          accepted_tos_version: @form.current_organization.tos_version,
+          locale: @form.current_locale,
+          extended_data: extended_data
+        }
+        @user = User.create!(user_payload)
+      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
+        custom_data = {}
+        Decidim::CustomUserFields.custom_fields.each do |field_def|
+          custom_data[field_def.name] = @form[field_def.name]
+        end
+        @extended_data ||= (@user&.extended_data || {}).merge(custom_data)
+      end
+    end
+  end
+end

data/lib/decidim/custom_user_fields/overrides/form_definition.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module Decidim
+  module CustomUserFields
+    # Extra user fields definitions for forms
+    module FormsDefinition
+      extend ActiveSupport::Concern
+
+      included do |inst|
+        include ::Decidim::CustomUserFields::ApplicationHelper
+        Decidim::CustomUserFields.custom_fields.each do |field_def|
+          field_def.configure_form(inst)
+        end
+      end
+
+      def map_model(model)
+        extended_data = model.extended_data.with_indifferent_access
+        field_def.map_model(self, model)
+      end
+    end
+  end
+end

data/lib/decidim/custom_user_fields/version.rb

@@ -0,0 +1,11 @@
+module Decidim
+  module CustomUserFields
+    def self.version
+      '0.0.1'
+    end
+
+    def self.decidim_version
+      '>= 0.26'
+    end
+  end
+end

data/lib/decidim/user_fields.rb

@@ -0,0 +1,18 @@
+require 'decidim/custom_user_fields/fields/generic_field'
+require 'decidim/custom_user_fields/fields/date_field'
+require 'decidim/custom_user_fields/fields/text_area_field'
+require 'decidim/custom_user_fields/fields/text_field'
+require 'decidim/custom_user_fields/field_definition'
+
+require 'decidim/custom_user_fields/helpers/application_helper'
+require 'decidim/custom_user_fields/custom_user_fields'
+require 'decidim/custom_user_fields/overrides/command'
+require 'decidim/custom_user_fields/overrides/form_definition'
+
+require 'decidim/custom_user_fields/engine'
+
+Decidim.register_global_engine(
+  :decidim_custom_user_fields, # this is the name of the global method to access engine routes
+  ::Decidim::CustomUserFields::Engine,
+  at: '/decidim_custom_user_fields'
+)

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: decidim-user_fields
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hadrien Froger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: decidim-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.26'
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: decidim-dev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.26'
+description: Allows to collect and manage some extra user fields on registration and
+  profile edition.
+email:
+- hadrien@octree.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/overrides/decidim/account/show/extra_user_fields.html.erb.deface
+- app/overrides/decidim/admin/officializations/index/_export_users_dropdown.html.erb.deface
+- app/overrides/decidim/devise/invitations/edit/extra_user_fields.html.erb.deface
+- app/overrides/decidim/devise/invitations/edit/extra_user_fields_form.html.erb.deface
+- app/overrides/decidim/devise/registrations/new/extra_user_fields.html.erb.deface
+- app/views/decidim/custom_user_fields/_profile_form.html.erb
+- app/views/decidim/custom_user_fields/_registration_form.html.erb
+- lib/decidim/custom_user_fields/custom_user_fields.rb
+- lib/decidim/custom_user_fields/engine.rb
+- lib/decidim/custom_user_fields/field_definition.rb
+- lib/decidim/custom_user_fields/fields/date_field.rb
+- lib/decidim/custom_user_fields/fields/generic_field.rb
+- lib/decidim/custom_user_fields/fields/text_area_field.rb
+- lib/decidim/custom_user_fields/fields/text_field.rb
+- lib/decidim/custom_user_fields/helpers/application_helper.rb
+- lib/decidim/custom_user_fields/overrides/command.rb
+- lib/decidim/custom_user_fields/overrides/form_definition.rb
+- lib/decidim/custom_user_fields/version.rb
+- lib/decidim/user_fields.rb
+homepage: https://github.com/octree-gva/decidim-module-mkutano-extra_user_fields
+licenses:
+- AGPL-3.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Configure user fields for your decidim users
+test_files: []