bridgetown-core 1.0.0.alpha6 → 1.0.0.alpha7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dd8600eb037c6f3841fdbc7a9175ecccd0ab4e3c7d1814e914b6954ad4fb832
-  data.tar.gz: ca457af17e62de5d71a441b90d9aa8d97136fcd4cc9ecd65a855d8a78bab53b3
+  metadata.gz: 7e8dceaa24615a3a0de23c469444c2d22b36ce1f2c171177a9d20646f7b31446
+  data.tar.gz: 10c6c7e5c3bfc2a1f591d8953d098dae8d0d90942bb1ad6ef7871834cf658434
 SHA512:
-  metadata.gz: 594d6e6de4a514e3eeb439a1ebc3d8936d4bb5027a78063db12c503072fe1c8b6db9d8f3ce6568a95781375d2e0c59dc32faf83fc333e8e9dcd3e95c140e7287
-  data.tar.gz: fa2ad70a10323054e8f9ab646dfb92cc37457b53427907888dd8bc47589046feafcdc29730c3d4e6d3eb81cf8cd0be6cebbb692a32d8c3ec200c7a8c7fb80693
+  metadata.gz: 254a0d29eca611c8642acf2f664ace0dc8de883cf38dd00f56597dfc273625460089743e5ebc8e81df231035a8a1365393a5e890c1c4b1447d94fba48e310a2f
+  data.tar.gz: 48c9518b97fc1e890d8b04b908a117296def616657831c7d0572e9e611a58d3381870f9257f17303db965fa40d47b2280b3e2b814f02652b0b374e6ab4ab0f0d

data/bridgetown-core.gemspec

@@ -28,8 +28,7 @@ Gem::Specification.new do |s|
 
   s.rdoc_options = ["--charset=UTF-8"]
 
-  s.required_ruby_version     = ">= 2.5.0"
-  s.required_rubygems_version = ">= 2.7.0"
+  s.required_ruby_version     = ">= 2.7.0"
 
   s.add_runtime_dependency("activemodel",           "~> 6.0")
   s.add_runtime_dependency("activesupport",         "~> 6.0")

data/lib/bridgetown-core/cache.rb

@@ -144,7 +144,7 @@ module Bridgetown
       @base_dir ||= File.join(Bridgetown::Cache.cache_dir, @name)
       return @base_dir if hash.nil?
 
-      File.join(@base_dir, hash[0..1], hash[2..-1]).freeze
+      File.join(@base_dir, hash[0..1], hash[2..]).freeze
     end
 
     # Given a key, return a SHA2 hash that can be used for caching this item to disk.

data/lib/bridgetown-core/collection.rb

@@ -234,7 +234,7 @@ module Bridgetown
       end
 
       resources.each do |data_resource|
-        segments = data_resource.relative_path.each_filename.to_a[1..-1]
+        segments = data_resource.relative_path.each_filename.to_a[1..]
         nested = []
         segments.each_with_index do |segment, index|
           sanitized_segment = sanitize_filename.(File.basename(segment, ".*"))

data/lib/bridgetown-core/commands/configure.rb

@@ -41,6 +41,7 @@ module Bridgetown
         configuration_file = find_in_source_paths("#{configuration}.rb")
 
         inside(New.created_site_dir || Dir.pwd) do
+          @templates_dir = File.expand_path("../configurations/#{configuration}", __dir__)
           apply configuration_file, verbose: false
         end
       end
@@ -62,6 +63,12 @@ module Bridgetown
           return Dir.glob("*.rb").map { |file| file.sub(".rb", "") }
         end
       end
+
+      def in_templates_dir(*paths)
+        paths.reduce(@templates_dir) do |base, path|
+          Bridgetown.sanitized_path(base, path.to_s)
+        end
+      end
     end
   end
 end

data/lib/bridgetown-core/commands/new.rb

@@ -153,6 +153,7 @@ module Bridgetown
             inside(path) do
               run "bundle install", abort_on_failure: true
               run "bundle binstubs bridgetown-core"
+              run "cp bin/bridgetown bin/bt"
             end
           end
         end

data/lib/bridgetown-core/component.rb

@@ -164,9 +164,9 @@ module Bridgetown
       end
     end
 
-    ruby2_keywords def method_missing(method, *args, &block)
+    def method_missing(method, *args, **kwargs, &block)
       if helpers.respond_to?(method.to_sym)
