journeybook 0.1.6.pre.alpha

data/lib/generators/journeybook/install/templates/add_knowledge_base_fields_to_journeybook_pages.rb

@@ -0,0 +1,8 @@
+class AddKnowledgeBaseFieldsToJourneybookPages < ActiveRecord::Migration[8.0]
+  def change
+    add_reference :journeybook_pages, :parent, foreign_key: { to_table: :journeybook_pages }
+    add_column :journeybook_pages, :topic, :string
+
+    add_index :journeybook_pages, %i[site_id page_type topic]
+  end
+end

data/lib/generators/journeybook/install/templates/add_open_in_new_window_to_journeybook_navigation_items.rb

@@ -0,0 +1,5 @@
+class AddOpenInNewWindowToJourneybookNavigationItems < ActiveRecord::Migration[8.0]
+  def change
+    add_column :journeybook_navigation_items, :open_in_new_window, :boolean, default: false, null: false
+  end
+end

data/lib/generators/journeybook/install/templates/add_position_to_journeybook_pages.rb

@@ -0,0 +1,6 @@
+class AddPositionToJourneybookPages < ActiveRecord::Migration[8.0]
+  def change
+    add_column :journeybook_pages, :position, :integer, null: false, default: 0
+    add_index :journeybook_pages, %i[site_id page_type parent_id position]
+  end
+end

data/lib/generators/journeybook/install/templates/create_journeybook_ai_style_prompts.rb

@@ -0,0 +1,12 @@
+class CreateJourneybookAiStylePrompts < ActiveRecord::Migration[8.0]
+  def change
+    create_table :journeybook_ai_style_prompts do |t|
+      t.string :name, null: false
+      t.text :prompt, null: false
+
+      t.timestamps
+    end
+
+    add_index :journeybook_ai_style_prompts, :name, unique: true
+  end
+end

data/lib/generators/journeybook/install/templates/create_journeybook_media_assets.rb

@@ -0,0 +1,24 @@
+class CreateJourneybookMediaAssets < ActiveRecord::Migration[8.0]
+  def change
+    create_table :journeybook_media_assets do |t|
+      t.string :title, null: false
+      t.string :alt_text
+      t.text :description
+      t.string :tags
+      t.string :storage_key, null: false
+      t.string :original_filename, null: false
+      t.string :content_type, null: false
+      t.integer :byte_size, null: false
+      t.string :checksum
+      t.integer :width
+      t.integer :height
+      t.json :metadata
+
+      t.timestamps
+    end
+
+    add_index :journeybook_media_assets, :storage_key, unique: true
+    add_index :journeybook_media_assets, :title
+    add_index :journeybook_media_assets, :content_type
+  end
+end

data/lib/generators/journeybook/install/templates/create_journeybook_navigation.rb

@@ -0,0 +1,28 @@
+class CreateJourneybookNavigation < ActiveRecord::Migration[8.0]
+  def change
+    create_table :journeybook_navigation_menus do |t|
+      t.references :site, null: false, foreign_key: { to_table: :journeybook_sites }
+      t.string :key, null: false
+      t.string :title, null: false
+      t.integer :position, null: false, default: 0
+
+      t.timestamps
+    end
+
+    add_index :journeybook_navigation_menus, %i[site_id key], unique: true
+
+    create_table :journeybook_navigation_items do |t|
+      t.references :navigation_menu, null: false, foreign_key: { to_table: :journeybook_navigation_menus }
+      t.references :page, foreign_key: { to_table: :journeybook_pages }
+      t.string :label, null: false
+      t.text :description
+      t.string :external_url
+      t.integer :position, null: false, default: 0
+      t.boolean :visible, null: false, default: true
+
+      t.timestamps
+    end
+
+    add_index :journeybook_navigation_items, %i[navigation_menu_id position]
+  end
+end

data/lib/generators/journeybook/install/templates/create_journeybook_pages.rb

