bridgetown-core 1.3.4 → 2.0.0.beta1

data/lib/bridgetown-core.rb

@@ -9,7 +9,7 @@ $LOAD_PATH.unshift __dir__ # For use/testing when no gem is installed
 # Returns nothing.
 def require_all(path)
   glob = File.join(__dir__, path, "*.rb")
-  Dir[glob].sort.each do |f|
+  Dir[glob].each do |f|
     require f
   end
 end
@@ -31,35 +31,29 @@ require "csv"
 require "json"
 require "yaml"
 
+# Pull in Foundation gem
+require "bridgetown-foundation"
+
 # 3rd party
-require "active_support"
-require "active_support/core_ext/class/attribute"
-require "active_support/core_ext/hash/keys"
-require "active_support/core_ext/module/delegation"
+require "active_support" # TODO: remove by the end of 2024
 require "active_support/core_ext/object/blank"
-require "active_support/core_ext/object/deep_dup"
-require "active_support/core_ext/object/inclusion"
 require "active_support/core_ext/string/inflections"
-require "active_support/core_ext/string/inquiry"
 require "active_support/core_ext/string/output_safety"
-require "active_support/core_ext/string/starts_ends_with"
-require "active_support/current_attributes"
-require "active_support/descendants_tracker"
-require "hash_with_dot_access"
 require "addressable/uri"
 require "liquid"
 require "listen"
 require "kramdown"
-require "colorator"
 require "i18n"
 require "i18n/backend/fallbacks"
 require "faraday"
+require "signalize"
 require "thor"
-require "zeitwerk"
 
 # Ensure we can set up fallbacks so the default locale gets used
 I18n::Backend::Simple.include I18n::Backend::Fallbacks
 
+# Monkey patches:
+
 module HashWithDotAccess
   class Hash # :nodoc:
     def to_liquid
@@ -72,6 +66,8 @@ end
 class Rb < String; end
 
 module Bridgetown
+  using Bridgetown::Refinements
+
   autoload :Cache,               "bridgetown-core/cache"
   autoload :Current,             "bridgetown-core/current"
   autoload :Cleaner,             "bridgetown-core/cleaner"
@@ -82,14 +78,13 @@ module Bridgetown
   autoload :EntryFilter,         "bridgetown-core/entry_filter"
   # TODO: we have too many errors! This is silly
   autoload :Errors,              "bridgetown-core/errors"
-  autoload :FrontmatterDefaults, "bridgetown-core/frontmatter_defaults"
-  autoload :FrontMatterImporter, "bridgetown-core/concerns/front_matter_importer"
+  autoload :FrontMatter,         "bridgetown-core/front_matter"
   autoload :GeneratedPage,       "bridgetown-core/generated_page"
   autoload :Hooks,               "bridgetown-core/hooks"
+  autoload :Inflector,           "bridgetown-core/inflector"
   autoload :Layout,              "bridgetown-core/layout"
   autoload :LayoutPlaceable,     "bridgetown-core/concerns/layout_placeable"
   autoload :LayoutReader,        "bridgetown-core/readers/layout_reader"
-  autoload :LiquidRenderable,    "bridgetown-core/concerns/liquid_renderable"
   autoload :Localizable,         "bridgetown-core/concerns/localizable"
   autoload :LiquidRenderer,      "bridgetown-core/liquid_renderer"
   autoload :LogAdapter,          "bridgetown-core/log_adapter"
@@ -100,11 +95,11 @@ module Bridgetown
   autoload :Reader,              "bridgetown-core/reader"
   autoload :RubyTemplateView,    "bridgetown-core/ruby_template_view"
   autoload :LogWriter,           "bridgetown-core/log_writer"
+  autoload :Signals,             "bridgetown-core/signals"
   autoload :Site,                "bridgetown-core/site"
   autoload :Slot,                "bridgetown-core/slot"
   autoload :StaticFile,          "bridgetown-core/static_file"
   autoload :Transformable,       "bridgetown-core/concerns/transformable"
