bridgetown-core 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6a9d2528b695e8e0cf1016e12d9ef4f83ea3983568db4b20e740f5256024990
-  data.tar.gz: 8cfdc7484ba7f011cac11708667eb93e3fa27400269b7a548fc1cbc80dee37c1
+  metadata.gz: 34e42f164cec4d31c4904ed8f35ea1ac8079a60d79ec89fb97946b4e9799e65a
+  data.tar.gz: a590bd4e904bbbd89d0fa57541280fc9c01c11bbac5974261940020a4bb9d832
 SHA512:
-  metadata.gz: 98523ff2520d3428505ba743408fd20f4672cdfdebdb50fe914b025b7e63e6d661f923cdd6ee0d27c9f8cd126fc08b8b522206461b5e5862b6ddc7b30fcfe02c
-  data.tar.gz: 795673a2a1e3b44aa0624fbf1c7bb0e9bac35d2f3882dd45d309f70346777896a9ed75c1993f186f2a3adfc94df0d5c69e0beb71a7fbeaea3aa7ac5bf774400f
+  metadata.gz: 7a6654c80468f31af2d728bcef3820f1c265e67df5f0e8c92e8d495c4376d309da919d3c31a69b69ac87ad3b9d6849f93ec45e69630f2875e43c5282dbd54d4d
+  data.tar.gz: 709855c6285071f112206bf7f2a96f5956abc74f35c8bbf591f2b13f222a6e75e83158d93062f948d34f878ee62048747a6c9337710ebe9f0da2ef4f18db25bd

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

@@ -10,7 +10,7 @@ class Bridgetown::Site
       Bridgetown::Hooks.trigger :site, :pre_render, self
       execute_inline_ruby_for_layouts!
       render_resources
-      render_generated_pages
+      generated_pages.each(&:transform!)
       Bridgetown::Hooks.trigger :site, :post_render, self
     end
 
@@ -46,6 +46,32 @@ class Bridgetown::Site
       matches
     end
 
+    # @return [Array<Bridgetown::Layout>]
+    def validated_layouts_for(convertible, layout_name)
+      layout = layouts[layout_name]
+      warn_on_missing_layout convertible, layout, layout_name
+
+      layout_list = Set.new([layout])
+      while layout
+        layout_name = layout.data.layout
+        layout = layouts[layout_name]
+        warn_on_missing_layout convertible, layout, layout_name
+
+        layout_list << layout
+      end
+
+      layout_list.to_a.compact
+    end
+
+    def warn_on_missing_layout(convertible, layout, layout_name)
+      return unless layout.nil? && layout_name
+
+      Bridgetown.logger.warn(
+        "Build Warning:",
+        "Layout '#{layout_name}' requested via #{convertible.relative_path} does not exist."
+      )
+    end
+
     # Renders all resources
     # @return [void]
     def render_resources
@@ -58,14 +84,6 @@ class Bridgetown::Site
       end
     end
 
-    # Renders all generated pages
-    # @return [void]
-    def render_generated_pages
-      generated_pages.each do |page|
-        render_page page
-      end
-    end
-
     # Renders a content item while ensuring site locale is set if the data is available.
     # @param item [Document, Page, Bridgetown::Resource::Base] The item to render
     # @yield Runs the block in between locale setting and resetting
@@ -80,12 +98,5 @@ class Bridgetown::Site
         yield
       end
     end
-
-    # Regenerates a content item using {Renderer}
-    # @param item [Page] The page to render
-    # @return [void]
-    def render_page(page)
-      Bridgetown::Renderer.new(self, page).run
-    end
   end
 end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Transformable
