devise-multi_email_revived 3.0.1

data/lib/devise/multi-email/parent_model_extensions.rb

@@ -0,0 +1,28 @@
+require 'devise/multi_email/email_model_extensions'
+require 'devise/multi_email/association_manager'
+require 'devise/multi_email/parent_model_manager'
+
+module Devise
+  module MultiEmail
+    module ParentModelExtensions
+      extend ActiveSupport::Concern
+
+      included do
+        multi_email_association.configure_autosave!
+        multi_email_association.include_module(EmailModelExtensions)
+      end
+
+      delegate Devise::MultiEmail.primary_email_method_name, to: :multi_email, allow_nil: false
+
+      def multi_email
+        @multi_email ||= ParentModelManager.new(self)
+      end
+
+      module ClassMethods
+        def multi_email_association
+          @multi_email ||= AssociationManager.new(self, Devise::MultiEmail.emails_association_name)
+        end
+      end
+    end
+  end
+end

data/lib/devise/multi-email/parent_model_manager.rb

@@ -0,0 +1,90 @@
+require 'devise/multi_email/email_model_extensions'
+
+module Devise
+  module MultiEmail
+    class ParentModelManager
+
+      def initialize(parent_record)
+        @parent_record = parent_record
+      end
+
+      def current_email_record
+        login_email_record || primary_email_record
+      end
+
+      def login_email_record
+        if @parent_record.current_login_email.present?
+          formatted_email = format_email(@parent_record.current_login_email)
+          filtered_emails.find { |item| item.email == formatted_email }
+        end
+      end
+
+      # Gets the primary email record.
+      def primary_email_record
+        filtered_emails.find(&:primary?)
+      end
+      alias_method Devise::MultiEmail.primary_email_method_name, :primary_email_record
+
+      # :allow_unconfirmed option sets this email record to primary
+      # :skip_confirmations option confirms this email record (without saving)
+      # @see `set_primary_record_to`
+      def change_primary_email_to(new_email, options = {})
+        # mark none as primary when set to nil
+        if new_email.nil?
+          filtered_emails.each { |item| item.primary = false }
+
+        # select or build an email record
+        else
+          record = find_or_build_for_email(new_email)
+
+          if record.try(:confirmed?) || primary_email_record.nil? || options[:allow_unconfirmed]
+            set_primary_record_to(record, options)
+          end
+        end
+
+        record
+      end
+
+      # Use Devise formatting settings for emails
+      def format_email(email)
+        @parent_record.class.__send__(:devise_parameter_filter).filter(email: email)[:email]
+      end
+
+      def find_or_build_for_email(email)
+        formatted_email = format_email(email)
+        record = filtered_emails.find { |item| item.email == formatted_email }
+        record || emails.build(email: formatted_email)
+      end
+
+      def emails
+        @parent_record.__send__(@parent_record.class.multi_email_association.name)
+      end
+
+      # Gets the email records that have not been deleted
+      def filtered_emails(options = {})
+        emails.to_a.reject(&:destroyed?).reject(&:marked_for_destruction?)
+      end
+
+      def confirmed_emails
+        filtered_emails.select { |record| record.try(:confirmed?) }
+      end
+
+      def unconfirmed_emails
+        filtered_emails.reject { |record| record.try(:confirmed?) }
+      end
+
+    protected
+
+      # :skip_confirmations option confirms this email record (without saving)
+      def set_primary_record_to(record, options = {})
+        # Toggle primary flag for all emails
+        filtered_emails.each { |other| other.primary = (other.email == record.email) }
+
+        if options[:skip_confirmations]
+          record.try(:skip_confirmation!)
+          record.try(:skip_reconfirmation!)
+        end
+      end
+    end
+  end
+end

data/lib/devise/multi-email/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module MultiEmail
+    VERSION = "3.0.1"
+  end
+end

data/lib/devise/multi_email/association_manager.rb

@@ -0,0 +1,43 @@
+
+module Devise
+  module MultiEmail
+    class AssociationManager
+
+      attr_reader :name
+
+      def initialize(klass, association_name)
+        @klass = klass
+        @name = association_name
+      end
+
+      def include_module(mod)
+        model_class.__send__ :include, mod
+      end
+
+      # Specify a block with alternative behavior which should be
+      # run when `autosave` is not enabled.
+      def configure_autosave!(&block)
+        unless autosave_enabled?
+          if Devise::MultiEmail.autosave_emails?
+            reflection.autosave = true
+          else
+            yield if block_given?
+          end
+        end
+      end
+
+      def autosave_enabled?
+        reflection.options[:autosave] == true
+      end
+
+      def model_class
+        @model_class ||= reflection.class_name.constantize
+      end
+
+      def reflection
+        @reflection ||= @klass.reflect_on_association(name) ||
+                        raise("#{@klass}##{name} association not found: It might be because your declaration is after `devise :multi_email_confirmable`.")
+      end
+    end
+  end
+end

