Contents

module Clearance
  # Runs as the base {SignInGuard} for all requests, regardless of configured
  # {Configuration#sign_in_guards}.
  class DefaultSignInGuard < SignInGuard
    # Runs the default sign in guard.
    #
    # If there is a value set in the clearance session object, then the guard
    # returns {SuccessStatus}. Otherwise, it returns {FailureStatus} with the
    # message returned by {#default_failure_message}.
    #
    # @return [SuccessStatus, FailureStatus]
    def call
      if session.signed_in?
        success
      else
        failure default_failure_message.html_safe
      end
    end

    # The default failure message pulled from the i18n framework.
    #
    # Will use the value returned from the following i18n keys, in this order:
    #
    # * `clearance.controllers.sessions.bad_email_or_password`
    # * `flashes.failure_after_create`
    #
    # @return [String]
    def default_failure_message
      I18n.t(
        :bad_email_or_password,
        scope: [:clearance, :controllers, :sessions],
        default: I18n.t('flashes.failure_after_create').html_safe
      )
    end
  end
end

Version data entries

31 entries across 31 versions & 1 rubygems

Version	Path
clearance-1.16.2	lib/clearance/default_sign_in_guard.rb
clearance-1.16.1	lib/clearance/default_sign_in_guard.rb
clearance-1.16.0	lib/clearance/default_sign_in_guard.rb
clearance-1.15.1	lib/clearance/default_sign_in_guard.rb
clearance-1.15.0	lib/clearance/default_sign_in_guard.rb
clearance-1.14.2	lib/clearance/default_sign_in_guard.rb
clearance-1.14.1	lib/clearance/default_sign_in_guard.rb
clearance-1.14.0	lib/clearance/default_sign_in_guard.rb
clearance-1.13.0	lib/clearance/default_sign_in_guard.rb
clearance-1.12.1	lib/clearance/default_sign_in_guard.rb
clearance-1.12.0	lib/clearance/default_sign_in_guard.rb