bridgetown-core 1.0.0 → 1.1.0.beta3

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

@@ -13,6 +13,9 @@ module Bridgetown
       end
 
       desc "list", "List information about installed plugins"
+      option :verbose,
+             type: :boolean,
+             desc: "Print the source path of each plugin"
       def list
         site = Bridgetown::Site.new(configuration_with_overrides(options))
         site.reset
@@ -32,7 +35,7 @@ module Bridgetown
           end
         end
 
-        Bridgetown.logger.info("Source Manifests:", "---") unless pm.class.source_manifests.empty?
+        Bridgetown.logger.info("Source Manifests:", "----") unless pm.class.source_manifests.empty?
 
         pm.class.source_manifests.each do |manifest|
           Bridgetown.logger.info("Origin:", (manifest.origin || "n/a").to_s.green)
@@ -40,20 +43,27 @@ module Bridgetown
           Bridgetown.logger.info("Content:", (manifest.content || "n/a").to_s.cyan)
           Bridgetown.logger.info("Layouts:", (manifest.layouts || "n/a").to_s.cyan)
 
-          Bridgetown.logger.info("", "---")
+          Bridgetown.logger.info("", "----")
         end
 
         unless Bridgetown.autoload? :Builder
           builders = Bridgetown::Builder.descendants
           Bridgetown.logger.info("Builders:", builders.length.to_s.yellow.bold)
 
-          builders.each do |builder|
-            name = builder.respond_to?(:custom_name) ? builder.custom_name : builder.name
+          builders.sort.each do |builder|
+            name = plugin_name_for(builder)
             name_components = name.split("::")
             last_name = name_components.pop
             name_components.push last_name.magenta
             Bridgetown.logger.info("", name_components.join("::"))
+            next unless options[:verbose]
+
+            Bridgetown.logger.info(
+              "", "PATH: " + builder_path_for(builder)
+            )
+            Bridgetown.logger.info("")
           end
+          Bridgetown.logger.info("", "----")
         end
 
         Bridgetown.logger.info("Converters:", site.converters.length.to_s.yellow.bold)
@@ -64,8 +74,16 @@ module Bridgetown
           last_name = name_components.pop
           name_components.push last_name.magenta
           Bridgetown.logger.info("", name_components.join("::"))
+          next unless options[:verbose]
+
+          Bridgetown.logger.info(
+            "", "PATH: " + converter_path_for(converter)
+          )
+          Bridgetown.logger.info("")
         end
 
+        Bridgetown.logger.info("", "----")
+
         Bridgetown.logger.info("Generators:", site.generators.length.to_s.yellow.bold)
 
         site.generators.each do |generator|
@@ -74,6 +92,12 @@ module Bridgetown
           last_name = name_components.pop
           name_components.push last_name.magenta
           Bridgetown.logger.info("", name_components.join("::"))
+          next unless options[:verbose]
+
+          Bridgetown.logger.info(
+            "", "PATH: " + generator_path_for(generator)
+          )
+          Bridgetown.logger.info("")
         end
       end
 
@@ -120,6 +144,7 @@ module Bridgetown
                                  " return to your site root.")
           puts
 
+          # rubocop: disable Style/RedundantCondition
           Dir.chdir dir do
             ENV["BRIDGETOWN_SITE"] = site.root_dir
             if ENV["SHELL"]
@@ -128,6 +153,7 @@ module Bridgetown
               system("/bin/sh")
             end
           end
+          # rubocop: enable Style/RedundantCondition
 
           puts
           Bridgetown.logger.info("Done!", "You're back in #{Dir.pwd.green}")
@@ -194,11 +220,23 @@ module Bridgetown
       protected
 
       def plugin_name_for(plugin)
-        if plugin.class.respond_to?(:custom_name)
-          plugin.class.custom_name
-        else
-          plugin.class.name
-        end
+        klass = plugin.is_a?(Class) ? plugin : plugin.class
+        klass.respond_to?(:custom_name) ? klass.custom_name : klass.name
+      end
+
+      def builder_path_for(plugin)
+        klass = plugin.is_a?(Class) ? plugin : plugin.class
+        klass.instance_method(:build).source_location[0]
+      end
+
+      def converter_path_for(plugin)
+        klass = plugin.is_a?(Class) ? plugin : plugin.class
+        klass.instance_method(:convert).source_location[0]
+      end
+
+      def generator_path_for(plugin)
+        klass = plugin.is_a?(Class) ? plugin : plugin.class
+        klass.instance_method(:generate).source_location[0]
       end
     end
   end

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

