bridgetown-core 0.14.1 → 0.15.0

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

@@ -188,13 +188,10 @@ module Bridgetown
     #
     # Returns nothing.
     def do_layout(payload, layouts)
-      self.output = _renderer.tap do |renderer|
+      _renderer.tap do |renderer|
         renderer.layouts = layouts
         renderer.payload = payload
       end.run
-
-      Bridgetown.logger.debug "Post-Render Hooks:", relative_path
-      Bridgetown::Hooks.trigger hook_owner, :post_render, self
     ensure
       @_renderer = nil # this will allow the modifications above to disappear
     end

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

@@ -43,8 +43,7 @@ module Bridgetown
     def render_regenerated(document, payload)
       return unless regenerator.regenerate?(document)
 
-      document.output = Bridgetown::Renderer.new(self, document, payload).run
-      document.trigger_hooks(:post_render)
+      Bridgetown::Renderer.new(self, document, payload).run
     end
   end
 end

data/lib/bridgetown-core/drops/document_drop.rb

@@ -12,7 +12,15 @@ module Bridgetown
       mutable false
 
       def_delegator :@obj, :relative_path, :path
-      def_delegators :@obj, :id, :output, :content, :to_s, :relative_path, :url, :date
+      def_delegators :@obj,
+                     :id,
+                     :output,
+                     :content,
+                     :to_s,
+                     :relative_path,
+                     :url,
+                     :date,
+                     :related_posts
 
       private def_delegator :@obj, :data, :fallback_data
 

data/lib/bridgetown-core/drops/page_drop.rb

@@ -7,7 +7,7 @@ module Bridgetown
 
       mutable false
 
-      def_delegators :@obj, :content, :dir, :name, :path, :url
+      def_delegators :@obj, :content, :dir, :name, :path, :url, :pager
       private def_delegator :@obj, :data, :fallback_data
     end
   end

data/lib/bridgetown-core/excerpt.rb

@@ -81,7 +81,10 @@ module Bridgetown
     end
 
     def output
-      @output ||= Renderer.new(doc.site, self, site.site_payload).run
+      @output || (
+        Renderer.new(doc.site, self, site.site_payload).run
+        @output
+      )
     end
 
     def place_in_layout?

data/lib/bridgetown-core/generators/prototype_generator.rb

@@ -63,6 +63,8 @@ module Bridgetown
       new_page
     end
 
+    # TODO: this would be a great use of .try
+    # document.try(:collection).try(:label) == @configured_collection
     def terms_matching_pages(search_term)
       selected_docs = @site.documents.select do |document|
         document.respond_to?(:collection) && document.collection.label == @configured_collection

data/lib/bridgetown-core/liquid_renderer.rb

@@ -26,6 +26,7 @@ module Bridgetown
     def reset
       @stats = {}
       @cache = {}
+      Renderer.cached_partials = {}
     end
 
     def file(filename)

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

@@ -10,11 +10,8 @@ module Bridgetown
 
       def parse(content)
         measure_time do
