bridgetown-core 0.15.0 → 0.17.1

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,24 +2,19 @@
 
 module Bridgetown
   class Page
-    include Convertible
+    include DataAccessible
+    include LayoutPlaceable
+    include LiquidRenderable
+    include Publishable
+    include Validatable
 
     attr_writer :dir
-    attr_accessor :site, :pager
+    attr_accessor :site, :paginator, :pager
     attr_accessor :name, :ext, :basename
     attr_accessor :data, :content, :output
 
     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.
 
@@ -126,12 +121,18 @@ module Bridgetown
     # desired placeholder replacements. For details see "url.rb"
     def url_placeholders
       {
-        path: @dir,
+        path: qualified_pages_path_for_url,
         basename: basename,
         output_ext: output_ext,
       }
     end
 
+    # Strips _pages prefix off if needed for the url/destination generation
+    # @return [String]
+    def qualified_pages_path_for_url
+      @dir.sub(%r!^/_pages!, "")
+    end
+
     # Extract information from the page filename.
     #
     # name - The String filename of the page file.
@@ -143,19 +144,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
@@ -168,6 +156,16 @@ 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
+    def output_ext
+      @output_ext ||= Bridgetown::Renderer.new(site, self).output_ext
+    end
+
     # Obtain destination path.
     #
     # dest - The String path to the destination dir.
@@ -180,9 +178,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 +210,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

@@ -68,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)
 

data/lib/bridgetown-core/reader.rb

@@ -13,6 +13,7 @@ module Bridgetown
     # Returns nothing.
     # rubocop:disable Metrics/AbcSize
     def read
+      @site.defaults_reader.read
       @site.layouts = LayoutReader.new(site).read
       read_directories
       read_included_excludes

data/lib/bridgetown-core/readers/collection_reader.rb

@@ -5,6 +5,7 @@ module Bridgetown
     SPECIAL_COLLECTIONS = %w(posts data).freeze
 
     attr_reader :site, :content
+
     def initialize(site)
       @site = site
       @content = {}

data/lib/bridgetown-core/readers/data_reader.rb

@@ -3,9 +3,10 @@
 module Bridgetown
   class DataReader
     attr_reader :site, :content
+
     def initialize(site)
       @site = site
-      @content = ActiveSupport::HashWithIndifferentAccess.new
+      @content = {}
       @entry_filter = EntryFilter.new(site)
     end
 
@@ -19,7 +20,7 @@ module Bridgetown
       base = site.in_source_dir(dir)
       read_data_to(base, @content)
       merge_environment_specific_metadata!
-      @content
+      @content = @content.with_dot_access
     end
 
     # Read and parse all .yaml, .yml, .json, .csv and .tsv
@@ -43,7 +44,7 @@ module Bridgetown
         if File.directory?(path)
           read_data_to(
             path,
-            data[sanitize_filename(entry)] = ActiveSupport::HashWithIndifferentAccess.new
+            data[sanitize_filename(entry)] = {}
           )
         else
           key = sanitize_filename(File.basename(entry, ".*"))

data/lib/bridgetown-core/readers/defaults_reader.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  class DefaultsReader
+    attr_reader :site, :path_defaults
+
+    def initialize(site)
+      @site = site
+      @path_defaults = HashWithDotAccess::Hash.new
+    end
+
+    def read
+      return unless File.directory?(site.source)
+
+      entries = Dir.chdir(site.source) do
+        Dir["**/_defaults.{yaml,yml,json}"]
+      end
+
+      entries.each do |entry|
+        path = @site.in_source_dir(entry)
+        @path_defaults[File.dirname(path) + File::SEPARATOR] = SafeYAML.load_file(path)
+      end
+
+      @path_defaults
+    end
+  end
+end

data/lib/bridgetown-core/readers/layout_reader.rb

@@ -3,6 +3,7 @@
 module Bridgetown
   class LayoutReader
     attr_reader :site
+
     def initialize(site)
       @site = site
       @layouts = {}

data/lib/bridgetown-core/readers/page_reader.rb

@@ -3,6 +3,7 @@
 module Bridgetown
   class PageReader
     attr_reader :site, :dir, :unfiltered_content
