bridgetown-core 2.0.0.beta2 → 2.0.0.beta4

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

@@ -77,12 +77,14 @@ module Bridgetown
         bt_bound_url = "http://#{bt_options.bind}:#{port}"
 
         # Set a local site URL in the config if one is not available
-        bt_options.url = bt_bound_url if Bridgetown.env.development? && !options["url"]
+        if Bridgetown.env.development? && !options["url"]
+          bt_options.url = bt_bound_url.sub("0.0.0.0", "localhost")
+        end
 
         Bridgetown::Server.new({
           Host: bt_options.bind,
           Port: port,
-          config: "config.ru",
+          config: rack_config_file,
         }).tap do |server|
           if server.serveable?
             pid_tracker.create_pid_dir
@@ -115,6 +117,14 @@ module Bridgetown
           end
         end
       end
+
+      protected
+
+      def rack_config_file
+        File.exist?("config.ru") ?
+          "config.ru" :
+          File.expand_path("../rack/default_config.ru", __dir__)
+      end
     end
   end
 end

data/lib/bridgetown-core/component.rb

@@ -94,7 +94,7 @@ module Bridgetown
 
       def path_for_errors
         File.basename(component_template_path)
-      rescue RuntimeError
+      rescue RuntimeError, TypeError
         source_location
       end
     end

data/lib/bridgetown-core/concerns/intuitive_expectations.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  # This is for including into Minitest::Expectation
+  module IntuitiveExpectations
+    def true?(msg = nil)
+      must_be(:itself, Minitest::Assertions::UNDEFINED, msg)
+      self
+    end
+
+    def false?(msg = nil)
+      wont_be(:itself, Minitest::Assertions::UNDEFINED, msg)
+      self
+    end
+
+    def ==(other)
+      must_equal(other)
+      self
+    end
+
+    def !=(other)
+      must_not_equal(other)
+      self
+    end
+
+    def nil?(msg = nil)
+      must_be_nil(msg)
+      self
+    end
+
+    def not_nil?(msg = nil)
+      wont_be_nil(msg)
+      self
+    end
+
+    def empty?(msg = nil)
+      must_be_empty(msg)
+      self
+    end
+
+    def filled?(msg = nil)
+      wont_be_empty(msg)
+      self
+    end
+
+    def include?(other, msg = nil)
+      must_include(other, msg)
+      self
+    end
+    alias_method :<<, :include?
+
+    def exclude?(other, msg = nil)
+      wont_include(other, msg)
+      self
+    end
+
+    def =~(other)
+      must_match(other)
+      self
+    end
+
+    def is_a?(klass, msg = nil)
+      must_be_instance_of(klass, msg)
+      self
+    end
+  end
+end

data/lib/bridgetown-core/concerns/layout_placeable.rb

@@ -4,7 +4,7 @@ module Bridgetown
   module LayoutPlaceable
     # Determine whether the file should be placed into layouts.
     #
-    # Returns false if the document is an asset file or if the front matter
+    # @return [Boolean] false if the document is an asset file or if the front matter
     #   specifies `layout: none`
     def place_in_layout?
       no_layout?.!

data/lib/bridgetown-core/concerns/publishable.rb

@@ -3,6 +3,8 @@
 module Bridgetown
   module Publishable
     # Whether the resource is published or not, as indicated in YAML front-matter
+    #
+    # @return [Boolean]
     def published?
       !(data.key?("published") && data["published"] == false)
     end

data/lib/bridgetown-core/concerns/site/content.rb

@@ -27,6 +27,7 @@ class Bridgetown::Site
     end
 
     # Returns the contents of the site metadata file or a blank hash
+    #
     # @return [HashWithDotAccess::Hash] Returns a hash of site metadata
     def metadata
       signals["site_metadata"] ||= HashWithDotAccess::Hash.new
@@ -49,7 +50,6 @@ class Bridgetown::Site
     #
     # @return [HashWithDotAccess::Hash{String, Symbol => Collection}] A Hash
     #   containing a collection name-to-instance pairs.
