bridgetown-core 1.0.0.beta2 → 1.1.0.beta1

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/renderable.rb

@@ -10,7 +10,7 @@ class Bridgetown::Site
       Bridgetown::Hooks.trigger :site, :pre_render, self
       execute_inline_ruby_for_layouts!
       render_resources
-      render_generated_pages
+      generated_pages.each(&:transform!)
       Bridgetown::Hooks.trigger :site, :post_render, self
     end
 
@@ -46,6 +46,32 @@ class Bridgetown::Site
       matches
     end
 
+    # @return [Array<Bridgetown::Layout>]
+    def validated_layouts_for(convertible, layout_name)
+      layout = layouts[layout_name]
+      warn_on_missing_layout convertible, layout, layout_name
+
+      layout_list = Set.new([layout])
+      while layout
+        layout_name = layout.data.layout
+        layout = layouts[layout_name]
+        warn_on_missing_layout convertible, layout, layout_name
+
+        layout_list << layout
+      end
+
+      layout_list.to_a.compact
+    end
+
+    def warn_on_missing_layout(convertible, layout, layout_name)
+      return unless layout.nil? && layout_name
+
+      Bridgetown.logger.warn(
+        "Build Warning:",
+        "Layout '#{layout_name}' requested via #{convertible.relative_path} does not exist."
+      )
+    end
+
     # Renders all resources
     # @return [void]
     def render_resources
@@ -58,14 +84,6 @@ class Bridgetown::Site
       end
     end
 
-    # Renders all generated pages
-    # @return [void]
-    def render_generated_pages
-      generated_pages.each do |page|
-        render_page page
-      end
-    end
-
     # Renders a content item while ensuring site locale is set if the data is available.
     # @param item [Document, Page, Bridgetown::Resource::Base] The item to render
     # @yield Runs the block in between locale setting and resetting
@@ -80,12 +98,5 @@ class Bridgetown::Site
         yield
       end
     end
-
-    # Regenerates a content item using {Renderer}
-    # @param item [Page] The page to render
-    # @return [void]
-    def render_page(page)
-      Bridgetown::Renderer.new(self, page).run
-    end
   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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Transformable
+    # Transforms an input document by running it through available converters
+    # (requires a `converter` method to be present on the including class)
+    #
+    # @param document [Bridgetown::GeneratedPage, Bridgetown::Resource::Base]
+    # @return String
+    # @yieldparam converter [Bridgetown::Converter]
+    # @yieldparam index [Integer] index of the conversion step
+    # @yieldparam output [String]
+    def transform_content(document)
+      converters.each_with_index.inject(document.content.to_s) do |content, (converter, index)|
+        output = if converter.method(:convert).arity == 1
+                   converter.convert content
+                 else
+                   converter.convert content, document
+                 end
+
+        yield converter, index, output if block_given?
+
+        output.html_safe
+      rescue StandardError => e
+        Bridgetown.logger.error "Conversion error:",
+                                "#{converter.class} encountered an error while "\
+                                "converting `#{document.relative_path}'"
+        raise e
+      end
+    end
+
+    # Transforms an input document by placing it within the specified layout
+    #
+    # @param layout [Bridgetown::Layout]
+    # @param output [String] the output from document content conversions
+    # @param document [Bridgetown::GeneratedPage, Bridgetown::Resource::Base]
+    # @return String
+    # @yieldparam converter [Bridgetown::Converter]
+    # @yieldparam layout_output [String]
+    def transform_with_layout(layout, output, document)
+      layout_converters = site.matched_converters_for_convertible(layout)
+      layout_input = layout.content.dup
+
+      layout_converters.inject(layout_input) do |content, converter|
+        next(content) unless [2, -2].include?(converter.method(:convert).arity) # rubocop:disable Performance/CollectionLiteralInLoop
+
+        layout.current_document = document
+        layout.current_document_output = output
+        layout_output = converter.convert content, layout
+
+        yield converter, layout_output if block_given?
+
+        layout_output
+      rescue StandardError => e
+        Bridgetown.logger.error "Conversion error:",
+                                "#{converter.class} encountered an error while "\
+                                "converting `#{document.relative_path}'"
+        raise e
+      end
+    end
+  end
+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
 

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/gh-pages/gh-pages.yml

@@ -0,0 +1,33 @@
+name: Deploy to GitHub pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: "16"
+          cache: "yarn"
+      - run: yarn install
+
+      - name: Build
+        run: bin/bridgetown deploy
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./output

data/lib/bridgetown-core/configurations/gh-pages.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+`bundle lock --add-platform x86_64-linux`
+copy_file in_templates_dir("gh-pages.yml"), ".github/workflows/gh-pages.yml"
+
+# rubocop:disable Layout/LineLength
+say "🎉 A GitHub action to deploy your site to GitHub pages has been configured!"
+say ""
+
+say "🛠️  After pushing the action, go to your repository settings and configure GitHub Pages to deploy from the branch `gh-pages`."
+say ""
+
+say "You'll likely also need to set `base_path` in your `bridgetown.config.yml` to your repository's name. If you do this you'll need to use the `relative_url` helper for all links and assets in your HTML."
+say "If you're using esbuild for frontend assets, edit `esbuild.config.js` to update `publicPath`."
+say ""
+# rubocop:enable Layout/LineLength

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)