@@ -0,0 +1,33 @@
+class CreateJourneybookPages < ActiveRecord::Migration[8.0]
+  def change
+    create_table :journeybook_pages do |t|
+      t.references :site, null: false, foreign_key: { to_table: :journeybook_sites }
+      t.string :title, null: false
+      t.string :slug, null: false
+      t.string :path, null: false
+      t.text :markdown, null: false
+      t.string :meta_title
+      t.text :meta_description
+      t.string :status, null: false, default: "draft"
+      t.datetime :published_at
+      t.string :layout
+      t.string :locale, null: false, default: "en"
+
+      t.string :page_type, null: false, default: "page"
+      t.text :excerpt
+      t.string :author_name
+      t.references :parent, foreign_key: { to_table: :journeybook_pages }
+      t.string :topic
+      t.integer :position, null: false, default: 0
+
+      t.timestamps
+    end
+
+    add_index :journeybook_pages, %i[site_id locale slug], unique: true
+    add_index :journeybook_pages, %i[site_id locale path], unique: true
+    add_index :journeybook_pages, :status
+    add_index :journeybook_pages, :page_type
+    add_index :journeybook_pages, %i[site_id page_type topic]
+    add_index :journeybook_pages, %i[site_id page_type parent_id position]
+  end
+end

data/lib/generators/journeybook/install/templates/create_journeybook_redirects.rb

@@ -0,0 +1,13 @@
+class CreateJourneybookRedirects < ActiveRecord::Migration[8.0]
+  def change
+    create_table :journeybook_redirects do |t|
+      t.string :from, null: false
+      t.string :to, null: false
+      t.integer :status_code, null: false, default: 301
+
+      t.timestamps
+    end
+
+    add_index :journeybook_redirects, :from, unique: true
+  end
+end

data/lib/generators/journeybook/install/templates/create_journeybook_sites.rb

@@ -0,0 +1,13 @@
+class CreateJourneybookSites < ActiveRecord::Migration[8.0]
+  def change
+    create_table :journeybook_sites do |t|
+      t.string :name, null: false
+      t.string :host, null: false
+      t.string :default_locale, null: false, default: "en"
+
+      t.timestamps
+    end
+
+    add_index :journeybook_sites, :host, unique: true
+  end
+end

data/lib/generators/journeybook/install/templates/journeybook.rb

@@ -0,0 +1,42 @@
+journeybook_credentials = Rails.application.credentials.fetch(:journeybook, {})
+journeybook_s3_default = journeybook_credentials.dig(:s3, :default) || {}
+journeybook_s3_env = journeybook_credentials.dig(:s3, Rails.env.to_sym) || {}
+journeybook_s3 = journeybook_s3_default.merge(journeybook_s3_env)
+
+Journeybook.configure do |config|
+  config.default_layout = "application"
+
+  # Journeybook denies admin access until the host application configures it.
+  # config.admin_basic_auth username: journeybook_credentials.dig(:admin, :username), password: journeybook_credentials.dig(:admin, :password)
+
+  config.openai_api_key = journeybook_credentials.dig(:openai, :api_key)
+  config.openai_model = journeybook_credentials.dig(:openai, :model) || config.openai_model
+
+  # Required when using Journeybook form components that send email via Postmark.
+  config.postmark_api_key = journeybook_credentials.dig(:postmark, :api_key)
+  # config.form_from = "noreply@example.com"
+  # config.form_to = "team@example.com"
+  # config.form_action = "/journeybook/form"
+  # config.form_delivery_method = Rails.env.development? ? :letter_opener : :postmark
+
+  # Required when using the Journeybook image library.
+  config.s3_bucket = journeybook_s3[:bucket]
+  config.s3_region = journeybook_s3[:region]
+  config.s3_access_key_id = journeybook_s3[:access_key_id]
+  config.s3_secret_access_key = journeybook_s3[:secret_access_key]
+  config.s3_prefix = journeybook_s3[:prefix] || "journeybook/#{Rails.env}"
+  # Optional: use CloudFront, a CDN, or another custom public host instead of the default S3 URL.
+  config.s3_public_base_url = journeybook_s3[:public_base_url]
+end
+
+# Register host application components here. `to_prepare` keeps registrations
+# compatible with development reloading and eager loading.
+# Rails.application.config.to_prepare do
+#   Journeybook.register :hero, Website::HeroComponent,
+#                        description: "Large hero section",
+#                        props: {
+#                          title: "Main headline",
+#                          body: { type: :long_text, description: "Supporting copy" },
+#                          image_url: { type: :image, label: "Image", description: "Image from the Journeybook library" }
+#                        }
+# end