-    #
     # @return [HashWithDotAccess::Hash] Returns a blank hash if no items found
     def collections
       @collections ||= collection_names.each_with_object(
@@ -60,6 +60,7 @@ class Bridgetown::Site
     end
 
     # An array of collection names.
+    #
     # @return [Array<String>] an array of collection names from the configuration,
     #   or an empty array if the `config["collections"]` key is not set.
     def collection_names
@@ -84,6 +85,7 @@ class Bridgetown::Site
     end
 
     # Get all loaded resources.
+    #
     # @return [Array<Bridgetown::Resource::Base>] an array of resources
     def resources
       collections.each_with_object(Set.new) do |(_, collection), set|
@@ -112,6 +114,7 @@ class Bridgetown::Site
     end
 
     # Loads and memoizes the parsed frontend bundler manifest file (if available)
+    #
     # @return [Hash]
     def frontend_manifest
       @frontend_manifest ||= begin

data/lib/bridgetown-core/concerns/site/extensible.rb

@@ -4,6 +4,7 @@ class Bridgetown::Site
   module Extensible
     # Load necessary libraries, plugins, converters, and generators.
     # This is only ever run once for the lifecycle of the site object.
+    #
     # @see Converter
     # @see Generator
     # @see PluginManager
@@ -16,6 +17,7 @@ class Bridgetown::Site
     end
 
     # Run all Generators.
+    #
     # @see Generator
     # @return [void]
     def generate
@@ -34,6 +36,7 @@ class Bridgetown::Site
     end
 
     # Get the implementation for the given Converter class.
+    #
     # @param klass [Class] The Class of the Converter to fetch.
     # @return [Converter] Returns the {Converter}
     #   instance implementing the given `Converter` class.
@@ -46,7 +49,8 @@ class Bridgetown::Site
 
     # Create an array of instances of the subclasses of the class
     #   passed in as argument.
-    # @param klass [Class] - class which is the parent of the subclasses.
+    #
+    # @param klass [Class] class which is the parent of the subclasses.
     # @return [Array<Converter, Generator>] Returns an array of instances of
     #   subclasses of `klass`.
     def instantiate_subclasses(klass)
@@ -56,6 +60,7 @@ class Bridgetown::Site
     end
 
     # Shorthand for registering a site hook via {Bridgetown::Hooks}
+    #
     # @param event [Symbol] name of the event (`:pre_read`, `:post_render`, etc.)
     # @yield the block will be called when the event is triggered
     # @yieldparam site the site which triggered the event hook

data/lib/bridgetown-core/concerns/site/fast_refreshable.rb

@@ -10,15 +10,17 @@ class Bridgetown::Site
       @fast_refresh_ordering = 0
       full_abort = false
       found_gen_pages = false
-      paths.each do |path|
-        res = resources.find do |resource|
+      found_route_file = false
+      paths.each do |path| # rubocop:todo Metrics
+        found_res = resources.select do |resource|
           resource.id.start_with?("repo://") && in_source_dir(resource.relative_path) == path
         end
 
         layouts_to_reload = Set.new
-        locate_resource_layouts_and_partials_for_fash_refresh(path, layouts_to_reload) unless res
+        locate_resource_layouts_and_partials_for_fash_refresh(path, layouts_to_reload) unless
+          found_res.any?
 
-        locate_components_for_fast_refresh(path) unless res
+        locate_components_for_fast_refresh(path) unless found_res.any?
 
         pages = locate_layouts_and_pages_for_fast_refresh(path, layouts_to_reload)
 
@@ -27,26 +29,33 @@ class Bridgetown::Site
             self, layout.instance_variable_get(:@base), layout.name
           )
         end
-        liquid_renderer.reset unless layouts_to_reload.empty?
-        next unless res || !pages.empty?
 
-        unless pages.empty?
+        if config.key?(:routes) # carve out fast refresh track for the routes plugin
+          found_route_file = config.routes.source_paths.any? do |routes_dir|
+            path.start_with?(in_source_dir(routes_dir))
+          end
+        end
+        next unless found_res.any? || pages.any? || found_route_file
+
+        if pages.any?
           found_gen_pages = true
           mark_original_page_resources_for_fast_refresh(pages)
           next
         end
 
