bridgetown-core 0.20.0 → 0.21.0.beta1

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

@@ -69,7 +69,7 @@ module Bridgetown
           end
         else
           output = @parser.convert(content)
-          if @parser.respond_to?(:extractions)
+          if convertible && @parser.respond_to?(:extractions)
             convertible.data.markdown_extractions = @parser.extractions
           end
           output

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/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/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/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
@@ -27,8 +27,12 @@ module Bridgetown
     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
 
@@ -54,9 +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
+
+    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/model/origin.rb

@@ -35,4 +35,4 @@ module Bridgetown
 end
 
 require "bridgetown-core/model/builder_origin"
-require "bridgetown-core/model/file_origin"
+require "bridgetown-core/model/repo_origin"

data/lib/bridgetown-core/model/{file_origin.rb → repo_origin.rb}

@@ -2,29 +2,48 @@
 
 module Bridgetown
   module Model
-    class FileOrigin < Origin
+    class RepoOrigin < Origin
+      include Bridgetown::FrontMatterImporter
+      include Bridgetown::Utils::RubyFrontMatterDSL
+
       YAML_FRONT_MATTER_REGEXP = %r!\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m.freeze
+      RUBY_FRONT_MATTER_HEADER = %r!\A[~`#\-]{3,}(?:ruby|<%|{%)\s*\n!.freeze
+      RUBY_FRONT_MATTER_REGEXP =
+        %r!#{RUBY_FRONT_MATTER_HEADER.source}(.*?\n?)^((?:%>|%})?[~`#\-]{3,}\s*$\n?)!m.freeze
+
+      # @return [String]
+      attr_accessor :content
+
+      # @return [Integer]
+      attr_accessor :front_matter_line_count
 
       class << self
         def handle_scheme?(scheme)
-          scheme == "file"
+          scheme == "repo"
         end
 
         def data_file_extensions
-          %w(.yaml .yml .json .csv .tsv).freeze
+          %w(.yaml .yml .json .csv .tsv .rb).freeze
         end
       end
 
       def read
-        @data = (in_data_collection? ? read_file_data : read_frontmatter) || {}
+        begin
+          @data = (in_data_collection? ? read_file_data : read_front_matter(original_path)) || {}
+        rescue SyntaxError => e
+          Bridgetown.logger.error "Error:",
+                                  "Ruby Exception in #{e.message}"
+        rescue StandardError => e
+          handle_read_error(e)
+        end
+
+        @data ||= {}
         @data[:_id_] = id
         @data[:_origin_] = self
         @data[:_collection_] = collection
-        @data[:_content_] = @content if @content
+        @data[:_content_] = content if content
 
         @data
-      rescue StandardError => e
-        handle_read_error(e)
       end
 
       def url
@@ -63,40 +82,28 @@ module Bridgetown
           collection.data?
       end
 
-      def read_file_data
+      def read_file_data # rubocop:todo Metrics/MethodLength
         case original_path.extname.downcase
         when ".csv"
           {
-            array:
+            rows:
               CSV.read(original_path,
                        headers: true,
                        encoding: Bridgetown::Current.site.config["encoding"]).map(&:to_hash),
           }
         when ".tsv"
           {
-            array:
+            rows:
               CSV.read(original_path,
                        col_sep: "\t",
                        headers: true,
                        encoding: Bridgetown::Current.site.config["encoding"]).map(&:to_hash),
           }
+        when ".rb"
+          process_ruby_data(File.read(original_path), original_path, 1)
         else
           yaml_data = SafeYAML.load_file(original_path)
-          yaml_data.is_a?(Array) ? { array: yaml_data } : yaml_data
-        end
-      end
-
-      def read_frontmatter
-        @content = File.read(
-          original_path, **Bridgetown::Utils.merged_file_read_opts(Bridgetown::Current.site, {})
-        )
-        content_match = @content.match(YAML_FRONT_MATTER_REGEXP)
-        if content_match
-          @content = content_match.post_match
-          SafeYAML.load(content_match[1])
-        else
-          yaml_data = SafeYAML.load_file(original_path)
-          yaml_data.is_a?(Array) ? { array: yaml_data } : yaml_data
+          yaml_data.is_a?(Array) ? { rows: yaml_data } : yaml_data
         end
       end
 

data/lib/bridgetown-core/reader.rb

@@ -63,7 +63,7 @@ module Bridgetown
         file_path = @site.in_source_dir(base, entry)
         if File.directory?(file_path)
           dot_dirs << entry
-        elsif Utils.has_yaml_header?(file_path)
+        elsif Utils.has_yaml_header?(file_path) || Utils.has_rbfm_header?(file_path)
           dot_pages << entry
         else
           dot_static_files << entry
@@ -113,7 +113,7 @@ module Bridgetown
     def retrieve_pages(dir, dot_pages)
       if site.uses_resource?
         dot_pages.each do |page_path|
-          site.collections.pages.send(:read_resource, site.in_source_dir(dir, page_path))
+          site.collections.pages.read_resource(site.in_source_dir(dir, page_path))
         end
         return
       end

data/lib/bridgetown-core/renderer.rb

@@ -52,7 +52,7 @@ module Bridgetown
       output = document.content
       Bridgetown.logger.debug "Rendering Markup:", document.relative_path
       output = convert(output.to_s, document)
-      document.content = output
+      document.content = output.html_safe
 
       if document.place_in_layout?
         Bridgetown.logger.debug "Rendering Layout:", document.relative_path

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

@@ -23,13 +23,6 @@ module Bridgetown
       # @return [String]
       attr_accessor :content, :untransformed_content, :output
 
-      # @!attribute [r] collection
-      #   @return [Bridgetown::Collection] collection of this resource
-
-      # @!attribute [r] relative_path
-      #   @return [Pathname] the relative path of source file or
-      #     file-like origin
-
       DATE_FILENAME_MATCHER = %r!^(?>.+/)*?(\d{2,4}-\d{1,2}-\d{1,2})-([^/]*)(\.[^.]+)$!.freeze
 
       # @param site [Bridgetown::Site]
@@ -42,11 +35,15 @@ module Bridgetown
         trigger_hooks(:post_init)
       end
 
+      # Collection associated with this resource
+      #
       # @return [Bridgetown::Collection]
       def collection
         model.collection
       end
 
+      # The relative path of source file or file-like origin
+      #
       # @return [Pathname]
       def relative_path
         model.origin.relative_path
@@ -57,6 +54,11 @@ module Bridgetown
         @transformer ||= Bridgetown::Resource::Transformer.new(self)
       end
 
+      # @return [Bridgetown::Resource::Relations]
+      def relations
+        @relations ||= Bridgetown::Resource::Relations.new(self)
+      end
+
       # @param new_data [HashWithDotAccess::Hash]
       def data=(new_data)
         unless new_data.is_a?(HashWithDotAccess::Hash)
@@ -80,9 +82,11 @@ module Bridgetown
 
         unless collection.data?
           self.untransformed_content = content
-          determine_slug_and_date
           normalize_categories_and_tags
           import_taxonomies_from_data
+          ensure_default_data
+          transformer.execute_inline_ruby!
+          set_date_from_string(data.date)
         end
 
         @destination = Destination.new(self) if requires_destination?
@@ -94,7 +98,7 @@ module Bridgetown
       alias_method :read, :read! # TODO: eventually use the bang version only
 
       def transform!
-        transformer.process! unless collection.data?
+        transformer.process! if output_allowed?
       end
 
       def trigger_hooks(hook_name, *args)
@@ -108,6 +112,7 @@ module Bridgetown
         trigger_hooks :"post_#{hook_suffix}"
       end
 
+      # @return [String]
       def relative_path_basename_without_prefix
         return_path = Pathname.new("")
         relative_path.each_filename do |filename|
@@ -121,6 +126,7 @@ module Bridgetown
         (return_path.dirname + return_path.basename(".*")).to_s
       end
 
+      # @return [String]
       def basename_without_ext
         relative_path.basename(".*").to_s
       end
@@ -135,21 +141,28 @@ module Bridgetown
         data&.permalink
       end
 
+      # @return [String]
       def path
         (model.origin.respond_to?(:original_path) ? model.origin.original_path : relative_path).to_s
       end
 
+      # @return [String]
       def absolute_url
         format_url destination&.absolute_url
       end
 
+      # @return [String]
       def relative_url
         format_url destination&.relative_url
       end
-      alias_method :id, :relative_url
+
+      # @return [String]
+      def id
+        model.origin.id
+      end
 
       def date
-        data["date"] ||= site.time # TODO: this doesn't reflect documented behavior
+        data["date"] ||= site.time
       end
 
       # @return [Hash<String, Hash<String => Bridgetown::Resource::TaxonomyType,
@@ -165,8 +178,12 @@ module Bridgetown
         end
       end
 
+      def output_allowed?
+        !collection.data? && data.config&.output != false
+      end
+
       def requires_destination?
-        collection.write? && data.config&.output != false
+        collection.write? && output_allowed?
       end
 
       def write?
@@ -189,13 +206,36 @@ module Bridgetown
 
       # Create a Liquid-understandable version of this resource.
       #
-      # @return [Drops::DocumentDrop] represents this resource's data.
+      # @return [Drops::ResourceDrop] represents this resource's data.
       def to_liquid
         @to_liquid ||= Drops::ResourceDrop.new(self)
       end
 
+      def to_h
+        {
+          id: id,
+          absolute_url: absolute_url,
+          relative_path: relative_path,
+          relative_url: relative_url,
+          date: date,
+          data: data,
+          taxonomies: taxonomies,
+          untransformed_content: untransformed_content,
+          content: content,
+          output: output,
+        }
+      end
+
+      def as_json(*)
+        to_h
+      end
+
+      ruby2_keywords def to_json(*options)
+        as_json(*options).to_json(*options)
+      end
+
       def inspect
-        "#<#{self.class} [#{collection.label}] #{relative_path}>"
+        "#<#{self.class} #{id}>"
       end
 
       # Compare this document against another document.
@@ -229,23 +269,25 @@ module Bridgetown
 
       private
 
-      def determine_slug_and_date
-        return unless relative_path.to_s =~ DATE_FILENAME_MATCHER
-
-        new_date, slug = Regexp.last_match.captures
-        modify_date(new_date)
+      def ensure_default_data
+        slug = if matches = relative_path.to_s.match(DATE_FILENAME_MATCHER) # rubocop:disable Lint/AssignmentInCondition
+                 set_date_from_string(matches[1]) unless data.date
+                 matches[2]
+               else
+                 basename_without_ext
+               end
 
-        slug.gsub!(%r!\.*\z!, "")
         data.slug ||= slug
+        data.title ||= Bridgetown::Utils.titleize_slug(slug)
       end
 
-      def modify_date(new_date)
-        if !data.date || data.date.to_i == site.time.to_i
-          data.date = Utils.parse_date(
-            new_date,
-            "Document '#{relative_path}' does not have a valid date in the #{model}."
-          )
-        end
+      def set_date_from_string(new_date) # rubocop:disable Naming/AccessorMethodName
+        return unless new_date.is_a?(String)
+
+        data.date = Bridgetown::Utils.parse_date(
+          new_date,
+          "Document '#{relative_path}' does not have a valid date in the #{model}."
+        )
       end
 
       def normalize_categories_and_tags