bridgetown-core 0.15.0.beta1 → 0.16.0.beta1

data/lib/bridgetown-core/converter.rb

@@ -2,6 +2,20 @@
 
 module Bridgetown
   class Converter < Plugin
+    class << self
+      attr_accessor :extname_list
+
+      # Converters can provide one or more extensions they accept. Examples:
+      #
+      # * `input :erb`
+      # * `input %i(xls xlsx)`
+      def input(extnames)
+        extnames = Array(extnames)
+        self.extname_list ||= []
+        self.extname_list += extnames.map { |e| ".#{e.to_s.downcase}" }
+      end
+    end
+
     # Public: Get or set the highlighter prefix. When an argument is specified,
     # the prefix will be set. If no argument is specified, the current prefix
     # will be returned.
@@ -37,6 +51,26 @@ module Bridgetown
       @config = config
     end
 
+    # Does the given extension match this converter's list of acceptable extensions?
+    #
+    # @param [String] ext
+    #   The file's extension (including the dot)
+    #
+    # @return [Boolean] Whether the extension matches one in the list
+    def matches(ext)
+      (self.class.extname_list || []).include?(ext.downcase)
+    end
+
+    # You can override this in Converter subclasses as needed. Default is ".html"
+    #
+    # @param [String] ext
+    #   The extension of the original file
+    #
+    # @return [String] The output file extension (including the dot)
+    def output_ext(_ext)
+      ".html"
+    end
+
     # Get the highlighter prefix.
     #
     # Returns the String prefix.

data/lib/bridgetown-core/converters/erb_templates.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "tilt/erb"
+require "active_support/core_ext/hash/keys"
+
+module Bridgetown
+  class ERBView < RubyTemplateView
+    include ERB::Util
+
+    def partial(partial_name, options = {})
+      options.merge!(options[:locals]) if options[:locals]
+
+      partial_segments = partial_name.split("/")
+      partial_segments.last.sub!(%r!^!, "_")
+      partial_name = partial_segments.join("/")
+
+      Tilt::ERBTemplate.new(
+        site.in_source_dir(site.config[:partials_dir], "#{partial_name}.erb"),
+        trim: "<>-",
+        outvar: "@_erbout"
+      ).render(self, options)
+    end
+
+    def markdownify
+      previous_buffer_state = @_erbout
+      @_erbout = +""
+      result = yield
+      @_erbout = previous_buffer_state
+
+      content = Bridgetown::Utils.reindent_for_markdown(result)
+      converter = site.find_converter_instance(Bridgetown::Converters::Markdown)
+      md_output = converter.convert(content).strip
+      @_erbout << md_output
+    end
+  end
+
+  module Converters
+    class ERBTemplates < Converter
+      input :erb
+
+      # Logic to do the content conversion.
+      #
+      # content - String content of file (without front matter).
+      #
+      # Returns a String of the converted content.
+      def convert(content, convertible)
+        erb_view = Bridgetown::ERBView.new(convertible)
+
+        erb_renderer = Tilt::ERBTemplate.new(trim: "<>-", outvar: "@_erbout") { content }
+
+        if convertible.is_a?(Bridgetown::Layout)
+          erb_renderer.render(erb_view) do
+            convertible.current_document_output
+          end
+        else
+          erb_renderer.render(erb_view)
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-core/converters/markdown.rb

@@ -8,6 +8,12 @@ module Bridgetown
       highlighter_prefix "\n"
       highlighter_suffix "\n"
 
+      def initialize(config = {})
+        super
+
+        self.class.input @config["markdown_ext"].split(",")
+      end
+
       def setup
         return if @setup ||= false
 
@@ -51,25 +57,6 @@ module Bridgetown
         self.class.constants - [:KramdownParser, :PRIORITIES]
       end
 
-      # Does the given extension match this converter's list of acceptable extensions?
-      # Takes one argument: the file's extension (including the dot).
-      #
-      # ext - The String extension to check.
-      #
-      # Returns true if it matches, false otherwise.
-      def matches(ext)
-        extname_list.include?(ext.downcase)
-      end
-
-      # Public: The extension to be given to the output file (including the dot).
-      #
-      # ext - The String extension or original file.
-      #
-      # Returns The String output file extension.
-      def output_ext(_ext)
-        ".html"
-      end
-
       # Logic to do the content conversion.
       #
       # content - String content of file (without front matter).
@@ -82,10 +69,6 @@ module Bridgetown
         end
       end
 
-      def extname_list
-        @extname_list ||= @config["markdown_ext"].split(",").map! { |e| ".#{e.downcase}" }
-      end
-
       private
 
       def custom_processor

data/lib/bridgetown-core/converters/smartypants.rb

@@ -30,16 +30,6 @@ module Bridgetown
         @config[:input] = :SmartyPants
       end
 
-      # Does the given extension match this converter's list of acceptable extensions?
-      # Takes one argument: the file's extension (including the dot).
-      #
-      # ext - The String extension to check.
-      #
-      # Returns true if it matches, false otherwise.
-      def matches(_ext)
-        false
-      end
-
       # Public: The extension to be given to the output file (including the dot).
       #
       # ext - The String extension or original file.

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/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/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
@@ -81,19 +82,16 @@ 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?
       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.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

@@ -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.
 
@@ -73,18 +68,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 +77,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
@@ -158,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
@@ -180,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.
@@ -195,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.
@@ -214,6 +204,10 @@ module Bridgetown
       Bridgetown::Hooks.trigger :pages, hook_name, self, *args
     end
 
+    def type
+      :pages
+    end
+
     def write?
       true
     end