bridgetown-core 0.17.1 → 0.18.0

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

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
-module Bridgetown
-  module Site::Extensible
+class Bridgetown::Site
+  module Extensible
     # Load necessary libraries, plugins, converters, and generators.
-    # @see Bridgetown::Converter
-    # @see Bridgetown::Generator
+    # @see Converter
+    # @see Generator
     # @see PluginManager
     # @return [void]
     def setup
       plugin_manager.require_plugin_files
+      plugin_manager.setup_component_loaders
       self.converters = instantiate_subclasses(Bridgetown::Converter)
       self.generators = instantiate_subclasses(Bridgetown::Generator)
     end
 
     # Run all Generators.
-    # @see Bridgetown::Generator
+    # @see Generator
     # @return [void]
     def generate
       generators.each do |generator|
@@ -33,10 +34,10 @@ module Bridgetown
       end
     end
 
-    # Get the implementation class for the given Converter.
-    # @param klass [Object] The Class of the Converter to fetch.
-    # @return [Bridgetown::Converter] Returns the {Bridgetown::Converter}
-    #   instance implementing the given +Converter+.
+    # Get the implementation for the given Converter class.
+    # @param klass [Class] The Class of the Converter to fetch.
+    # @return [Converter] Returns the {Converter}
+    #   instance implementing the given `Converter` class.
     def find_converter_instance(klass)
       @find_converter_instance ||= {}
       @find_converter_instance[klass] ||= begin
@@ -45,11 +46,11 @@ module Bridgetown
       end
     end
 
-    # Create an array of instances of the subclasses of the class or module
+    # Create an array of instances of the subclasses of the class
     #   passed in as argument.
-    # @param klass [Class, Module] - class or module containing the subclasses.
-    # @return [Array<Object>] Returns an array of instances of subclasses of
-    #   +klass+.
+    # @param klass [Class] - class which is the parent of the subclasses.
+    # @return [Array<Converter, Generator>] Returns an array of instances of
+    #   subclasses of `klass`.
     def instantiate_subclasses(klass)
       klass.descendants.sort.map do |c|
         c.new(config)

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

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-module Bridgetown
-  module Site::Localizable
+class Bridgetown::Site
+  module Localizable
+    # Returns the current and/or default configured locale
+    # @return String
     def locale
       if @locale
         @locale
@@ -13,6 +15,8 @@ module Bridgetown
       end
     end
 
+    # Sets the current locale for the site
+    # @param new_locale [String] for example: "en" for English, "es" for Spanish
     def locale=(new_locale)
       I18n.locale = @locale = new_locale.to_sym
     end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Bridgetown
-  module Site::Processable
+class Bridgetown::Site
+  module Processable
     # Reset, Read, Generate, Render, Cleanup, Process, and Write this Site to output.
     # @return [void]
     # @see #reset
@@ -22,14 +22,15 @@ module Bridgetown
 
     # rubocop:disable Metrics/AbcSize
 
-    # Reset Site details.
+    # Reset all in-memory data and content.
     # @return [void]
     def reset
-      self.time = if config["time"]
-                    Utils.parse_date(config["time"].to_s, "Invalid time in bridgetown.config.yml.")
-                  else
-                    Time.now
-                  end
+      self.time = Time.now
+      if config["time"]
+        self.time = Bridgetown::Utils.parse_date(
+          config["time"].to_s, "Invalid time in bridgetown.config.yml."
+        )
+      end
       self.layouts = HashWithDotAccess::Hash.new
       self.pages = []
       self.static_files = []
@@ -50,7 +51,7 @@ module Bridgetown
 
     # rubocop:enable Metrics/AbcSize
 
-    # Read Site data from disk and load it into internal data structures.
+    # Read data from disk and load it into internal memory.
     # @return [void]
     def read
       Bridgetown::Hooks.trigger :site, :pre_read, self

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

@@ -1,20 +1,17 @@
 # frozen_string_literal: true
 
-module Bridgetown
-  module Site::Renderable
-    # Render the site to the destination.
+class Bridgetown::Site
+  module Renderable
+    # Render all pages & documents so they're ready to be written out to disk.
     # @return [void]
+    # @see Page
+    # @see Document
     def render
-      payload = site_payload
-
-      Bridgetown::Hooks.trigger :site, :pre_render, self, payload
-
+      Bridgetown::Hooks.trigger :site, :pre_render, self
       execute_inline_ruby_for_layouts!
-
-      render_docs(payload)
-      render_pages(payload)
-
-      Bridgetown::Hooks.trigger :site, :post_render, self, payload
+      render_docs
+      render_pages
+      Bridgetown::Hooks.trigger :site, :post_render, self
     end
 
     # Executes inline Ruby frontmatter
@@ -33,36 +30,47 @@ module Bridgetown
     end
 
     # Renders all documents
