bridgetown-core 0.20.0 → 0.21.0

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,20 +27,34 @@ 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
 
     # Gets/Sets the document output (for layout-compatible converters)
     attr_accessor :current_document_output
 
+    # Determines the label a layout should use based on its filename
+    #
+    # @param file [String]
+    # @return [String]
+    def self.label_for_file(file)
+      # TODO: refactor this so multi-extension layout filenames don't leak
+      # middle extensions into layout label
+      file.split(".")[0..-2].join(".")
+    end
+
     # Initialize a new Layout.
     #
-    # site - The Site.
-    # base - The String path to the source.
-    # name - The String filename of the layout file.
-    # from_plugin - true if the layout comes from a Gem-based plugin folder.
+    # @param site [Bridgetown::Site]
+    # @param base [String] The path to the source.
+    # @param name [String] The filename of the layout file.
+    # @param from_plugin [Boolean] if the layout comes from a Gem-based plugin folder.
     def initialize(site, base, name, from_plugin: false)
       @site = site
       @base = base
@@ -54,31 +68,49 @@ 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.
-    # Includes the relative path and the collection label.
+    # The label of the layout (should match what would used in front matter
+    # references).
     #
-    # Returns the inspect string for this document.
-    def inspect
-      "#<#{self.class} #{@path}>"
+    # @return [String]
+    def label
+      @label ||= self.class.label_for_file(name)
     end
 
-    # Extract information from the layout filename.
-    #
-    # name - The String filename of the layout file.
+    # The inspect string for this layout. Includes the relative path.
     #
-    # Returns nothing.
-    def process(name)
-      self.ext = File.extname(name)
+    # @return [String]
+    def inspect
+      "#<#{self.class} #{relative_path}>"
     end
 
-    # Provide this Layout's data to a Hash suitable for use by Liquid.
+    # Provide this Layout's data for use by Liquid.
     #
-    # Returns the Hash representation of this Layout.
+    # @return [HashWithDotAccess::Hash]
     def to_liquid
       data
     end

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 = YAMLParser.load_file(original_path)
+          yaml_data.is_a?(Array) ? { rows: yaml_data } : yaml_data
         end
       end
 

data/lib/bridgetown-core/page.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Bridgetown
+  # TODO: to be retired once the Resource engine is made official
   class Page
     include DataAccessible
     include LayoutPlaceable
@@ -44,7 +45,7 @@ module Bridgetown
               end
 
       process(name)
-      read_yaml(PathManager.join(base, dir), name)
+      read_yaml(File.join(base, dir), name)
 
       data.default_proc = proc do |_, key|
         site.frontmatter_defaults.find(relative_path, type, key.to_s)

data/lib/bridgetown-core/plugin_manager.rb

@@ -133,7 +133,7 @@ module Bridgetown
         sorted_plugin_files.each do |plugin_file|
           self.class.add_registered_plugin plugin_file
         end
-        Bridgetown::External.require_with_graceful_fail(sorted_plugin_files)
+        Bridgetown::Utils::RequireGems.require_with_graceful_fail(sorted_plugin_files)
       end
     end
 

data/lib/bridgetown-core/publisher.rb

@@ -15,7 +15,7 @@ module Bridgetown
       return false unless thing.respond_to?(:date)
 
       future_allowed =
-        thing.respond_to?(:collection) && thing.collection.metadata.future || @site.future
+        thing.respond_to?(:collection) && thing.collection.metadata.future || @site.config.future
       thing_time = thing.date.is_a?(Date) ? thing.date.to_time.to_i : thing.date.to_i
       !future_allowed && thing_time > @site.time.to_i
     end
@@ -23,7 +23,7 @@ module Bridgetown
     private
 
     def can_be_published?(thing)
-      thing.data.fetch("published", true) || @site.unpublished
+      thing.data.fetch("published", true) || @site.config.unpublished
     end
   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
@@ -98,7 +98,7 @@ module Bridgetown
     def retrieve_dirs(_base, dir, dot_dirs)
       dot_dirs.each do |file|
         dir_path = site.in_source_dir(dir, file)
-        rel_path = PathManager.join(dir, file)
+        rel_path = File.join(dir, file)
         @site.reader.read_directories(rel_path) unless @site.dest.chomp("/") == dir_path
       end
     end
@@ -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
@@ -124,12 +124,14 @@ module Bridgetown
     # Retrieve all the static files from the current directory,
     # add them to the site and sort them.
     #
-    # dir - The directory retrieve the static files from.
-    # dot_static_files - The static files in the dir.
-    #
-    # Returns nothing.
-    def retrieve_static_files(dir, dot_static_files)
-      site.static_files.concat(StaticFileReader.new(site, dir).read(dot_static_files))
+    # @param dir [String] The directory retrieve the static files from.
+    # @param files [Array<String>] The static files in the dir.
+    def retrieve_static_files(dir, files)
+      site.static_files.concat(
+        files.map do |file|
+          StaticFile.new(site, site.source, dir, file)
+        end
+      )
     end
 
     # Filter out any files/directories that are hidden or backup files (start
