Module: Magik::Notify

Defined in:

lib/magik/notify.rb

Overview

Multi-channel notifications from a single declaration.

Implements: Phase 8 — i18n, PWA, Notifications of docs/idea/00-build-spec.md.

Planned DSL surface, copied from the spec:

* `notification :name do channel :email, :in_app, :push end`

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 8 — i18n, PWA, Notifications"

DSL_SURFACE =

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

Returns:

• (Array<String>)

[
  "notification :name do channel :email, :in_app, :push end"
].freeze

STATUS =

Implementation status of this subsystem.

Returns:

• (String)

"Not implemented — spec only"

Class Method Summary

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

  Entry point for the Notify DSL.

Class Method Details

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

This method returns an undefined value.

Entry point for the Notify DSL.

Parameters:

• _args (Array) —

  ignored

• _options (Hash) —

  ignored

Raises:

• (NotImplementedError) —

  always, until Phase 8 lands

# File 'lib/magik/notify.rb', line 38

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