devise-multi_email 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae0a4824abdf90e63b3a5027520c2d4ef6465e31
-  data.tar.gz: ae37353431e7e16eb565a0ba27c814020f644f3e
+  metadata.gz: 9ba4375a3b35995bdfa11564cc3f2a4e879d9731
+  data.tar.gz: 32c1c262c80fbfa87ef8819e40e0821ecc8ce822
 SHA512:
-  metadata.gz: 232a734290ad0eab39000b8ecb76a3c6fc320ece267fdd43a52a1dadf726ee50cd97dae4c712de750a757ca48bbf72e9b7d6fc59b3e138b32414ee6b9d915e06
-  data.tar.gz: 658d6b2220f1eaf9ca811d4df1b669a938cb7a2911c803abc5546eec9def051756511228eff406b282d7e088084fd8610b7950b88f6d71f2ded2876a187e59f2
+  metadata.gz: 9926f6af62664391396203089a60f9a0876d8b3548898ee5148626e963d4c5bd818ff8db4d20c934cf3d7672f3886274fe68e75465a08cf1fa560b84060cdd61
+  data.tar.gz: 711a2674cee47fb189a46220adf4d32b334609f74ad490016bc4cd87d387ac9c836b5e1eae2165d5478d747e6b0c58971b75c54bad3f522487ca47de349ac063

data/CHANGELOG.md

@@ -1,8 +1,13 @@
+### 2.0.1 - 2017-05-16
+
+* Refactored to simplify some logic and start moving toward mimicking default Devise lifecycle behavior
+* Added `Devise::MultiEmail.only_login_with_primary_email` option to restrict login to only primary emails
+* Added `Devise::MultiEmail.autosave_emails` option to automatically enable `autosave` on "emails" association
+
 ### 2.0.0 - 2017-05-12
 
-* New `Devise::MultiEmail#configure` setup with options for `user` and `emails` associations and `primary_email` method names
+* New `Devise::MultiEmail#configure` setup with options for `user` and `emails` associations and `primary_email_record` method names
 * Refactor to expose `_multi_email_*` prefixed methods on models
-* New `primary_email` method to get primary email record (however, can be configured as `primary_email_record` for backwards-compatibility)
 * Changed logic when changing an email address to look up existing email record, otherwise creating a new one, then marking it "primary"
 * Changed logic when changing an email address to mark all others as `primary = false`
 * Changed logic when changing an email address to `nil` to mark as `primary = false` rather than deleting records

data/README.md