-  autoload :URL,                 "bridgetown-core/url"
   autoload :Utils,               "bridgetown-core/utils"
   autoload :VERSION,             "bridgetown-core/version"
   autoload :Watcher,             "bridgetown-core/watcher"
@@ -126,13 +121,12 @@ module Bridgetown
   require_all "bridgetown-core/drops"
   require_all "bridgetown-core/generators"
   require_all "bridgetown-core/tags"
-  require_all "bridgetown-core/core_ext"
 
   class << self
     # Tells you which Bridgetown environment you are building in so
     #   you can skip tasks if you need to.
     def environment
-      (ENV["BRIDGETOWN_ENV"] || "development").inquiry
+      (ENV["BRIDGETOWN_ENV"] || "development").questionable
     end
     alias_method :env, :environment
 
@@ -246,21 +240,21 @@ module Bridgetown
       Bridgetown::Current.preloaded_configuration.initializers[name.to_sym] =
         Bridgetown::Configuration::Initializer.new(
           name: name.to_sym,
-          block: block,
+          block:,
           completed: false
         )
     end
 
     # @yieldself [Bridgetown::Configuration::ConfigurationDSL]
-    def configure(&block)
-      initializer :init, &block
+    def configure(&)
+      initializer(:init, &)
     end
 
     # Convenience method to register a new Thor command
     #
     # @see Bridgetown::Commands::Registrations.register
-    def register_command(&block)
-      Bridgetown::Commands::Registrations.register(&block)
+    def register_command(&)
+      Bridgetown::Commands::Registrations.register(&)
     end
 
     def load_tasks
@@ -268,7 +262,7 @@ module Bridgetown
       unless Bridgetown::Current.preloaded_configuration
         Bridgetown::Current.preloaded_configuration = Bridgetown::Configuration::Preflight.new
       end
-      Bridgetown::PluginManager.setup_bundler(skip_yarn: true)
+      Bridgetown::PluginManager.setup_bundler
 
       if Bridgetown::Current.preloaded_configuration.is_a?(Bridgetown::Configuration::Preflight)
         Bridgetown::Current.preloaded_configuration = Bridgetown.configuration
@@ -293,11 +287,11 @@ module Bridgetown
     # the block on to it.
     #
     # @return [void]
-    def with_unbundled_env(&block)
+    def with_unbundled_env(&)
       if Bundler.bundler_major_version >= 2
-        Bundler.method(:with_unbundled_env).call(&block)
+        Bundler.method(:with_unbundled_env).call(&)
       else
-        Bundler.method(:with_clean_env).call(&block)
+        Bundler.method(:with_clean_env).call(&)
       end
     end
 
@@ -337,17 +331,6 @@ module Bridgetown
       @logger = LogAdapter.new(writer, (ENV["BRIDGETOWN_LOG_LEVEL"] || :info).to_sym)
     end
 
-    # Deprecated. Now using the Current site.
-    #
-    # @return [Array<Bridgetown::Site>] the Bridgetown sites created.
-    def sites
-      Deprecator.deprecation_message(
-        "Bridgetown.sites will be removed in the next version. Use Bridgetown::Current.sites" \
-        "instead"
-      )
-      [Bridgetown::Current.site].compact
-    end
-
     # Ensures the questionable path is prefixed with the base directory
     #   and prepends the questionable path with the base directory if false.
     #
@@ -390,9 +373,7 @@ module Bridgetown
       )
     end
   end
-end
 
-module Bridgetown
   module Model; end
 
   module Resource
@@ -405,13 +386,18 @@ module Bridgetown
       end
     end
   end
-end
 
-# This method is available in Ruby 3, monkey patching for older versions
-Psych.extend Bridgetown::CoreExt::Psych::SafeLoadFile unless Psych.respond_to?(:safe_load_file)
+  # mixin for identity so Roda knows to call renderable objects
+  module RodaCallable
+    def self.===(other)
+      other.class < self
+    end
+  end
+end
 
