bridgetown-core 2.0.0.beta3 → 2.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f521946dedcb0f22d30ef1ca8be0aa3c2f1eb967dfc629f0da7c1640ddfba1e
-  data.tar.gz: 2f6479875ecc1f3271d20e4b1626c8bff8e305f8e5cb82fa49d6676b786b4495
+  metadata.gz: 640ad580e7362c34e924047d18d5aabc84ce83790f1ae6f31e69c5e486ac31a7
+  data.tar.gz: b0a955781229fdc4f87ca6f89cfc53990a821aac27d8d470cacf46a143db5ca7
 SHA512:
-  metadata.gz: 4036965b0db3c36e648dd4e80cd2656d4aeb03619a37530e6145bf84dbcd6f46eda5ccbaa051f3c605922b72618a4ebdd2de6e2d14962f441afad0ed6bb40a8d
-  data.tar.gz: 86b1e921da1dbaf594760f5269d47517ff54498bba74ff721f82d0963308f694a0452715a5b875da963fc29e9074a4221b84e4887aaa36dd6847491d9df0e501
+  metadata.gz: 49d47097b2dff1226b8ddf0b61191559a26d18745e5d15fafd0c51bd07eec35d406b370b0b16112df0bb3f9518660b8fa36d47cd0d707a534f34b0d195482b8c
+  data.tar.gz: 96f4cf0298dfb193494387ea3e6c7136613724bb70f58700a2df0b08c34e25dd1bff9f91428b8133869b4fe2b675a88026ea367584937f9b752d7d8be644b07c

data/bridgetown-core.gemspec

@@ -2,58 +2,59 @@
 
 require_relative "../bridgetown-foundation/lib/bridgetown/version"
 
-Gem::Specification.new do |s|
-  s.name          = "bridgetown-core"
-  s.version       = Bridgetown::VERSION
-  s.license       = "MIT"
-  s.author        = "Bridgetown Team"
-  s.email         = "maintainers@bridgetownrb.com"
-  s.homepage      = "https://www.bridgetownrb.com"
-  s.summary       = "A next-generation, progressive site generator & fullstack framework, powered by Ruby"
-  s.description   = "Bridgetown is a next-generation, progressive site generator & fullstack framework, powered by Ruby"
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-core"
+  spec.version       = Bridgetown::VERSION
+  spec.license       = "MIT"
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.homepage      = "https://www.bridgetownrb.com"
+  spec.summary       = "A next-generation, progressive site generator & fullstack framework, powered by Ruby"
+  spec.description   = "Bridgetown is a next-generation, progressive site generator & fullstack framework, powered by Ruby"
 
-  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r!^(benchmark|features|script|test)/!)
   end
-  s.executables   = ["bridgetown", "bt"] # `bt` is a shortcut to `bridgetown` command
-  s.bindir        = "bin"
-  s.require_paths = ["lib"]
+  spec.executables   = ["bridgetown", "bt"] # `bt` is a shortcut to `bridgetown` command
+  spec.bindir        = "bin"
+  spec.require_paths = ["lib"]
 
