Module: Magik::Core

Defined in:

lib/magik/core.rb

Overview

Application composition root: the App.define boot process, the Sequel connection, and the config swap points every opinionated default must honour.

Implements: Phase 1 — Foundation of docs/idea/00-build-spec.md.

Planned DSL surface, copied from the spec:

* `App.define :Name do ... end`
* `tenant_by :subdomain`
* `swap points: db, cache, jobs, search, realtime backends`

Status: Not implemented — spec only. Every entry point below raises NotImplementedError. Nothing here reads config, touches a database or emits a byte of HTML.

See Also:

• SUBSYSTEMS

Constant Summary

SPEC_PHASE =

The build-spec phase this subsystem implements.

Returns:

• (String)

"Phase 1 — Foundation"

DSL_SURFACE =

The DSL this subsystem will expose, verbatim from the spec.

Returns:

• (Array<String>)

[
  "App.define :Name do ... end",
  "tenant_by :subdomain",
  "swap points: db, cache, jobs, search, realtime backends"
].freeze

STATUS =

Implementation status of this subsystem.

Returns:

• (String)

"Not implemented — spec only"

Class Method Summary

• .define(*_args, **_options) ⇒ void

  Entry point for the Core DSL.

Class Method Details

.define(*_args, **_options) ⇒ void

This method returns an undefined value.

Entry point for the Core DSL.

Parameters:

• _args (Array) —

  ignored

• _options (Hash) —

  ignored

Raises:

• (NotImplementedError) —

  always, until Phase 1 lands

# File 'lib/magik/core.rb', line 43

def self.define(*_args, **_options)
  raise NotImplementedError, "Magik::Core is spec-only; see docs/idea/00-build-spec.md"
end