data/lib/bridgetown-core/configurations/lit.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+unless Bridgetown::Utils.frontend_bundler_type == :esbuild
+  error_message = "#{"esbuild.config.js".bold} not found. (This configuration doesn't currently " \
+                  "support Webpack.)"
+
+  @logger.error "\nError:".red, "🚨 #{error_message}"
+
+  return
+end
+
+say_status :lit, "Installing Lit + SSR Plugin..."
+
+add_bridgetown_plugin "bridgetown-lit-renderer", version: "2.0.0.beta3"
+
+run "yarn add lit esbuild-plugin-lit-css bridgetown-lit-renderer@2.0.0-beta3"
+
+copy_file in_templates_dir("lit-ssr.config.js"), "config/lit-ssr.config.js"
+copy_file in_templates_dir("lit-components-entry.js"), "config/lit-components-entry.js"
+copy_file in_templates_dir("esbuild-plugins.js"), "config/esbuild-plugins.js"
+
+insert_into_file "esbuild.config.js",
+                 after: 'const build = require("./config/esbuild.defaults.js")' do
+  <<~JS
+
+    const { plugins } = require("./config/esbuild-plugins.js")
+  JS
+end
+
+found_match = false
+gsub_file "esbuild.config.js", %r{const esbuildOptions = {}\n} do |_match|
+  found_match = true
+
+  <<~JS
+    const esbuildOptions = {
+      plugins: [...plugins],
+      // Uncomment the following to opt into `.global.css` & `.lit.css` nomenclature.
+      // Read https://edge.bridgetownrb.com/docs/components/lit#sidecar-css-files for documentation.
+      /*
+      postCssPluginConfig: {
+        filter: /(?:index|\.global)\.css$/,
+      },
+      */
+    }
+  JS
+end
+
+unless found_match
+  insert_into_file "esbuild.config.js",
+                   after: 'const { plugins } = require("./config/esbuild-plugins.js")' do
+    <<~JS
+
+      // TODO: You will manually need to move any plugins below you wish to share with
+      // Lit SSR into the `config/esbuild-plugins.js` file.
+      // Then add `...plugins` as an item in your plugins array.
+      //
+      // You might also want to include the following in your esbuild config to opt into
+      // `.global.css` & `.lit.css` nomenclature.
+      // Read https://edge.bridgetownrb.com/docs/components/lit#sidecar-css-files for documentation.
+      /*
+      postCssPluginConfig: {
+        filter: /(?:index|\.global)\.css$/,
+      },
+      */
+    JS
+  end
+end
+
+copy_file in_templates_dir("happy-days.lit.js"), "src/_components/happy-days.lit.js"
+
+javascript_import do
+  <<~JS
+    import "bridgetown-lit-renderer"
+  JS
+end
+
+insert_into_file "frontend/javascript/index.js",
+                 before: 'import components from "bridgetownComponents/**/*.{js,jsx,js.rb,css}"' do
+  <<~JS
+    // To opt into `.global.css` & `.lit.css` nomenclature, change the `css` extension below to `global.css`.
+    // Read https://edge.bridgetownrb.com/docs/components/lit#sidecar-css-files for documentation.
+  JS
+end
+
+if found_match
+  say_status :lit, "Lit is now configured!"
+  say_status :lit,
+             "The `config/esbuild-plugins.js` file will let you add full-stack plugins in future."
+else
+  say_status :lit, "Lit is just about configured!"
+  say_status :lit, "You will need to edit `esbuild.config.js` to finish setting up the plugin."
+end
+
+say "Check out the example `happy-days.lit.js` file in `src/_components`", :blue
+say 'For further reading, check out "https://edge.bridgetownrb.com/docs/components/lit"', :blue

data/lib/bridgetown-core/configurations/open-props/variables.css.erb

@@ -0,0 +1,11 @@
+@import "open-props/<% if Bridgetown::Utils.frontend_bundler_type == :esbuild %>open-props.min.css<% else %>style<% end %>";
+
+/* Uncomment this if you want addiitonal "default" styles applied: */
+/* @import "open-props/normalize<% if Bridgetown::Utils.frontend_bundler_type == :esbuild %>.min.css<% end %>"; */
+
+:root {
+  /* Define additional variables here. */
+
+  /* You can use variables from Open Props in your own custom properties. */
+  --color-medium-gray: var(--gray-7);
+}

data/lib/bridgetown-core/configurations/open-props.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+run "yarn add open-props"
+
+variables_import = <<~CSS
+  @import "variables.css";
+
+CSS
+
+if File.exist?("frontend/styles/index.css")
+  prepend_to_file "frontend/styles/index.css", variables_import
+elsif File.exist?("frontend/styles/index.scss")
+  prepend_to_file "frontend/styles/index.scss", variables_import
+else
+  say "\nPlease add the following lines to your CSS index file:"
+  say variables_import
+end
+
+template in_templates_dir("variables.css.erb"), "frontend/styles/variables.css"
+
+say_status :open_props, "Open Props is now configured."