data/lib/devise/multi_email/email_model_extensions.rb

@@ -0,0 +1,20 @@
+require 'devise/multi_email/association_manager'
+require 'devise/multi_email/email_model_manager'
+
+module Devise
+  module MultiEmail
+    module EmailModelExtensions
+      extend ActiveSupport::Concern
+
+      def multi_email
+        @multi_email ||= EmailModelManager.new(self)
+      end
+
+      module ClassMethods
+        def multi_email_association
+          @multi_email ||= AssociationManager.new(self, Devise::MultiEmail.parent_association_name)
+        end
+      end
+    end
+  end
+end

data/lib/devise/multi_email/email_model_manager.rb

@@ -0,0 +1,16 @@
+require 'devise/multi_email/email_model_extensions'
+
+module Devise
+  module MultiEmail
+    class EmailModelManager
+
+      def initialize(email_record)
+        @email_record = email_record
+      end
+
+      def parent
+        @email_record.__send__(@email_record.class.multi_email_association.name)
+      end
+    end
+  end
+end

data/lib/devise/multi_email/models/authenticatable.rb

@@ -0,0 +1,96 @@
+require 'devise/multi_email/parent_model_extensions'
+
+module Devise
+  module Models
+    module EmailAuthenticatable
+      def devise_scope
+        self.class.multi_email_association.model_class
+      end
+    end
+
+    module MultiEmailAuthenticatable
+      extend ActiveSupport::Concern
+
+      included do
+        include Devise::MultiEmail::ParentModelExtensions
+
+        attr_accessor :current_login_email
+
+        devise :database_authenticatable
+
+        include AuthenticatableExtensions
+      end
+
+      def self.required_fields(klass)
+        []
+      end
+
+      module AuthenticatableExtensions
+        extend ActiveSupport::Concern
+
+        included do
+          multi_email_association.configure_autosave!{ include AuthenticatableAutosaveExtensions }
+          multi_email_association.include_module(EmailAuthenticatable)
+        end
+
+        delegate :skip_confirmation!, to: Devise::MultiEmail.primary_email_method_name, allow_nil: false
+
+        # Gets the primary email address of the user.
+        def email
+          multi_email.primary_email_record.try(:email)
+        end
+
+        # Sets the default email address of the user.
+        def email=(new_email)
+          multi_email.change_primary_email_to(new_email, allow_unconfirmed: true)
+        end
+      end
+
+      module AuthenticatableAutosaveExtensions
+        extend ActiveSupport::Concern
+
+        included do
+          # Toggle `primary` value for all emails if `autosave` is not on
+          after_save do
+            multi_email.filtered_emails.each do |email|
+              # update value in database without persisting any other changes
+              email.save if email.changes.key?(:primary)
+            end
+          end
+        end
+      end
+
+      module ClassMethods
+        def find_first_by_auth_conditions(tainted_conditions, opts = {})
+          filtered_conditions = devise_parameter_filter.filter(tainted_conditions.dup)
+          criteria = filtered_conditions.extract!(:email, :unconfirmed_email)
+
+          if criteria.keys.any?
+            conditions = filtered_conditions.to_h.merge(opts).
+              reverse_merge(build_conditions(criteria))
+
+            resource = joins(multi_email_association.name).find_by(conditions)
+            resource.current_login_email = criteria.values.first if resource
+            resource
+          else
+            super(tainted_conditions, opts)
+          end
+        end
+
+        def find_by_email(email)
+          joins(multi_email_association.name).where(build_conditions email: email).first
+        end
+
+        def build_conditions(criteria)
+          criteria = devise_parameter_filter.filter(criteria)
+          # match the primary email record if the `unconfirmed_email` column is specified
+          if Devise::MultiEmail.only_login_with_primary_email? || criteria[:unconfirmed_email]
+            criteria.merge!(primary: true)
+          end
+
+          { multi_email_association.reflection.table_name.to_sym => criteria }
+        end
+      end
+    end
+  end
+end

data/lib/devise/multi_email/models/confirmable.rb

