bridgetown-core 1.1.0 → 1.2.0.beta1

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

@@ -6,12 +6,15 @@ module Bridgetown
     # (requires a `converter` method to be present on the including class)
     #
     # @param document [Bridgetown::GeneratedPage, Bridgetown::Resource::Base]
+    # @param alternate_content [String, nil] Pass in content if you don't want to use document's
     # @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)|
+    def transform_content(document, alternate_content: nil)
+      converters.each_with_index.inject(
+        (alternate_content || document.content).to_s
+      ) do |content, (converter, index)|
         output = if converter.method(:convert).arity == 1
                    converter.convert content
                  else

data/lib/bridgetown-core/configuration/configuration_dsl.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  class Configuration
+    class ConfigurationDSL < Bridgetown::Utils::RubyFrontMatter
+      attr_reader :context
+
+      # @yieldself [ConfigurationDSL]
+      def init(name, require_gem: true, require_initializer: true, **kwargs, &block) # rubocop:todo Metrics
+        return if @scope.initializers.key?(name.to_sym) &&
+          @scope.initializers[name.to_sym].completed
+
+        initializer = _setup_initializer(
+          name: name, require_gem: require_gem, require_initializer: require_initializer
+        )
+
+        return unless initializer.nil? || initializer.completed == false
+
+        set :init_params do
+          block ? set(name, &block) : set(name, kwargs)
+        end
+
+        if initializer.nil?
+          Bridgetown.logger.warn("Initializing:",
+                                 "The `#{name}' initializer could not be found")
+          return
+        end
+
+        Bridgetown.logger.debug "Initializing:", name
+        @scope.initializers[name.to_sym].block.(self, **@scope.init_params[name].symbolize_keys)
+        initializer.completed = true
+      end
+
+      def only(*context, &block)
+        return unless context.any? { _1 == @context }
+
+        instance_exec(&block)
+      end
+
+      def except(*context, &block)
+        return if context.any? { _1 == @context }
+
+        instance_exec(&block)
+      end
+
+      def hook(
+        owner,
+        event,
+        priority: Bridgetown::Hooks::DEFAULT_PRIORITY,
+        &block
+      )
+        Bridgetown::Hooks.register_one(owner, event, priority: priority, &block)
+      end
+
+      def source_manifest(**kwargs)
+        @scope.source_manifests << SourceManifest.new(**kwargs)
+      end
+
+      def builder(klass = nil, &block)
+        return klass.register if klass.is_a?(Bridgetown::Builder)
+
+        unless klass.is_a?(Symbol)
+          raise "You must supply a constant symbol to register an inline builder"
+        end
+
+        Object.const_set(
+          klass, Class.new(Bridgetown::Builder, &block).tap(&:register)
+        )
+      end
+
+      def roda(&block)
+        @scope.roda_initializers << block
+      end
+
+      def method_missing(key, *value, &block) # rubocop:disable Style/MissingRespondToMissing
+        return get(key) if value.length.zero? && block.nil?
+
+        set(key, value[0], &block)
+      end
+
+      def get(key)
+        unless @data.key?(key)
+          Bridgetown.logger.debug("Initializing:", "Uh oh, missing key `#{key}' in configuration")
+        end
+
+        super
+      end
+
+      def set(key, value = nil, &block)
+        # Handle nested data within a block
+        if block
+          value = self.class.new(scope: @scope).tap do |fm|
+            fm.instance_exec(&block)
+          end.to_h
+        end
+
+        key = key.to_s.delete_suffix("=") if key.to_s.ends_with?("=")
+
+        @data[key] = if @data[key].is_a?(Hash) && value.is_a?(Hash)
+                       Bridgetown::Utils.deep_merge_hashes(@data[key], value)
+                     else
+                       value
+                     end
+      end
+
+      def reflect(name, require_gem: true, require_initializer: true)
+        initializer = _setup_initializer(
+          name: name, require_gem: require_gem, require_initializer: require_initializer
+        )
+
+        if initializer.nil?
+          Bridgetown.logger.info("Reflection:",
+                                 "The `#{name}' initializer could not be found")
+          return
+        end
+
+        Bridgetown.logger.info(
+          "Reflection:",
+          "The #{name.to_s.yellow} initializer accepts the following options:"
+        )
+        initializer.block.parameters.each do |param|
+          next if param[0] == :opt
+
+          Bridgetown.logger.info("",
+                                 "* #{param[1].to_s.cyan}#{" (required)" if param[0] == :keyreq}")
+        end
+      end
+
+      # @return [Bridgetown::Configuration::Initializer]
+      def _setup_initializer(name:, require_gem:, require_initializer:)
+        Bridgetown::PluginManager.require_gem(name) if require_gem && !_in_require_denylist?(name)
+
+        if require_initializer
+          init_file_name = File.join(@scope.root_dir, "config", "#{name}.rb")
+          require(init_file_name) if File.exist?(init_file_name)
+        end
+
+        @scope.initializers[name.to_sym]
+      end
+
+      def _in_require_denylist?(name)
+        REQUIRE_DENYLIST.include?(name.to_sym)
+      end
+    end
+  end
+end