+    # Transforms an input document by running it through available converters
+    # (requires a `converter` method to be present on the including class)
+    #
+    # @param document [Bridgetown::GeneratedPage, Bridgetown::Resource::Base]
+    # @return String
+    # @yieldparam converter [Bridgetown::Converter]
+    # @yieldparam index [Integer] index of the conversion step
+    # @yieldparam output [String]
+    def transform_content(document)
+      converters.each_with_index.inject(document.content.to_s) do |content, (converter, index)|
+        output = if converter.method(:convert).arity == 1
+                   converter.convert content
+                 else
+                   converter.convert content, document
+                 end
+
+        yield converter, index, output if block_given?
+
+        output.html_safe
+      rescue StandardError => e
+        Bridgetown.logger.error "Conversion error:",
+                                "#{converter.class} encountered an error while "\
+                                "converting `#{document.relative_path}'"
+        raise e
+      end
+    end
+
+    # Transforms an input document by placing it within the specified layout
+    #
+    # @param layout [Bridgetown::Layout]
+    # @param output [String] the output from document content conversions
+    # @param document [Bridgetown::GeneratedPage, Bridgetown::Resource::Base]
+    # @return String
+    # @yieldparam converter [Bridgetown::Converter]
+    # @yieldparam layout_output [String]
+    def transform_with_layout(layout, output, document)
+      layout_converters = site.matched_converters_for_convertible(layout)
+      layout_input = layout.content.dup
+
+      layout_converters.inject(layout_input) do |content, converter|
+        next(content) unless [2, -2].include?(converter.method(:convert).arity) # rubocop:disable Performance/CollectionLiteralInLoop
+
+        layout.current_document = document
+        layout.current_document_output = output
+        layout_output = converter.convert content, layout
+
+        yield converter, layout_output if block_given?
+
+        layout_output
+      rescue StandardError => e
+        Bridgetown.logger.error "Conversion error:",
+                                "#{converter.class} encountered an error while "\
+                                "converting `#{document.relative_path}'"
+        raise e
+      end
+    end
+  end
+end

data/lib/bridgetown-core/generated_page.rb

@@ -5,6 +5,7 @@ module Bridgetown
     include LayoutPlaceable
     include LiquidRenderable
     include Publishable
+    include Transformable
 
     attr_writer :dir
     attr_accessor :site, :paginator, :name, :ext, :basename, :data, :content, :output
@@ -12,7 +13,7 @@ module Bridgetown
     alias_method :extname, :ext
 
     # A set of extensions that are considered HTML or HTML-like so we