@@ -0,0 +1,108 @@
+require 'devise/multi_email/parent_model_extensions'
+
+module Devise
+  module Models
+    module EmailConfirmable
+      extend ActiveSupport::Concern
+
+      included do
+        devise :confirmable
+
+        include ConfirmableExtensions
+      end
+
+      module ConfirmableExtensions
+        def confirmation_period_valid?
+          primary? ? super : false
+        end
+      end
+    end
+
+    module MultiEmailConfirmable
+      extend ActiveSupport::Concern
+
+      included do
+        include Devise::MultiEmail::ParentModelExtensions
+
+        devise :confirmable
+
+        include ConfirmableExtensions
+      end
+
+      def self.required_fields(klass)
+        []
+      end
+
+      module ConfirmableExtensions
+        extend ActiveSupport::Concern
+
+        included do
+          multi_email_association.include_module(EmailConfirmable)
+        end
+
+        # delegate before creating overriding methods
+        delegate :skip_confirmation!, :skip_confirmation_notification!, :skip_reconfirmation!, :confirmation_required?,
+                 :confirmation_token, :confirmed_at, :confirmed_at=, :confirmation_sent_at, :confirm, :confirmed?, :unconfirmed_email,
+                 :reconfirmation_required?, :pending_reconfirmation?, to: Devise::MultiEmail.primary_email_method_name, allow_nil: true
+
+        # In case email updates are being postponed, don't change anything
+        # when the postpone feature tries to switch things back
+        def email=(new_email)
+          multi_email.change_primary_email_to(new_email, allow_unconfirmed: unconfirmed_access_possible?)
+        end
+
+        # This need to be forwarded to the email that the user logged in with
+        def active_for_authentication?
+          login_email = multi_email.login_email_record
+
+          if login_email && !login_email.primary?
+            super && login_email.active_for_authentication?
+          else
+            super
+          end
+        end
+
+        # Shows email not confirmed instead of account inactive when the email that user used to login is not confirmed
+        def inactive_message
+          login_email = multi_email.login_email_record
+
+          if login_email && !login_email.primary? && !login_email.confirmed?
+            :unconfirmed
+          else
+            super
+          end
+        end
+
+      protected
+
+        # Overrides Devise::Models::Confirmable#postpone_email_change?
+        def postpone_email_change?
+          false
+        end
+
+        # Email should handle the confirmation token.
+        def generate_confirmation_token
+        end
+
+        # Email will send reconfirmation instructions.
+        def send_reconfirmation_instructions
+        end
+
+        # Email will send confirmation instructions.
+        def send_on_create_confirmation_instructions
+        end
+
+      private
+
+        def unconfirmed_access_possible?
+          Devise.allow_unconfirmed_access_for.nil? || \
+            Devise.allow_unconfirmed_access_for > 0.days
+        end
+
+        module ClassMethods
+          delegate :confirm_by_token, :send_confirmation_instructions, to: 'multi_email_association.model_class', allow_nil: false
+        end
+      end
+    end
+  end
+end

data/lib/devise/multi_email/models/validatable.rb

@@ -0,0 +1,107 @@
+require 'devise/multi_email/parent_model_extensions'
+
+module Devise
+  module Models
+    module EmailValidatable
+      extend ActiveSupport::Concern
+
+      included do
+        validates_presence_of   :email, if: :email_required?
+        validates_uniqueness_of :email, allow_blank: true, case_sensitive: true, if: :will_save_change_to_email?
+        validates_format_of     :email, with: email_regexp, allow_blank: true, if: :will_save_change_to_email?
+      end
+
+      def email_required?
+        true
+      end
+
+      module ClassMethods
+        Devise::Models.config(self, :email_regexp)
+      end
+    end
+
+    module MultiEmailValidatable
+      extend ActiveSupport::Concern
+
+      included do
+        include Devise::MultiEmail::ParentModelExtensions
+
+        assert_validations_api!(self)
+
+        validates_presence_of     :email, if: :email_required?
+
+        validates_presence_of     :password, if: :password_required?
+        validates_confirmation_of :password, if: :password_required?
+        validates_length_of       :password, within: password_length, allow_blank: true
+
+        after_validation :propagate_email_errors
+
+        multi_email_association.include_module(EmailValidatable)
+
+        devise_modules << :validatable
+      end
+
+      def self.required_fields(klass)
+        []
+      end
+
+    protected
+
+      # Same as Devise::Models::Validatable#password_required?
+      def password_required?
+        !persisted? || !password.nil? || !password_confirmation.nil?
+      end
+
+      # Same as Devise::Models::Validatable#email_required?
+      def email_required?
+        true
+      end
+
+    private
+
+      def propagate_email_errors
+        association_name = self.class.multi_email_association.name
+        email_error_key = errors_attribute_names.detect do |key|
+          [association_name.to_s, "#{association_name}.email"].include?(key.to_s)
+        end
+        return unless email_error_key.present?
+
+        email_errors =
+          if errors.respond_to?(:details)
+            errors
+              .details[email_error_key]
+              .map { |e| e[:error] }
+              .zip(errors.delete(email_error_key) || [])
+          else
+            errors.delete(email_error_key)
+          end
+
+        email_errors.each do |type, message|
+          errors.add(:email, type, message: message)
+        end
+      end
+
+      def errors_attribute_names
+        errors.respond_to?(:attribute_names) ? errors.attribute_names : errors.keys
+      end
+
+      module ClassMethods
+
+        # All validations used by this module.
+        VALIDATIONS = [:validates_presence_of, :validates_uniqueness_of, :validates_format_of,
+                       :validates_confirmation_of, :validates_length_of].freeze
+
+        def assert_validations_api!(base) #:nodoc:
+          unavailable_validations = VALIDATIONS.select { |v| !base.respond_to?(v) }
+
+          unless unavailable_validations.empty?
+            raise "Could not use :validatable module since #{base} does not respond " <<
+                  "to the following methods: #{unavailable_validations.to_sentence}."
+          end
+        end
+
+        Devise::Models.config(self, :password_length)
+      end
+    end
+  end
+end