-loader = Zeitwerk::Loader.new
-loader.push_dir File.join(__dir__, "bridgetown-core/model"), namespace: Bridgetown::Model
-loader.push_dir File.join(__dir__, "bridgetown-core/resource"), namespace: Bridgetown::Resource
-loader.setup # ready!
+Zeitwerk.with_loader do |l|
+  l.push_dir File.join(__dir__, "bridgetown-core/model"), namespace: Bridgetown::Model
+  l.push_dir File.join(__dir__, "bridgetown-core/resource"), namespace: Bridgetown::Resource
+  l.setup # ready!
+end
 Bridgetown::Model::Origin # this needs to load first

data/lib/roda/plugins/bridgetown_server.rb

@@ -11,6 +11,7 @@ class Roda
                 "plugin"
         end
 
+        app.extend ClassMethods # we need to do this here because Roda hasn't done it yet
         app.plugin :initializers
         app.plugin :method_override
         app.plugin :all_verbs
@@ -19,9 +20,8 @@ class Roda
         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 :cookies, path: "/"
+        app.plugin :ssg, 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"))
@@ -41,6 +41,7 @@ class Roda
           "500 Internal Server Error"
         end
 
+        # TODO: there may be a better way to do this, see `exception_page_css` instance method
         ExceptionPage.class_eval do # rubocop:disable Metrics/BlockLength
           def self.css
             <<~CSS
@@ -97,8 +98,16 @@ class Roda
             CSS
           end
         end
+      end
+
+      module ClassMethods
+        def root_hook(&block)
+          opts[:root_hook] = block
+        end
+      end
 
-        app.before do
+      module InstanceMethods
+        def initialize_bridgetown_context
           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] =
@@ -107,30 +116,63 @@ class Roda
           end
           Bridgetown::Current.preloaded_configuration ||=
             self.class.opts[:bridgetown_preloaded_config]
+        end
 
+        def initialize_bridgetown_root # rubocop:todo Metrics/AbcSize
           request.root do
-            output_folder = Bridgetown::Current.preloaded_configuration.destination
-            File.read(File.join(output_folder, "index.html"))
-          rescue StandardError
+            hook_result = instance_exec(&self.class.opts[:root_hook]) if self.class.opts[:root_hook]
+            next hook_result if hook_result
+
+            status, headers, body = self.class.opts[:ssg_server].serving(
+              request, File.join(self.class.opts[:ssg_root], "index.html")
+            )
+            response_headers = response.headers
+            response_headers.replace(headers)
+
+            request.halt [status, response_headers, body]
+          rescue StandardError => e
+            Bridgetown.logger.debug("Root handler error: #{e.message}")
             response.status = 500
             "<p>ERROR: cannot find <code>index.html</code> in the output folder.</p>"
           end
         end
+
+        # This is useful if you're passing the Roda app instance around and want to
+        # get at `request` / `response` easily as local variables
+        def deconstruct_keys(*)
+          { request:, response: }
+        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
+        # symbol or dot access
         def cookies
-          # TODO: maybe replace with a simpler hash that offers an overloaded `[]` method
-          _previous_roda_cookies.with_indifferent_access
+          HashWithDotAccess::Hash.new(_previous_roda_cookies)
         end
 
-        # Starts up the Bridgetown routing system
+        # Start up the Bridgetown routing system
         def bridgetown
-          Bridgetown::Rack::Routes.start!(scope)
+          scope.initialize_bridgetown_context
+          scope.initialize_bridgetown_root
+
+          # Run the static file server
+          ssg
+
+          # There are two different code paths depending on if there's a site `base_path` configured
+          if Bridgetown::Current.preloaded_configuration.base_path == "/"
+            Bridgetown::Rack::Routes.load_all scope
+            return
+          end
+
+          # Support custom base_path configurations
+          on(Bridgetown::Current.preloaded_configuration.base_path.delete_prefix("/")) do
+            Bridgetown::Rack::Routes.load_all scope
+          end
+
+          nil
         end
       end
     end

