devise_invitable 1.7.5 → 2.0.5

data/lib/devise_invitable/mailer.rb

@@ -4,7 +4,7 @@ module DeviseInvitable
   module Mailer
 
     # Deliver an invitation email
-    def invitation_instructions(record, token, opts={})
+    def invitation_instructions(record, token, opts = {})
       @token = token
       devise_mail(record, :invitation_instructions, opts)
     end

data/lib/devise_invitable/mapping.rb

@@ -1,10 +1,11 @@
 module DeviseInvitable
   module Mapping
     private
-    def default_controllers(options)
-      options[:controllers] ||= {}
-      options[:controllers][:registrations] ||= "devise_invitable/registrations"
-      super
-    end
+
+      def default_controllers(options)
+        options[:controllers] ||= {}
+        options[:controllers][:registrations] ||= 'devise_invitable/registrations'
+        super
+      end
   end
 end

data/lib/devise_invitable/models.rb

@@ -10,15 +10,15 @@ module Devise
     #
     # Configuration:
     #
-    #   invite_for: The period the generated invitation token is valid, after
-    #               this period, the invited resource won't be able to accept the invitation.
+    #   invite_for: The period the generated invitation token is valid.
+    #               After this period, the invited resource won't be able to accept the invitation.
     #               When invite_for is 0 (the default), the invitation won't expire.
     #
     # Examples:
     #
     #   User.find(1).invited_to_sign_up?                    # => true/false
-    #   User.invite!(:email => 'someone@example.com')       # => send invitation
-    #   User.accept_invitation!(:invitation_token => '...') # => accept invitation with a token
+    #   User.invite!(email: 'someone@example.com')          # => send invitation
+    #   User.accept_invitation!(invitation_token: '...')    # => accept invitation with a token
     #   User.find(1).accept_invitation!                     # => accept invitation
     #   User.find(1).invite!                                # => reset invitation status and send invitation again
     module Invitable
@@ -31,34 +31,34 @@ module Devise
       included do
         include ::DeviseInvitable::Inviter
         belongs_to_options = if Devise.invited_by_class_name
-          {:class_name => Devise.invited_by_class_name}
+          { class_name: Devise.invited_by_class_name }
         else
-          {:polymorphic => true}
+          { polymorphic: true }
         end
         if fk = Devise.invited_by_foreign_key
           belongs_to_options[:foreign_key] = fk
         end
         if defined?(ActiveRecord) && defined?(ActiveRecord::Base) && self < ActiveRecord::Base
           counter_cache = Devise.invited_by_counter_cache
-          belongs_to_options.merge! :counter_cache => counter_cache if counter_cache
-          belongs_to_options.merge! :optional => true if ActiveRecord::VERSION::MAJOR >= 5
+          belongs_to_options.merge! counter_cache: counter_cache if counter_cache
+          belongs_to_options.merge! optional: true if ActiveRecord::VERSION::MAJOR >= 5
         elsif defined?(Mongoid) && defined?(Mongoid::Document) && self < Mongoid::Document && Mongoid::VERSION >= '6.0.0'
-          belongs_to_options.merge! :optional => true
+          belongs_to_options.merge! optional: true
         end
-        belongs_to :invited_by, belongs_to_options
+        belongs_to :invited_by, **belongs_to_options
 
         extend ActiveModel::Callbacks
         define_model_callbacks :invitation_created
         define_model_callbacks :invitation_accepted
 
-        scope :no_active_invitation, lambda { where(:invitation_token => nil) }
+        scope :no_active_invitation, lambda { where(invitation_token: nil) }
         if defined?(Mongoid) && defined?(Mongoid::Document) && self < Mongoid::Document
           scope :created_by_invite, lambda { where(:invitation_created_at.ne => nil) }
