sitepress 5.0.0.beta1 → 5.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b707e7c86292a673b7ac37ea95e669fe9bcc089488526a0d2fce815052589c91
-  data.tar.gz: 225126e120689d7a943698c7c6e0d5b221ebd8a7b669f53949f158239ad475e7
+  metadata.gz: 30daa89481221dd83d4fc8041ff73e5187ea0715ca763a0d6542899fadb0f60b
+  data.tar.gz: 04d1a39f9d91d1ae2b492e2619ade8a1217395948dc66d663c8af196b2aa0ce0
 SHA512:
-  metadata.gz: 282751df85cd68d7d160bb2266e270dc75b3740d8d45c14ab7a4a2330687ca5244a395aa2fdbbb6a274d20f996e18415160c87836f4e220b963fe06c36c69a7d
-  data.tar.gz: e0365ccfcc30ee2ab4fb5542c4785edb8d48bb7438f22e1ac11da95ed5043372d39fc568bde28beb7840bfba6df7bebd09208ae3ec060584f06794cce1b72f9a
+  metadata.gz: 1008b2d97905b6749180bf8c79b85987ffd20c219e0dc9cdbb657b2103a42ff473ea59f8bc23dd93f537b076515bd02c9291b42977b816c86f662130b273fc4c
+  data.tar.gz: d4a8406386ea5a29107c6bcadc451f094ccae768565881dca68695cb26115b938c057a469ba2caac63f9df55ee5631a1b6476447961e78158d6771b738c4d229

data/exe/sitepress

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
-require "sitepress-cli"
+require "sitepress"
+require "sitepress/cli"
 
 Sitepress::CLI.start(ARGV)

data/lib/sitepress/application.rb

@@ -0,0 +1,61 @@
+require "action_controller/railtie"
+require "propshaft"
+require "sitepress-rails"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+# Configure the rails application for standalone Sitepress.
+# This handles rendering pages via Rails' view layer.
+module Sitepress
+  class Application < Rails::Application
+    # Control whether or not to display friendly error reporting messages
+    # in Sitepress. The development server turns this on an handles exception,
+    # while the compile and other environments would likely have this disabled.
+    config.enable_site_error_reporting = false
+
+    # When in a development environment, we'll want to reload the site between
+    # requests so we can see the latest changes; otherwise, load the site once
+    # and we're done.
+    config.enable_site_reloading = false
+
+    # Default to a development environment type of configuration, which would reload the site.
+    # This gets reset later depending on a preference in the `before_initialize` callback.
+    config.eager_load = true
+    config.cache_classes = true
+
+    config.before_initialize do
+      # Eager load classes, content, etc. to boost performance when site reloading is disabled.
+      config.eager_load = !config.enable_site_reloading
+
+      # Cache classes for speed in production environments when site reloading is disabled.
+      config.cache_classes = !config.enable_site_reloading
+    end
+
+    # Path that points the the Sitepress UI rails app; which displays routes, error messages.
+    # etc. to the user if `enable_site_error_reporting` is enabled.
+    config.root = File.join(File.dirname(__FILE__), "../../rails")
+
+    # Rails won't start without this.
+    config.secret_key_base = SecureRandom.uuid
+
+    # Setup routes. The `constraints` key is set to `nil` so the `SiteController` can
+    # treat a page not being found as an exception, which it then handles. If the constraint
+    # was set to the default, Sitepress would hand off routing back to rails if something isn't
+    # found and fail silently.
+    routes.append { sitepress_pages root: true, controller: "site", constraints: nil }
+
+    # Setup logger.
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
+
+    # Allow any host to connect to the development server. The actual binding is
+    # controlled by server in the `sitepress-cli`; not by Rails.
+    config.hosts << proc { true } if config.respond_to? :hosts
+
+    # Stand-alone boot locations
+    paths["config/initializers"] << File.expand_path("./config/initializers")
+  end
+end

data/lib/sitepress/application_server.rb

