Table of Contents - clearance-2.5.0 Documentation
Pages
- LICENSE
-
README
- Clearance
- Getting Started
- Configure
- Use
- Access Control
- Helper Methods
- Password Resets
- Multiple Domain Support
- Integrating with Rack Applications
- Overriding Clearance
- Routes
- Controllers
- Redirects
- Views
- Layouts
- Translations
- User Model
- Signed Cookies
- Extending Sign In
- Testing
- Fast Feature Specs
- Ready Made Feature Specs
- Controller Test Helpers
- View and Helper Spec Helpers
- Contributing
- License
- About thoughtbot
- README
- USAGE
- user_signs_out_spec.rb.tt
- visitor_resets_password_spec.rb.tt
- visitor_signs_in_spec.rb.tt
- visitor_signs_up_spec.rb.tt
- visitor_updates_password_spec.rb.tt
- USAGE
Classes and Modules
- ActionController
- ActionController::TestCase
- Clearance
- Clearance::Authentication
- Clearance::Authorization
- Clearance::BackDoor
- Clearance::Configuration
- Clearance::Constraints
- Clearance::Constraints::SignedIn
- Clearance::Constraints::SignedOut
- Clearance::Controller
- Clearance::DefaultSignInGuard
- Clearance::Engine
- Clearance::FailureStatus
- Clearance::Generators
- Clearance::Generators::InstallGenerator
- Clearance::Generators::RoutesGenerator
- Clearance::Generators::SpecsGenerator
- Clearance::Generators::ViewsGenerator
- Clearance::PasswordStrategies
- Clearance::PasswordStrategies::Argon2
- Clearance::PasswordStrategies::BCrypt
- Clearance::RackSession
- Clearance::Session
- Clearance::SignInGuard
- Clearance::SuccessStatus
- Clearance::Testing
- Clearance::Testing::ControllerHelpers
- Clearance::Testing::Matchers
- Clearance::Testing::Matchers::DenyAccessMatcher
- Clearance::Testing::ViewHelpers
- Clearance::Testing::ViewHelpers::CurrentUser
- Clearance::Token
- Clearance::User
- Clearance::User::Callbacks
- Clearance::User::ClassMethods
- Clearance::User::Validations
- Features
- Features::ClearanceHelpers
Methods
- ::configuration — Clearance
- ::configuration= — Clearance
- ::configure — Clearance
- ::new — Clearance::BackDoor
- ::new — Clearance::Configuration
- ::new — Clearance::Constraints::SignedIn
- ::new — Clearance::RackSession
- ::new — Clearance::Session
- ::new — Clearance::FailureStatus
- ::new — Clearance::SignInGuard
- ::new — Clearance::Testing::Matchers::DenyAccessMatcher
- ::new — Clearance::Token
- ::next_migration_number — Clearance::Generators::InstallGenerator
- #add_cookie_to_headers — Clearance::Session
- #allow_sign_up? — Clearance::Configuration
- #allowed_environments — Clearance::BackDoor
- #authenticate — Clearance::Authentication
- #authenticate — Clearance::User::ClassMethods
- #authenticated? — Clearance::PasswordStrategies::Argon2
- #authenticated? — Clearance::PasswordStrategies::BCrypt
- #authentication_successful? — Clearance::Session
- #call — Clearance::BackDoor
- #call — Clearance::DefaultSignInGuard
- #call — Clearance::RackSession
- #clear_return_to — Clearance::Authorization
- #clearance_routes — Clearance::Generators::RoutesGenerator
- #clearance_session — Clearance::Constraints::SignedIn
- #clearance_session — Clearance::Constraints::SignedOut
- #clearance_session — Clearance::Testing::Matchers::DenyAccessMatcher
- #clearance_session — Clearance::Authentication
- #configured_bcrypt_cost — Clearance::PasswordStrategies::BCrypt
- #configured_cookie_domain — Clearance::Session
- #configured_key_type — Clearance::Generators::InstallGenerator
- #cookie_options — Clearance::Session
- #cookies — Clearance::Session
- #copy_migration — Clearance::Generators::InstallGenerator
- #create_add_columns_migration — Clearance::Generators::InstallGenerator
- #create_clearance_initializer — Clearance::Generators::InstallGenerator
- #create_clearance_migration — Clearance::Generators::InstallGenerator
- #create_locales — Clearance::Generators::ViewsGenerator
- #create_or_inject_clearance_into_user_model — Clearance::Generators::InstallGenerator
- #create_specs — Clearance::Generators::SpecsGenerator
- #create_views — Clearance::Generators::ViewsGenerator
- #current_user — Clearance::Constraints::SignedIn
- #current_user — Clearance::Session
- #current_user — Clearance::SignInGuard
- #current_user — Clearance::Authentication
- #current_user_fulfills_additional_requirements? — Clearance::Constraints::SignedIn
- #default_failure_message — Clearance::DefaultSignInGuard
- #delete_cookie_options — Clearance::Session
- #denied_access_url — Clearance::Testing::Matchers::DenyAccessMatcher
- #deny_access — Clearance::Authorization
- #deny_access — Clearance::Testing::Matchers
- #description — Clearance::Testing::Matchers::DenyAccessMatcher
- #disable_clearance_internal_routes — Clearance::Generators::RoutesGenerator
- #display_readme_in_terminal — Clearance::Generators::InstallGenerator
- #domain — Clearance::Session
- #email_optional? — Clearance::User
- #environment_is_allowed? — Clearance::BackDoor
- #error_message — Clearance::BackDoor
- #existing_migrations — Clearance::Generators::InstallGenerator
- #existing_users_columns — Clearance::Generators::InstallGenerator
- #existing_users_indexes — Clearance::Generators::InstallGenerator
- #expect_user_to_be_signed_in — Features::ClearanceHelpers
- #expect_user_to_be_signed_out — Features::ClearanceHelpers
- #expires_configuration — Clearance::Session
- #factory_module — Clearance::Testing::ControllerHelpers
- #failure — Clearance::SignInGuard
- #failure_message_for_should — Clearance::Testing::Matchers::DenyAccessMatcher
- #failure_message_for_should_not — Clearance::Testing::Matchers::DenyAccessMatcher
- #files_within_root — Clearance::Generators::ViewsGenerator
- #find_by_normalized_email — Clearance::User::ClassMethods
- #find_user — Clearance::BackDoor
- #flash_alert_value — Clearance::Testing::Matchers::DenyAccessMatcher
- #forgot_password! — Clearance::User
- #generate_confirmation_token — Clearance::User
- #generate_remember_token — Clearance::User
- #handle_unverified_request — Clearance::Authentication
- #initialize_sign_in_guard_stack — Clearance::Session
- #inject_clearance_into_application_controller — Clearance::Generators::InstallGenerator
- #inject_clearance_routes_into_application_routes — Clearance::Generators::RoutesGenerator
- #locales — Clearance::Generators::ViewsGenerator
- #matches? — Clearance::Constraints::SignedIn
- #matches? — Clearance::Constraints::SignedOut
- #matches? — Clearance::Testing::Matchers::DenyAccessMatcher
- #migration_exists? — Clearance::Generators::InstallGenerator
- #migration_name_without_timestamp — Clearance::Generators::InstallGenerator
- #migration_needed? — Clearance::Generators::InstallGenerator
- #migration_primary_key_type_string — Clearance::Generators::InstallGenerator
- #migration_version — Clearance::Generators::InstallGenerator
- #missing_session? — Clearance::Constraints::SignedOut
- #models_inherit_from — Clearance::Generators::InstallGenerator
- #new_columns — Clearance::Generators::InstallGenerator
- #new_indexes — Clearance::Generators::InstallGenerator
- #next_guard — Clearance::SignInGuard
- #normalize_email — Clearance::User
- #normalize_email — Clearance::User::ClassMethods
- #parent_controller — Clearance::Configuration
- #password= — Clearance::PasswordStrategies::Argon2
- #password= — Clearance::PasswordStrategies::BCrypt
- #password= — Clearance::User
- #password_optional? — Clearance::User
- #password_strategy — Clearance::User::ClassMethods
- #path_without_leading_slashes — Clearance::Authorization
- #prevent_timing_attack — Clearance::User::ClassMethods
- #redirect_back_or — Clearance::Authorization
- #redirect_request — Clearance::Authorization
- #redirects_to_url? — Clearance::Testing::Matchers::DenyAccessMatcher
- #reload_user_model — Clearance::Configuration
- #remember_token — Clearance::Session
- #remember_token_cookie — Clearance::Session
- #remember_token_expires — Clearance::Session
- #request_with_env — Clearance::Session
- #require_login — Clearance::Authorization
- #reset_password_for — Features::ClearanceHelpers
- #reset_remember_token! — Clearance::User
- #return_to — Clearance::Authorization
- #return_to_url — Clearance::Authorization
- #rotate_csrf_on_sign_in? — Clearance::Configuration
- #route — Clearance::Generators::RoutesGenerator
- #routes_enabled? — Clearance::Configuration
- #routes_file_path — Clearance::Generators::RoutesGenerator
- #rspec_helper_file — Clearance::Generators::SpecsGenerator
- #run_sign_in_stack — Clearance::Session
- #set_remember_token — Clearance::Session
- #sets_the_flash? — Clearance::Testing::Matchers::DenyAccessMatcher
- #setup_controller_request_and_response — Clearance::Testing::ControllerHelpers
- #sign_in — Clearance::Session
- #sign_in — Clearance::Authentication
- #sign_in — Clearance::Testing::ControllerHelpers
- #sign_in — Clearance::Testing::ViewHelpers
- #sign_in — Features::ClearanceHelpers
- #sign_in_as — Clearance::Testing::ControllerHelpers
- #sign_in_as — Clearance::Testing::ViewHelpers
- #sign_in_through_the_back_door — Clearance::BackDoor
- #sign_in_with — Features::ClearanceHelpers
- #sign_out — Clearance::Session
- #sign_out — Clearance::Authentication
- #sign_out — Clearance::Testing::ControllerHelpers
- #sign_out — Features::ClearanceHelpers
- #sign_up_with — Features::ClearanceHelpers
- #signed_cookie= — Clearance::Configuration
- #signed_in? — Clearance::Constraints::SignedIn
- #signed_in? — Clearance::Session
- #signed_in? — Clearance::SignInGuard
- #signed_in? — Clearance::Authentication
- #signed_in? — Clearance::Testing::ViewHelpers::CurrentUser
- #signed_in_with_remember_token? — Clearance::Session
- #signed_out? — Clearance::Session
- #signed_out? — Clearance::Authentication
- #signed_out? — Clearance::Testing::ViewHelpers::CurrentUser
- #skip_password_validation? — Clearance::User
- #store_location — Clearance::Authorization
- #success — Clearance::SignInGuard
- #success? — Clearance::SuccessStatus
- #success? — Clearance::FailureStatus
- #update_password — Clearance::User
- #url_after_denied_access_when_signed_in — Clearance::Authorization
- #url_after_denied_access_when_signed_out — Clearance::Authorization
- #user_actions — Clearance::Configuration
- #user_from_remember_token — Clearance::Session
- #user_id_parameter — Clearance::Configuration
- #user_model — Clearance::Configuration
- #user_parameter — Clearance::Configuration
- #user_with_reset_password — Features::ClearanceHelpers
- #users_table_exists? — Clearance::Generators::InstallGenerator
- #views — Clearance::Generators::ViewsGenerator