data/lib/roda/plugins/bridgetown_ssr.rb

@@ -9,12 +9,23 @@ class Roda
         def bridgetown_site
           self.class.opts[:bridgetown_site]
         end
+
+        alias_method :site, :bridgetown_site
+      end
+
+      def self.load_dependencies(app)
+        app.plugin :custom_block_results
+
+        # This lets us return callable objects directly in Roda response blocks
+        app.handle_block_result(Bridgetown::RodaCallable) do |callable|
+          callable.(self)
+        end
       end
 
-      def self.configure(app, _opts = {}, &block)
+      def self.configure(app, _opts = {}, &)
         app.include Bridgetown::Filters::URLFilters
         app.opts[:bridgetown_site] =
-          Bridgetown::Site.start_ssr!(loaders_manager: Bridgetown::Rack.loaders_manager, &block)
+          Bridgetown::Site.start_ssr!(loaders_manager: Bridgetown::Rack.loaders_manager, &)
       end
     end
 

data/lib/roda/plugins/ssg.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "uri"
+require "rack/files"
+
+class Roda
+  module RodaPlugins
+    # This is a simplifed and modified variant of Roda's Public core plugin. It adds additional
+    # functionality so that you can host an entire static site through Roda. What's necessary for
+    # this to work is handling "pretty" URLs, aka:
+    #
+    # /path/to/page -> /path/to/page.html or /path/to/page/index.html
+    # /path/to/page/ -> /path/to/page/index.html
+    #
+    # It does not support serving compressed files, as that should ideally be handled through a
+    # proxy or CDN layer in your architecture.
+    module SSG
+      PARSER = URI::DEFAULT_PARSER
+
+      def self.configure(app, opts = {})
+        app.opts[:ssg_root] = app.expand_path(opts.fetch(:root, "public"))
+        app.opts[:ssg_server] = Rack::Files.new(app.opts[:ssg_root])
+      end
+
+      module RequestMethods
+        def ssg
+          return unless is_get?
+
+          path = PARSER.unescape(real_remaining_path)
+          return if path.include?("\0")
+
+          server = roda_class.opts[:ssg_server]
+          path = File.join(server.root, *segments_for_path(path))
+
+          return unless File.file?(path)
+
+          status, headers, body = server.serving(self, path)
+          response_headers = response.headers
+          response_headers.replace(headers)
+          halt [status, response_headers, body]
+        end
+
+        # TODO: this could be refactored a bit
+        def segments_for_path(path) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          segments = []
+
+          path.split("/").each do |seg|
+            next if seg.empty? || seg == "."
+
+            seg == ".." ? segments.pop : segments << seg
+          end
+
+          path = File.join(roda_class.opts[:ssg_root], *segments)
+          unless File.file?(path)
+            path = File.join(path, "index.html")
+            if File.file?(path)
+              segments << "index.html"
+            else
+              segments[segments.size - 1] = "#{segments.last}.html"
+            end
+          end
+
+          segments
+        rescue IndexError
+          nil
+        end
+      end
+    end
+
+    register_plugin :ssg, SSG
+  end
+end

data/lib/site_template/.gitignore

@@ -2,13 +2,10 @@
 output
 .bridgetown-cache
 .bridgetown-metadata
-.bridgetown-webpack
 .routes.json
 
 # Dependency folders
 node_modules
-bower_components
-vendor
 
 # Caches
 .sass-cache
@@ -34,3 +31,12 @@ yarn-debug.log*
 .pnp.js
 # Yarn Integrity file
 .yarn-integrity