@@ -0,0 +1,72 @@
+module Sitepress
+  # Development server wrapper that handles Application setup and
+  # delegates to the base Server class.
+  #
+  # This provides a simpler API for site.rb configuration:
+  #
+  #   site = Sitepress::Site.new(root_path: ".")
+  #   Sitepress.server = Sitepress::ApplicationServer.new(site)
+  #   Sitepress.server.live_reload = true
+  #   Sitepress.server.add_process :css, "tailwindcss -w ..."
+  #
+  class ApplicationServer
+    attr_reader :site, :processes
+    attr_accessor :live_reload, :host, :port
+
+    def initialize(site)
+      @site = site
+      @live_reload = false
+      @host = Server::DEFAULT_HOST
+      @port = Server::DEFAULT_PORT
+      @processes = []
+    end
+
+    # Add a labeled process to run alongside the server.
+    def add_process(label, command)
+      @processes << [label, command]
+    end
+
+    # Start the server with the Sitepress Application.
+    def run
+      setup_application!
+
+      r = build_reloader if live_reload
+
+      server = Server.new(Application, reloader: r)
+      server.host = host
+      server.port = port
+      @processes.each { |label, cmd| server.add_process(label, cmd) }
+
+      puts "  Site: #{site.root_path}"
+      server.run
+    end
+
+    private
+
+    def setup_application!
+      require_relative "application"
+
+      Application.config.enable_site_error_reporting = true
+      Application.config.enable_site_reloading = true
+
+      # Make site available to the Rails app
+      Sitepress.configuration.site = site
+
+      Application.initialize!
+    end
+
+    def build_reloader
+      r = Reloader.new(logger: $stdout)
+      site_watch_paths.each { |path| r.watch(path) }
+      r
+    end
+
+    def site_watch_paths
+      [
+        site.pages_path.to_s,
+        site.helpers_path.to_s,
+        site.assets_path.to_s
+      ].select { |p| File.directory?(p) }
+    end
+  end
+end

data/lib/sitepress/cli/plugin_helpers.rb

@@ -0,0 +1,59 @@
+require "thor"
+
+module Sitepress
+  class CLI < Thor
+    # Helpers for CLI plugin commands.
+    #
+    # Include this module in your plugin's Thor class to get access
+    # to Sitepress configuration, site, and Rails environment.
+    #
+    # Example:
+    #
+    #   class Sitepress::Deploy::CLI < Thor
+    #     include Sitepress::CLI::PluginHelpers
+    #
+    #     desc "s3", "Deploy to S3"
+    #     def s3
+    #       initialize!  # Boot Rails/Sitepress
+    #       site.resources.each { |r| upload(r) }
+    #     end
+    #   end
+    #
+    module PluginHelpers
+      # Boot the Rails/Sitepress environment.
+      # Call this at the start of commands that need access to the site.
+      #
+      # @yield [app] Optional block to configure the app before initialization
+      def initialize!(&block)
+        require File.expand_path("../boot", __dir__)
+        app.tap(&block) if block_given?
+        app.initialize! unless app.initialized?
+      end
+
+      # The Sitepress::Server Rails application.
+      def app
+        Sitepress::Server
+      end
+
+      # The Sitepress configuration object.
+      def configuration
+        Sitepress.configuration
+      end
+
+      # The configured Site instance.
+      def site
+        configuration.site
+      end
+
+      # The parent Rails engine (Sitepress::Server or host app).
+      def rails
+        configuration.parent_engine
+      end
+
+      # The Rails logger.
+      def logger
+        rails.config.logger
+      end
+    end
+  end
+end

data/lib/sitepress/cli.rb

