Module: Cybertrain

Defined in:

cybertrain/html.rb,
cybertrain/db.rb,
cybertrain/app.rb,
cybertrain/cli.rb,
cybertrain/dev.rb,
cybertrain/cast.rb,
cybertrain/main.rb,
cybertrain/test.rb,
cybertrain/flash.rb,
cybertrain/ident.rb,
cybertrain/model.rb,
cybertrain/views.rb,
cybertrain/config.rb,
cybertrain/crypto.rb,
cybertrain/db/cli.rb,
cybertrain/errors.rb,
cybertrain/logger.rb,
cybertrain/params.rb,
cybertrain/router.rb,
cybertrain/schema.rb,
cybertrain/context.rb,
cybertrain/db/pool.rb,
cybertrain/session.rb,
cybertrain/version.rb,
cybertrain/app_name.rb,
cybertrain/callback.rb,
cybertrain/db/error.rb,
cybertrain/relation.rb,
cybertrain/cli/build.rb,
cybertrain/migration.rb,
cybertrain/validator.rb,
cybertrain/controller.rb,
cybertrain/dev/reexec.rb,
cybertrain/http/query.rb,
cybertrain/middleware.rb,
cybertrain/application.rb,
cybertrain/cli/new_app.rb,
cybertrain/db/migrator.rb,
cybertrain/dev/watcher.rb,
cybertrain/http/parser.rb,
cybertrain/http/server.rb,
cybertrain/test/client.rb,
cybertrain/cli/scaffold.rb,
cybertrain/http/cookies.rb,
cybertrain/http/handler.rb,
cybertrain/http/request.rb,
cybertrain/schema/table.rb,
cybertrain/template/ast.rb,
cybertrain/cli/templates.rb,
cybertrain/cli/toolchain.rb,
cybertrain/db/connection.rb,
cybertrain/db/sqlite_ddl.rb,
cybertrain/db/sqlite_ffi.rb,
cybertrain/dev/rebuilder.rb,
cybertrain/http/response.rb,
cybertrain/schema/dumper.rb,
cybertrain/dev/error_page.rb,
cybertrain/template/inode.rb,
cybertrain/template/lexer.rb,
cybertrain/context_handler.rb,
cybertrain/template/engine.rb,
cybertrain/template/limits.rb,
cybertrain/template/parser.rb,
cybertrain/db/schema_dumper.rb,
cybertrain/generator/runner.rb,
cybertrain/http/header_name.rb,
cybertrain/template/helpers.rb,
cybertrain/http/client_error.rb,
cybertrain/middleware/static.rb,
cybertrain/schema/definition.rb,
cybertrain/generator/manifest.rb,
cybertrain/generator/inflector.rb,
cybertrain/generator/model_scan.rb,
cybertrain/generator/routes_dsl.rb,
cybertrain/template/interpreter.rb,
cybertrain/generator/url_support.rb,
cybertrain/template/form_builder.rb,
cybertrain/middleware/error_pages.rb,
cybertrain/generator/views_emitter.rb,
cybertrain/generator/models_emitter.rb,
cybertrain/generator/routes_emitter.rb,
cybertrain/middleware/session_store.rb,
cybertrain/generator/controller_scan.rb,
cybertrain/middleware/request_logger.rb,
cybertrain/middleware/csrf_protection.rb,
cybertrain/middleware/method_override.rb,
cybertrain/generator/migrations_emitter.rb,
cybertrain/generator/controllers_emitter.rb,
docs/api/stubs/cybertrain.rb

Overview

The framework’s namespace. An application reaches it in three places:

• its classes, through ApplicationController < Cybertrain::Controller and the models spin run gen derives from Model;
• config/app.rb, through Cybertrain.configure and Cybertrain.url_root=;
• config/routes.rb, through Routes.draw.

See the overview for where each part of the API is documented.

Defined Under Namespace

Modules: Cookies, Gen, Html, Migration, Routes, Schema, Test Classes: Config, Controller, Errors, Flash, FlashNow, Model, Params, RecordInvalid, RecordNotFound, Relation, Request, Response, SafeString, Session

Class Method Summary

• .config ⇒ Config

  The application’s Config.

• .configure {|config| ... } ⇒ nil

  Yields Cybertrain.config for config/app.rb to change.

• .env ⇒ String

  Cybertrain.config.env.

• .url_root ⇒ String

  Scheme and host the *_url helpers prepend: Cybertrain.url_root = “https://example.com”.

• .url_root=(root) ⇒ String

Class Method Details

.config ⇒ Config

The application’s Config.

Returns:

• (Config)

# File 'cybertrain/config.rb', line 289

def self.config
  current = @config
  if current.nil?
    current = Config.new
    @config = current
  end
  current
end

.configure {|config| ... } ⇒ nil

Yields config for config/app.rb to change.

Yield Parameters:

• config (Config)

Returns:

• (nil)

# File 'cybertrain/config.rb', line 311

def self.configure(&block)
  block.call(config)
  nil
end

.env ⇒ String

Returns Cybertrain.config.env.

Returns:

• (String) —

  Cybertrain.config.env

# File 'cybertrain/config.rb', line 318

def self.env
  config.env
end

.url_root ⇒ String

Scheme and host the *_url helpers prepend: Cybertrain.url_root = “https://example.com”. It is not derived from the request or from Config; set it in config/app.rb, e.g. Cybertrain.url_root = "https://example.com" if Cybertrain.config.production?.

Returns:

• (String) —

  "http://localhost:3000" until set

# File 'cybertrain/generator/url_support.rb', line 15

def self.url_root
  @url_root
end

.url_root=(root) ⇒ String

Parameters:

• root (String) —

  scheme and host, no trailing slash

Returns:

• (String)

# File 'cybertrain/generator/url_support.rb', line 22

def self.url_root=(root)
  @url_root = root
end