bridgetown-core 1.0.0.alpha4 → 1.0.0.alpha8

data/lib/bridgetown-core/ruby_template_view.rb

@@ -61,9 +61,9 @@ module Bridgetown
       @helpers ||= Helpers.new(self, site)
     end
 
-    ruby2_keywords def method_missing(method_name, *args, &block)
+    def method_missing(method_name, *args, **kwargs, &block)
       if helpers.respond_to?(method_name.to_sym)
-        helpers.send method_name.to_sym, *args, &block
+        helpers.send method_name.to_sym, *args, **kwargs, &block
       else
         super
       end

data/lib/bridgetown-core/site.rb

@@ -13,9 +13,10 @@ module Bridgetown
     include SSR
     include Writable
 
-    attr_reader   :root_dir, :source, :dest, :cache_dir, :config,
-                  :liquid_renderer, :components_load_paths,
-                  :includes_load_paths
+    attr_reader :root_dir, :source, :dest, :cache_dir, :config, :liquid_renderer
+
+    # @return [Bridgetown::Utils::LoadersManager]
+    attr_reader :loaders_manager
 
     # All files not pages/documents or structured data in the source folder
     # @return [Array<StaticFile>]
@@ -33,11 +34,20 @@ module Bridgetown
 
     # Initialize a new Site.
     #
-    # config - A Hash containing site configuration details.
-    def initialize(config)
+    # @param config [Bridgetown::Configuration]
+    # @param loaders_manager [Bridgetown::Utils::LoadersManager] initialized if none provided
+    def initialize(config, loaders_manager: nil)
       self.config = config
       locale
 
+      loaders_manager = if loaders_manager
+                          loaders_manager.config = self.config
+                          loaders_manager
+                        else
+                          Bridgetown::Utils::LoadersManager.new(self.config)
+                        end
+      @loaders_manager = loaders_manager
+
       @plugin_manager  = PluginManager.new(self)
       @cleaner         = Cleaner.new(self)
       @reader          = Reader.new(self)

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Utils
+    class LoadersManager
+      attr_accessor :config
+
+      attr_reader :loaders, :root_dir
+
+      # @param config [Bridgetown::Configuration]
+      # @param root_dir [String] root of the current site
+      def initialize(config, root_dir = Dir.pwd)
+        @config = config
+        @loaders = {}
+        @root_dir = root_dir
+      end
+
+      def unload_loaders
+        return if @loaders.keys.empty?
+
+        @loaders.each do |_path, loader|
+          loader.unload
+        end
+        @loaders = {}
+      end
+
+      def reloading_enabled?(load_path)
+        load_path.start_with?(root_dir) && ENV["BRIDGETOWN_ENV"] != "production"
+      end
+
+      def setup_loaders(autoload_paths = []) # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+        (autoload_paths.presence || config.autoload_paths).each do |load_path|
+          if @loaders.key?(load_path)
+            raise "Zeitwerk loader already added for `#{load_path}'. Please check your config"
+          end
+
+          next unless Dir.exist? load_path
+
+          loader = Zeitwerk::Loader.new
+          begin
+            loader.push_dir(load_path)
+          rescue Zeitwerk::Error
+            next
+          end
+          loader.enable_reloading if reloading_enabled?(load_path)
+          loader.ignore(File.join(load_path, "**", "*.js.rb"))
+          config.autoloader_collapsed_paths.each do |collapsed_path|
+            next unless collapsed_path.starts_with?(load_path)
+
+            loader.collapse(collapsed_path)
+          end
+          Bridgetown::Hooks.trigger :loader, :pre_setup, loader, load_path
+          loader.setup
+          loader.eager_load if config.eager_load_paths.include?(load_path)
+          Bridgetown::Hooks.trigger :loader, :post_setup, loader, load_path
+          @loaders[load_path] = loader
+        end
+      end
+
+      def reload_loaders
+        @loaders.each do |load_path, loader|
+          next unless reloading_enabled?(load_path)
+
+          Bridgetown::Hooks.trigger :loader, :pre_reload, loader, load_path
+          loader.reload
+          loader.eager_load if config.eager_load_paths.include?(load_path)
+          Bridgetown::Hooks.trigger :loader, :post_reload, loader, load_path
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-core/utils.rb

