bridgetown-core 1.3.4 → 2.0.0.beta2

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

@@ -1,20 +1,16 @@
 # frozen_string_literal: true
 
-require "active_model"
-
 module Bridgetown
   module Model
     class Base
-      include ActiveModel::Model
-      extend ActiveModel::Callbacks # also extends with DescendantsTracker
-      define_model_callbacks :load, :save, :destroy
+      include Bridgetown::RodaCallable
 
       class << self
         def find(id, site: Bridgetown::Current.site)
           raise "A Bridgetown site must be initialized and added to Current" unless site
 
-          origin = origin_for_id(id, site: site)
-          klass_for_id(id, origin: origin).new(origin.read)
+          origin = origin_for_id(id, site:)
+          klass_for_id(id, origin:).new(origin.read)
         end
 
         def origin_for_id(id, site: Bridgetown::Current.site)
@@ -25,12 +21,12 @@ module Bridgetown
 
           raise "No origin could be found for #{id}" unless origin_klass
 
-          origin_klass.new(id, site: site)
+          origin_klass.new(id, site:)
         end
 
         def klass_for_id(id, origin: nil)
           Bridgetown::Model::Base.descendants.find do |klass|
-            klass.will_load_id?(id, origin: origin)
+            klass.will_load_id?(id, origin:)
           end || Bridgetown::Model::Base
         end
 
@@ -44,7 +40,7 @@ module Bridgetown
           site = builder.site
           data = Bridgetown::Model::BuilderOrigin.new(
             Bridgetown::Model::BuilderOrigin.id_for_builder_path(builder, path),
-            site: site
+            site:
           ).read do
             data[:_collection_] = site.collections[collection_name]
             data
@@ -54,9 +50,7 @@ module Bridgetown
       end
 
       def initialize(attributes = {})
-        run_callbacks :load do
-          super
-        end
+        self.attributes = attributes
       end
 
       def id
@@ -82,9 +76,7 @@ module Bridgetown
           raise "`#{origin.class}' doesn't allow writing of model objects"
         end
 
-        run_callbacks :save do
-          origin.write(self)
-        end
+        origin.write(self)
       end
 
       # @return [Bridgetown::Resource::Base]
@@ -102,6 +94,11 @@ module Bridgetown
         to_resource.read!.transform!
       end
 
+      # Converts this model to a resource and returns the full output
+      #
+      # @return [String]
+      def call(*) = render_as_resource.output
+
       # override if need be
       # @return [Bridgetown::Site]
       def site
@@ -130,6 +127,10 @@ module Bridgetown
         @attributes ||= HashWithDotAccess::Hash.new
       end
 
+      def attributes=(new_attributes)
+        attributes.update new_attributes
+      end
+
       # Strip out keys like _origin_, _collection_, etc.
       # @return [HashWithDotAccess::Hash]
       def data_attributes
@@ -146,7 +147,6 @@ module Bridgetown
         key = method_name.to_s
         if key.end_with?("=")
           key.chop!
-          # attribute_will_change!(key)
           attributes[key] = args.first
           return attributes[key]
         end

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

@@ -34,9 +34,11 @@ module Bridgetown
         @data
       end
 
-      def exists?
-        false
-      end
+      def front_matter_line_count = @data[:_front_matter_line_count_]
+
+      def original_path = @data[:_original_path_] || relative_path
+
+      def exists? = false
 
       def read_data_from_builder
         builder = Kernel.const_get(url.host.gsub(".", "::"))

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

@@ -4,8 +4,6 @@ module Bridgetown
   module Model
     # Abstract Superclass
     class Origin
-      extend ActiveSupport::DescendantsTracker
-
       EAGER_LOAD_DESCENDANTS = %i(BuilderOrigin RepoOrigin PluginOrigin).freeze
 
       # @return [String]
@@ -30,7 +28,7 @@ module Bridgetown
 
         return klass.collection_name.to_s == collection_name if klass.respond_to?(:collection_name)
 
-        klass.name == ActiveSupport::Inflector.classify(collection_name)
+        klass.name == site.config.inflector.classify(collection_name)
       end
 
       def read

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

