bridgetown-core 0.19.2 → 0.21.0.beta3

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Model
+    # Abstract Superclass
+    class BuilderOrigin < Origin
+      # @return [Pathname]
+      attr_reader :relative_path
+
+      # Override in subclass
+      def self.handle_scheme?(scheme)
+        scheme == "builder"
+      end
+
+      def initialize(id)
+        self.id = id
+        @relative_path = Pathname.new(id.delete_prefix("builder://"))
+      end
+
+      def read
+        @data = if block_given?
+                  yield
+                elsif defined?(SiteBuilder) && SiteBuilder.respond_to?(:data_for_id)
+                  SiteBuilder.data_for_id(id)
+                else
+                  raise "No builder exists which can read #{id}"
+                end
+        @data[:_id_] = id
+        @data[:_origin_] = self
+        @relative_path = Pathname.new(@data[:_relative_path_]) if @data[:_relative_path_]
+
+        @data
+      end
+
+      def exists?
+        false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Model
+    # Abstract Superclass
+    class Origin
+      extend ActiveSupport::DescendantsTracker
+
+      # @return [String]
+      attr_accessor :id
+
+      # Override in subclass
+      def self.handle_scheme?(_scheme)
+        false
+      end
+
+      def initialize(id)
+        self.id = id
+      end
+
+      def read
+        raise "Implement #read in a subclass of Bridgetown::Model::Origin"
+      end
+
+      # @return [Pathname]
+      def relative_path
+        raise "Implement #relative_path in a subclass of Bridgetown::Model::Origin"
+      end
+
+      def exists?
+        raise "Implement #exists? in a subclass of Bridgetown::Model::Origin"
+      end
+    end
+  end
+end
+
+require "bridgetown-core/model/builder_origin"
+require "bridgetown-core/model/repo_origin"

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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Model
+    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 == "repo"
+        end
+
+        def data_file_extensions
+          %w(.yaml .yml .json .csv .tsv .rb).freeze
+        end
+      end
+
+      def read
+        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
+      end
+
+      def url
+        @url = URI.parse(id)
+      end
+
+      def relative_path
+        @relative_path ||= Pathname.new(
+          Addressable::URI.unescape(url.path.delete_prefix("/"))
+        )
+      end
+
+      def collection
+        return @collection if @collection
+
+        collection_name = if url.host.ends_with?(".collection")
+                            url.host.chomp(".collection")
+                          else
+                            "pages"
+                          end
+        @collection = Bridgetown::Current.site.collections[collection_name]
+      end
+
+      def original_path
+        @original_path ||= relative_path.expand_path(Bridgetown::Current.site.source)
+      end
+
+      def exists?
+        File.exist?(original_path)
+      end
+
+      private
+
+      def in_data_collection?
+        original_path.extname.downcase.in?(self.class.data_file_extensions) &&
+          collection.data?
+      end
+
+      def read_file_data # rubocop:todo Metrics/MethodLength
+        case original_path.extname.downcase
+        when ".csv"
+          {
+            rows:
+              CSV.read(original_path,
+                       headers: true,
+                       encoding: Bridgetown::Current.site.config["encoding"]).map(&:to_hash),
+          }
+        when ".tsv"
+          {
+            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 = YAMLParser.load_file(original_path)
+          yaml_data.is_a?(Array) ? { rows: yaml_data } : yaml_data
+        end
+      end
+
+      def handle_read_error(error)
+        if error.is_a? Psych::SyntaxError
+          Bridgetown.logger.error "Error:",
+                                  "YAML Exception reading #{original_path}: #{error.message}"
+        else
+          Bridgetown.logger.error "Error:",
+                                  "could not read file #{original_path}: #{error.message}"
+        end
+
+        if Bridgetown::Current.site.config["strict_front_matter"] ||
+            error.is_a?(Bridgetown::Errors::FatalException)
+          raise error
+        end
+      end
+    end
+  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,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_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,13 +12,18 @@ 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.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
 
     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

@@ -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|
+      site.config.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(
@@ -68,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