decidim-friendly_signup 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f2ae2b38da8d5bfc15a20685f71f03c57874127d6017924d475a142f60d02cf
-  data.tar.gz: 929035be31dd91ac0e725b849f83385164966b2be0f47ed103a8d3b5c3cbc149
+  metadata.gz: c631ec440674f278ea3a0f3369435831014443e36f2f4247d1a87d914e7e66c8
+  data.tar.gz: cf5ca968cfe4459a63471e02ff36dd38f28cfb042c3146e175c3766dab4a6571
 SHA512:
-  metadata.gz: ed74b6aaba9d5bf1bd4187f9199e1caba5c7ee2684be73eb271274734bced92119ead384a77a9434d6de9b65126e84b6799789e8d9286b0e25b4f573721ff4b3
-  data.tar.gz: 28a1e3a53faf886766638d2765533fd3d395401c291f60d7b25066386682be00fcd581585e925c007dd0ad404d0db94794b73c188d24fe00e79e3934767c28d7
+  metadata.gz: cdd1a58fad3b2b40cb5f73497c3ca408a621afce743073b40c9fee720a4e9050e0d5a8f3b495e5024b6e807ce7fe8c61859e264259fd3ccec30424d025114bb3
+  data.tar.gz: b0437d886f9018aaed1a3f405f52032d77c8c01ec7f1f40bb8a61b708138f1eeedbacb424ab394d26048c7bb643d14b3579ddce4954cd5c2af521fea6ffc8f38

data/README.md

@@ -1,21 +1,25 @@
 # Decidim::FriendlySignup
 