@@ -3,13 +3,8 @@
 module Bridgetown
   module Model
     class RepoOrigin < Origin
-      include Bridgetown::FrontMatterImporter
-      include Bridgetown::Utils::RubyFrontMatterDSL
-
-      YAML_FRONT_MATTER_REGEXP = %r!\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m.freeze
-      RUBY_FRONT_MATTER_HEADER = %r!\A[~`#-]{3,}(?:ruby|<%|{%)\s*\n!.freeze
-      RUBY_FRONT_MATTER_REGEXP =
-        %r!#{RUBY_FRONT_MATTER_HEADER.source}(.*?\n?)^((?:%>|%})?[~`#-]{3,}\s*$\n?)!m.freeze
+      using Bridgetown::Refinements
+      include Bridgetown::FrontMatter::Importer
 
       # @return [String]
       attr_accessor :content
@@ -35,7 +30,7 @@ module Bridgetown
         def new_with_collection_path(collection, relative_path, site: Bridgetown::Current.site)
           collection = collection.label if collection.is_a?(Bridgetown::Collection)
 
-          new("repo://#{collection}.collection/#{relative_path}", site: site)
+          new("repo://#{collection}.collection/#{relative_path}", site:)
         end
       end
 
@@ -88,11 +83,9 @@ module Bridgetown
       def collection
         return @collection if @collection
 
-        collection_name = if url.host.ends_with?(".collection")
-                            url.host.chomp(".collection")
-                          else
+        collection_name = url.host.ends_with?(".collection") ?
+                            url.host.chomp(".collection") :
                             "pages"
-                          end
         @collection = site.collections[collection_name]
       end
 
@@ -107,7 +100,7 @@ module Bridgetown
       private
 
       def in_data_collection?
-        original_path.extname.downcase.in?(self.class.data_file_extensions) &&
+        original_path.extname.downcase.within?(self.class.data_file_extensions) &&
           collection.data?
       end
 
@@ -129,7 +122,12 @@ module Bridgetown
                        encoding: site.config["encoding"]).map(&:to_hash),
           }
         when ".rb"
-          process_ruby_data(File.read(original_path), original_path, 1)
+          Bridgetown::Utils::RubyExec.process_ruby_data(
+            self,
+            File.read(original_path),
+            original_path,
+            1
+          )
         when ".json"
           json_data = JSON.parse(File.read(original_path))
           json_data.is_a?(Array) ? { rows: json_data } : json_data

data/lib/bridgetown-core/plugin.rb

@@ -2,7 +2,6 @@
 
 module Bridgetown
   class Plugin
