bridgetown-core 0.19.3 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad7d5025a99240586457a8afa4aa3e9a9aba0e289484ff855648bd772b89e7a9
-  data.tar.gz: 1ea0ad14dc78ca7465f7ff93bab6e178ec18b336e08641ac18bf75cf655b7246
+  metadata.gz: c58653595832ef2fb9e6bbea3f147a0b3be9edae554d169e974570b84565a507
+  data.tar.gz: 7af409e9a01570321171cf1afc562c00cacdcc6e0dce98f2b8eac4988a60e8d6
 SHA512:
-  metadata.gz: 95b1542d9fa33741d18832a026aa43e720f99520b8367b12672e2689c7be19200e0cedd53b8070666c15e7594af43dec3c1885fa8570e6c7daf463afcae3405f
-  data.tar.gz: '00048d6aa2ca15728544ecbf46ee05b4b813630a03a0f35154b45096a2f9720ea645e23faac13fcab18a85e395fa6782eee522cbd39248b88b0f2a80a7fcff41'
+  metadata.gz: b21d9c304dd99dd306b70e97e172d1ec172f0d1fa48034610cc3d9e6bc9c40b98e7fe10479226103cb2ff501c22c7c2841f20630235262cc7214661be62bcf3e
+  data.tar.gz: cab7afb0f441e412850ce648d6e7ca9a3996f106b0800c31ef24a0cf63af9db770498f307da275860c0572d6d6f2a5f1e56570d10349bb11cd4f17f96b3266ee

data/bridgetown-core.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version     = ">= 2.5.0"
   s.required_rubygems_version = ">= 2.7.0"
 
+  s.add_runtime_dependency("activemodel",           "~> 6.0")
   s.add_runtime_dependency("activesupport",         "~> 6.0")
   s.add_runtime_dependency("addressable",           "~> 2.4")
   s.add_runtime_dependency("amazing_print",         "~> 1.2")
@@ -45,7 +46,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency("liquid",                "~> 5.0")
   s.add_runtime_dependency("liquid-component",      ">= 0.1")
   s.add_runtime_dependency("listen",                "~> 3.0")
-  s.add_runtime_dependency("pathutil",              "~> 0.9")
   s.add_runtime_dependency("rouge",                 "~> 3.0")
   s.add_runtime_dependency("safe_yaml",             "~> 1.0")
   s.add_runtime_dependency("terminal-table",        "~> 1.8")

data/lib/bridgetown-core.rb

@@ -18,6 +18,7 @@ end
 require "rubygems"
 
 # stdlib
+require "find"
 require "forwardable"
 require "fileutils"
 require "time"
@@ -31,13 +32,16 @@ require "json"
 # 3rd party
 require "active_support"
 require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/object/blank"
+require "active_support/core_ext/object/deep_dup"
+require "active_support/core_ext/object/inclusion"
 require "active_support/core_ext/string/inflections"
 require "active_support/core_ext/string/inquiry"
 require "active_support/core_ext/string/starts_ends_with"
+require "active_support/current_attributes"
 require "active_support/descendants_tracker"
 require "hash_with_dot_access"
-require "pathutil"
 require "addressable/uri"
 require "safe_yaml/load"
 require "liquid"
@@ -47,6 +51,7 @@ require "colorator"
 require "i18n"
 require "faraday"
 require "thor"
+require "zeitwerk"
 
 module HashWithDotAccess
   class Hash # :nodoc:
@@ -73,7 +78,6 @@ if RUBY_VERSION.start_with?("3.0")
 end
 
 module Bridgetown
-  # internal requires
   autoload :Cleaner,             "bridgetown-core/cleaner"
   autoload :Collection,          "bridgetown-core/collection"
   autoload :Configuration,       "bridgetown-core/configuration"
@@ -81,30 +85,38 @@ module Bridgetown
   autoload :Deprecator,          "bridgetown-core/deprecator"
   autoload :Document,            "bridgetown-core/document"
   autoload :EntryFilter,         "bridgetown-core/entry_filter"
+  # TODO: we have too many errors! This is silly
   autoload :Errors,              "bridgetown-core/errors"
   autoload :Excerpt,             "bridgetown-core/excerpt"
+  # TODO: this is a poorly named, unclear class. Relocate to Utils:
   autoload :External,            "bridgetown-core/external"
   autoload :FrontmatterDefaults, "bridgetown-core/frontmatter_defaults"
   autoload :Hooks,               "bridgetown-core/hooks"
   autoload :Layout,              "bridgetown-core/layout"
   autoload :LayoutPlaceable,     "bridgetown-core/concerns/layout_placeable"
   autoload :Cache,               "bridgetown-core/cache"