data/lib/bridgetown-core/configurations/ruby2js/hello_world.js.rb

@@ -0,0 +1,9 @@
+class HelloWorld < HTMLElement
+  def connected_callback()
+    self.inner_html = "<p><strong>Hello World!</strong></p>"
+  end
+end
+
+# Try adding `<hello-world></hello-world>` somewhere on your site to see this
+# example web component in action!
+custom_elements.define "hello-world", HelloWorld

data/lib/bridgetown-core/configurations/ruby2js.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+unless Bridgetown::Utils.frontend_bundler_type == :esbuild
+  error_message = "#{"esbuild.config.js".bold} not found. (This configuration doesn't currently " \
+                  "support Webpack.)"
+
+  @logger.error "\nError:".red, "🚨 #{error_message}"
+
+  return
+end
+
+say_status :ruby2js, "Installing Ruby2JS..."
+
+run "yarn add -D @ruby2js/esbuild-plugin"
+
+found_match = false
+gsub_file "esbuild.config.js", %r{const esbuildOptions = {}\n} do |_match|
+  found_match = true
+
+  <<~JS
+    const ruby2js = require("@ruby2js/esbuild-plugin")
+
+    const esbuildOptions = {
+      plugins: [
+        // See docs on Ruby2JS options here: https://www.ruby2js.com/docs/options
+        ruby2js({
+          eslevel: 2022,
+          autoexports: "default",
+          filters: ["camelCase", "functions", "lit", "esm", "return"]
+        })
+      ]
+    }
+  JS
+end
+
+unless found_match
+  insert_into_file "esbuild.config.js",
+                   after: 'const build = require("./config/esbuild.defaults.js")' do
+    <<~JS
+
+      const ruby2js = require("@ruby2js/esbuild-plugin")
+
+      // TODO: Uncomment and move the following into your plugins array:
+      //
+      //  ruby2js({
+      //    eslevel: 2022,
+      //    autoexports: "default",
+      //    filters: ["camelCase", "functions", "lit", "esm", "return"]
+      //  })
+      //
+      // See docs on Ruby2JS options here: https://www.ruby2js.com/docs/options
+
+    JS
+  end
+end
+
+copy_file in_templates_dir("hello_world.js.rb"), "src/_components/hello_world.js.rb"
+
+if found_match
+  say_status :ruby2js, "Ruby2JS is now configured!"
+else
+  say_status :ruby2js, "Ruby2JS is just about configured!"
+  say_status :ruby2js, "You will need to edit `esbuild.config.js` to finish setting up the plugin."
+end
+
+say "Check out the example `hello_world.js.rb` file in `src/_components`", :blue
+say 'For further reading, check out "https://www.ruby2js.com"', :blue

data/lib/bridgetown-core/configurations/shoelace.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+say_status :shoelace, "Installing Shoelace..."
+
+run "yarn add @shoelace-style/shoelace"
+
+say 'Adding Shoelace to "frontend/javascript/index.js"...', :magenta
+
+javascript_import do
+  <<~JS
+    // Import the base Shoelace stylesheet:
+    import "@shoelace-style/shoelace/dist/themes/light.css"
+
+    // Example components, mix 'n' match however you like!
+    import "@shoelace-style/shoelace/dist/components/button/button.js"
+    import "@shoelace-style/shoelace/dist/components/icon/icon.js"
+    import "@shoelace-style/shoelace/dist/components/spinner/spinner.js"
+
+    // Use the public icons folder:
+    import { setBasePath } from "@shoelace-style/shoelace/dist/utilities/base-path.js"
+    setBasePath("/shoelace-assets")
+  JS
+end
+
+say "Updating frontend build commands...", :magenta
+
+if Bridgetown::Utils.frontend_bundler_type == :esbuild
+  insert_into_file "package.json", before: '    "esbuild": "node' do
+    <<-JS
+    "shoelace:copy-assets": "mkdir -p src/shoelace-assets && cp -r node_modules/@shoelace-style/shoelace/dist/assets src/shoelace-assets",
+    JS
+  end
+  gsub_file "package.json", %r{"esbuild": "node}, '"esbuild": "yarn shoelace:copy-assets && node'
+  gsub_file "package.json", %r{"esbuild-dev": "node},
+            '"esbuild-dev": "yarn shoelace:copy-assets && node'
+else
+  insert_into_file "package.json", before: '    "webpack-build": "webpack' do
+    <<-JS
+    "shoelace:copy-assets": "mkdir -p src/shoelace-assets && cp -r node_modules/@shoelace-style/shoelace/dist/assets src/shoelace-assets",
+    JS
+  end
+  gsub_file "package.json", %r{"webpack-build": "webpack},
+            '"webpack-build": "yarn shoelace:copy-assets && webpack'
+  gsub_file "package.json", %r{"webpack-dev": "webpack},
+            '"webpack-dev": "yarn shoelace:copy-assets && webpack'
+end
+
+say_status :shoelace, "Shoelace is now configured!"
+
+say 'For further reading, check out "https://shoelace.style"', :blue