bridgetown-core 2.0.0.beta2 → 2.0.0.beta4

data/lib/bridgetown-core/log_adapter.rb

@@ -11,23 +11,19 @@ module Bridgetown
       error: ::Logger::ERROR,
     }.freeze
 
-    # Public: Create a new instance of a log writer
+    # Create a new instance of a log writer
     #
-    # writer - Logger compatible instance
-    # log_level - (optional, symbol) the log level
-    #
-    # Returns nothing
+    # @param writer [Logger] compatible instance
+    # @param log_level [Symbol] the log level (`debug` | `info` | `warn` | `error`)
     def initialize(writer, level = :info)
       @messages = []
       @writer = writer
       self.log_level = level
     end
 
-    # Public: Set the log level on the writer
-    #
-    # level - (symbol) the log level
+    # Set the log level on the writer
     #
-    # Returns nothing
+    # @param log_level [Symbol] the log level (`debug` | `info` | `warn` | `error`)
     def log_level=(level)
       writer.level = level if level.is_a?(Integer) && level.between?(0, 3)
       writer.level = LOG_LEVELS[level] ||
@@ -45,63 +41,52 @@ module Bridgetown
       debug "Logging at level:", LOG_LEVELS.key(writer.level).to_s
     end
 
-    # Public: Print a debug message
-    #
-    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
-    # message - the message detail
+    # Print a debug message
     #
-    # Returns nothing
+    # @param topic [String] e.g. "Configuration file", "Deprecation", etc.
+    # @param message [String] the message detail
     def debug(topic, message = nil, &)
       write(:debug, topic, message, &)
     end
 
-    # Public: Print a message
+    # Print an informational message
     #
-    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
-    # message - the message detail
-    #
-    # Returns nothing
+    # @param topic [String] e.g. "Configuration file", "Deprecation", etc.
+    # @param message [String] the message detail
     def info(topic, message = nil, &)
       write(:info, topic, message, &)
     end
 
-    # Public: Print a message
-    #
-    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
-    # message - the message detail
+    # Print a warning message
     #
-    # Returns nothing
+    # @param topic [String] e.g. "Configuration file", "Deprecation", etc.
+    # @param message [String] the message detail
     def warn(topic, message = nil, &)
       write(:warn, topic, message, &)
     end
 
-    # Public: Print an error message
-    #
-    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
-    # message - the message detail
+    # Print an error message
     #
-    # Returns nothing
+    # @param topic [String] e.g. "Configuration file", "Deprecation", etc.
+    # @param message [String] the message detail
     def error(topic, message = nil, &)
       write(:error, topic, message, &)
     end
 
-    # Public: Print an error message and immediately abort the process
+    # Print an error message and immediately abort the process
     #
-    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
-    # message - the message detail (can be omitted)
-    #
-    # Returns nothing
+    # @param topic [String] e.g. "Configuration file", "Deprecation", etc.
+    # @param message [String] the message detail
     def abort_with(topic, message = nil, &)
       error(topic, message, &)
       abort
     end
 
-    # Internal: Build a topic method
-    #
-    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
-    # message - the message detail
+    # Build a topic method
     #
-    # Returns the formatted message
+    # @param topic [String] e.g. "Configuration file", "Deprecation", etc.
+    # @param message [String] the message detail
+    # @return [String] the formatted message
     def message(topic, message = nil)
       raise ArgumentError, "block or message, not both" if block_given? && message
 
@@ -113,34 +98,30 @@ module Bridgetown
       out
     end
 
-    # Internal: Format the topic
-    #
-    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
-    # colon -
+    # Format the topic
     #
-    # Returns the formatted topic statement
+    # @param topic [String] e.g. "Configuration file", "Deprecation", etc.
+    # @param colon [Boolean]
+    # @return [String] formatted topic statement
     def formatted_topic(topic, colon = false) # rubocop:disable Style/OptionalBooleanParameter
       "#{topic}#{colon ? ": " : " "}".rjust(20)
     end
 
-    # Internal: Check if the message should be written given the log level.
+    # Check if the message should be written given the log level
     #
-    # level_of_message - the Symbol level of message, one of :debug, :info, :warn, :error
-    #
-    # Returns whether the message should be written.
+    # @param level_of_message [Symbol] the message level (`debug` | `info` | `warn` | `error`)
+    # @return [Boolean] whether the message should be written to the log
     def write_message?(level_of_message)
       LOG_LEVELS.fetch(level) <= LOG_LEVELS.fetch(level_of_message)
     end
 