-  autoload :CollectionReader,    "bridgetown-core/readers/collection_reader"
+  autoload :Current,             "bridgetown-core/current"
+  # TODO: remove this when legacy content engine is gone:
   autoload :DataReader,          "bridgetown-core/readers/data_reader"
   autoload :DefaultsReader,      "bridgetown-core/readers/defaults_reader"
   autoload :LayoutReader,        "bridgetown-core/readers/layout_reader"
+  # TODO: remove this when legacy content engine is gone:
   autoload :PostReader,          "bridgetown-core/readers/post_reader"
+  # TODO: we can merge this back into Reader class:
   autoload :PageReader,          "bridgetown-core/readers/page_reader"
   autoload :PluginContentReader, "bridgetown-core/readers/plugin_content_reader"
+  # TODO: also merge this:
   autoload :StaticFileReader,    "bridgetown-core/readers/static_file_reader"
   autoload :LogAdapter,          "bridgetown-core/log_adapter"
   autoload :Page,                "bridgetown-core/page"
-  autoload :PageWithoutAFile,    "bridgetown-core/page_without_a_file"
+  autoload :GeneratedPage,       "bridgetown-core/page"
+  # TODO: figure out how to get rid of this seemingly banal class:
   autoload :PathManager,         "bridgetown-core/path_manager"
   autoload :PluginManager,       "bridgetown-core/plugin_manager"
   autoload :Publishable,         "bridgetown-core/concerns/publishable"
   autoload :Publisher,           "bridgetown-core/publisher"
   autoload :Reader,              "bridgetown-core/reader"
+  # TODO: remove this when the incremental regenerator is gone:
   autoload :Regenerator,         "bridgetown-core/regenerator"
   autoload :RelatedPosts,        "bridgetown-core/related_posts"
   autoload :Renderer,            "bridgetown-core/renderer"
@@ -130,6 +142,7 @@ module Bridgetown
 
   require "bridgetown-core/drops/drop"
   require "bridgetown-core/drops/document_drop"
+  require "bridgetown-core/drops/resource_drop"
   require_all "bridgetown-core/converters"
   require_all "bridgetown-core/converters/markdown"
   require_all "bridgetown-core/drops"
@@ -193,11 +206,7 @@ module Bridgetown
     # @return [void]
     # rubocop:disable Naming/AccessorMethodName
     def set_timezone(timezone)
-      ENV["TZ"] = if Utils::Platforms.really_windows?
-                    Utils::WinTZ.calculate(timezone)
-                  else
-                    timezone
-                  end
+      ENV["TZ"] = timezone
     end
     # rubocop:enable Naming/AccessorMethodName
 
@@ -218,11 +227,11 @@ module Bridgetown
       @logger = LogAdapter.new(writer, (ENV["BRIDGETOWN_LOG_LEVEL"] || :info).to_sym)
     end
 
-    # An array of sites. Currently only ever a single entry.
+    # Deprecated. Now using the Current site.
     #
     # @return [Array<Bridgetown::Site>] the Bridgetown sites created.
     def sites
-      @sites ||= []
+      [Bridgetown::Current.site].compact
     end
 
     # Ensures the questionable path is prefixed with the base directory
@@ -259,3 +268,13 @@ module Bridgetown
     Bridgetown::External.require_if_present("liquid/c")
   end
 end
+
+module Bridgetown
+  module Model; end
+  module Resource; end
+end
+
+loader = Zeitwerk::Loader.new
+loader.push_dir File.join(__dir__, "bridgetown-core/model"), namespace: Bridgetown::Model
+loader.push_dir File.join(__dir__, "bridgetown-core/resource"), namespace: Bridgetown::Resource
+loader.setup # ready!

data/lib/bridgetown-core/cleaner.rb

@@ -58,7 +58,13 @@ module Bridgetown
     # Returns a Set with the file paths
     def new_files
       @new_files ||= Set.new.tap do |files|
-        site.each_site_file { |item| files << item.destination(site.dest) }
+        site.each_site_file do |item|
+          files << if item.method(:destination).arity == 1
+                     item.destination(site.dest)
+                   else
+                     item.destination.output_path
+                   end
+        end
       end
     end
 

data/lib/bridgetown-core/collection.rb

