module SignOut

Please see README

Public Instance Methods

sign_out(options=nil) click to toggle source

The sign_out method calls:

# File lib/sixarm_ruby_sign_out.rb, line 14
def sign_out(options=nil)
 begin
  sign_out_attempt(options) or raise SecurityError
  sign_out_success(options)
  return true
 rescue SecurityError
  sign_out_failure(options)
  return false
 end
end
sign_out_attempt(options=nil) click to toggle source

The sign_out method calls this first.

You override this method to e.g.:

  • prompt the user to save any of his open work

  • clear the current user variable

  • clear the current user id in the session

If this method succeeds, then control goes to sign_out_success.

If this method raises an error, then control goes to sign_out_failure.

# File lib/sixarm_ruby_sign_out.rb, line 37
def sign_out_attempt(options=nil)
end
sign_out_failure(options=nil) click to toggle source

The sign_out method calls this second, iff sign_out_attempt raises an exception.

You override this method to e.g.:

  • show the user a flash warning message saying “Problem…”

  • redirect to a help page with a way to report the problem

# File lib/sixarm_ruby_sign_out.rb, line 59
def sign_out_failure(options=nil)
end
sign_out_success(options=nil) click to toggle source

The sign_out method calls this second, iff sign_out_attempt succeeds.

You override this method to e.g.:

  • show the user a flash notice message saying “Goodbye…”

  • redirect to the application home page

# File lib/sixarm_ruby_sign_out.rb, line 48
def sign_out_success(options=nil)
end