-  s.metadata      = {
+  spec.metadata      = {
     "source_code_uri"       => "https://github.com/bridgetownrb/bridgetown",
     "bug_tracker_uri"       => "https://github.com/bridgetownrb/bridgetown/issues",
     "changelog_uri"         => "https://github.com/bridgetownrb/bridgetown/releases",
-    "homepage_uri"          => s.homepage,
+    "homepage_uri"          => spec.homepage,
     "rubygems_mfa_required" => "true",
   }
 
-  s.rdoc_options = ["--charset=UTF-8"]
+  spec.rdoc_options = ["--charset=UTF-8"]
 
-  s.required_ruby_version     = ">= 3.1.0"
+  spec.required_ruby_version     = ">= 3.1.0"
 
-  s.add_runtime_dependency("activesupport",             [">= 6.0", "< 8.0"])
-  s.add_runtime_dependency("addressable",               "~> 2.4")
-  s.add_runtime_dependency("amazing_print",             "~> 1.2")
-  s.add_runtime_dependency("bridgetown-foundation",     Bridgetown::VERSION)
-  s.add_runtime_dependency("csv",                       "~> 3.2")
-  s.add_runtime_dependency("dry-inflector",             ">= 1.0")
-  s.add_runtime_dependency("erubi",                     "~> 1.9")
-  s.add_runtime_dependency("faraday",                   "~> 2.0")
-  s.add_runtime_dependency("faraday-follow_redirects",  "~> 0.3")
-  s.add_runtime_dependency("i18n",                      "~> 1.0")
-  s.add_runtime_dependency("kramdown",                  "~> 2.1")
-  s.add_runtime_dependency("kramdown-parser-gfm",       "~> 1.0")
-  s.add_runtime_dependency("liquid",                    [">= 5.0", "< 5.5"])
-  s.add_runtime_dependency("listen",                    "~> 3.0")
-  s.add_runtime_dependency("rack",                      ">= 3.0")
-  s.add_runtime_dependency("rackup",                    "~> 2.0")
-  s.add_runtime_dependency("rake",                      ">= 13.0")
-  s.add_runtime_dependency("roda",                      "~> 3.46")
-  s.add_runtime_dependency("rouge",                     [">= 3.0", "< 5.0"])
-  s.add_runtime_dependency("serbea",                    "~> 2.1")
-  s.add_runtime_dependency("signalize",                 "~> 1.3")
-  s.add_runtime_dependency("streamlined",               ">= 0.6.0")
-  s.add_runtime_dependency("thor",                      "~> 1.1")
-  s.add_runtime_dependency("tilt",                      "~> 2.0")
-  s.add_runtime_dependency("zeitwerk",                  "~> 2.5")
+  spec.add_dependency("activesupport",             [">= 6.0", "< 8.0"])
+  spec.add_dependency("addressable",               "~> 2.4")
+  spec.add_dependency("amazing_print",             "~> 1.2")
+  spec.add_dependency("bridgetown-foundation",     Bridgetown::VERSION)
+  spec.add_dependency("csv",                       "~> 3.2")
+  spec.add_dependency("dry-inflector",             ">= 1.0")
+  spec.add_dependency("erubi",                     "~> 1.9")
+  spec.add_dependency("faraday",                   "~> 2.0")
+  spec.add_dependency("faraday-follow_redirects",  "~> 0.3")
+  spec.add_dependency("i18n",                      "~> 1.0")
+  spec.add_dependency("irb",                       ">= 1.14")
+  spec.add_dependency("kramdown",                  "~> 2.1")
+  spec.add_dependency("kramdown-parser-gfm",       "~> 1.0")
+  spec.add_dependency("liquid",                    [">= 5.0", "< 5.5"])
+  spec.add_dependency("listen",                    "~> 3.0")
+  spec.add_dependency("rack",                      ">= 3.0")
+  spec.add_dependency("rackup",                    "~> 2.0")
+  spec.add_dependency("rake",                      ">= 13.0")
+  spec.add_dependency("roda",                      "~> 3.46")
+  spec.add_dependency("rouge",                     [">= 3.0", "< 5.0"])
+  spec.add_dependency("serbea",                    "~> 2.1")
+  spec.add_dependency("signalize",                 "~> 1.3")
+  spec.add_dependency("streamlined",               ">= 0.6.0")
+  spec.add_dependency("thor",                      "~> 1.1")
+  spec.add_dependency("tilt",                      "~> 2.0")
+  spec.add_dependency("zeitwerk",                  "~> 2.5")
 end

data/lib/bridgetown-core/collection.rb

@@ -55,13 +55,13 @@ module Bridgetown
     # Iterate over Resources by delegating to `resources.each` (supports Enumerable)
     def each(...) = resources.each(...)
 
-    # Delgates to `resources.last`
+    # Delegates to `resources.last`
     def last(...) = resources.last(...)
 
-    # Delgates to `resources.deconstruct`
+    # Delegates to `resources.deconstruct`
     def deconstruct = resources.deconstruct
 
-    # Delgates to `resources[]`
+    # Delegates to `resources[]`
     def [](...) = resources.[](...)
 
     # Fetch the static files in this collection.
@@ -184,7 +184,8 @@ module Bridgetown
     #
     # @return [String]
     def inspect
-      "#<#{self.class} @label=#{label} resources=#{resources}>"
+      "#<#{self.class} #{label}: #{resources.count} metadata=#{metadata.inspect} " \
+        "static_files: #{static_files.count}>"
     end
 
     # Produce a sanitized label name

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

@@ -66,6 +66,13 @@ module Bridgetown
               puts "Unknown task: #{cmd.split("[")[0]}\n\nHere's a list of tasks you can run:"
               display_rake_tasks(rake)
             end
+          rescue RuntimeError => e
+            # re-raise error unless it's an error through Minitest
+            raise e unless e.message.include?("ruby -Ilib:test")
+
+            Bridgetown.logger.error "test aborted!"
+            Bridgetown.logger.error e.message
+            exit(false)
           end
         end
       end

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

@@ -50,11 +50,7 @@ module Bridgetown
           if Bridgetown::Utils.frontend_bundler_type(config_options[:root_dir]) == :esbuild
             Bridgetown::Utils.update_esbuild_autogenerated_config config_options
           end
-          require "rake"
-          Rake.with_application do |rake|
-            rake.load_rakefile
-            rake["frontend:watcher"].invoke(true)
-          end
+          invoke_frontend_watcher_from_rake
         end
 
         @site = Bridgetown::Site.new(config_options)
@@ -95,6 +91,19 @@ module Bridgetown
       #
       # @param options [Bridgetown::Configuration] options loaded from config and/or CLI
       def watch_site(config_options)
+        if config_options["url"]&.include?("://localhost")
+          require "socket"
+          external_ip = Socket.ip_address_list.find do |ai|
+            ai.ipv4? && !ai.ipv4_loopback?
+          end&.ip_address
+          scheme = config_options.bind&.split("://")&.first == "ssl" ? "https" : "http"
+          port = ENV.fetch("BRIDGETOWN_PORT", config_options.port)
+          Bridgetown.logger.info ""
+          Bridgetown.logger.info "Now serving at:", "#{scheme}://localhost:#{port}".magenta
+          Bridgetown.logger.info "", "#{scheme}://#{external_ip}:#{port}".magenta if external_ip
+          Bridgetown.logger.info ""
+        end
+
         Bridgetown::Watcher.watch(@site, config_options)
       end
 
@@ -112,6 +121,21 @@ module Bridgetown
         plugins_dir = File.expand_path(config_options["plugins_dir"])
         Bridgetown.logger.info "Custom Plugins:", plugins_dir if Dir.exist?(plugins_dir)
       end
+
+      def invoke_frontend_watcher_from_rake
+        require "rake"
+        Rake.with_application do |rake|
+          begin
+            rake.raw_load_rakefile
+          rescue StandardError => e
+            unless e.message.include?("No Rakefile found")
+              Bridgetown.logger.error "Error Running Rake:", "#{e.message} (#{e.class})"
+              e.backtrace[0..1].each { |backtrace_line| Bridgetown.logger.info backtrace_line }
+            end
+          end
+          rake["frontend:watcher"].invoke(true) if rake.tasks.any? { _1.name == "frontend:watcher" }
+        end
+      end
     end
   end
 end

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

@@ -80,7 +80,6 @@ module Bridgetown
 
         config_options = configuration_with_overrides(options)
         if options[:"server-config"]
-          require "puma"
           require "bridgetown-core/rack/boot"
           Bridgetown::Rack.boot
         else

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

@@ -27,15 +27,16 @@ module Bridgetown
 
         pm = site.plugin_manager
 
-        plugins_list += pm.class.registered_plugins.reject do |plugin|
-          plugin.to_s.end_with? "site_builder.rb"
+        plugins_list += pm.class.registered_plugins.to_a
+
+        plugins_list.reject! do |plugin|
+          plugin.to_s.end_with?("site_builder.rb") || plugin.to_s == "init (Initializer)"
         end
 
         Bridgetown.logger.info("Registered Plugins:", plugins_list.length.to_s.yellow.bold)
 
         plugins_list.each do |plugin|
           plugin_desc = plugin.to_s
-          next if plugin_desc.ends_with?("site_builder.rb") || plugin_desc == "init (Initializer)"
 
           if plugin.is_a?(Bridgetown::Configuration::Initializer)
             Bridgetown.logger.info("", plugin_desc)

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

@@ -169,7 +169,7 @@ module Bridgetown
         end
         result&.html_safe
       else
-        partial(item, options, &block)&.html_safe
+        partial(item, **options, &block)&.html_safe
       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/site/fast_refreshable.rb

@@ -10,6 +10,7 @@ class Bridgetown::Site
       @fast_refresh_ordering = 0
       full_abort = false
       found_gen_pages = false
+      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
@@ -28,7 +29,13 @@ class Bridgetown::Site
             self, layout.instance_variable_get(:@base), layout.name
           )
         end
-        next unless found_res.any? || pages.any?
+
+        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
@@ -48,7 +55,7 @@ class Bridgetown::Site
       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
@@ -62,13 +69,14 @@ class Bridgetown::Site
 
       Bridgetown::Hooks.trigger :site, :fast_refresh, self
 
-      liquid_renderer.reset
-      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

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
 

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

@@ -122,14 +122,17 @@ module Bridgetown
           .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
 
@@ -148,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
@@ -283,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({
@@ -357,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