+
     def initialize(site, dir)
       @site = site
       @dir = dir

data/lib/bridgetown-core/readers/post_reader.rb

@@ -3,6 +3,7 @@
 module Bridgetown
   class PostReader
     attr_reader :site, :unfiltered_content
+
     def initialize(site)
       @site = site
     end

data/lib/bridgetown-core/readers/static_file_reader.rb

@@ -3,6 +3,7 @@
 module Bridgetown
   class StaticFileReader
     attr_reader :site, :dir, :unfiltered_content
+
     def initialize(site, dir)
       @site = site
       @dir = dir

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?
@@ -223,12 +249,12 @@ module Bridgetown
       )
     end
 
-    # Set page content to payload and assign pager if document has one.
+    # Set page content to payload and assign paginator if document has one.
     #
     # Returns nothing
     def assign_pages!
       payload["page"] = document.to_liquid
-      payload["paginator"] = (document.pager.to_liquid if document.respond_to?(:pager))
+      payload["paginator"] = document.paginator.to_liquid if document.respond_to?(:paginator)
     end
 
     # Set related posts to payload if document is a post.

data/lib/bridgetown-core/ruby_template_view.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "digest"
+require "active_support/core_ext/hash/keys"
+
+module Bridgetown
+  class RubyTemplateView
+    class Helpers
+      include Bridgetown::Filters
+
+      attr_reader :view, :site
+
+      Context = Struct.new(:registers)
+
+      def initialize(view, site)
+        @view = view
+        @site = site
+
+        # duck typing for Liquid context
+        @context = Context.new({ site: site })
+      end
+
+      def webpack_path(asset_type)
+        Bridgetown::Utils.parse_webpack_manifest_file(site, asset_type.to_s)
+      end
+
+      # @param pairs [Hash] A hash of key/value pairs.
+      #
+      # @return [String] Space-separated keys where the values are truthy.
+      def class_map(pairs = {})
+        pairs.select { |_key, truthy| truthy }.keys.join(" ")
+      end
+
+      def t(*args)
+        I18n.send :t, *args
+      end
+    end
+
+    attr_reader :layout, :page, :paginator, :site, :content
+
+    def initialize(convertible)
+      if convertible.is_a?(Layout)
+        @layout = convertible
+        @page = layout.current_document
+        @content = layout.current_document_output
+      else
+        @page = convertible
+      end
+      @paginator = page.paginator if page.respond_to?(:paginator)
+      @site = page.site
+    end
+
+    def partial(_partial_name, _options = {})
+      raise "Must be implemented in a subclass"
+    end
+
+    def site_drop
+      site.site_payload.site
+    end
+
+    def liquid_render(component, options = {})
+      render_statement = _render_statement(component, options)
+
+      template = site.liquid_renderer.file(
+        "#{page.path}.#{Digest::SHA2.hexdigest(render_statement)}"
+      ).parse(render_statement)
+      template.warnings.each do |e|
+        Bridgetown.logger.warn "Liquid Warning:",
+                               LiquidRenderer.format_error(e, path || document.relative_path)
+      end
+      template.render!(options.deep_stringify_keys, _liquid_context)
+    end
+
+    def helpers
+      @helpers ||= Helpers.new(self, site)
+    end
+
+    def method_missing(method, *args, &block)
+      if helpers.respond_to?(method.to_sym)
+        helpers.send method.to_sym, *args, &block
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      helpers.respond_to?(method.to_sym, include_private) || super
+    end
+
+    private
+
+    def _render_statement(component, options)
+      render_statement = ["{% render \"#{component}\""]
+      unless options.empty?
+        render_statement << ", " + options.keys.map { |k| "#{k}: #{k}" }.join(", ")
+      end
+      render_statement << " %}"
+      render_statement.join
+    end
+
+    def _liquid_context
+      {
+        registers: {
+          site: site,
+          page: page,
+          cached_partials: Bridgetown::Renderer.cached_partials,
+        },
+        strict_filters: site.config["liquid"]["strict_filters"],
+        strict_variables: site.config["liquid"]["strict_variables"],
+      }
+    end
+  end
+end