bridgetown-core 0.19.1 → 0.21.0.beta2

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

@@ -3,14 +3,26 @@
 require "tilt/erubi"
 
 module Bridgetown
-  class ERBBuffer < String
-    def concat_to_s(input)
-      concat input.to_s
+  class OutputBuffer < ActiveSupport::SafeBuffer
+    def initialize(*)
+      super
+      encode!
     end
 
-    alias_method :safe_append=, :concat_to_s
-    alias_method :append=, :concat_to_s
-    alias_method :safe_expr_append=, :concat_to_s
+    def <<(value)
+      return self if value.nil?
+
+      super(value.to_s)
+    end
+    alias_method :append=, :<<
+
+    def safe_expr_append=(val)
+      return self if val.nil? # rubocop:disable Lint/ReturnInVoidContext
+
+      safe_concat val.to_s
+    end
+
+    alias_method :safe_append=, :safe_concat
   end
 
   class ERBEngine < Erubi::Engine
@@ -22,24 +34,47 @@ module Bridgetown
       @src << ";" unless code[Erubi::RANGE_LAST] == "\n"
     end
 
+    def add_text(text)
+      return if text.empty?
+
+      src << bufvar << ".safe_append='"
+      src << text.gsub(%r{['\\]}, '\\\\\&')
+      src << "'.freeze;"
+    end
+
     # pulled from Rails' ActionView
     BLOCK_EXPR = %r!\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z!.freeze
 
     def add_expression(indicator, code)
+      src << bufvar << if (indicator == "==") || @escape
+                         ".safe_expr_append="
+                       else
+                         ".append="
+                       end
+
       if BLOCK_EXPR.match?(code)
-        src << "#{@bufvar}.append= " << code
+        src << " " << code
       else
-        super
+        src << "(" << code << ");"
       end
     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)
+  module ERBCapture
+    def capture(*args)
+      previous_buffer_state = @_erbout
+      @_erbout = OutputBuffer.new
+      result = yield(*args)
+      result = @_erbout.presence || result
+      @_erbout = previous_buffer_state
+
+      result.is_a?(String) ? ERB::Util.h(result) : result
     end
   end
 
   class ERBView < RubyTemplateView
+    include ERBCapture
+
     def h(input)
       Erubi.h(input)
     end
@@ -55,37 +90,10 @@ module Bridgetown
       Tilt::ErubiTemplate.new(
         site.in_source_dir(site.config[:partials_dir], "#{partial_name}.erb"),
         outvar: "@_erbout",
-        bufval: "Bridgetown::ERBBuffer.new",
+        bufval: "Bridgetown::OutputBuffer.new",
         engine_class: ERBEngine
       ).render(self, options)
     end
-
-    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)
-      converter.convert(content).strip
-    end
-
-    def capture(obj = nil, &block)
-      previous_buffer_state = @_erbout
-      @_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.respond_to?(:html_safe) ? result.html_safe : result
-    end
   end
 
   module Converters
@@ -107,14 +115,15 @@ module Bridgetown
 
         erb_renderer = Tilt::ErubiTemplate.new(
           convertible.relative_path,
+          line_start(convertible),
           outvar: "@_erbout",
-          bufval: "Bridgetown::ERBBuffer.new",
+          bufval: "Bridgetown::OutputBuffer.new",
           engine_class: ERBEngine
         ) { content }
 
         if convertible.is_a?(Bridgetown::Layout)
           erb_renderer.render(erb_view) do
-            convertible.current_document_output
+            convertible.current_document_output.html_safe
           end
         else
           erb_renderer.render(erb_view)

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

@@ -25,15 +25,6 @@ module Bridgetown
       def output_ext(ext)
         ext
       end
-
-      # Logic to do the content conversion.
-      #
-      # content - String content of file (without front matter).
-      #
-      # Returns a String of the converted content.
-      def convert(content)
-        content
-      end
     end
   end
 end

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

@@ -22,7 +22,9 @@ module Bridgetown
           raise Errors::FatalException, "Invalid Markdown processor given: #{@config["markdown"]}"
         end
 
-        @cache = Bridgetown::Cache.new("Bridgetown::Converters::Markdown")
+        unless @config.cache_markdown == false || @config.kramdown.input == "GFMExtractions"
+          @cache = Bridgetown::Cache.new("Bridgetown::Converters::Markdown")
+        end
         @setup = true
       end
 
@@ -59,10 +61,18 @@ module Bridgetown
       # content - String content of file (without front matter).
       #
       # Returns a String of the converted content.
-      def convert(content)
+      def convert(content, convertible = nil)
         setup
-        @cache.getset(content) do
-          @parser.convert(content)
+        if @cache
+          @cache.getset(content) do
+            @parser.convert(content)
+          end
+        else
+          output = @parser.convert(content)
+          if convertible && @parser.respond_to?(:extractions)
+            convertible.data.markdown_extractions = @parser.extractions
+          end
+          output
         end
       end
 

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

@@ -69,22 +69,14 @@ module Bridgetown
   module Converters
     class Markdown
       class KramdownParser
+        attr_reader :extractions
+
         def initialize(config)
-          @main_fallback_highlighter = config["highlighter"] || "rouge"
           @config = config["kramdown"] || {}
-          @highlighter = nil
-          setup
-          load_dependencies
-        end
-
-        # Setup and normalize the configuration:
-        #   * Create Kramdown if it doesn't exist.
-        #   * Set syntax_highlighter
-        #   * Make sure `syntax_highlighter_opts` exists.
-        def setup
-          @config["syntax_highlighter"] ||= highlighter
+          @config["syntax_highlighter"] ||= config["highlighter"] || "rouge"
           @config["syntax_highlighter_opts"] ||= {}
           @config["syntax_highlighter_opts"]["guess_lang"] = @config["guess_lang"]
+          require "kramdown-parser-gfm" if @config["input"] == "GFM"
         end
 
         def convert(content)
@@ -95,34 +87,9 @@ module Bridgetown
               Bridgetown.logger.warn "Kramdown warning:", warning
             end
           end
+          @extractions = document.root.options[:extractions] # could be nil
           html_output
         end
-
-        private
-
-        def load_dependencies
-          require "kramdown-parser-gfm" if @config["input"] == "GFM"
-
-          # `mathjax` emgine is bundled within kramdown-2.x and will be handled by
-          # kramdown itself.
-          if (math_engine = @config["math_engine"]) && math_engine != "mathjax"
-            Bridgetown::External.require_with_graceful_fail("kramdown-math-#{math_engine}")
-          end
-        end
-
-        # config[kramdown][syntax_higlighter] >
-        #   config[highlighter]
-        def highlighter
-          return @highlighter if @highlighter
-
-          if @config["syntax_highlighter"]
-            return @highlighter = @config[
-              "syntax_highlighter"
-            ]
-          end
-
-          @highlighter = @main_fallback_highlighter
-        end
       end
     end
   end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Converters
+    class RubyTemplates < Converter
+      priority :highest
+      input :rb
+
+      def convert(content, convertible)
+        erb_view = Bridgetown::ERBView.new(convertible)
+        erb_view.instance_eval(
+          content, convertible.relative_path.to_s, line_start(convertible)
+        ).to_s
+      end
+    end
+  end
+end

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

@@ -25,7 +25,9 @@ module Bridgetown
       priority :low
 
       def initialize(config)
-        Bridgetown::External.require_with_graceful_fail "kramdown" unless defined?(Kramdown)
+        unless defined?(Kramdown)
+          Bridgetown::Utils::RequireGems.require_with_graceful_fail "kramdown"
+        end
         @config = config["kramdown"].dup || {}
         @config[:input] = :SmartyPants
       end

data/lib/bridgetown-core/current.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  class Current < ActiveSupport::CurrentAttributes
+    # @!method self.site
+    #   @return [Bridgetown::Site]
+
+    attribute :site
+  end
+end

data/lib/bridgetown-core/document.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Bridgetown
+  # TODO: to be retired once the Resource engine is made official
   class Document
     extend Forwardable
     include DataAccessible
@@ -52,7 +53,7 @@ module Bridgetown
       @has_yaml_header = nil
 
       data.default_proc = proc do |_, key|
-        site.frontmatter_defaults.find(relative_path, type, key)
+        site.frontmatter_defaults.find(relative_path, type, key.to_s)
       end
 
       trigger_hooks(:post_init)
@@ -81,7 +82,7 @@ module Bridgetown
     #
     # Return document date string.
     def date
-      data["date"] ||= site.time
+      data["date"] ||= site.time # TODO: this doesn't reflect documented behavior
     end
 
     # Return document file modification time in the form of a Time object.
@@ -402,21 +403,13 @@ module Bridgetown
     end
 
     def populate_categories
-      categories = Array(data["categories"]) + Utils.pluralized_array_from_hash(
-        data, "category", "categories"
-      )
-      categories.map!(&:to_s)
-      categories.flatten!
-      categories.uniq!
-
-      merge_data!({ "categories" => categories })
+      data.categories = Utils.pluralized_array_from_hash(
+        data, :category, :categories
+      ).map(&:to_s)
     end
 
     def populate_tags
-      tags = Utils.pluralized_array_from_hash(data, "tag", "tags")
-      tags.flatten!
-
-      merge_data!({ "tags" => tags })
+      data.tags = Utils.pluralized_array_from_hash(data, :tag, :tags)
     end
 
     def determine_locale

data/lib/bridgetown-core/drops/collection_drop.rb

@@ -8,7 +8,7 @@ module Bridgetown
       mutable false
 
       def_delegator  :@obj, :write?, :output
-      def_delegators :@obj, :label, :docs, :files, :relative_path
+      def_delegators :@obj, :label, :docs, :files, :relative_path, :resources, :static_files
 
       private def_delegator :@obj, :metadata, :fallback_data
 

data/lib/bridgetown-core/drops/page_drop.rb

@@ -9,6 +9,10 @@ module Bridgetown
 
       def_delegators :@obj, :content, :dir, :name, :path, :url, :pager
       private def_delegator :@obj, :data, :fallback_data
+
+      def relative_url
+        @obj.relative_url
+      end
     end
   end
 end

data/lib/bridgetown-core/drops/relations_drop.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Drops
+    class RelationsDrop < Drop
+      mutable false
+
+      def [](type)
+        return nil unless type.to_s.in?(@obj.relation_types)
+
+        @obj.resources_for_type(type)
+      end
+
+      def key?(type)
+        type.to_s.in?(@obj.relation_types)
+      end
+
+      def fallback_data
+        {}
+      end
+    end
+  end
+end

data/lib/bridgetown-core/drops/resource_drop.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Drops
+    class ResourceDrop < Drop
+      extend Forwardable
+
+      NESTED_OBJECT_FIELD_BLACKLIST = %w(
+        content output excerpt next previous
+      ).freeze
+
+      mutable false
+
+      def_delegator :@obj, :relative_path, :path
+      def_delegators :@obj,
+                     :id,
+                     :data,
+                     :output,
+                     :content,
+                     :to_s,
+                     :absolute_url,
+                     :relative_path,
+                     :relative_url,
+                     :date,
+                     :taxonomies,
+                     :relations
+
+      private def_delegator :@obj, :data, :fallback_data
+
+      def collection
+        @collection ||= @obj.collection.to_liquid
+      end
+
+      def excerpt
+        fallback_data["excerpt"].to_s
+      end
+
+      def <=>(other)
+        return nil unless other.is_a? ResourceDrop
+
+        cmp = self["date"] <=> other["date"]
+        cmp = self["path"] <=> other["path"] if cmp.nil? || cmp.zero?
+        cmp
+      end
+
+      def previous
+        @previous ||= @obj.previous_resource.to_liquid
+      end
+
+      def next
+        @next ||= @obj.previous_resource.to_liquid
+      end
+
+      # Generate a Hash for use in generating JSON.
+      # This is useful if fields need to be cleared before the JSON can generate.
+      #
+      # state - the JSON::State object which determines the state of current processing.
+      #
+      # Returns a Hash ready for JSON generation.
+      def hash_for_json(state = nil)
+        to_h.tap do |hash|
+          # use collection label in the hash
+          hash["collection"] = hash["collection"]["label"] if hash["collection"]
+
+          if state && state.depth >= 2
+            hash["previous"] = collapse_document(hash["previous"]) if hash["previous"]
+            hash["next"]     = collapse_document(hash["next"]) if hash["next"]
+          end
+        end
+      end
+
+      # Generate a Hash which breaks the recursive chain.
+      # Certain fields which are normally available are omitted.
+      #
+      # Returns a Hash with only non-recursive fields present.
+      def collapse_document(doc)
+        doc.keys.each_with_object({}) do |(key, _), result|
+          result[key] = doc[key] unless NESTED_OBJECT_FIELD_BLACKLIST.include?(key)
+        end
+      end
+    end
+  end
+end