@@ -0,0 +1,173 @@
+require "thor"
+require "fileutils"
+
+module Sitepress
+  # Command line interface for Sitepress sites.
+  class CLI < Thor
+    # Default build path for compiler.
+    COMPILE_TARGET_PATH = "./build".freeze
+
+    # Site configuration file
+    SITE_CONFIG_PATH = "config/site.rb".freeze
+
+    include Thor::Actions
+
+    source_root File.expand_path("../../../templates/default", __FILE__)
+
+    option :port, aliases: "-p", type: :numeric, desc: "Port to run server on"
+    option :host, aliases: "-h", type: :string, desc: "Host to bind server to"
+    desc "server", "Run development server"
+    def server
+      setup_environment!
+      load_site_config!(validate: false)
+
+      unless Sitepress.server
+        say "Error: Server not configured in #{SITE_CONFIG_PATH}", :red
+        say "Add: Sitepress.server = Sitepress::ApplicationServer.new(site)"
+        exit 1
+      end
+
+      # Override port/host if specified on command line
+      Sitepress.server.port = options[:port] if options[:port]
+      Sitepress.server.host = options[:host] if options[:host]
+
+      Sitepress.server.run
+    end
+
+    option :output_path, default: COMPILE_TARGET_PATH, type: :string
+    option :fail_on_error, default: false, type: :boolean
+    desc "compile", "Compile project into static pages"
+    def compile
+      setup_environment!
+      load_site_config!(validate: false)
+      setup_site_from_server!
+      initialize_rails_app!
+
+      logger.info "Sitepress compiling assets"
+      compile_assets(Pathname.new(options.fetch("output_path")).join("assets"))
+
+      logger.info "Sitepress compiling pages"
+      compiler = Compiler::Files.new \
+        site: Sitepress.site,
+        root_path: options.fetch("output_path"),
+        fail_on_error: options.fetch("fail_on_error")
+
+      begin
+        compiler.compile
+      ensure
+        logger.info ""
+        logger.info "Compilation Summary"
+        logger.info "  Build path: #{compiler.root_path.expand_path}"
+        logger.info "  Succeeded:  #{compiler.succeeded.count}"
+        logger.info "  Failed:     #{compiler.failed.count}"
+        if compiler.failed.any?
+          logger.info ""
+          logger.info "Failed Resources"
+          compiler.failed.each do |resource|
+            logger.info "  #{resource.request_path}  #{resource.asset.path}"
+          end
+          abort
+        end
+      end
+    end
+
+    desc "console", "Interactive project shell"
+    def console
+      setup_environment!
+      load_site_config!(validate: false)
+      setup_site_from_server!
+      initialize_rails_app!
+      REPL.new(site: Sitepress.site).start
+    end
+
+    desc "new PATH", "Create new project at PATH"
+    def new(target)
+      # Peg the generated site to roughly the released version.
+      *segments, _ = Gem::Version.new(Sitepress::VERSION).segments
+      @target_sitepress_version = segments.join(".")
+
+      inside target do
+        directory self.class.source_root, "."
+        run "bundle install"
+      end
+    end
+
+    desc "version", "Show version"
+    def version
+      say Sitepress::VERSION
+    end
+
+    private
+
+    def setup_environment!
+      unless File.exist?(SITE_CONFIG_PATH)
+        say "Error: #{SITE_CONFIG_PATH} not found.", :red
+        say "Run 'sitepress new .' to create a new project in the current directory."
+        exit 1
+      end
+
+      # Set up Bundler if Gemfile exists
+      if File.exist?("Gemfile")
+        ENV['BUNDLE_GEMFILE'] ||= File.expand_path("Gemfile")
+        require "bundler/setup"
+      end
+    end
+
+    def load_site_config!(validate: true)
+      config_path = File.expand_path(SITE_CONFIG_PATH)
+      load config_path
+
+      # Ensure site is configured (check the raw instance variable to avoid auto-creating default)
+      if validate && !Sitepress.configuration.instance_variable_get(:@site)
+        say "Error: Site not configured in #{SITE_CONFIG_PATH}", :red
+        say "Add: Sitepress.configuration.site = Sitepress::Site.new(root_path: '.')"
+        exit 1
+      end
+    end
+
+    def setup_site_from_server!
+      # Store the site so RailsConfiguration can use it instead of creating a default.
+      # This must be set BEFORE requiring sitepress-rails.
+      if Sitepress.server.respond_to?(:site)
+        Sitepress.pending_site = Sitepress.server.site
+      end
+    end
+
+    def initialize_rails_app!
+      require_relative "application"
+
+      Application.config.enable_site_error_reporting = false
+      Application.config.enable_site_reloading = false
+
+      Application.initialize!
+    end
+
+    def compile_assets(output_path)
+      assets = Application.assets
+
+      if defined?(Propshaft) && assets.is_a?(Propshaft::Assembly)
+        FileUtils.mkdir_p(output_path)
+        processor = Propshaft::Processor.new(
+          load_path: assets.load_path,
+          output_path: output_path,
+          compilers: assets.compilers,
+          manifest_path: output_path.join(".manifest.json")
+        )
+        processor.process
+      elsif defined?(Sprockets) && assets.class.name.start_with?("Sprockets::")
+        FileUtils.mkdir_p(output_path)
+        manifest = Sprockets::Manifest.new(assets, output_path)
+        precompile = Application.config.assets.precompile
+        manifest.compile(precompile)
+      else
+        logger.warn "Unknown asset pipeline, skipping asset compilation"
+      end
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT).tap do |l|
+        l.formatter = ->(_, _, _, msg) { "#{msg}\n" }
+      end
+    end
+  end
+end

data/lib/sitepress/plugins.rb