-        res.prepare_for_fast_refresh!.tap { full_abort = true unless _1 }
-        next unless res.collection.data?
+        found_res.each do |res|
+          res.prepare_for_fast_refresh!.tap { full_abort = true unless _1 }
+          next unless res.collection.data?
 
-        res.collection.merge_data_resources.each do |k, v|
-          data[k] = v
-          signals[k] = v
+          res.collection.merge_data_resources.each do |k, v|
+            data[k] = v
+            signals[k] = v
+          end
         end
       end
 
       marked_resources = resources.select(&:fast_refresh_order).sort_by(&:fast_refresh_order)
-      if full_abort || (marked_resources.empty? && !found_gen_pages)
+      if full_abort || (marked_resources.empty? && !found_gen_pages && !found_route_file)
         # Darn, a full reload is needed (unless we're on a super-fast track)
         if reload_if_needed
           Bridgetown::Hooks.trigger :site, :pre_reload, self, paths
@@ -60,12 +69,14 @@ class Bridgetown::Site
 
       Bridgetown::Hooks.trigger :site, :fast_refresh, self
 
-      transform_resources_for_fast_refresh(marked_resources, found_gen_pages)
-      transform_generated_pages_for_fast_refresh
-
-      FileUtils.touch(in_destination_dir("index.html"))
+      unless found_route_file
+        liquid_renderer.reset
+        transform_resources_for_fast_refresh(marked_resources, found_gen_pages)
+        transform_generated_pages_for_fast_refresh
+      end
 
       Bridgetown::Hooks.trigger :site, :post_write, self
+      Bridgetown.touch_live_reload_file
     end
 
     private
@@ -134,7 +145,11 @@ class Bridgetown::Site
     end
 
     def transform_resources_for_fast_refresh(marked_resources, found_gen_pages)
