bridgetown-core 1.1.0 → 1.2.0.beta2

data/lib/bridgetown-core/rack/roda.rb

@@ -1,57 +1,50 @@
 # frozen_string_literal: true
 
-begin
-  # If it's in the Gemfile's :bridgetown_plugins group it's already been required, but we'll try
-  # again just to be on the safe side:
-  require "bridgetown-routes"
-rescue LoadError
+unless Bridgetown::Current.preloaded_configuration
+  raise "You must supply a preloaded configuration before loading Bridgetown's Roda superclass"
 end
 
-class Roda
-  module RodaPlugins
-    module BridgetownSSR
-      module InstanceMethods
-        # Helper shorthand for Bridgetown::Current.site
-        # @return [Bridgetown::Site]
-        def bridgetown_site
-          Bridgetown::Current.site
+module Bridgetown
+  module Rack
+    class Roda < ::Roda
+      class << self
+        def inherited(klass)
+          super
+          klass.plugin :initializers
         end
-      end
 
-      def self.configure(app, _opts = {}, &block)
-        app.include Bridgetown::Filters::URLFilters
-        app.opts[:bridgetown_site] =
-          Bridgetown::Site.start_ssr!(loaders_manager: Bridgetown::Rack.loaders_manager, &block)
-      end
-    end
-
-    register_plugin :bridgetown_ssr, BridgetownSSR
+        # rubocop:disable Bridgetown/NoPutsAllowed
+        def print_routes
+          # TODO: this needs to be fully documented
+          routes = begin
+            JSON.parse(
+              File.read(
+                File.join(Bridgetown::Current.preloaded_configuration.root_dir, ".routes.json")
+              )
+            )
+          rescue StandardError
+            []
+          end
+          puts
+          puts "Routes:"
+          puts "======="
+          if routes.blank?
+            puts "No routes found. Have you commented all of your routes?"
+            puts "Documentation: https://github.com/jeremyevans/roda-route_list#basic-usage-"
+          end
 
-    module BridgetownBoot
-      Roda::RodaRequest.alias_method :_previous_roda_cookies, :cookies
-
-      module RequestMethods
-        # Monkeypatch Roda/Rack's Request object so it returns a hash which allows for
-        # indifferent access
-        def cookies
-          # TODO: maybe replace with a simpler hash that offers an overloaded `[]` method
-          _previous_roda_cookies.with_indifferent_access
-        end
-
-        # Starts up the Bridgetown routing system
-        def bridgetown
-          Bridgetown::Rack::Routes.start!(scope)
+          routes.each do |route|
+            puts [
+              route["methods"]&.join("|") || "GET",
+              route["path"],
+              route["file"] ? "\n  File: #{route["file"]}" : nil,
+            ].compact.join(" ")
+          end
+          puts
         end
+        # rubocop:enable Bridgetown/NoPutsAllowed
       end
-    end
-
-    register_plugin :bridgetown_boot, BridgetownBoot
-  end
-end
 
-module Bridgetown
-  module Rack
-    class Roda < ::Roda
       SiteContext = Struct.new(:registers) # for use by Liquid-esque URL helpers
 
       plugin :hooks
@@ -142,7 +135,8 @@ module Bridgetown
       before do
         if self.class.opts[:bridgetown_site]
           # The site had previously been initialized via the bridgetown_ssr plugin
-          Bridgetown::Current.site ||= self.class.opts[:bridgetown_site]
+          Bridgetown::Current.sites[self.class.opts[:bridgetown_site].label] =
+            self.class.opts[:bridgetown_site]
           @context ||= SiteContext.new({ site: self.class.opts[:bridgetown_site] })
         end
         Bridgetown::Current.preloaded_configuration ||=

data/lib/bridgetown-core/rack/routes.rb

@@ -125,16 +125,12 @@ module Bridgetown
           Bridgetown::Rack::Routes.sorted_subclasses&.each do |klass|
             klass.merge roda_app
           end