-        helpers.send method.to_sym, *args, &block
+        helpers.send method.to_sym, *args, **kwargs, &block
       else
         super
       end

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

@@ -32,7 +32,7 @@ module Bridgetown
         self.front_matter_line_count = ruby_content[1].lines.size
         process_ruby_data(ruby_content[1], file_path, 2)
       elsif Bridgetown::Utils.has_rbfm_header?(file_path)
-        process_ruby_data(File.read(file_path).lines[1..-1].join("\n"), file_path, 2)
+        process_ruby_data(File.read(file_path).lines[1..].join("\n"), file_path, 2)
       elsif is_a?(Layout)
         self.content = file_contents
         {}

data/lib/bridgetown-core/concerns/site/configurable.rb

@@ -155,10 +155,10 @@ class Bridgetown::Site
       Bridgetown::Cache.disable_disk_cache! if config["disable_disk_cache"]
     end
 
-    def configure_component_paths
+    def configure_component_paths # rubocop:todo Metrics/AbcSize
       # Loop through plugins paths first
       plugin_components_load_paths = Bridgetown::PluginManager.source_manifests
-        .map(&:components).compact
+        .filter_map(&:components)
 
       local_components_load_paths = config["components_dir"].yield_self do |dir|
         dir.is_a?(Array) ? dir : [dir]
@@ -172,7 +172,10 @@ class Bridgetown::Site
         end
       end
 
-      @components_load_paths = plugin_components_load_paths + local_components_load_paths
+      config.components_load_paths = plugin_components_load_paths + local_components_load_paths
+      # Because "first constant wins" in Zeitwerk, we need to load the local
+      # source components _before_ we load any from plugins
+      config.autoload_paths += config.components_load_paths.reverse
     end
 
     def configure_file_read_opts

data/lib/bridgetown-core/concerns/site/extensible.rb

@@ -3,13 +3,14 @@
 class Bridgetown::Site
   module Extensible
     # Load necessary libraries, plugins, converters, and generators.
+    # This is only ever run once for the lifecycle of the site object.
     # @see Converter
     # @see Generator
     # @see PluginManager
     # @return [void]
     def setup
       plugin_manager.require_plugin_files
-      plugin_manager.setup_component_loaders
+      loaders_manager.setup_loaders
       self.converters = instantiate_subclasses(Bridgetown::Converter)
       self.generators = instantiate_subclasses(Bridgetown::Generator)
     end

data/lib/bridgetown-core/concerns/site/ssr.rb

@@ -8,29 +8,16 @@ class Bridgetown::Site
 
     module ClassMethods
       # Establish an SSR pipeline for a persistent backend process
-      def start_ssr! # rubocop:todo Metrics/AbcSize
+      def start_ssr!(loaders_manager: nil, &block)
         if Bridgetown::Current.site
           raise Bridgetown::Errors::FatalException, "Bridgetown SSR already started! " \
                                                     "Check your Rack app for threading issues"
         end
 
         Bridgetown::PluginManager.require_from_bundler
-        site = new(Bridgetown::Current.preloaded_configuration)
+        site = new(Bridgetown::Current.preloaded_configuration, loaders_manager: loaders_manager)
         site.enable_ssr
-
-        Bridgetown::Hooks.trigger :site, :pre_read, site
-        site.defaults_reader.tap do |d|
-          d.path_defaults.clear
-          d.read
-        end
-        site.layouts = Bridgetown::LayoutReader.new(site).read
-        site.collections.data.tap do |coll|
-          coll.read
-          site.data = coll.merge_data_resources
-        end
-        Bridgetown::Hooks.trigger :site, :post_read, site
-
-        yield(site) if block_given? # provide additional setup hook
+        site.ssr_setup(&block)
 
         site
       end
@@ -45,6 +32,41 @@ class Bridgetown::Site
       @ssr_enabled = true
     end
 
