Module: Cybertrain

Defined in:
cybertrain/ident.rb,
cybertrain/db.rb,
cybertrain/app.rb,
cybertrain/cli.rb,
cybertrain/job.rb,
cybertrain/sse.rb,
cybertrain/cast.rb,
cybertrain/cron.rb,
cybertrain/html.rb,
cybertrain/jobs.rb,
cybertrain/main.rb,
cybertrain/test.rb,
cybertrain/cache.rb,
cybertrain/clock.rb,
cybertrain/feeds.rb,
cybertrain/flash.rb,
cybertrain/lease.rb,
cybertrain/model.rb,
cybertrain/roles.rb,
cybertrain/shell.rb,
cybertrain/token.rb,
cybertrain/turbo.rb,
cybertrain/views.rb,
cybertrain/assets.rb,
cybertrain/config.rb,
cybertrain/crypto.rb,
cybertrain/db/cli.rb,
cybertrain/errors.rb,
cybertrain/logger.rb,
cybertrain/mailer.rb,
cybertrain/mailer.rb,
cybertrain/params.rb,
cybertrain/router.rb,
cybertrain/schema.rb,
cybertrain/stream.rb,
cybertrain/cli/job.rb,
cybertrain/console.rb,
cybertrain/context.rb,
cybertrain/db/blob.rb,
cybertrain/db/pool.rb,
cybertrain/feature.rb,
cybertrain/job/cli.rb,
cybertrain/net/tls.rb,
cybertrain/preview.rb,
cybertrain/runtime.rb,
cybertrain/session.rb,
cybertrain/streams.rb,
cybertrain/version.rb,
cybertrain/app_name.rb,
cybertrain/callback.rb,
cybertrain/db/error.rb,
cybertrain/http/sse.rb,
cybertrain/job/base.rb,
cybertrain/password.rb,
cybertrain/relation.rb,
cybertrain/strftime.rb,
cybertrain/time_ext.rb,
cybertrain/cli/build.rb,
cybertrain/component.rb,
cybertrain/encryptor.rb,
cybertrain/job/store.rb,
cybertrain/jobs_page.rb,
cybertrain/migration.rb,
cybertrain/rendering.rb,
cybertrain/scheduler.rb,
cybertrain/test/args.rb,
cybertrain/test/jobs.rb,
cybertrain/test/mail.rb,
cybertrain/test_help.rb,
cybertrain/test_help.rb,
cybertrain/test_help.rb,
cybertrain/time_zone.rb,
cybertrain/validator.rb,
cybertrain/websocket.rb,
cybertrain/background.rb,
cybertrain/blob_store.rb,
cybertrain/cli/helper.rb,
cybertrain/controller.rb,
cybertrain/cookie_jar.rb,
cybertrain/dev/reexec.rb,
cybertrain/http/query.rb,
cybertrain/http_cache.rb,
cybertrain/job/worker.rb,
cybertrain/middleware.rb,
cybertrain/net/socket.rb,
cybertrain/pagination.rb,
cybertrain/rate_limit.rb,
cybertrain/sentry_dsn.rb,
cybertrain/stream/hub.rb,
cybertrain/test/views.rb,
cybertrain/test_files.rb,
cybertrain/zoned_time.rb,
cybertrain/application.rb,
cybertrain/cli/new_app.rb,
cybertrain/db/migrator.rb,
cybertrain/dev/watched.rb,
cybertrain/dev/watcher.rb,
cybertrain/http/parser.rb,
cybertrain/http/server.rb,
cybertrain/http_client.rb,
cybertrain/net/address.rb,
cybertrain/preview/ffi.rb,
cybertrain/roles/feeds.rb,
cybertrain/test/bundle.rb,
cybertrain/test/client.rb,
cybertrain/test/select.rb,
cybertrain/cli/scaffold.rb,
cybertrain/config/files.rb,
cybertrain/http/cookies.rb,
cybertrain/http/handler.rb,
cybertrain/http/request.rb,
cybertrain/job/executor.rb,
cybertrain/mailer/later.rb,
cybertrain/roles/server.rb,
cybertrain/roles/worker.rb,
cybertrain/schema/table.rb,
cybertrain/template/ast.rb,
cybertrain/cli/component.rb,
cybertrain/cli/line_diff.rb,
cybertrain/cli/templates.rb,
cybertrain/cli/toolchain.rb,
cybertrain/db/connection.rb,
cybertrain/db/normalizer.rb,
cybertrain/db/sqlite_ddl.rb,
cybertrain/db/sqlite_ffi.rb,
cybertrain/dev/indicator.rb,
cybertrain/dev/rebuilder.rb,
cybertrain/http/gzip_ffi.rb,
cybertrain/http/response.rb,
cybertrain/number_helper.rb,
cybertrain/schema/dumper.rb,
cybertrain/stream/poller.rb,
cybertrain/test/database.rb,
cybertrain/test/receiver.rb,
cybertrain/asset_manifest.rb,
cybertrain/cli/attachment.rb,
cybertrain/cli/build_lock.rb,
cybertrain/cli/dev_server.rb,
cybertrain/dev/error_page.rb,
cybertrain/dev/state_file.rb,
cybertrain/error_reporter.rb,
cybertrain/http/multipart.rb,
cybertrain/mailer/message.rb,
cybertrain/template/inode.rb,
cybertrain/template/lexer.rb,
cybertrain/test/test_case.rb,
cybertrain/console/helpers.rb,
cybertrain/console/printer.rb,
cybertrain/context_handler.rb,
cybertrain/dev/supervision.rb,
cybertrain/feature_catalog.rb,
cybertrain/generator/crc32.rb,
cybertrain/http/ip_address.rb,
cybertrain/locales/bundled.rb,
cybertrain/preview/failure.rb,
cybertrain/stream/endpoint.rb,
cybertrain/template/engine.rb,
cybertrain/template/limits.rb,
cybertrain/template/parser.rb,
cybertrain/test/assertions.rb,
cybertrain/test/broadcasts.rb,
cybertrain/websocket/frame.rb,
cybertrain/cli/test_command.rb,
cybertrain/db/schema_dumper.rb,
cybertrain/dev/build_status.rb,
cybertrain/format_collector.rb,
cybertrain/generator/runner.rb,
cybertrain/http/body_writer.rb,
cybertrain/http/header_name.rb,
cybertrain/job/retry_policy.rb,
cybertrain/template/helpers.rb,
cybertrain/test/html_reader.rb,
cybertrain/test/integration.rb,
cybertrain/websocket/client.rb,
cybertrain/config/validation.rb,
cybertrain/http/client_error.rb,
cybertrain/http/gzip_decoder.rb,
cybertrain/middleware/static.rb,
cybertrain/model/bulk_writes.rb,
cybertrain/schema/definition.rb,
cybertrain/cli/authentication.rb,
cybertrain/generator/job_scan.rb,
cybertrain/generator/manifest.rb,
cybertrain/http/uploaded_file.rb,
cybertrain/test/http_receiver.rb,
cybertrain/test/smtp_receiver.rb,
cybertrain/generator/code_view.rb,
cybertrain/generator/inflector.rb,
cybertrain/generator/test_scan.rb,
cybertrain/http/stream_failure.rb,
cybertrain/mailer/mail_message.rb,
cybertrain/preview/ffi_library.rb,
cybertrain/relation/aggregates.rb,
cybertrain/scheduler/timetable.rb,
cybertrain/cli/dev_server/watch.rb,
cybertrain/generator/asset_scan.rb,
cybertrain/generator/model_scan.rb,
cybertrain/generator/routes_dsl.rb,
cybertrain/template/interpreter.rb,
cybertrain/test/sentry_receiver.rb,
cybertrain/websocket/feed_table.rb,
cybertrain/background/supervisor.rb,
cybertrain/cli/framework_version.rb,
cybertrain/error_reporter/sentry.rb,
cybertrain/generator/helper_scan.rb,
cybertrain/generator/locale_scan.rb,
cybertrain/generator/locale_yaml.rb,
cybertrain/generator/url_support.rb,
cybertrain/http/parameter_filter.rb,
cybertrain/middleware/request_id.rb,
cybertrain/template/form_builder.rb,
cybertrain/turbo_stream_renderer.rb,
cybertrain/cli/dev_server/holding.rb,
cybertrain/cli/dev_server/machine.rb,
cybertrain/generator/concern_scan.rb,
cybertrain/generator/fixture_scan.rb,
cybertrain/generator/jobs_emitter.rb,
cybertrain/generator/model_naming.rb,
cybertrain/middleware/error_pages.rb,
cybertrain/template/helper_object.rb,
cybertrain/content_security_policy.rb,
cybertrain/generator/tests_emitter.rb,
cybertrain/generator/view_requires.rb,
cybertrain/generator/views_emitter.rb,
cybertrain/middleware/health_check.rb,
cybertrain/middleware/ssl_redirect.rb,
cybertrain/stream/websocket_server.rb,
cybertrain/template/stream_helpers.rb,
cybertrain/test/websocket_receiver.rb,
cybertrain/websocket/status_writer.rb,
cybertrain/cli/authentication_tests.rb,
cybertrain/cli/dev_server/processes.rb,
cybertrain/generator/assets_emitter.rb,
cybertrain/generator/component_scan.rb,
cybertrain/generator/models_emitter.rb,
cybertrain/generator/routes_emitter.rb,
cybertrain/middleware/session_store.rb,
cybertrain/generator/console_emitter.rb,
cybertrain/generator/controller_scan.rb,
cybertrain/generator/helpers_emitter.rb,
cybertrain/generator/locales_emitter.rb,
cybertrain/middleware/request_logger.rb,
cybertrain/generator/concerns_emitter.rb,
cybertrain/generator/importmap_reader.rb,
cybertrain/generator/model_validation.rb,
cybertrain/middleware/csrf_protection.rb,
cybertrain/middleware/method_override.rb,
cybertrain/generator/test_data_emitter.rb,
cybertrain/generator/components_emitter.rb,
cybertrain/generator/migrations_emitter.rb,
cybertrain/generator/association_emitter.rb,
cybertrain/generator/controllers_emitter.rb,
cybertrain/middleware/host_authorization.rb,
cybertrain/template/turbo_stream_builder.rb,
cybertrain/middleware/content_security_policy_header.rb,
docs/api/stubs/cybertrain.rb