-    extend ActiveSupport::DescendantsTracker
     include Bridgetown::Prioritizable
 
     self.priorities = {

data/lib/bridgetown-core/plugin_manager.rb

@@ -2,44 +2,12 @@
 
 module Bridgetown
   class PluginManager
-    LEGACY_PLUGINS_GROUP = :bridgetown_plugins
-    YARN_DEPENDENCY_REGEXP = %r!(.+)@([^@]*)$!.freeze
+    NPM_DEPENDENCY_REGEXP = %r!(.+)@([^@]*)$!
 
     attr_reader :site, :loaders_manager
 
     @registered_plugins = Set.new
 
-    # @param source_manifest [Bridgetown::Configuration::SourceManifest]
-    def self.add_source_manifest(source_manifest)
-      unless source_manifest.is_a?(Bridgetown::Configuration::SourceManifest)
-        raise "You must add a SourceManifest instance"
-      end
-
-      unless Bridgetown::Current.preloaded_configuration
-        raise "A preloaded configuration must be present before adding source manifests"
-      end
-
-      Bridgetown::Deprecator.deprecation_message(
-        "The #{source_manifest.origin} plugin should switch from using `add_source_manifest' to " \
-        "the `source_manifest` initializer method"
-      )
-
-      Bridgetown::Current.preloaded_configuration.source_manifests << source_manifest
-    end
-
-    def self.new_source_manifest(*_args, **kwargs)
-      unless Bridgetown::Current.preloaded_configuration
-        raise "A preloaded configuration must be present before adding source manifests"
-      end
-
-      Bridgetown::Deprecator.deprecation_message(
-        "The #{kwargs[:origin]} plugin should switch from using `new_source_manifest' to the " \
-        "`source_manifest` initializer method"
-      )
-
-      add_source_manifest(Bridgetown::Configuration::SourceManifest.new(**kwargs))
-    end
-
     def self.add_registered_plugin(gem_or_plugin_file)
       @registered_plugins << gem_or_plugin_file
     end
@@ -50,23 +18,16 @@ module Bridgetown
       def bundler_specs
         @bundler_specs ||= Bundler.load.requested_specs
       end
-
-      def source_manifests
-        Bridgetown::Deprecator.deprecation_message(
-          "Use the configuration's `source_manifests` method instead of the plugin manager"
-        )
-
-        Bridgetown::Current.preloaded_configuration.source_manifests
-      end
     end
 
-    def self.setup_bundler(skip_yarn: false)
+    def self.setup_bundler
       if !ENV["BRIDGETOWN_NO_BUNDLER_REQUIRE"] &&
           (Bundler::SharedHelpers.in_bundle? || Bridgetown.env.test?)
         require "bundler"
 
         require_relative "utils/initializers"
-        load_determined_bundler_environment(skip_yarn: skip_yarn)
+        load_determined_bundler_environment
+        require_plugin_features
 
         ENV["BRIDGETOWN_NO_BUNDLER_REQUIRE"] = "true"
         true
@@ -78,7 +39,7 @@ module Bridgetown
       alias_method :require_from_bundler, :setup_bundler
     end
 
-    def self.load_determined_bundler_environment(skip_yarn: false)
+    def self.load_determined_bundler_environment
       boot_file = File.join("config", "boot.rb")
 
       if File.file?(boot_file)
@@ -89,15 +50,22 @@ module Bridgetown
         # Note: the default Bundler config will set up all gem groups,
         #   see: https://bundler.io/guides/groups.html
         Bundler.setup(:default, Bridgetown.env)
-      else
-        # Only setup and require :bridgetown_plugins
-        legacy_yarn_and_register(legacy_require, skip_yarn: skip_yarn)
+      end
+    end
+
+    def self.require_plugin_features
+      bundler_specs.select do |loaded_gem|
+        loaded_gem.to_spec.metadata["bridgetown_features"] == "true"
+      end.each do |plugin_gem|
+        Bridgetown::Utils::RequireGems.require_with_graceful_fail(
+          "bridgetown/features/#{plugin_gem.name}"
+        )
       end
     end
 
     def self.require_gem(name)
       Bridgetown::Utils::RequireGems.require_with_graceful_fail(name)
-      plugins = Bridgetown::PluginManager.install_yarn_dependencies(name: name)
+      plugins = Bridgetown::PluginManager.install_npm_dependencies(name:)
 
       plugin_to_register = if plugins.length == 1
                              plugins.first
@@ -112,28 +80,11 @@ module Bridgetown
                               "Registered #{plugin_to_register.name}")
     end
 
-    def self.legacy_require
-      Bundler.require(LEGACY_PLUGINS_GROUP).select do |dep|
-        (dep.groups & [LEGACY_PLUGINS_GROUP]).any? && dep.should_include?
-      end
-    end
-
-    def self.legacy_yarn_and_register(required_gems, skip_yarn: false)
-      install_yarn_dependencies(required_gems) unless skip_yarn
-
-      required_gems.each do |installed_gem|
-        add_registered_plugin installed_gem
-      end
-
-      Bridgetown.logger.debug("PluginManager:",
-                              "Required #{required_gems.map(&:name).join(", ")}")
-    end
-
     def self.package_manager
-      @package_manager ||= if File.exist?("yarn.lock")
-                             "yarn"
-                           elsif File.exist?("package-lock.json")
+      @package_manager ||= if File.exist?("package-lock.json")
                              "npm"
+                           elsif File.exist?("yarn.lock")
+                             "yarn"
                            elsif File.exist?("pnpm-lock.yaml")
                              "pnpm"
                            else
