bridgetown-core 0.15.0.beta3 → 0.16.0

data/lib/bridgetown-core/document.rb

@@ -2,8 +2,12 @@
 
 module Bridgetown
   class Document
-    include Comparable
     extend Forwardable
+    include DataAccessible
+    include Comparable
+    include LayoutPlaceable
+    include LiquidRenderable
+    include Publishable
 
     attr_reader :path, :site, :extname, :collection, :type
     attr_accessor :content, :output
@@ -95,6 +99,9 @@ module Bridgetown
       @relative_path ||= path.sub("#{site.collections_path}/", "")
     end
 
+    # FIXME: spinning up a new Renderer object just to get an extension
+    # seems excessive
+    #
     # The output extension of the document.
     #
     # Returns the output extension
@@ -143,38 +150,6 @@ module Bridgetown
       YAML_FILE_EXTS.include?(extname)
     end
 
-    # TODO: Depricated
-    # Used to determine CoffeeScript and Sass/SCSS files.
-    def asset_file?
-      false
-    end
-
-    # Determine whether the file should be rendered with Liquid.
-    #
-    # Returns false if the document is either an asset file or a yaml file,
-    #   or if the document doesn't contain any Liquid Tags or Variables,
-    #   true otherwise.
-    def render_with_liquid?
-      return false if data["render_with_liquid"] == false
-
-      !(yaml_file? || !Utils.has_liquid_construct?(content))
-    end
-
-    # Determine whether the file should be rendered with a layout.
-    #
-    # Returns true if the Front Matter specifies that `layout` is set to `none`.
-    def no_layout?
-      data["layout"] == "none"
-    end
-
-    # Determine whether the file should be placed into layouts.
-    #
-    # Returns false if the document is set to `layouts: none`, or is either an
-    #   asset file or a yaml file. Returns true otherwise.
-    def place_in_layout?
-      !(asset_file? || yaml_file? || no_layout?)
-    end
-
     # The URL template where the document would be accessible.
     #
     # Returns the URL template for the document.
@@ -209,10 +184,6 @@ module Bridgetown
       ).to_s
     end
 
-    def [](key)
-      data[key]
-    end
-
     # The full path to the output file.
     #
     # base_directory - the base path of the output directory
@@ -243,14 +214,6 @@ module Bridgetown
       trigger_hooks(:post_write)
     end
 
-    # Whether the file is published or not, as indicated in YAML front-matter
-    #
-    # Returns 'false' if the 'published' key is specified in the
-    # YAML front-matter and is 'false'. Otherwise returns 'true'.
-    def published?
-      !(data.key?("published") && data["published"] == false)
-    end
-
     # Read in the file and assign the content and data based on the file contents.
     # Merge the frontmatter of the file with the frontmatter default
     # values
@@ -287,13 +250,6 @@ module Bridgetown
       "#<#{self.class} #{relative_path} collection=#{collection.label}>"
     end
 
-    # The string representation for this document.
-    #
-    # Returns the content of the document
-    def to_s
-      output || content || "NO CONTENT"
-    end
-
     # Compare this document against another document.
     # Comparison is a comparison between the 2 paths of the documents.
     #

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/errors.rb

@@ -16,5 +16,7 @@ module Bridgetown
     PostURLError                = Class.new(FatalException)
     InvalidURLError             = Class.new(FatalException)
     InvalidConfigurationError   = Class.new(FatalException)
+
+    WebpackAssetError           = Class.new(FatalException)
   end
 end

data/lib/bridgetown-core/excerpt.rb

@@ -3,6 +3,7 @@
 module Bridgetown
   class Excerpt
     extend Forwardable
+    include LiquidRenderable
 
     attr_accessor :doc
     attr_accessor :content, :ext
@@ -91,12 +92,6 @@ module Bridgetown
       false
     end
 
-    def render_with_liquid?
-      return false if data["render_with_liquid"] == false
-
-      !(yaml_file? || !Utils.has_liquid_construct?(content))
-    end
-
     protected
 
     # Internal: Extract excerpt from the content

data/lib/bridgetown-core/filters.rb

@@ -30,6 +30,7 @@ module Bridgetown
       ).convert(input.to_s)
     end
 
