Decidim::FriendlySignup

A more user friendly approach for the user registration process in Decidim.

Usage

This module simply substitutes some pages to ease up the registration process in Decidim.

Features:

[x] Simplify the password field and add a button with a "show password".
[x] Remove the nickname field from the registration process and automatically create one on registering.
[x] Instant validate parameters when registering without having to send it for backend validation.
[x] Use numeric, confirmation codes to validate the email instead of a link.

Installation

Add this line to your application's Gemfile:

gem "decidim-friendly_signup"

For a bleeding edge version (or while developing) please use instead:

gem "decidim-friendly_signup", git: "https://github.com/OpenSourcePolitics/decidim-module-friendly_signup", branch: "main"

And then execute:

bundle

For security reasons, it is also recomended to set a expiration time on confirmation tokens, to do that, make sure your Devise initializer has the variable confirm_within to certain amount of time.

For instance, you can do that by creating an initializer such as:

# config/initializers/devise.rb

Devise.setup do |config|
  config.confirm_within = 12.hours
end

Note:

The correct version of FriendlySignup should resolved automatically by the Bundler. However you can force some specific version using gem "decidim-friendly_signup", "~> 0.1.0" in the Gemfile.

Depending on your Decidim version, choose the corresponding FriendlySignup version to ensure compatibility:

FriendlySignup version	Compatible Decidim versions
0.4.x	0.26.x
0.3.x	0.26.x
0.2.x	0.26.x
0.1.x	0.26.x

Configuration

Customize your integration by creating an initializer (ie: config/initializes/friendly_signup.rb) and set some of the variables (you don't need to do this if you want all features enabled):

# config/initializers/friendly_signup.rb

Decidim::FriendlySignup.configure do |config|
  # Override password views or leave the originals (default is true):
  config.override_passwords = false

  # Automatically validate user inputs in the register form (default is true):
  config.use_instant_validation = false

  # Hide nickname field and create one automatically from user's name or email (default is true)
  config.hide_nickname = false

  # Send the users a 4-digit number that needs to be entered in a confirmation page instead of a confirmation link (default is true)
  config.use_confirmation_codes = false
end

Customize error messages in instant validation

You can customize any message either overriding in your application the files in config/locales/*.yml or by using a module like Term Customizer.

This plugin uses a cascade-style fallback looking for a series of I18n keys and returns the first available. For instance, for the attribute email and the validation key blank it will look for these 3 possibilities, returning the first matching one:

Specific attribute error:

en:
  decidim:
    friendly_signup:
      errors:
        messages:
          email:
            blank: Please enter an email address

Generic error:

en:
  decidim:
    friendly_signup:
      errors:
        messages:
          blank: Looks like you haven’t entered anything in this field

Rails' default error:

en:
  errors:
    messages:
      blank: can't be blank

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/OpenSourcePolitics/decidim-module-friendly_signup.

Localization

If you would like to see this module in your own language, you can help with its translation at Crowdin:

https://crowdin.com/project/decidim-friendly-signup

Developing

To start contributing to this project, first:

Install the basic dependencies (such as Ruby and PostgreSQL)
Clone this repository

Decidim's main repository also provides a Docker configuration file if you prefer to use Docker instead of installing the dependencies locally on your machine.

You can create the development app by running the following commands after cloning this project:

$ bundle
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake development_app

Note that the database user has to have rights to create and drop a database in order to create the dummy test app database.

Then to test how the module works in Decidim, start the development server:

$ cd development_app
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rails s

In case you are using rbenv and have the rbenv-vars plugin installed for it, you can add the environment variables to the root directory of the project in a file named .rbenv-vars. If these are defined for the environment, you can omit defining these in the commands shown above.

Code Styling

Please follow the code styling defined by the different linters that ensure we are all talking with the same language collaborating on the same project. This project is set to follow the same rules that Decidim itself follows.

Rubocop linter is used for the Ruby language.

You can run the code styling checks by running the following commands from the console:

$ bundle exec rubocop

To ease up following the style guide, you should install the plugin to your favorite editor, such as:

Sublime Text - Sublime RuboCop
Visual Studio Code - Rubocop for Visual Studio Code

Testing

To run the tests run the following in the gem development path:

$ bundle
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake test_app
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rspec

Note that the database user has to have rights to create and drop a database in order to create the dummy test app database.

In case you are using rbenv and have the rbenv-vars plugin installed for it, you can add these environment variables to the root directory of the project in a file named .rbenv-vars. In this case, you can omit defining these in the commands shown above.

Test code coverage

Test coverage should be generated automatically in the folder "coverage" once any test is run:

$ bundle exec rspec
$ firefox coverage/index.html

License

See LICENSE-AGPLv3.txt.