bridgetown-core 1.0.0 → 1.1.0.beta3

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

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

@@ -21,7 +21,7 @@ run "npx tailwindcss init"
 
 gsub_file "tailwind.config.js", "content: [],", <<~JS.strip
   content: [
-      './src/**/*.{html,md,liquid,erb,serb}',
+      './src/**/*.{html,md,liquid,erb,serb,rb}',
       './frontend/javascript/**/*.js',
     ],
 JS
@@ -38,6 +38,20 @@ end
 
 create_file "frontend/styles/jit-refresh.css", "/* #{Time.now.to_i} */"
 
+insert_into_file "Rakefile",
+                  after: %r{  task :(build|dev) do\n} do
+  <<-JS
+    sh "touch frontend/styles/jit-refresh.css"
+  JS
+end
+
+append_to_file ".gitignore" do
+  <<~FILES
+
+    frontend/styles/jit-refresh.css
+  FILES
+end
+
 create_builder "tailwind_jit.rb" do
   <<~RUBY
     class Builders::TailwindJit < SiteBuilder
@@ -45,7 +59,7 @@ create_builder "tailwind_jit.rb" do
         hook :site, :pre_reload do |_, paths|
           # Don't trigger refresh if it's a frontend-only change
           next if paths.length == 1 && paths.first.ends_with?("manifest.json")
-    
+
           # Save out a comment file to trigger Tailwind's JIT
           refresh_file = site.in_root_dir("frontend", "styles", "jit-refresh.css")
           File.write refresh_file, "/* \#{Time.now.to_i} */"

data/lib/bridgetown-core/configurations/turbo/turbo_transitions.js