+[![[CI] Lint](https://github.com/OpenSourcePolitics/decidim-module-friendly_signup/actions/workflows/lint.yml/badge.svg)](https://github.com/OpenSourcePolitics/decidim-module-friendly_signup/actions/workflows/lint.yml)
 [![[CI] Test](https://github.com/OpenSourcePolitics/decidim-module-friendly_signup/actions/workflows/test.yml/badge.svg)](https://github.com/OpenSourcePolitics/decidim-module-friendly_signup/actions/workflows/test.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/46c261f70f7f49a8f385/maintainability)](https://codeclimate.com/github/OpenSourcePolitics/decidim-module-friendly_signup/maintainability)
 [![Test Coverage](https://codecov.io/gh/OpenSourcePolitics/decidim-module-friendly_signup/branch/main/graph/badge.svg?token=1lrOiLdy9P)](https://codecov.io/gh/OpenSourcePolitics/decidim-module-friendly_signup)
+[![Gem Version](https://badge.fury.io/rb/decidim-friendly_signup.svg)](https://badge.fury.io/rb/decidim-friendly_signup)
+
 ---
-A more user friendly approach for the user registration process.
+
+A more user friendly approach for the user registration process in [Decidim](https://github.com/decidim/decidim).
 
 ## Usage
 
 This module simply substitutes some pages to ease up the registration process in Decidim.
 
-Features:
+### Features:
 
 - [x] Simplify the password field and add a button with a "show password". ![Show/hide password](examples/passwords.png)
  
 - [ ] Remove the nickname field from the registration process and automatically create one on registering
-- [ ] Instant validate parameters when registering without having to send it for backend validation
+- [x] Instant validate parameters when registering without having to send it for backend validation. ![Instant validation](examples/instant_validation.png)
 - [ ] Use checkout codes to validate the email instead of a link
 
 ## Installation
@@ -38,9 +42,21 @@ And then execute:
 bundle
 ```
 
+**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.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:
+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):
 
 ```ruby
 # config/initializers/friendly_signup.rb
@@ -48,14 +64,23 @@ Customize your integration by creating an initializer (ie: `config/initializes/f
 Decidim::FriendlySignup.configure do |config|
   # Override password views or leave the originals (default is true):
   config.override_passwords = false
-end
 
+  # Automatically validate user inputs in the register form (default is true):
+  config.use_instant_validation = false
+end
 ```
 
 ## 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:
@@ -133,23 +158,13 @@ commands shown above.
 
 ### Test code coverage
 
-If you want to generate the code coverage report for the tests, you can use
-the `SIMPLECOV=1` environment variable in the rspec command as follows:
+Test coverage should be generated automatically in the folder "coverage" once any test is run:
 
 ```bash
-$ SIMPLECOV=1 bundle exec rspec
+$ bundle exec rspec
+$ firefox coverage/index.html
 ```
 
-This will generate a folder named `coverage` in the project root which contains
-the code coverage report.
-
-### 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
-
 ## License
 
 See [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt).

data/app/controllers/concerns/decidim/friendly_signup/needs_header_snippets.rb

@@ -23,11 +23,8 @@ module Decidim
         @snippets
       end
 
-      def friendly_override_activated?(type)
-        case type
-        when :override_passwords
-          Decidim::FriendlySignup.override_passwords.present?
-        end
+      def friendly_override_activated?(feat)
+        Decidim::FriendlySignup.send(feat.to_s).present?
       end
     end
   end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module FriendlySignup
+    class ApplicationController < Decidim::ApplicationController
+    end
+  end
+end

data/app/controllers/decidim/friendly_signup/validator_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module FriendlySignup
+    class ValidatorController < ApplicationController
+      include Decidim::FormFactory
+
+      def validate
+        @form = form(Decidim::RegistrationForm).from_params(params)
+        validator = UserAttributeValidator.new(form: @form, attribute: params[:attribute])
+        render json: {
+          valid: validator.valid?,
+          error: validator.error
+        }
+      end
+    end
+  end
+end

data/app/packs/entrypoints/decidim_friendly_signup.js

@@ -1,4 +1,5 @@
-import "src/decidim/friendly_signup/password_helper"
+import "src/decidim/friendly_signup/setup_password"
+import "src/decidim/friendly_signup/setup_validations"
 
 // CSS
 import "entrypoints/decidim_friendly_signup.scss";

data/app/packs/src/decidim/friendly_signup/lib/instant_validator.js

@@ -0,0 +1,95 @@
+/* eslint-disable line-comment-position, no-ternary, no-inline-comments */
+
+// Instant, server-side validation
+// compatible with abide classes https://get.foundation/sites/docs/abide.html
+export default class InstantValidator {
+  // ms before xhr check
+  static get TIMEOUT() {
+    return 150;
+  }
+
+  constructor($form) {
+    this.$form = $form;
+    this.$inputs = $form.find("[data-instant-attribute]");
+    this.url = this.$form.data("validationUrl");
+  }
+
+  init() {
+    // this final validation prevents abide from resetting the field when user loses focus
+    this.$inputs.on("blur", (evt) => {
+      this.validate($(evt.currentTarget));
+    });
+    this.$inputs.on("keyup", (evt) => {
+      let $input = $(evt.currentTarget);
+      let checkTimeout = $input.data("checkTimeout");
+      // Trigger live validation with a delay to avoid throttling
+      if (checkTimeout) {
+        clearTimeout(checkTimeout);
+      }
+      $input.data("checkTimeout", setTimeout(() => {
+        this.validate($input);
+      }, this.TIMEOUT)
+      );
+    });
+  }
+
+  value($input) {
+    return $input.val().trim();
+  }
+
+  attribute($input) {
+    return $input.data("instantAttribute");
+  }
+
+  target($input) {
+    const $target = this.$form.find($input.data("instantTarget"));
+    return $target.length
+      ? $target
+      : $input;
+  }
+
+  validate($input) {
+    this.tamper($input);
+    this.post($input).done((response) => {
+      this.setFeedback(response, $input);
+    });
+  }
+
+  setFeedback(data, $input) {
+    if (data.valid) {
+      this.clearErrors($input);
+    } else {
+      this.addErrors(this.target($input), data.error);
+    }
+  }
+
+  tamper($dest) {
+    $dest.data("tampered", $dest.val().trim() !== "");
+  }
+
+  isTampered($dest) {
+    return $dest.data("tampered");
+  }
+
+  addErrors($dest, msg) {
+    if ($dest.closest("label").find(".form-error").length > 1) {
+      // Decidim may add and additional error class that does not play well with abide
+      $dest.closest("label").find(".form-error:last").remove();
+    }
+    this.$form.foundation("addErrorClasses", $dest);
+    if (msg) {
+      $dest.closest("label").find(".form-error").text(msg);
+    }
+  }
+
+  clearErrors($dest) {
+    this.$form.foundation("removeErrorClasses", $dest);
+  }
+
+  post($input) {
+    return $.ajax(this.url, {
+      method: "POST",
+      data: `${this.$form.serialize()}&attribute=${this.attribute($input)}`
+    });
+  }
+}

data/app/packs/src/decidim/friendly_signup/{password_helper.js → setup_password.js}

@@ -1,4 +1,4 @@
-import PasswordToggler from "src/decidim/friendly_signup/password_toggler";
+import PasswordToggler from "src/decidim/friendly_signup/lib/password_toggler";
 
 $(() => {
   window.Decidim = window.Decidim || {};

data/app/packs/src/decidim/friendly_signup/setup_validations.js

@@ -0,0 +1,7 @@
+import InstantValidator from "src/decidim/friendly_signup/lib/instant_validator";
+
+$(() => {
+  window.Decidim = window.Decidim || {};
+  window.Decidim.instantValidator = new InstantValidator($("form.instant-validation"));
+  window.Decidim.instantValidator.init();
+});

data/app/views/decidim/devise/registrations/new.html.erb

@@ -26,7 +26,7 @@
   <div class="row">
     <div class="columns large-6 medium-10 medium-centered">
 
-      <%= decidim_form_for(@form, namespace: "registration", as: resource_name, url: registration_path(resource_name), html: { class: "register-form new_user", id: "register-form" }) do |f| %>
+      <%= decidim_form_for(@form, namespace: "registration", as: resource_name, url: registration_path(resource_name), html: { class: "register-form new_user#{friendly_override_activated?(:use_instant_validation) && ' instant-validation'}", id: "register-form" }, data: { "validation-url": decidim_friendly_signup.validate_path }) do |f| %>
         <%= invisible_captcha %>
         <div class="card">
           <div class="card__content">
@@ -34,21 +34,21 @@
 
             <div class="user-person">
               <div class="field">
-                <%= f.text_field :name, help_text: t(".username_help") %>
+                <%= f.text_field :name, help_text: t(".username_help"), autocomplete: "off" %>
               </div>
             </div>
 
             <div class="user-nickname">
               <div class="field">
-                <%= f.text_field :nickname, help_text: t(".nickname_help", organization: current_organization.name), prefix: { value: "@", small: 1, large: 1 } %>
+                <%= f.text_field :nickname, help_text: t(".nickname_help", organization: current_organization.name), prefix: { value: "@", small: 1, large: 1 }, autocomplete: "off" %>
               </div>
             </div>
 
             <div class="field">
-              <%= f.email_field :email %>
+              <%= f.email_field :email, autocomplete: "email", data: { "instant-attribute": "email" } %>
             </div>
 
-            <%= render("decidim/friendly_signup/shared/password_fields", form: f, options: { help_text: t(".password_help", minimun_characters: ::PasswordValidator::MINIMUM_LENGTH), autocomplete: "off" }) %>
+            <%= render("decidim/friendly_signup/shared/password_fields", form: f, options: { required: true, help_text: t(".password_help", minimun_characters: ::PasswordValidator::MINIMUM_LENGTH), autocomplete: "off", data: { "instant-attribute": "password" } }) %>
           </div>
         </div>
 

data/app/views/decidim/friendly_signup/shared/_password_fields.html.erb

@@ -11,7 +11,7 @@
 
   <div class="user-password-confirmation">
     <div class="field">
-      <%= form.password_field :password_confirmation, options.except(:help_text, :autocomplete) %>
+      <%= form.password_field :password_confirmation %>
     </div>
   </div>
 <% else %>

data/lib/decidim/friendly_signup/engine.rb

@@ -9,6 +9,10 @@ module Decidim
     class Engine < ::Rails::Engine
       isolate_namespace Decidim::FriendlySignup
 
+      routes do
+        post :validate, to: "validator#validate"
+      end
+
       # Prepare a zone to create overrides
       # https://edgeguides.rubyonrails.org/engines.html#overriding-models-and-controllers
       # overrides

data/lib/decidim/friendly_signup/user_attribute_validator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Decidim
+  module FriendlySignup
+    class UserAttributeValidator
+      def initialize(attribute:, form:)
+        @attribute = attribute
+        @form = form
+      end
+
+      delegate :current_organization, to: :form
+      attr_reader :attribute, :form
+
+      def valid?
+        @valid ||= begin
+          form.validate
+          # we don't validate the form but the attribute alone
+          errors.blank?
+        end
+      end
+
+      def input
+        @input ||= form.public_send(attribute).to_s.dup if valid_attribute?
+      end
+
+      def errors
+        @errors ||= valid_attribute? ? form.errors[attribute] : ["Invalid attribute"]
+      end
+
+      def error
+        errors.flatten.map(&:upcase_first).join(". ") unless valid?
+      end
+
+      private
+
+      def valid_attribute?
+        %w(nickname email name password).include? attribute.to_s
+      end
+
+      def valid_suggestor?
+        ["nickname"].include? attribute.to_s
+      end
+
+      def valid_users
+        Decidim::UserBaseEntity.where(invitation_token: nil, organization: current_organization)
+      end
+    end
+  end
+end

data/lib/decidim/friendly_signup/version.rb

@@ -5,6 +5,6 @@ module Decidim
   module FriendlySignup
     DECIDIM_VERSION = "0.26.2"
     COMPAT_DECIDIM_VERSION = "~> 0.26.0"
-    VERSION = "0.1"
+    VERSION = "0.2"
   end
 end

data/lib/decidim/friendly_signup.rb

@@ -1,14 +1,29 @@
 # frozen_string_literal: true
 
+require "decidim/friendly_signup/version"
 require "decidim/friendly_signup/engine"
 
 module Decidim
   module FriendlySignup
     include ActiveSupport::Configurable
 
+    autoload :UserAttributeValidator, "decidim/friendly_signup/user_attribute_validator"
+
     # Whether to override passwords boxes or not
     config_accessor :override_passwords do
       true
     end
+
+    # Whether to use instant validation or not
+    config_accessor :use_instant_validation do
+      true
+    end
   end
 end
+
+# Engines to handle logic unrelated to participatory spaces or components
+Decidim.register_global_engine(
+  :decidim_friendly_signup, # this is the name of the global method to access engine routes
+  ::Decidim::FriendlySignup::Engine,
+  at: "/friendly_signup"
+)

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "decidim-module-friendly_signup",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "decidim-module-friendly_signup",
-      "version": "0.1.0",
+      "version": "0.2.0",
       "license": "AGPL-3.0-or-later",
       "devDependencies": {
         "eslint": "^7.25.0",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "decidim-module-friendly_signup",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A better signup process for Decidim",
   "main": "index.js",
   "directories": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-friendly_signup
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Ivan Vergés
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-core
@@ -49,11 +49,15 @@ files:
 - README.md
 - Rakefile
 - app/controllers/concerns/decidim/friendly_signup/needs_header_snippets.rb
+- app/controllers/decidim/friendly_signup/application_controller.rb
+- app/controllers/decidim/friendly_signup/validator_controller.rb
 - app/packs/entrypoints/decidim_friendly_signup.js
 - app/packs/entrypoints/decidim_friendly_signup.scss
 - app/packs/images/decidim/friendly_signup/icon.svg
-- app/packs/src/decidim/friendly_signup/password_helper.js
-- app/packs/src/decidim/friendly_signup/password_toggler.js
+- app/packs/src/decidim/friendly_signup/lib/instant_validator.js
+- app/packs/src/decidim/friendly_signup/lib/password_toggler.js
+- app/packs/src/decidim/friendly_signup/setup_password.js
+- app/packs/src/decidim/friendly_signup/setup_validations.js
 - app/packs/stylesheets/decidim/friendly_signup/_input-groups.scss
 - app/views/decidim/account/_password_fields.html.erb
 - app/views/decidim/devise/invitations/edit.html.erb
@@ -65,6 +69,7 @@ files:
 - config/locales/en.yml
 - lib/decidim/friendly_signup.rb
 - lib/decidim/friendly_signup/engine.rb
+- lib/decidim/friendly_signup/user_attribute_validator.rb
 - lib/decidim/friendly_signup/version.rb
 - package-lock.json
 - package.json