@@ -147,11 +98,11 @@ module Bridgetown
 
     # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
-    # Iterates through loaded gems and finds yard-add gemspec metadata.
-    # If that exact package hasn't been installed, execute yarn add
+    # Iterates through loaded gems and finds npm-add gemspec metadata.
+    # If that exact package hasn't been installed, execute npm i
     #
     # @return [Bundler::SpecSet]
-    def self.install_yarn_dependencies(required_gems = bundler_specs, name: nil)
+    def self.install_npm_dependencies(required_gems = bundler_specs, name: nil)
       return required_gems unless File.exist?("package.json")
 
       package_json = JSON.parse(File.read("package.json"))
@@ -166,34 +117,37 @@ module Bridgetown
 
       # all right, time to install the package
       gems_to_search.each do |loaded_gem|
-        yarn_dependency = find_yarn_dependency(loaded_gem)
-        next unless add_yarn_dependency?(yarn_dependency, package_json)
+        npm_dependency = find_npm_dependency(loaded_gem)
+        next unless add_npm_dependency?(npm_dependency, package_json)
 
         next if package_manager.empty?
 
-        cmd = "#{package_manager} #{package_manager_install_command} #{yarn_dependency.join("@")}"
+        cmd = "#{package_manager} #{package_manager_install_command} #{npm_dependency.join("@")}"
         system cmd
       end
 
       gems_to_search
     end
 
-    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
-
-    def self.find_yarn_dependency(loaded_gem)
-      yarn_dependency = loaded_gem.to_spec&.metadata&.dig("yarn-add")&.match(YARN_DEPENDENCY_REGEXP)
-      return nil if yarn_dependency&.length != 3 || yarn_dependency[2] == ""
+    def self.find_npm_dependency(loaded_gem)
+      npm_metadata = loaded_gem.to_spec&.metadata&.dig("npm-add") ||
+        loaded_gem.to_spec&.metadata&.dig("yarn-add")
+      npm_dependency = npm_metadata&.match(NPM_DEPENDENCY_REGEXP)
+      return nil if npm_dependency&.length != 3 || npm_dependency[2] == ""
 
-      yarn_dependency[1..2]
+      npm_dependency[1..2]
     end
 
-    def self.add_yarn_dependency?(yarn_dependency, package_json)
-      return false if yarn_dependency.nil?
+    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+
+    def self.add_npm_dependency?(npm_dependency, package_json)
+      return false if npm_dependency.nil?
 
       # check matching version number is see if it's already installed
       if package_json["dependencies"]
-        current_version = package_json["dependencies"][yarn_dependency.first]
-        package_requires_updating?(current_version, yarn_dependency.last)
+        current_version = package_json["dependencies"][npm_dependency.first]
+        current_version = current_version.delete_prefix("^") if current_version
+        package_requires_updating?(current_version, npm_dependency.last)
       else
         true
       end

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

@@ -3,27 +3,14 @@
 require "zeitwerk"
 require "roda"
 require "json"
-require "roda/plugins/public"
 
 Bridgetown::Current.preloaded_configuration ||= Bridgetown.configuration
 
 require_relative "logger"
 require_relative "routes"
-require_relative "static_indexes"
 
 module Bridgetown
   module Rack
-    class Roda < ::Roda
-      def self.inherited(klass)
-        Bridgetown::Deprecator.deprecation_message(
-          "The `Bridgetown::Rack::Roda' class will be removed in favor of using the " \
-          "`bridgetown_server' plugin in a future version"
-        )
-        super
-        klass.plugin :bridgetown_server
-      end
-    end
-
     class << self
       # @return [Bridgetown::Utils::LoadersManager]
       attr_accessor :loaders_manager
@@ -76,7 +63,6 @@ module Bridgetown
 
             loader.reload
             loader.eager_load
-            Bridgetown::Rack::Routes.reload_subclasses
           rescue SyntaxError => e
             Bridgetown::Errors.print_build_error(e)
           end.start
