bridgetown-core 1.0.0 → 1.1.0.beta3

data/lib/bridgetown-core/plugin.rb

@@ -3,55 +3,24 @@
 module Bridgetown
   class Plugin
     extend ActiveSupport::DescendantsTracker
+    include Bridgetown::Prioritizable
 
-    PRIORITIES = {
-      low: -10,
+    self.priorities = {
       highest: 100,
-      lowest: -100,
-      normal: 0,
       high: 10,
+      normal: 0,
+      low: -10,
+      lowest: -100,
     }.freeze
 
     SourceManifest = Struct.new(:origin, :components, :content, :layouts, keyword_init: true)
 
-    # Get or set the priority of this plugin. When called without an
-    # argument it returns the priority. When an argument is given, it will
-    # set the priority.
-    #
-    # priority - The Symbol priority (default: nil). Valid options are:
-    #            :lowest, :low, :normal, :high, :highest
-    #
-    # Returns the Symbol priority.
-    def self.priority(priority = nil)
-      @priority ||= nil
-      @priority = priority if priority && PRIORITIES.key?(priority)
-      @priority || :normal
-    end
-
-    # Spaceship is priority [higher -> lower]
-    #
-    # other - The class to be compared.
-    #
-    # Returns -1, 0, 1.
-    def self.<=>(other)
-      PRIORITIES[other.priority] <=> PRIORITIES[priority]
-    end
-
-    # Spaceship is priority [higher -> lower]
-    #
-    # other - The class to be compared.
-    #
-    # Returns -1, 0, 1.
-    def <=>(other)
-      self.class <=> other.class
-    end
-
     # Initialize a new plugin. This should be overridden by the subclass.
     #
     # config - The Hash of configuration options.
     #
     # Returns a new instance.
-    def initialize(config = {})
+    def initialize(config = {}) # rubocop:disable Style/RedundantInitialize
       # no-op for default
     end
   end

data/lib/bridgetown-core/plugin_manager.rb

@@ -40,7 +40,8 @@ module Bridgetown
       @loaders_manager = Bridgetown::Utils::LoadersManager.new(site.config)
     end
 
-    def self.require_from_bundler
+    def self.require_from_bundler(skip_yarn: false) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # NOTE: investigate why this ENV var is really necessary
       if !ENV["BRIDGETOWN_NO_BUNDLER_REQUIRE"] && File.file?("Gemfile")
         require "bundler"
 
@@ -48,7 +49,7 @@ module Bridgetown
           (dep.groups & [PLUGINS_GROUP]).any? && dep.should_include?
         end
 
-        install_yarn_dependencies(required_gems)
+        install_yarn_dependencies(required_gems) unless skip_yarn
 
         required_gems.each do |installed_gem|
           add_registered_plugin installed_gem

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

@@ -19,6 +19,11 @@ module Bridgetown
       attr_accessor :loaders_manager
     end
 
+    # Start up the Roda Rack application and the Zeitwerk autoloaders. Ensure the
+    # Roda app is provided the preloaded Bridgetown site configuration. Handle
+    # any uncaught Roda errors.
+    #
+    # @param [Bridgetown::Rack::Roda] optional, defaults to the `RodaApp` constant
     def self.boot(roda_app = nil)
       self.loaders_manager =
         Bridgetown::Utils::LoadersManager.new(Bridgetown::Current.preloaded_configuration)
@@ -28,8 +33,8 @@ module Bridgetown
     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 `roda_app.rb'"
+              "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 `roda_app.rb'"
       end
 
       raise e

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

@@ -4,19 +4,29 @@ require "logger"
 
 module Bridgetown
   module Rack
-    class Logger < Logger
+    class Logger < Bridgetown::LogWriter
       def self.message_with_prefix(msg)
-        return if msg.include?("/_bridgetown/live_reload")
+        #        return if msg.include?("/_bridgetown/live_reload")
 
         "\e[35m[Server]\e[0m #{msg}"
       end
 
-      def initialize(*)
-        super
+      def enable_prefix
         @formatter = proc do |_, _, _, msg|
           self.class.message_with_prefix(msg)
         end
       end
+
+      def add(severity, message = nil, progname = nil)
+        return if progname&.include?("/_bridgetown/live_reload")
+
+        super
+      end
+
+      def initialize(*_args)
+        super()
+        enable_prefix
+      end
     end
   end
 end

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

@@ -1,29 +1,67 @@
 # frozen_string_literal: true
 
-require "rack/indifferent"
+begin
+  # If it's in the Gemfile's :bridgetown_plugins group it's already been required, but we'll try
+  # again just to be on the safe side:
+  require "bridgetown-routes"
+rescue LoadError
+end
 
 class Roda
   module RodaPlugins
     module BridgetownSSR
+      module InstanceMethods
+        # Helper shorthand for Bridgetown::Current.site
+        # @return [Bridgetown::Site]
+        def bridgetown_site
+          Bridgetown::Current.site
+        end
+      end
+
       def self.configure(app, _opts = {}, &block)
+        app.include Bridgetown::Filters::URLFilters
         app.opts[:bridgetown_site] =
           Bridgetown::Site.start_ssr!(loaders_manager: Bridgetown::Rack.loaders_manager, &block)
       end
     end
 
     register_plugin :bridgetown_ssr, BridgetownSSR
+
+    module BridgetownBoot
+      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
+        def cookies
+          # TODO: maybe replace with a simpler hash that offers an overloaded `[]` method
+          _previous_roda_cookies.with_indifferent_access
+        end
+
+        # Starts up the Bridgetown routing system
+        def bridgetown
+          Bridgetown::Rack::Routes.start!(scope)
+        end
+      end
+    end
+
+    register_plugin :bridgetown_boot, BridgetownBoot
   end
 end
 
 module Bridgetown
   module Rack
     class Roda < ::Roda
+      SiteContext = Struct.new(:registers) # for use by Liquid-esque URL helpers
+
       plugin :hooks
       plugin :common_logger, Bridgetown::Rack::Logger.new($stdout), method: :info
       plugin :json
       plugin :json_parser
+      plugin :indifferent_params
       plugin :cookies
       plugin :streaming
+      plugin :bridgetown_boot
       plugin :public, root: Bridgetown::Current.preloaded_configuration.destination
       plugin :not_found do
         output_folder = Bridgetown::Current.preloaded_configuration.destination
@@ -31,19 +69,81 @@ module Bridgetown
       rescue Errno::ENOENT
         "404 Not Found"
       end
+      plugin :exception_page
       plugin :error_handler do |e|
-        puts "\n#{e.class} (#{e.message}):\n\n"
-        puts e.backtrace
+        Bridgetown::Errors.print_build_error(
+          e, logger: Bridgetown::LogAdapter.new(self.class.opts[:common_logger])
+        )
+        next exception_page(e) if ENV.fetch("RACK_ENV", nil) == "development"
+
         output_folder = Bridgetown::Current.preloaded_configuration.destination
         File.read(File.join(output_folder, "500.html"))
       rescue Errno::ENOENT
         "500 Internal Server Error"
       end
 
+      ::Roda::RodaPlugins::ExceptionPage.class_eval do
+        def self.css
+          <<~CSS
+            html * { padding:0; margin:0; }
+            body * { padding:10px 20px; }
+            body * * { padding:0; }
+            body { font-family: -apple-system, sans-serif; font-size: 90%; }
+            body>div { border-bottom:1px solid #ddd; }
+            code { font-family: ui-monospace, monospace; }
+            h1 { font-weight: bold; margin-block-end: .8em; }
+            h2 { margin-block-end:.8em; }
+            h2 span { font-size:80%; color:#f7f7db; font-weight:normal; }
+            h3 { margin:1em 0 .5em 0; }
+            h4 { margin:0 0 .5em 0; font-weight: normal; }
+            table {
+                border:1px solid #ccc; border-collapse: collapse; background:white; }
+            tbody td, tbody th { vertical-align:top; padding:2px 3px; }
+            thead th {
+                padding:1px 6px 1px 3px; background:#fefefe; text-align:left;
+                font-weight:normal; font-size:11px; border:1px solid #ddd; }
+            tbody th { text-align:right; opacity: 0.7; padding-right:.5em; }
+            table.vars { margin:5px 0 2px 40px; }
+            table.vars td, table.req td { font-family: ui-monospace, monospace; }
+            table td.code { width:100%;}
+            table td.code div { overflow:hidden; }
+            table.source th { color:#666; }
+            table.source td {
+                font-family: ui-monospace, monospace; white-space:pre; border-bottom:1px solid #eee; }
+            ul.traceback { list-style-type:none; }
+            ul.traceback li.frame { margin-bottom:1em; }
+            div.context { margin: 10px 0; }
+            div.context ol {
+                padding-left:30px; margin:0 10px; list-style-position: inside; }
+            div.context ol li {
+                font-family: ui-monospace, monospace; white-space:pre; color:#666; cursor:pointer; }
+            div.context ol.context-line li { color:black; background-color:#f7f7db; }
+            div.context ol.context-line li span { float: right; }
+            div.commands { margin-left: 40px; }
+            div.commands a { color:black; text-decoration:none; }
+            #summary { background: #1D453C; color: white; }
+            #summary h2 { font-weight: normal; color: white; }
+            #summary ul#quicklinks { list-style-type: none; margin-bottom: 2em; }
+            #summary ul#quicklinks li { float: left; padding: 0 1em; }
+            #summary ul#quicklinks>li+li { border-left: 1px #666 solid; }
+            #summary a { color: #f47c3c; }
+            #explanation { background:#eee; }
+            #traceback { background: white; }
+            #requestinfo { background:#f6f6f6; padding-left:120px; }
+            #summary table { border:none; background:transparent; }
+            #requestinfo h2, #requestinfo h3 { position:relative; margin-left:-100px; }
+            #requestinfo h3 { margin-bottom:-1em; }
+            .error { background: #ffc; }
+            .specific { color:#cc3300; font-weight:bold; }
+          CSS
+        end
+      end
+
       before do
         if self.class.opts[:bridgetown_site]
           # The site had previously been initialized via the bridgetown_ssr plugin
           Bridgetown::Current.site ||= self.class.opts[:bridgetown_site]
+          @context ||= SiteContext.new({ site: self.class.opts[:bridgetown_site] })
         end
         Bridgetown::Current.preloaded_configuration ||=
           self.class.opts[:bridgetown_preloaded_config]
@@ -51,14 +151,11 @@ module Bridgetown
         request.root do
           output_folder = Bridgetown::Current.preloaded_configuration.destination
           File.read(File.join(output_folder, "index.html"))
+        rescue StandardError
+          response.status = 500
+          "<p>ERROR: cannot find <code>index.html</code> in the output folder.</p>"
         end
       end
-
-      # Helper shorthand for Bridgetown::Current.site
-      # @return [Bridgetown::Site]
-      def bridgetown_site
-        Bridgetown::Current.site
-      end
     end
   end
 end

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

@@ -9,19 +9,49 @@ module Bridgetown
     end
 
     class Routes
+      include Bridgetown::Prioritizable
+
+      self.priorities = {
+        highest: "010",
+        high: "020",
+        normal: "030",
+        low: "040",
+        lowest: "050",
+      }.freeze
+
       class << self
-        attr_accessor :tracked_subclasses, :router_block
+        # @return [Hash<String, Class(Routes)>]
+        attr_accessor :tracked_subclasses
+
+        # @return [Proc]
+        attr_accessor :router_block
+
+        # Spaceship is priority [higher -> lower]
+        #
+        # @param other [Class(Routes)] The class to be compared.
+        # @return [Integer] -1, 0, 1.
+        def <=>(other)
+          "#{priorities[priority]}#{self}" <=> "#{priorities[other.priority]}#{other}"
+        end
 
+        # @param base [Class(Routes)]
         def inherited(base)
           Bridgetown::Rack::Routes.track_subclass base
           super
         end
 
+        # @param klass [Class(Routes)]
         def track_subclass(klass)
           Bridgetown::Rack::Routes.tracked_subclasses ||= {}
           Bridgetown::Rack::Routes.tracked_subclasses[klass.name] = klass
         end
 
+        # @return [Array<Class(Routes)>]
+        def sorted_subclasses
+          Bridgetown::Rack::Routes.tracked_subclasses&.values&.sort
+        end
+
+        # @return [void]
         def reload_subclasses
           Bridgetown::Rack::Routes.tracked_subclasses&.each_key do |klassname|
             Kernel.const_get(klassname)
@@ -30,16 +60,38 @@ module Bridgetown
           end
         end
 
+        # Add a router block via the current Routes class
+        #
+        # Example:
+        #
+        #   class Routes::Hello < Bridgetown::Rack::Routes
+        #     route do |r|
+        #       r.get "hello", String do |name|
+        #         { hello: "friend #{name}" }
+        #       end
+        #     end
+        #   end
+        #
+        # @param block [Proc]
         def route(&block)
           self.router_block = block
         end
 
+        # Initialize a new Routes instance and execute the route as part of the
+        # Roda app request cycle
+        #
+        # @param roda_app [Bridgetown::Rack::Roda]
         def merge(roda_app)
           return unless router_block
 
           new(roda_app).handle_routes
         end
 
+        # Start the Roda app request cycle. There are two different code paths
+        # depending on if there's a site `base_path` configured
+        #
+        # @param roda_app [Bridgetown::Rack::Roda]
+        # @return [void]
         def start!(roda_app)
           if Bridgetown::Current.preloaded_configuration.base_path == "/"
             load_all_routes roda_app
@@ -56,6 +108,12 @@ module Bridgetown
           nil
         end
 
+        # Run the Roda public plugin first, set up live reload if allowed, then
+        # run through all the Routes blocks. If the file-based router plugin
+        # is available, kick off that request process next.
+        #
+        # @param roda_app [Bridgetown::Rack::Roda]
+        # @return [void]
         def load_all_routes(roda_app)
           roda_app.request.public
 
@@ -64,7 +122,7 @@ module Bridgetown
             setup_live_reload roda_app
           end
 
-          Bridgetown::Rack::Routes.tracked_subclasses&.each_value do |klass|
+          Bridgetown::Rack::Routes.sorted_subclasses&.each do |klass|
             klass.merge roda_app
           end
 
@@ -73,6 +131,7 @@ module Bridgetown
           Bridgetown::Routes::RodaRouter.start!(roda_app)
         end
 
+        # @param app [Bridgetown::Rack::Roda]
         def setup_live_reload(app) # rubocop:disable Metrics/AbcSize
           sleep_interval = 0.2
           file_to_check = File.join(app.class.opts[:bridgetown_preloaded_config].destination,
@@ -102,14 +161,20 @@ module Bridgetown
         end
       end
 
+      # @param roda_app [Bridgetown::Rack::Roda]
       def initialize(roda_app)
         @_roda_app = roda_app
       end
 
+      # Execute the router block via the instance, passing it the Roda request
+      #
+      # @return [Object] whatever is returned by the router block as expected
+      #   by the Roda API
       def handle_routes
         instance_exec(@_roda_app.request, &self.class.router_block)
       end
 
+      # Any missing methods are passed along to the underlying Roda app if possible
       def method_missing(method_name, *args, **kwargs, &block)
         if @_roda_app.respond_to?(method_name.to_sym)
           @_roda_app.send method_name.to_sym, *args, **kwargs, &block

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

@@ -7,6 +7,7 @@ module Bridgetown
       include Bridgetown::Publishable
       include Bridgetown::LayoutPlaceable
       include Bridgetown::LiquidRenderable
+      include Bridgetown::Localizable
 
       # @return [HashWithDotAccess::Hash]
       attr_reader :data
@@ -180,6 +181,11 @@ module Bridgetown
         model.origin.id
       end
 
+      # @return [String]
+      def output_ext
+        destination&.output_ext
+      end
+
       def date
         data["date"] ||= site.time
       end
@@ -210,10 +216,7 @@ module Bridgetown
       def requires_destination?
         collection.write? && data.config&.output != false
       end
-
-      def write?
-        requires_destination? && site.publisher.publish?(self)
-      end
+      alias_method :write?, :requires_destination?
 
       # Write the generated Document file to the destination directory.
       #
@@ -295,7 +298,7 @@ module Bridgetown
 
       private
 
-      def ensure_default_data # rubocop:todo Metrics/AbcSize
+      def ensure_default_data
         determine_locale
 
         slug = if matches = relative_path.to_s.match(DATE_FILENAME_MATCHER) # rubocop:disable Lint/AssignmentInCondition
@@ -305,7 +308,7 @@ module Bridgetown
                  basename_without_ext
                end
 
-        slug.chomp!(".#{data.locale}") if data.locale && slug.ends_with?(".#{data.locale}")
+        Bridgetown::Utils.chomp_locale_suffix!(slug, data.locale)
 
         data.slug ||= slug
         data.title ||= Bridgetown::Utils.titleize_slug(slug)

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

@@ -12,6 +12,7 @@ module Bridgetown
       # @param resource [Bridgetown::Resource::Base]
       def initialize(resource)
         @resource = resource
+        warn_on_rails_style_extension
         @output_ext = resource.transformer.final_ext
       end
 
@@ -46,6 +47,23 @@ module Bridgetown
         Bridgetown.logger.debug "Writing:", path
         File.write(path, output, mode: "wb")
       end
+
+      private
+
+      def warn_on_rails_style_extension
+        return unless resource.relative_path.fnmatch?("*.{html,json,js}.*", File::FNM_EXTGLOB)
+
+        Bridgetown.logger.warn("Uh oh!", "You're using a Rails-style filename extension in:")
+        Bridgetown.logger.warn("", resource.relative_path)
+        Bridgetown.logger.warn(
+          "", "Instead, you can use either the desired output file extension or set a permalink."
+        )
+        Bridgetown.logger.warn(
+          "For more info:",
+          "https://www.bridgetownrb.com/docs/template-engines/erb-and-beyond#extensions-and-permalinks"
+        )
+        Bridgetown.logger.warn("")
+      end
     end
   end
 end

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

@@ -113,9 +113,8 @@ module Bridgetown
             if resource.site.config["collections_dir"].present?
               path.delete_prefix! "#{resource.site.config["collections_dir"]}/"
             end
-            if resource.data.locale && path.ends_with?(".#{resource.data.locale}")
-              path.chomp!(".#{resource.data.locale}")
-            end
+
+            Bridgetown::Utils.chomp_locale_suffix!(path, resource.data.locale)
           end,
         }
       end
@@ -137,7 +136,10 @@ module Bridgetown
 
       # @param resource [Bridgetown::Resource::Base]
       register_placeholder :locale, ->(resource) do
-        next nil if resource.data.locale&.to_sym == resource.site.config.default_locale
+        if !resource.site.config.prefix_default_locale &&
+            resource.data.locale&.to_sym == resource.site.config.default_locale
+          next nil
+        end
 
         locale_data = resource.data.locale&.to_sym
         resource.site.config.available_locales.include?(locale_data) ? locale_data.to_s : nil

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

@@ -68,7 +68,7 @@ module Bridgetown
       # @return [String]
       def kind_of_relation_for_type(type)
         relation_schema&.each do |relation_type, collections|
-          collections = Array(collections).yield_self do |collections_arr|
+          collections = Array(collections).then do |collections_arr|
             collections_arr +
               collections_arr.map { |item| ActiveSupport::Inflector.pluralize(item) }
           end.flatten.uniq

data/lib/bridgetown-core/ruby_template_view.rb

@@ -22,16 +22,16 @@ module Bridgetown
       @site = page.site
     end
 
-    def partial(_partial_name, _options = {})
+    def partial(_partial_name = nil, **_options)
       raise "Must be implemented in a subclass"
     end
 
-    def render(item, options = {}, &block)
+    def render(item, **options, &block)
       if item.respond_to?(:render_in)
         result = item.render_in(self, &block)
         result&.html_safe
       else
-        partial(item, options, &block)&.html_safe
+        partial(item, **options, &block)&.html_safe
       end
     end
 

data/lib/bridgetown-core/static_file.rb

@@ -108,7 +108,7 @@ module Bridgetown
       self.class.mtimes[path] = mtime
 
       FileUtils.mkdir_p(File.dirname(dest_path))
-      FileUtils.rm(dest_path) if File.exist?(dest_path)
+      FileUtils.rm_rf(dest_path)
       Bridgetown.logger.debug "Saving file:", dest_path
       copy_file(dest_path)
 

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

@@ -88,7 +88,7 @@ module Bridgetown
           "class=\"language-#{@lang.to_s.tr("+", "-")}\"",
           "data-lang=\"#{@lang}\"",
         ].join(" ")
-        "<figure class=\"highlight\"><pre><code #{code_attributes}>"\
+        "<figure class=\"highlight\"><pre><code #{code_attributes}>" \
           "#{code.chomp}</code></pre></figure>"
       end
     end

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

@@ -80,7 +80,7 @@ module Bridgetown
           next unless @post.deprecated_equality document
 
           Bridgetown::Deprecator.deprecation_message(
-            "A call to "\
+            "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 " \

data/lib/bridgetown-core/url.rb

@@ -100,7 +100,7 @@ module Bridgetown
         winner = pool.find { |key| @placeholders.key?(key) }
         if winner.nil?
           raise NoMethodError,
-                "The URL template doesn't have #{pool.join(" or ")} keys. "\
+                "The URL template doesn't have #{pool.join(" or ")} keys. " \
                 "Check your permalink template!"
         end
 

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

@@ -20,7 +20,8 @@ module Bridgetown
       def self.run_process(name, color, cmd)
         Thread.new do
           rd, wr = IO.pipe("BINARY")
-          pid = Process.spawn(cmd, out: wr, err: wr, pgroup: true)
+          pid = Process.spawn({ "BRIDGETOWN_NO_BUNDLER_REQUIRE" => nil },
+                              cmd, out: wr, err: wr, pgroup: true)
           @mutex.synchronize do
             add_pid pid
           end

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

@@ -41,15 +41,12 @@ module Bridgetown
             require name
           rescue LoadError => e
             Bridgetown.logger.error "Dependency Error:", <<~MSG
-              Yikes! It looks like you don't have #{name} or one of its dependencies installed.
-              In order to use Bridgetown as currently configured, you'll need to install this gem.
+              Oops! It looks like you don't have #{name} or one of its dependencies installed.
+              Please double-check you've added #{name} to your Gemfile.
 
-              If you've run Bridgetown with `bundle exec`, ensure that you have included the #{name}
-              gem in your Gemfile as well.
+              If you're stuck, you can find help at https://www.bridgetownrb.com/community
 
               The full error message from Ruby is: '#{e.message}'
-
-              If you run into trouble, you can find helpful resources at https://www.bridgetownrb.com/docs/community/
             MSG
             raise Bridgetown::Errors::MissingDependencyException, name
           end