-    # Internal: Log a message.
-    #
-    # level_of_message - the Symbol level of message, one of :debug, :info, :warn, :error
-    # topic - the String topic or full message
-    # message - the String message (optional)
-    # block - a block containing the message (optional)
+    # Log a message. If a block is provided containing the message, use that instead.
     #
-    # Returns false if the message was not written, otherwise returns the value of calling
-    # the appropriate writer method, e.g. writer.info.
+    # @param level_of_message [Symbol] the message level (`debug` | `info` | `warn` | `error`)
+    # @param topic [String] e.g. "Configuration file", "Deprecation", etc.
+    # @param message [String] the message detail
+    # @return [BasicObject] false if the message was not written, otherwise returns the value of
+    #   calling the appropriate writer method, e.g. writer.info.
     def write(level_of_message, topic, message = nil, &)
       return false unless write_message?(level_of_message)
 

data/lib/bridgetown-core/plugin_manager.rb

@@ -81,12 +81,12 @@ module Bridgetown
     end
 
     def self.package_manager
-      @package_manager ||= if File.exist?("package-lock.json")
-                             "npm"
-                           elsif File.exist?("yarn.lock")
+      @package_manager ||= if File.exist?("yarn.lock")
                              "yarn"
                            elsif File.exist?("pnpm-lock.yaml")
                              "pnpm"
+                           elsif File.exist?("package.json")
+                             "npm"
                            else
                              ""
                            end
@@ -96,6 +96,10 @@ module Bridgetown
       package_manager == "npm" ? "install" : "add"
     end
 
+    def self.package_manager_uninstall_command
+      package_manager == "npm" ? "uninstall" : "remove"
+    end
+
     # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
     # Iterates through loaded gems and finds npm-add gemspec metadata.

data/lib/bridgetown-core/rack/boot.rb

@@ -3,14 +3,16 @@
 require "zeitwerk"
 require "roda"
 require "json"
+require "bridgetown"
 
-Bridgetown::Current.preloaded_configuration ||= Bridgetown.configuration
-
+require_relative "loader_hooks"
 require_relative "logger"
 require_relative "routes"
 
 module Bridgetown
   module Rack
+    Bridgetown.begin!(with_config: :initializers)
+
     class << self
       # @return [Bridgetown::Utils::LoadersManager]
       attr_accessor :loaders_manager
@@ -23,61 +25,9 @@ module Bridgetown
       self.loaders_manager =
         Bridgetown::Utils::LoadersManager.new(Bridgetown::Current.preloaded_configuration)
       Bridgetown::Current.preloaded_configuration.run_initializers! context: :server
-      autoload_server_folder
-    rescue Roda::RodaError => e
-      if e.message.include?("sessions plugin :secret option")
-        raise Bridgetown::Errors::InvalidConfigurationError,
-              "The Roda sessions plugin can't find a valid secret. Run `bin/bridgetown secret' " \
-              "and put the key in a ENV var you can use to configure the session in the Roda app"
-      end
-
-      raise e
-    end
-
-    # @param root [String] root of Bridgetown site, defaults to config value
-    def self.autoload_server_folder( # rubocop:todo Metrics
-      root: Bridgetown::Current.preloaded_configuration.root_dir
-    )
-      server_folder = File.join(root, "server")
-
-      Bridgetown::Hooks.register_one(
-        :loader, :post_setup, reloadable: false
-      ) do |loader, load_path|
-        next unless load_path == server_folder
-
-        loader.eager_load
-        loader.do_not_eager_load(File.join(server_folder, "roda_app.rb"))
-
-        unless ENV["BRIDGETOWN_ENV"] == "production"
-          Listen.to(server_folder) do |modified, added, removed|
-            c = modified + added + removed
-            n = c.length
-
-            Bridgetown.logger.info(
-              "Reloading…",
-              "#{n} file#{"s" if n > 1} changed at #{Time.now.strftime("%Y-%m-%d %H:%M:%S")}"
-            )
-            c.each do |path|
-              Bridgetown.logger.info "", "- #{path["#{File.dirname(server_folder)}/".length..]}"
-            end
-
-            loader.reload
-            loader.eager_load
-          rescue SyntaxError => e
-            Bridgetown::Errors.print_build_error(e)
-          end.start
-        end
-      end
-
-      Bridgetown::Hooks.register_one(
-        :loader, :post_reload, reloadable: false
-      ) do |loader, load_path|
-        next unless load_path == server_folder
-
-        loader.eager_load
-      end
-
-      loaders_manager.setup_loaders([server_folder])
+      LoaderHooks.autoload_server_folder(
+        File.join(Bridgetown::Current.preloaded_configuration.root_dir, "server")
+      )
     end
   end
 end