@@ -89,7 +75,6 @@ module Bridgetown
         next unless load_path == server_folder
 
         loader.eager_load
-        Bridgetown::Rack::Routes.reload_subclasses
       end
 
       loaders_manager.setup_loaders([server_folder])

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

@@ -2,12 +2,6 @@
 
 module Bridgetown
   module Rack
-    @interrupted = false
-
-    class << self
-      attr_accessor :interrupted
-    end
-
     class Routes
       include Bridgetown::Prioritizable
 
@@ -34,7 +28,7 @@ module Bridgetown
           end
           puts
           puts "Routes:"
-          puts "======="
+          puts "=======\n"
           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-"
@@ -51,9 +45,6 @@ module Bridgetown
         end
         # rubocop:enable Bridgetown/NoPutsAllowed, Metrics/MethodLength
 
-        # @return [Hash<String, Class(Routes)>]
-        attr_accessor :tracked_subclasses
-
         # @return [Proc]
         attr_accessor :router_block
 
@@ -65,30 +56,9 @@ module Bridgetown
           "#{priorities[priority]}#{self}" <=> "#{priorities[other.priority]}#{other}"
         end
 
-        # @param base [Class(Routes)]
-        def inherited(base)
-          Bridgetown::Rack::Routes.track_subclass base
-          super
-        end
-
-        # @param klass [Class(Routes)]
-        def track_subclass(klass)
-          Bridgetown::Rack::Routes.tracked_subclasses ||= {}
-          Bridgetown::Rack::Routes.tracked_subclasses[klass.name] = klass
-        end
-
         # @return [Array<Class(Routes)>]
         def sorted_subclasses
-          Bridgetown::Rack::Routes.tracked_subclasses&.values&.sort
-        end
-
-        # @return [void]
-        def reload_subclasses
-          Bridgetown::Rack::Routes.tracked_subclasses&.each_key do |klassname|
-            Kernel.const_get(klassname)
-          rescue NameError
-            Bridgetown::Rack::Routes.tracked_subclasses.delete klassname
-          end
+          Bridgetown::Rack::Routes.descendants.sort
         end
 
         # Add a router block via the current Routes class
@@ -118,36 +88,11 @@ module Bridgetown
           new(roda_app).handle_routes
         end
 
-        # Start the Roda app request cycle. There are two different code paths
-        # depending on if there's a site `base_path` configured
+        # Set up live reload if allowed, then run through all the Routes blocks.
         #
         # @param roda_app [Roda]
         # @return [void]
-        def start!(roda_app)
-          if Bridgetown::Current.preloaded_configuration.base_path == "/"
-            load_all_routes roda_app
-            return
-          end
-
-          # Support custom base_path configurations
-          roda_app.request.on(
-            Bridgetown::Current.preloaded_configuration.base_path.delete_prefix("/")
-          ) do
-            load_all_routes roda_app
-          end
-
-          nil
-        end
-
-        # Run the Roda public plugin first, set up live reload if allowed, then
-        # run through all the Routes blocks. If the file-based router plugin
-        # is available, kick off that request process next.
-        #
-        # @param roda_app [Roda]
-        # @return [void]
-        def load_all_routes(roda_app)
-          roda_app.request.public
-
+        def load_all(roda_app)
           if Bridgetown.env.development? &&
               !Bridgetown::Current.preloaded_configuration.skip_live_reload
             setup_live_reload roda_app
@@ -160,33 +105,40 @@ module Bridgetown
 
         # @param app [Roda]
         def setup_live_reload(app) # rubocop:disable Metrics
-          sleep_interval = 0.2
+          sleep_interval = 0.5
           file_to_check = File.join(Bridgetown::Current.preloaded_configuration.destination,
                                     "index.html")
           errors_file = Bridgetown.build_errors_path
 
           app.request.get "_bridgetown/live_reload" do
-            app.response["Content-Type"] = "text/event-stream"
-
             @_mod = File.exist?(file_to_check) ? File.stat(file_to_check).mtime.to_i : 0
