bridgetown-core 0.19.1 → 0.21.0.beta2

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,10 +45,10 @@ 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)
+        site.frontmatter_defaults.find(relative_path, type, key.to_s)
       end
 
       Bridgetown::Hooks.trigger :pages, :post_init, self
@@ -116,6 +117,7 @@ module Bridgetown
         permalink: permalink
       ).to_s
     end
+    alias_method :relative_url, :url
 
     # Returns a hash of URL placeholder names (as symbols) mapping to the
     # desired placeholder replacements. For details see "url.rb"
@@ -218,4 +220,11 @@ module Bridgetown
       true
     end
   end
+
+  # set up virtual page class for future compatibility
+  class GeneratedPage < Page
+    def read_yaml(_base, _name, _opts = {})
+      self.data ||= HashWithDotAccess::Hash.new
+    end
+  end
 end

data/lib/bridgetown-core/plugin.rb

@@ -2,6 +2,8 @@
 
 module Bridgetown
   class Plugin
+    extend ActiveSupport::DescendantsTracker
+
     PRIORITIES = {
       low: -10,
       highest: 100,
@@ -12,32 +14,6 @@ module Bridgetown
 
     SourceManifest = Struct.new(:origin, :components, :content, :layouts, keyword_init: true)
 
-    #
-
-    def self.inherited(const)
-      catch_inheritance(const) do |const_|
-        catch_inheritance(const_)
-      end
-    end
-
-    #
-
-    def self.catch_inheritance(const)
-      const.define_singleton_method :inherited do |const_|
-        (@children ||= Set.new).add const_
-        yield const_ if block_given?
-      end
-    end
-
-    #
-
-    def self.descendants
-      @children ||= Set.new
-      out = @children.map(&:descendants)
-      out << self unless superclass == Plugin
-      Set.new(out).flatten
-    end
-
     # Get or set the priority of this plugin. When called without an
     # argument it returns the priority. When an argument is given, it will
     # set the priority.

data/lib/bridgetown-core/plugin_manager.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "zeitwerk"
-
 module Bridgetown
   class PluginManager
     PLUGINS_GROUP = :bridgetown_plugins
@@ -135,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

@@ -2,6 +2,7 @@
 
 module Bridgetown
   class Publisher
+    # @param site [Bridgetown::Site]
     def initialize(site)
       @site = site
     end
@@ -11,7 +12,12 @@ module Bridgetown
     end
 
     def hidden_in_the_future?(thing)
-      thing.respond_to?(:date) && !@site.future && thing.date.to_i > @site.time.to_i
+      return false unless thing.respond_to?(:date)
+
+      future_allowed =
+        thing.respond_to?(:collection) && thing.collection.metadata.future || @site.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
 
     private

data/lib/bridgetown-core/reader.rb

@@ -11,20 +11,29 @@ module Bridgetown
     # Read Site data from disk and load it into internal data structures.
     #
     # Returns nothing.
-    # rubocop:disable Metrics/AbcSize
-    def read
-      @site.defaults_reader.read
-      @site.layouts = LayoutReader.new(site).read
+    def read # rubocop:todo Metrics/AbcSize
+      site.defaults_reader.read
+      site.layouts = LayoutReader.new(site).read
       read_directories
       read_included_excludes
       sort_files!
-      @site.data = DataReader.new(site).read(site.config["data_dir"])
-      CollectionReader.new(site).read
+      read_collections
+      site.data = if site.uses_resource?
+                    site.collections.data.merge_data_resources
+                  else
+                    DataReader.new(site).read
+                  end
       Bridgetown::PluginManager.source_manifests.map(&:content).compact.each do |plugin_content_dir|
         PluginContentReader.new(site, plugin_content_dir).read
       end
     end
-    # rubocop:enable Metrics/AbcSize
+
+    def read_collections
+      site.collections.each_value do |collection|
+        collection.read unless !site.uses_resource? &&
+          collection.legacy_reader?
+      end
+    end
 
     # Sorts posts, pages, and static files.
     def sort_files!
@@ -54,14 +63,14 @@ 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
         end
       end
 
-      retrieve_posts(dir)
+      retrieve_posts(dir) unless site.uses_resource?
       retrieve_dirs(base, dir, dot_dirs)
       retrieve_pages(dir, dot_pages)
       retrieve_static_files(dir, dot_static_files)
@@ -89,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
@@ -102,18 +111,27 @@ module Bridgetown
     #
     # Returns nothing.
     def retrieve_pages(dir, dot_pages)
+      if site.uses_resource?
+        dot_pages.each do |page_path|
+          site.collections.pages.read_resource(site.in_source_dir(dir, page_path))
+        end
+        return
+      end
+
       site.pages.concat(PageReader.new(site, dir).read(dot_pages))
     end
 
     # 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
@@ -126,7 +144,7 @@ module Bridgetown
     #
     # Returns the Array of filtered entries.
     def filter_entries(entries, base_directory = nil)
-      EntryFilter.new(site, base_directory).filter(entries)
+      EntryFilter.new(site, base_directory: base_directory).filter(entries)
     end
 
     # Read the entries from a particular directory for processing
@@ -165,14 +183,11 @@ module Bridgetown
     end
 
     def read_included_excludes
-      entry_filter = EntryFilter.new(site)
-
       site.include.each do |entry|
         next if entry == ".htaccess"
 
         entry_path = site.in_source_dir(entry)
         next if File.directory?(entry_path)
-        next if entry_filter.symlink?(entry_path)
 
         read_included_file(entry_path) if File.file?(entry_path)
       end
@@ -184,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
 
@@ -16,8 +17,8 @@ module Bridgetown
     #
     # Returns @content, a Hash of the .yaml, .yml,
     # .json, and .csv files in the base directory
-    def read(dir)
-      base = site.in_source_dir(dir)
+    def read
+      base = site.in_source_dir(site.config.data_dir)
       read_data_to(base, @content)
       merge_environment_specific_metadata!
       @content = @content.with_dot_access
@@ -31,7 +32,7 @@ module Bridgetown
     #
     # Returns nothing
     def read_data_to(dir, data)
-      return unless File.directory?(dir) && !@entry_filter.symlink?(dir)
+      return unless File.directory?(dir)
 
       entries = Dir.chdir(dir) do
         Dir["*.{yaml,yml,json,csv,tsv}"] + Dir["*"].select { |fn| File.directory?(fn) }
@@ -39,7 +40,6 @@ module Bridgetown
 
       entries.each do |entry|
         path = @site.in_source_dir(dir, entry)
-        next if @entry_filter.symlink?(path)
 
         if File.directory?(path)
           read_data_to(

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.files << item
+        site.collections.posts.static_files << item
         site.static_files << item
       end
 

data/lib/bridgetown-core/regenerator.rb

@@ -19,7 +19,7 @@ module Bridgetown
     # Checks if a renderable object needs to be regenerated
     #
     # Returns a boolean.
-    def regenerate?(document)
+    def regenerate?(document) # rubocop:todo Metrics/CyclomaticComplexity
       return true if disabled
 
       case document
@@ -27,6 +27,8 @@ module Bridgetown
         regenerate_page?(document)
       when Document
         regenerate_document?(document)
+      when Bridgetown::Resource::Base
+        regenerate_resource?(document)
       else
         source_path = document.respond_to?(:path) ? document.path : nil
         dest_path = document.destination(@site.dest) if document.respond_to?(:destination)
@@ -176,6 +178,11 @@ module Bridgetown
         )
     end
 
+    # TODO: need to manage dependencies, but for now always regenerate
+    def regenerate_resource?(_resource)
+      true
+    end
+
     def existing_file_modified?(path)
       # If one of this file dependencies have been modified,
       # set the regeneration bit for both the dependency and the file to true

data/lib/bridgetown-core/related_posts.rb

@@ -11,11 +11,11 @@ module Bridgetown
     def initialize(post)
       @post = post
       @site = post.site
-      Bridgetown::External.require_with_graceful_fail("classifier-reborn") if site.lsi
+      Bridgetown::Utils::RequireGems.require_with_graceful_fail("classifier-reborn") if site.lsi
     end
 
     def build
-      return [] unless site.posts.docs.size > 1
+      return [] unless site.collections.posts.docs.size > 1
 
       if site.lsi
         build_index
@@ -30,7 +30,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
 
@@ -42,11 +42,11 @@ module Bridgetown
     end
 
     def lsi_related_posts
-      self.class.lsi.find_related(post, 11)
+      self.class.lsi.find_related(post, 11) - [post]
     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

data/lib/bridgetown-core/renderer.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Bridgetown
+  # This class handles the output rendering and layout placement of pages and
+  # documents. For rendering of resources in particular, see Bridgetown::Resource::Transformer
   class Renderer
     attr_reader :document, :site
 
@@ -50,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
@@ -121,21 +123,11 @@ module Bridgetown
         "in #{document.relative_path} does not exist."
     end
 
-    def converters_for_layout(layout)
-      site.converters.select do |converter|
-        if converter.method(:matches).arity == 1
-          converter.matches(layout.ext)
-        else
-          converter.matches(layout.ext, layout)
-        end
-      end.sort
-    end
-
     # Render layout content into document.output
     #
     # Returns String rendered content
     def render_layout(output, layout)
-      layout_converters = converters_for_layout(layout)
+      layout_converters = site.matched_converters_for_convertible(layout)
 
       layout_content = layout.content.dup
       layout_converters.reduce(layout_content) do |layout_output, converter|
@@ -163,7 +155,8 @@ module Bridgetown
 
     def permalink_ext
       document_permalink = document.permalink
-      if document_permalink && !document_permalink.end_with?("/")
+      if document_permalink &&
+          !document_permalink.end_with?("/")
         permalink_ext = File.extname(document_permalink)
         permalink_ext unless permalink_ext.empty?
       end