+
+# Ignore all tempfiles.
+/tmp/*
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep

data/lib/site_template/Gemfile.erb

@@ -6,9 +6,9 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 #
 # To install a plugin, run:
 #
-#   bundle add new-plugin-name -g bridgetown_plugins
+#   bundle add new-plugin-name
 #
-# This will ensure the plugin is added to the correct Bundler group.
+# and add a relevant init comment to your config/initializers.rb file.
 #
 # When you run Bridgetown commands, we recommend using a binstub like so:
 #
@@ -33,4 +33,4 @@ gem "puma", "< 7"
 # gem "nokogiri", "~> 1.13"
 
 # Or for faster parsing of HTML-only resources via Inspectors, use Nokolexbor:
-# gem "nokolexbor", "~> 0.4"
+# gem "nokolexbor", "~> 0.5"

data/lib/site_template/README.md

@@ -16,18 +16,17 @@ Welcome to your new Bridgetown website! You can update this README file to provi
 - [GCC](https://gcc.gnu.org/install/)
 - [Make](https://www.gnu.org/software/make/)
 - [Ruby](https://www.ruby-lang.org/en/downloads/)
-  - `>= 2.7`
+  - `>= 3.1`
 - [Bridgetown Gem](https://rubygems.org/gems/bridgetown)
   - `gem install bridgetown -N`
 - [Node](https://nodejs.org)
-  - `>= 12`
-- [Yarn](https://yarnpkg.com)
+  - `>= 20`
 
 ## Install
 
 ```sh
 cd bridgetown-site-folder
-bundle install && yarn install
+bundle install && npm install
 ```
 > Learn more: [Bridgetown Getting Started Documentation](https://www.bridgetownrb.com/docs/).
 

data/lib/site_template/Rakefile.erb

@@ -28,25 +28,12 @@ end
 namespace :frontend do
   desc "Build the frontend with esbuild for deployment"
   task :build do
-    sh "yarn run esbuild"
+    sh "npm run esbuild"
   end
 
   desc "Watch the frontend with esbuild during development"
   task :dev do
-    sh "yarn run esbuild-dev"
-  rescue Interrupt
-  end
-end
-<%- else -%>
-namespace :frontend do
-  desc "Build the frontend with Webpack for deployment"
-  task :build do
-    sh "yarn run webpack-build"
-  end
-
-  desc "Watch the frontend with Webpack during development"
-  task :dev do
-    sh "yarn run webpack-dev --color"
+    sh "npm run esbuild-dev"
   rescue Interrupt
   end
 end

data/lib/site_template/TEMPLATES/erb/_partials/_head.erb

@@ -5,6 +5,6 @@
 
 <meta name="description" content="<%= metadata.description %>" />
 
-<link rel="stylesheet" href="<%= webpack_path :css %>" />
-<script src="<%= webpack_path :js %>" defer></script>
+<link rel="stylesheet" href="<%= asset_path :css %>" />
+<script src="<%= asset_path :js %>" defer></script>
 <%= live_reload_dev_js %>

data/lib/site_template/TEMPLATES/serbea/_partials/_head.serb

@@ -5,6 +5,6 @@
 
 <meta name="description" content="{%= metadata.description %}" />
 
-<link rel="stylesheet" href="{%= webpack_path :css %}" />
-<script src="{%= webpack_path :js %}" defer></script>
+<link rel="stylesheet" href="{%= asset_path :css %}" />
+<script src="{%= asset_path :js %}" defer></script>
 {%= live_reload_dev_js %}

data/lib/site_template/config/initializers.rb

@@ -1,34 +1,61 @@
+# Welcome to Bridgetown!
+#
+# This configuration file is for settings which affect your whole site.
+#
+# For more documentation on using this initializers file, visit:
+# https://www.bridgetownrb.com/docs/configuration/initializers/
+#
+# A list of all available configuration options can be found here:
+# https://www.bridgetownrb.com/docs/configuration/options
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# `bin/bridgetown start`. If you change this file, please restart the server process.
+#
+# For reloadable site metadata like title, SEO description, social media
+# handles, etc., take a look at `src/_data/site_metadata.yml`
+
 Bridgetown.configure do |config|
-  # You can configure aspects of your Bridgetown site here instead of using
-  # `bridgetown.config.yml`. For example:
+  # The base hostname & protocol for your site, e.g. https://example.com
+  url ""
+
+  # Available options are `erb` (default), `serbea`, or `liquid`
+  template_engine "erb"
+
+  # Other options you might want to investigate:
+
+  # See list of timezone values here:
+  # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
   #
-  # permalink "simple"
   # timezone "America/Los_Angeles"
+
+  # Add collection pagination features to your site. Documentation here:
+  # https://www.bridgetownrb.com/docs/content/pagination
   #
-  # You can also modify options on the configuration object directly, like so:
-  #
-  # config.autoload_paths << "models"
+  # pagination do
+  #   enabled true
+  # end
+
+  # Configure the permalink style for pages and posts. Custom collections can be
+  # configured separately under the `collections` key. Documentation here:
+  # https://www.bridgetownrb.com/docs/content/permalinks
   #
+  # permalink "simple"
 
-  # You can configure the inflector used by Zeitwerk. In v2.0,
-  # ActiveSupport::Inflector will become the default.
+  # Optionally host your site off a path, e.g. /blog. If you set this option,
+  # ensure you use the `relative_url` helper for all links and assets in your HTML.
+  # If you're using esbuild for frontend assets, edit `esbuild.config.js` to
+  # update `publicPath`.
   #
-  # config.inflector = ActiveSupport::Inflector
+  # base_path "/"
+
+  # You can also modify options on this configuration object directly, like so:
   #
-  # Add new inflection rules using the following format. Inflections
-  # are locale specific, and you may define rules for as many different
-  # locales as you wish. All of these examples are active by default:
-  # ActiveSupport::Inflector.inflections(:en) do |inflect|
-  #   inflect.plural /^(ox)$/i, "\\1en"
-  #   inflect.singular /^(ox)en/i, "\\1"
-  #   inflect.irregular "person", "people"
-  #   inflect.uncountable %w( fish sheep )
-  # end
+  # config.autoload_paths << "models"
+
+  # If you find you're having trouble using the new Fast Refresh feature in development,
+  # you can disable it to force full rebuilds instead:
   #
-  # These inflection rules are supported but not enabled by default:
-  # ActiveSupport::Inflector.inflections(:en) do |inflect|
-  #   inflect.acronym "RESTful"
-  # end
+  # fast_refresh false
 
   # You can use `init` to initialize various Bridgetown features or plugin gems.
   # For example, you can use the Dotenv gem to load environment variables from
@@ -58,6 +85,17 @@ Bridgetown.configure do |config|
   # end
   #
 
+  # You can configure the inflector used by Zeitwerk and models. A few acronyms are provided
+  # by default like HTML, CSS, and JS, so a file like `html_processor.rb` could be defined by
+  # `HTMLProcessor`. You can add more like so:
+  #
+  # config.inflector.configure do |inflections|
+  #   inflections.acronym "W3C"
+  # end
+  #
+  # Bridgetown's inflector is based on Dry::Inflector so you can read up on how to add inflection
+  # rules here: https://dry-rb.org/gems/dry-inflector/1.0/#custom-inflection-rules
+
   # For more documentation on how to configure your site using this initializers file,
   # visit: https://edge.bridgetownrb.com/docs/configuration/initializers/
 end

data/lib/site_template/config/puma.rb

@@ -19,6 +19,8 @@ max_threads_count = ENV.fetch("BRIDGETOWN_MAX_THREADS") { 5 }
 min_threads_count = ENV.fetch("BRIDGETOWN_MIN_THREADS") { max_threads_count }
 threads min_threads_count, max_threads_count
 
+pidfile ENV["PIDFILE"] || "tmp/pids/server.pid"
+
 # Preload the application for maximum performance
 #
 preload_app!