@@ -4,12 +4,11 @@ module Bridgetown
   module Commands
     module Registrations
       def self.registrations
-        @registrations || []
+        @registrations ||= []
       end
 
       def self.register(&block)
-        @registrations ||= []
-        @registrations.push(block)
+        registrations << block
       end
     end
   end

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

@@ -178,8 +178,8 @@ module Bridgetown
 
           Process.detach(pid)
           Bridgetown.logger.info "Server detached with pid '#{pid}'.", \
-                                 "Run `pkill -f bridgetown' or `kill -9 #{pid}'" \
-                                 " to stop the server."
+                                 "Run `pkill -f bridgetown' or `kill -9 #{pid}' " \
+                                 "to stop the server."
         else
           t = Thread.new { server.start }
           trap("INT") { server.shutdown }

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

@@ -70,6 +70,9 @@ module Bridgetown
             end
 
             cli = Puma::CLI.new puma_args
+            cli.launcher.events.on_stopped do
+              Bridgetown::Hooks.trigger :site, :server_shutdown
+            end
             cli.run
           end
 

data/lib/bridgetown-core/commands/webpack/update.rb

@@ -7,11 +7,11 @@ say "🎉 Webpack configuration updated successfully!"
 
 return if Bridgetown.environment.test?
 
-required_packages = %w(esbuild esbuild-loader webpack@5.39.1 webpack-cli@4.7.2 webpack-manifest-plugin@3.1.1)
-redundant_packages = %w(@babel/core @babel/plugin-proposal-class-properties @babel/plugin-proposal-decorators @babel/plugin-transform-runtime @babel/preset-env babel-loader)
+required_packages = %w(esbuild esbuild-loader css-loader@6.7.1 webpack@5.72.0 webpack-cli@4.9.2 webpack-manifest-plugin@5.0.0)
+redundant_packages = %w(@babel/core @babel/plugin-proposal-class-properties @babel/plugin-proposal-decorators @babel/plugin-transform-runtime @babel/preset-env babel-loader file-loader)
 
 say "Installing required packages"
-run "yarn add -D #{required_packages.join(" ")}"
+run "yarn add -D --tilde #{required_packages.join(" ")}"
 
 packages_to_remove = package_json["devDependencies"].slice(*redundant_packages).keys
 unless packages_to_remove.empty?

data/lib/bridgetown-core/commands/webpack/webpack.defaults.js.erb

