bridgetown-core 1.0.0.alpha6 → 1.0.0.alpha10

data/lib/bridgetown-core/configurations/cypress/cypress_dir/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add("login", (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

data/lib/bridgetown-core/configurations/cypress/cypress_dir/support/index.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

data/lib/bridgetown-core/configurations/cypress/cypress_tasks

@@ -0,0 +1,33 @@
+namespace :cy do
+  desc "Open Cypress test runner"
+  task :open do
+    system "yarn run cypress open"
+  end
+
+  desc "Run Cypress tests headless"
+  task :run do
+    system "yarn run cypress run"
+  end
+
+  desc "Start server and open Cypress test runner"
+  task :test do
+    ENV["BRIDGETOWN_ENV"] = "test"
+    server_pid = fork { Bridgetown::Commands::Start.start }
+    Rake::Task["cy:open"].execute
+    Process.kill "SIGTERM", server_pid
+    sleep 1 # give processes time to clean up
+    puts
+  end
+
+  namespace :test do
+    desc "Start server and run Cypress tests headless"
+    task :ci do
+      ENV["BRIDGETOWN_ENV"] = "test"
+      server_pid = fork { Bridgetown::Commands::Start.start }
+      Rake::Task["cy:run"].execute
+      Process.kill "SIGTERM", server_pid
+      sleep 1 # give processes time to clean up
+      puts
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Install packages
+
+say "Installing Cypress...", :green
+run "yarn add -D cypress"
+
+# Copy cypress files and tasks into place
+cypress_tasks = File.read(in_templates_dir("cypress_tasks"))
+
+copy_file in_templates_dir("cypress.json"), "cypress.json"
+inject_into_file("Rakefile", "\n#{cypress_tasks}")
+directory in_templates_dir("cypress_dir"), "cypress"

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

@@ -2,7 +2,7 @@
 
 # rubocop:disable all
 
-say_status :minitesting, "Adding test gems, package.json scripts, and examples"
+say_status :minitesting, "Adding test gems and examples"
 
 append_to_file "Gemfile" do
   <<~GEMS
@@ -18,12 +18,6 @@ append_to_file "Gemfile" do
   GEMS
 end
 
-new_scripts = '    "test": "BRIDGETOWN_ENV=test yarn build",'
-new_scripts += "\n" + '    "deploy:test": "bundle install --with test && yarn deploy"'
-package_json = "package.json"
-script_regex = %r{"scripts": \{(\s+".*,?)*}
-inject_into_file(package_json, ",\n" + new_scripts, after: script_regex)
-
 create_file "test/helper.rb" do
   <<~RUBY
     require "nokogiri"
@@ -32,23 +26,29 @@ create_file "test/helper.rb" do
     require "minitest/profile"
     require "shoulda"
     require "rails-dom-testing"
+
     # Report with color.
     Minitest::Reporters.use! [
       Minitest::Reporters::DefaultReporter.new(
         color: true
       ),
     ]
+
     Minitest::Test.class_eval do
       include Rails::Dom::Testing::Assertions
+
       def site
         @site ||= Bridgetown.sites.first
       end
+
       def nokogiri(input)
         input.respond_to?(:output) ? Nokogiri::HTML(input.output) : Nokogiri::HTML(input)
       end
+
       def document_root(root)
         @document_root = root.is_a?(Nokogiri::XML::Document) ? root : nokogiri(root)
       end
+
       def document_root_element
         if @document_root.nil?
           raise "Call `document_root' with a Nokogiri document before testing your assertions"
@@ -62,12 +62,14 @@ end
 create_file "test/test_homepage.rb" do
   <<~RUBY
     require_relative "./helper"
+
     class TestHomepage < Minitest::Test
       context "homepage" do
         setup do
           page = site.collections.pages.resources.find { |doc| doc.relative_url == "/" }
           document_root page
         end
+
         should "exist" do
           assert_select "body"
         end
@@ -78,18 +80,20 @@ end
 
 create_file "plugins/test_output.rb" do
   <<~RUBY
-    unless Bridgetown.environment == "development"
-      Bridgetown::Hooks.register :site, :post_write do
-        # Load test suite to run on exit
-        require "nokogiri"
-        Dir["test/**/*.rb"].each { |file| require_relative("../\#{file}") }
-      rescue LoadError
-        Bridgetown.logger.warn "Testing:", "To run tests, you must first run \`bundle install --with test\`"
+    module TestOutput
+      unless Bridgetown.env.development?
+        Bridgetown::Hooks.register :site, :post_write do
+          # Load test suite to run on exit
+          require "nokogiri"
+          Dir["test/**/*.rb"].each { |file| require_relative("../\#{file}") }
+        rescue LoadError
+          Bridgetown.logger.warn "Testing:", "To run tests, you must first run \`bundle install --with test\`"
+        end
       end
     end
   RUBY
 end
 
-say_status :minitesting, "All set! To get started, look at test/test_homepage.rb and then run \`yarn test\`"
+say_status :minitesting, "All set! To get started, look at test/test_homepage.rb and then run \`bin/bridgetown test\`"
 
 # rubocop:enable all

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-TEMPLATE_PATH = File.expand_path("./netlify", __dir__)
-
-copy_file "#{TEMPLATE_PATH}/netlify.toml", "netlify.toml"
-copy_file "#{TEMPLATE_PATH}/netlify.sh", "bin/netlify.sh"
+copy_file in_templates_dir("netlify.toml"), "netlify.toml"
+copy_file in_templates_dir("netlify.sh"), "bin/netlify.sh"
 `chmod a+x ./bin/netlify.sh`

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

@@ -6,9 +6,9 @@ say_status :purgecss, "Installing PurgeCSS"
 
 run "yarn add -D purgecss"
 
-create_builder "purgecss_builder.rb" do
+create_builder "purgecss.rb" do
   <<~RUBY
-    class PurgeCSS < SiteBuilder
+    class Builders::Purgecss < SiteBuilder
       def build
         unless config[:watch] # don't run in "watch mode"
           hook :site, :post_write do

data/lib/bridgetown-core/configurations/render/render.yaml.erb

@@ -0,0 +1,26 @@
+services:
+  - type: web
+    name: <%= @render_service_name %>
+    env: static
+    buildCommand: bin/bridgetown deploy
+    staticPublishPath: ./output
+    pullRequestPreviewsEnabled: true
+    headers:
+      - path: /*
+        name: X-Frame-Options
+        value: DENY
+      - path: /*
+        name: X-XSS-Protection
+        value: "1; mode=block"
+      - path: /*
+        name: X-Content-Type-Options
+        value: "nosniff"
+      - path: /*
+        name: Strict-Transport-Security
+        value: "max-age=15552000; includeSubDomains"
+      - path: /*
+        name: Referrer-Policy
+        value: "no-referrer-when-downgrade"
+      - path: /*
+        name: Cache-Control
+        value: "public, max-age=86400, s-max-age=86400"

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+@render_service_name = ask "What would like to call your Render service?"
+template in_templates_dir("render.yaml.erb"), "render.yaml"
+
+say "All done. Just create a new blueprint from the Render dashboard and connect this repo."

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

@@ -2,8 +2,6 @@
 
 # rubocop:disable all
 
-TEMPLATE_PATH = File.expand_path("./tailwindcss", __dir__)
-
 unless File.exist?("postcss.config.js")
   error_message = "#{"postcss.config.js".bold} not found. Please configure postcss in your project."
 
@@ -19,16 +17,16 @@ return unless confirm.casecmp?("Y")
 run "yarn add -D tailwindcss"
 run "npx tailwindcss init"
 
-copy_file "#{TEMPLATE_PATH}/postcss.config.js", "postcss.config.js", force: true
+copy_file in_templates_dir("postcss.config.js"), "postcss.config.js", force: true
 
 run "bundle exec bridgetown configure purgecss"
 
 if File.exist?("frontend/styles/index.css")
   prepend_to_file "frontend/styles/index.css",
-                  File.read("#{TEMPLATE_PATH}/css_imports.css")
+                  File.read(in_templates_dir("css_imports.css"))
 else
   say "\nPlease add the following lines to your CSS index file:"
-  say File.read("#{TEMPLATE_PATH}/css_imports.css")
+  say File.read(in_templates_dir("/css_imports.css"))
 end
 
 # rubocop:enable all

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

@@ -38,7 +38,7 @@ module Bridgetown
       return if text.empty?
 
       src << bufvar << ".safe_append='"
-      src << text.gsub(%r{['\\]}, '\\\\\&') # rubocop:disable Style/StringLiterals
+      src << text.gsub(%r{['\\]}, '\\\\\&')
       src << "'.freeze;"
     end
 

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

@@ -23,7 +23,7 @@ module Kramdown
         @options ||= Options.merge(options).freeze
         @parser  ||= begin
           parser_name = (@options[:input] || "kramdown").to_s
-          parser_name = parser_name[0..0].upcase + parser_name[1..-1]
+          parser_name = parser_name[0..0].upcase + parser_name[1..]
           try_require("parser", parser_name)
 
           if Parser.const_defined?(parser_name)

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "serbea"
+require "rouge/lexers/serbea"
+
+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
+
+      partial_segments = partial_name.split("/")
+      partial_segments.last.sub!(%r!^!, "_")
+      partial_name = partial_segments.join("/")
+
+      Tilt::SerbeaTemplate.new(
+        site.in_source_dir(site.config[:partials_dir], "#{partial_name}.serb")
+      ).render(self, options)
+    end
+  end
+
+  module Converters
+    class SerbeaTemplates < Converter
+      priority :highest
+      input :serb
+
+      # Logic to do the Serbea content conversion.
+      #
+      # @param content [String] Content of the file (without front matter).
+      # @param convertible [
+      #   Bridgetown::GeneratedPage, Bridgetown::Resource::Base, Bridgetown::Layout]
+      #   The instantiated object which is processing the file.
+      #
+      # @return [String] The converted content.
+      def convert(content, convertible)
+        return content if convertible.data[:template_engine].to_s != "serbea"
+
+        serb_view = Bridgetown::SerbeaView.new(convertible)
+
+        serb_renderer = Tilt::SerbeaTemplate.new(convertible.relative_path) { content }
+
+        if convertible.is_a?(Bridgetown::Layout)
+          serb_renderer.render(serb_view) do
+            convertible.current_document_output
+          end
+        else
+          serb_renderer.render(serb_view)
+        end
+      end
+
+      def matches(ext, convertible)
+        if convertible.data[:template_engine].to_s == "serbea" ||
+            (convertible.data[:template_engine].nil? &&
+              @config[:template_engine].to_s == "serbea")
+          convertible.data[:template_engine] = "serbea"
+          return true
+        end
+
+        super(ext).tap do |ext_matches|
+          convertible.data[:template_engine] = "serbea" if ext_matches
+        end
+      end
+
+      def output_ext(ext)
+        ext == ".serb" ? ".html" : ext
+      end
+    end
+  end
+end

data/lib/bridgetown-core/core_ext/psych.rb

@@ -6,11 +6,7 @@ module Bridgetown
       module SafeLoadFile
         def safe_load_file(filename, **kwargs)
           File.open(filename, "r:bom|utf-8") do |f|
-            if RUBY_VERSION.start_with?("2.5")
-              safe_load f, kwargs[:permitted_classes], [], false, filename
-            else
-              safe_load f, filename: filename, **kwargs
-            end
+            safe_load f, filename: filename, **kwargs
           end
         end
       end

data/lib/bridgetown-core/frontmatter_defaults.rb

@@ -181,7 +181,7 @@ module Bridgetown
       sets = site.config["defaults"]
       return [] unless sets.is_a?(Array)
 
-      sets.map do |set|
+      sets.filter_map do |set|
         if valid?(set)
           massage_scope!(set)
           # TODO: is this trip really necessary?
@@ -191,7 +191,7 @@ module Bridgetown
           Bridgetown.logger.warn set.to_s
           nil
         end
-      end.compact
+      end
     end
 
     # Set path to blank if not specified and alias older type to collection

data/lib/bridgetown-core/liquid_renderer/file_system.rb

@@ -31,9 +31,7 @@ module Bridgetown
         raise Liquid::FileSystemError, "No such template '#{template_path}'" if found_paths.empty?
 
         # Last path in the list wins
-        LiquidComponent.parse(
-          ::File.read(found_paths.last, **site.file_read_opts)
-        ).content
+        ::File.read(found_paths.last, **site.file_read_opts)
       end
     end
   end

data/lib/bridgetown-core/liquid_renderer.rb

@@ -15,7 +15,7 @@ module Bridgetown
 
       # Set up Liquid file system access to components for the Render tag
       Liquid::Template.file_system = LiquidRenderer::FileSystem.new(
-        @site.components_load_paths, "%s.liquid"
+        @site.config.components_load_paths, "%s.liquid"
       )
       Liquid::Template.file_system.site = site
 

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

@@ -9,40 +9,37 @@ module Bridgetown
       extend ActiveModel::Callbacks # also extends with DescendantsTracker
       define_model_callbacks :load, :save, :destroy
 
-      def self.loads_id?(id)
-        name == ActiveSupport::Inflector.classify(
-          URI.parse(id).host.chomp(".collection")
-        )
-      end
+      class << self
+        def find(id)
+          unless Bridgetown::Current.site
+            raise "A Bridgetown site must be initialized and added to Current"
+          end
 
-      def self.find(id)
-        unless Bridgetown::Current.site
-          raise "A Bridgetown site must be initialized and added to Current"
+          origin = origin_for_id(id)
+          klass_for_id(id, origin: origin).new(origin.read)
         end
 
-        model_klass = klass_for_id(id)
-        model_klass.new(read_data_for_id(id))
-      end
-
-      def self.klass_for_id(id)
-        descendants.find do |klass|
-          klass.loads_id?(id)
-        end || self
-      end
+        def origin_for_id(id)
+          scheme = URI.parse(id).scheme
+          origin_klass = Origin.descendants.find do |klass|
+            klass.handle_scheme?(scheme)
+          end
 
-      def self.read_data_for_id(id)
-        origin_for_id(id).read
-      end
+          raise "No origin could be found for #{id}" unless origin_klass
 
-      def self.origin_for_id(id)
-        scheme = URI.parse(id).scheme
-        origin_klass = Origin.descendants.find do |klass|
-          klass.handle_scheme?(scheme)
+          origin_klass.new(id)
         end
 
-        raise "No origin could be found for #{id}" unless origin_klass
+        def klass_for_id(id, origin: nil)
+          Bridgetown::Model::Base.descendants.find do |klass|
+            klass.will_load_id?(id, origin: origin)
+          end || Bridgetown::Model::Base
+        end
 
-        origin_klass.new(id)
+        def will_load_id?(id, origin: nil)
+          origin ||= origin_for_id(id)
+          origin.verify_model?(self)
+        end
       end
 
       class << self

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

@@ -6,12 +6,14 @@ module Bridgetown
       # @return [Pathname]
       attr_reader :relative_path
 
-      def self.handle_scheme?(scheme)
-        scheme == "builder"
-      end
-
-      def self.id_for_builder_path(builder, path)
-        "builder://#{builder.class.name.gsub("::", ".")}/#{path}"
+      class << self
+        def handle_scheme?(scheme)
+          scheme == "builder"
+        end
+
+        def id_for_builder_path(builder, path)
+          "builder://#{builder.class.name.gsub("::", ".")}/#{path}"
+        end
       end
 
       def initialize(id)

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

@@ -11,7 +11,7 @@ module Bridgetown
       # @return [String]
       attr_accessor :id
 
-      # Override in subclass
+      # You must implement in subclasses
       def self.handle_scheme?(_scheme)
         false
       end
@@ -20,6 +20,15 @@ module Bridgetown
         self.id = id
       end
 
+      # You can override in subclass
+      def verify_model?(klass)
+        collection_name = URI.parse(id).host.chomp(".collection")
+
+        return klass.collection_name.to_s == collection_name if klass.respond_to?(:collection_name)
+
+        klass.name == ActiveSupport::Inflector.classify(collection_name)
+      end
+
       def read
         raise "Implement #read in a subclass of Bridgetown::Model::Origin"
       end

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

@@ -22,7 +22,7 @@ module Bridgetown
 
       def relative_path
         @relative_path ||= Pathname.new(
-          Addressable::URI.unescape(url.path.delete_prefix("/")).split("/")[1..-1].join("/")
+          Addressable::URI.unescape(url.path.delete_prefix("/")).split("/")[1..].join("/")
         )
       end
 

data/lib/bridgetown-core/plugin_manager.rb

@@ -5,7 +5,7 @@ module Bridgetown
     PLUGINS_GROUP = :bridgetown_plugins
     YARN_DEPENDENCY_REGEXP = %r!(.+)@([^@]*)$!.freeze
 
-    attr_reader :site, :component_loaders
+    attr_reader :site, :loaders_manager
 
     @source_manifests = Set.new
     @registered_plugins = Set.new
@@ -18,8 +18,8 @@ module Bridgetown
       @source_manifests << source_manifest
     end
 
-    def self.new_source_manifest(*args)
-      add_source_manifest(Bridgetown::Plugin::SourceManifest.new(*args))
+    def self.new_source_manifest(*args, **kwargs)
+      add_source_manifest(Bridgetown::Plugin::SourceManifest.new(*args, **kwargs))
     end
 
     def self.add_registered_plugin(gem_or_plugin_file)
@@ -37,15 +37,14 @@ module Bridgetown
     # Returns nothing
     def initialize(site)
       @site = site
-      @component_loaders = {}
+      @loaders_manager = Bridgetown::Utils::LoadersManager.new(site.config)
     end
 
     def self.require_from_bundler
       if !ENV["BRIDGETOWN_NO_BUNDLER_REQUIRE"] && File.file?("Gemfile")
         require "bundler"
 
-        required_gems = Bundler.require PLUGINS_GROUP
-        required_gems.select! do |dep|
+        required_gems = Bundler.require(PLUGINS_GROUP).select do |dep|
           (dep.groups & [PLUGINS_GROUP]).any? && dep.should_include?
         end
 
@@ -133,12 +132,16 @@ module Bridgetown
         sorted_plugin_files.each do |plugin_file|
           self.class.add_registered_plugin plugin_file
         end
+        next if site.config[:plugins_use_zeitwerk]
+
         Bridgetown::Utils::RequireGems.require_with_graceful_fail(sorted_plugin_files)
       end
     end
 
     # Reload .rb plugin files via the watcher
     def reload_plugin_files
+      return if site.config[:plugins_use_zeitwerk]
+
       plugins_path.each do |plugin_search_path|
         plugin_files = Utils.safe_glob(plugin_search_path, File.join("**", "*.rb"))
         Array(plugin_files).each do |name|
@@ -159,35 +162,5 @@ module Bridgetown
         Array(site.config["plugins_dir"]).map { |d| File.expand_path(d) }
       end
     end
-
-    def setup_component_loaders
-      unless @component_loaders.keys.empty?
-        @component_loaders.each do |_path, loader|
-          loader.unload
-        end
-        @component_loaders = {}
-      end
-
-      # Because "first constant wins" in Zeitwerk, we need to load the local
-      # source components _before_ we load any from plugins
-      site.components_load_paths.reverse_each do |load_path|
-        next unless Dir.exist? load_path
-
-        begin
-          @component_loaders[load_path] = Zeitwerk::Loader.new
-          @component_loaders[load_path].push_dir(load_path)
-          @component_loaders[load_path].enable_reloading if load_path.start_with?(site.root_dir)
-          @component_loaders[load_path].ignore(File.join(load_path, "**", "*.js.rb"))
-          @component_loaders[load_path].setup
-        rescue Zeitwerk::Error # rubocop:disable Lint/SuppressedException
-        end
-      end
-    end
-
-    def reload_component_loaders
-      @component_loaders.each do |path, loader|
-        loader.reload if path.start_with?(site.root_dir)
-      end
-    end
   end
 end