bridgetown-core 1.2.0.beta5 → 1.3.0.beta1

data/lib/roda/plugins/bridgetown_server.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+class Roda
+  module RodaPlugins
+    module BridgetownServer
+      SiteContext = Struct.new(:registers) # for use by Liquid-esque URL helpers
+
+      def self.load_dependencies(app) # rubocop:disable Metrics
+        unless Bridgetown::Current.preloaded_configuration
+          raise "You must supply a preloaded configuration before loading the Bridgetown Roda " \
+                "plugin"
+        end
+
+        app.plugin :initializers
+        app.plugin :method_override
+        app.plugin :all_verbs
+        app.plugin :hooks
+        app.plugin :common_logger, Bridgetown::Rack::Logger.new($stdout), method: :info
+        app.plugin :json
+        app.plugin :json_parser
+        app.plugin :indifferent_params
+        app.plugin :cookies
+        app.plugin :streaming
+        app.plugin :public, root: Bridgetown::Current.preloaded_configuration.destination
+        app.plugin :not_found do
+          output_folder = Bridgetown::Current.preloaded_configuration.destination
+          File.read(File.join(output_folder, "404.html"))
+        rescue Errno::ENOENT
+          "404 Not Found"
+        end
+        app.plugin :exception_page
+        app.plugin :error_handler do |e|
+          Bridgetown::Errors.print_build_error(
+            e, logger: Bridgetown::LogAdapter.new(self.class.opts[:common_logger]), server: true
+          )
+          next exception_page(e) if ENV.fetch("RACK_ENV", nil) == "development"
+
+          output_folder = Bridgetown::Current.preloaded_configuration.destination
+          File.read(File.join(output_folder, "500.html"))
+        rescue Errno::ENOENT
+          "500 Internal Server Error"
+        end
+
+        ExceptionPage.class_eval do # rubocop:disable Metrics/BlockLength
+          def self.css
+            <<~CSS
+              html * { padding:0; margin:0; }
+              body * { padding:10px 20px; }
+              body * * { padding:0; }
+              body { font-family: -apple-system, sans-serif; font-size: 90%; }
+              body>div { border-bottom:1px solid #ddd; }
+              code { font-family: ui-monospace, monospace; }
+              h1 { font-weight: bold; margin-block-end: .8em; }
+              h2 { margin-block-end:.8em; }
+              h2 span { font-size:80%; color:#f7f7db; font-weight:normal; }
+              h3 { margin:1em 0 .5em 0; }
+              h4 { margin:0 0 .5em 0; font-weight: normal; }
+              table {
+                  border:1px solid #ccc; border-collapse: collapse; background:white; }
+              tbody td, tbody th { vertical-align:top; padding:2px 3px; }
+              thead th {
+                  padding:1px 6px 1px 3px; background:#fefefe; text-align:left;
+                  font-weight:normal; font-size:11px; border:1px solid #ddd; }
+              tbody th { text-align:right; opacity: 0.7; padding-right:.5em; }
+              table.vars { margin:5px 0 2px 40px; }
+              table.vars td, table.req td { font-family: ui-monospace, monospace; }
+              table td.code { width:100%;}
+              table td.code div { overflow:hidden; }
+              table.source th { color:#666; }
+              table.source td {
+                  font-family: ui-monospace, monospace; white-space:pre; border-bottom:1px solid #eee; }
+              ul.traceback { list-style-type:none; }
+              ul.traceback li.frame { margin-bottom:1em; }
+              div.context { margin: 10px 0; }
+              div.context ol {
+                  padding-left:30px; margin:0 10px; list-style-position: inside; }
+              div.context ol li {
+                  font-family: ui-monospace, monospace; white-space:pre; color:#666; cursor:pointer; }
+              div.context ol.context-line li { color:black; background-color:#f7f7db; }
+              div.context ol.context-line li span { float: right; }
+              div.commands { margin-left: 40px; }
+              div.commands a { color:black; text-decoration:none; }
+              #summary { background: #1D453C; color: white; }
+              #summary h2 { font-weight: normal; color: white; }
+              #summary ul#quicklinks { list-style-type: none; margin-bottom: 2em; }
+              #summary ul#quicklinks li { float: left; padding: 0 1em; }
+              #summary ul#quicklinks>li+li { border-left: 1px #666 solid; }
+              #summary a { color: #f47c3c; }
+              #explanation { background:#eee; }
+              #traceback { background: white; }
+              #requestinfo { background:#f6f6f6; padding-left:120px; }
+              #summary table { border:none; background:transparent; }
+              #requestinfo h2, #requestinfo h3 { position:relative; margin-left:-100px; }
+              #requestinfo h3 { margin-bottom:-1em; }
+              .error { background: #ffc; }
+              .specific { color:#cc3300; font-weight:bold; }
+            CSS
+          end
+        end
+
+        app.before do
+          if self.class.opts[:bridgetown_site]
+            # The site had previously been initialized via the bridgetown_ssr plugin
+            Bridgetown::Current.sites[self.class.opts[:bridgetown_site].label] =
+              self.class.opts[:bridgetown_site]
+            @context ||= SiteContext.new({ site: self.class.opts[:bridgetown_site] })
+          end
+          Bridgetown::Current.preloaded_configuration ||=
+            self.class.opts[:bridgetown_preloaded_config]
+
+          request.root do
+            output_folder = Bridgetown::Current.preloaded_configuration.destination
+            File.read(File.join(output_folder, "index.html"))
+          rescue StandardError
+            response.status = 500
+            "<p>ERROR: cannot find <code>index.html</code> in the output folder.</p>"
+          end
+        end
+      end
+
+      Roda::RodaRequest.alias_method :_previous_roda_cookies, :cookies
+
+      module RequestMethods
+        # Monkeypatch Roda/Rack's Request object so it returns a hash which allows for
+        # indifferent access
+        def cookies
+          # TODO: maybe replace with a simpler hash that offers an overloaded `[]` method
+          _previous_roda_cookies.with_indifferent_access
+        end
+
+        # Starts up the Bridgetown routing system
+        def bridgetown
+          Bridgetown::Rack::Routes.start!(scope)
+        end
+      end
+    end
+
+    register_plugin :bridgetown_server, BridgetownServer
+  end
+end

data/lib/site_template/Gemfile.erb

@@ -24,10 +24,13 @@ gem "bridgetown", "~> <%= Bridgetown::VERSION %>"
 # Uncomment to add file-based dynamic routing to your project:
 # gem "bridgetown-routes", "~> <%= Bridgetown::VERSION %>"
 
+# Puma is the Rack-compatible web server used by Bridgetown
+# (you can optionally limit this to the "development" group)
+gem "puma", "< 7"
+
 # Uncomment to use the Inspectors API to manipulate the output
 # of your HTML or XML resources:
 # gem "nokogiri", "~> 1.13"
 
-# Puma is a Rack-compatible server used by Bridgetown
-# (you can optionally limit this to the "development" group)
-gem "puma", "~> 5.6"
+# Or for faster parsing of HTML-only resources via Inspectors, use Nokolexbor:
+# gem "nokolexbor", "~> 0.4"

data/lib/site_template/server/roda_app.rb

@@ -2,9 +2,11 @@
 # on the concept of a routing tree. Bridgetown uses it for its development
 # server, but you can also run it in production for fast, dynamic applications.
 #
-# Learn more at: http://roda.jeremyevans.net
+# Learn more at: https://www.bridgetownrb.com/docs/routes
+
+class RodaApp < Roda
+  plugin :bridgetown_server
 
-class RodaApp < Bridgetown::Rack::Roda
   # Some Roda configuration is handled in the `config/initializers.rb` file.
   # But you can also add additional Roda configuration here if needed.
 

data/lib/site_template/src/_posts/0000-00-00-welcome-to-bridgetown.md.erb

@@ -5,7 +5,7 @@ date:   <%= Time.now.strftime('%Y-%m-%d %H:%M:%S %z') %>
 categories: updates
 ---
 
-You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `bridgetown serve`, which launches a web server and auto-regenerates your site when a file is updated.
+You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `bin/bridgetown start`, which launches a web server and auto-regenerates your site when a file is updated.
 
 Bridgetown requires blog post files to be named according to the following format:
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-core
 version: !ruby/object:Gem::Version
-  version: 1.2.0.beta5
+  version: 1.3.0.beta1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -112,28 +112,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: hash_with_dot_access
   requirement: !ruby/object:Gem::Requirement
@@ -274,20 +274,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: terminal-table
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -316,20 +302,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: webrick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -382,8 +354,6 @@ files:
 - lib/bridgetown-core/commands/new.rb
 - lib/bridgetown-core/commands/plugins.rb
 - lib/bridgetown-core/commands/registrations.rb
-- lib/bridgetown-core/commands/serve.rb
-- lib/bridgetown-core/commands/serve/servlet.rb
 - lib/bridgetown-core/commands/start.rb
 - lib/bridgetown-core/commands/webpack.rb
 - lib/bridgetown-core/commands/webpack/enable-postcss.rb
@@ -501,7 +471,6 @@ files:
 - lib/bridgetown-core/plugin_manager.rb
 - lib/bridgetown-core/rack/boot.rb
 - lib/bridgetown-core/rack/logger.rb
-- lib/bridgetown-core/rack/roda.rb
 - lib/bridgetown-core/rack/routes.rb
 - lib/bridgetown-core/rack/static_indexes.rb
 - lib/bridgetown-core/reader.rb
@@ -543,7 +512,7 @@ files:
 - lib/bridgetown-core/version.rb
 - lib/bridgetown-core/watcher.rb
 - lib/bridgetown-core/yaml_parser.rb
-- lib/roda/plugins/bridgetown_boot.rb
+- lib/roda/plugins/bridgetown_server.rb
 - lib/roda/plugins/bridgetown_ssr.rb
 - lib/roda/plugins/initializers.rb
 - lib/roda/plugins/method_override.rb

data/lib/bridgetown-core/commands/serve/servlet.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require "webrick"
-
-module Bridgetown
-  module Commands
-    class Serve
-      class Servlet < WEBrick::HTTPServlet::FileHandler
-        DEFAULTS = {
-          "Cache-Control" => "private, max-age=0, proxy-revalidate, " \
-                             "no-store, no-cache, must-revalidate",
-        }.freeze
-
-        def initialize(server, root, callbacks)
-          # So we can access them easily.
-          @bridgetown_opts = server.config[:BridgetownOptions]
-          set_defaults
-          super
-        end
-
-        def search_index_file(req, res)
-          super ||
-            search_file(req, res, ".html") ||
-            search_file(req, res, ".xhtml")
-        end
-
-        # Add the ability to tap file.html the same way that Nginx does on our
-        # Docker images (or on GitHub Pages.) The difference is that we might end
-        # up with a different preference on which comes first.
-
-        def search_file(req, res, basename)
-          # /file.* > /file/index.html > /file.html
-          super ||
-            super(req, res, "#{basename}.html") ||
-            super(req, res, "#{basename}.xhtml")
-        end
-
-        # rubocop:disable Naming/MethodName
-        def do_GET(req, res)
-          rtn = super
-
-          validate_and_ensure_charset(req, res)
-          res.header.merge!(@headers)
-          rtn
-        end
-        # rubocop:enable Naming/MethodName
-
-        private
-
-        def validate_and_ensure_charset(_req, res)
-          key = res.header.keys.grep(%r!content-type!i).first
-          typ = res.header[key]
-
-          return if %r!;\s*charset=!.match?(typ)
-
-          res.header[key] = "#{typ}; charset=#{@bridgetown_opts["encoding"]}"
-        end
-
-        def set_defaults
-          hash_ = @bridgetown_opts.fetch("webrick", {}).fetch("headers", {})
-          DEFAULTS.each_with_object(@headers = hash_) do |(key, val), hash|
-            hash[key] = val unless hash.key?(key)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/bridgetown-core/commands/serve.rb

@@ -1,253 +0,0 @@
-# frozen_string_literal: true
-
-module Bridgetown
-  module Commands
-    class Serve < Thor::Group
-      extend BuildOptions
-      extend Summarizable
-      include ConfigurationOverridable
-
-      Registrations.register do
-        register(Serve, "serve", "serve", Serve.summary)
-      end
-
-      class_option :host, aliases: "-H", desc: "Host to bind to"
-      class_option :port, aliases: "-P", desc: "Port to listen on"
-      class_option :detach,
-                   aliases: "-B",
-                   type: :boolean,
-                   desc: "Run the server in the background"
-      class_option :ssl_cert, desc: "X.509 (SSL) certificate."
-      class_option :ssl_key, desc: "X.509 (SSL) Private Key."
-      class_option :show_dir_listing,
-                   type: :boolean,
-                   desc: "Show a directory listing instead of loading your index file."
-      class_option :skip_initial_build,
-                   type: :boolean,
-                   desc: "Skips the initial site build which occurs before the server is started."
-      class_option :watch,
-                   type: :boolean,
-                   aliases: "-w",
-                   default: true,
-                   desc: "Watch for changes and rebuild"
-
-      def self.banner
-        "bridgetown serve [options]"
-      end
-      summary "DEPRECATED (Serve your site locally using WEBrick)"
-
-      DIRECTORY_INDEX = %w(
-        index.htm
-        index.html
-        index.rhtml
-        index.xht
-        index.xhtml
-        index.cgi
-        index.xml
-        index.json
-      ).freeze
-
-      def serve
-        Bridgetown::Deprecator.deprecation_message(
-          "WEBrick (serve) will be removed in favor of Puma (start) in the next Bridgetown release"
-        )
-
-        @mutex = Mutex.new
-        @run_cond = ConditionVariable.new
-        @running = false
-
-        no_watch = options["watch"] == false
-
-        options = Thor::CoreExt::HashWithIndifferentAccess.new(self.options)
-        options["serving"] = true
-        options["watch"] = true unless no_watch
-
-        config = configuration_with_overrides(options, Bridgetown::Current.preloaded_configuration)
-        if Bridgetown.environment == "development"
-          default_url(config).tap do |url|
-            options["url"] = url
-            config.url = url
-          end
-        end
-
-        invoke(Build, [], options)
-        start_server
-      end
-
-      protected
-
-      def start_server
-        destination = Bridgetown::Current.preloaded_configuration.destination
-        setup(destination)
-
-        start_up_webrick(destination)
-      end
-
-      def setup(destination)
-        require_relative "serve/servlet"
-
-        FileUtils.mkdir_p(destination)
-        return unless File.exist?(File.join(destination, "404.html"))
-
-        WEBrick::HTTPResponse.class_eval do
-          def create_error_page
-            @header["Content-Type"] = "text/html; charset=UTF-8"
-            @body = File.read(File.join(@config[:DocumentRoot], "404.html"))
-          end
-        end
-      end
-
-      def webrick_opts(opts)
-        opts = {
-          BridgetownOptions: opts,
-          DoNotReverseLookup: true,
-          MimeTypes: mime_types,
-          DocumentRoot: opts["destination"],
-          StartCallback: start_callback(opts["detach"]),
-          StopCallback: stop_callback(opts["detach"]),
-          BindAddress: opts["host"],
-          Port: opts["port"],
-          DirectoryIndex: DIRECTORY_INDEX,
-        }
-
-        opts[:DirectoryIndex] = [] if opts[:BridgetownOptions]["show_dir_listing"]
-
-        enable_ssl(opts)
-        enable_logging(opts)
-        opts
-      end
-
-      def start_up_webrick(destination)
-        opts = Bridgetown::Current.preloaded_configuration
-        @server = WEBrick::HTTPServer.new(webrick_opts(opts)).tap { |o| o.unmount("") }
-        @server.mount(opts["base_path"].to_s, Servlet, destination, file_handler_opts)
-
-        Bridgetown.logger.info "Server address:", server_address(@server, opts)
-        launch_browser @server, opts if opts["open_url"]
-        boot_or_detach @server, opts
-      end
-
-      def shutdown
-        @server.shutdown if running?
-      end
-
-      def default_url(config)
-        format_url(
-          config["ssl_cert"] && config["ssl_key"],
-          config["host"] == "127.0.0.1" ? "localhost" : config["host"],
-          config["port"]
-        )
-      end
-
-      def format_url(ssl_enabled, address, port, baseurl = nil)
-        format("%<prefix>s://%<address>s:%<port>i%<baseurl>s",
-               prefix: ssl_enabled ? "https" : "http",
-               address: address,
-               port: port,
-               baseurl: baseurl ? "#{baseurl}/" : "")
-      end
-
-      # Recreate NondisclosureName under utf-8 circumstance
-      def file_handler_opts
-        WEBrick::Config::FileHandler.merge(
-          FancyIndexing: true,
-          NondisclosureName: [
-            ".ht*", "~*",
-          ]
-        )
-      end
-
-      def server_address(server, options = {})
-        format_url(
-          server.config[:SSLEnable],
-          server.config[:BindAddress],
-          server.config[:Port],
-          options["baseurl"]
-        )
-      end
-
-      # Keep in our area with a thread or detach the server as requested
-      # by the user.  This method determines what we do based on what you
-      # ask us to do.
-      def boot_or_detach(server, opts)
-        if opts["detach"]
-          pid = Process.fork do
-            server.start
-          end
-
-          Process.detach(pid)
-          Bridgetown.logger.info "Server detached with pid '#{pid}'.", \
-                                 "Run `pkill -f bridgetown' or `kill -9 #{pid}' " \
-                                 "to stop the server."
-        else
-          t = Thread.new { server.start }
-          trap("INT") { server.shutdown }
-          t.join
-        end
-      end
-
-      # Make the stack verbose if the user requests it.
-      def enable_logging(opts)
-        opts[:AccessLog] = []
-        level = WEBrick::Log.const_get(opts[:BridgetownOptions]["verbose"] ? :DEBUG : :WARN)
-        opts[:Logger] = WEBrick::Log.new($stdout, level)
-      end
-
-      # Add SSL to the stack if the user triggers --enable-ssl and they
-      # provide both types of certificates commonly needed.  Raise if they
-      # forget to add one of the certificates.
-      def enable_ssl(opts)
-        cert, key, src =
-          opts[:BridgetownOptions].values_at("ssl_cert", "ssl_key", "source")
-
-        return if cert.nil? && key.nil?
-        raise "Missing --ssl_cert or --ssl_key. Both are required." unless cert && key
-
-        require "openssl"
-        require "webrick/https"
-
-        opts[:SSLCertificate] = OpenSSL::X509::Certificate.new(read_file(src, cert))
-        begin
-          opts[:SSLPrivateKey] = OpenSSL::PKey::RSA.new(read_file(src, key))
-        rescue StandardError
-          raise unless defined?(OpenSSL::PKey::EC)
-
-          opts[:SSLPrivateKey] = OpenSSL::PKey::EC.new(read_file(src, key))
-        end
-        opts[:SSLEnable] = true
-      end
-
-      def start_callback(detached)
-        return if detached
-
-        proc do
-          @mutex.synchronize do
-            @running = true
-            Bridgetown.logger.info("Server running…", "press ctrl-c to stop.")
-            @run_cond.broadcast
-          end
-        end
-      end
-
-      def stop_callback(detached)
-        return if detached
-
-        proc do
-          @mutex.synchronize do
-            @running = false
-            @run_cond.broadcast
-          end
-        end
-      end
-
-      def mime_types
-        file = File.expand_path("../mime.types", __dir__)
-        WEBrick::HTTPUtils.load_mime_types(file)
-      end
-
-      def read_file(source_dir, file_path)
-        File.read(Bridgetown.sanitized_path(source_dir, file_path))
-      end
-    end
-  end
-end