bridgetown-core 0.19.3 → 0.21.0.beta4

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
@@ -15,6 +16,10 @@ module Bridgetown
         @site_drop ||= SiteDrop.new(@obj)
       end
 
+      def collections
+        @obj.collections
+      end
+
       private
 
       def fallback_data

data/lib/bridgetown-core/entry_filter.rb

@@ -4,12 +4,14 @@ module Bridgetown
   class EntryFilter
     attr_reader :site
     SPECIAL_LEADING_CHAR_REGEX = %r!\A#{Regexp.union([".", "_", "#", "~"])}!o.freeze
+    SPECIAL_LEADING_CHAR_NO_UNDERSCORES_REGEX = %r!\A#{Regexp.union([".", "#", "~"])}!o.freeze
 
-    def initialize(site, base_directory = nil)
+    def initialize(site, base_directory: nil, include_underscores: false)
       @site = site
       @base_directory = derive_base_directory(
         @site, base_directory.to_s.dup
       )
+      @include_underscores = include_underscores
     end
 
     def base_directory
@@ -32,8 +34,6 @@ module Bridgetown
         # Reject this entry if it is just a "dot" representation.
         #   e.g.: '.', '..', '_movies/.', 'music/..', etc
         next true if e.end_with?(".")
-        # Reject this entry if it is a symlink.
-        next true if symlink?(e)
         # Do not reject this entry if it is included.
         next false if included?(e)
 
@@ -43,13 +43,18 @@ 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)
-      SPECIAL_LEADING_CHAR_REGEX.match?(entry) ||
-        SPECIAL_LEADING_CHAR_REGEX.match?(File.basename(entry))
+      use_regex = if @include_underscores
+                    SPECIAL_LEADING_CHAR_NO_UNDERSCORES_REGEX
+                  else
+                    SPECIAL_LEADING_CHAR_REGEX
+                  end
+
+      use_regex.match?(entry) || use_regex.match?(File.basename(entry))
     end
 
     def backup?(entry)
@@ -57,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:",
@@ -67,33 +74,15 @@ module Bridgetown
       end
     end
 
-    # --
-    # TODO: this is for old Safe mode and can be removed.
-    # --
-    def symlink?(_entry)
-      false
-    end
-
-    # --
-    # NOTE: Pathutil#in_path? gets the realpath.
-    # @param [<Anything>] entry the entry you want to validate.
-    # Check if a path is outside of our given root.
-    # --
-    def symlink_outside_site_source?(entry)
-      !Pathutil.new(entry).in_path?(
-        site.in_source_dir
-      )
-    end
-
     # 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/errors.rb

@@ -4,8 +4,6 @@ module Bridgetown
   module Errors
     FatalException = Class.new(::RuntimeError)
 
-    InvalidThemeName = Class.new(FatalException)
-
     DropMutationException       = Class.new(FatalException)
     InvalidPermalinkError       = Class.new(FatalException)
     InvalidYAMLFrontMatterError = Class.new(FatalException)

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.
@@ -63,6 +39,7 @@ module Bridgetown
     # Returns the given filename or title as a lowercase URL String.
     # See Utils.slugify for more detail.
     def slugify(input, mode = nil)
+      mode = @context.registers[:site].config.slugify_mode if mode.nil?
       Utils.slugify(input, mode: mode)
     end
 
@@ -102,7 +79,7 @@ module Bridgetown
     #
     # Returns the escaped String.
     def cgi_escape(input)
-      CGI.escape(input)
+      CGI.escape(input.to_s)
     end
 
     # URI escape a string.
@@ -131,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,11 +1,24 @@
 # frozen_string_literal: true
 
+# 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)
   end
 end
 
+# Handles Resources
+Bridgetown::Hooks.register :resources, :post_read, reloadable: false do |resource|
+  if resource.data["prototype"].is_a?(Hash)
+    Bridgetown::PrototypeGenerator.add_matching_template(resource)
+  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
@@ -13,27 +26,29 @@ module Bridgetown
     # @return [Bridgetown::Site]
     attr_reader :site
 
