bridgetown-core 0.20.0 → 0.21.0

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

@@ -72,21 +72,11 @@ module Bridgetown
         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)
@@ -100,32 +90,6 @@ module Bridgetown
           @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/core_ext/psych.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module CoreExt
+    module Psych
+      module SafeLoadFile
+        def safe_load_file(filename, **kwargs)
+          File.open(filename, "r:bom|utf-8") do |f|
+            if RUBY_VERSION.start_with?("2.5")
+              safe_load f, kwargs[:permitted_classes], [], false, filename
+            else
+              safe_load f, filename: filename, **kwargs
+            end
+          end
+        end
+      end
+    end
+  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
@@ -223,7 +224,7 @@ module Bridgetown
       Bridgetown.logger.debug "Reading:", relative_path
 
       if yaml_file?
-        @data = SafeYAML.load_file(path)
+        @data = YAMLParser.load_file(path)
       else
         begin
           merge_defaults
@@ -357,7 +358,7 @@ module Bridgetown
       self.content = File.read(path, **Utils.merged_file_read_opts(site, opts))
       if content =~ YAML_FRONT_MATTER_REGEXP
         self.content = $POSTMATCH
-        data_file = SafeYAML.load(Regexp.last_match(1))
+        data_file = YAMLParser.load(Regexp.last_match(1))
         merge_data!(data_file, source: "YAML front matter") if data_file
       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

@@ -14,6 +14,7 @@ module Bridgetown
       def_delegator :@obj, :relative_path, :path
       def_delegators :@obj,
                      :id,
+                     :data,
                      :output,
                      :content,
                      :to_s,
@@ -21,7 +22,8 @@ module Bridgetown
                      :relative_path,
                      :relative_url,
                      :date,
-                     :taxonomies
+                     :taxonomies,
+                     :relations
 
       private def_delegator :@obj, :data, :fallback_data
 

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

@@ -6,6 +6,7 @@ module Bridgetown
       mutable true
 
       attr_accessor :page, :layout, :content, :paginator
+      alias_method :resource, :page
 
       def bridgetown
         BridgetownDrop.global

data/lib/bridgetown-core/entry_filter.rb

@@ -43,8 +43,8 @@ module Bridgetown
     end
 
     def included?(entry)
-      glob_include?(site.include, entry) ||
-        glob_include?(site.include, File.basename(entry))
+      glob_include?(site.config.include, entry) ||
+        glob_include?(site.config.include, File.basename(entry))
     end
 
     def special?(entry)
@@ -62,7 +62,9 @@ module Bridgetown
     end
 
     def excluded?(entry)