-            app.stream async: true do |out|
-              # 5 second intervals so Puma's threads aren't all exausted
-              (5 / sleep_interval).to_i.times do
-                break if Bridgetown::Rack.interrupted
-
-                new_mod = File.exist?(file_to_check) ? File.stat(file_to_check).mtime.to_i : 0
-                if @_mod < new_mod
-                  out << "data: reloaded!\n\n"
+            event_stream = proc do |stream|
+              Thread.new do
+                loop do
+                  new_mod = File.exist?(file_to_check) ? File.stat(file_to_check).mtime.to_i : 0
+
+                  if @_mod < new_mod
+                    stream.write "data: reloaded!\n\n"
+                    break
+                  elsif File.exist?(errors_file)
+                    stream.write "event: builderror\ndata: #{File.read(errors_file).to_json}\n\n"
+                  else
+                    stream.write "data: #{new_mod}\n\n"
+                  end
+
+                  sleep sleep_interval
+                rescue Errno::EPIPE # User refreshed the page
                   break
-                elsif File.exist?(errors_file)
-                  out << "event: builderror\ndata: #{File.read(errors_file).to_json}\n\n"
-                else
-                  out << "data: #{new_mod}\n\n"
                 end
-
-                sleep sleep_interval
+              ensure
+                stream.close
               end
             end
+
+            app.request.halt [200, {
+              "Content-Type"  => "text/event-stream",
+              "cache-control" => "no-cache",
+            }, event_stream,]
           end
         end
       end
@@ -205,9 +157,9 @@ module Bridgetown
       end
 
       # Any missing methods are passed along to the underlying Roda app if possible
-      def method_missing(method_name, *args, **kwargs, &block)
+      def method_missing(method_name, ...)
         if @_roda_app.respond_to?(method_name.to_sym)
-          @_roda_app.send method_name.to_sym, *args, **kwargs, &block
+          @_roda_app.send(method_name.to_sym, ...)
         else
           super
         end
@@ -219,15 +171,3 @@ module Bridgetown
     end
   end
 end
-
-if defined?(Puma) && Bridgetown.env.development? &&
-    !Bridgetown::Current.preloaded_configuration.skip_live_reload
-  Puma::Launcher.class_eval do
-    alias_method :_old_stop, :stop
-    def stop
-      Bridgetown::Rack.interrupted = true
-
-      _old_stop
-    end
-  end
-end

data/lib/bridgetown-core/reader.rb

@@ -38,7 +38,7 @@ module Bridgetown
       site.collections.each_value do |collection|
         next if collection.data?
 
-        collection.read
+        collection.read unless site.ssr? && collection.metadata.skip_for_ssr
       end
     end
 
@@ -69,7 +69,7 @@ module Bridgetown
         file_path = @site.in_source_dir(base, entry)
         if File.directory?(file_path)
           entries_dirs << entry
-        elsif Utils.has_yaml_header?(file_path) || Utils.has_rbfm_header?(file_path)
+        elsif FrontMatter::Loaders.front_matter?(file_path)
           entries_pages << entry
         else
           entries_static_files << entry
@@ -78,7 +78,7 @@ module Bridgetown
 
       retrieve_dirs(dir, entries_dirs)
       retrieve_pages(dir, entries_pages)
-      retrieve_static_files(dir, entries_static_files)
+      retrieve_static_files(dir, entries_static_files) unless site.ssr?
     end
 
     # Recursively traverse directories with the read_directories function.
@@ -101,6 +101,8 @@ module Bridgetown
     # @param entries_pages [Array<String>] page paths in the directory
     # @return [void]
     def retrieve_pages(dir, entries_pages)
+      return if site.ssr? && site.collections.pages.metadata.skip_for_ssr
+
       entries_pages.each do |page_path|
         site.collections.pages.read_resource(site.in_source_dir(dir, page_path))
       end
@@ -129,7 +131,7 @@ module Bridgetown
     #
     # Returns the Array of filtered entries.
     def filter_entries(entries, base_directory = nil)
-      EntryFilter.new(site, base_directory: base_directory).filter(entries)
+      EntryFilter.new(site, base_directory:).filter(entries)
     end
 
     # Read the entries from a particular directory for processing