@@ -8,82 +8,104 @@ module Bridgetown
     attr_reader :label, :metadata
     attr_writer :docs
 
+    attr_writer :resources
+
     # Create a new Collection.
     #
-    # site - the site to which this collection belongs.
-    # label - the name of the collection
-    #
-    # Returns nothing.
+    # @param site [Bridgetown::Site] the site to which this collection belongs
+    # @param label [String] the name of the collection
     def initialize(site, label)
       @site     = site
       @label    = sanitize_label(label)
       @metadata = extract_metadata
     end
 
+    def builtin?
+      label.in? %w(posts pages data).freeze
+    end
+
+    def legacy_reader?
+      label.in? %w(posts data).freeze
+    end
+
+    def data?
+      label == "data"
+    end
+
     # Fetch the Documents in this collection.
     # Defaults to an empty array if no documents have been read in.
     #
-    # Returns an array of Bridgetown::Document objects.
+    # @return [Array<Bridgetown::Document>]
     def docs
       @docs ||= []
     end
 
-    # Override of normal respond_to? to match method_missing's logic for
-    # looking in @data.
-    def respond_to_missing?(method, include_private = false)
-      docs.respond_to?(method.to_sym, include_private) || super
+    # Fetch the Resources in this collection.
+    # Defaults to an empty array if no resources have been read in.
+    #
+    # @return [Array<Bridgetown::Resource::Base>]
+    def resources
+      @resources ||= []
     end
 
-    # Override of method_missing to check in @data for the key.
-    def method_missing(method, *args, &blck)
-      if docs.respond_to?(method.to_sym)
-        Bridgetown.logger.warn "Deprecation:",
-                               "#{label}.#{method} should be changed to #{label}.docs.#{method}."
-        Bridgetown.logger.warn "", "Called by #{caller(0..0)}."
-        docs.public_send(method.to_sym, *args, &blck)
-      else
-        super
-      end
+    # Iterate over either Resources or Documents depending on how the site is
+    # configured
+    def each(&block)
+      site.uses_resource? ? resources.each(&block) : docs.each(&block)
     end
 
     # Fetch the static files in this collection.
     # Defaults to an empty array if no static files have been read in.
     #
-    # Returns an array of Bridgetown::StaticFile objects.
+    # @return [Array<Bridgetown::StaticFile>]
+    def static_files
+      @static_files ||= []
+    end
+
     def files
-      @files ||= []
+      Bridgetown::Deprecator.deprecation_message "Collection#files is now Collection#static_files"
+      static_files
     end
 
     # Read the allowed documents into the collection's array of docs.
     #
-    # Returns the sorted array of docs.
-    def read
+    # @return [Bridgetown::Collection] self
+    def read # rubocop:todo Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       filtered_entries.each do |file_path|
         full_path = collection_dir(file_path)
         next if File.directory?(full_path)
 
-        if Utils.has_yaml_header? full_path
+        if site.uses_resource?
+          next if File.basename(file_path).starts_with?("_")
+
+          if label == "data" || Utils.has_yaml_header?(full_path)
+            read_resource(full_path)
+          else
+            read_static_file(file_path, full_path)
+          end
+        elsif Utils.has_yaml_header? full_path
           read_document(full_path)
         else
           read_static_file(file_path, full_path)
         end
       end
-      site.static_files.concat(files)
+      site.static_files.concat(static_files)
       sort_docs!
+
+      self
     end
 
     # All the entries in this collection.
     #
-    # Returns an Array of file paths to the documents in this collection
-    #   relative to the collection's directory
+    # @return [Array<String>] file paths to the documents in this collection
+    #   relative to the collection's folder
     def entries
       return [] unless exists?
 
       @entries ||= begin
         collection_dir_slash = "#{collection_dir}/"
         Utils.safe_glob(collection_dir, ["**", "*"], File::FNM_DOTMATCH).map do |entry|
-          entry[collection_dir_slash] = ""
-          entry
+          entry.sub(collection_dir_slash, "")
         end
       end
     end
@@ -91,85 +113,87 @@ module Bridgetown
     # Filtered version of the entries in this collection.
     # See `Bridgetown::EntryFilter#filter` for more information.
     #
-    # Returns a list of filtered entry paths.
+    # @return [Array<String>] list of filtered entry paths
     def filtered_entries
       return [] unless exists?
 
       @filtered_entries ||=
