bridgetown-core 1.3.4 → 2.0.0.beta2

data/lib/bridgetown-core/slot.rb

@@ -2,6 +2,8 @@
 
 module Bridgetown
   class Slot
+    using Bridgetown::Refinements
+
     include Transformable
 
     # @return [String]
@@ -28,12 +30,10 @@ module Bridgetown
     private
 
     def converters
-      # A private method calling another private method. Hmm.
-      document_converters = if context.is_a?(Bridgetown::Resource::Base)
-                              context.transformer.send(:converters)
-                            else
+      # TODO: a private method calling another private method. Hmm.
+      document_converters = context.is_a?(Bridgetown::Resource::Base) ?
+                              context.transformer.send(:converters) :
                               context.send(:converters)
-                            end
 
       document_converters.select { _1.class.supports_slots? }
     end

data/lib/bridgetown-core/static_file.rb

@@ -2,6 +2,7 @@
 
 module Bridgetown
   class StaticFile
+    using Bridgetown::Refinements
     extend Forwardable
 
     attr_reader :relative_path, :extname, :name, :data, :site, :collection
@@ -34,7 +35,7 @@ module Bridgetown
       @collection = collection
       @relative_path = File.join(*[@dir, @name].compact)
       @extname = File.extname(@name)
-      @data = @site.frontmatter_defaults.all(relative_path, type).with_dot_access
+      @data = @site.frontmatter_defaults.all(relative_path, type).as_dots
       data.permalink ||= if collection && !collection.builtin?
                            "#{collection.default_permalink.chomp("/").chomp(".*")}.*"
                          else
@@ -58,7 +59,7 @@ module Bridgetown
       if site.base_path.present? && collection
         dest_url = dest_url.delete_prefix site.base_path(strip_slash_only: true)
       end
-      site.in_dest_dir(dest, Bridgetown::URL.unescape_path(dest_url))
+      site.in_dest_dir(dest, Bridgetown::Utils.unencode_uri(dest_url))
     end
 
     def destination_rel_dir
@@ -146,7 +147,6 @@ module Bridgetown
       }
     end
 
-    # Similar to Bridgetown::Document#cleaned_relative_path.
     # Generates a relative path with the collection's directory removed when applicable
     #   and additionally removes any multiple periods in the string.
     #
@@ -167,15 +167,13 @@ module Bridgetown
       end
     end
 
-    # Applies a similar URL-building technique as Bridgetown::Document that takes
+    # Applies a similar URL-building technique as resources that takes
     # the collection's URL template into account. The default URL template can
     # be overriden in the collection's configuration in bridgetown.config.yml.
     def url
       @url ||= begin
         newly_processed = false
-        special_posts_case = @collection&.label == "posts" &&
-          site.config.content_engine != "resource"
-        base = if @collection.nil? || special_posts_case
+        base = if @collection.nil?
                  cleaned_relative_path
                else
                  newly_processed = true

data/lib/bridgetown-core/tags/asset_path.rb

@@ -2,7 +2,7 @@
 
 module Bridgetown
   module Tags
-    # A helper class to help find the path to assets inside of a webpack or esbuild
+    # A helper class to help find the path to assets inside of an esbuild
     # manifest file.
     class AssetPath < Liquid::Tag
       # @param tag_name [String] Name of the tag
@@ -20,13 +20,22 @@ module Bridgetown
       # Render an asset path based on the frontend manifest file
       # @param context [Liquid::Context] Context passed to the tag
       #
-      # @return [String] Returns "MISSING_WEBPACK_MANIFEST" if the manifest
+      # @return [String] Returns "MISSING_ESBUILD_MANIFEST" if the manifest
       #   file isn't found
       # @return [String] Returns a blank string if the asset isn't found
       # @return [String] Returns the path to the asset if no issues parsing
       def render(context)
         @context = context
         site = context.registers[:site]
+        if tag_name == "webpack_path"
+          source_file =
+            "#{context.registers.static[:file_system].root.last}/#{context.template_name}.liquid"
+          raise(
+            Bridgetown::Errors::FatalException,
+            "🚨 Oops, you'll need to change `webpack_path' to `asset_path' in:\n#{source_file}\n"
+          )
+        end
+
         Bridgetown::Utils.parse_frontend_manifest_file(site, @asset_type) || ""
       end
     end

