add custom select fields (#4)

* add custom select fields

* specs

* erb lint

* specfix

* fix specs

* readme

Author: microstudi

.gitignore

@@ -16,3 +16,6 @@ spec/decidim_dummy_app
 # default development application
 development_app
 .rubocop-https*-yml
+.byebug_history
+.rbenv-vars
+.env

README.md

@@ -96,6 +96,16 @@ Currently, the following ENV variables are supported:
 | EXTRA_USER_FIELDS_GENDERS | Options for the gender field (you need to add the corresponding I18n keys, ie: `decidim.extra_user_fields.genders.prefer_not_to_say` ) | `female male other prefer_not_to_say` |
 | EXTRA_USER_FIELDS_AGE_RANGES | Options for the age range field (you need to add the corresponding I18n keys, e.g., `decidim.extra_user_fields.age_ranges.up_to_16`) | `up_to_16 17_to_30 31_to_60 61_or_more prefer_not_to_say` |
 
+## Custom fields
+
+If your use case include fields not defined in this module, it is possible to define custom fields of different types:
+
+1. **Select fields** This configuration option allows you to define any number of extra user fields of the type "Select".
+
+
+See the next section "Configuration through an initializer" for more information.
+
+
 ### Configuration through an initializer
 
 It is also possible to configure the module using the an initializer:
@@ -110,6 +120,30 @@ Decidim::ExtraUserFields.configure do |config|
   config.age_ranges = ["30_or_younger", "31_or_older", "prefer_not_to_say"]
 
   ...
+
+
+    # I extra select fields are needed, they can be added here.
+    # The key is the field name and the value is a hash with the options.
+    # You can (optionally) add I18n keys for the options (if not the text will be used as it is).
+    # For the user interface, you can defined labels and descriptions for the fields (optionally):
+    # decidim.extra_user_fields.select_fields.field_name.label
+    # decidim.extra_user_fields.select_fields.field_name.description
+    # For the admin interface, you can defined labels and descriptions for the fields (optionally):
+    # decidim.extra_user_fields.admin.extra_user_fields.select_fields.field_name.label
+    # decidim.extra_user_fields.admin.extra_user_fields.select_fields.field_name.description
+    config_accessor :select_fields do
+      {
+        participant_type: {
+          # "" => "",
+          "individual" => "decidim.extra_user_fields.participant_types.individual",
+          "organization" => "decidim.extra_user_fields.participant_types.organization"
+        },
+        favorite_pet: {
+          "cat" => "my_app.favorite_pets.cat".
+          "dog" => "my_app.favorite_pets.dog"
+        }
+      }
+    end
 end
 ```
 

app/commands/concerns/decidim/extra_user_fields/create_registrations_commands_overrides.rb

@@ -54,6 +54,7 @@ def extended_data
           phone_number: form.phone_number,
           location: form.location,
           underage: form.underage,
+          select_fields: form.select_fields,
           statutory_representative_email: form.statutory_representative_email
         )
       end

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

@@ -81,6 +81,7 @@ def extended_data
           phone_number: form.phone_number,
           location: form.location,
           underage: form.underage,
+          select_fields: form.select_fields,
           statutory_representative_email: form.statutory_representative_email
         )
       end

app/commands/concerns/decidim/extra_user_fields/update_account_commands_overrides.rb

@@ -30,6 +30,7 @@ def extended_data
           phone_number: @form.phone_number,
           location: @form.location,
           underage: @form.underage,
+          select_fields: @form.select_fields,
           statutory_representative_email: @form.statutory_representative_email
         )
       end

app/commands/decidim/extra_user_fields/admin/update_extra_user_fields.rb

@@ -55,7 +55,8 @@ def extra_user_fields
             },
             "location" => { "enabled" => form.location.presence || false },
             "underage" => { "enabled" => form.underage || false },
-            "underage_limit" => form.underage_limit || Decidim::ExtraUserFields.underage_limit
+            "underage_limit" => form.underage_limit || Decidim::ExtraUserFields.underage_limit,
+            "select_fields" => form.select_fields.to_a
           }
         end
         # rubocop:enable Metrics/CyclomaticComplexity

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

@@ -22,6 +22,7 @@ module FormsDefinitions
         attribute :location, String
         attribute :underage, ActiveRecord::Type::Boolean
         attribute :statutory_representative_email, String
+        attribute :select_fields, Hash, default: {}
 
         # EndBlock
 
@@ -46,6 +47,7 @@ module FormsDefinitions
                   "valid_email_2/email": { disposable: true },
                   if: :underage_accepted?
         validate :birth_date_under_limit
+        validate :select_fields_configured
 
         # EndBlock
       end
@@ -61,11 +63,8 @@ def map_model(model)
         self.phone_number = extended_data[:phone_number]
         self.location = extended_data[:location]
         self.underage = extended_data[:underage]
+        self.select_fields = extended_data[:select_fields] || {}
         self.statutory_representative_email = extended_data[:statutory_representative_email]
-
-        # Block ExtraUserFields MapModel
-
-        # EndBlock
       end
 
       private
@@ -109,6 +108,10 @@ def underage?
         extra_user_fields_enabled && current_organization.activated_extra_field?(:underage)
       end
 
+      def select_fields?
+        extra_user_fields_enabled && current_organization.activated_extra_field?(:select_fields)
+      end
+
       def underage_accepted?
         underage? && underage == "1"
       end
@@ -146,6 +149,21 @@ def underage_within_limit?(age)
       def underage_limit
         current_organization.extra_user_fields["underage_limit"]
       end
+
+      def select_fields_configured
+        return unless select_fields?
+
+        select_fields.each do |field, value|
+          next unless current_organization.extra_user_field_configuration(:select_fields).include?(field.to_s)
+
+          conf = Decidim::ExtraUserFields.select_fields.with_indifferent_access[field]
+          next unless conf.is_a?(Hash)
+          next if conf.with_indifferent_access.has_key?(value)
+
+          label = I18n.t("decidim.extra_user_fields.select_fields.#{field}.label", default: field.to_s.humanize)
+          errors.add(:base, I18n.t("decidim.extra_user_fields.errors.select_fields", field: label))
+        end
+      end
     end
   end
 end

app/forms/decidim/extra_user_fields/admin/extra_user_fields_form.rb

@@ -19,9 +19,8 @@ class ExtraUserFieldsForm < Decidim::Form
 
         attribute :phone_number_pattern, String
         translatable_attribute :phone_number_placeholder, String
-        # Block ExtraUserFields Attributes
 
-        # EndBlock
+        attribute :select_fields, Array, default: []
 
         def map_model(model)
           self.enabled = model.extra_user_fields["enabled"]
@@ -36,9 +35,13 @@ def map_model(model)
           self.underage_limit = model.extra_user_fields.fetch("underage_limit", Decidim::ExtraUserFields.underage_limit)
           self.phone_number_pattern = model.extra_user_fields.dig("phone_number", "pattern")
           self.phone_number_placeholder = model.extra_user_fields.dig("phone_number", "placeholder")
-          # Block ExtraUserFields MapModel
+          self.select_fields = model.extra_user_fields["select_fields"] || []
+        end
 
-          # EndBlock
+        def select_fields
+          super.filter do |field|
+            Decidim::ExtraUserFields.select_fields.keys.map(&:to_s).include?(field)
+          end
         end
       end
     end

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

@@ -18,6 +18,14 @@ def extra_user_fields_export_users_dropdown
             end.join.html_safe
           end
         end
+
+        def custom_select_fields(form)
+          return {} unless Decidim::ExtraUserFields.select_fields.is_a?(Hash)
+
+          Decidim::ExtraUserFields.select_fields.keys.index_with do |field|
+            form.object.select_fields.include?(field.to_s)
+          end
+        end
       end
     end
   end

app/helpers/decidim/extra_user_fields/application_helper.rb

@@ -24,6 +24,22 @@ def phone_number_extra_user_field_pattern
       def phone_number_extra_user_field_placeholder
         current_organization.extra_user_field_configuration(:phone_number)["placeholder"]
       end
+
+      def custom_select_fields_options
+        Decidim::ExtraUserFields.select_fields.filter_map do |field, options|
+          next unless options.is_a?(Hash)
+          next if options.blank?
+          next if current_organization.extra_user_field_configuration(:select_fields).include?(field)
+
+          [
+            field,
+            options.map do |option, label|
+              label = I18n.t(label, default: label.split(".").last.to_s.humanize) if label.present?
+              [label, option]
+            end
+          ]
+        end.to_h
+      end
     end
   end
 end

app/models/concerns/decidim/extra_user_fields/organization_overrides.rb

@@ -10,27 +10,40 @@ module OrganizationOverrides
 
       # If true display registration field in signup form
       def extra_user_fields_enabled?
-        extra_user_fields["enabled"].presence && at_least_one_extra_field?
+        extra_user_fields["enabled"].present? && at_least_one_extra_field?
       end
 
       def at_least_one_extra_field?
-        extra_user_fields.reject { |key| %w(enabled underage_limit).include?(key) }
-                         .map { |_, value| value["enabled"] }.any?
+        extra_user_fields.filter_map do |field, _value|
+          next if %w(enabled underage_limit).include?(field)
+
+          activated_extra_field?(field)
+        end.any?
       end
 
       # Check if the given value is enabled in extra_user_fields
-      def activated_extra_field?(sym)
-        extra_user_fields.dig(sym.to_s, "enabled") == true
+      def activated_extra_field?(field)
+        value = extra_user_fields[field.to_s]
+
+        if value.is_a?(Hash)
+          value["enabled"]
+        else
+          value
+        end.present?
       end
 
       def age_limit?
         extra_user_fields["underage_limit"].to_i
       end
 
-      def extra_user_field_configuration(sym)
-        return {} unless activated_extra_field?(sym)
+      def extra_user_field_configuration(field)
+        return {} unless activated_extra_field?(field)
+
+        value = extra_user_fields[field.to_s]
+
+        return value.except("enabled") if value.is_a?(Hash)
 
-        extra_user_fields[sym.to_s].except("enabled")
+        value
       end
     end
   end

app/serializers/decidim/extra_user_fields/user_export_serializer.rb

@@ -13,7 +13,7 @@ def serialize
       def extra_user_fields
         extended_data = resource.extended_data.symbolize_keys
 
-        [:gender, :age_range, :country, :postal_code, :date_of_birth, :phone_number, :location, :underage, :statutory_representative_email].index_with do |key|
+        extra_fields.index_with do |key|
           extended_data[key]
         end
       end
@@ -36,10 +36,8 @@ def extra_fields
           :phone_number,
           :location,
           :underage,
+          :select_fields,
           :statutory_representative_email
-          # Block ExtraUserFields AddExtraField
-
-          # EndBlock
         ]
       end
     end

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

@@ -33,4 +33,8 @@
     <%= f.hidden_field :underage, value: current_user.extended_data["underage"] || "0" %>
     <%= f.hidden_field :statutory_representative_email, value: current_user.extended_data["statutory_representative_email"] || "" %>
   <% end %>
+
+  <% if current_organization.activated_extra_field?(:select_fields) %>
+    <%= render partial: "decidim/extra_user_fields/select_fields", locals: { f: f } %>
+  <% end %>
 <% end %>

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

@@ -3,7 +3,7 @@
     <h2 class="h4"><%= t(".signup.legend") %></h2>
 
     <% if current_organization.activated_extra_field?(:date_of_birth) %>
-      <div><%= f.date_field :date_of_birth, id: "user_date_of_birth" %></div>
+      <div><%= f.date_field :date_of_birth %></div>
     <% end %>
 
     <% if current_organization.activated_extra_field?(:gender) %>
@@ -49,9 +49,10 @@
         </div>
       <% end %>
     <% end %>
-    <%# Block ExtraUserFields SignUpFormFields %>
 
-    <%# EndBlock %>
+    <% if current_organization.activated_extra_field?(:select_fields) %>
+      <%= render partial: "decidim/extra_user_fields/select_fields", locals: { f: f } %>
+    <% end %>
 
   </div>
   <%= append_javascript_pack_tag "decidim_extra_user_fields.js" %>

app/views/decidim/extra_user_fields/_select_fields.html.erb

@@ -0,0 +1,14 @@
+    <% f.object.custom_select_fields_options.each do |field, options| %>
+      <div class="fieldset">
+        <%= label_tag f.field_id("select_fields_#{field}") do %>
+          <%= t("decidim.extra_user_fields.select_fields.#{field}.label", default: field.to_s.humanize) %>
+          <% if (help = t("decidim.extra_user_fields.select_fields.#{field}.description", default: "")).present? %>
+            <span class="help-text"><%= help %></span>
+          <% end %>
+
+          <%= select_tag "user[select_fields][#{field}]",
+                        options_for_select(options, f.object.select_fields[field]),
+                        id: f.field_id("select_fields_#{field}") %>
+        <% end %>
+      </div>
+    <% end %>

app/views/decidim/extra_user_fields/admin/extra_user_fields/_form.html.erb

@@ -33,6 +33,13 @@
       <%= render partial: "decidim/extra_user_fields/admin/extra_user_fields/fields/phone_number", locals: { form: form } %>
       <%= render partial: "decidim/extra_user_fields/admin/extra_user_fields/fields/location", locals: { form: form } %>
       <%= render partial: "decidim/extra_user_fields/admin/extra_user_fields/fields/underage", locals: { form: form } %>
+
+      <div class="card-divider">
+        <h2 class="card-title"><%= t(".extra_user_fields.section_extras") %></h2>
+        <p class="help-text"><%= t(".extra_user_fields.section_extras_description") %></p>
+      </div>
+
+      <%= render partial: "decidim/extra_user_fields/admin/extra_user_fields/fields/select_fields", locals: { form: form } %>
     </div>
   </div>
 </div>

app/views/decidim/extra_user_fields/admin/extra_user_fields/fields/_select_fields.html.erb

@@ -0,0 +1,15 @@
+<% custom_select_fields(form).each do |field, checked| %>
+  <div class="card-section">
+    <div class="row column">
+      <%= label_tag "extra_user_fields_select_field_#{field}" do %>
+
+        <%= check_box_tag "extra_user_fields[select_fields][]",
+                          field,
+                          checked,
+                          id: "extra_user_fields_select_field_#{field}" %>
+        <%= t("decidim.extra_user_fields.admin.extra_user_fields.select_fields.#{field}.label", default: field.to_s.humanize ) %>
+        <span class="help-text"><%= t("decidim.extra_user_fields.admin.extra_user_fields.select_fields.#{field}.description", default: "") %></span>
+      <% end %>
+    </div>
+  </div>
+<% end %>

bin/rails

@@ -1,16 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# This command will automatically be run when you run "rails" with Rails gems
-# installed from the root of your application.
+Dir.chdir("development_app")
 
-ENGINE_ROOT = File.expand_path("..", __dir__)
-ENGINE_PATH = File.expand_path("../lib/decidim/extra_user_fields/engine", __dir__)
-
-# Set up gems listed in the Gemfile.
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-
-require "bundler/setup"
-
-require "rails/all"
-require "rails/engine/commands"
+load "bin/rails"

bin/shakapacker

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Dir.chdir("development_app")
+
+load "bin/shakapacker"

bin/shakapacker-dev-server

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Dir.chdir("development_app")
+
+load "bin/shakapacker-dev-server"