@@ -41,7 +41,9 @@ const cssRules = {
     {
       loader: "css-loader",
       options: {
-        url: url => !url.startsWith('/'),
+        url: {
+          filter: url => !url.startsWith('/')
+        },
         importLoaders: 1
       }
     }
@@ -49,7 +51,14 @@ const cssRules = {
   mode: '<%= self.config.uses_postcss? ? "postcss" : "sass" %>',
 
   postcss: () => {
-    cssRules.use.push("postcss-loader")
+    cssRules.use.push({
+      loader: "postcss-loader",
+      options: {
+        postcssOptions: {
+          config: "postcss.config.js"
+        }
+      }
+    })
     return { test: cssRules.test, use: cssRules.use }
   },
 
@@ -72,22 +81,18 @@ const cssRules = {
 
 const fontsRule = {
   test: /\.woff2?$|\.ttf$|\.eot$/,
-  loader: "file-loader",
-  options: {
-    name: "[name]-[contenthash].[ext]",
-    outputPath: "../fonts",
-    publicPath: "../fonts",
-  },
+  type: "asset/resource",
+  generator: {
+    filename: "../fonts/[name]-[hash][ext][query]"
+  }
 }
 
 const imagesRule = {
   test: /\.png?$|\.gif$|\.jpg$|\.svg$/,
-  loader: "file-loader",
-  options: {
-    name: "[path][name]-[contenthash].[ext]",
-    outputPath: "../",
-    publicPath: "../",
-  },
+  type: "asset/resource",
+  generator: {
+    filename: "../[path][name]-[hash][ext][query]"
+  }
 }
 
 // Default configuration object

data/lib/bridgetown-core/component.rb

@@ -4,7 +4,7 @@ module Bridgetown
   class Component
     extend Forwardable
 
-    def_delegators :@view_context, :helpers, :liquid_render, :partial
+    def_delegators :@view_context, :liquid_render, :partial
 
     # @return [Bridgetown::Site]
     attr_reader :site # will be nil unless you explicitly set a `@site` ivar
@@ -32,14 +32,12 @@ module Bridgetown
       def renderer_for_ext(ext, &block)
         @_tmpl ||= case ext.to_s
                    when "erb"
-                     include ERBCapture
                      Tilt::ErubiTemplate.new(component_template_path,
                                              outvar: "@_erbout",
                                              bufval: "Bridgetown::OutputBuffer.new",
                                              engine_class: Bridgetown::ERBEngine,
                                              &block)
-                   when "serb" # requires serbea
-                     include Serbea::Helpers
+                   when "serb"
                      Tilt::SerbeaTemplate.new(component_template_path, &block)
                    when "slim" # requires bridgetown-slim
                      Slim::Template.new(component_template_path, &block)
@@ -138,7 +136,7 @@ module Bridgetown
       end
     rescue StandardError => e
       Bridgetown.logger.error "Component error:",
-                              "#{self.class} encountered an error while "\
+                              "#{self.class} encountered an error while " \
                               "rendering `#{self.class.path_for_errors}'"
       raise e
     end
@@ -166,12 +164,20 @@ module Bridgetown
     def _renderer
       @_renderer ||= begin
         ext = File.extname(self.class.component_template_path).delete_prefix(".")
-        self.class.renderer_for_ext(ext) { self.class.component_template_content }
+        self.class.renderer_for_ext(ext) { self.class.component_template_content }.tap do |rn|
+          self.class.include(rn.is_a?(Tilt::SerbeaTemplate) ? Serbea::Helpers : ERBCapture)
+        end
       end
     end
 
+    def helpers
+      @helpers ||= Bridgetown::RubyTemplateView::Helpers.new(
+        self, view_context&.site || Bridgetown::Current.site
+      )
+    end
+
     def method_missing(method, *args, **kwargs, &block)
-      if view_context && helpers.respond_to?(method.to_sym)
+      if helpers.respond_to?(method.to_sym)
         helpers.send method.to_sym, *args, **kwargs, &block
       else
         super
@@ -179,7 +185,7 @@ module Bridgetown
     end
 
     def respond_to_missing?(method, include_private = false)
-      (view_context && helpers.respond_to?(method.to_sym, include_private)) || super
+      helpers.respond_to?(method.to_sym, include_private) || super
     end
   end
 end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Localizable
+    def all_locales
+      result_set = case self
+                   when Bridgetown::Resource::Base
+                     collection.resources
+                   when Bridgetown::GeneratedPage
+                     site.generated_pages
+                   else
+                     []
+                   end
+
+      result_set.select { |item| item.data.slug == data.slug }.sort_by do |item|
+        site.config.available_locales.index item.data.locale
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Prioritizable
+    module ClassMethods
+      # @!method priorities
+      #   @return [Hash<Symbol, Object>]
+
+      # Get or set the priority of this class. When called without an
+      # argument it returns the priority. When an argument is given, it will
+      # set the priority.
+      #
+      # @param priority [Symbol] new priority (optional)
+      #   Valid options are: `:lowest`, `:low`, `:normal`, `:high`, `:highest`
+      # @return [Symbol]
+      def priority(priority = nil)
+        @priority ||= nil
+        @priority = priority if priority && priorities.key?(priority)
+        @priority || :normal
+      end
+
+      # Spaceship is priority [higher -> lower]
+      #
+      # @param other [Class] The class to be compared.
+      # @return [Integer] -1, 0, 1.
+      def <=>(other)
+        priorities[other.priority] <=> priorities[priority]
+      end
+    end
+
+    def self.included(klass)
+      klass.extend ClassMethods
+      klass.class_attribute :priorities, instance_accessor: false
+    end
+
+    # Spaceship is priority [higher -> lower]
+    #
+    # @param other [object] The object to be compared.
+    # @return [Integer] -1, 0, 1.
+    def <=>(other)
+      self.class <=> other.class
+    end
+  end
+end

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

@@ -2,9 +2,19 @@
 
 module Bridgetown
   module Publishable
-    # Whether the file is published or not, as indicated in YAML front-matter
+    # Whether the resource is published or not, as indicated in YAML front-matter
     def published?
       !(data.key?("published") && data["published"] == false)
     end
+
+    def publishable?
+      return true if collection.data?
+      return false unless published? || @site.config.unpublished
+
+      future_allowed = collection.metadata.future || @site.config.future
+      this_time = date.is_a?(Date) ? date.to_time.to_i : date.to_i
+
+      future_allowed || this_time <= @site.time.to_i
+    end
   end
 end

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

@@ -38,7 +38,7 @@ class Bridgetown::Site
     # @param strip_slash_only [Boolean] set to true if you wish "/" to be returned as ""
     # @return [String]
     def base_path(strip_slash_only: false)
-      (config[:base_path] || config[:baseurl]).yield_self do |path|
+      (config[:base_path] || config[:baseurl]).then do |path|
         strip_slash_only ? path.to_s.sub(%r{^/$}, "") : path
       end
     end
@@ -61,14 +61,6 @@ class Bridgetown::Site
       @frontmatter_defaults ||= Bridgetown::FrontmatterDefaults.new(self)
     end
 
-    # Returns the current instance of {Publisher} or creates a new instance of
-    #   {Publisher} if one doesn't exist.
-    #
-    # @return [Publisher] Returns an instance of {Publisher}
-    def publisher
-      @publisher ||= Bridgetown::Publisher.new(self)
-    end
-
     # Prefix a path or paths with the {#root_dir} directory.
     #
     # @see Bridgetown.sanitized_path
@@ -166,7 +158,7 @@ class Bridgetown::Site
       plugin_components_load_paths = Bridgetown::PluginManager.source_manifests
         .filter_map(&:components)
 
-      local_components_load_paths = config["components_dir"].yield_self do |dir|
+      local_components_load_paths = config["components_dir"].then do |dir|
         dir.is_a?(Array) ? dir : [dir]
       end
       local_components_load_paths.map! do |dir|

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

@@ -7,11 +7,15 @@ class Bridgetown::Site
     def locale
       @locale ||= begin
         locale = ENV.fetch("BRIDGETOWN_LOCALE", config[:default_locale]).to_sym
-        Dir["#{in_source_dir("_locales")}/*.yml"].each do |locale_path|
+        Dir["#{in_source_dir("_locales")}/*.{json,rb,yml}"].each do |locale_path|
           I18n.load_path << locale_path
         end
         I18n.available_locales = config[:available_locales]
         I18n.default_locale = locale
+        I18n.fallbacks = (config[:available_locales] + [:en]).uniq.to_h do |available_locale|
+          [available_locale, [available_locale, locale, :en].uniq]
+        end
+        locale
       end
     end
 

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

@@ -32,7 +32,7 @@ class Bridgetown::Site
       @ssr_enabled = true
     end
 
-    def ssr_setup
+    def ssr_setup(&block)
       config.serving = true
       Bridgetown::Hooks.trigger :site, :pre_read, self
       defaults_reader.tap do |d|
@@ -46,10 +46,10 @@ class Bridgetown::Site
       end
       Bridgetown::Hooks.trigger :site, :post_read, self
 
-      yield self if block_given? # provide additional setup hook
+      block&.call(self) # provide additional setup hook
       return if Bridgetown.env.production?
 
-      Bridgetown::Watcher.watch(self, config)
+      Bridgetown::Watcher.watch(self, config, &block)
     end
 
     def disable_ssr

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

@@ -14,6 +14,8 @@ class Bridgetown::Site
     # @return [void]
     def write
       each_site_file { |item| item.write(dest) }
+      write_redirecting_index if config.prefix_default_locale
+
       Bridgetown::Hooks.trigger :site, :post_write, self
     end
 
@@ -40,5 +42,31 @@ class Bridgetown::Site
         }
       end
     end
+
+    def write_redirecting_index
+      resource = resources.find do |item|
+        item.data.slug == "index" && item.data.locale == config.default_locale
+      end
+
+      unless resource
+        Bridgetown.logger.warn(
+          "Index file not found in the source folder, cannot generate top-level redirect file"
+        )
+        return
+      end
+
+      index_html = <<~HTML
+        <!DOCTYPE html>
+        <html>
+          <head>
+            <title>Redirecting…</title>
+            <meta http-equiv="refresh" content="0; url=#{resource.relative_url}" />
+          </head>
+          <body></body>
+        </html>
+      HTML
+
+      File.write(in_dest_dir("index.html"), index_html, mode: "wb")
+    end
   end
 end

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

@@ -23,7 +23,7 @@ module Bridgetown
         output.html_safe
       rescue StandardError => e
         Bridgetown.logger.error "Conversion error:",
-                                "#{converter.class} encountered an error while "\
+                                "#{converter.class} encountered an error while " \
                                 "converting `#{document.relative_path}'"
         raise e
       end
@@ -53,7 +53,7 @@ module Bridgetown
         layout_output
       rescue StandardError => e
         Bridgetown.logger.error "Conversion error:",
-                                "#{converter.class} encountered an error while "\
+                                "#{converter.class} encountered an error while " \
                                 "converting `#{document.relative_path}'"
         raise e
       end

data/lib/bridgetown-core/configuration.rb

@@ -59,6 +59,7 @@ module Bridgetown
       # Output Configuration
       "available_locales"          => [:en],
       "default_locale"             => :en,
+      "prefix_default_locale"      => false,
       "permalink"                  => nil, # default is set according to content engine
       "timezone"                   => nil, # use the local timezone
 
@@ -83,6 +84,7 @@ module Bridgetown
         "footnote_nr"             => 1,
         "show_warnings"           => false,
         "include_extraction_tags" => false,
+        "mark_highlighting"       => true,
       },
     }.each_with_object(Configuration.new) { |(k, v), hsh| hsh[k] = v.freeze }.freeze
 