@@ -0,0 +1,76 @@
+module Sitepress
+  # Plugin registry for CLI command extensions.
+  #
+  # Plugins are discovered via Bundler by looking for gems with
+  # `sitepress_plugin: "true"` in their gemspec metadata.
+  #
+  # Example plugin registration:
+  #
+  #   Sitepress::Plugins.register(
+  #     name: "deploy",
+  #     cli: Sitepress::Deploy::CLI,
+  #     description: "Deploy your site"
+  #   )
+  #
+  module Plugins
+    class << self
+      def registry
+        @registry ||= {}
+      end
+
+      # Register a plugin CLI class.
+      #
+      # @param name [String] The subcommand name (e.g., "deploy")
+      # @param cli [Class] A Thor class with the plugin's commands
+      # @param description [String] Description shown in `sitepress help`
+      def register(name:, cli:, description: nil)
+        name = name.to_s
+        if registry.key?(name)
+          warn "WARNING: Sitepress plugin '#{name}' is already registered, skipping"
+          return
+        end
+
+        registry[name] = {
+          cli: cli,
+          description: description || "#{name} commands"
+        }
+      end
+
+      # Discover and load plugins from Bundler.
+      # Looks for gems with `sitepress_plugin: "true"` metadata.
+      def discover!
+        return unless defined?(Bundler)
+
+        Bundler.load.specs.each do |spec|
+          next unless spec.metadata["sitepress_plugin"] == "true"
+
+          begin
+            require spec.name
+          rescue LoadError => e
+            warn "WARNING: Could not load Sitepress plugin '#{spec.name}': #{e.message}"
+          end
+        end
+      end
+
+      # List of registered plugin names.
+      def registered
+        registry.keys
+      end
+
+      # Get a specific plugin by name.
+      def get(name)
+        registry[name.to_s]
+      end
+
+      # Iterate over all registered plugins.
+      def each(&block)
+        registry.each(&block)
+      end
+
+      # Clear the registry (useful for testing).
+      def reset!
+        @registry = {}
+      end
+    end
+  end
+end

data/lib/sitepress/project_template.rb

@@ -0,0 +1,18 @@
+require "fileutils"
+
+module Sitepress
+  # Creates new projects from a template.
+  class ProjectTemplate
+    DEFAULT_TEMPLATE = File.expand_path("../../../templates/default",__FILE__).freeze
+
+    include FileUtils
+
+    def initialize(path: DEFAULT_TEMPLATE)
+      @path = path
+    end
+
+    def copy(to:)
+      cp_r @path, to
+    end
+  end
+end

data/lib/sitepress/repl.rb

@@ -0,0 +1,29 @@
+require "irb"
+
+module Sitepress
+  # Interactive REPL for Sitepress project
+  class REPL
+    attr_reader :site
+
+    def initialize(site:)
+      @site = site
+    end
+
+    def start
+      ARGV.clear
+      IRB.setup(nil)
+      IRB.conf[:PROMPT_MODE] = :SIMPLE
+      workspace = IRB::WorkSpace.new(binding)
+      IRB::Irb.new(workspace).run(IRB.conf)
+    end
+
+    # Provide convenient access in the REPL
+    def resources
+      site.resources
+    end
+
+    def get(path)
+      site.get(path)
+    end
+  end
+end

data/lib/sitepress.rb

@@ -1,2 +1,19 @@
+require "sitepress-core"
+require "sitepress-server"
+
 module Sitepress
+  autoload :Application,        "sitepress/application"
+  autoload :ApplicationServer,  "sitepress/application_server"
+  autoload :CLI,                "sitepress/cli"
+  autoload :Plugins,            "sitepress/plugins"
+  autoload :ProjectTemplate,    "sitepress/project_template"
+  autoload :REPL,               "sitepress/repl"
+
+  class << self
+    # Server is only used in standalone mode
+    attr_accessor :server
+
+    # Used by CLI to pass site to RailsConfiguration before Rails is loaded
+    attr_accessor :pending_site
+  end
 end

data/rails/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/rails/app/controllers/site_controller.rb