-    # @param payload [Hash] A hash of site data.
     # @return [void]
-    # @see Bridgetown::Site::Content#site_payload
-    def render_docs(payload)
+    def render_docs
       collections.each_value do |collection|
         collection.docs.each do |document|
-          render_regenerated(document, payload)
+          render_with_locale(document) do
+            render_regenerated document
+          end
         end
       end
     end
 
     # Renders all pages
-    # @param payload [Hash] A hash of site data.
     # @return [void]
-    # @see Bridgetown::Site::Content#site_payload
-    def render_pages(payload)
+    def render_pages
       pages.each do |page|
-        render_regenerated(page, payload)
+        render_regenerated page
+      end
+    end
+
+    # Renders a document while ensuring site locale is set if the data is available.
+    # @param document [Document] The document to render
+    # @yield Runs the block in between locale setting and resetting
+    # @return [void]
+    def render_with_locale(document)
+      if document.data["locale"]
+        previous_locale = locale
+        self.locale = document.data["locale"]
+        yield
+        self.locale = previous_locale
+      else
+        yield
       end
     end
 
-    # Regenerates a site using {Bridgetown::Renderer}
-    # @param document [Post] The document to regenerate.
-    # @param payload [Hash] A hash of site data.
+    # Regenerates a site using {Renderer}
+    # @param document [Document] The document to regenerate.
     # @return [void]
-    # @see Bridgetown::Renderer
-    def render_regenerated(document, payload)
+    def render_regenerated(document)
       return unless regenerator.regenerate?(document)
 
-      Bridgetown::Renderer.new(self, document, payload).run
+      Bridgetown::Renderer.new(self, document).run
     end
   end
 end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Bridgetown
-  module Site::Writable
+class Bridgetown::Site
+  module Writable
     # Remove orphaned files and empty directories in destination.
     #
     # @return [void]
@@ -9,7 +9,7 @@ module Bridgetown
       @cleaner.cleanup!
     end
 
-    # Write static files, pages, and posts.
+    # Write static files, pages, and documents to the destination folder.
     #
     # @return [void]
     def write
@@ -20,22 +20,14 @@ module Bridgetown
       Bridgetown::Hooks.trigger :site, :post_write, self
     end
 
-    # Yields the pages from {#pages}, {#static_files}, and {#docs_to_write}.
+    # Yields all content objects while looping through {#pages},
+    #   {#static_files_to_write}, and {#docs_to_write}.
     #
-    # @yieldparam item [Document, Page, StaticFile] Yields a
-    # {#Bridgetown::Page}, {#Bridgetown::StaticFile}, or
-    # {#Bridgetown::Document} object.
+    # @yieldparam item [Document, Page, StaticFile]
     #
     # @return [void]
-    #
-    # @see #pages
-    # @see #static_files
-    # @see #docs_to_write
-    # @see Page
-    # @see StaticFile
-    # @see Document
     def each_site_file
-      %w(pages static_files docs_to_write).each do |type|
+      %w(pages static_files_to_write docs_to_write).each do |type|
         send(type).each do |item|
           yield item
         end

data/lib/bridgetown-core/configuration.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  # TODO: refactor this whole object! Already had to fix obscure
-  # bugs just making minor changes, and all the indirection is
-  # quite hard to decipher. -JW
+  # Holds the processed configuration loaded from the YAML config file.
+  #
+  # @todo refactor this whole object! Already had to fix obscure
+  #   bugs just making minor changes, and all the indirection is
+  #   quite hard to decipher. -JW
   class Configuration < HashWithDotAccess::Hash
     # Default options. Overridden by values in bridgetown.config.yml.
     # Strings rather than symbols are used for compatibility with YAML.

data/lib/bridgetown-core/converter.rb

@@ -16,34 +16,6 @@ module Bridgetown
       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.
-    #
-    # highlighter_prefix - The String prefix (default: nil).
-    #
-    # Returns the String prefix.
-    def self.highlighter_prefix(highlighter_prefix = nil)
-      unless defined?(@highlighter_prefix) && highlighter_prefix.nil?
-        @highlighter_prefix = highlighter_prefix
-      end
-      @highlighter_prefix
-    end
-
-    # Public: Get or set the highlighter suffix. When an argument is specified,
-    # the suffix will be set. If no argument is specified, the current suffix
-    # will be returned.
-    #
-    # highlighter_suffix - The String suffix (default: nil).
-    #
-    # Returns the String suffix.
-    def self.highlighter_suffix(highlighter_suffix = nil)
-      unless defined?(@highlighter_suffix) && highlighter_suffix.nil?
-        @highlighter_suffix = highlighter_suffix
-      end
-      @highlighter_suffix
-    end
-
     # Initialize the converter.
     #
     # Returns an initialized Converter.