-    @matching_templates = []
-
-    def self.add_matching_template(template)
-      @matching_templates << template
+    # @return [Set<Bridgetown::Page, Bridgetown::Resource::Base>]
+    def self.matching_templates
+      @matching_templates ||= Set.new
     end
 
-    class << self
-      # @return [Array<Page>]
-      attr_reader :matching_templates
+    def self.add_matching_template(template)
+      matching_templates << template
     end
 
+    # @param site [Bridgetown::Site]
     def generate(site)
       @site = site
-      @configured_collection = "posts"
+      @configured_collection = "posts" unless site.uses_resource?
+      page_list = site.uses_resource? ? site.collections.pages.resources : site.pages
 
       prototype_pages = self.class.matching_templates.select do |page|
-        site.pages.include? page
+        page_list.include?(page)
       end
 
       if prototype_pages.length.positive?
-        site.pages.reject! do |page|
+        ensure_pagination_enabled
+
+        page_list.reject! do |page|
           prototype_pages.include? page
         end
 
@@ -42,15 +57,24 @@ module Bridgetown
           next if search_term.nil?
 
           terms_matching_pages(search_term).each do |term|
-            generate_new_page_from_prototype(prototype_page, search_term, term).data
+            generate_new_page_from_prototype(prototype_page, search_term, term)
           end
         end
       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 [PrototypePage]
+    # @param prototype_page [Bridgetown::Page, Bridgetown::Resource::Base]
     #
     # @return [String, nil]
     def validate_search_term(prototype_page)
@@ -62,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
@@ -71,7 +100,7 @@ module Bridgetown
 
     def generate_new_page_from_prototype(prototype_page, search_term, term)
       new_page = PrototypePage.new(prototype_page, @configured_collection, search_term, term)
-      site.pages << new_page
+      site.add_generated_page new_page
       new_page
     end
 
@@ -81,16 +110,26 @@ module Bridgetown
     #
     # @return [Array<String>]
     def terms_matching_pages(search_term)
+      pages_list = if site.uses_resource?
+                     site.collections[@configured_collection].resources
+                   else
+                     site.collections[@configured_collection].docs
+                   end
+
       Bridgetown::Paginate::PaginationIndexer.index_documents_by(
-        site.collections[@configured_collection].docs, search_term
+        pages_list, search_term
       ).keys
     end
   end
 
-  class PrototypePage < Page
-    # @return [Page]
+  class PrototypePage < GeneratedPage
+    # @return [Bridgetown::Page, Bridgetown::Resource::Base]
     attr_reader :prototyped_page
 
+    # @param prototyped_page [Bridgetown::Page, Bridgetown::Resource::Base]
+    # @param collection [Bridgetown::Collection]
+    # @param search_term [String]
+    # @param term [String]
     def initialize(prototyped_page, collection, search_term, term)
       @prototyped_page = prototyped_page
       @site = prototyped_page.site
@@ -107,7 +146,7 @@ module Bridgetown
       validate_data! prototyped_page.path
       validate_permalink! prototyped_page.path
 
-      @dir = Pathname.new(prototyped_page.relative_path).dirname.to_s
+      @dir = Pathname.new(prototyped_page.relative_path).dirname.to_s.sub(%r{^_pages}, "")
       @path = site.in_source_dir(@dir, @name)
 
       process_prototype_page_data(collection, search_term, term)
@@ -132,7 +171,7 @@ module Bridgetown
       slugify_term(term)
     end
 
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:todo Metrics/AbcSize
     def process_title_data_placeholder(search_term, term)
       if prototyped_page.data["prototype"]["data"]
         if data["title"]&.include?(":prototype-data-label")
@@ -164,7 +203,7 @@ module Bridgetown
     end
 
     def slugify_term(term)
-      term_slug = Bridgetown::Utils.slugify(term)
+      term_slug = Bridgetown::Utils.slugify(term, mode: site.config.slugify_mode)
       @url = if permalink.is_a?(String)
                data["permalink"] = data["permalink"].sub(":term", term_slug)
              else

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