-          # Remove extraneous indentation for rendercontent tags
-          processed_content = content.gsub(%r!^[ \t]+{%-? rendercontent!, "{% rendercontent")
-
           @renderer.cache[@filename] ||= Liquid::Template.parse(
-            processed_content, line_numbers: true
+            content, line_numbers: true
           )
         end
         @template = @renderer.cache[@filename]

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

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

data/lib/bridgetown-core/page.rb

@@ -73,18 +73,6 @@ module Bridgetown
       end
     end
 
-    # For backwards-compatibility in subclasses that do not redefine
-    # the `:to_liquid` method, stash existing definition under a new name
-    #
-    # TODO: Remove in Bridgetown 5.0
-    alias_method :legacy_to_liquid, :to_liquid
-    private :legacy_to_liquid
-
-    # Private
-    # Subclasses can choose to optimize their `:to_liquid` method by wrapping
-    # it around this definition.
-    #
-    # TODO: Remove in Bridgetown 5.0
     def liquid_drop
       @liquid_drop ||= begin
         defaults = site.frontmatter_defaults.all(relative_path, type)
@@ -94,15 +82,12 @@ module Bridgetown
         Drops::PageDrop.new(self)
       end
     end
-    private :liquid_drop
 
     # Public
     #
     # Liquid representation of current page
-    #
-    # TODO: Remove optional parameter in Bridgetown 5.0
-    def to_liquid(attrs = nil)
-      self.class == Bridgetown::Page ? liquid_drop : legacy_to_liquid(attrs)
+    def to_liquid
+      liquid_drop
     end
 
     # The full path and filename of the post. Defined in the YAML of the post
@@ -180,7 +165,7 @@ module Bridgetown
 
     # The path to the page source file, relative to the site source
     def relative_path
-      @relative_path ||= File.join(*[@dir, @name].map(&:to_s).reject(&:empty?)).sub(%r!\A\/!, "")
+      @relative_path ||= File.join(*[@dir, @name].map(&:to_s).reject(&:empty?)).delete_prefix("/")
     end
 
     # Obtain destination path.

data/lib/bridgetown-core/plugin_manager.rb

@@ -2,6 +2,9 @@
 
 module Bridgetown
   class PluginManager
+    PLUGINS_GROUP = :bridgetown_plugins
+    YARN_DEPENDENCY_REGEXP = %r!(.+)@([^@]*)$!.freeze
+
     attr_reader :site
 
     @source_manifests = Set.new
@@ -40,11 +43,9 @@ module Bridgetown
       if !ENV["BRIDGETOWN_NO_BUNDLER_REQUIRE"] && File.file?("Gemfile")
         require "bundler"
 
-        group_name = :bridgetown_plugins
-
-        required_gems = Bundler.require group_name
+        required_gems = Bundler.require PLUGINS_GROUP
         required_gems.select! do |dep|
-          (dep.groups & [group_name]).any? && dep.should_include?
+          (dep.groups & [PLUGINS_GROUP]).any? && dep.should_include?
         end
 
         install_yarn_dependencies(required_gems)
@@ -67,30 +68,43 @@ module Bridgetown
     # If that exact package hasn't been installed, execute yarn add
     #
     # Returns nothing.
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
     def self.install_yarn_dependencies(required_gems)
       return unless File.exist?("package.json")
 
       package_json = JSON.parse(File.read("package.json"))
 
       required_gems.each do |loaded_gem|
-        next unless loaded_gem.to_spec&.metadata&.dig("yarn-add")
-
-        yarn_add_dependency = loaded_gem.to_spec.metadata["yarn-add"].split("@")
-        next unless yarn_add_dependency.length == 2
-
-        # check matching version number is see if it's already installed
-        if package_json["dependencies"]
-          current_package = package_json["dependencies"].dig(yarn_add_dependency.first)
-          next unless current_package.nil? || current_package != yarn_add_dependency.last
-        end
+        yarn_dependency = find_yarn_dependency(loaded_gem)
+        next unless add_yarn_dependency?(yarn_dependency, package_json)
 
         # all right, time to install the package
-        cmd = "yarn add #{yarn_add_dependency.join("@")}"
+        cmd = "yarn add #{yarn_dependency.join("@")}"
         system cmd
       end
     end
-    # rubocop:enable Metrics/AbcSize, 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] == ""
+
+      yarn_dependency[1..2]
+    end
+
+    def self.add_yarn_dependency?(yarn_dependency, package_json)
+      return false if yarn_dependency.nil?
+
+      # check matching version number is see if it's already installed
+      if package_json["dependencies"]
+        current_version = package_json["dependencies"].dig(yarn_dependency.first)
+        package_requires_updating?(current_version, yarn_dependency.last)
+      else
+        true
+      end
+    end
+
+    def self.package_requires_updating?(current_version, dep_version)
+      current_version.nil? || current_version != dep_version && !current_version.include?("/")
+    end
 
     # Require all .rb files
     #

data/lib/bridgetown-core/renderer.rb

@@ -5,11 +5,16 @@ module Bridgetown
     attr_reader :document, :site
     attr_writer :layouts, :payload
 
+    class << self
+      attr_accessor :cached_partials
+    end
+
     def initialize(site, document, site_payload = nil)
       @site     = site
       @document = document
       @payload  = site_payload
       @layouts  = nil
+      self.class.cached_partials ||= {}
     end
 
     # Fetches the payload used in Liquid rendering.
@@ -48,7 +53,7 @@ module Bridgetown
 
     # Prepare payload and render the document
     #
-    # Returns String rendered document output
+    # Returns nothing
     def run
       Bridgetown.logger.debug "Rendering:", document.relative_path
 
@@ -58,8 +63,8 @@ module Bridgetown
       assign_layout_data!
 
       document.trigger_hooks(:pre_render, payload)
-
-      render_document
+      document.output = render_document
+      document.trigger_hooks(:post_render)
     end
 
     # Render the document.
@@ -67,18 +72,14 @@ module Bridgetown
     # Returns String rendered document output
     # rubocop: disable Metrics/AbcSize
     def render_document
-      info = {
-        registers: { site: site, page: payload["page"] },
-        strict_filters: liquid_options["strict_filters"],
-        strict_variables: liquid_options["strict_variables"],
-      }
+      liquid_context = provide_liquid_context
 
       execute_inline_ruby!
 
       output = document.content
       if document.render_with_liquid?
         Bridgetown.logger.debug "Rendering Liquid:", document.relative_path
-        output = render_liquid(output, payload, info, document.path)
+        output = render_liquid(output, payload, liquid_context, document.path)
       end
 
       Bridgetown.logger.debug "Rendering Markup:", document.relative_path
@@ -87,12 +88,24 @@ module Bridgetown
 
       if document.place_in_layout?
         Bridgetown.logger.debug "Rendering Layout:", document.relative_path
-        output = place_in_layouts(output, payload, info)
+        output = place_in_layouts(output, payload, liquid_context)
       end
 
       output
     end
 
+    def provide_liquid_context
+      {
+        registers: {
+          site: site,
+          page: payload["page"],
+          cached_partials: self.class.cached_partials,
+        },
+        strict_filters: liquid_options["strict_filters"],
+        strict_variables: liquid_options["strict_variables"],
+      }
+    end
+
     def execute_inline_ruby!
       return unless site.config.should_execute_inline_ruby?
 
@@ -101,21 +114,21 @@ module Bridgetown
 
     # rubocop: enable Metrics/AbcSize
 
-    # Render the given content with the payload and info
+    # Render the given content with the payload and context
     #
     # content -
     # payload -
-    # info    -
+    # context    -
     # path    - (optional) the path to the file, for use in ex
     #
     # Returns String the content, rendered by Liquid.
-    def render_liquid(content, payload, info, path = nil)
+    def render_liquid(content, payload, liquid_context, path = nil)
       template = site.liquid_renderer.file(path).parse(content)
       template.warnings.each do |e|
         Bridgetown.logger.warn "Liquid Warning:",
                                LiquidRenderer.format_error(e, path || document.relative_path)
       end
-      template.render!(payload, info)
+      template.render!(payload, liquid_context)
     # rubocop: disable Lint/RescueException
     rescue Exception => e
       Bridgetown.logger.error "Liquid Exception:",
@@ -151,7 +164,7 @@ module Bridgetown
     # Render layouts and place document content inside.
     #
     # Returns String rendered content
-    def place_in_layouts(content, payload, info)
+    def place_in_layouts(content, payload, liquid_context)
       output = content.dup
       layout = layouts[document.data["layout"].to_s]
       validate_layout(layout)
@@ -162,7 +175,7 @@ module Bridgetown
       payload["layout"] = nil
 
       while layout
-        output = render_layout(output, layout, info)
+        output = render_layout(output, layout, liquid_context)
         add_regenerator_dependencies(layout)
 
         next unless (layout = site.layouts[layout.data["layout"]])
@@ -189,14 +202,14 @@ module Bridgetown
     # Render layout content into document.output
     #
     # Returns String rendered content
-    def render_layout(output, layout, info)
+    def render_layout(output, layout, liquid_context)
       payload["content"] = output
       payload["layout"]  = Utils.deep_merge_hashes(layout.data, payload["layout"] || {})
 
       render_liquid(
         layout.content,
         payload,
-        info,
+        liquid_context,
         layout.path
       )
     end

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

@@ -3,6 +3,10 @@
 module Bridgetown
   module Tags
     class IncludeTag < Liquid::Tag
+      class << self
+        attr_accessor :deprecation_message_shown
+      end
+
       VALID_SYNTAX = %r!
         ([\w-]+)\s*=\s*
         (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))
