bridgetown-core 0.19.3 → 0.20.0

data/lib/bridgetown-core/layout.rb

@@ -21,6 +21,8 @@ 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
 
@@ -53,8 +55,6 @@ module Bridgetown
       end
       @relative_path = @path.sub(@base_dir, "")
 
-      self.data = {}
-
       process(name)
       read_yaml(base, name)
     end

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

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/file_origin.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Model
+    class FileOrigin < Origin
+      YAML_FRONT_MATTER_REGEXP = %r!\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m.freeze
+
+      class << self
+        def handle_scheme?(scheme)
+          scheme == "file"
+        end
+
+        def data_file_extensions
+          %w(.yaml .yml .json .csv .tsv).freeze
+        end
+      end
+
+      def read
+        @data = (in_data_collection? ? read_file_data : read_frontmatter) || {}
+        @data[:_id_] = id
+        @data[:_origin_] = self
+        @data[:_collection_] = collection
+        @data[:_content_] = @content if @content
+
+        @data
+      rescue StandardError => e
+        handle_read_error(e)
+      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
+        case original_path.extname.downcase
+        when ".csv"
+          {
+            array:
+              CSV.read(original_path,
+                       headers: true,
+                       encoding: Bridgetown::Current.site.config["encoding"]).map(&:to_hash),
+          }
+        when ".tsv"
+          {
+            array:
+              CSV.read(original_path,
+                       col_sep: "\t",
+                       headers: true,
+                       encoding: Bridgetown::Current.site.config["encoding"]).map(&:to_hash),
+          }
+        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
+        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/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/file_origin"

data/lib/bridgetown-core/page.rb

@@ -47,7 +47,7 @@ module Bridgetown
       read_yaml(PathManager.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 +116,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 +219,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

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!
@@ -61,7 +70,7 @@ module Bridgetown
         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)
@@ -102,6 +111,13 @@ module Bridgetown
     #
     # Returns nothing.
     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))
+        end
+        return
+      end
+
       site.pages.concat(PageReader.new(site, dir).read(dot_pages))
     end
 
@@ -126,7 +142,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 +181,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