-        Dir.chdir(directory) do
+        Dir.chdir(absolute_path) do
           entry_filter.filter(entries).reject do |f|
             path = collection_dir(f)
-            File.directory?(path) || entry_filter.symlink?(f)
+            File.directory?(path)
           end
         end
     end
 
-    # The directory for this Collection, relative to the site source or the directory
-    # containing the collection.
+    # The folder name of this Collection, e.g. `_posts` or `_events`
     #
-    # Returns a String containing the directory name where the collection
-    #   is stored on the filesystem.
-    def relative_directory
-      @relative_directory ||= "_#{label}"
+    # @return [String]
+    def folder_name
+      @folder_name ||= "_#{label}"
     end
+    alias_method :relative_directory, :folder_name
 
-    # The relative path to the directory containing the collection.
+    # The relative path to the folder containing the collection.
     #
-    # Returns a String containing the directory name where the collection
-    #   is stored relative to the source directory
+    # @return [String] folder where the collection is stored relative to the
+    #   configured collections folder (usually the site source)
     def relative_path
-      Pathname.new(container).join(relative_directory).to_s
+      Pathname.new(container).join(folder_name).to_s
     end
 
-    # The full path to the directory containing the collection.
+    # The full path to the folder containing the collection.
     #
-    # Returns a String containing the directory name where the collection
-    #   is stored on the filesystem.
-    def directory
-      @directory ||= site.in_source_dir(relative_path)
+    # @return [String] full path where the collection is stored on the filesystem
+    def absolute_path
+      @absolute_path ||= site.in_source_dir(relative_path)
     end
+    alias_method :directory, :absolute_path
 
-    # The full path to the directory containing the collection, with
+    # The full path to the folder containing the collection, with
     #   optional subpaths.
     #
-    # *files - (optional) any other path pieces relative to the
-    #           directory to append to the path
-    #
-    # Returns a String containing th directory name where the collection
-    #   is stored on the filesystem.
+    # @param *files [Array<String>] any other path pieces relative to the
+    #   folder to append to the path
+    # @return [String]
     def collection_dir(*files)
-      return directory if files.empty?
+      return absolute_path if files.empty?
 
-      site.in_source_dir(container, relative_directory, *files)
+      site.in_source_dir(relative_path, *files)
     end
 
-    # Checks whether the directory "exists" for this collection.
+    # Checks whether the folder "exists" for this collection.
+    #
+    # @return [Boolean]
     def exists?
-      File.directory?(directory)
+      File.directory?(absolute_path)
     end
 
     # The entry filter for this collection.
-    # Creates an instance of Bridgetown::EntryFilter.
+    # Creates an instance of Bridgetown::EntryFilter if needed.
     #
-    # Returns the instance of Bridgetown::EntryFilter for this collection.
+    # @return [Bridgetown::EntryFilter]
     def entry_filter
-      @entry_filter ||= Bridgetown::EntryFilter.new(site, relative_directory)
+      @entry_filter ||= Bridgetown::EntryFilter.new(
+        site,
+        base_directory: folder_name,
+        include_underscores: site.uses_resource?
+      )
     end
 
     # An inspect string.
     #
-    # Returns the inspect string
+    # @return [String]
     def inspect
-      "#<#{self.class} @label=#{label} docs=#{docs}>"
+      "#<#{self.class} @label=#{label} docs=#{docs} resources=#{resources}>"
     end
 
     # Produce a sanitized label name
     # Label names may not contain anything but alphanumeric characters,
     #   underscores, and hyphens.
     #
-    # label - the possibly-unsafe label
-    #
-    # Returns a sanitized version of the label.
+    # @param label [String] the possibly-unsafe label
+    # @return [String] sanitized version of the label.
     def sanitize_label(label)
       label.gsub(%r![^a-z0-9_\-\.]!i, "")
     end
@@ -179,7 +203,8 @@ module Bridgetown
     #   - label
     #   - docs
     #
-    # Returns a representation of this collection for use in Liquid.
+    # @return [Bridgetown::Drops::CollectionDrop] representation of this
+    #   collection for use in Liquid
     def to_liquid
       Drops::CollectionDrop.new self
     end
@@ -187,14 +212,22 @@ module Bridgetown
     # Whether the collection's documents ought to be written as individual
     #   files in the output.
     #
-    # Returns true if the 'write' metadata is true, false otherwise.
+    # @return [Boolean] true if the 'write' metadata is true, false otherwise.
     def write?
       !!metadata.fetch("output", false)
     end
 