-    # should not alter them,  this includes .xhtml through XHTM5.
+    # should not alter them
 
     HTML_EXTENSIONS = %w(
       .html
@@ -54,11 +55,11 @@ module Bridgetown
       output || content || ""
     end
 
-    # Accessor for data properties by Liquid.
+    # Accessor for data properties by Liquid
     #
-    # property - The String name of the property to retrieve.
+    # @param property [String] name of the property to retrieve
     #
-    # Returns the String value or nil if the property isn't included.
+    # @return [Object]
     def [](property)
       data[property]
     end
@@ -67,7 +68,7 @@ module Bridgetown
     # upon generation. This is derived from the permalink or, if
     # permalink is absent, will be '/'
     #
-    # Returns the String destination directory.
+    # @return [String]
     def dir
       if url.end_with?("/")
         url
@@ -78,6 +79,8 @@ module Bridgetown
     end
 
     # Liquid representation of current page
+    #
+    # @return [Bridgetown::Drops::GeneratedPageDrop]
     def to_liquid
       @liquid_drop ||= Drops::GeneratedPageDrop.new(self)
     end
@@ -90,7 +93,7 @@ module Bridgetown
 
     # The template of the permalink.
     #
-    # Returns the template String.
+    # @return [String]
     def template
       if !html?
         "/:path/:basename:output_ext"
@@ -103,7 +106,7 @@ module Bridgetown
 
     # The generated relative url of this page. e.g. /about.html.
     #
-    # Returns the String url.
+    # @return [String]
     def url
       @url ||= URL.new(
         template: template,
@@ -123,6 +126,22 @@ module Bridgetown
       }
     end
 
+    # Layout associated with this resource
+    # This will output a warning if the layout can't be found.
+    #
+    # @return [Bridgetown::Layout]
+    def layout
+      return @layout if @layout
+      return if no_layout?
+
+      @layout = site.layouts[data.layout].tap do |layout|
+        unless layout
+          Bridgetown.logger.warn "Generated Page:", "Layout '#{data.layout}' " \
+                                                    "requested via #{relative_path} does not exist."
+        end
+      end
+    end
+
     # Overide this in subclasses for custom initialization behavior
     def process
       # no-op by default
@@ -139,21 +158,68 @@ module Bridgetown
       @relative_path ||= File.join(*[@dir, @name].map(&:to_s).reject(&:empty?)).delete_prefix("/")
     end
 
-    # FIXME: spinning up a new Renderer object just to get an extension
-    # seems excessive
-    #
     # The output extension of the page.
     #
-    # Returns the output extension
+    # @return [String]
     def output_ext
-      @output_ext ||= Bridgetown::Renderer.new(site, self).output_ext
+      @output_ext ||= (permalink_ext || converter_output_ext)
+    end
+
+    def permalink_ext
+      page_permalink = permalink
+      if page_permalink &&
+          !page_permalink.end_with?("/")
+        permalink_ext = File.extname(page_permalink)
+        permalink_ext unless permalink_ext.empty?
+      end
+    end
+
+    def converter_output_ext
+      if output_exts.size == 1
+        output_exts.last
+      else
+        output_exts[-2]
+      end
+    end
+
+    def output_exts
+      @output_exts ||= converters.filter_map do |c|
+        c.output_ext(extname)
+      end
+    end
+
+    # @return [Array<Bridgetown::Converter>]
+    def converters
+      @converters ||= site.matched_converters_for_convertible(self)
+    end
+
+    def transform!
+      Bridgetown.logger.debug "Transforming:", relative_path
+
+      trigger_hooks :pre_render
+      self.content = transform_content(self)
+      place_in_layout? ? place_into_layouts : self.output = content.dup
+      trigger_hooks :post_render
+
+      self
+    end
+
+    def place_into_layouts
+      Bridgetown.logger.debug "Placing in Layouts:", relative_path
+      rendered_output = content.dup
+
+      site.validated_layouts_for(self, data.layout).each do |layout|
+        rendered_output = transform_with_layout(layout, rendered_output, self)
+      end
+
+      self.output = rendered_output
     end
 
     # Obtain destination path.
     #
-    # dest - The String path to the destination dir.
+    # @param dest [String] path to the destination dir
     #
-    # Returns the destination file path String.
+    # @return [String]
     def destination(dest)
       path = site.in_dest_dir(dest, URL.unescape_path(url))
       path = File.join(path, "index") if url.end_with?("/")
@@ -163,9 +229,7 @@ module Bridgetown
 
     # Write the generated page file to the destination directory.
     #
-    # dest - The String path to the destination dir.
-    #
-    # Returns nothing.
+    # @param dest [String] path to the destination dir
     def write(dest)
       path = destination(dest)
       FileUtils.mkdir_p(File.dirname(path))

data/lib/bridgetown-core/resource/transformer.rb

@@ -3,6 +3,8 @@
 module Bridgetown
   module Resource
     class Transformer
+      include Transformable
+
       # @return [Array<Hash>]
       attr_reader :conversions
 
@@ -30,10 +32,18 @@ module Bridgetown
         permalink_ext || output_ext
       end
 
-      def process!
+      def process! # rubocop:disable Metrics/AbcSize
         Bridgetown.logger.debug "Transforming:", resource.relative_path
         resource.around_hook :render do
-          run_conversions
+          resource.content = transform_content(resource) do |converter, index, output|
+            conversions[index] = {
+              type: :content,
+              converter: converter,
+              output: Bridgetown.env.production? ? nil : output,
+              output_ext: conversions[index]&.dig(:output_ext) ||
+                converter.output_ext(resource.extname),
+            }
+          end
           resource.place_in_layout? ? place_into_layouts : resource.output = resource.content.dup
         end
       end
@@ -85,95 +95,21 @@ module Bridgetown
           .fetch(:output_ext)
       end
 
-      # @return [Array<Bridgetown::Layout>]
-      def validated_layouts
-        layout = site.layouts[resource.data.layout]
-        warn_on_missing_layout layout, resource.data.layout
-
-        layout_list = Set.new([layout])
-        while layout
-          layout_name = layout.data.layout
-          layout = site.layouts[layout_name]
-          warn_on_missing_layout layout, layout_name
-
-          layout_list << layout
-        end
-
-        layout_list.to_a.compact
-      end
-
-      def warn_on_missing_layout(layout, layout_name)
-        return unless layout.nil? && layout_name
-
-        Bridgetown.logger.warn(
-          "Build Warning:",
-          "Layout '#{layout_name}' requested via #{resource.relative_path} does not exist."
-        )
-      end
-
-      ### Transformation Actions
-
-      def run_conversions # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        input = resource.content.to_s
-
-        # @param content [String]
-        # @param converter [Bridgetown::Converter]
-        resource.content = converters.each_with_index.inject(input) do |content, (converter, index)|
-          output = if converter.method(:convert).arity == 1
-                     converter.convert content
-                   else
-                     converter.convert content, resource
-                   end
-          conversions[index] = {
-            type: :content,
-            converter: converter,
-            output: Bridgetown.env.production? ? nil : output,
-            output_ext: conversions[index]&.dig(:output_ext) ||
-              converter.output_ext(resource.extname),
-          }
-          output.html_safe
-        rescue StandardError => e
-          Bridgetown.logger.error "Conversion error:",
-                                  "#{converter.class} encountered an error while "\
-                                  "converting `#{resource.relative_path}'"
-          raise e
-        end
-      end
-
       def place_into_layouts
         Bridgetown.logger.debug "Placing in Layouts:", resource.relative_path
         output = resource.content.dup
-        validated_layouts.each do |layout|
-          output = run_layout_conversions layout, output
+        site.validated_layouts_for(resource, resource.data.layout).each do |layout|
+          output = transform_with_layout(layout, output, resource) do |converter, layout_output|
+            conversions << {
+              type: :layout,
+              layout: layout,
+              converter: converter,
+              output: Bridgetown.env.production? ? nil : layout_output,
+            }
+          end
         end
         resource.output = output
       end
-
-      def run_layout_conversions(layout, output)
-        layout_converters = site.matched_converters_for_convertible(layout)
-        layout_input = layout.content.dup
-
-        layout_converters.inject(layout_input) do |content, converter|
-          next(content) unless [2, -2].include?(converter.method(:convert).arity) # rubocop:disable Performance/CollectionLiteralInLoop
-
-          layout.current_document = resource
-          layout.current_document_output = output
-          layout_output = converter.convert content, layout
-
-          conversions << {
-            type: :layout,
-            layout: layout,
-            converter: converter,
-            output: Bridgetown.env.production? ? nil : layout_output,
-          }
-          layout_output
-        rescue StandardError => e
-          Bridgetown.logger.error "Conversion error:",
-                                  "#{converter.class} encountered an error while "\
-                                  "converting `#{resource.relative_path}'"
-          raise e
-        end
-      end
     end
   end
 end

data/lib/bridgetown-core/version.rb

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

data/lib/bridgetown-core.rb

@@ -92,11 +92,11 @@ module Bridgetown
   autoload :Publishable,         "bridgetown-core/concerns/publishable"
   autoload :Publisher,           "bridgetown-core/publisher"
   autoload :Reader,              "bridgetown-core/reader"
-  autoload :Renderer,            "bridgetown-core/renderer"
   autoload :RubyTemplateView,    "bridgetown-core/ruby_template_view"
   autoload :LogWriter,           "bridgetown-core/log_writer"
   autoload :Site,                "bridgetown-core/site"
   autoload :StaticFile,          "bridgetown-core/static_file"
+  autoload :Transformable,       "bridgetown-core/concerns/transformable"
   autoload :URL,                 "bridgetown-core/url"
   autoload :Utils,               "bridgetown-core/utils"
   autoload :VERSION,             "bridgetown-core/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -418,6 +418,7 @@ files:
 - lib/bridgetown-core/concerns/site/renderable.rb
 - lib/bridgetown-core/concerns/site/ssr.rb
 - lib/bridgetown-core/concerns/site/writable.rb
+- lib/bridgetown-core/concerns/transformable.rb
 - lib/bridgetown-core/configuration.rb
 - lib/bridgetown-core/configurations/.keep
 - lib/bridgetown-core/configurations/bt-postcss.rb
@@ -508,7 +509,6 @@ files:
 - lib/bridgetown-core/readers/defaults_reader.rb
 - lib/bridgetown-core/readers/layout_reader.rb
 - lib/bridgetown-core/readers/plugin_content_reader.rb
-- lib/bridgetown-core/renderer.rb
 - lib/bridgetown-core/resource/base.rb
 - lib/bridgetown-core/resource/destination.rb
 - lib/bridgetown-core/resource/permalink_processor.rb

data/lib/bridgetown-core/renderer.rb

@@ -1,169 +0,0 @@
-# frozen_string_literal: true
-
-module Bridgetown
-  # This class handles the output rendering and layout placement of pages and
-  # documents. For rendering of resources in particular, see Bridgetown::Resource::Transformer
-  class Renderer
-    attr_reader :document, :site
-
-    def initialize(site, document)
-      @site     = site
-      @document = document
-    end
-
-    # Determine which converters to use based on this document's
-    # extension.
-    #
-    # Returns Array of Converter instances.
-    def converters
-      @converters ||= site.converters.select do |converter|
-        if converter.method(:matches).arity == 1
-          converter.matches(document.extname)
-        else
-          converter.matches(document.extname, document)
-        end
-      end.sort
-    end
-
-    # Determine the extname the outputted file should have
-    #
-    # Returns String the output extname including the leading period.
-    def output_ext
-      @output_ext ||= (permalink_ext || converter_output_ext)
-    end
-
-    # Run hooks and render the document
-    #
-    # Returns nothing
-    def run
-      Bridgetown.logger.debug "Rendering:", document.relative_path
-
-      document.trigger_hooks :pre_render
-      document.output = render_document
-      document.trigger_hooks :post_render
-    end
-
-    # Render the document.
-    #
-    # Returns String rendered document output
-    def render_document
-      execute_inline_ruby!
-
-      output = document.content
-      Bridgetown.logger.debug "Rendering Markup:", document.relative_path
-      output = convert(output.to_s, document)
-      document.content = output.html_safe
-
-      if document.place_in_layout?
-        Bridgetown.logger.debug "Rendering Layout:", document.relative_path
-        output = place_in_layouts(output)
-      end
-
-      output
-    end
-
-    def execute_inline_ruby!
-      return unless site.config.should_execute_inline_ruby?
-
-      Bridgetown::Utils::RubyExec.search_data_for_ruby_code(document)
-    end
-
-    # Convert the document using the converters which match this renderer's document.
-    #
-    # Returns String the converted content.
-    def convert(content, document)
-      converters.reduce(content) do |output, converter|
-        if converter.method(:convert).arity == 1
-          converter.convert output
-        else
-          converter.convert output, document
-        end
-      rescue StandardError => e
-        Bridgetown.logger.error "Conversion error:",
-                                "#{converter.class} encountered an error while "\
-                                "converting `#{document.relative_path}'"
-        raise e
-      end
-    end
-
-    # Render layouts and place document content inside.
-    #
-    # Returns String rendered content
-    def place_in_layouts(content)
-      output = content.dup
-      layout = site.layouts[document.data["layout"]]
-      validate_layout(layout)
-
-      used = Set.new([layout])
-
-      while layout
-        output = render_layout(output, layout)
-
-        next unless (layout = site.layouts[layout.data["layout"]])
-        break if used.include?(layout)
-
-        used << layout
-      end
-      output
-    end
-
-    private
-
-    # Checks if the layout specified in the document actually exists
-    #
-    # layout - the layout to check
-    # Returns nothing
-    def validate_layout(layout)
-      return unless document.data["layout"].present? &&
-        layout.nil? &&
-        !(document.is_a? Bridgetown::Excerpt)
-
-      Bridgetown.logger.warn "Build Warning:", "Layout '#{document.data["layout"]}' requested " \
-                                               "in #{document.relative_path} does not exist."
-    end
-
-    # Render layout content into document.output
-    #
-    # Returns String rendered content
-    def render_layout(output, layout)
-      layout_converters = site.matched_converters_for_convertible(layout)
-
-      layout_content = layout.content.dup
-      layout_converters.reduce(layout_content) do |layout_output, converter|
-        next(layout_output) unless converter.method(:convert).arity == 2
-
-        layout.current_document = document
-        layout.current_document_output = output
-        converter.convert layout_output, layout
-      rescue StandardError => e
-        Bridgetown.logger.error "Conversion error:",
-                                "#{converter.class} encountered an error while "\
-                                "converting `#{document.relative_path}'"
-        raise e
-      end
-    end
-
-    def permalink_ext
-      document_permalink = document.permalink
-      if document_permalink &&
-          !document_permalink.end_with?("/")
-        permalink_ext = File.extname(document_permalink)
-        permalink_ext unless permalink_ext.empty?
-      end
-    end
-
-    def converter_output_ext
-      if output_exts.size == 1
-        output_exts.last
-      else
-        output_exts[-2]
-      end
-    end
-
-    def output_exts
-      @output_exts ||= converters.filter_map do |c|
-        c.output_ext(document.extname)
-      end
-    end
-  end
-end