-      glob_include?(site.exclude - site.include, relative_to_source(entry)).tap do |excluded|
+      glob_include?(
+        site.config.exclude - site.config.include, relative_to_source(entry)
+      ).tap do |excluded|
         if excluded
           Bridgetown.logger.debug(
             "EntryFilter:",
@@ -75,12 +77,12 @@ module Bridgetown
     # Check if an entry matches a specific pattern.
     # Returns true if path matches against any glob pattern, else false.
     def glob_include?(enumerator, entry)
-      entry_with_source = PathManager.join(site.source, entry)
+      entry_with_source = File.join(site.source, entry)
 
       enumerator.any? do |pattern|
         case pattern
         when String
-          pattern_with_source = PathManager.join(site.source, pattern)
+          pattern_with_source = File.join(site.source, pattern)
 
           File.fnmatch?(pattern_with_source, entry_with_source) ||
             entry_with_source.start_with?(pattern_with_source)

data/lib/bridgetown-core/filters.rb

@@ -31,30 +31,6 @@ 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.
-    #
-    # Returns the CSS formatted String.
-    def sassify(input)
-      @context.registers[:site].find_converter_instance(
-        Bridgetown::Converters::Sass
-      ).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.
-    #
-    # Returns the CSS formatted String.
-    def scssify(input)
-      @context.registers[:site].find_converter_instance(
-        Bridgetown::Converters::Scss
-      ).convert(input)
-    end
-
     # Slugify a filename or title.
     #
     # input - The filename or title to slugify.
@@ -132,7 +108,7 @@ module Bridgetown
       script += "function(c){{var j=c.charCodeAt(0);if((j>=33)&&(j<=126)){"
       script += "return String.fromCharCode(33+((j+ 14)%94));}"
       script += "else{return String.fromCharCode(j);}}}));</script>"
-      script
+      script.html_safe
     end
 
     # Replace any whitespace in the input string with a single space

data/lib/bridgetown-core/filters/from_liquid.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Filters
+    module FromLiquid
+      extend Liquid::StandardFilters
+
+      def strip_html(input)
+        FromLiquid.strip_html(input)
+      end
+
+      def strip_newlines(input)
+        FromLiquid.strip_newlines(input)
+      end
+
+      def newline_to_br(input)
+        FromLiquid.newline_to_br(input)
+      end
+
+      # FYI, truncate and truncate words are already provided by ActiveSupport! =)
+    end
+  end
+end

data/lib/bridgetown-core/filters/url_filters.rb

@@ -3,6 +3,8 @@
 module Bridgetown
   module Filters
     module URLFilters
+      extend self
+
       # Produces an absolute URL based on site.url and site.baseurl.
       #
       # input - the URL to make absolute.
@@ -35,6 +37,16 @@ module Bridgetown
         input.sub(%r!/index\.html?$!, "/")
       end
 
+      # Strips the extension (if present) off a path/URL
+      #
+      # @param input [Object] value which responds to `to_s`
+      # @return [String]
+      def strip_extname(input)
+        Pathname.new(input.to_s).yield_self do |path|
+          path.dirname + path.basename(".*")
+        end.to_s
+      end
+
       private
 
       def compute_absolute_url(input)

data/lib/bridgetown-core/frontmatter_defaults.rb

@@ -13,7 +13,7 @@ module Bridgetown
     end
 
     def reset
-      @glob_cache = {} if @glob_cache
+      @glob_cache = {}
     end
 
     def update_deprecated_types(set)

data/lib/bridgetown-core/generators/prototype_generator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Handles Legacy Pages
+# Handles Generated Pages
 Bridgetown::Hooks.register :pages, :post_init, reloadable: false do |page|
   if page.class != Bridgetown::PrototypePage && page.data["prototype"].is_a?(Hash)
     Bridgetown::PrototypeGenerator.add_matching_template(page)
@@ -14,6 +14,11 @@ Bridgetown::Hooks.register :resources, :post_read, reloadable: false do |resourc
   end
 end
 
+# Ensure sites clear out templates before rebuild
+Bridgetown::Hooks.register :site, :after_reset, reloadable: false do |_site|
+  Bridgetown::PrototypeGenerator.matching_templates.clear
+end
+
 module Bridgetown
   class PrototypeGenerator < Generator
     priority :low
@@ -21,9 +26,9 @@ module Bridgetown
     # @return [Bridgetown::Site]
     attr_reader :site
 
-    # @return [Array<Bridgetown::Page, Bridgetown::Resource::Base>]
+    # @return [Set<Bridgetown::Page, Bridgetown::Resource::Base>]
     def self.matching_templates
-      @matching_templates ||= []
+      @matching_templates ||= Set.new
     end
 
     def self.add_matching_template(template)
@@ -41,6 +46,8 @@ module Bridgetown
       end
 
       if prototype_pages.length.positive?
+        ensure_pagination_enabled
+
         page_list.reject! do |page|
           prototype_pages.include? page
         end
@@ -56,6 +63,15 @@ module Bridgetown
       end
     end
 
+    def ensure_pagination_enabled
+      unless @site.config.dig(:pagination, :enabled)
+        Bridgetown.logger.warn(
+          "Pagination:",
+          "Must be enabled for prototype pages to contain matches"
+        )
+      end
+    end
+
     # Check incoming prototype configuration and normalize options.
     #
     # @param prototype_page [Bridgetown::Page, Bridgetown::Resource::Base]
@@ -70,7 +86,12 @@ module Bridgetown
         @configured_collection = prototype_page.data["prototype"]["collection"]
       end
 
-      return nil unless site.collections[@configured_collection]
+      unless site.collections[@configured_collection]
+        Bridgetown.logger.warn(
+          "No collection specified for prototype page #{prototype_page.relative_path}"
+        )
+        return nil
+      end
 
       # Categories and Tags are unique in that singular and plural front matter
       # can be present for each

data/lib/bridgetown-core/helpers.rb

@@ -4,8 +4,13 @@ module Bridgetown
   class RubyTemplateView
     class Helpers
       include Bridgetown::Filters
+      include Bridgetown::Filters::FromLiquid
 
-      attr_reader :view, :site
+      # @return [Bridgetown::RubyTemplateView]
+      attr_reader :view
+
+      # @return [Bridgetown::Site]
+      attr_reader :site
 
       Context = Struct.new(:registers)
 
@@ -28,20 +33,44 @@ module Bridgetown
         pairs.select { |_key, truthy| truthy }.keys.join(" ")
       end
 
+      # Convert a Markdown string into HTML output.
+      #
+      # @param input [String] the Markdown to convert, if no block is passed
+      # @return [String]
+      def markdownify(input = nil, &block)
+        content = Bridgetown::Utils.reindent_for_markdown(
+          block.nil? ? input.to_s : view.capture(&block)
+        )
+        converter = site.find_converter_instance(Bridgetown::Converters::Markdown)
+        safe(converter.convert(content).strip)
+      end
+
       # This helper will generate the correct permalink URL for the file path.
       #
       # @param relative_path [String, Object] source file path, e.g.
-      #   "_posts/2020-10-20-my-post.md", or object that responds to `url`
+      #   "_posts/2020-10-20-my-post.md", or object that responds to either
+      #   `url` or `relative_url`
       # @return [String] the permalink URL for the file
-      # @raise [ArgumentError] if the file cannot be found
       def url_for(relative_path)
-        path_string = !relative_path.is_a?(String) ? relative_path.url : relative_path
+        if relative_path.respond_to?(:relative_url)
+          return safe(relative_path.relative_url) # new resource engine
+        elsif relative_path.respond_to?(:url)
+          return safe(relative_url(relative_path.url)) # old legacy engine
+        elsif relative_path.start_with?("/", "http")
+          return safe(relative_path)
+        end
 
-        return path_string if path_string.start_with?("/", "http")
+        find_relative_url_for_path(relative_path)
+      end
+      alias_method :link, :url_for
 
+      # @param relative_path [String] source file path, e.g.
+      #   "_posts/2020-10-20-my-post.md"
+      # @raise [ArgumentError] if the file cannot be found
+      def find_relative_url_for_path(relative_path)
         site.each_site_file do |item|
-          if item.relative_path == path_string || item.relative_path == "/#{path_string}"
-            return relative_url(item)
+          if item.relative_path == relative_path || item.relative_path == "/#{relative_path}"
+            return safe(item.respond_to?(:relative_url) ? item.relative_url : relative_url(item))
           end
         end
 
@@ -51,7 +80,6 @@ module Bridgetown
           Make sure the document exists and the path is correct.
         MSG
       end
-      alias_method :link, :url_for
 
       # This helper will generate the correct permalink URL for the file path.
       #
@@ -69,7 +97,8 @@ module Bridgetown
           attr = attr.to_s.tr("_", "-")
           segments << "#{attr}=\"#{Utils.xml_escape(option)}\""
         end
-        "<#{segments.join(" ")}>#{text}</a>"
+        # TODO: this might leak an XSS string into text, need to check
+        safe("<#{segments.join(" ")}>#{text}</a>")
       end
 
       # Forward all arguments to I18n.t method
@@ -79,6 +108,16 @@ module Bridgetown
       def t(*args)
         I18n.send :t, *args
       end
+
+      # For template contexts where ActiveSupport's output safety is loaded, we
+      # can ensure a string has been marked safe
+      #
+      # @param input [Object]
+      # @return [String]
+      def safe(input)
+        input.to_s.html_safe
+      end
+      alias_method :raw, :safe
     end
   end
 end