data/lib/bridgetown-core/rack/default_config.ru

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bridgetown-core/rack/boot"
+
+Bridgetown::Rack.boot
+
+unless defined?(RodaApp)
+  class RodaApp < Roda
+    plugin :bridgetown_server
+    route(&:bridgetown)
+  end
+end
+
+run RodaApp.freeze.app

data/lib/bridgetown-core/rack/loader_hooks.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Rack
+    module LoaderHooks
+      # Sets up a Zeitwerk loader for the Roda routes in the server folder. Called by the server
+      # boot process when Rack starts up
+      #
+      # @param server_folder [String] typically `server` within the site root
+      def self.autoload_server_folder(server_folder)
+        reload_file_path = Bridgetown.live_reload_path
+
+        register_hooks server_folder, reload_file_path
+
+        Bridgetown::Rack.loaders_manager.setup_loaders([server_folder])
+      end
+
+      # Registers a `post_setup` and `post_reload` hook for the Zeitwerk loader in order to handle
+      # eager loading and, in development, the live reload watcher
+      #
+      # @param server_folder [String]
+      # @param reload_file_path [String] path to the special live reload txt file
+      def self.register_hooks(server_folder, reload_file_path) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+        Bridgetown::Hooks.register_one(
+          :loader, :post_setup, reloadable: false
+        ) do |loader, load_path|
+          next unless load_path == server_folder
+
+          loader.eager_load
+          subclass_names = Roda.subclasses.map(&:name)
+          subclass_paths = Set.new
+
+          loader.all_expected_cpaths.each do |cpath, cname|
+            if subclass_names.include?(cname) && cpath.start_with?(server_folder)
+              subclass_paths << cpath
+              loader.do_not_eager_load cpath
+            end
+          end
+
+          unless ENV["BRIDGETOWN_ENV"] == "production"
+            setup_autoload_listener loader, server_folder, subclass_paths
+          end
+        end
+
+        Bridgetown::Hooks.register_one(
+          :loader, :post_reload, reloadable: false
+        ) do |loader, load_path|
+          next unless load_path == server_folder
+
+          loader.eager_load
+          Bridgetown.touch_live_reload_file(reload_file_path)
+        end
+      end
+
+      # Creates a listener to detect file changes within the server folder and notify Zeitwerk
+      #
+      # @param loader [Zeitwerk::Loader]
+      # @param server_loader [String]
+      # @param subclass_paths [Array<string>]
+      def self.setup_autoload_listener(loader, server_folder, subclass_paths)
+        Listen.to(server_folder) do |modified, added, removed|
+          c = modified + added + removed
+          n = c.length
+
+          unless n == 1 && subclass_paths.include?(c.first)
+            Bridgetown.logger.info(
+              "Reloading…",
+              "#{n} file#{"s" if n > 1} changed at #{Time.now.strftime("%Y-%m-%d %H:%M:%S")}"
+            )
+            c.each do |path|
+              Bridgetown.logger.info "", "- #{path["#{File.dirname(server_folder)}/".length..]}"
+            end
+          end
+
+          loader.reload
+          Bridgetown::Hooks.trigger :loader, :post_reload, loader, server_folder
+        rescue SyntaxError => e
+          Bridgetown::Errors.print_build_error(e)
+        end.start
+      end
+    end
+  end
+end

data/lib/bridgetown-core/rack/logger.rb

@@ -7,8 +7,6 @@ module Bridgetown
   module Rack
     class Logger < Bridgetown::LogWriter
       def self.message_with_prefix(msg)
-        #        return if msg.include?("/_bridgetown/live_reload")
-
         "\e[35m[Server]\e[0m #{msg}"
       end
 

data/lib/bridgetown-core/rack/routes.rb

@@ -101,13 +101,14 @@ module Bridgetown
           Bridgetown::Rack::Routes.sorted_subclasses&.each do |klass|
             klass.merge roda_app
           end
+
+          nil # required for proper 404 handling
         end
 
         # @param app [Roda]
         def setup_live_reload(app) # rubocop:disable Metrics
           sleep_interval = 0.5
-          file_to_check = File.join(Bridgetown::Current.preloaded_configuration.destination,
-                                    "index.html")
+          file_to_check = Bridgetown.live_reload_path
           errors_file = Bridgetown.build_errors_path
 
           app.request.get "_bridgetown/live_reload" do

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

@@ -106,11 +106,7 @@ module Bridgetown
       #
       # @param new_data [HashWithDotAccess::Hash]
       def data=(new_data)