@@ -16,7 +16,7 @@ document.addEventListener("turbo:visit", () => {
       { opacity: 1, transform: "translateY(0px) scale(1)" },
       { opacity: 0, transform: `translateY(${movement}) scale(${scale})` }
     ],
-    { duration: 300, easing: "cubic-bezier(0.45, 0, 0.55, 1)" }
+    { duration: 300, easing: "cubic-bezier(0.45, 0, 0.55, 1)", fill: "forwards" }
   );
 
   Promise.all(main.getAnimations().map(animation => animation.finished)).then(() => {

data/lib/bridgetown-core/converters/erb_templates.rb

@@ -79,10 +79,15 @@ module Bridgetown
       Erubi.h(input)
     end
 
-    def partial(partial_name, options = {})
+    def partial(partial_name = nil, **options, &block)
+      partial_name = options[:template] if partial_name.nil? && options[:template]
       options.merge!(options[:locals]) if options[:locals]
-      options[:content] = yield if block_given?
+      options[:content] = capture(&block) if block
 
+      _render_partial partial_name, options
+    end
+
+    def _render_partial(partial_name, options)
       partial_path = _partial_path(partial_name, "erb")
       tmpl = site.tmp_cache["partial-tmpl:#{partial_path}"] ||= Tilt::ErubiTemplate.new(
         partial_path,

data/lib/bridgetown-core/converters/markdown/kramdown_parser.rb

@@ -76,7 +76,7 @@ module Bridgetown
           @config["syntax_highlighter"] ||= config["highlighter"] || "rouge"
           @config["syntax_highlighter_opts"] ||= {}
           @config["syntax_highlighter_opts"]["guess_lang"] = @config["guess_lang"]
-          require "kramdown-parser-gfm" if @config["input"] == "GFM"
+          require_relative "../../kramdown/parser/gfm" if @config["input"] == "GFM"
         end
 
         def convert(content)

data/lib/bridgetown-core/converters/serbea_templates.rb

@@ -7,10 +7,7 @@ module Bridgetown
   class SerbeaView < ERBView
     include Serbea::Helpers
 
-    def partial(partial_name, options = {}, &block)
-      options.merge!(options[:locals]) if options[:locals]
-      options[:content] = capture(&block) if block
-
+    def _render_partial(partial_name, options)
       partial_path = _partial_path(partial_name, "serb")
       tmpl = site.tmp_cache["partial-tmpl:#{partial_path}"] ||=
         Tilt::SerbeaTemplate.new(partial_path)

data/lib/bridgetown-core/drops/generated_page_drop.rb

@@ -15,7 +15,8 @@ module Bridgetown
                      :path,
                      :url,
                      :relative_url,
-                     :relative_path
+                     :relative_path,
+                     :all_locales
 
       private def_delegator :@obj, :data, :fallback_data
     end

data/lib/bridgetown-core/drops/resource_drop.rb

@@ -24,7 +24,8 @@ module Bridgetown
                      :relative_url,
                      :date,
                      :taxonomies,
-                     :relations
+                     :relations,
+                     :all_locales
 
       private def_delegator :@obj, :data, :fallback_data
 

data/lib/bridgetown-core/errors.rb

@@ -15,9 +15,9 @@ module Bridgetown
     InvalidURLError             = Class.new(FatalException)
     InvalidConfigurationError   = Class.new(FatalException)
 
-    def self.print_build_error(exc, trace: false)
-      Bridgetown.logger.error "Exception raised:", exc.class.to_s.bold
-      Bridgetown.logger.error exc.message.reset_ansi
+    def self.print_build_error(exc, trace: false, logger: Bridgetown.logger)
+      logger.error "Exception raised:", exc.class.to_s.bold
+      logger.error exc.message.reset_ansi
 
       trace_args = ["-t", "--trace"]
       print_trace_msg = true
@@ -28,12 +28,12 @@ module Bridgetown
                  exc.backtrace[0..4]
                end
       traces.each_with_index do |backtrace_line, index|
-        Bridgetown.logger.error "#{index + 1}:", backtrace_line.reset_ansi
+        logger.error "#{index + 1}:", backtrace_line.reset_ansi
       end
 
       return unless print_trace_msg
 
-      Bridgetown.logger.warn "Backtrace:", "Use the --trace option for complete information."
+      logger.warn "Backtrace:", "Use the --trace option for complete information."
     end
   end
 end

data/lib/bridgetown-core/filters/translation_filters.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Filters
+    module TranslationFilters
+      def t(input)
+        I18n.t(input.to_s)
+      end
+    end
+  end
+end

data/lib/bridgetown-core/filters/url_filters.rb

@@ -7,9 +7,8 @@ module Bridgetown
 
       # Produces an absolute URL based on site.url and site.base_path.
       #
-      # input - the URL to make absolute.
-      #
-      # Returns the absolute URL as a String.
+      # @param input [String] the URL to make absolute.
+      # @return [String] the absolute URL as a String.
       def absolute_url(input)
         cache = (@context.registers[:cached_absolute_urls] ||= {})
         cache[input] ||= compute_absolute_url(input)
@@ -18,19 +17,47 @@ module Bridgetown
       # Produces a URL relative to the domain root based on site.base_path
       # unless it is already an absolute url with an authority (host).
       #
-      # input - the URL to make relative to the domain root
-      #
-      # Returns a URL relative to the domain root as a String.
+      # @param input [String] the URL to make relative to the domain root
+      # @return [String] a URL relative to the domain root as a String.
       def relative_url(input)
         cache = (@context.registers[:cached_relative_urls] ||= {})
         cache[input] ||= compute_relative_url(input)
       end
 
-      # Strips trailing `/index.html` from URLs to create pretty permalinks
+      # For string input, adds a prefix of the current site locale to a relative
+      # URL, unless it's a default locale and prefix_current_locale config is
+      # false. For a resources array input, return a filtered resources array
+      # based on the locale.
       #
-      # input - the URL with a possible `/index.html`
+      # @param input [String, Array] the relative URL, or an array of resources
+      # @param use_locale [String] another locale to use beside the current one
+      #   (must be in site's `available_locales` config)
+      # @return [String, Array] the prefixed relative URL, or filtered resources
+      def in_locale(input, use_locale = nil)
+        site = @context.registers[:site]
+        use_locale ||= site.locale
+
+        # If we're given a collection, filter down and return
+        if input.is_a?(Array)
+          return input.select do |res|
+            res.data[:locale].to_sym == use_locale.to_sym
+          end
+        end
+
+        if !site.config.prefix_default_locale &&
+            use_locale.to_sym == site.config.default_locale
+          return input
+        end
+
+        return input unless site.config.available_locales.include?(use_locale.to_sym)
+
+        "#{use_locale}/#{input.to_s.delete_prefix("/")}"
+      end
+
+      # Strips trailing `/index.html` from URLs to create pretty permalinks
       #
-      # Returns a URL with the trailing `/index.html` removed
+      # @param input [String] the URL with a possible `/index.html`
+      # @return [String] a URL with the trailing `/index.html` removed
       def strip_index(input)
         return if input.nil? || input.to_s.empty?
 
@@ -42,7 +69,7 @@ module Bridgetown
       # @param input [Object] value which responds to `to_s`
       # @return [String]
       def strip_extname(input)
-        Pathname.new(input.to_s).yield_self do |path|
+        Pathname.new(input.to_s).then do |path|
           path.dirname + path.basename(".*")
         end.to_s
       end

data/lib/bridgetown-core/filters.rb

@@ -435,3 +435,6 @@ end
 Liquid::Template.register_filter(
   Bridgetown::Filters
 )
+Liquid::Template.register_filter(
+  Bridgetown::Filters::TranslationFilters
+)

data/lib/bridgetown-core/frontmatter_defaults.rb

@@ -9,10 +9,12 @@ module Bridgetown
 
     def initialize(site)
       @site = site
+      @defaults_cache = {}
     end
 
     def reset
       @glob_cache = {}
+      @defaults_cache = {}
     end
 
     def ensure_time!(set)
@@ -29,16 +31,19 @@ module Bridgetown
     # Collects a hash with all default values for a resource
     #
     # @param path [String] the relative path of the resource
-    # @param collection [Symbol] :posts, :pages, etc.
+    # @param collection_name [Symbol] :posts, :pages, etc.
     #
-    # @returns [Hash] all default values (an empty hash if there are none)
-    def all(path, collection)
-      defaults = {}
+    # @return [Hash] all default values (an empty hash if there are none)
+    def all(path, collection_name)
+      if @defaults_cache.key?([path, collection_name])
+        return @defaults_cache[[path, collection_name]]
+      end
 
+      defaults = {}
       merge_data_cascade_for_path(path, defaults)
 
       old_scope = nil
-      matching_sets(path, collection).each do |set|
+      matching_sets(path, collection_name).each do |set|
         if has_precedence?(old_scope, set["scope"])
           defaults = Utils.deep_merge_hashes(defaults, set["values"])
           old_scope = set["scope"]
@@ -46,7 +51,8 @@ module Bridgetown
           defaults = Utils.deep_merge_hashes(set["values"], defaults)
         end
       end
-      defaults
+
+      @defaults_cache[[path, collection_name]] = defaults
     end
 
     private
@@ -123,7 +129,7 @@ module Bridgetown
     # @param scope [Hash] the defaults set being asked about
     # @param collection [Symbol] the collection of the resource being processed
     #
-    # @returns [Boolean] whether either of the above conditions are satisfied
+    # @return [Boolean] whether either of the above conditions are satisfied
     def applies_collection?(scope, collection)
       !scope.key?("collection") || scope["collection"].eql?(collection.to_s)
     end
@@ -132,7 +138,7 @@ module Bridgetown
     #
     # @param set [Hash] the default value hash as defined in bridgetown.config.yml
     #
-    # @returns [Boolean] if the set is valid and can be used
+    # @return [Boolean] if the set is valid and can be used
     def valid?(set)
       set.is_a?(Hash) && set["values"].is_a?(Hash)
     end

data/lib/bridgetown-core/generated_page.rb

@@ -4,6 +4,7 @@ module Bridgetown
   class GeneratedPage
     include LayoutPlaceable
     include LiquidRenderable
+    include Localizable
     include Publishable
     include Transformable
 

data/lib/bridgetown-core/kramdown/parser/gfm.rb

@@ -0,0 +1,36 @@
+# Frozen-string-literal: true
+
+require "kramdown-parser-gfm"
+
+module Kramdown
+  module Parser
+    class GFM
+      MARK_DELIMITER = %r{(==|::)+}.freeze
+      MARK_MATCH = %r{#{MARK_DELIMITER}(?!\s|=|:).*?[^\s=:]#{MARK_DELIMITER}}m.freeze
+
+      # Monkey-patch GFM initializer to add our new mark parser
+      alias_method :_old_initialize, :initialize
+      def initialize(source, options)
+        _old_initialize(source, options)
+        @span_parsers << :mark if @options[:mark_highlighting]
+      end
+
+      def parse_mark
+        line_number = @src.current_line_number
+
+        @src.pos += @src.matched_size
+        el = Element.new(:html_element, "mark", {}, category: :span, line: line_number)
+        @tree.children << el
+
+        env = save_env
+        reset_env(src: Kramdown::Utils::StringScanner.new(@src.matched[2..-3], line_number),
+                  text_type: :text)
+        parse_spans(el)
+        restore_env(env)
+
+        el
+      end
+      define_parser(:mark, MARK_MATCH)
+    end
+  end
+end

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

@@ -95,8 +95,7 @@ module Bridgetown
 
       # @return [Bridgetown::Resource::Base]
       def as_resource_in_collection
-        collection.resources << to_resource.read!
-        collection.resources.last
+        collection.add_resource_from_model(self)
       end
 
       # @return [Bridgetown::Resource::Base]
@@ -153,8 +152,8 @@ module Bridgetown
           return attributes[key]
         end
 
-        Bridgetown.logger.warn "key `#{method_name}' not found in attributes for" \
-                               " #{attributes[:id].presence || "new #{self.class}"}"
+        Bridgetown.logger.warn "key `#{method_name}' not found in attributes for " \
+                               "#{attributes[:id].presence || "new #{self.class}"}"
         nil
       end