@@ -5,6 +5,7 @@ module Bridgetown
     extend self
     autoload :Ansi, "bridgetown-core/utils/ansi"
     autoload :Aux, "bridgetown-core/utils/aux"
+    autoload :LoadersManager, "bridgetown-core/utils/loaders_manager"
     autoload :RequireGems, "bridgetown-core/utils/require_gems"
     autoload :RubyExec, "bridgetown-core/utils/ruby_exec"
     autoload :RubyFrontMatter, "bridgetown-core/utils/ruby_front_matter"
@@ -120,15 +121,11 @@ module Bridgetown
     # @return [Boolean] if the YAML front matter is present.
     # rubocop: disable Naming/PredicateName
     def has_yaml_header?(file)
-      File.open(file, "rb", &:readline).match? Bridgetown::FrontMatterImporter::YAML_HEADER
-    rescue EOFError
-      false
+      File.open(file, "rb", &:gets)&.match?(Bridgetown::FrontMatterImporter::YAML_HEADER) || false
     end
 
     def has_rbfm_header?(file)
-      File.open(file, "rb", &:readline).match? Bridgetown::FrontMatterImporter::RUBY_HEADER
-    rescue EOFError
-      false
+      File.open(file, "rb", &:gets)&.match?(Bridgetown::FrontMatterImporter::RUBY_HEADER) || false
     end
 
     # Determine whether the given content string contains Liquid Tags or Vaiables
@@ -354,7 +351,7 @@ module Bridgetown
     # @raise [WebpackAssetError] if unable to find css or js in the manifest
     # file
     def parse_webpack_manifest_file(site, asset_type)
-      return log_webpack_asset_error("Webpack manifest") if site.frontend_manifest.nil?
+      return log_webpack_asset_error(site, "Webpack manifest") if site.frontend_manifest.nil?
 
       asset_path = if %w(js css).include?(asset_type)
                      site.frontend_manifest["main.#{asset_type}"]
@@ -364,7 +361,7 @@ module Bridgetown
                      end&.last
                    end
 
-      return log_webpack_asset_error(asset_type) if asset_path.nil?
+      return log_webpack_asset_error(site, asset_type) if asset_path.nil?
 
       static_frontend_path site, ["js", asset_path]
     end
@@ -379,12 +376,14 @@ module Bridgetown
       Addressable::URI.parse(path_parts.join("/")).normalize.to_s
     end
 
-    def log_webpack_asset_error(asset_type)
-      Bridgetown.logger.warn(
-        "Webpack:",
-        "There was an error parsing your #{asset_type} file. \
-        Please check your #{asset_type} file for any errors."
-      )
+    def log_webpack_asset_error(site, asset_type)
+      site.data[:__webpack_asset_errors] ||= {}
+      site.data[:__webpack_asset_errors][asset_type] ||=
+        Bridgetown.logger.warn(
+          "Webpack:",
+          "There was an error parsing your #{asset_type} file. \
+          Please check your #{asset_type} file for any errors."
+        )
 
       "MISSING_WEBPACK_MANIFEST_FILE"
     end

data/lib/bridgetown-core/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  VERSION = "1.0.0.alpha4"
+  VERSION = "1.0.0.alpha8"
   CODE_NAME = "Pearl"
 end

data/lib/bridgetown-core/watcher.rb

@@ -41,10 +41,12 @@ module Bridgetown
         Dir.exist?(path)
       end
 