data/lib/bridgetown-core/configuration.rb

@@ -1,20 +1,35 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  # Holds the processed configuration loaded from the YAML config file.
-  #
-  # @todo refactor this whole object! Already had to fix obscure
-  #   bugs just making minor changes, and all the indirection is
-  #   quite hard to decipher. -JW
+  # The primary configuration object for a Bridgetown project
   class Configuration < HashWithDotAccess::Hash
-    # Default options. Overridden by values in bridgetown.config.yml.
+    REQUIRE_DENYLIST = %i(parse_routes ssr) # rubocop:disable Style/MutableConstant
+
+    Initializer = Struct.new(:name, :block, :completed, keyword_init: true) do
+      def to_s
+        "#{name} (Initializer)"
+      end
+    end
+
+    SourceManifest = Struct.new(:origin, :components, :content, :layouts, keyword_init: true)
+
+    Preflight = Struct.new(:source_manifests, :initializers, keyword_init: true) do
+      def initialize(*)
+        super
+        self.source_manifests ||= Set.new
+      end
+    end
+
+    require_relative "configuration/configuration_dsl"
+
+    # Default options. Overridden by values in bridgetown.config.yml or initializers.
     # Strings rather than symbols are used for compatibility with YAML.
     DEFAULTS = {
       # Where things are
       "root_dir"                   => Dir.pwd,
       "plugins_dir"                => "plugins",
-      "source"                     => File.join(Dir.pwd, "src"),
-      "destination"                => File.join(Dir.pwd, "output"),
+      "source"                     => "src",
+      "destination"                => "output",
       "collections_dir"            => "",
       "cache_dir"                  => ".bridgetown-cache",
       "layouts_dir"                => "_layouts",
@@ -87,12 +102,15 @@ module Bridgetown
       },
     }.each_with_object(Configuration.new) { |(k, v), hsh| hsh[k] = v.freeze }.freeze
 
-    # The modern default config file name is bridgetown.config.EXT, but we also
-    # need to check for _config.EXT as a backward-compatibility nod to our
-    # progenitor
+    # TODO: Deprecated. Remove support for _config as well as toml in the next release.
     CONFIG_FILE_PREFIXES = %w(bridgetown.config _config).freeze
     CONFIG_FILE_EXTS = %w(yml yaml toml).freeze
 
+    # @return [Hash<Symbol, Initializer>]
+    attr_accessor :initializers
+
+    attr_writer :source_manifests, :roda_initializers
+
     class << self
       # Static: Produce a Configuration ready for use in a Site.
       # It takes the input, fills in the defaults where values do not exist.
@@ -101,7 +119,7 @@ module Bridgetown
       #
       # Returns a Configuration filled with defaults.
       def from(user_config, starting_defaults = DEFAULTS)
-        Utils.deep_merge_hashes(starting_defaults.deep_dup, Configuration[user_config])
+        Utils.deep_merge_hashes(starting_defaults.deep_dup, Configuration.new(user_config))
           .merge_environment_specific_options!
           .setup_load_paths!
           .setup_locales
@@ -111,6 +129,43 @@ module Bridgetown
       end
     end
 
+    def run_initializers!(context:)
+      initializers_file = File.join(root_dir, "config", "initializers.rb")
+      return unless File.file?(initializers_file)
+
+      require initializers_file
+
+      return unless initializers # no initializers have been set up
+
+      init_init = initializers[:init]
+      return unless init_init && !init_init.completed
+
+      Bridgetown.logger.debug "Initializing:", "Running initializers with `#{context}' context in:"
+      Bridgetown.logger.debug "", initializers_file
+      self.init_params = {}
+      dsl = ConfigurationDSL.new(scope: self, data: self)
+      dsl.instance_variable_set(:@context, context)
+      dsl.instance_exec(dsl, &init_init.block)
+
+      self
+    end
+
+    # @return [Set<SourceManifest>]
+    def source_manifests
+      @source_manifests ||= Set.new
+    end
+
+    # @return [Array<Proc>]
+    def roda_initializers
+      @roda_initializers ||= []
+    end
+
+    def initialize_roda_app(app)
+      roda_initializers.each do |initializer|
+        initializer.(app)
+      end
+    end
+
     def get_config_value_with_override(config_key, override)
       override[config_key] || self[config_key] || DEFAULTS[config_key]
     end