data/lib/devise/multi_email/parent_model_extensions.rb

@@ -0,0 +1,28 @@
+require 'devise/multi_email/email_model_extensions'
+require 'devise/multi_email/association_manager'
+require 'devise/multi_email/parent_model_manager'
+
+module Devise
+  module MultiEmail
+    module ParentModelExtensions
+      extend ActiveSupport::Concern
+
+      included do
+        multi_email_association.configure_autosave!
+        multi_email_association.include_module(EmailModelExtensions)
+      end
+
+      delegate Devise::MultiEmail.primary_email_method_name, to: :multi_email, allow_nil: false
+
+      def multi_email
+        @multi_email ||= ParentModelManager.new(self)
+      end
+
+      module ClassMethods
+        def multi_email_association
+          @multi_email ||= AssociationManager.new(self, Devise::MultiEmail.emails_association_name)
+        end
+      end
+    end
+  end
+end

data/lib/devise/multi_email/parent_model_manager.rb

@@ -0,0 +1,90 @@
+require 'devise/multi_email/email_model_extensions'
+
+module Devise
+  module MultiEmail
+    class ParentModelManager
+
+      def initialize(parent_record)
+        @parent_record = parent_record
+      end
+
+      def current_email_record
+        login_email_record || primary_email_record
+      end
+
+      def login_email_record
+        if @parent_record.current_login_email.present?
+          formatted_email = format_email(@parent_record.current_login_email)
+          filtered_emails.find { |item| item.email == formatted_email }
+        end
+      end
+
+      # Gets the primary email record.
+      def primary_email_record
+        filtered_emails.find(&:primary?)
+      end
+      alias_method Devise::MultiEmail.primary_email_method_name, :primary_email_record
+
+      # :allow_unconfirmed option sets this email record to primary
+      # :skip_confirmations option confirms this email record (without saving)
+      # @see `set_primary_record_to`
+      def change_primary_email_to(new_email, options = {})
+        # mark none as primary when set to nil
+        if new_email.nil?
+          filtered_emails.each { |item| item.primary = false }
+
+        # select or build an email record
+        else
+          record = find_or_build_for_email(new_email)
+
+          if record.try(:confirmed?) || primary_email_record.nil? || options[:allow_unconfirmed]
+            set_primary_record_to(record, options)
+          end
+        end
+
+        record
+      end
+
+      # Use Devise formatting settings for emails
+      def format_email(email)
+        @parent_record.class.__send__(:devise_parameter_filter).filter(email: email)[:email]
+      end
+
+      def find_or_build_for_email(email)
+        formatted_email = format_email(email)
+        record = filtered_emails.find { |item| item.email == formatted_email }
+        record || emails.build(email: formatted_email)
+      end
+
+      def emails
+        @parent_record.__send__(@parent_record.class.multi_email_association.name)
+      end
+
+      # Gets the email records that have not been deleted
+      def filtered_emails(options = {})
+        emails.to_a.reject(&:destroyed?).reject(&:marked_for_destruction?)
+      end
+
+      def confirmed_emails
+        filtered_emails.select { |record| record.try(:confirmed?) }
+      end
+
+      def unconfirmed_emails
+        filtered_emails.reject { |record| record.try(:confirmed?) }
+      end
+
+    protected
+
+      # :skip_confirmations option confirms this email record (without saving)
+      def set_primary_record_to(record, options = {})
+        # Toggle primary flag for all emails
+        filtered_emails.each { |other| other.primary = (other.email == record.email) }
+
+        if options[:skip_confirmations]
+          record.try(:skip_confirmation!)
+          record.try(:skip_reconfirmation!)
+        end
+      end
+    end
+  end
+end

data/lib/devise/multi_email/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module MultiEmail
+    VERSION = '3.1.0'
+  end
+end