@@ -49,6 +49,31 @@ create_table :emails do |t|
  end
 ```
 
+You can choose whether or not users can login with an email address that is not the primary email address.
+
+```ruby
+Devise::MultiEmail.configure do |config|
+  # Default is `false`
+  config.only_login_with_primary_email = true
+end
+```
+
+The `autosave` is automatically enabled on the `emails` association by default. This is to ensure the `primary`
+flag is persisted for all emails when the primary email is changed. When `autosave` is not enabled on the association,
+only new emails are saved when the parent (e.g. `User`) record is saved. (Updates to already-persisted email records
+are not saved.)
+
+If you don't want `autosave` to be enabled automatically, you can disable this feature. What this will do is
+enable alternative behavior, which adds an `after_save` callback to the parent record and calls `email.save` on each email
+record where the `primary` value has changed.
+
+```ruby
+Devise::MultiEmail.configure do |config|
+  # Default is `true`
+  config.autosave_emails = false
+end
+```
+
 ### Configure custom association names
 
 You may not want to use the association `user.emails` or `email.users`. You can customize the name of the associations used. Add your custom configurations to an initializer file such as `config/initializers/devise-multi_email.rb`.
@@ -61,9 +86,8 @@ Devise::MultiEmail.configure do |config|
   config.parent_association_name = :team
   # Default is :emails for parent (e.g. User) model
   config.emails_association_name = :email_addresses
-  # For backwards-compatibility, specify :primary_email_record
-  # Default is :primary_email
-  config.primary_email_method_name = :primary_email_record
+  # Default is :primary_email_record
+  config.primary_email_method_name = :primary_email
 end
 
 # Example use of custom association names

data/devise-multi_email.gemspec

@@ -6,8 +6,8 @@ require 'devise/multi_email/version'
 Gem::Specification.new do |spec|
   spec.name          = 'devise-multi_email'
   spec.version       = Devise::MultiEmail::VERSION
-  spec.authors       = ['ALLEN WANG QIANG']
-  spec.email         = ['rovingbreeze@gmail.com']
+  spec.authors       = ['ALLEN WANG QIANG', 'Joel Van Horn']
+  spec.email         = ['rovingbreeze@gmail.com', 'joel@joelvanhorn.com']
 
   spec.summary       = %q{Let devise support multiple emails.}
   spec.description   = %q{Devise authenticatable, confirmable and validatable with multiple emails.}

data/lib/devise/multi_email.rb

@@ -3,32 +3,54 @@ require 'devise'
 
 module Devise
   module MultiEmail
-    def self.configure(&block)
-      yield self
-    end
+    class << self
+      def configure(&block)
+        yield self
+      end
 
-    def self.parent_association_name
-      @parent_association_name ||= :user
-    end
+      @autosave_emails = false
 
-    def self.parent_association_name=(name)
-      @parent_association_name = name.try(:to_sym)
-    end
+      def autosave_emails?
+        @autosave_emails == true
+      end
 
-    def self.emails_association_name
-      @emails_association_name ||= :emails
-    end
+      def autosave_emails=(value)
+        @autosave_emails = (value == true)
+      end
 
-    def self.emails_association_name=(name)
-      @emails_association_name = name.try(:to_sym)
-    end
+      @only_login_with_primary_email = false
 
-    def self.primary_email_method_name
-      @primary_email_method_name ||= :primary_email
-    end
+      def only_login_with_primary_email?
+        @only_login_with_primary_email == true
+      end
+
+      def only_login_with_primary_email=(value)
+        @only_login_with_primary_email = (value == true)
+      end
+
+      def parent_association_name
+        @parent_association_name ||= :user
+      end
+
+      def parent_association_name=(name)
+        @parent_association_name = name.try(:to_sym)
+      end
+
+      def emails_association_name
+        @emails_association_name ||= :emails
+      end
+
+      def emails_association_name=(name)
+        @emails_association_name = name.try(:to_sym)
+      end
+
+      def primary_email_method_name
+        @primary_email_method_name ||= :primary_email_record
+      end
 
-    def self.primary_email_method_name=(name)
-      @primary_email_method_name = name.try(:to_sym)
+      def primary_email_method_name=(name)
+        @primary_email_method_name = name.try(:to_sym)
+      end
     end
   end
 end

data/lib/devise/multi_email/association_manager.rb

@@ -14,16 +14,29 @@ module Devise
         model_class.__send__ :include, mod
       end
 
-      def model_class
-        unless reflection
-          raise "#{@klass}##{name} association not found: It might be because your declaration is after `devise :multi_email_confirmable`."
+      # 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)
+        @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

data/lib/devise/multi_email/email_model_manager.rb

@@ -4,14 +4,12 @@ module Devise
   module MultiEmail
     class EmailModelManager
 
-      attr_reader :record
-
-      def initialize(record)
-        @record = record
+      def initialize(email_record)
+        @email_record = email_record
       end
 
       def parent
-        record.__send__(record.class.multi_email_association.name)
+        @email_record.__send__(@email_record.class.multi_email_association.name)
       end
     end
   end

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

@@ -29,6 +29,7 @@ module Devise
         extend ActiveSupport::Concern
 
         included do
+          multi_email_association.configure_autosave!{ include AuthenticatableAutosaveExtensions }
           multi_email_association.include_module(EmailAuthenticatable)
         end
 
@@ -36,26 +37,40 @@ module Devise
 
         # Gets the primary email address of the user.
         def email
-          multi_email.primary_email.try(: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)
+          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)
-          email = filtered_conditions.delete(:email)
+          criteria = filtered_conditions.extract!(:email, :unconfirmed_email)
 
-          if email && email.is_a?(String)
+          if criteria.keys.any?
             conditions = filtered_conditions.to_h.merge(opts).
-              reverse_merge(multi_email_association.reflection.table_name => { email: email })
+              reverse_merge(build_conditions(criteria))
 
             resource = joins(multi_email_association.name).find_by(conditions)
-            resource.current_login_email = email if resource.respond_to?(:current_login_email=)
+            resource.current_login_email = criteria.values.first if resource
             resource
           else
             super(tainted_conditions, opts)
@@ -63,7 +78,17 @@ module Devise
         end
 
         def find_by_email(email)
-          joins(multi_email_association.name).where(multi_email_association.reflection.table_name => { email: email.downcase }).first
+          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

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

@@ -8,12 +8,12 @@ module Devise
       included do
         devise :confirmable
 
-        extend ClassReplacementMethods
+        include ConfirmableExtensions
       end
 
-      module ClassReplacementMethods
-        def allow_unconfirmed_access_for
-          0.days
+      module ConfirmableExtensions
+        def confirmation_period_valid?
+          primary? ? super : false
         end
       end
     end
@@ -45,9 +45,15 @@ module Devise
                  :confirmation_token, :confirmed_at, :confirmation_sent_at, :confirm, :confirmed?, :unconfirmed_email,
                  :reconfirmation_required?, :pending_reconfirmation?, to: :primary_email_record, 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: false)
+        end
+
         # This need to be forwarded to the email that the user logged in with
         def active_for_authentication?
-          login_email = current_login_email_record
+          login_email = multi_email.login_email_record
 
           if login_email && !login_email.primary?
             super && login_email.active_for_authentication?
@@ -58,7 +64,7 @@ module Devise
 
         # Shows email not confirmed instead of account inactive when the email that user used to login is not confirmed
         def inactive_message
-          login_email = current_login_email_record
+          login_email = multi_email.login_email_record
 
           if login_email && !login_email.primary? && !login_email.confirmed?
             :unconfirmed
@@ -88,12 +94,6 @@ module Devise
 
       private
 
-        def current_login_email_record
-          if respond_to?(:current_login_email) && current_login_email
-            multi_email.emails.find_by(email: current_login_email)
-          end
-        end
-
         module ClassMethods
           delegate :confirm_by_token, :send_confirmation_instructions, to: 'multi_email_association.model_class', allow_nil: false
         end

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

@@ -61,12 +61,8 @@ module Devise
 
       def propagate_email_errors
         email_error_key = self.class.multi_email_association.name
-
-        if respond_to?("#{email_error_key}_attributes=")
-          email_error_key = "#{email_error_key}.email".to_sym
-        end
-
-        email_errors = errors.delete(email_error_key) || []
+        email_errors = errors.delete(email_error_key) ||
+                       errors.delete("#{email_error_key}.email".to_sym) || []
 
         email_errors.each do |error|
           errors.add(:email, error)
@@ -80,7 +76,7 @@ module Devise
                        :validates_confirmation_of, :validates_length_of].freeze
 
         def assert_validations_api!(base) #:nodoc:
-          unavailable_validations = VALIDATIONS.select{ |v| !base.respond_to?(v) }
+          unavailable_validations = VALIDATIONS.select { |v| !base.respond_to?(v) }
 
           unless unavailable_validations.empty?
             raise "Could not use :validatable module since #{base} does not respond " <<

data/lib/devise/multi_email/parent_model_extensions.rb

@@ -8,9 +8,10 @@ module Devise
       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

data/lib/devise/multi_email/parent_model_manager.rb

@@ -4,51 +4,86 @@ module Devise
   module MultiEmail
     class ParentModelManager
 
-      attr_reader :record
+      def initialize(parent_record)
+        @parent_record = parent_record
+      end
 
-      def initialize(record)
-        @record = record
+      def current_email_record
+        login_email_record || primary_email_record
       end
 
-      # Gets the email records that have not been deleted
-      def filtered_emails
-        emails.reject(&:destroyed?).reject(&:marked_for_destruction?)
+      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
+      def primary_email_record
         filtered_emails.find(&:primary?)
       end
-      alias_method Devise::MultiEmail.primary_email_method_name, :primary_email
-
-      def change_primary_email_to(new_email)
-        # Use Devise formatting settings for emails
-        formatted_email = record.class.send(:devise_parameter_filter).filter(email: new_email)[:email]
-
-        valid_emails = filtered_emails
+      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?
-          valid_emails.each{ |record| record.primary = false }
+          filtered_emails.each { |item| item.primary = false }
 
         # select or build an email record
         else
-          record = valid_emails.find{ |record| record.email == formatted_email }
+          record = find_or_build_for_email(new_email)
 
-          unless record
-            record = emails.build(email: formatted_email)
-            valid_emails << record
+          if record.try(:confirmed?) || primary_email_record.nil? || options[:allow_unconfirmed]
+            set_primary_record_to(record, options)
           end
-
-          # toggle the selected record as primary and others as not
-          valid_emails.each{ |other| other.primary = (other == record) }
         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
-        record.__send__(record.class.multi_email_association.name)
+        @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.lazy.reject(&:destroyed?).reject(&:marked_for_destruction?).to_a
+      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

data/lib/devise/multi_email/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module MultiEmail
-    VERSION = "2.0.0"
+    VERSION = "2.0.1"
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: devise-multi_email
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - ALLEN WANG QIANG
+- Joel Van Horn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -111,6 +112,7 @@ dependencies:
 description: Devise authenticatable, confirmable and validatable with multiple emails.
 email:
 - rovingbreeze@gmail.com
+- joel@joelvanhorn.com
 executables: []
 extensions: []
 extra_rdoc_files: []