@@ -143,16 +198,32 @@ module Bridgetown
     end
     alias_method :verbose?, :verbose
 
-    def safe_load_file(filename)
+    def safe_load_file(filename) # rubocop:todo Metrics
       case File.extname(filename)
       when %r!\.toml!i
+        Deprecator.deprecation_message(
+          "TOML configurations will no longer be supported in the next version of Bridgetown." \
+          "Use initializers or a .yaml config instead."
+        )
         Bridgetown::Utils::RequireGems.require_with_graceful_fail("tomlrb") unless defined?(Tomlrb)
         Tomlrb.load_file(filename)
       when %r!\.ya?ml!i
+        if File.basename(filename, ".*") == "_config"
+          Deprecator.deprecation_message(
+            "YAML configurations named `_config.y(a)ml' will no longer be supported in the next " \
+            "version of Bridgetown. Rename to `bridgetown.config.yml' instead."
+          )
+        end
+        if File.extname(filename) == ".yaml"
+          Deprecator.deprecation_message(
+            "YAML configurations ending in `.yaml' will no longer be supported in the next " \
+            "version of Bridgetown. Rename to use `.yml' extension instead."
+          )
+        end
         YAMLParser.load_file(filename) || {}
       else
         raise ArgumentError,
-              "No parser for '#{filename}' is available. Use a .y(a)ml or .toml file instead."
+              "No parser for '#{filename}' is available. Use a .y(a)ml file instead."
       end
     rescue Psych::DisallowedClass => e
       raise "Unable to parse `#{File.basename(filename)}'. #{e.message}"
@@ -252,7 +323,11 @@ module Bridgetown
       self
     end
 