Overview

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

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

Defined Under Namespace

Modules: Assets, Background, BlobStore, Cache, Cast, Clock, Console, Cookies, Cron, Crypto, DB, Gen, GzipFFI, Html, Job, JobsPage, Lease, Main, Migration, Multipart, Net, NumberHelper, ParameterFilter, Password, Query, Routes, Runtime, SSE, Scheduler, Schema, Sse, Stream, Template, Test, Token, Turbo, Views, WebSocket Classes: Application, BlobKeyInvalid, BodyTooLarge, BodyUndecodable, BodyWriter, Component, ComponentCollection, Config, ContentSecurityPolicy, Context, Controller, CookieJar, EncryptedCookieJar, Encryptor, ErrorEvent, ErrorReporter, ErrorSubscriber, Errors, Flash, FlashNow, FormatCollector, GzipDecoder, HttpClient, Logger, MailMessage, Mailer, Model, MultipartForm, MultipartHeaderTooLarge, MultipartMalformed, MultipartPartTooLarge, MultipartTooManyParts, Page, Params, PermanentCookieJar, RateLimit, RecordInvalid, RecordNotFound, Relation, Request, RequestId, Response, SafeString, SentryDsn, Session, SignedCookieJar, Sink, TimeZone, TurboStreams, UploadedFile, ZonedTime

Class Method Summary collapse

Class Method Details

.config ⇒ Config

The application’s Config.

Returns:



1929
1930
1931
1932
1933
1934
1935
1936
# File 'cybertrain/config.rb', line 1929

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:

Returns:

  • (nil)


1951
1952
1953
1954
# File 'cybertrain/config.rb', line 1951

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

.env ⇒ String

Returns Cybertrain.config.env.

Returns:

  • (String) —

    Cybertrain.config.env



1958
1959
1960
# File 'cybertrain/config.rb', line 1958

def self.env
  config.env
end

.error ⇒ ErrorReporter

The process’s error reporter.

Examples:

Cybertrain.error.report(e, context: { "order_id" => order.id })

Returns:



874
875
876
# File 'cybertrain/error_reporter.rb', line 874

def self.error
  @error_reporter
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



15
16
17
# 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)


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

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