@@ -206,8 +208,8 @@ module Bridgetown
           config = Utils.deep_merge_hashes(self, new_config)
         end
       rescue ArgumentError => e
-        Bridgetown.logger.warn "WARNING:", "Error reading configuration. Using defaults" \
-                                           " (and options)."
+        Bridgetown.logger.warn "WARNING:", "Error reading configuration. Using defaults " \
+                                           "(and options)."
         warn e
       end
 

data/lib/bridgetown-core/configurations/bt-postcss/postcss.config.js

@@ -1,8 +1,10 @@
 module.exports = {
   plugins: {
-    'postcss-easy-import': {},
     'postcss-mixins': {},
-    'postcss-color-function': {},
+    'postcss-color-mod-function': {
+      // Uncomment the following to import CSS variables for use in `color-mod`:
+      // importFrom: "frontend/styles/variables.css"
+    },
     'postcss-flexbugs-fixes': {},
     'postcss-preset-env': {
       autoprefixer: {
@@ -14,7 +16,7 @@ module.exports = {
         'custom-media-queries': true
       },
     },
-    'cssnano' : {
+    'cssnano': {
       preset: 'default'
     }
   }

data/lib/bridgetown-core/configurations/bt-postcss.rb

@@ -14,7 +14,7 @@ end
 confirm = ask "This configuration will ovewrite your existing #{"postcss.config.js".bold.white}. Would you like to continue? [Yn]"
 return unless confirm.casecmp?("Y")
 
-plugins = %w(postcss-easy-import postcss-mixins postcss-color-function cssnano)
+plugins = %w(postcss-mixins postcss-color-mod-function cssnano)
 
 say "Adding the following PostCSS plugins: #{plugins.join(' | ')}", :green
 run "yarn add -D #{plugins.join(' ')}"

data/lib/bridgetown-core/configurations/lit/esbuild-plugins.js

@@ -0,0 +1,21 @@
+// You can add "full-stack" esbuild plugins here that you wish to share between
+// the frontend bundles and Lit SSR. Just import your plugins and add them and
+// any additional configuration to the `plugins` array below.
+
+// This plugin will let you import `.lit.css` files as sidecar stylesheets.
+// Read https://edge.bridgetownrb.com/docs/components/lit#sidecar-css-files for documentation.
+const { litCssPlugin } = require("esbuild-plugin-lit-css")
+const postCssConfig = require("postcss-load-config").sync()
+const postCssProcessor = require("postcss")([...postCssConfig.plugins])
+
+module.exports = {
+  plugins: [
+    litCssPlugin({
+      filter: /\.lit\.css$/,
+      transform: async (css, { filePath }) => {
+        const results = await postCssProcessor.process(css, { ...postCssConfig.options, from: filePath })
+        return results.css
+      }
+    }),
+  ]
+}

data/lib/bridgetown-core/configurations/lit/happy-days.lit.js

@@ -0,0 +1,26 @@
+import { LitElement, html, css } from "lit"
+
+export class HappyDaysElement extends LitElement {
+  static styles = css`
+    :host {
+      display: block;
+      border: 2px dashed gray;
+      padding: 20px;
+      max-width: 300px;
+    }
+  `
+
+  static properties = {
+    hello: { type: String }
+  }
+
+  render() {
+    return html`
+      <p>Hello ${this.hello}! ${Date.now()}</p>
+    `;
+  }
+}
+
+// Try adding `<%= lit :happy_days, hello: "there" %>` somewhere in an ERB template
+// on your site to see this example Lit component in action!
+customElements.define("happy-days", HappyDaysElement)

data/lib/bridgetown-core/configurations/lit/lit-components-entry.js

@@ -0,0 +1 @@
+import components from "bridgetownComponents/**/*.{lit.js,lit.js.rb}"

data/lib/bridgetown-core/configurations/lit/lit-ssr.config.js

@@ -0,0 +1,6 @@
+const build = require("bridgetown-lit-renderer/build")
+const { plugins } = require("./esbuild-plugins.js")
+
+const esbuildOptions = { plugins }
+
+build(esbuildOptions)