@@ -70,19 +42,5 @@ module Bridgetown
     def output_ext(_ext)
       ".html"
     end
-
-    # Get the highlighter prefix.
-    #
-    # Returns the String prefix.
-    def highlighter_prefix
-      self.class.highlighter_prefix
-    end
-
-    # Get the highlighter suffix.
-    #
-    # Returns the String suffix.
-    def highlighter_suffix
-      self.class.highlighter_suffix
-    end
   end
 end

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

@@ -1,9 +1,44 @@
 # frozen_string_literal: true
 
 require "tilt/erubi"
-require "erubi/capture_end"
 
 module Bridgetown
+  class ERBBuffer < String
+    def concat_to_s(input)
+      concat input.to_s
+    end
+
+    alias_method :safe_append=, :concat_to_s
+    alias_method :append=, :concat_to_s
+    alias_method :safe_expr_append=, :concat_to_s
+  end
+
+  class ERBEngine < Erubi::Engine
+    private
+
+    def add_code(code)
+      @src << code
+      @src << ";#{@bufvar};" if code.strip.split(".").first == "end"
+      @src << ";" unless code[Erubi::RANGE_LAST] == "\n"
+    end
+
+    # pulled from Rails' ActionView
+    BLOCK_EXPR = %r!\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z!.freeze
+
+    def add_expression(indicator, code)
+      if BLOCK_EXPR.match?(code)
+        src << "#{@bufvar}.append= " << code
+      else
+        super
+      end
+    end
+
+    # Don't allow == to output escaped strings, as that's the opposite of Rails
+    def add_expression_result_escaped(code)
+      add_expression_result(code)
+    end
+  end
+
   class ERBView < RubyTemplateView
     def h(input)
       Erubi.h(input)
@@ -11,6 +46,7 @@ module Bridgetown
 
     def partial(partial_name, options = {})
       options.merge!(options[:locals]) if options[:locals]
+      options[:content] = yield if block_given?
 
       partial_segments = partial_name.split("/")
       partial_segments.last.sub!(%r!^!, "_")
@@ -19,34 +55,42 @@ module Bridgetown
       Tilt::ErubiTemplate.new(
         site.in_source_dir(site.config[:partials_dir], "#{partial_name}.erb"),
         outvar: "@_erbout",
-        engine_class: Erubi::CaptureEndEngine
+        bufval: "Bridgetown::ERBBuffer.new",
+        engine_class: ERBEngine
       ).render(self, options)
     end
 
-    def markdownify
-      previous_buffer_state = @_erbout
-      @_erbout = +""
-      result = yield
-      @_erbout = previous_buffer_state
-
-      content = Bridgetown::Utils.reindent_for_markdown(result)
+    def markdownify(input = nil, &block)
+      content = Bridgetown::Utils.reindent_for_markdown(
+        block.nil? ? input.to_s : capture(&block)
+      )
       converter = site.find_converter_instance(Bridgetown::Converters::Markdown)
-      md_output = converter.convert(content).strip
-      @_erbout << md_output
+      converter.convert(content).strip
     end
 
-    def capture
+    def capture(obj = nil, &block)
       previous_buffer_state = @_erbout
-      @_erbout = +""
-      result = yield
+      @_erbout = ERBBuffer.new
+
+      # For compatibility with ActionView, not used by Bridgetown normally
+      previous_ob_state = @output_buffer
+      @output_buffer = ERBBuffer.new
+
+      result = instance_exec(obj, &block)
+      if @output_buffer != ""
+        # use Rails' ActionView buffer if present
+        result = @output_buffer
+      end
       @_erbout = previous_buffer_state
+      @output_buffer = previous_ob_state
 
-      result
+      result.respond_to?(:html_safe) ? result.html_safe : result
     end
   end
 
   module Converters
     class ERBTemplates < Converter
+      priority :highest
       input :erb
 
       # Logic to do the ERB content conversion.
@@ -62,7 +106,8 @@ module Bridgetown
         erb_renderer = Tilt::ErubiTemplate.new(
           convertible.relative_path,
           outvar: "@_erbout",
-          engine_class: Erubi::CaptureEndEngine
+          bufval: "Bridgetown::ERBBuffer.new",
+          engine_class: ERBEngine
         ) { content }
 
         if convertible.is_a?(Bridgetown::Layout)
@@ -73,6 +118,20 @@ module Bridgetown
           erb_renderer.render(erb_view)
         end
       end
+
+      def matches(ext, convertible)
+        if convertible.data[:template_engine] == "erb" ||
+            (convertible.data[:template_engine].nil? &&
+              @config[:template_engine] == "erb")
+          return true
+        end
+
+        super(ext)
+      end
+
+      def output_ext(ext)
+        ext == ".erb" ? ".html" : ext
+      end
     end
   end
 end