+    # TODO: This should be removed, there is no Sass converter
     # Convert a Sass string into CSS output.
     #
     # input - The Sass String to convert.
@@ -41,6 +42,7 @@ module Bridgetown
       ).convert(input)
     end
 
+    # TODO: This should be removed, there is no Scss converter
     # Convert a Scss string into CSS output.
     #
     # input - The Scss String to convert.

data/lib/bridgetown-core/layout.rb

@@ -2,7 +2,9 @@
 
 module Bridgetown
   class Layout
-    include Convertible
+    include DataAccessible
+    include LiquidRenderable
+    include Validatable
 
     # Gets the Site object.
     attr_reader :site
@@ -25,6 +27,12 @@ module Bridgetown
     # Gets/Sets the content of this layout.
     attr_accessor :content
 
+    # Gets/Sets the current document (for layout-compatible converters)
+    attr_accessor :current_document
+
+    # Gets/Sets the document output (for layout-compatible converters)
+    attr_accessor :current_document_output
+
     # Initialize a new Layout.
     #
     # site - The Site.
@@ -51,6 +59,14 @@ module Bridgetown
       read_yaml(base, name)
     end
 
+    # The inspect string for this document.
+    # Includes the relative path and the collection label.
+    #
+    # Returns the inspect string for this document.
+    def inspect
+      "#<#{self.class} #{@path}>"
+    end
+
     # Extract information from the layout filename.
     #
     # name - The String filename of the layout file.
@@ -59,5 +75,12 @@ module Bridgetown
     def process(name)
       self.ext = File.extname(name)
     end
+
+    # Provide this Layout's data to a Hash suitable for use by Liquid.
+    #
+    # Returns the Hash representation of this Layout.
+    def to_liquid
+      data
+    end
   end
 end

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

@@ -32,7 +32,7 @@ module Bridgetown
 
         # Last path in the list wins
         LiquidComponent.parse(
-          ::File.read(found_paths.last, site.file_read_opts)
+          ::File.read(found_paths.last, **site.file_read_opts)
         ).content
       end
     end

data/lib/bridgetown-core/page.rb

@@ -2,7 +2,11 @@
 
 module Bridgetown
   class Page
-    include Convertible
+    include DataAccessible
+    include LayoutPlaceable
+    include LiquidRenderable
+    include Publishable
+    include Validatable
 
     attr_writer :dir
     attr_accessor :site, :pager
@@ -11,15 +15,6 @@ module Bridgetown
 
     alias_method :extname, :ext
 
-    # Attributes for Liquid templates
-    ATTRIBUTES_FOR_LIQUID = %w(
-      content
-      dir
-      name
-      path
-      url
-    ).freeze
-
     # A set of extensions that are considered HTML or HTML-like so we
     # should not alter them,  this includes .xhtml through XHTM5.
 
@@ -143,19 +138,6 @@ module Bridgetown
       self.basename = name[0..-ext.length - 1].gsub(%r!\.*\z!, "")
     end
 
-    # Add any necessary layouts to this post
-    #
-    # layouts      - The Hash of {"name" => "layout"}.
-    # site_payload - The site payload Hash.
-    #
-    # Returns String rendered page.
-    def render(layouts, site_payload)
-      site_payload["page"] = to_liquid
-      site_payload["paginator"] = pager.to_liquid
-
-      do_layout(site_payload, layouts)
-    end
-
     # The path to the source file
     #
     # Returns the path to the source file
@@ -165,7 +147,17 @@ 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
+
+    # FIXME: spinning up a new Renderer object just to get an extension
+    # seems excessive
+    #
+    # The output extension of the page.
+    #
+    # Returns the output extension
+    def output_ext
+      @output_ext ||= Bridgetown::Renderer.new(site, self).output_ext
     end
 
     # Obtain destination path.
@@ -180,9 +172,22 @@ module Bridgetown
       path
     end
 
+    # Write the generated page file to the destination directory.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns nothing.
+    def write(dest)
+      path = destination(dest)
+      FileUtils.mkdir_p(File.dirname(path))
+      Bridgetown.logger.debug "Writing:", path
+      File.write(path, output, mode: "wb")
+      Bridgetown::Hooks.trigger :pages, :post_write, self
+    end
+
     # Returns the object as a debug String.
     def inspect