+      paths_to_watch = (plugin_paths_to_watch + options.autoload_paths).uniq
+
       Listen.to(
         options["source"],
         webpack_path,
-        *plugin_paths_to_watch,
+        *paths_to_watch,
         ignore: listen_ignore_paths(options),
         force_polling: options["force_polling"],
         &listen_handler(site, options)
@@ -57,10 +59,12 @@ module Bridgetown
         c = modified + added + removed
         n = c.length
 
-        Bridgetown.logger.info "Regenerating…"
-        Bridgetown.logger.info "", "#{n} file(s) changed at #{t.strftime("%Y-%m-%d %H:%M:%S")}"
+        unless site.ssr?
+          Bridgetown.logger.info "Regenerating…"
+          Bridgetown.logger.info "", "#{n} file(s) changed at #{t.strftime("%Y-%m-%d %H:%M:%S")}"
+          c.each { |path| Bridgetown.logger.info "", path["#{site.root_dir}/".length..] }
+        end
 
-        c.each { |path| Bridgetown.logger.info "", path["#{site.root_dir}/".length..-1] }
         process(site, t, options)
       end
     end
@@ -101,7 +105,7 @@ module Bridgetown
       source = Pathname.new(options["source"]).expand_path
       paths  = to_exclude(options)
 
-      paths.map do |p|
+      paths.filter_map do |p|
         absolute_path = Pathname.new(normalize_encoding(p, options["source"].encoding)).expand_path
         next unless absolute_path.exist?
 
@@ -116,20 +120,25 @@ module Bridgetown
         rescue ArgumentError
           # Could not find a relative path
         end
-      end.compact + [%r!^\.bridgetown-metadata!]
+      end + [%r!^\.bridgetown-metadata!]
     end
 
     def sleep_forever
       loop { sleep 1000 }
     end
 
+    # @param site [Bridgetown::Site]
     def process(site, time, options)
       begin
         I18n.reload! # make sure any locale files get read again
+        Bridgetown::Current.site = site # needed in SSR mode apparently
         Bridgetown::Hooks.trigger :site, :pre_reload, site
         Bridgetown::Hooks.clear_reloadable_hooks
         site.plugin_manager.reload_plugin_files
-        site.plugin_manager.reload_component_loaders
+        site.loaders_manager.reload_loaders
+
+        return site.ssr_reload if site.ssr?
+
         site.process
         Bridgetown.logger.info "Done! 🎉", "#{"Completed".green} in less than" \
                                           " #{(Time.now - time).ceil(2)} seconds."

data/lib/bridgetown-core/yaml_parser.rb

@@ -11,11 +11,7 @@ module Bridgetown
       end
 
       def load(yaml)
-        if RUBY_VERSION.start_with?("2.5")
-          YAML.safe_load yaml, PERMITTED_CLASSES
-        else
-          YAML.safe_load yaml, permitted_classes: PERMITTED_CLASSES
-        end
+        YAML.safe_load yaml, permitted_classes: PERMITTED_CLASSES
       end
     end
   end

data/lib/site_template/README.md

@@ -16,7 +16,7 @@ Welcome to your new Bridgetown website! You can update this README file to provi
 - [GCC](https://gcc.gnu.org/install/)
 - [Make](https://www.gnu.org/software/make/)
 - [Ruby](https://www.ruby-lang.org/en/downloads/)
-  - `>= 2.5`
+  - `>= 2.7`
 - [Bridgetown Gem](https://rubygems.org/gems/bridgetown)
   - `gem install bridgetown -N`
 - [Node](https://nodejs.org)

data/lib/site_template/Rakefile

@@ -2,6 +2,9 @@ require "bridgetown"
 
 Bridgetown.load_tasks
 
+# Run rake without specifying any command to execute a deploy build by default.
+task default: :deploy
+
 #
 # Standard set of tasks, which you can customize if you wish:
 #
@@ -44,6 +47,3 @@ end
 #     say_status :rake, "I'm a Rake tast =) #{site.config.url}"
 #   end
 # end
-
-# Run rake without specifying any command to execute a deploy build by default.
-task default: :deploy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha4
+  version: 1.0.0.alpha8
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -390,11 +390,21 @@ files:
 - lib/bridgetown-core/configurations/.keep
 - lib/bridgetown-core/configurations/bt-postcss.rb
 - lib/bridgetown-core/configurations/bt-postcss/postcss.config.js
+- lib/bridgetown-core/configurations/cypress.rb
+- lib/bridgetown-core/configurations/cypress/cypress.json
+- lib/bridgetown-core/configurations/cypress/cypress_dir/fixtures/example.json
+- lib/bridgetown-core/configurations/cypress/cypress_dir/integration/navbar.spec.js
+- lib/bridgetown-core/configurations/cypress/cypress_dir/plugins/index.js
+- lib/bridgetown-core/configurations/cypress/cypress_dir/support/commands.js
+- lib/bridgetown-core/configurations/cypress/cypress_dir/support/index.js
+- lib/bridgetown-core/configurations/cypress/cypress_tasks
 - lib/bridgetown-core/configurations/minitesting.rb
 - lib/bridgetown-core/configurations/netlify.rb
 - lib/bridgetown-core/configurations/netlify/netlify.sh
 - lib/bridgetown-core/configurations/netlify/netlify.toml
 - lib/bridgetown-core/configurations/purgecss.rb
+- lib/bridgetown-core/configurations/render.rb
+- lib/bridgetown-core/configurations/render/render.yaml.erb
 - lib/bridgetown-core/configurations/stimulus.rb
 - lib/bridgetown-core/configurations/swup.rb
 - lib/bridgetown-core/configurations/tailwindcss.rb
@@ -476,7 +486,6 @@ files:
 - lib/bridgetown-core/tags/class_map.rb
 - lib/bridgetown-core/tags/find.rb
 - lib/bridgetown-core/tags/highlight.rb
-- lib/bridgetown-core/tags/include.rb
 - lib/bridgetown-core/tags/link.rb
 - lib/bridgetown-core/tags/live_reload_dev_js.rb
 - lib/bridgetown-core/tags/post_url.rb
@@ -489,6 +498,7 @@ files:
 - lib/bridgetown-core/utils.rb
 - lib/bridgetown-core/utils/ansi.rb
 - lib/bridgetown-core/utils/aux.rb
+- lib/bridgetown-core/utils/loaders_manager.rb
 - lib/bridgetown-core/utils/require_gems.rb
 - lib/bridgetown-core/utils/ruby_exec.rb
 - lib/bridgetown-core/utils/ruby_front_matter.rb
@@ -543,12 +553,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key: 

data/lib/bridgetown-core/tags/include.rb

@@ -1,216 +0,0 @@
-# frozen_string_literal: true
-
-module Bridgetown
-  module Tags
-    class IncludeTag < Liquid::Tag
-      class << self
-        attr_accessor :deprecation_message_shown
-      end
-
-      VALID_SYNTAX = %r!
-        ([\w-]+)\s*=\s*
-        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w.-]+))
-      !x.freeze
-
-      # rubocop:disable Lint/MixedRegexpCaptureTypes
-      VARIABLE_SYNTAX = %r!
-        (?<variable>[^{]*(\{\{\s*[\w\-.]+\s*(\|.*)?\}\}[^\s{}]*)+)
-        (?<params>.*)
-      !mx.freeze
-      # rubocop:enable Lint/MixedRegexpCaptureTypes
-
-      FULL_VALID_SYNTAX = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!.freeze
-      VALID_FILENAME_CHARS = %r!^[\w/.-]+$!.freeze
-      INVALID_SEQUENCES = %r![./]{2,}!.freeze
-
-      def initialize(tag_name, markup, tokens)
-        super
-
-        unless self.class.deprecation_message_shown
-          Bridgetown.logger.warn "NOTICE: the {% include %} tag is deprecated and" \
-                                 " will be removed in Bridgetown 1.0. You should" \
-                                 " use the {% render %} tag instead."
-          self.class.deprecation_message_shown = true
-        end
-
-        matched = markup.strip.match(VARIABLE_SYNTAX)
-        if matched
-          @file = matched["variable"].strip
-          @params = matched["params"].strip
-        else
-          @file, @params = markup.strip.split(%r!\s+!, 2)
-        end
-        validate_params if @params
-        @tag_name = tag_name
-      end
-
-      def syntax_example
-        "{% #{@tag_name} file.ext param='value' param2='value' %}"
-      end
-
-      def parse_params(context)
-        params = {}
-        markup = @params
-
-        while (match = VALID_SYNTAX.match(markup))
-          markup = markup[match.end(0)..-1]
-
-          value = if match[2]
-                    match[2].gsub('\\"', '"')
-                  elsif match[3]
-                    match[3].gsub("\\'", "'")
-                  elsif match[4]
-                    context[match[4]]
-                  end
-
-          params[match[1]] = value
-        end
-        params
-      end
-
-      def validate_file_name(file)
-        return unless INVALID_SEQUENCES.match?(file) || !VALID_FILENAME_CHARS.match?(file)
-
-        raise ArgumentError, <<~MSG
-          Invalid syntax for include tag. File contains invalid characters or sequences:
-
-            #{file}
-
-          Valid syntax:
-
-            #{syntax_example}
-
-        MSG
-      end
-
-      def validate_params
-        return if FULL_VALID_SYNTAX.match?(@params)
-
-        raise ArgumentError, <<~MSG
-          Invalid syntax for include tag:
-
-          #{@params}
-
-          Valid syntax:
-
-          #{syntax_example}
-
-        MSG
-      end
-
-      # Grab file read opts in the context
-      def file_read_opts(context)
-        context.registers[:site].file_read_opts
-      end
-
-      # Render the variable if required
-      def render_variable(context)
-        Liquid::Template.parse(@file).render(context) if VARIABLE_SYNTAX.match?(@file)
-      end
-
-      def tag_includes_dirs(context)
-        context.registers[:site].includes_load_paths.freeze
-      end
-
-      def locate_include_file(context, file)
-        includes_dirs = tag_includes_dirs(context)
-        includes_dirs.each do |dir|
-          path = File.join(dir, file)
-          return path if valid_include_file?(path, dir.to_s)
-        end
-        raise IOError, could_not_locate_message(file, includes_dirs)
-      end
-
-      def render(context)
-        file = render_variable(context) || @file
-        validate_file_name(file)
-
-        path = locate_include_file(context, file)
-        return unless path
-
-        partial = load_cached_partial(path, context)
-
-        context.stack do
-          context["include"] = parse_params(context) if @params
-          begin
-            partial.render!(context)
-          rescue Liquid::Error => e
-            e.template_name = path
-            e.markup_context = "included " if e.markup_context.nil?
-            raise e
-          end
-        end
-      end
-
-      def load_cached_partial(path, context)
-        context.registers[:cached_partials] ||= {}
-        cached_partial = context.registers[:cached_partials]
-
-        if cached_partial.key?(path)
-          cached_partial[path]
-        else
-          unparsed_file = context.registers[:site]
-            .liquid_renderer
-            .file(path)
-          begin
-            cached_partial[path] = unparsed_file.parse(read_file(path, context))
-          rescue Liquid::Error => e
-            e.template_name = path
-            e.markup_context = "included " if e.markup_context.nil?
-            raise e
-          end
-        end
-      end
-
-      def valid_include_file?(path, _dir)
-        File.file?(path)
-      end
-
-      def realpath_prefixed_with?(path, dir)
-        File.exist?(path) && File.realpath(path).start_with?(dir)
-      rescue StandardError
-        false
-      end
-
-      # This method allows to modify the file content by inheriting from the class.
-      def read_file(file, context)
-        File.read(file, **file_read_opts(context))
-      end
-
-      private
-
-      def could_not_locate_message(file, includes_dirs)
-        "Could not locate the included file '#{file}' in any of #{includes_dirs}." \
-          " Ensure it exists in one of those directories."
-      end
-    end
-
-    class IncludeRelativeTag < IncludeTag
-      def tag_includes_dirs(context)
-        Array(page_path(context)).freeze
-      end
-
-      def page_path(context)
-        if context.registers[:page].nil?
-          context.registers[:site].source
-        else
-          site = context.registers[:site]
-          page_payload = context.registers[:page]
-          resource_path = \
-            if page_payload["collection"].nil?
-              page_payload["path"]
-            else
-              File.join(site.config["collections_dir"], page_payload["path"])
-            end
-          # rubocop:disable Performance/DeleteSuffix
-          resource_path.sub!(%r!/#excerpt\z!, "")
-          # rubocop:enable Performance/DeleteSuffix
-          site.in_source_dir File.dirname(resource_path)
-        end
-      end
-    end
-  end
-end
-
-Liquid::Template.register_tag("include", Bridgetown::Tags::IncludeTag)
-Liquid::Template.register_tag("include_relative", Bridgetown::Tags::IncludeRelativeTag)