data/lib/generators/journeybook/install/templates/pages_controller.rb

@@ -0,0 +1,3 @@
+class PagesController < ApplicationController
+  include Journeybook::PublicPages
+end

data/lib/generators/journeybook/install/templates/show.html.erb

@@ -0,0 +1,10 @@
+<% content_for :title, @journeybook_page.meta_title.presence || @journeybook_page.title %>
+<% content_for :head do %>
+  <% if @journeybook_page.meta_description.present? %>
+    <meta name="description" content="<%= @journeybook_page.meta_description %>">
+  <% end %>
+<% end %>
+
+<article class="journeybook-page">
+  <%= @journeybook_html.html_safe %>
+</article>

data/lib/journeybook/component_registry.rb

@@ -0,0 +1,136 @@
+module Journeybook
+  class ComponentRegistry
+    Component = Data.define(:name, :component_class, :metadata) do
+      DEFAULT_PROP_TYPE = :short_text
+
+      def schema
+        {
+          "name" => name.to_s,
+          "description" => metadata.fetch(:description, nil),
+          "props" => normalized_props.transform_keys(&:to_s).transform_values do |prop|
+            {
+              "type" => prop[:type].to_s,
+              "label" => prop[:label],
+              "description" => prop[:description],
+              "required" => prop[:required]
+            }.tap do |schema|
+              next unless prop[:type] == :collection
+
+              schema["min"] = prop[:min]
+              schema["max"] = prop[:max]
+              schema["item"] = prop[:item].transform_keys(&:to_s)
+            end.tap do |schema|
+              next unless prop[:type] == :select
+
+              schema["options"] = prop[:options]
+            end
+          end
+        }
+      end
+
+      def normalized_props
+        metadata.fetch(:props, {}).each_with_object({}) do |(prop_name, config), props|
+          props[prop_name.to_sym] = normalize_prop(prop_name, config)
+        end
+      end
+
+      private
+
+      def normalize_prop(prop_name, config)
+        config_hash = config.is_a?(Hash) ? config.symbolize_keys : { description: config.to_s }
+
+        {
+          type: (config_hash[:type].presence || DEFAULT_PROP_TYPE).to_sym,
+          label: config_hash[:label].presence || prop_name.to_s.humanize,
+          description: config_hash[:description].to_s,
+          required: config_hash.fetch(:required, true)
+        }.tap do |prop|
+          if prop[:type] == :image && config_hash[:icons]
+            icon_config = config_hash[:icons].is_a?(Hash) ? config_hash[:icons].symbolize_keys : {}
+            prop[:icons] = {
+              styles: Array(icon_config[:styles].presence || %w[classic duotone]).map(&:to_s),
+              colors: Array(icon_config[:colors]).map(&:to_s)
+            }
+          end
+          if prop[:type] == :collection
+            prop[:min] = config_hash[:min].to_i
+            prop[:max] = config_hash[:max].to_i if config_hash[:max].present?
+            prop[:item] = normalize_item_props(config_hash[:item])
+          elsif prop[:type] == :select
+            prop[:options] = Array(config_hash[:options]).map(&:to_s)
+          end
+        end
+      end
+
+      def normalize_item_props(item)
+        item.to_h.each_with_object({}) do |(prop_name, config), props|
+          props[prop_name.to_sym] = normalize_prop(prop_name, config)
+        end
+      end
+    end
+
+    include Enumerable
+
+    def initialize
+      @components = {}
+    end
+
+    # @param name [String, Symbol]
+    # @param component_class [Class]
+    # @param metadata [Hash]
+    # @return [Component]
+    def register(name, component_class, **metadata)
+      normalized_name = normalize_name(name)
+      @components[normalized_name] = Component.new(normalized_name, component_class, metadata)
+    end
+
+    # @param name [String, Symbol]
+    # @return [Object]
+    # @raise [Journeybook::UnknownComponentError]
+    def fetch(name)
+      registered = @components.fetch(normalize_name(name)) do
+        raise UnknownComponentError, "Unknown Journeybook component: #{name}"
+      end
+
+      registered.component_class
+    end
+
+    # @param name [String, Symbol]
+    # @return [Component, nil]
+    def registered(name)
+      @components[normalize_name(name)]
+    end
+
+    # @return [Array<Hash>]
+    def schema
+      @components.values.map(&:schema)
+    end
+
+    def for_site(site)
+      return self unless site
+
+      filtered = self.class.new
+      @components.values.each do |component|
+        next unless component_available_for_site?(component, site)
+
+        filtered.register(component.name, component.component_class, **component.metadata)
+      end
+      filtered
+    end
+
+    def each(&block)
+      @components.values.each(&block)
+    end
+
+    private
+
+    def normalize_name(name)
+      name.to_s.strip.underscore.to_sym
+    end
+
+    def component_available_for_site?(component, site)
+      sites = Array(component.metadata[:sites]).map { |value| normalize_name(value) }
+      sites.empty? || sites.include?(normalize_name(site.key))
+    end
+  end
+end