@@ -0,0 +1,62 @@
+class SiteController < ApplicationController
+  include Sitepress::SitePages
+
+  DEFAULT_SITE_LAYOUT = "layouts/layout".freeze
+
+  # This `rescue_from` order is important; it must come before the
+  # `include Sitepress::SitePages` statement; otherwise exceptions
+  # won't be properly handled.
+  rescue_from Exception, with: :standard_error
+  rescue_from ActionView::Template::Error, with: :action_view_template_error
+  rescue_from Sitepress::ParseError, with: :parse_error
+  rescue_from Sitepress::ResourceNotFoundError, with: :page_not_found
+
+  layout :site_layout
+
+  private
+  def site_layout
+    DEFAULT_SITE_LAYOUT if template_exists? DEFAULT_SITE_LAYOUT
+  end
+
+  def standard_error(exception)
+    render_exception(template: "standard_error", exception: exception)
+  end
+
+  def action_view_template_error(exception)
+    render_exception(template: "action_template_error", exception: exception)
+  end
+
+  def parse_error(exception)
+    raise exception unless has_error_reporting_enabled?
+
+    @title = "Parse error"
+    @exception = exception
+    render "parse_error", layout: "sitepress_error", status: :internal_server_error, formats: :html
+  end
+
+  def render_exception(template:, exception:)
+    raise exception unless has_error_reporting_enabled?
+
+    @title = "Error in resource #{current_page.asset.path}"
+    @exception = exception
+    render template, layout: "sitepress_error", status: :internal_server_error, formats: :html
+  end
+
+  def page_not_found(exception)
+    raise exception unless has_error_reporting_enabled?
+    not_found
+  end
+
+  def not_found
+    @title = "Could not find resource at #{request.path}"
+    render "not_found", layout: "sitepress_error", status: :not_found
+  end
+
+  def has_error_reporting_enabled?
+    Sitepress::Application.config.enable_site_error_reporting
+  end
+
+  def reload_site?
+    Sitepress::Application.config.enable_site_reloading
+  end
+end

data/rails/app/helpers/application_helper.rb

@@ -0,0 +1,27 @@
+module ApplicationHelper
+  DEFAULT_TITLE_KEY = "title".freeze
+
+  DEFAULT_ORDER_KEY = "order".freeze
+
+  # Links to a Sitepress::Resource. If the link does not have a block, the `title`
+  # attribute from Resource#data is used to create the text link.
+  def link_to_page(page, *args, title_key: DEFAULT_TITLE_KEY, **kwargs, &block)
+    if block_given?
+      link_to page.request_path, *args, **kwargs, &block
+    else
+      link_to page.data[DEFAULT_TITLE_KEY], page.request_path, *args, **kwargs
+    end
+  end
+
+  # Render a block within a layout. This is a useful, and prefered way, to handle
+  # nesting layouts, within Sitepress
+  def render_layout(layout, locals = {}, &block)
+    render inline: capture(&block), layout: "layouts/#{layout}", locals: locals
+  end
+
+  # Orders pages via the
+  def order_pages(pages, order_key: DEFAULT_ORDER_KEY)
+    pages.sort_by { |r| r.data.fetch(order_key, Float::INFINITY) }
+  end
+
+end

data/rails/app/views/layouts/sitepress.html.erb

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title><%= @title || "Sitepress" %></title>
+  <link href="/_sitepress/stylesheets/site.css" rel="stylesheet">
+</head>
+<body>
+  <header>
+    <img src="/_sitepress/images/logo.svg" alt="Sitepress" id="logo">
+    <h1 id="title"><%= @title || "Sitepress" %></h1>
+  </header>
+  <main>
+    <%= yield %>
+  </main>
+  <footer>
+    Sitepress <%= Sitepress::VERSION %> &middot; <a href="https://sitepress.cc/">sitepress.cc</a>
+  </footer>
+</body>
+</html>

data/rails/app/views/layouts/sitepress_error.html.erb

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title><%= @title || "Sitepress" %></title>
+  <link href="/_sitepress/stylesheets/site.css" rel="stylesheet">
+  <script src="/_sitepress/javascripts/error.js" defer></script>
+</head>
+<body>
+  <div class="error-page">
+    <main class="error-main">
+      <div class="error-branding">
+        <img src="/_sitepress/images/logo.svg" alt="Sitepress" class="error-branding__logo">
+        <span class="error-branding__version">v<%= Sitepress::VERSION %></span>
+      </div>
+      <%= yield %>
+    </main>
+  </div>
+</body>
+</html>

data/rails/app/views/site/_copy_button.html.erb

@@ -0,0 +1,7 @@
+<button class="copy-btn" onclick="copyError(this)">
+  <svg class="icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
+    <rect x="9" y="9" width="13" height="13" rx="2"></rect>
+    <path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"></path>
+  </svg>
+  Copy
+</button>

data/rails/app/views/site/_footer.html.erb

@@ -0,0 +1 @@
+<footer class="error-footer"><a href="https://sitepress.cc">sitepress.cc</a></footer>