+    def ssr_setup(&block) # rubocop:disable Metrics/AbcSize
+      config.serving = true
+      Bridgetown::Hooks.trigger :site, :pre_read, self
+      defaults_reader.tap do |d|
+        d.path_defaults.clear
+        d.read
+      end
+      reader.read_layouts
+      collections.data.tap do |coll|
+        coll.read
+        self.data = coll.merge_data_resources
+      end
+      Bridgetown::Hooks.trigger :site, :post_read, self
+
+      hook = block&.(self) # provide additional setup hook
+      return if Bridgetown.env.production?
+
+      @ssr_reload_hook = hook if hook.is_a?(Proc) && hook.lambda?
+      Bridgetown::Watcher.watch(self, config)
+    end
+
+    def ssr_reload
+      reset soft: true
+      reader.read_layouts
+
+      collections.data.tap do |coll|
+        coll.resources.clear
+        coll.read
+        coll.merge_data_resources.each do |k, v|
+          data[k] = v
+        end
+      end
+      @ssr_reload_hook.() if @ssr_reload_hook.is_a?(Proc)
+    end
+
     def disable_ssr
       Bridgetown.logger.info "SSR:", "now disabled."
       @ssr_enabled = false

data/lib/bridgetown-core/configuration.rb

@@ -11,64 +11,68 @@ module Bridgetown
     # 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"),