@@ -18,6 +22,14 @@ module Bridgetown
 
       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
@@ -200,7 +212,9 @@ module Bridgetown
             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

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

@@ -3,28 +3,51 @@
 module Bridgetown
   module Tags
     class BlockRenderTag < Liquid::Block
-      def initialize(tag_name, markup, options)
-        super
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def render(context)
+        context.stack({}) do
+          # unindent the incoming text
+          content = Bridgetown::Utils.reindent_for_markdown(super)
 
-        @tag = tag_name
-        @markup = markup
-        @options = options
-      end
+          regions = gather_content_regions(context)
 
-      def render(context)
-        content = super.gsub(%r!^[ \t]+!, "") # unindent the incoming text
+          site = context.registers[:site]
+          converter = site.find_converter_instance(Bridgetown::Converters::Markdown)
+          markdownified_content = converter.convert(content)
+          context["processed_component_content"] = markdownified_content
 
-        site = context.registers[:site]
-        converter = site.find_converter_instance(Bridgetown::Converters::Markdown)
-        markdownified_content = converter.convert(content)
+          render_params = [@markup, "content: processed_component_content"]
+          unless regions.empty?
+            regions.each do |region_name, region_content|
+              region_name = region_name.sub("content_with_region_", "")
 
-        context.stack do
-          context["componentcontent"] = markdownified_content
-          render_params = "#{@markup}, content: componentcontent"
-          render_tag = Liquid::Render.parse("render", render_params, @options, @parse_context)
-          render_tag.render_tag(context, +"")
+              if region_name.end_with? ":markdown"
+                region_name.sub!(%r!:markdown$!, "")
+                context[region_name] = converter.convert(
+                  Bridgetown::Utils.reindent_for_markdown(region_content)
+                )
+              else
+                context[region_name] = region_content
+              end
+              render_params.push "#{region_name}: #{region_name}"
+            end
+          end
+
+          Liquid::Render.parse("render", render_params.join(","), nil, @parse_context)
+            .render_tag(context, +"")
         end
       end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+      private
+
+      def gather_content_regions(context)
+        unless context.scopes[0].keys.find { |k| k.to_s.start_with? "content_with_region_" }
+          return {}
+        end
+
+        context.scopes[0].select { |k| k.to_s.start_with? "content_with_region_" }
+      end
     end
   end
 end