-    # The URL template to render collection's documents at.
+    # Used by Resource's permalink processor
+    # @return [String]
+    def default_permalink
+      metadata.fetch("permalink") do
+        "/:collection/:path/"
+      end
+    end
+
+    # LEGACY: The URL template to render collection's documents at.
     #
-    # Returns the URL template to render collection's documents at.
+    # @return [String]
     def url_template
       @url_template ||= metadata.fetch("permalink") do
         Utils.add_permalink_suffix("/:collection/:path", site.permalink_style)
@@ -203,13 +236,47 @@ module Bridgetown
 
     # Extract options for this collection from the site configuration.
     #
-    # Returns the metadata for this collection
+    # @return [HashWithDotAccess::Hash]
     def extract_metadata
-      if site.config["collections"].is_a?(Hash)
-        site.config["collections"][label] || {}
-      else
-        {}
+      site.config.collections[label] || HashWithDotAccess::Hash.new
+    end
+
+    def merge_data_resources
+      data_contents = {}
+
+      sanitize_filename = ->(name) do
+        name.gsub(%r![^\w\s-]+|(?<=^|\b\s)\s+(?=$|\s?\b)!, "")
+          .gsub(%r!\s+!, "_")
       end
+
+      resources.each do |data_resource|
+        segments = data_resource.relative_path.each_filename.to_a[1..-1]
+        nested = []
+        segments.each_with_index do |segment, index|
+          sanitized_segment = sanitize_filename.(File.basename(segment, ".*"))
+          hsh = nested.empty? ? data_contents : data_contents.dig(*nested)
+          hsh[sanitized_segment] = if index == segments.length - 1
+                                     data_resource.data.array || data_resource.data
+                                   else
+                                     {}
+                                   end
+          nested << sanitized_segment
+        end
+      end
+
+      merge_environment_specific_metadata(data_contents).with_dot_access
+    end
+
+    def merge_environment_specific_metadata(data_contents)
+      if data_contents["site_metadata"]
+        data_contents["site_metadata"][Bridgetown.environment]&.each_key do |k|
+          data_contents["site_metadata"][k] =
+            data_contents["site_metadata"][Bridgetown.environment][k]
+        end
+        data_contents["site_metadata"].delete(Bridgetown.environment)
+      end
+
+      data_contents
     end
 
     private
@@ -219,17 +286,28 @@ module Bridgetown
     end
 
     def read_document(full_path)
-      doc = Document.new(full_path, site: site, collection: self)
-      doc.read
+      doc = Document.new(full_path, site: site, collection: self).tap(&:read)
       docs << doc if site.unpublished || doc.published?
     end
 
+    def read_resource(full_path)
+      id = "file://#{label}.collection/" + Addressable::URI.escape(
+        Pathname(full_path).relative_path_from(Pathname(site.source)).to_s
+      )
+      resource = Bridgetown::Model::Base.find(id).to_resource.read!
+      resources << resource if site.unpublished || resource.published?
+    end
+
     def sort_docs!
       if metadata["sort_by"].is_a?(String)
         sort_docs_by_key!
+        sort_resources_by_key!
       else
         docs.sort!
+        resources.sort!
       end
+      docs.reverse! if metadata.sort_direction == "descending"
+      resources.reverse! if metadata.sort_direction == "descending"
     end
 
     # A custom sort function based on Schwartzian transform
@@ -252,6 +330,24 @@ module Bridgetown
       end.map!(&:last)
     end
 
+    def sort_resources_by_key!
+      meta_key = metadata["sort_by"]
+      # Modify `docs` array to cache document's property along with the Document instance
+      resources.map! { |doc| [doc.data[meta_key], doc] }.sort! do |apples, olives|
+        order = determine_sort_order(meta_key, apples, olives)
+
+        # Fall back to `Document#<=>` if the properties were equal or were non-sortable
+        # Otherwise continue with current sort-order
+        if order.nil? || order.zero?
+          apples[-1] <=> olives[-1]
+        else
+          order
+        end
+
+        # Finally restore the `docs` array with just the Document objects themselves
+      end.map!(&:last)
+    end
+
     def determine_sort_order(sort_key, apples, olives)
       apple_property, apple_document = apples
       olive_property, olive_document = olives
@@ -277,7 +373,7 @@ module Bridgetown
         File.dirname(file_path)
       ).chomp("/.")
 
-      files << StaticFile.new(
+      static_files << StaticFile.new(
         site,
         site.source,
         relative_dir,