-        if site.config.fast_refresh && write?
-          # TODO: investigate if this would be better:
-          # @data.value = front_matter_defaults
-          mark_for_fast_refresh!
-        end
+        mark_for_fast_refresh! if site.config.fast_refresh && write?
 
         Signalize.batch do
           @content_signal.value += 1
@@ -221,12 +217,12 @@ module Bridgetown
 
       # @return [String]
       def absolute_url
-        format_url destination&.absolute_url
+        @absolute_url ||= format_url(destination&.absolute_url)
       end
 
       # @return [String]
       def relative_url
-        format_url destination&.relative_url
+        @relative_url ||= format_url(destination&.relative_url)
       end
 
       # @return [String]
@@ -365,7 +361,11 @@ module Bridgetown
         past_values = @data.peek.select do |key|
           key == "categories" || key == "tags" || site.taxonomy_types.keys.any?(key)
         end
-        model.attributes = model.origin.read
+        origin_data = model.origin.read
+        correct_locale = origin_data["locale"] || origin_data[:locale] || data.locale
+        model.attributes = origin_data
+        model.attributes.locale = correct_locale
+        @relative_url = @absolute_url = nil # wipe memoizations
         read!
         tax_diff = past_values.any? { |k, v| @data.peek[k] != v }
 

data/lib/bridgetown-core/resource/permalink_processor.rb

@@ -120,7 +120,7 @@ module Bridgetown
       end
 
       # @param resource [Bridgetown::Resource::Base]
-      register_placeholder :name, ->(resource) do
+      register_placeholder :name, ->(resource) do # rubocop:disable Style/SymbolProc
         resource.basename_without_ext
       end
 

data/lib/bridgetown-core/resource/relations.rb

@@ -20,7 +20,9 @@ module Bridgetown
 
       # @return [HashWithDotAccess::Hash]
       def relation_schema
-        resource.collection.metadata.relations
+        @relation_schema ||= resource.collection.metadata.relations&.transform_values do |value|
+          value.is_a?(Array) ? value.map(&:to_s) : value.to_s
+        end
       end
 
       # @return [Array<String>]

data/lib/bridgetown-core/ruby_template_view.rb

@@ -131,7 +131,6 @@ module Bridgetown
     def _partial_path(partial_name, ext)
       partial_name = partial_name.split("/").tap { _1.last.prepend("_") }.join("/")
 
-      # TODO: see if there's a workaround for this to speed up performance
       site.in_source_dir(site.config[:partials_dir], "#{partial_name}.#{ext}")
     end
   end

data/lib/bridgetown-core/static_file.rb

@@ -48,11 +48,10 @@ module Bridgetown
       @path ||= File.join(*[@base, @dir, @name].compact)
     end
 
-    # Obtain destination path.
+    # Obtain destination path
     #
-    # dest - The String path to the destination dir.
-    #
-    # Returns destination file path.
+    # @param dest [String] path to the destination dir
+    # @return [String]
     def destination(dest)
       dest = site.in_dest_dir(dest)
       dest_url = url
@@ -76,22 +75,21 @@ module Bridgetown
 
     alias_method :date, :modified_time
 
-    # Returns last modification time for this file.
+    # @return [Integer] last modification time for this file
     def mtime
       modified_time.to_i
     end
 
     # Is source path modified?
     #
-    # Returns true if modified since last write.
+    # @return [Boolean] true if modified since last write
     def modified?
       self.class.mtimes[path] != mtime
     end
 
     # Whether to write the file to the filesystem
     #
-    # Returns true unless the defaults for the destination path from
-    # bridgetown.config.yml contain `published: false`.
+    # @return [Boolean] true unless the defaults for the destination path contain `published: false`
     def write?
       publishable = defaults.fetch("published", true)
       return publishable unless @collection
@@ -99,11 +97,10 @@ module Bridgetown
       publishable && @collection.write?
     end
 
-    # Write the static file to the destination directory (if modified).
-    #
-    # dest - The String path to the destination dir.
+    # Write the static file to the destination directory (if modified)
     #
-    # Returns false if the file was not modified since last time (no-op).
+    # @param dest [String] path to the destination dir
+    # @return [Boolean] false if the file was not modified since last time (no-op)
     def write(dest)
       dest_path = destination(dest)
       return false if File.exist?(dest_path) && !modified?
@@ -152,12 +149,12 @@ module Bridgetown
     #
     # NOTE: `String#gsub!` removes all trailing periods (in comparison to `String#chomp!`)
     #