data/lib/journeybook/configuration.rb

@@ -0,0 +1,55 @@
+module Journeybook
+  class Configuration
+    attr_accessor :default_layout, :admin_authenticator, :ai_provider, :openai_api_key, :openai_model,
+      :postmark_api_key, :form_from, :form_to, :form_action, :form_delivery_method,
+      :s3_bucket, :s3_region, :s3_access_key_id, :s3_secret_access_key, :s3_prefix, :s3_public_base_url
+    attr_reader :components, :templates
+
+    def initialize
+      @default_layout = "application"
+      @admin_authenticator = ->(_controller) { false }
+      @ai_provider = :openai
+      @openai_api_key = nil
+      @openai_model = "gpt-5.4-mini"
+      @postmark_api_key = nil
+      @form_from = nil
+      @form_to = nil
+      @form_action = "/journeybook/form"
+      @form_delivery_method = :postmark
+      @s3_bucket = nil
+      @s3_region = nil
+      @s3_access_key_id = nil
+      @s3_secret_access_key = nil
+      @s3_prefix = "journeybook/#{Rails.env}"
+      @s3_public_base_url = nil
+      @components = ComponentRegistry.new
+      @templates = PageTemplateRegistry.new
+    end
+
+    # @param name [String, Symbol]
+    # @param component_class [Class]
+    # @param metadata [Hash]
+    # @return [Object]
+    def component(name, component_class, **metadata)
+      components.register(name, component_class, **metadata)
+    end
+
+    def admin_basic_auth(username:, password:, realm: "Journeybook")
+      @admin_authenticator = lambda do |controller|
+        expected_username = username.to_s
+        expected_password = password.to_s
+
+        controller.authenticate_or_request_with_http_basic(realm) do |provided_username, provided_password|
+          expected_username.present? && expected_password.present? &&
+            secure_compare(provided_username, expected_username) && secure_compare(provided_password, expected_password)
+        end
+      end
+    end
+
+    private
+
+    def secure_compare(provided, expected)
+      ActiveSupport::SecurityUtils.secure_compare(Digest::SHA256.hexdigest(provided), Digest::SHA256.hexdigest(expected))
+    end
+  end
+end

data/lib/journeybook/engine.rb

@@ -0,0 +1,19 @@
+require "importmap-rails"
+require "stimulus-rails"
+
+module Journeybook
+  class Engine < ::Rails::Engine
+    isolate_namespace Journeybook
+
+    config.autoload_paths << root.join("app/services")
+    config.eager_load_paths << root.join("app/services")
+
+    initializer "journeybook.importmap", after: "importmap" do |app|
+      path = root.join("config/importmap.rb")
+      app.config.importmap.paths << path
+      app.config.importmap.cache_sweepers << root.join("app/javascript")
+      app.config.assets.paths << root.join("app/javascript")
+      app.importmap.draw(path)
+    end
+  end
+end

data/lib/journeybook/page_template_registry.rb