-          scope :invitation_not_accepted, lambda { where(:invitation_accepted_at => nil, :invitation_token.ne => nil) }
+          scope :invitation_not_accepted, lambda { where(invitation_accepted_at: nil, :invitation_token.ne => nil) }
           scope :invitation_accepted, lambda { where(:invitation_accepted_at.ne => nil) }
         else
           scope :created_by_invite, lambda { where(arel_table[:invitation_created_at].not_eq(nil)) }
-          scope :invitation_not_accepted, lambda { where(arel_table[:invitation_token].not_eq(nil)).where(:invitation_accepted_at => nil) }
+          scope :invitation_not_accepted, lambda { where(arel_table[:invitation_token].not_eq(nil)).where(invitation_accepted_at: nil) }
           scope :invitation_accepted, lambda { where(arel_table[:invitation_accepted_at].not_eq(nil)) }
 
           callbacks = [
@@ -158,7 +158,7 @@ module Devise
           self.downcase_keys if new_record_and_responds_to?(:downcase_keys)
           self.strip_whitespace if new_record_and_responds_to?(:strip_whitespace)
 
-          if save(:validate => false)
+          if save(validate: false)
             self.invited_by.decrement_invitation_limit! if !was_invited and self.invited_by.present?
             deliver_invitation(options) unless skip_invitation
           end
@@ -274,7 +274,7 @@ module Devise
         end
 
         def generate_invitation_token!
-          generate_invitation_token && save(:validate => false)
+          generate_invitation_token && save(validate: false)
         end
 
         def new_record_and_responds_to?(method)
@@ -298,7 +298,7 @@ module Devise
         # email is resent unless resend_invitation is set to false.
         # Attributes must contain the user's email, other attributes will be
         # set in the record
-        def _invite(attributes={}, invited_by=nil, options = {}, &block)
+        def _invite(attributes = {}, invited_by = nil, options = {}, &block)
           invite_key_array = invite_key_fields
           attributes_hash = {}
           invite_key_array.each do |k,v|
@@ -328,12 +328,12 @@ module Devise
           [invitable, mail]
         end
 
-        def invite!(attributes={}, invited_by=nil, options = {}, &block)
+        def invite!(attributes = {}, invited_by = nil, options = {}, &block)
           attr_hash = ActiveSupport::HashWithIndifferentAccess.new(attributes.to_h)
           _invite(attr_hash, invited_by, options, &block).first
         end
 
-        def invite_mail!(attributes={}, invited_by=nil, options = {}, &block)
+        def invite_mail!(attributes = {}, invited_by = nil, options = {}, &block)
           _invite(attributes, invited_by, options, &block).last
         end
 
@@ -342,7 +342,7 @@ module Devise
         # the record. If not user is found, returns a new user containing an
         # error in invitation_token attribute.
         # Attributes must contain invitation_token, password and confirmation
-        def accept_invitation!(attributes={})
+        def accept_invitation!(attributes = {})
           original_token = attributes.delete(:invitation_token)
           invitable = find_by_invitation_token(original_token, false)
           if invitable.errors.empty?
@@ -391,15 +391,17 @@ module Devise
 
         private
 
-        # The random password, as set after an invitation, must conform
-        # to any password format validation rules of the application.
-        # This default fixes the most common scenarios: Passwords must contain
-        # lower + upper case, a digit and a symbol.
-        # For more unusual rules, this method can be overridden.
-        def random_password
-          "aA1!" + Devise.friendly_token[0, 20]
-        end
+          # The random password, as set after an invitation, must conform
+          # to any password format validation rules of the application.
+          # This default fixes the most common scenarios: Passwords must contain
+          # lower + upper case, a digit and a symbol.
+          # For more unusual rules, this method can be overridden.
+          def random_password
+            length = respond_to?(:password_length) ? password_length : Devise.password_length
 
+            prefix = 'aA1!'
+            prefix + Devise.friendly_token(length.last - prefix.length)
+          end
       end
     end
   end

data/lib/devise_invitable/models/authenticatable.rb

@@ -1,11 +1,17 @@
 module Devise
   module Models
     module Authenticatable
-      BLACKLIST_FOR_SERIALIZATION.concat %i[
+      list = %i[
         invitation_token invitation_created_at invitation_sent_at
         invitation_accepted_at invitation_limit invited_by_type
         invited_by_id invitations_count
       ]
+      
+      if defined?(UNSAFE_ATTRIBUTES_FOR_SERIALIZATION)
+        UNSAFE_ATTRIBUTES_FOR_SERIALIZATION.concat(list)
+      else
+        BLACKLIST_FOR_SERIALIZATION.concat(list)
+      end
     end
   end
 end

data/lib/devise_invitable/parameter_sanitizer.rb

@@ -12,27 +12,27 @@ module DeviseInvitable
 
     private
 
-    if defined?(Devise::BaseSanitizer)
-      def permit(keys)
-        default_params.permit(*Array(keys))
-      end
+      if defined?(Devise::BaseSanitizer)
+        def permit(keys)
+          default_params.permit(*Array(keys))
+        end
 
-      def attributes_for(kind)
-        case kind
-        when :invite
-          resource_class.respond_to?(:invite_key_fields) ? resource_class.invite_key_fields : []
-        when :accept_invitation
-          [:password, :password_confirmation, :invitation_token]
-        else
+        def attributes_for(kind)
+          case kind
+          when :invite
+            resource_class.respond_to?(:invite_key_fields) ? resource_class.invite_key_fields : []
+          when :accept_invitation
+            [:password, :password_confirmation, :invitation_token]
+          else
+            super
+          end
+        end
+      else
+        def initialize(resource_class, resource_name, params)
           super
+          permit(:invite, keys: (resource_class.respond_to?(:invite_key_fields) ? resource_class.invite_key_fields : []) )
+          permit(:accept_invitation, keys: [:password, :password_confirmation, :invitation_token] )
         end
       end
-    else
-      def initialize(resource_class, resource_name, params)
-        super
-        permit(:invite, keys: (resource_class.respond_to?(:invite_key_fields) ? resource_class.invite_key_fields : []) )
-        permit(:accept_invitation, keys: [:password, :password_confirmation, :invitation_token] )
-      end
-    end
   end
 end

data/lib/devise_invitable/routes.rb

@@ -2,13 +2,13 @@ module ActionDispatch::Routing
   class Mapper
 
   protected
+
     def devise_invitation(mapping, controllers)
-      resource :invitation, :only => [:new, :create, :update],
-        :path => mapping.path_names[:invitation], :controller => controllers[:invitations] do
-        get :edit, :path => mapping.path_names[:accept], :as => :accept
-        get :destroy, :path => mapping.path_names[:remove], :as => :remove
+      resource :invitation, only: [:new, :create, :update],
+        path: mapping.path_names[:invitation], controller: controllers[:invitations] do
+        get :edit, path: mapping.path_names[:accept], as: :accept
+        get :destroy, path: mapping.path_names[:remove], as: :remove
       end
     end
-
   end
 end

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '1.7.5'
+  VERSION = '2.0.5'.freeze
 end

data/lib/generators/active_record/devise_invitable_generator.rb

@@ -3,14 +3,14 @@ require 'rails/generators/active_record'
 module ActiveRecord
   module Generators
     class DeviseInvitableGenerator < ActiveRecord::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('../templates', __FILE__)
 
       def copy_devise_migration
-        migration_template "migration.rb", "db/migrate/devise_invitable_add_to_#{table_name}.rb", migration_version: migration_version
+        migration_template 'migration.rb', "db/migrate/devise_invitable_add_to_#{table_name}.rb", migration_version: migration_version
       end
 
       def migration_version
-        if Rails.version.start_with? '5.'
+        if Rails::VERSION::MAJOR >= 5
           "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
         end
       end

data/lib/generators/active_record/templates/migration.rb

@@ -8,7 +8,6 @@ class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration<%
       t.integer    :invitation_limit
       t.references :invited_by, polymorphic: true
       t.integer    :invitations_count, default: 0
-      t.index      :invitations_count
       t.index      :invitation_token, unique: true # for invitable
       t.index      :invited_by_id
     end

data/lib/generators/devise_invitable/devise_invitable_generator.rb

@@ -1,17 +1,13 @@
 module DeviseInvitable
   module Generators
     class DeviseInvitableGenerator < Rails::Generators::NamedBase
-      namespace "devise_invitable"
+      namespace 'devise_invitable'
 
-      desc "Add :invitable directive in the given model. Also generate migration for ActiveRecord"
-
-      # def devise_generate_model
-      #   invoke "devise", [name]
-      # end
+      desc 'Add :invitable directive in the given model. Also generate migration for ActiveRecord'
 
       def inject_devise_invitable_content
-        path = File.join("app", "models", "#{file_path}.rb")
-        inject_into_file(path, "invitable, :", :after => "devise :") if File.exists?(path)
+        path = File.join('app', 'models', "#{file_path}.rb")
+        inject_into_file(path, 'invitable, :', after: 'devise :') if File.exists?(path)
       end
 
       hook_for :orm

data/lib/generators/devise_invitable/install_generator.rb

@@ -1,26 +1,22 @@
 module DeviseInvitable
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../templates", __FILE__)
-      desc "Add DeviseInvitable config variables to the Devise initializer and copy DeviseInvitable locale files to your application."
-
-      # def devise_install
-      #   invoke "devise:install"
-      # end
+      source_root File.expand_path('../../templates', __FILE__)
+      desc 'Add DeviseInvitable config variables to the Devise initializer and copy DeviseInvitable locale files to your application.'
 
       def add_config_options_to_initializer
-        devise_initializer_path = "config/initializers/devise.rb"
+        devise_initializer_path = 'config/initializers/devise.rb'
         if File.exist?(devise_initializer_path)
           old_content = File.read(devise_initializer_path)
 
           if old_content.match(Regexp.new(/^\s# ==> Configuration for :invitable\n/))
             false
           else
-            inject_into_file(devise_initializer_path, :before => "  # ==> Configuration for :confirmable\n") do
+            inject_into_file(devise_initializer_path, before: "  # ==> Configuration for :confirmable\n") do
 <<-CONTENT
   # ==> Configuration for :invitable
-  # The period the generated invitation token is valid, after
-  # this period, the invited resource won't be able to accept the invitation.
+  # The period the generated invitation token is valid.
+  # After this period, the invited resource won't be able to accept the invitation.
   # When invite_for is 0 (the default), the invitation won't expire.
   # config.invite_for = 2.weeks
 
@@ -36,10 +32,11 @@ module DeviseInvitable
 
   # The key to be used to check existing users when sending an invitation
   # and the regexp used to test it when validate_on_invite is not set.
-  # config.invite_key = {:email => /\\A[^@]+@[^@]+\\z/}
-  # config.invite_key = {:email => /\\A[^@]+@[^@]+\\z/, :username => nil}
+  # config.invite_key = { email: /\\A[^@]+@[^@]+\\z/ }
+  # config.invite_key = { email: /\\A[^@]+@[^@]+\\z/, username: nil }
 
-  # Flag that force a record to be valid before being actually invited
+  # Ensure that invited record is valid.
+  # The invitation won't be sent if this check fails.
   # Default: false
   # config.validate_on_invite = true
 
@@ -73,7 +70,7 @@ CONTENT
       end
 
       def copy_locale
-        copy_file "../../../config/locales/en.yml", "config/locales/devise_invitable.en.yml"
+        copy_file '../../../config/locales/en.yml', 'config/locales/devise_invitable.en.yml'
       end
 
     end

data/lib/generators/devise_invitable/templates/simple_form_for/invitations/edit.html.erb

@@ -1,11 +1,15 @@
-<h2><%= t 'devise.invitations.edit.header' %></h2>
+<h2><%= t "devise.invitations.edit.header" %></h2>
 
-<%= simple_form_for resource, as: resource_name, url: invitation_path(resource_name), html: { method: :put } do |f| %>
-  <%= devise_error_messages! %>
+<%= simple_form_for(resource, as: resource_name, url: invitation_path(resource_name), html: { method: :put }) do |f| %>
+  <%= f.error_notification %>
   <%= f.hidden_field :invitation_token %>
 
-  <%= f.input :password %>
-  <%= f.input :password_confirmation %>
+  <div class="form-inputs">
+    <%= f.input :password %>
+    <%= f.input :password_confirmation %>
+  </div>
 
-  <%= f.button :submit, t("devise.invitations.edit.submit_button") %>
+  <div class="form-actions">
+    <%= f.button :submit, t("devise.invitations.edit.submit_button") %>
+  </div>
 <% end %>

data/lib/generators/devise_invitable/templates/simple_form_for/invitations/new.html.erb

@@ -1,11 +1,15 @@
 <h2><%= t "devise.invitations.new.header" %></h2>
 
-<%= simple_form_for resource, as: resource_name, url: invitation_path(resource_name), html: { method: :post} do |f| %>
-  <%= devise_error_messages! %>
+<%= simple_form_for(resource, as: resource_name, url: invitation_path(resource_name), html: { method: :post }) do |f| %>
+  <%= f.error_notification %>
 
-<% resource.class.invite_key_fields.each do |field| -%>
-  <%= f.input field %>
-<% end -%>
+  <% resource.class.invite_key_fields.each do |field| -%>
+    <div class="form-inputs">
+      <%= f.input field %>
+    </div>
+  <% end -%>
 
-<%= f.button :submit, t("devise.invitations.new.submit_button") %>
+  <div class="form-actions">
+    <%= f.button :submit, t("devise.invitations.new.submit_button") %>
+  </div>
 <% end %>

data/lib/generators/devise_invitable/views_generator.rb

@@ -11,17 +11,17 @@ module DeviseInvitable
     end
 
     class SimpleFormForGenerator < InvitationViewsGenerator
-      source_root File.expand_path("../templates/simple_form_for", __FILE__)
+      source_root File.expand_path('../templates/simple_form_for', __FILE__)
     end
 
     class FormForGenerator < InvitationViewsGenerator
-      source_root File.expand_path("../../../../app/views/devise", __FILE__)
+      source_root File.expand_path('../../../../app/views/devise', __FILE__)
     end
 
     class MailerViewsGenerator < Rails::Generators::Base
       include ::Devise::Generators::ViewPathTemplates
-      source_root File.expand_path("../../../../app/views/devise", __FILE__)
-      desc "Copies Devise mail erb views to your application."
+      source_root File.expand_path('../../../../app/views/devise', __FILE__)
+      desc 'Copies Devise mail erb views to your application.'
       hide!
 
       def copy_views
@@ -31,11 +31,11 @@ module DeviseInvitable
 
     class ViewsGenerator < Rails::Generators::Base
       desc 'Copies all DeviseInvitable views to your application.'
-      argument :scope, :required => false, :default => nil, :desc => "The scope to copy views to"
+      argument :scope, required: false, default: nil, desc: 'The scope to copy views to'
 
       invoke MailerViewsGenerator
 
-      hook_for :form_builder, :aliases => "-b", :desc => "Form builder to be used", :default => defined?(SimpleForm) ? "simple_form_for" : "form_for"
+      hook_for :form_builder, aliases: '-b', desc: 'Form builder to be used', default: defined?(SimpleForm) ? 'simple_form_for' : 'form_for'
     end
   end
 end