-    # Examples:
+    # @example
     #   When `relative_path` is "_methods/site/my-cool-avatar...png":
     #     cleaned_relative_path
     #     # => "/site/my-cool-avatar"
     #
-    # Returns the cleaned relative path of the static file.
+    # @return [String] cleaned relative path of the static file
     def cleaned_relative_path
       @cleaned_relative_path ||= begin
         cleaned = relative_path[0..-extname.length - 1]
@@ -169,7 +166,7 @@ module Bridgetown
 
     # 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.
+    # be overriden in the collection's configuration
     def url
       @url ||= begin
         newly_processed = false
@@ -183,19 +180,17 @@ module Bridgetown
       end
     end
 
-    # Returns the type of the collection if present, nil otherwise.
+    # @return [Symbol, nil] type of the collection if present
     def type
       @type ||= @collection&.label&.to_sym
     end
 
-    # Returns the front matter defaults defined for the file's URL and/or type
-    # as defined in bridgetown.config.yml.
+    # @return [Hash] front matter defaults defined for the file's URL and/or type
     def defaults
       @defaults ||= site.frontmatter_defaults.all url, type
     end
 
-    # Returns a debug string on inspecting the static file.
-    # Includes only the relative path of the object.
+    # @return [String] includes only the relative path of the object
     def inspect
       "#<#{self.class} @relative_path=#{relative_path.inspect}>"
     end

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

@@ -23,7 +23,7 @@ module Bridgetown
     class ClassMap < Liquid::Tag
       # @see https://api.rubyonrails.org/classes/ActiveModel/Type/Boolean.html
       FALSE_VALUES = [
-        nil, "nil", "NIL", false, 0, "0", :"0", "f", :f, "F", :F, "false",
+        nil, "nil", "NIL", 0, "0", :"0", "f", :f, "F", :F, "false",
         false, "FALSE", :FALSE,
       ].to_set.freeze
 

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

@@ -12,7 +12,7 @@ module Bridgetown
 
         all, @path, @date, @slug = *name.sub(%r!^/!, "").match(MATCHER)
         unless all
-          raise Bridgetown::Errors::InvalidPostNameError,
+          raise Bridgetown::Errors::FatalException,
                 "'#{name}' does not contain valid date and/or title."
         end
 
@@ -31,24 +31,6 @@ module Bridgetown
       def ==(other)
         other.relative_path.to_s.match(@name_regex)
       end
-
-      def deprecated_equality(other)
-        slug == post_slug(other) &&
-          post_date.year  == other.date.year &&
-          post_date.month == other.date.month &&
-          post_date.day   == other.date.day
-      end
-
-      private
-
-      # Construct the directory-aware post slug for a Bridgetown::Post
-      #
-      # other - the Bridgetown::Post
-      #
-      # Returns the post slug with the subdirectory (relative to _posts)
-      def post_slug(other)
-        other.data.slug
-      end
     end
 
     class PostUrl < Liquid::Tag
@@ -75,19 +57,7 @@ module Bridgetown
         site.collections.posts.resources.each do |document|
           return relative_url(document) if @post == document
 
-          # New matching method did not match, fall back to old method
-          # with deprecation warning if this matches
-          next unless @post.deprecated_equality document
-
-          Bridgetown::Deprecator.deprecation_message(
-            "A call to " \
-            "'{% post_url #{@post.name} %}' did not match " \
-            "a post using the new matching method of checking name " \
-            "(path-date-slug) equality. Please make sure that you " \
-            "change this tag to match the post's name exactly."
-          )
-
-          return relative_url(document)
+          next
         end
 
         raise Bridgetown::Errors::PostURLError, <<~MSG

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

@@ -4,9 +4,9 @@ Bridgetown.initializer :dotenv do |config|
   Bridgetown.load_dotenv root: config.root_dir
 end
 
-Bridgetown.initializer :ssr do |config, setup: nil|
+Bridgetown.initializer :ssr do |config, setup: nil, **options|
   config.roda do |app|
-    app.plugin(:bridgetown_ssr, &setup)
+    app.plugin(:bridgetown_ssr, options, &setup)
   end
 end
 

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

@@ -4,13 +4,11 @@ module Bridgetown
   module Utils
     module RequireGems
       class << self
-        #
         # Require a gem or gems. If it's not present, show a very nice error
         # message that explains everything and is much more helpful than the
         # normal LoadError.
         #
-        # names - a string gem name or array of gem names
-        #
+        # @param names [String, Array<String>] gem name or array of gem names
         def require_with_graceful_fail(names)
           Array(names).each do |name|
             Bridgetown.logger.debug "Requiring:", name.to_s