-
-          return unless defined?(Bridgetown::Routes::RodaRouter)
-
-          Bridgetown::Routes::RodaRouter.start!(roda_app)
         end
 
         # @param app [Bridgetown::Rack::Roda]
         def setup_live_reload(app) # rubocop:disable Metrics/AbcSize
           sleep_interval = 0.2
-          file_to_check = File.join(app.class.opts[:bridgetown_preloaded_config].destination,
+          file_to_check = File.join(Bridgetown::Current.preloaded_configuration.destination,
                                     "index.html")
 
           app.request.get "_bridgetown/live_reload" do
@@ -190,7 +186,7 @@ module Bridgetown
   end
 end
 
-if Bridgetown.env.development? &&
+if defined?(Puma) && Bridgetown.env.development? &&
     !Bridgetown::Current.preloaded_configuration.skip_live_reload
   Puma::Launcher.class_eval do
     alias_method :_old_stop, :stop

data/lib/bridgetown-core/rack/static_indexes.rb

@@ -2,8 +2,7 @@
 
 require "roda/plugins/public"
 
-# NOTE: once this upstreamed PR is merged in we can remove this file.
-# https://github.com/jeremyevans/roda/pull/215
+# TODO: extract out to a standalone Roda plugin
 Roda::RodaPlugins::Public::RequestMethods.module_eval do
   SPLIT = Regexp.union(*[File::SEPARATOR, File::ALT_SEPARATOR].compact) # rubocop:disable Lint/ConstantDefinitionInBlock
   def public_path_segments(path) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

data/lib/bridgetown-core/reader.rb

@@ -5,30 +5,35 @@ module Bridgetown
     # @return [Bridgetown::Site]
     attr_reader :site
 
+    # @param site [Bridgetown::Site]
     def initialize(site)
       @site = site
     end
 
-    # Read Site data from disk and load it into internal data structures.
-    #
-    # Returns nothing.
+    # Read data and resources from disk and load it into internal data structures.
+    # @return [void]
     def read
       site.defaults_reader.read
+      site.data = site.collections.data.read.merge_data_resources
       read_layouts
       read_directories
       read_includes
       sort_files!
-      site.data = site.collections.data.read.merge_data_resources
       read_collections
-      Bridgetown::PluginManager.source_manifests.select(&:content).each do |manifest|
+      site.config.source_manifests.select(&:content).each do |manifest|
         PluginContentReader.new(site, manifest).read
       end
     end
 
+    # Read in layouts
+    # @see LayoutReader
+    # @return [void]
     def read_layouts
       site.layouts = LayoutReader.new(site).read
     end
 
+    # Read in collections (other than the data collection)
+    # @return [void]
     def read_collections
       site.collections.each_value do |collection|
         next if collection.data?
@@ -38,6 +43,7 @@ module Bridgetown
     end
 
     # Sorts generated pages and static files.
+    # @return [void]
     def sort_files!
       site.generated_pages.sort_by!(&:name)
       site.static_files.sort_by!(&:relative_path)
@@ -47,59 +53,55 @@ module Bridgetown
     # that will become part of the site according to the rules in
     # filter_entries.
     #
-    # dir - The String relative path of the directory to read. Default: ''.
-    #
-    # Returns nothing.
+    # @param dir [String] relative path of the directory to read. Default: ''
+    # @return [void]
     def read_directories(dir = "")
       base = site.in_source_dir(dir)
 
       return unless File.directory?(base)
 
-      dot_dirs = []
-      dot_pages = []
-      dot_static_files = []
+      entries_dirs = []
+      entries_pages = []
+      entries_static_files = []
 
-      dot = Dir.chdir(base) { filter_entries(Dir.entries("."), base) }
-      dot.each do |entry|
+      entries = Dir.chdir(base) { filter_entries(Dir.entries("."), base) }
+      entries.each do |entry|
         file_path = @site.in_source_dir(base, entry)
         if File.directory?(file_path)
-          dot_dirs << entry
+          entries_dirs << entry
         elsif Utils.has_yaml_header?(file_path) || Utils.has_rbfm_header?(file_path)
-          dot_pages << entry
+          entries_pages << entry
         else
-          dot_static_files << entry
+          entries_static_files << entry
         end
       end
 
-      retrieve_dirs(base, dir, dot_dirs)
-      retrieve_pages(dir, dot_pages)
-      retrieve_static_files(dir, dot_static_files)
+      retrieve_dirs(dir, entries_dirs)
+      retrieve_pages(dir, entries_pages)
+      retrieve_static_files(dir, entries_static_files)
     end
 
     # Recursively traverse directories with the read_directories function.
     #
-    # base - The String representing the site's base directory.
-    # dir - The String representing the directory to traverse down.
-    # dot_dirs - The Array of subdirectories in the dir.
-    #
-    # Returns nothing.
-    def retrieve_dirs(_base, dir, dot_dirs)
-      dot_dirs.each do |file|
+    # @param dir [String] the directory to traverse down
+    # @param entries_dirs [Array<String>] subdirectories in the directory
+    # @return [void]
+    def retrieve_dirs(dir, entries_dirs)
+      entries_dirs.each do |file|
         dir_path = site.in_source_dir(dir, file)
         rel_path = File.join(dir, file)
-        @site.reader.read_directories(rel_path) unless @site.dest.chomp("/") == dir_path
+        read_directories(rel_path) unless @site.destination.chomp("/") == dir_path
       end
     end
 
     # Retrieve all the pages from the current directory,
     # add them to the site and sort them.
     #
-    # dir - The String representing the directory retrieve the pages from.
-    # dot_pages - The Array of pages in the dir.
-    #
-    # Returns nothing.
-    def retrieve_pages(dir, dot_pages)
-      dot_pages.each do |page_path|
+    # @param dir [String] the directory to retrieve the pages from
+    # @param entries_pages [Array<String>] page paths in the directory
+    # @return [void]
+    def retrieve_pages(dir, entries_pages)
+      entries_pages.each do |page_path|
         site.collections.pages.read_resource(site.in_source_dir(dir, page_path))
       end
     end
@@ -122,8 +124,8 @@ module Bridgetown
     # or are excluded in the site configuration, unless they are web server
     # files such as '.htaccess'.
     #
-    # entries - The Array of String file/directory entries to filter.
-    # base_directory - The string representing the optional base directory.
+    # @param entries [Array<String>] file/directory entries to filter
+    # @param base_directory [String] optional base directory
     #
     # Returns the Array of filtered entries.
     def filter_entries(entries, base_directory = nil)
@@ -132,8 +134,8 @@ module Bridgetown
 
     # Read the entries from a particular directory for processing
     #
-    # dir - The String representing the relative path of the directory to read.
-    # subfolder - The String representing the directory to read.
+    # @param dir [String] parent directory
+    # @param subfolder [String] the directory to read
     #
     # Returns the list of entries to process
     def get_entries(dir, subfolder)
@@ -146,19 +148,6 @@ module Bridgetown
 
     private
 
-    # Internal
-    #
-    # Determine if the directory is supposed to contain posts.
-    # If the user has defined a custom collections_dir, then attempt to read
-    # posts only from within that directory.
-    #
-    # Returns true if a custom collections_dir has been set but current directory lies
-    # outside that directory.
-    def outside_configured_directory?(dir)
-      collections_dir = site.config["collections_dir"]
-      !collections_dir.empty? && !dir.start_with?("/#{collections_dir}")
-    end
-
     def read_includes
       site.config.include.each do |entry|
         next if entry == ".htaccess"

data/lib/bridgetown-core/readers/layout_reader.rb

@@ -15,7 +15,7 @@ module Bridgetown
           Layout.new(site, layout_directory, layout_file)
       end
 
-      Bridgetown::PluginManager.source_manifests.filter_map(&:layouts).each do |plugin_layouts|
+      site.config.source_manifests.filter_map(&:layouts).each do |plugin_layouts|
         layout_entries(plugin_layouts).each do |layout_file|
           @layouts[layout_name(layout_file)] ||= \
             Layout.new(site, plugin_layouts, layout_file, from_plugin: true)

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

@@ -2,7 +2,7 @@
 
 module Bridgetown
   module Resource
-    class Base
+    class Base # rubocop:todo Metrics/ClassLength
       include Comparable
       include Bridgetown::Publishable
       include Bridgetown::LayoutPlaceable
@@ -21,6 +21,9 @@ module Bridgetown
       # @return [Bridgetown::Site]
       attr_reader :site
 
+      # @return [Array<Bridgetown::Slot>]
+      attr_reader :slots
+
       # @return [String]
       attr_accessor :content, :untransformed_content, :output
 
@@ -32,6 +35,7 @@ module Bridgetown
         @model = model
         @site = model.site
         @data = collection.data? ? HashWithDotAccess::Hash.new : front_matter_defaults
+        @slots = []
 
         trigger_hooks :post_init
       end
@@ -300,6 +304,7 @@ module Bridgetown
 
       def ensure_default_data
         determine_locale
+        merge_requested_site_data
 
         slug = if matches = relative_path.to_s.match(DATE_FILENAME_MATCHER) # rubocop:disable Lint/AssignmentInCondition
                  set_date_from_string(matches[1]) unless data.date
@@ -314,6 +319,17 @@ module Bridgetown
         data.title ||= Bridgetown::Utils.titleize_slug(slug)
       end
 
+      # Lets you put `site.data.foo.bar` in a front matter variable and it will then get swapped
+      # out for the actual site data
+      def merge_requested_site_data
+        data.each do |k, v|
+          next unless v.is_a?(String) && v.starts_with?("site.data.")
+
+          data_path = v.delete_prefix("site.data.")
+          data[k] = site.data.dig(*data_path.split("."))
+        end
+      end
+
       def set_date_from_string(new_date) # rubocop:disable Naming/AccessorMethodName
         return unless new_date.is_a?(String)
 

data/lib/bridgetown-core/ruby_template_view.rb

@@ -6,20 +6,24 @@ module Bridgetown
   class RubyTemplateView
     require "bridgetown-core/helpers"
 
-    attr_reader :layout, :page, :paginator, :site, :content
-    alias_method :resource, :page
+    attr_reader :layout, :resource, :paginator, :site, :content
+    alias_method :page, :resource
 
     def initialize(convertible)
       if convertible.is_a?(Layout)
         @layout = convertible
-        @page = layout.current_document
+        @resource = layout.current_document
         @content = layout.current_document_output
       else
         @layout = convertible.site.layouts[convertible.data["layout"]]
-        @page = convertible
+        @resource = convertible
       end
-      @paginator = page.paginator if page.respond_to?(:paginator)
-      @site = page.site
+      @paginator = resource.paginator if resource.respond_to?(:paginator)
+      @site = resource.site
+    end
+
+    def data
+      resource.data
     end
 
     def partial(_partial_name = nil, **_options)
@@ -48,7 +52,7 @@ module Bridgetown
       render_statement = _render_statement(component, options)
 
       template = site.liquid_renderer.file(
-        "#{page.path}.#{Digest::SHA2.hexdigest(render_statement)}"
+        "#{resource.path}.#{Digest::SHA2.hexdigest(render_statement)}"
       ).parse(render_statement)
       template.warnings.each do |e|
         Bridgetown.logger.warn "Liquid Warning:",
@@ -100,7 +104,7 @@ module Bridgetown
       {
         registers: {
           site: site,
-          page: page.to_liquid,
+          page: resource.to_liquid,
           cached_partials: Bridgetown::Converters::LiquidTemplates.cached_partials,
         },
         strict_filters: site.config["liquid"]["strict_filters"],

data/lib/bridgetown-core/site.rb

@@ -13,11 +13,17 @@ module Bridgetown
     include SSR
     include Writable
 
-    attr_reader :root_dir, :source, :dest, :cache_dir, :config, :liquid_renderer
+    # @return [Bridgetown::Configuration]
+    attr_reader :config
+
+    # @return [Symbol]
+    attr_reader :label
 
     # @return [Bridgetown::Utils::LoadersManager]
     attr_reader :loaders_manager
 
+    attr_reader :cache_dir, :liquid_renderer
+
     # All files not pages/documents or structured data in the source folder
     # @return [Array<StaticFile>]
     attr_accessor :static_files
@@ -36,7 +42,8 @@ module Bridgetown
     #
     # @param config [Bridgetown::Configuration]
     # @param loaders_manager [Bridgetown::Utils::LoadersManager] initialized if none provided
-    def initialize(config, loaders_manager: nil)
+    def initialize(config, label: :main, loaders_manager: nil)
+      @label = label.to_sym
       self.config = config
       locale
 
@@ -56,7 +63,7 @@ module Bridgetown
       Bridgetown::Cache.base_cache["site_tmp"] = {}.with_dot_access
       ensure_not_in_dest
 
-      Bridgetown::Current.site = self
+      Bridgetown::Current.sites[@label] = self
       Bridgetown::Hooks.trigger :site, :after_init, self
 
       reset   # Processable

data/lib/bridgetown-core/slot.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  class Slot
+    include Transformable
+
+    # @return [String]
+    attr_reader :name
+
+    # @return [String]
+    attr_accessor :content
+
+    # @return [Object, nil]
+    attr_reader :context
+
+    def initialize(name:, content:, context:, transform: false)
+      @name, @content, @context = name, content, context
+
+      Bridgetown::Hooks.trigger :slots, :pre_render, self
+      transform! if transform
+      Bridgetown::Hooks.trigger :slots, :post_render, self
+    end
+
+    def transform!
+      self.content = transform_content(context, alternate_content: content)
+    end
+
+    private
+
+    def converters
+      # A private method calling another private method. Hmm.
+      document_converters = if context.is_a?(Bridgetown::Resource::Base)
+                              context.transformer.send(:converters)
+                            else
+                              context.send(:converters)
+                            end
+
+      document_converters.select { _1.class.supports_slots? }
+    end
+  end
+end

data/lib/bridgetown-core/tasks/bridgetown_tasks.rake

@@ -11,9 +11,8 @@ namespace :frontend do
   task :watcher, :sidecar do |_task, args|
     # sidecar is when the task is running alongside the start command
     sidecar = args[:sidecar] == true
-    Bridgetown::Utils::Aux.group do
-      run_process "Frontend", :yellow, "bundle exec bridgetown frontend:dev"
-    end
+    Bridgetown::Utils::Aux.run_process "Frontend", :yellow, "bundle exec bridgetown frontend:dev"
+
     if sidecar
       # give FE bundler time to boot before returning control to the start command
       sleep Bridgetown::Utils.frontend_bundler_type == :esbuild ? 3 : 4
@@ -28,8 +27,17 @@ namespace :frontend do
   end
 end
 
+namespace :roda do
+  desc "Prints out the Roda routes file"
+  task :routes do
+    require "bridgetown-core/rack/boot"
+
+    Bridgetown::Rack::Roda.print_routes
+  end
+end
+
 desc "Prerequisite task which loads site and provides automation"
-task :environment do
+task :environment do # rubocop:todo Metrics/BlockLength
   class HammerActions < Thor # rubocop:disable Lint/ConstantDefinitionInBlock
     include Thor::Actions
     include Bridgetown::Commands::Actions
@@ -44,8 +52,12 @@ task :environment do
 
     private
 
-    def site
-      @site ||= Bridgetown::Site.new(Bridgetown.configuration)
+    def site(context: :rake)
+      @site ||= begin
+        config = Bridgetown::Current.preloaded_configuration
+        config.run_initializers! context: context
+        Bridgetown::Site.new(config)
+      end
     end
   end
 
@@ -54,8 +66,10 @@ task :environment do
     @hammer.instance_exec(*args, &block)
   end
 
-  define_singleton_method :site do
-    @hammer ||= HammerActions.new
-    @hammer.send(:site)
+  %i(site run_initializers).each do |meth|
+    define_singleton_method meth do |**kwargs|
+      @hammer ||= HammerActions.new
+      @hammer.send(:site, **kwargs)
+    end
   end
 end

data/lib/bridgetown-core/utils/ansi.rb

@@ -1,4 +1,4 @@
-# Frozen-string-literal: true
+# frozen_string_literal: true
 
 module Bridgetown
   module Utils

data/lib/bridgetown-core/utils/aux.rb

@@ -17,14 +17,14 @@ module Bridgetown
         running_pids << pid
       end
 
-      def self.run_process(name, color, cmd)
+      def self.run_process(name, color, cmd, env: {})
+        @mutex ||= Thread::Mutex.new
+
         Thread.new do
           rd, wr = IO.pipe("BINARY")
-          pid = Process.spawn({ "BRIDGETOWN_NO_BUNDLER_REQUIRE" => nil },
+          pid = Process.spawn({ "BRIDGETOWN_NO_BUNDLER_REQUIRE" => nil }.merge(env),
                               cmd, out: wr, err: wr, pgroup: true)
-          @mutex.synchronize do
-            add_pid pid
-          end
+          @mutex.synchronize { add_pid(pid) }
 
           loop do
             line = rd.gets
@@ -42,7 +42,8 @@ module Bridgetown
       end
 
       def self.group(&block)
-        @mutex = Thread::Mutex.new
+        Bridgetown::Deprecator.deprecation_message "Bridgetown::Aux.group method will be removed" \
+                                                   "in a future version, use run_process"
         instance_exec(&block)
       end
 

data/lib/bridgetown-core/utils/initializers.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+Bridgetown.initializer :dotenv do |config|
+  Bridgetown.load_dotenv root: config.root_dir
+end
+
+Bridgetown.initializer :ssr do |config, setup: nil|
+  config.roda do |app|
+    app.plugin(:bridgetown_ssr, &setup)
+  end
+end
+
+Bridgetown.initializer :parse_routes do |config|
+  # This builds upon the work done here:
+  # https://github.com/jeremyevans/roda-route_list/blob/master/bin/roda-parse_routes
+
+  require "roda-route_parser"
+
+  route_files = Dir["#{config.root_dir}/server/**/*.rb"]
+  if config.key?(:routes)
+    config.routes.source_paths.each do |routes_dir|
+      routes_dir = File.expand_path(routes_dir, config.source)
+      route_files += Dir["#{routes_dir}/**/*.*"]
+    end
+  end
+
+  parser = RodaRouteParser.new
+  json_gen_opts = { indent: "  ", space: " ", object_nl: "\n", array_nl: "\n" }
+
+  routing_tree = []
+
+  route_files.each do |route_file|
+    file_contents = File.read(route_file)
+    routes = parser.parse(file_contents)
+
+    next unless routes.present?
+
+    routes.each do |route|
+      route["file"] = route_file
+    end
+    routing_tree += routes
+  end
+
+  File.write(File.join(config.root_dir, ".routes.json"), routing_tree.to_json(json_gen_opts))
+end

data/lib/bridgetown-core/utils/loaders_manager.rb

@@ -9,10 +9,10 @@ module Bridgetown
 
       # @param config [Bridgetown::Configuration]
       # @param root_dir [String] root of the current site
-      def initialize(config, root_dir = Dir.pwd)
+      def initialize(config)
         @config = config
         @loaders = {}
-        @root_dir = root_dir
+        @root_dir = config.root_dir
       end
 
       def unload_loaders