-      "collections_dir"      => "",
-      "cache_dir"            => ".bridgetown-cache",
-      "layouts_dir"          => "_layouts",
-      "data_dir"             => "_data",
-      "components_dir"       => "_components",
-      "partials_dir"         => "_partials",
-      "collections"          => {},
-      "taxonomies"           => {
+      "root_dir"                   => Dir.pwd,
+      "plugins_dir"                => "plugins",
+      "source"                     => File.join(Dir.pwd, "src"),
+      "destination"                => File.join(Dir.pwd, "output"),
+      "collections_dir"            => "",
+      "cache_dir"                  => ".bridgetown-cache",
+      "layouts_dir"                => "_layouts",
+      "data_dir"                   => "_data",
+      "components_dir"             => "_components",
+      "partials_dir"               => "_partials",
+      "collections"                => {},
+      "taxonomies"                 => {
         category: { key: "categories", title: "Category" }, tag: { key: "tags", title: "Tag" },
       },
+      "autoload_paths"             => [],
+      "eager_load_paths"           => [],
+      "autoloader_collapsed_paths" => [],
+      "plugins_use_zeitwerk"       => true,
 
       # Handling Reading
-      "include"              => [".htaccess", "_redirects", ".well-known"],
-      "exclude"              => [],
-      "keep_files"           => [".git", ".svn", "_bridgetown"],
-      "encoding"             => "utf-8",
-      "markdown_ext"         => "markdown,mkdown,mkdn,mkd,md",
-      "strict_front_matter"  => false,
-      "slugify_mode"         => "pretty",
+      "include"                    => [".htaccess", "_redirects", ".well-known"],
+      "exclude"                    => [],
+      "keep_files"                 => [".git", ".svn", "_bridgetown"],
+      "encoding"                   => "utf-8",
+      "markdown_ext"               => "markdown,mkdown,mkdn,mkd,md",
+      "strict_front_matter"        => false,
+      "slugify_mode"               => "pretty",
 
       # Filtering Content
-      "future"               => false,
-      "unpublished"          => false,
-      "ruby_in_front_matter" => true,
+      "future"                     => false,
+      "unpublished"                => false,
+      "ruby_in_front_matter"       => true,
 
       # Conversion
-      "content_engine"       => "resource",
-      "markdown"             => "kramdown",
-      "highlighter"          => "rouge",
-      "excerpt_separator"    => "\n\n",
+      "content_engine"             => "resource",
+      "markdown"                   => "kramdown",
+      "highlighter"                => "rouge",
+      "excerpt_separator"          => "\n\n",
 
       # Serving
-      "port"                 => "4000",
-      "host"                 => "127.0.0.1",
-      "base_path"            => "/",
-      "show_dir_listing"     => false,
+      "port"                       => "4000",
+      "host"                       => "127.0.0.1",
+      "base_path"                  => "/",
+      "show_dir_listing"           => false,
 
       # Output Configuration
-      "available_locales"    => [:en],
-      "default_locale"       => :en,
-      "permalink"            => nil, # default is set according to content engine
-      "timezone"             => nil, # use the local timezone
+      "available_locales"          => [:en],
+      "default_locale"             => :en,
+      "permalink"                  => nil, # default is set according to content engine
+      "timezone"                   => nil, # use the local timezone
 
-      "quiet"                => false,
-      "verbose"              => false,
-      "defaults"             => [],
+      "quiet"                      => false,
+      "verbose"                    => false,
+      "defaults"                   => [],
 
-      "liquid"               => {
+      "liquid"                     => {
         "error_mode"       => "warn",
         "strict_filters"   => false,
         "strict_variables" => false,
       },
 
-      "kramdown"             => {
+      "kramdown"                   => {
         "auto_ids"                => true,
         "toc_levels"              => (1..6).to_a,
         "entity_output"           => "as_char",
@@ -98,6 +102,7 @@ module Bridgetown
       def from(user_config, starting_defaults = DEFAULTS)
         Utils.deep_merge_hashes(starting_defaults.deep_dup, Configuration[user_config])
           .merge_environment_specific_options!
+          .setup_load_paths!
           .setup_locales
           .add_default_collections
           .add_default_excludes
@@ -109,21 +114,21 @@ module Bridgetown
       override[config_key] || self[config_key] || DEFAULTS[config_key]
     end
 
-    # Public: Directory of the top-level root where config files are located
+    # Directory of the top-level root where config files are located
     #
-    # override - the command-line options hash
+    # @param override [Hash] options hash which will override value if key is present
     #
-    # Returns the path to the Bridgetown root directory
-    def root_dir(override = "")
+    # @return [String] path to the Bridgetown root directory
+    def root_dir(override = {})
       get_config_value_with_override("root_dir", override)
     end
 
     # Public: Directory of the Bridgetown source folder
     #
-    # override - the command-line options hash
+    # @param override [Hash] options hash which will override value if key is present
     #
-    # Returns the path to the Bridgetown source directory
-    def source(override = "")
+    # @return [String]  path to the Bridgetown source directory
+    def source(override = {})
       get_config_value_with_override("source", override)
     end
 
@@ -240,6 +245,32 @@ module Bridgetown
         self[k] = self[Bridgetown.environment][k]
       end
       delete(Bridgetown.environment)
+
+      self
+    end
+
+    def setup_load_paths!
+      if self[:plugins_use_zeitwerk]
+        autoload_paths.unshift({
+          path: self[:plugins_dir],
+          eager: true,
+        })
+      end
+
+      autoload_paths.map! do |load_path|
+        if load_path.is_a?(Hash)
+          expanded = File.expand_path(load_path[:path], root_dir)
+          self[:eager_load_paths] << expanded if load_path[:eager]
+          next expanded
+        end
+
+        File.expand_path(load_path, root_dir)
+      end
+
+      autoloader_collapsed_paths.map! do |collapsed_path|
+        File.expand_path(collapsed_path, root_dir)
+      end
+
       self
     end
 

data/lib/bridgetown-core/configurations/bt-postcss.rb

@@ -2,8 +2,6 @@
 
 # rubocop:disable all
 
-TEMPLATE_PATH = File.expand_path("./bt-postcss", __dir__)
-
 unless File.exist?("postcss.config.js")
   error_message = "#{"postcss.config.js".bold} not found. Please configure postcss in your project."
 
@@ -21,6 +19,6 @@ plugins = %w(postcss-easy-import postcss-mixins postcss-color-function cssnano)
 say "Adding the following PostCSS plugins: #{plugins.join(' | ')}", :green
 run "yarn add -D #{plugins.join(' ')}"
 
-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
 
 # rubocop:enable all

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

@@ -0,0 +1,4 @@
+{
+  "baseUrl": "http://localhost:4000"
+}
+

data/lib/bridgetown-core/configurations/cypress/cypress_dir/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

data/lib/bridgetown-core/configurations/cypress/cypress_dir/integration/navbar.spec.js

@@ -0,0 +1,17 @@
+describe("Testing that links exist in the navbar", () => {
+  beforeEach(() => {
+    cy.visit("/");
+  });
+  it("navbar links appear on all pages", () => {
+    const baseUrl = Cypress.config("baseUrl");
+
+    cy.get('[href="/"]').click();
+    cy.url().should("eq", baseUrl + "/");
+
+    cy.get('[href="/posts"]').click();
+    cy.url().should("eq", baseUrl + "/posts");
+
+    cy.get('[href="/about"]').click();
+    cy.url().should("eq", baseUrl + "/about");
+  });
+});

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

@@ -0,0 +1,21 @@
+/// <reference types="cypress" />
+// ***********************************************************
+// This example plugins/index.js can be used to load plugins
+//
+// You can change the location of this file or turn off loading
+// the plugins file with the 'pluginsFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/plugins-guide
+// ***********************************************************
+
+// This function is called when a project is opened or re-opened (e.g. due to
+// the project's config changing)
+
+/**
+ * @type {Cypress.PluginConfig}
+ */
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+}

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