-      marked_resources.each { _1.transform!.write }
+      marked_resources.each do |res|
+        render_with_locale(res) do
+          res.transform!.write
+        end
+      end
       number_of_resources = marked_resources.length
       number_of_resources += 1 if found_gen_pages
       Bridgetown.logger.info(

data/lib/bridgetown-core/concerns/site/localizable.rb

@@ -3,6 +3,7 @@
 class Bridgetown::Site
   module Localizable
     # Returns the current and/or default configured locale
+    #
     # @return String
     def locale
       @locale ||= begin
@@ -16,6 +17,7 @@ class Bridgetown::Site
     end
 
     # Sets the current locale for the site
+    #
     # @param new_locale [String] for example: "en" for English, "es" for Spanish
     def locale=(new_locale)
       I18n.locale = @locale = new_locale.to_sym

data/lib/bridgetown-core/concerns/site/processable.rb

@@ -3,6 +3,7 @@
 class Bridgetown::Site
   module Processable
     # Reset, Read, Generate, Render, Cleanup, Process, and Write this Site to output.
+    #
     # @return [void]
     # @see #reset
     # @see #read
@@ -67,6 +68,7 @@ class Bridgetown::Site
     end
 
     # Read data from disk and load it into internal memory.
+    #
     # @return [void]
     def read
       Bridgetown::Hooks.trigger :site, :pre_read, self

data/lib/bridgetown-core/concerns/site/renderable.rb

@@ -3,6 +3,7 @@
 class Bridgetown::Site
   module Renderable
     # Render all pages & documents so they're ready to be written out to disk.
+    #
     # @return [void]
     # @see Page
     # @see Document
@@ -97,6 +98,7 @@ class Bridgetown::Site
     end
 
     # Renders all resources
+    #
     # @return [void]
     def render_resources
       collections.each_value do |collection|
@@ -109,6 +111,7 @@ class Bridgetown::Site
     end
 
     # Renders a content item while ensuring site locale is set if the data is available.
+    #
     # @param item [Bridgetown::Resource::Base] The item to render
     # @yield Runs the block in between locale setting and resetting
     # @return [void]

data/lib/bridgetown-core/concerns/site/ssr.rb

@@ -28,7 +28,7 @@ class Bridgetown::Site
 
     def enable_ssr
       Bridgetown.logger.info "SSR:", "enabled."
-      config.fast_refresh = false # SSR mode and Fast Refresh mode are mututally exclusive
+      config.fast_refresh = false # SSR mode and Fast Refresh mode are mutually exclusive
       @ssr_enabled = true
     end
 
@@ -45,7 +45,6 @@ class Bridgetown::Site
     end
 
     def ssr_first_read
-      # TODO: this shouldn't be running twice, right?!
       Bridgetown::Hooks.trigger :site, :pre_read, self
       defaults_reader.tap do |d|
         d.path_defaults.clear

data/lib/bridgetown-core/concerns/site/writable.rb

@@ -17,6 +17,7 @@ class Bridgetown::Site
       write_redirecting_index if config.prefix_default_locale
 
       Bridgetown::Hooks.trigger :site, :post_write, self
+      Bridgetown.touch_live_reload_file unless config.disable_disk_cache
     end
 
     # Yields all content objects while looping through {#generated_pages},

data/lib/bridgetown-core/concerns/viewable.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  # This mixin for Bridgetown components allows you to provide front matter and render
+  # the component template via the layouts transformation pipeline, which can be called
+  # from any Roda route
+  module Viewable
+    include Bridgetown::RodaCallable
+    include Bridgetown::Transformable
+
+    def site
+      @site ||= Bridgetown::Current.site
+    end
+
+    def data
+      @data ||= HashWithDotAccess::Hash.new
+    end
+
+    def front_matter(&block)
+      Bridgetown::FrontMatter::RubyFrontMatter.new(data:).tap { _1.instance_exec(&block) }
+    end
+
+    def relative_path = self.class.source_location.delete_prefix("#{site.root_dir}/")
+
+    # Render the component template in the layout specified in your front matter
+    #
+    # @param app [Roda]
+    def render_in_layout(app)
+      render_in(app) => rendered_output
+
+      site.validated_layouts_for(self, data.layout).each do |layout|
+        transform_with_layout(layout, rendered_output, self) => rendered_output
+      end
+
+      rendered_output
+    end
+
+    # Pass a block of front matter and render the component template in layouts
+    #
+    # @param app [Roda]
+    def render_with(app, &)
+      front_matter(&)
+      render_in_layout(app)
+    end
+  end
+end

data/lib/bridgetown-core/configuration.rb

@@ -111,26 +111,28 @@ module Bridgetown
     attr_writer :source_manifests, :roda_initializers
 
     class << self
-      # Static: Produce a Configuration ready for use in a Site.
+      # Produce a Configuration ready for use in a Site.
       # It takes the input, fills in the defaults where values do not exist.
       #
-      # user_config - a Hash or Configuration of overrides.
-      #
-      # Returns a Configuration filled with defaults.
+      # @param user_config [Hash, Configuration]
+      # @return [Configuration] filled with defaults
       def from(user_config, starting_defaults = DEFAULTS)
         Utils.deep_merge_hashes(starting_defaults.deep_dup, Configuration.new(user_config))
           .merge_environment_specific_options!
           .setup_load_paths!
           .setup_locales
           .add_default_collections
-          .add_default_excludes
+          .add_destination_paths
           .check_include_exclude
       end
     end
 
     def run_initializers!(context:) # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity
       initializers_file = File.join(root_dir, "config", "initializers.rb")
-      return unless File.file?(initializers_file)
+      unless File.file?(initializers_file)
+        setup_load_paths! appending: true
+        return
+      end
 
       load initializers_file
 
@@ -149,11 +151,15 @@ module Bridgetown
       dsl._run_builtins!
       self.url = cached_url if cached_url # restore local development URL if need be
 
-      setup_load_paths! appending: true
+      setup_post_init!
 
       self
     end
 
+    def setup_post_init!
+      add_destination_paths.setup_load_paths! appending: true
+    end
+
     # @return [Set<SourceManifest>]
     def source_manifests
       @source_manifests ||= Set.new
@@ -177,16 +183,14 @@ module Bridgetown
     # Directory of the top-level root where config files are located
     #
     # @param override [Hash] options hash which will override value if key is present
-    #
     # @return [String] path to the Bridgetown root directory
     def root_dir(override = {})
       get_config_value_with_override("root_dir", override)
     end
 
-    # Public: Directory of the Bridgetown source folder
+    # Directory of the Bridgetown source folder
     #
     # @param override [Hash] options hash which will override value if key is present
-    #
     # @return [String]  path to the Bridgetown source directory
     def source(override = {})
       get_config_value_with_override("source", override)
@@ -208,11 +212,10 @@ module Bridgetown
       raise "Unable to parse `#{File.basename(filename)}'. #{e.message}"
     end
 
-    # Public: Generate list of configuration files from the override
-    #
-    # override - the command-line options hash
+    # Generate list of configuration files from the override
     #
-    # Returns an Array of config files
+    # @param override [Hash] the command-line options hash
+    # @return [Array<string>] config files
     def config_files(override)
       # Adjust verbosity quickly
       Bridgetown.logger.adjust_verbosity(
@@ -232,9 +235,8 @@ module Bridgetown
     # Read in a list of configuration files and merge with this hash
     #
     # @param files [Array<String>]
-    #
     # @return [Hash] configuration with the defaults overridden by the values in the
-    # configuration files
+    #   configuration files
     def read_config_files(files)
       config = self
 
@@ -257,7 +259,6 @@ module Bridgetown
     # Read configuration and return merged Hash
     #
     # @param file [String] the path to the YAML file to be read in
-    #
     # @return [Hash]
     def read_config_file(file)
       default_config_file = file == "bridgetown.config.yml"
@@ -289,13 +290,13 @@ module Bridgetown
     end
 
     def setup_load_paths!(appending: false) # rubocop:todo Metrics
-      unless appending
-        self[:root_dir] = File.expand_path(self[:root_dir])
-        self[:source] = File.expand_path(self[:source], self[:root_dir])
-        self[:destination] = File.expand_path(self[:destination], self[:root_dir])
+      self[:root_dir] = File.expand_path(self[:root_dir])
+      self[:source] = File.expand_path(self[:source], self[:root_dir])
+      self[:destination] = File.expand_path(self[:destination], self[:root_dir])
 
+      unless appending
         autoload_paths.unshift({
-          path: self[:plugins_dir],
+          path: File.expand_path(self[:plugins_dir], self[:root_dir]),
           eager: true,
         })
         autoload_paths.unshift({
@@ -363,13 +364,18 @@ module Bridgetown
       vendor/bundle/ vendor/cache/ vendor/gems/ vendor/ruby/
     ).freeze
 
-    def add_default_excludes
+    def add_destination_paths
+      self["keep_files"] << "_bridgetown" unless
+        self["keep_files"].nil?.! && self["keep_files"].include?("_bridgetown")
+
       return self if self["exclude"].nil?
 
       self["exclude"].concat(DEFAULT_EXCLUDES).uniq!
       self
     end
 
+    alias_method :add_default_excludes, :add_destination_paths
+
     def should_execute_inline_ruby?
       ENV["BRIDGETOWN_RUBY_IN_FRONT_MATTER"] != "false" &&
         self["ruby_in_front_matter"]

data/lib/bridgetown-core/configurations/gh-pages/gh-pages.yml

@@ -9,7 +9,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
@@ -17,9 +17,9 @@ jobs:
           bundler-cache: true
 
       - name: Setup Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
-          node-version: "20"
+          node-version: "22"
           cache: "npm"
       - run: npm install
 
@@ -29,7 +29,7 @@ jobs:
         run: bin/bridgetown deploy
 
       - name: Upload build artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: ./output
 
@@ -48,4 +48,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4