@@ -0,0 +1,67 @@
+module Journeybook
+  class PageTemplateRegistry
+    Template = Data.define(:key, :metadata) do
+      def name
+        metadata.fetch(:name, key.to_s.humanize)
+      end
+
+      def description
+        metadata.fetch(:description, "")
+      end
+
+      def page_type
+        metadata.fetch(:page_type, "page").to_s
+      end
+
+      def markdown
+        metadata.fetch(:markdown, "").to_s
+      end
+
+      def path_prefix
+        metadata[:path_prefix].to_s.presence
+      end
+
+      def path_hint
+        metadata[:path_hint].to_s.presence
+      end
+
+      def available_for_site?(site)
+        sites = Array(metadata[:sites]).map(&:to_s)
+        sites.empty? || site && site.key.in?(sites)
+      end
+    end
+
+    include Enumerable
+
+    def initialize
+      @templates = {}
+    end
+
+    def register(key, **metadata)
+      normalized_key = normalize_key(key)
+      @templates[normalized_key] = Template.new(normalized_key, metadata)
+    end
+
+    def fetch(key)
+      @templates.fetch(normalize_key(key))
+    end
+
+    def registered(key)
+      @templates[normalize_key(key)]
+    end
+
+    def for_site(site)
+      @templates.values.select { |template| template.available_for_site?(site) }
+    end
+
+    def each(&)
+      @templates.values.each(&)
+    end
+
+    private
+
+    def normalize_key(key)
+      key.to_s.parameterize(separator: "_").underscore.to_sym
+    end
+  end
+end

data/lib/journeybook/public_page_constraint.rb

@@ -0,0 +1,23 @@
+module Journeybook
+  class PublicPageConstraint
+    RESERVED_PATHS = %w[
+      /assets/
+      /journeybook/
+      /rails/
+      /recede_historical_location
+      /resume_historical_location
+      /refresh_historical_location
+      /up
+    ].freeze
+
+    def matches?(request)
+      request.get? && html_request?(request) && RESERVED_PATHS.none? { |path| request.path.start_with?(path) }
+    end
+
+    private
+
+    def html_request?(request)
+      request.format.html? || request.format == Mime[:all]
+    end
+  end
+end

data/lib/journeybook/version.rb

@@ -0,0 +1,3 @@
+module Journeybook
+  VERSION = "0.1.6-alpha"
+end

data/lib/journeybook.rb

@@ -0,0 +1,62 @@
+require "journeybook/version"
+require "journeybook/component_registry"
+require "journeybook/page_template_registry"
+require "journeybook/configuration"
+require "journeybook/public_page_constraint"
+require "journeybook/engine"
+
+module Journeybook
+  class Error < StandardError; end
+  class UnknownComponentError < Error; end
+
+  class << self
+    # @return [Journeybook::Configuration]
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # @yieldparam config [Journeybook::Configuration]
+    # @return [Journeybook::Configuration]
+    def configure
+      yield configuration
+      configuration
+    end
+
+    # @return [Journeybook::ComponentRegistry]
+    def components
+      configuration.components
+    end
+
+    # @param name [String, Symbol]
+    # @return [Object]
+    def component(name)
+      components.fetch(name)
+    end
+
+    # @param name [String, Symbol]
+    # @param component_class [Class]
+    # @param metadata [Hash]
+    # @return [Object]
+    def register(name, component_class, **metadata)
+      components.register(name, component_class, **metadata)
+    end
+
+    # @return [Journeybook::PageTemplateRegistry]
+    def templates
+      configuration.templates
+    end
+
+    # @param key [String, Symbol]
+    # @return [Journeybook::PageTemplateRegistry::Template]
+    def template(key)
+      templates.fetch(key)
+    end
+
+    # @param key [String, Symbol]
+    # @param metadata [Hash]
+    # @return [Journeybook::PageTemplateRegistry::Template]
+    def register_template(key, **metadata)
+      templates.register(key, **metadata)
+    end
+  end
+end

data/lib/tasks/journeybook_tasks.rake

@@ -0,0 +1,8 @@
+namespace :journeybook do
+  desc "Install Journeybook migrations, initializer, and host component directories"
+  task install: :environment do
+    require "rails/generators"
+
+    Rails::Generators.invoke("journeybook:install", [], destination_root: Rails.root)
+  end
+end