Module: Aker::Form::LoginFormAssetProvider

Includes:

Rack::ConfigurationHelper, Rack::Utils

Included in:

Middleware::LoginRenderer, Middleware::LoginResponder, Middleware::LogoutResponder

Defined in:

lib/aker/form/login_form_asset_provider.rb

Overview

Provides HTML and CSS for login forms.

Author:

• David Yip

Instance Method Summary

• #asset_root ⇒ String

  Where to look for HTML and CSS assets.

• #login_css ⇒ String

  Provides the CSS for the login form.

• #login_html(env, options = {}) ⇒ String

  Provides the HTML for the login form.

Methods included from Rack::ConfigurationHelper

#login_path, #logout_path

Methods included from Rack::EnvironmentHelper

#authority, #configuration, #interactive?

Instance Method Details

#asset_root ⇒ String

Where to look for HTML and CSS assets.

This is currently hardcoded as ‘(aker gem root)/assets/aker/form`.

Returns:

• (String) —

  a directory path

# File 'lib/aker/form/login_form_asset_provider.rb', line 20

def asset_root
  File.expand_path(File.join(File.dirname(__FILE__),
                             %w(.. .. ..),
                             %w(assets aker form)))
end

#login_css ⇒ String

Provides the CSS for the login form.

Returns:

• (String) —

  CSS data

# File 'lib/aker/form/login_form_asset_provider.rb', line 52

def login_css
  File.read(File.join(asset_root, 'login.css'))
end

#login_html(env, options = {}) ⇒ String

Provides the HTML for the login form.

This method expects to find a ‘login.html.erb` ERB template in #asset_root. The ERB template is evaluated in an environment where a local variable named `script_name` is bound to the value of the `SCRIPT_NAME` Rack environment variable, which is useful for CSS and form action URL generation.

Parameters:

• env (Rack environment) —

  a Rack environment

• options (Hash) (defaults to: {}) —

  rendering options

Options Hash (options):

• :login_failed (Boolean) —

  If true, will render a failure message

• :logged_out (Boolean) —

  If true, will render a logout notification

• :username (String) —

  Text for the username field

• :url (String) —

  A URL to redirect to upon successful login

Returns:

• (String) —

  HTML data

# File 'lib/aker/form/login_form_asset_provider.rb', line 42

def login_html(env, options = {})
  login_base = env['SCRIPT_NAME'] + login_path(env)
  template = File.read(File.join(asset_root, 'login.html.erb'))
  ERB.new(template).result(binding)
end