data/lib/bridgetown-core/tags/find.rb

@@ -6,7 +6,7 @@ module Bridgetown
       include Bridgetown::Filters::ConditionHelpers
       include Bridgetown::LiquidExtensions
 
-      SYNTAX = %r!^(.*?) (where|in) (.*?),(.*)$!.freeze
+      SYNTAX = %r!^(.*?) (where|in) (.*?),(.*)$!
       CONDITIONS_SEP = "~FINDSEP~"
 
       def initialize(tag_name, markup, tokens)
@@ -38,11 +38,9 @@ module Bridgetown
         end.join(" and ")
         @liquid_condition = parse_condition(expression)
 
-        context[@new_var_name] = if @single_or_group == "where"
-                                   group_evaluate(context)
-                                 else
+        context[@new_var_name] = @single_or_group == "where" ?
+                                   group_evaluate(context) :
                                    single_evaluate(context)
-                                 end
 
         ""
       end

data/lib/bridgetown-core/tags/highlight.rb

@@ -10,7 +10,7 @@ module Bridgetown
       # forms: name, name=value, or name="<quoted list>"
       #
       # <quoted list> is a space-separated list of numbers
-      SYNTAX = %r!^([a-zA-Z0-9.+#_-]+)((\s+\w+(=(\w+|"([0-9]+\s)*[0-9]+"))?)*)$!.freeze
+      SYNTAX = %r!^([a-zA-Z0-9.+#_-]+)((\s+\w+(=(\w+|"([0-9]+\s)*[0-9]+"))?)*)$!
 
       def initialize(tag_name, markup, tokens)
         super
@@ -28,7 +28,7 @@ module Bridgetown
         @highlight_options = parse_options(Regexp.last_match(2))
       end
 
-      LEADING_OR_TRAILING_LINE_TERMINATORS = %r!\A(\n|\r)+|(\n|\r)+\z!.freeze
+      LEADING_OR_TRAILING_LINE_TERMINATORS = %r!\A(\n|\r)+|(\n|\r)+\z!
 
       def render(context)
         prefix = context["highlighter_prefix"] || ""
@@ -49,7 +49,7 @@ module Bridgetown
 
       private
 
-      OPTIONS_REGEX = %r!(?:\w="[^"]*"|\w=\w|\w)+!.freeze
+      OPTIONS_REGEX = %r!(?:\w="[^"]*"|\w=\w|\w)+!
 
       def parse_options(input)
         options = {}

data/lib/bridgetown-core/tags/post_url.rb

@@ -3,7 +3,7 @@
 module Bridgetown
   module Tags
     class PostComparer
-      MATCHER = %r!^(.+/)*(\d+-\d+-\d+)-(.*)$!.freeze
+      MATCHER = %r!^(.+/)*(\d+-\d+-\d+)-(.*)$!
 
       attr_reader :path, :date, :slug, :name
 

data/lib/bridgetown-core/tasks/bridgetown_tasks.rake

@@ -32,7 +32,7 @@ namespace :roda do
   task :routes do
     require "bridgetown-core/rack/boot"
 
-    Bridgetown::Rack::Roda.print_routes
+    Bridgetown::Rack::Routes.print_routes
   end
 end
 
@@ -55,7 +55,7 @@ task :environment do # rubocop:todo Metrics/BlockLength
     def site(context: :rake)
       @site ||= begin
         config = Bridgetown::Current.preloaded_configuration
-        config.run_initializers! context: context
+        config.run_initializers!(context:)
         Bridgetown::Site.new(config)
       end
     end

data/lib/bridgetown-core/utils/aux.rb

@@ -3,57 +3,57 @@
 module Bridgetown
   module Utils
     module Aux
-      def self.with_color(name, message)
-        return message unless !name.nil? && Bridgetown::Utils::Ansi::COLORS[name.to_sym]
+      class << self
+        extend Inclusive::Class
 
-        Bridgetown::Utils::Ansi.send(name, message)
-      end
+        # @return
+        #   [Bridgetown::Foundation::Packages::Ansi, Bridgetown::Foundation::Packages::PidTracker]
+        packages def utils = [
+          Bridgetown::Foundation::Packages::Ansi,
+          Bridgetown::Foundation::Packages::PidTracker,
+        ]
 
-      def self.running_pids
-        @running_pids ||= []
-      end
+        def with_color(name, message)
+          return message unless !name.nil? && utils.colors[name.to_sym]
 
-      def self.add_pid(pid)
-        running_pids << pid
-      end
+          utils.send(name, message)
+        end
 
-      def self.run_process(name, color, cmd, env: {})
-        @mutex ||= Thread::Mutex.new
-
-        Thread.new do
-          rd, wr = IO.pipe("BINARY")
-          pid = Process.spawn({ "BRIDGETOWN_NO_BUNDLER_REQUIRE" => nil }.merge(env),
-                              cmd, out: wr, err: wr, pgroup: true)
-          @mutex.synchronize { add_pid(pid) }
-
-          loop do
-            line = rd.gets
-            line.to_s.lines.map(&:chomp).each do |message|
-              next if name == "Frontend" && %r{ELIFECYCLE.*?Command failed}.match?(message)
-
-              output = +""
-              output << with_color(color, "[#{name}] ") if color
-              output << message
-              @mutex.synchronize do
-                $stdout.puts output
-                $stdout.flush
+        def run_process(name, color, cmd, env: {}) # rubocop:disable Metrics/AbcSize
+          @mutex ||= Thread::Mutex.new
+
+          Thread.new do
+            rd, wr = IO.pipe("BINARY")
+            pid = Process.spawn({ "BRIDGETOWN_NO_BUNDLER_REQUIRE" => nil }.merge(env),
+                                cmd, out: wr, err: wr, pgroup: true)
+            @mutex.synchronize { utils.add_pid(pid, file: :aux) }
+
+            loop do
+              line = rd.gets
+              line.to_s.lines.map(&:chomp).each do |message|
+                next if name == "Frontend" && %r{ELIFECYCLE.*?Command failed}.match?(message)
+
+                output = +""
+                output << with_color(color, "[#{name}] ") if color
+                output << message
+                @mutex.synchronize do
+                  $stdout.puts output
+                  $stdout.flush
+                end
               end
             end
           end
         end
-      end
 
-      def self.group(&block)
-        Bridgetown::Deprecator.deprecation_message "Bridgetown::Aux.group method will be removed" \
-                                                   "in a future version, use run_process"
-        instance_exec(&block)
-      end
+        def kill_processes
+          Bridgetown.logger.info "Stopping auxiliary processes..."
 
-      def self.kill_processes
-        Bridgetown.logger.info "Stopping auxiliary processes..."
-        running_pids.each do |pid|
-          Process.kill("SIGTERM", -Process.getpgid(pid))
-        rescue Errno::ESRCH, Errno::EPERM, Errno::ECHILD # rubocop:disable Lint/SuppressedException
+          utils.read_pidfile(:aux).each do |pid|
+            Process.kill("SIGTERM", -Process.getpgid(pid.to_i))
+          rescue Errno::ESRCH, Errno::EPERM, Errno::ECHILD # rubocop:disable Lint/SuppressedException
+          ensure
+            utils.remove_pidfile :aux
+          end
         end
       end
     end

data/lib/bridgetown-core/utils/loaders_manager.rb

@@ -28,26 +28,8 @@ module Bridgetown
         load_path.start_with?(root_dir) && ENV["BRIDGETOWN_ENV"] != "production"
       end
 
-      def clear_descendants_for_reload(_cpath, value, _abspath)
-        unless value.is_a?(Class) && value.singleton_class < ActiveSupport::DescendantsTracker
-          return
-        end
-
-        if defined?(ActiveSupport::RubyFeatures) && ActiveSupport::RubyFeatures::CLASS_SUBCLASSES
-          ActiveSupport::DescendantsTracker.clear([value.superclass])
-          return
-        end
-
-        # TODO: this could probably be refactored to work like the above
-        if ActiveSupport::DescendantsTracker.class_variables.include?(:@@direct_descendants)
-          ActiveSupport::DescendantsTracker.class_variable_get(
-            :@@direct_descendants
-          )[value.superclass]&.reject! { _1 == value }
-        end
-      end
-
       def setup_loaders(autoload_paths = []) # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-        (autoload_paths.presence || config.autoload_paths).each do |load_path| # rubocop:todo Metrics/BlockLength
+        (autoload_paths.presence || config.autoload_paths).each do |load_path|
           if @loaders.key?(load_path)
             raise "Zeitwerk loader already added for `#{load_path}'. Please check your config"
           end
@@ -64,14 +46,13 @@ module Bridgetown
           loader.enable_reloading if reloading_enabled?(load_path)
           loader.ignore(File.join(load_path, "**", "*.js.rb"))
           loader.ignore(
-            File.join(File.expand_path(config[:islands_dir], config[:source]), "routes")
+            File.join(File.expand_path(config[:islands_dir], config[:source]), "**", "routes")
           )
           config.autoloader_collapsed_paths.each do |collapsed_path|
             next unless collapsed_path.starts_with?(load_path)
 
             loader.collapse(collapsed_path)
           end
-          loader.on_unload(&method(:clear_descendants_for_reload)) # rubocop:disable Performance/MethodObjectAsBlock
           Bridgetown::Hooks.trigger :loader, :pre_setup, loader, load_path
           loader.setup
           loader.eager_load if config.eager_load_paths.include?(load_path)

data/lib/bridgetown-core/utils/ruby_exec.rb

@@ -3,6 +3,23 @@
 module Bridgetown
   module Utils
     module RubyExec
+      # @param context [Layout, Model::RepoOrigin] the execution context (i.e.
+      #   `self` for the Ruby code)
+      # @param ruby_code [String] the Ruby code to execute
+      # @param file_path [String] the absolute path to the file
+      # @param starting_line [Integer] the number to list as the starting line
+      #   for compilation errors
+      # @return [Hash]
+      def self.process_ruby_data(context, ruby_code, file_path, starting_line)
+        ruby_data = context.instance_eval(ruby_code, file_path.to_s, starting_line)
+        ruby_data.is_a?(Array) ? { rows: ruby_data } : ruby_data.to_h
+      rescue StandardError => e
+        raise(
+          "Ruby code isn't returning an array, or object which " \
+          "responds to `to_h' (#{e.message})"
+        )
+      end
+
       def self.search_data_for_ruby_code(convertible)
         return if convertible.data.empty?
 

data/lib/bridgetown-core/utils.rb

@@ -2,15 +2,11 @@
 
 module Bridgetown
   module Utils # rubocop:todo Metrics/ModuleLength
-    extend Gem::Deprecate
     extend self
-    autoload :Ansi, "bridgetown-core/utils/ansi"
     autoload :Aux, "bridgetown-core/utils/aux"
     autoload :LoadersManager, "bridgetown-core/utils/loaders_manager"
     autoload :RequireGems, "bridgetown-core/utils/require_gems"
     autoload :RubyExec, "bridgetown-core/utils/ruby_exec"
-    autoload :RubyFrontMatter, "bridgetown-core/utils/ruby_front_matter"
-    autoload :RubyFrontMatterDSL, "bridgetown-core/utils/ruby_front_matter"
     autoload :SmartyPantsConverter, "bridgetown-core/utils/smarty_pants_converter"
 
     # Constants for use in #slugify
@@ -39,6 +35,13 @@ module Bridgetown
       input.to_s.encode(xml: :attr).gsub(%r!\A"|"\Z!, "")
     end
 
+    def unencode_uri(path)
+      path = path.encode("utf-8")
+      return path unless path.include?("%")
+
+      Addressable::URI.unencode(path)
+    end
+
     # Non-destructive version of deep_merge_hashes! See that method.
     #
     # Returns the merged hashes.
@@ -66,8 +69,6 @@ module Bridgetown
     def mergeable?(value)
       value.is_a?(Hash) || value.is_a?(Drops::Drop)
     end
-    alias_method :mergable?, :mergeable?
-    deprecate :mergable?, :mergeable?, 2023, 7
 
     def duplicable?(obj)
       case obj
@@ -123,24 +124,21 @@ module Bridgetown
     # Determines whether a given file has
     #
     # @return [Boolean] if the YAML front matter is present.
-    # rubocop: disable Naming/PredicateName
-    def has_yaml_header?(file)
-      File.open(file, "rb", &:gets)&.match?(Bridgetown::FrontMatterImporter::YAML_HEADER) || false
-    end
-
-    def has_rbfm_header?(file)
-      File.open(file, "rb", &:gets)&.match?(Bridgetown::FrontMatterImporter::RUBY_HEADER) || false
+    def has_yaml_header?(file) # rubocop: disable Naming/PredicateName
+      Bridgetown::Deprecator.deprecation_message(
+        "Bridgetown::Utils.has_yaml_header? is deprecated, use " \
+        "Bridgetown::FrontMatter::Loaders::YAML.header? instead"
+      )
+      FrontMatter::Loaders::YAML.header?(file)
     end
 
-    # Determine whether the given content string contains Liquid Tags or Vaiables
-    #
-    # @return [Boolean] if the string contains sequences of `{%` or `{{`
-    def has_liquid_construct?(content)
-      return false if content.nil? || content.empty?
-
-      content.include?("{%") || content.include?("{{")
+    def has_rbfm_header?(file) # rubocop: disable Naming/PredicateName
+      Bridgetown::Deprecator.deprecation_message(
+        "Bridgetown::Utils.has_rbfm_header? is deprecated, use " \
+        "Bridgetown::FrontMatter::Loaders::Ruby.header? instead"
+      )
+      FrontMatter::Loaders::Ruby.header?(file)
     end
-    # rubocop: enable Naming/PredicateName
 
     # Slugify a filename or title.
     #
@@ -201,7 +199,7 @@ module Bridgetown
         string = I18n.transliterate(string)
       end
 
-      slug = replace_character_sequence_with_hyphen(string, mode: mode)
+      slug = replace_character_sequence_with_hyphen(string, mode:)
 
       # Remove leading/trailing hyphen
       slug.gsub!(%r!^-|-$!i, "")
@@ -211,49 +209,6 @@ module Bridgetown
       slug
     end
 
-    # Add an appropriate suffix to template so that it matches the specified
-    # permalink style.
-    #
-    # template - permalink template without trailing slash or file extension
-    # permalink_style - permalink style, either built-in or custom
-    #
-    # The returned permalink template will use the same ending style as
-    # specified in permalink_style.  For example, if permalink_style contains a
-    # trailing slash (or is :pretty, which indirectly has a trailing slash),
-    # then so will the returned template.  If permalink_style has a trailing
-    # ":output_ext" (or is :none, :date, or :ordinal) then so will the returned
-    # template.  Otherwise, template will be returned without modification.
-    #
-    # Examples:
-    #   add_permalink_suffix("/:basename", :pretty)
-    #   # => "/:basename/"
-    #
-    #   add_permalink_suffix("/:basename", :date)
-    #   # => "/:basename:output_ext"
-    #
-    #   add_permalink_suffix("/:basename", "/:year/:month/:title/")
-    #   # => "/:basename/"
-    #
-    #   add_permalink_suffix("/:basename", "/:year/:month/:title")
-    #   # => "/:basename"
-    #
-    # Returns the updated permalink template
-    def add_permalink_suffix(template, permalink_style)
-      template = template.dup
-
-      case permalink_style
-      when :pretty, :simple
-        template << "/"
-      when :date, :ordinal, :none
-        template << ":output_ext"
-      else
-        template << "/" if permalink_style.to_s.end_with?("/")
-        template << ":output_ext" if permalink_style.to_s.end_with?(":output_ext")
-      end
-
-      template
-    end
-
     # Work the same way as Dir.glob but seperating the input into two parts
     # ('dir' + '/' + 'pattern') to make sure the first part('dir') does not act
     # as a pattern.
@@ -350,8 +305,6 @@ module Bridgetown
     # @return [String, nil]
     def parse_frontend_manifest_file(site, asset_type)
       case frontend_bundler_type(site.root_dir)
-      when :webpack
-        parse_webpack_manifest_file(site, asset_type)
       when :esbuild
         parse_esbuild_manifest_file(site, asset_type)
       else
@@ -363,35 +316,11 @@ module Bridgetown
       end
     end
 
-    # Return an asset path based on the Webpack manifest file
-    # @param site [Bridgetown::Site] The current site object
-    # @param asset_type [String] js or css, or filename in manifest
-    #
-    # @return [String] Returns "MISSING_WEBPACK_MANIFEST" if the manifest
-    #   file isnt found
-    # @return [nil] Returns nil if the asset isnt found
-    # @return [String] Returns the path to the asset if no issues parsing
-    def parse_webpack_manifest_file(site, asset_type)
-      return log_frontend_asset_error(site, "Webpack manifest") if site.frontend_manifest.nil?
-
-      asset_path = if %w(js css).include?(asset_type)
-                     site.frontend_manifest["main.#{asset_type}"]
-                   else
-                     site.frontend_manifest.find do |item, _|
-                       item.sub(%r{^../(frontend/|src/)?}, "") == asset_type
-                     end&.last
-                   end
-
-      return log_frontend_asset_error(site, asset_type) if asset_path.nil?
-
-      static_frontend_path site, ["js", asset_path]
-    end
-
     # Return an asset path based on the esbuild manifest file
     # @param site [Bridgetown::Site] The current site object
     # @param asset_type [String] js or css, or filename in manifest
     #
-    # @return [String] Returns "MISSING_WEBPACK_MANIFEST" if the manifest
+    # @return [String] Returns "MISSING_ESBUILD_MANIFEST" if the manifest
     #   file isnt found
     # @return [nil] Returns nil if the asset isnt found
     # @return [String] Returns the path to the asset if no issues parsing
@@ -442,9 +371,7 @@ module Bridgetown
     end
 
     def frontend_bundler_type(cwd = Dir.pwd)
-      if File.exist?(File.join(cwd, "webpack.config.js"))
-        :webpack
-      elsif File.exist?(File.join(cwd, "esbuild.config.js"))
+      if File.exist?(File.join(cwd, "esbuild.config.js"))
         :esbuild
       else
         :unknown
@@ -484,11 +411,15 @@ module Bridgetown
     def live_reload_js(site) # rubocop:disable Metrics/MethodLength
       return "" unless Bridgetown.env.development? && !site.config.skip_live_reload
 
+      path = File.join(site.base_path, "/_bridgetown/live_reload")
       code = <<~JAVASCRIPT
         let lastmod = 0
-        function startReloadConnection() {
-          const evtSource = new EventSource("#{site.base_path(strip_slash_only: true)}/_bridgetown/live_reload")
-          evtSource.onmessage = event => {
+        let reconnectAttempts = 0
+        function startLiveReload() {
+          const connection = new EventSource("#{path}")
+
+          connection.addEventListener("message", event => {
+            reconnectAttempts = 0
             if (document.querySelector("#bridgetown-build-error")) document.querySelector("#bridgetown-build-error").close()
             if (event.data == "reloaded!") {
               location.reload()
@@ -500,8 +431,9 @@ module Bridgetown
                 lastmod = newmod
               }
             }
-          }
-          evtSource.addEventListener("builderror", event => {
+          })
+
+          connection.addEventListener("builderror", event => {
             let dialog = document.querySelector("#bridgetown-build-error")
             if (!dialog) {
               dialog = document.createElement("dialog")
@@ -518,19 +450,23 @@ module Bridgetown
             }
             dialog.querySelector("pre").textContent = JSON.parse(event.data)
           })
-          evtSource.onerror = event => {
-            if (evtSource.readyState === 2) {
-              // reconnect with new object
-              evtSource.close()
-              console.warn("Live reload: attempting to reconnect in 3 seconds...")
 
-              setTimeout(() => startReloadConnection(), 3000)
+          connection.addEventListener("error", () => {
+            if (connection.readyState === 2) {
+              // reconnect with new object
+              connection.close()
+              reconnectAttempts++
+              if (reconnectAttempts < 25) {
+                console.warn("Live reload: attempting to reconnect in 3 seconds...")
+                setTimeout(() => startLiveReload(), 3000)
+              } else {
+                console.error("Too many live reload connections failed. Refresh the page to try again.")
+              }
             }
-          }
+          })
         }
-        setTimeout(() => {
-          startReloadConnection()
-        }, 500)
+
+        startLiveReload()
       JAVASCRIPT
 
       %(<script type="module">#{code}</script>).html_safe