-      "#<#{self.class} @relative_path=#{relative_path.inspect}>"
+      "#<#{self.class} #{relative_path}>"
     end
 
     # Returns the Boolean of whether this Page is HTML or not.
@@ -199,6 +204,10 @@ module Bridgetown
       Bridgetown::Hooks.trigger :pages, hook_name, self, *args
     end
 
+    def type
+      :pages
+    end
+
     def write?
       true
     end

data/lib/bridgetown-core/plugin_manager.rb

@@ -3,6 +3,7 @@
 module Bridgetown
   class PluginManager
     PLUGINS_GROUP = :bridgetown_plugins
+    YARN_DEPENDENCY_REGEXP = %r!(.+)@([^@]*)$!.freeze
 
     attr_reader :site
 
@@ -67,12 +68,20 @@ module Bridgetown
     # If that exact package hasn't been installed, execute yarn add
     #
     # Returns nothing.
-    def self.install_yarn_dependencies(required_gems)
+    def self.install_yarn_dependencies(required_gems, single_gemname = nil)
       return unless File.exist?("package.json")
 
       package_json = JSON.parse(File.read("package.json"))
 
-      required_gems.each do |loaded_gem|
+      gems_to_search = if single_gemname
+                         required_gems.select do |loaded_gem|
+                           loaded_gem.to_spec&.name == single_gemname.to_s
+                         end
+                       else
+                         required_gems
+                       end
+
+      gems_to_search.each do |loaded_gem|
         yarn_dependency = find_yarn_dependency(loaded_gem)
         next unless add_yarn_dependency?(yarn_dependency, package_json)
 
@@ -83,10 +92,10 @@ module Bridgetown
     end
 
     def self.find_yarn_dependency(loaded_gem)
-      yarn_dependency = loaded_gem.to_spec&.metadata&.dig("yarn-add")&.split("@")
-      return nil if yarn_dependency&.length != 2
+      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
+      yarn_dependency[1..2]
     end
 
     def self.add_yarn_dependency?(yarn_dependency, package_json)

data/lib/bridgetown-core/regenerator.rb

@@ -163,7 +163,7 @@ module Bridgetown
     end
 
     def regenerate_page?(document)
-      document.asset_file? || document.data["regenerate"] ||
+      document.data["regenerate"] ||
         source_modified_or_dest_missing?(
           site.in_source_dir(document.relative_path), document.destination(@site.dest)
         )

data/lib/bridgetown-core/renderer.rb

@@ -58,6 +58,7 @@ module Bridgetown
       Bridgetown.logger.debug "Rendering:", document.relative_path
 
       assign_pages!
+      # TODO: this can be eliminated I think:
       assign_current_document!
       assign_highlighter_options!
       assign_layout_data!
@@ -83,7 +84,7 @@ module Bridgetown
       end
 
       Bridgetown.logger.debug "Rendering Markup:", document.relative_path
-      output = convert(output.to_s)
+      output = convert(output.to_s, document)
       document.content = output
 
       if document.place_in_layout?
@@ -140,9 +141,13 @@ module Bridgetown
     # Convert the document using the converters which match this renderer's document.
     #
     # Returns String the converted content.
-    def convert(content)
+    def convert(content, document)
       converters.reduce(content) do |output, converter|
-        converter.convert output
+        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 "\
@@ -202,17 +207,38 @@ module Bridgetown
     # Render layout content into document.output
     #
     # Returns String rendered content
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     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,
-        liquid_context,
-        layout.path
-      )
+      if layout.render_with_liquid?
+        payload["content"] = output
+        payload["layout"]  = Utils.deep_merge_hashes(layout.data, payload["layout"] || {})
+
+        render_liquid(
+          layout.content,
+          payload,
+          liquid_context,
+          layout.path
+        )
+      else
+        layout_converters ||= site.converters.select { |c| c.matches(layout.ext) }.sort
+
+        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}':"
+          Bridgetown.logger.error("", e.to_s)
+          raise e
+        end
+      end
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def add_regenerator_dependencies(layout)
       return unless document.write?