bridgetown-core 0.19.3 → 0.20.0

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 @parser.respond_to?(:extractions)
+            convertible.data.markdown_extractions = @parser.extractions
+          end
+          output
         end
       end
 

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

@@ -69,6 +69,8 @@ module Bridgetown
   module Converters
     class Markdown
       class KramdownParser
+        attr_reader :extractions
+
         def initialize(config)
           @main_fallback_highlighter = config["highlighter"] || "rouge"
           @config = config["kramdown"] || {}
@@ -95,6 +97,7 @@ module Bridgetown
               Bridgetown.logger.warn "Kramdown warning:", warning
             end
           end
+          @extractions = document.root.options[:extractions] # could be nil
           html_output
         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

@@ -52,7 +52,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 +81,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 +402,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/resource_drop.rb

@@ -0,0 +1,81 @@
+# 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,
+                     :output,
+                     :content,
+                     :to_s,
+                     :absolute_url,
+                     :relative_path,
+                     :relative_url,
+                     :date,
+                     :taxonomies
+
+      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

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

@@ -7,35 +7,53 @@ module Bridgetown
 
       mutable false
 
-      def_delegator  :@obj, :data
-      def_delegators :@obj, :locale, :time, :pages, :static_files, :tags, :categories
+      def_delegators :@obj,
+                     :data,
+                     :locale,
+                     :time,
+                     :pages,
+                     :generated_pages,
+                     :static_files,
+                     :tags,
+                     :categories,
+                     :taxonomies,
+                     :taxonomy_types
 
       private def_delegator :@obj, :config, :fallback_data
 
       attr_writer :current_document
 
       def [](key)
-        if key != "posts" && @obj.collections.key?(key)
-          @obj.collections[key].docs
-        else
-          super(key)
+        if !@obj.uses_resource? && !%w(posts data).freeze.include?(key) &&
+            @obj.collections.key?(key)
+          return @obj.collections[key].docs
         end
+
+        super(key)
       end
 
       def key?(key)
-        (key != "posts" && @obj.collections.key?(key)) || super
+        (!@obj.uses_resource? && key != "posts" && @obj.collections.key?(key)) || super
+      end
+
+      def uses_resource
+        @obj.uses_resource?
       end
 
       def posts
-        @site_posts ||= @obj.posts.docs.sort { |a, b| b <=> a }
+        unless @obj.uses_resource?
+          @site_posts ||= @obj.collections.posts.docs.sort { |a, b| b <=> a }
+        end
       end
 
+      # TODO: deprecate before v1.0
       def html_pages
         @site_html_pages ||= @obj.pages.select do |page|
           page.html? || page.url.end_with?("/")
         end
       end
 
+      # TODO: deprecate before v1.0
       def collections
         @site_collections ||= @obj.collections.values.sort_by(&:label).map(&:to_liquid)
       end
@@ -50,6 +68,10 @@ module Bridgetown
         @documents ||= @obj.documents
       end
 
+      def resources
+        @resources ||= @obj.resources
+      end
+
       def contents
         @contents ||= @obj.contents
       end
@@ -58,6 +80,9 @@ module Bridgetown
         @site_metadata ||= @obj.data["site_metadata"]
       end
 
+      # TODO: change this so you *do* use site.config...aka site.config.timezone,
+      # not site.timezone
+      #
       # return nil for `{{ site.config }}` even if --config was passed via CLI
       def config; end
     end

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

@@ -15,6 +15,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)
 
@@ -48,8 +48,13 @@ module Bridgetown
     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)
@@ -67,24 +72,6 @@ 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)

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

@@ -63,6 +63,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 +103,7 @@ module Bridgetown
     #
     # Returns the escaped String.
     def cgi_escape(input)
-      CGI.escape(input)
+      CGI.escape(input.to_s)
     end
 
     # URI escape a string.

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

@@ -1,11 +1,19 @@
 # frozen_string_literal: true
 
+# Handles Legacy 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
+
 module Bridgetown
   class PrototypeGenerator < Generator
     priority :low
@@ -13,27 +21,27 @@ module Bridgetown
     # @return [Bridgetown::Site]
     attr_reader :site
 
-    @matching_templates = []
-
-    def self.add_matching_template(template)
-      @matching_templates << template
+    # @return [Array<Bridgetown::Page, Bridgetown::Resource::Base>]
+    def self.matching_templates
+      @matching_templates ||= []
     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|
+        page_list.reject! do |page|
           prototype_pages.include? page
         end
 
@@ -42,7 +50,7 @@ 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
@@ -50,7 +58,7 @@ module Bridgetown
 
     # 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)
@@ -71,7 +79,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 +89,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 +125,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 +150,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 +182,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