@@ -181,7 +183,7 @@ module Bridgetown
     end
 
     def read_included_excludes
-      site.include.each do |entry|
+      site.config.include.each do |entry|
         next if entry == ".htaccess"
 
         entry_path = site.in_source_dir(entry)
@@ -197,7 +199,7 @@ module Bridgetown
       if Utils.has_yaml_header?(entry_path)
         site.pages.concat(PageReader.new(site, dir).read(file))
       else
-        site.static_files.concat(StaticFileReader.new(site, dir).read(file))
+        retrieve_static_files(dir, file)
       end
     end
   end

data/lib/bridgetown-core/readers/data_reader.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Bridgetown
+  # TODO: to be retired once the Resource engine is made official
   class DataReader
     attr_reader :site, :content
 
@@ -67,7 +68,7 @@ module Bridgetown
                  headers: true,
                  encoding: site.config["encoding"]).map(&:to_hash)
       else
-        SafeYAML.load_file(path)
+        YAMLParser.load_file(path)
       end
     end
 

data/lib/bridgetown-core/readers/defaults_reader.rb

@@ -18,7 +18,7 @@ module Bridgetown
 
       entries.each do |entry|
         path = @site.in_source_dir(entry)
-        @path_defaults[File.dirname(path) + File::SEPARATOR] = SafeYAML.load_file(path)
+        @path_defaults[File.dirname(path) + File::SEPARATOR] = YAMLParser.load_file(path)
       end
 
       @path_defaults

data/lib/bridgetown-core/readers/layout_reader.rb

@@ -44,7 +44,7 @@ module Bridgetown
     end
 
     def layout_name(file)
-      file.split(".")[0..-2].join(".")
+      Layout.label_for_file(file)
     end
 
     def within(directory)

data/lib/bridgetown-core/readers/page_reader.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Bridgetown
+  # TODO: to be retired once the Resource engine is made official
   class PageReader
     attr_reader :site, :dir, :unfiltered_content
 

data/lib/bridgetown-core/readers/post_reader.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Bridgetown
+  # TODO: to be retired once the Resource engine is made official
   class PostReader
     attr_reader :site, :unfiltered_content
 
@@ -47,7 +48,7 @@ module Bridgetown
           # Process as Document
           Document.new(path,
                        site: @site,
-                       collection: @site.posts)
+                       collection: @site.collections.posts)
         else
           # Process as Static File
           read_static_file(
@@ -66,7 +67,7 @@ module Bridgetown
         site.source,
         relative_dir,
         File.basename(full_path),
-        @site.posts
+        @site.collections.posts
       )
     end
 
@@ -96,9 +97,9 @@ module Bridgetown
       return false unless processable?(item)
 
       if item.is_a?(Document)
-        site.posts.docs << item
+        site.collections.posts.docs << item
       elsif item.is_a?(StaticFile)
-        site.posts.static_files << item
+        site.collections.posts.static_files << item
         site.static_files << item
       end
 

data/lib/bridgetown-core/regenerator.rb

@@ -154,7 +154,7 @@ module Bridgetown
           begin
             Marshal.load(content)
           rescue TypeError
-            SafeYAML.load(content)
+            YAMLParser.load(content)
           rescue ArgumentError => e
             Bridgetown.logger.warn("Failed to load #{metadata_file}: #{e}")
             {}

data/lib/bridgetown-core/related_posts.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Bridgetown
+  # TODO: to be retired once the Resource engine is made official
   class RelatedPosts
     class << self
       attr_accessor :lsi
@@ -11,13 +12,15 @@ module Bridgetown
     def initialize(post)
       @post = post
       @site = post.site
-      Bridgetown::External.require_with_graceful_fail("classifier-reborn") if site.lsi
+      if site.config.lsi
+        Bridgetown::Utils::RequireGems.require_with_graceful_fail("classifier-reborn")
+      end
     end
 
     def build
-      return [] unless site.posts.docs.size > 1
+      return [] unless site.collections.posts.docs.size > 1
 
-      if site.lsi
+      if site.config.lsi
         build_index
         lsi_related_posts
       else
@@ -30,7 +33,7 @@ module Bridgetown
         lsi = ClassifierReborn::LSI.new(auto_rebuild: false)
         Bridgetown.logger.info("Populating LSI...")
 
-        site.posts.docs.each do |x|
+        site.collections.posts.docs.each do |x|
           lsi.add_item(x)
         end
 
@@ -46,7 +49,7 @@ module Bridgetown
     end
 
     def most_recent_posts
-      @most_recent_posts ||= (site.posts.docs.last(11).reverse - [post]).first(10)
+      @most_recent_posts ||= (site.collections.posts.docs.last(11).reverse - [post]).first(10)
     end
   end
 end