Module: Journeybook

Defined in:
lib/journeybook.rb,
lib/journeybook/engine.rb,
lib/journeybook/version.rb,
app/models/journeybook/page.rb,
app/models/journeybook/site.rb,
lib/journeybook/configuration.rb,
app/models/journeybook/redirect.rb,
app/models/journeybook/media_asset.rb,
lib/journeybook/component_registry.rb,
app/jobs/journeybook/application_job.rb,
app/services/journeybook/form_mailer.rb,
app/models/journeybook/ai_style_prompt.rb,
app/models/journeybook/navigation_item.rb,
app/models/journeybook/navigation_menu.rb,
app/services/journeybook/page_renderer.rb,
app/services/journeybook/page_resolver.rb,
lib/journeybook/page_template_registry.rb,
lib/journeybook/public_page_constraint.rb,
app/services/journeybook/html_sanitizer.rb,
app/services/journeybook/postmark_client.rb,
app/helpers/journeybook/navigation_helper.rb,
app/models/journeybook/application_record.rb,
app/services/journeybook/ai/openai_client.rb,
app/services/journeybook/component_parser.rb,
app/helpers/journeybook/application_helper.rb,
app/services/journeybook/ai/prompt_builder.rb,
app/services/journeybook/markdown_renderer.rb,
app/services/journeybook/storage/s3_client.rb,
app/services/journeybook/component_renderer.rb,
app/services/journeybook/component_validator.rb,
app/services/journeybook/letter_opener_client.rb,
app/services/journeybook/ai/markdown_generator.rb,
app/services/journeybook/ai/template_validator.rb,
app/services/journeybook/component_tag_updater.rb,
app/controllers/concerns/journeybook/public_pages.rb,
app/controllers/journeybook/admin/pages_controller.rb,
app/controllers/journeybook/admin/sites_controller.rb,
app/controllers/journeybook/application_controller.rb,
lib/generators/journeybook/install/install_generator.rb,
app/controllers/journeybook/admin/ai_pages_controller.rb,
app/controllers/journeybook/admin/dashboard_controller.rb,
app/controllers/journeybook/admin/redirects_controller.rb,
app/controllers/journeybook/admin/components_controller.rb,
app/controllers/journeybook/form_submissions_controller.rb,
app/controllers/journeybook/admin/media_assets_controller.rb,
app/controllers/journeybook/admin/ai_style_prompts_controller.rb,
app/controllers/journeybook/admin/navigation_items_controller.rb,
app/controllers/journeybook/admin/navigation_menus_controller.rb

Defined Under Namespace

Modules: Admin, Ai, ApplicationHelper, Generators, NavigationHelper, PublicPages, Storage Classes: AiStylePrompt, ApplicationController, ApplicationJob, ApplicationRecord, ComponentParser, ComponentRegistry, ComponentRenderer, ComponentTagUpdater, ComponentValidator, Configuration, Engine, Error, FormMailer, FormSubmissionsController, HtmlSanitizer, LetterOpenerClient, MarkdownRenderer, MediaAsset, NavigationItem, NavigationMenu, Page, PageRenderer, PageResolver, PageTemplateRegistry, PostmarkClient, PublicPageConstraint, Redirect, Site, UnknownComponentError

Constant Summary collapse

VERSION = 
"0.1.6-alpha"

Class Method Summary collapse

Class Method Details

.component(name) ⇒ Object

Parameters:

  • name (String, Symbol)

Returns:

  • (Object) 


32
33
34
 
# File 'lib/journeybook.rb', line 32

def component(name)
  components.fetch(name)
end

.components ⇒ Journeybook::ComponentRegistry

Returns:



26
27
28
 
# File 'lib/journeybook.rb', line 26

def components
  configuration.components
end

.configuration ⇒ Journeybook::Configuration

Returns:



14
15
16
 
# File 'lib/journeybook.rb', line 14

def configuration
  @configuration ||= Configuration.new
end

.configure {|config| ... } ⇒ Journeybook::Configuration

Yield Parameters:

Returns:



20
21
22
23
 
# File 'lib/journeybook.rb', line 20

def configure
  yield configuration
  configuration
end

.register(name, component_class, **metadata) ⇒ Object

Parameters:

  • name (String, Symbol)
  • component_class (Class)
  • metadata (Hash)

Returns:

  • (Object) 


40
41
42
 
# File 'lib/journeybook.rb', line 40

def register(name, component_class, **metadata)
  components.register(name, component_class, **metadata)
end

.register_template(key, **metadata) ⇒ Journeybook::PageTemplateRegistry::Template

Parameters:

  • key (String, Symbol)
  • metadata (Hash)

Returns:



58
59
60
 
# File 'lib/journeybook.rb', line 58

def register_template(key, **metadata)
  templates.register(key, **metadata)
end

.template(key) ⇒ Journeybook::PageTemplateRegistry::Template

Parameters:

  • key (String, Symbol)

Returns:



51
52
53
 
# File 'lib/journeybook.rb', line 51

def template(key)
  templates.fetch(key)
end

.templates ⇒ Journeybook::PageTemplateRegistry

Returns:



45
46
47
 
# File 'lib/journeybook.rb', line 45

def templates
  configuration.templates
end