-    def setup_load_paths!
+    def setup_load_paths! # rubocop:todo Metrics
+      self[:root_dir] = File.expand_path(self[:root_dir])
+      self[:source] = File.expand_path(self[:source], self[:root_dir])
+      self[:destination] = File.expand_path(self[:destination], self[:root_dir])
+
       if self[:plugins_use_zeitwerk]
         autoload_paths.unshift({
           path: self[:plugins_dir],

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

@@ -24,7 +24,9 @@ jobs:
       - run: yarn install
 
       - name: Build
-        run: bin/bridgetown deploy
+        env:
+          BRIDGETOWN_ENV: production
+        run:  bin/bridgetown deploy
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3

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

@@ -5,14 +5,17 @@
 // 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])
+const postcssrc = require("postcss-load-config")
+const postcss = require("postcss")
 
 module.exports = {
   plugins: [
     litCssPlugin({
       filter: /\.lit\.css$/,
       transform: async (css, { filePath }) => {
+        const postCssConfig = await postcssrc()
+        const postCssProcessor = postcss([...postCssConfig.plugins])
+
         const results = await postCssProcessor.process(css, { ...postCssConfig.options, from: filePath })
         return results.css
       }

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

@@ -38,7 +38,7 @@ create_file "test/helper.rb" do
       include Rails::Dom::Testing::Assertions
 
       def site
-        @site ||= Bridgetown.sites.first
+        @site ||= Bridgetown::Current.site
       end
 
       def nokogiri(input)

data/lib/bridgetown-core/converter.rb

@@ -14,6 +14,14 @@ module Bridgetown
         self.extname_list ||= []
         self.extname_list += extnames.map { |e| ".#{e.to_s.downcase}" }
       end
+
+      def supports_slots?
+        @support_slots == true
+      end
+
+      def support_slots(bool = true) # rubocop:disable Style/OptionalBooleanParameter
+        @support_slots = bool == true
+      end
     end
 
     # Initialize the converter.

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

@@ -7,6 +7,8 @@ module Bridgetown
     class Identity < Converter
       priority :lowest
 
+      support_slots
+
       # Public: Does the given extension match this converter's list of acceptable extensions?
       # Takes one argument: the file's extension (including the dot).
       #

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

@@ -89,6 +89,7 @@ module Bridgetown
         payload["paginator"] = document.respond_to?(:paginator) ? document.paginator.to_liquid : nil
         payload["layout"] = @layout ? @layout.to_liquid.merge({ data: @layout.data }) : {}
         payload["content"] = content
+        payload["data"] = payload["page"].data
       end
 
       def liquid_context

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

@@ -1,4 +1,4 @@
-# Frozen-string-literal: true
+# frozen_string_literal: true
 
 module Kramdown
   # A Kramdown::Document subclass meant to optimize memory usage from initializing

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

@@ -5,6 +5,8 @@ module Bridgetown
     # Markdown converter.
     # For more info on converters see https://bridgetownrb.com/docs/plugins/converters/
     class Markdown < Converter
+      support_slots
+
       def initialize(config = {})
         super
 

data/lib/bridgetown-core/current.rb

@@ -2,13 +2,27 @@
 
 module Bridgetown
   class Current < ActiveSupport::CurrentAttributes
-    # @!method self.site
-    #   @return [Bridgetown::Site]
-
-    attribute :site
-
     # @!method self.preloaded_configuration
     #   @return [Bridgetown::Configuration]
     attribute :preloaded_configuration
+
+    # @return [Bridgetown::Site, nil]
+    def self.site
+      sites[:main]
+    end
+
+    def self.site=(new_site)
+      sites[:main] = new_site
+    end
+
+    # @!method self.sites
+    #   @return [Hash<Symbol, Bridgetown::Site>]
+
+    attribute :sites
+
+    def initialize
+      super
+      @attributes[:sites] = {}
+    end
   end
 end

data/lib/bridgetown-core/deprecator.rb

@@ -2,45 +2,12 @@
 
 module Bridgetown
   module Deprecator
-    extend self
-
-    def process(args)
-      arg_is_present? args, "--server", "The --server command has been replaced by the \
-                          'serve' subcommand."
-      arg_is_present? args, "--serve", "The --serve command has been replaced by the \
-                          'serve' subcommand."
-      arg_is_present? args, "--no-server", "To build Bridgetown without launching a server, \
-                          use the 'build' subcommand."
-      arg_is_present? args, "--auto", "The switch '--auto' has been replaced with \
-                          '--watch'."
-      arg_is_present? args, "--no-auto", "To disable auto-replication, simply leave off \
-                          the '--watch' switch."
-      arg_is_present? args, "--url", "The 'url' setting can only be set in your \
-                          config files."
-      no_subcommand(args)
-    end
-
-    def no_subcommand(args)
-      unless args.empty? ||
-          args.first !~ %r(!/^--/!) || %w(--help --version).include?(args.first)
-        deprecation_message "Bridgetown now uses subcommands instead of just switches. \
-                          Run `bridgetown help` to find out more."
-        abort
-      end
-    end
-
-    def arg_is_present?(args, deprecated_argument, message)
-      deprecation_message(message) if args.include?(deprecated_argument)
-    end
-
-    def deprecation_message(message)
+    def self.deprecation_message(message)
       Bridgetown.logger.warn "Deprecation:", message
-    end
 
-    def defaults_deprecate_type(old, current)
-      Bridgetown.logger.warn "Defaults:", "The '#{old}' type has become '#{current}'."
-      Bridgetown.logger.warn "Defaults:", "Please update your front-matter defaults to use \
-                        'type: #{current}'."
+      caller_locations[0..1].each_with_index do |backtrace_line, index|
+        Bridgetown.logger.debug "#{index + 1}:", backtrace_line
+      end
     end
   end
 end

data/lib/bridgetown-core/filters.rb

@@ -26,9 +26,7 @@ module Bridgetown
     #
     # Returns the smart-quotified String.
     def smartify(input)
-      @context.registers[:site].find_converter_instance(
-        Bridgetown::Converters::SmartyPants
-      ).convert(input.to_s)
+      Utils::SmartyPantsConverter.new(@context.registers[:site].config).convert(input.to_s)
     end
 
     # Slugify a filename or title.

data/lib/bridgetown-core/generated_page.rb

@@ -65,6 +65,11 @@ module Bridgetown
       data[property]
     end
 
+    # @return [Array<Bridgetown::Slot>]
+    def slots
+      @slots ||= []
+    end
+
     # The generated directory into which the page will be placed
     # upon generation. This is derived from the permalink or, if
     # permalink is absent, will be '/'