bridgetown-core 0.19.2 → 0.21.0.beta3

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

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

data/lib/bridgetown-core/layout.rb

@@ -3,8 +3,8 @@
 module Bridgetown
   class Layout
     include DataAccessible
+    include FrontMatterImporter
     include LiquidRenderable
-    include Validatable
 
     # Gets the Site object.
     attr_reader :site
@@ -21,12 +21,18 @@ module Bridgetown
     # Gets/Sets the extension of this layout.
     attr_accessor :ext
 
+    alias_method :extname, :ext
+
     # Gets/Sets the Hash that holds the metadata for this layout.
     attr_accessor :data
 
     # Gets/Sets the content of this layout.
+    # @return [String]
     attr_accessor :content
 
+    # @return [Integer]
+    attr_accessor :front_matter_line_count
+
     # Gets/Sets the current document (for layout-compatible converters)
     attr_accessor :current_document
 
@@ -52,11 +58,29 @@ module Bridgetown
         @path = site.in_source_dir(base, name)
       end
       @relative_path = @path.sub(@base_dir, "")
+      @ext = File.extname(name)
+
+      @data = read_front_matter(@path)&.with_dot_access
+    rescue SyntaxError => e
+      Bridgetown.logger.error "Error:",
+                              "Ruby Exception in #{e.message}"
+    rescue StandardError => e
+      handle_read_error(e)
+    ensure
+      @data ||= HashWithDotAccess::Hash.new
+    end
 
-      self.data = {}
+    def handle_read_error(error)
+      if error.is_a? Psych::SyntaxError
+        Bridgetown.logger.warn "YAML Exception reading #{@path}: #{error.message}"
+      else
+        Bridgetown.logger.warn "Error reading file #{@path}: #{error.message}"
+      end
 
-      process(name)
-      read_yaml(base, name)
+      if site.config["strict_front_matter"] ||
+          error.is_a?(Bridgetown::Errors::FatalException)
+        raise error
+      end
     end
 
     # The inspect string for this document.
@@ -67,15 +91,6 @@ module Bridgetown
       "#<#{self.class} #{@path}>"
     end
 
-    # Extract information from the layout filename.
-    #
-    # name - The String filename of the layout file.
-    #
-    # Returns nothing.
-    def process(name)
-      self.ext = File.extname(name)
-    end
-
     # Provide this Layout's data to a Hash suitable for use by Liquid.
     #
     # Returns the Hash representation of this Layout.

data/lib/bridgetown-core/liquid_renderer/file.rb

@@ -2,6 +2,7 @@
 
 module Bridgetown
   class LiquidRenderer
+    # TODO: deprecate or move to a separate repo/plugin
     class File
       def initialize(renderer, filename)
         @renderer = renderer

data/lib/bridgetown-core/liquid_renderer/table.rb

@@ -2,6 +2,7 @@
 
 module Bridgetown
   class LiquidRenderer
+    # TODO: deprecate or move to a separate repo/plugin
     class Table
       GAUGES = [:count, :bytes, :time].freeze
 

data/lib/bridgetown-core/model/base.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "active_model"
+
+module Bridgetown
+  module Model
+    class Base
+      include ActiveModel::Model
+      extend ActiveModel::Callbacks # also extends with DescendantsTracker
+      define_model_callbacks :load, :save, :destroy
+
+      def self.loads_id?(id)
+        name == ActiveSupport::Inflector.classify(
+          URI.parse(id).host.chomp(".collection")
+        )
+      end
+
+      def self.find(id)
+        unless Bridgetown::Current.site
+          raise "A Bridgetown site must be initialized and added to Current"
+        end
+
+        model_klass = klass_for_id(id)
+        model_klass.new(read_data_for_id(id))
+      end
+
+      def self.klass_for_id(id)
+        descendants.find do |klass|
+          klass.loads_id?(id)
+        end || self
+      end
+
+      def self.read_data_for_id(id)
+        origin_for_id(id).read
+      end
+
+      def self.origin_for_id(id)
+        scheme = URI.parse(id).scheme
+        origin_klass = Origin.descendants.find do |klass|
+          klass.handle_scheme?(scheme)
+        end
+
+        raise "No origin could be found for #{id}" unless origin_klass
+
+        origin_klass.new(id)
+      end
+
+      class << self
+        def build(collection_name, path, data)
+          data = Bridgetown::Model::BuilderOrigin.new("builder://#{path}").read do
+            data[:_collection_] = Bridgetown::Current.site.collections[collection_name]
+            data
+          end
+          new(data)
+        end
+      end
+
+      def initialize(attributes = {})
+        run_callbacks :load do
+          super
+        end
+      end
+
+      def id
+        attributes[:id] || attributes[:_id_]
+      end
+
+      # @return [Bridgetown::Model::Origin]
+      def origin
+        attributes[:_origin_]
+      end
+
+      def persisted?
+        id && origin.exists?
+      end
+
+      # @return [Bridgetown::Resource::Base]
+      def to_resource
+        Bridgetown::Resource::Base.new(model: self)
+      end
+
+      def as_resource_in_collection
+        collection.resources << to_resource.read!
+        collection.resources.last
+      end
+
+      # override if need be
+      # @return [Bridgetown::Site]
+      def site
+        Bridgetown::Current.site
+      end
+
+      # @return [Bridgetown::Collection]
+      def collection
+        attributes[:_collection_]
+      end
+
+      # @return [String]
+      def content
+        attributes[:_content_]
+      end
+
+      def attributes
+        @attributes ||= HashWithDotAccess::Hash.new
+      end
+
+      # Strip out keys like _origin_, _collection_, etc.
+      # @return [HashWithDotAccess::Hash]
+      def data_attributes
+        attributes.reject { |k| k.starts_with?("_") && k.ends_with?("_") }
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        attributes.key?(method_name) || method_name.to_s.end_with?("=") || super
+      end
+
+      def method_missing(method_name, *args) # rubocop:disable Style/MethodMissingSuper
+        return attributes[method_name] if attributes.key?(method_name)
+
+        key = method_name.to_s
+        if key.end_with?("=")
+          key.chop!
+          # attribute_will_change!(key)
+          attributes[key] = args.first
+          return attributes[key]
+        end
+
+        Bridgetown.logger.warn "key `#{method_name}' not found in attributes for" \
+                               " #{attributes[:id].presence || ("new " + self.class.to_s)}"
+        nil
+      end
+
+      def inspect
+        "#<#{self.class} #{data_attributes.inspect.delete_prefix("{").delete_suffix("}")}>"
+      end
+    end
+  end
+end