bridgetown-core 1.0.0.beta2 → 1.1.0.beta1

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/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/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,7 +4,9 @@ module Bridgetown
   class GeneratedPage
     include LayoutPlaceable
     include LiquidRenderable
+    include Localizable
     include Publishable
+    include Transformable
 
     attr_writer :dir
     attr_accessor :site, :paginator, :name, :ext, :basename, :data, :content, :output
@@ -12,7 +14,7 @@ module Bridgetown
     alias_method :extname, :ext
 
     # A set of extensions that are considered HTML or HTML-like so we
-    # should not alter them,  this includes .xhtml through XHTM5.
+    # should not alter them
 
     HTML_EXTENSIONS = %w(
       .html
@@ -54,11 +56,11 @@ module Bridgetown
       output || content || ""
     end
 
-    # Accessor for data properties by Liquid.
+    # Accessor for data properties by Liquid
     #
-    # property - The String name of the property to retrieve.
+    # @param property [String] name of the property to retrieve
     #
-    # Returns the String value or nil if the property isn't included.
+    # @return [Object]
     def [](property)
       data[property]
     end
@@ -67,7 +69,7 @@ module Bridgetown
     # upon generation. This is derived from the permalink or, if
     # permalink is absent, will be '/'
     #
-    # Returns the String destination directory.
+    # @return [String]
     def dir
       if url.end_with?("/")
         url
@@ -78,6 +80,8 @@ module Bridgetown
     end
 
     # Liquid representation of current page
+    #
+    # @return [Bridgetown::Drops::GeneratedPageDrop]
     def to_liquid
       @liquid_drop ||= Drops::GeneratedPageDrop.new(self)
     end
@@ -90,7 +94,7 @@ module Bridgetown
 
     # The template of the permalink.
     #
-    # Returns the template String.
+    # @return [String]
     def template
       if !html?
         "/:path/:basename:output_ext"
@@ -103,7 +107,7 @@ module Bridgetown
 
     # The generated relative url of this page. e.g. /about.html.
     #
-    # Returns the String url.
+    # @return [String]
     def url
       @url ||= URL.new(
         template: template,
@@ -123,6 +127,22 @@ module Bridgetown
       }
     end
 
+    # Layout associated with this resource
+    # This will output a warning if the layout can't be found.
+    #
+    # @return [Bridgetown::Layout]
+    def layout
+      return @layout if @layout
+      return if no_layout?
+
+      @layout = site.layouts[data.layout].tap do |layout|
+        unless layout
+          Bridgetown.logger.warn "Generated Page:", "Layout '#{data.layout}' " \
+                                                    "requested via #{relative_path} does not exist."
+        end
+      end
+    end
+
     # Overide this in subclasses for custom initialization behavior
     def process
       # no-op by default
@@ -139,21 +159,68 @@ module Bridgetown
       @relative_path ||= File.join(*[@dir, @name].map(&:to_s).reject(&:empty?)).delete_prefix("/")
     end
 
-    # FIXME: spinning up a new Renderer object just to get an extension
-    # seems excessive
-    #
     # The output extension of the page.
     #
-    # Returns the output extension
+    # @return [String]
     def output_ext
-      @output_ext ||= Bridgetown::Renderer.new(site, self).output_ext
+      @output_ext ||= (permalink_ext || converter_output_ext)
+    end
+
+    def permalink_ext
+      page_permalink = permalink
+      if page_permalink &&
+          !page_permalink.end_with?("/")
+        permalink_ext = File.extname(page_permalink)
+        permalink_ext unless permalink_ext.empty?
+      end
+    end
+
+    def converter_output_ext
+      if output_exts.size == 1
+        output_exts.last
+      else
+        output_exts[-2]
+      end
+    end
+
+    def output_exts
+      @output_exts ||= converters.filter_map do |c|
+        c.output_ext(extname)
+      end
+    end
+
+    # @return [Array<Bridgetown::Converter>]
+    def converters
+      @converters ||= site.matched_converters_for_convertible(self)
+    end
+
+    def transform!
+      Bridgetown.logger.debug "Transforming:", relative_path
+
+      trigger_hooks :pre_render
+      self.content = transform_content(self)
+      place_in_layout? ? place_into_layouts : self.output = content.dup
+      trigger_hooks :post_render
+
+      self
+    end
+
+    def place_into_layouts
+      Bridgetown.logger.debug "Placing in Layouts:", relative_path
+      rendered_output = content.dup
+
+      site.validated_layouts_for(self, data.layout).each do |layout|
+        rendered_output = transform_with_layout(layout, rendered_output, self)
+      end
+
+      self.output = rendered_output
     end
 
     # Obtain destination path.
     #
-    # dest - The String path to the destination dir.
+    # @param dest [String] path to the destination dir
     #
-    # Returns the destination file path String.
+    # @return [String]
     def destination(dest)
       path = site.in_dest_dir(dest, URL.unescape_path(url))
       path = File.join(path, "index") if url.end_with?("/")
@@ -163,9 +230,7 @@ module Bridgetown
 
     # Write the generated page file to the destination directory.
     #
-    # dest - The String path to the destination dir.
-    #
-    # Returns nothing.
+    # @param dest [String] path to the destination dir
     def write(dest)
       path = destination(dest)
       FileUtils.mkdir_p(File.dirname(path))

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]

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)

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