bridgetown-core 0.19.1 → 0.21.0.beta2

data/lib/bridgetown-core/concerns/data_accessible.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Bridgetown
+  # TODO: to be retired once the Resource engine is made official
   module DataAccessible
     # Returns the contents as a String.
     def to_s

data/lib/bridgetown-core/concerns/front_matter_importer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module FrontMatterImporter
+    # Requires klass#content and klass#front_matter_line_count accessors
+    def self.included(klass)
+      klass.include Bridgetown::Utils::RubyFrontMatterDSL
+    end
+
+    YAML_HEADER = %r!\A---\s*\n!.freeze
+    YAML_BLOCK = %r!\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m.freeze
+    RUBY_HEADER = %r!\A[~`#\-]{3,}(?:ruby|<%|{%)\s*\n!.freeze
+    RUBY_BLOCK =
+      %r!#{RUBY_HEADER.source}(.*?\n?)^((?:%>|%})?[~`#\-]{3,}\s*$\n?)!m.freeze
+
+    def read_front_matter(file_path) # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+      file_contents = File.read(
+        file_path, **Bridgetown::Utils.merged_file_read_opts(Bridgetown::Current.site, {})
+      )
+      yaml_content = file_contents.match(YAML_BLOCK)
+      if !yaml_content && Bridgetown::Current.site.config.should_execute_inline_ruby?
+        ruby_content = file_contents.match(RUBY_BLOCK)
+      end
+
+      if yaml_content
+        self.content = yaml_content.post_match
+        self.front_matter_line_count = yaml_content[1].lines.size - 1
+        SafeYAML.load(yaml_content[1])
+      elsif ruby_content
+        # rbfm header + content underneath
+        self.content = ruby_content.post_match
+        self.front_matter_line_count = ruby_content[1].lines.size
+        process_ruby_data(ruby_content[1], file_path, 2)
+      elsif Bridgetown::Utils.has_rbfm_header?(file_path)
+        process_ruby_data(File.read(file_path).lines[1..-1].join("\n"), file_path, 2)
+      elsif is_a?(Layout)
+        self.content = file_contents
+        {}
+      else
+        yaml_data = SafeYAML.load_file(file_path)
+        yaml_data.is_a?(Array) ? { rows: yaml_data } : yaml_data
+      end
+    end
+
+    def process_ruby_data(rubycode, file_path, starting_line)
+      ruby_data = instance_eval(rubycode, file_path.to_s, starting_line)
+      ruby_data.is_a?(Array) ? { rows: ruby_data } : ruby_data.to_h
+    rescue StandardError => e
+      raise "Ruby code isn't returning an array, or object which responds to `to_h' (#{e.message})"
+    end
+  end
+end

data/lib/bridgetown-core/concerns/site/configurable.rb

@@ -30,11 +30,15 @@ class Bridgetown::Site
       configure_include_paths
       configure_file_read_opts
 
-      self.permalink_style = config["permalink"].to_sym
+      self.permalink_style = (config["permalink"] || "pretty").to_sym
 
       @config
     end
 
+    def uses_resource?
+      config[:content_engine] == "resource"
+    end
+
     def defaults_reader
       @defaults_reader ||= Bridgetown::DefaultsReader.new(self)
     end
@@ -78,7 +82,7 @@ class Bridgetown::Site
     # @return [Array<String>] Return an array of updated paths if multiple paths given.
     def in_root_dir(*paths)
       paths.reduce(root_dir) do |base, path|
-        Bridgetown.sanitized_path(base, path)
+        Bridgetown.sanitized_path(base, path.to_s)
       end
     end
 
@@ -91,7 +95,7 @@ class Bridgetown::Site
     # @return [Array<String>] Return an array of updated paths if multiple paths given.
     def in_source_dir(*paths)
       paths.reduce(source) do |base, path|
-        Bridgetown.sanitized_path(base, path)
+        Bridgetown.sanitized_path(base, path.to_s)
       end
     end
 

data/lib/bridgetown-core/concerns/site/content.rb

@@ -32,6 +32,18 @@ class Bridgetown::Site
       end
     end
 
+    def resources_grouped_by_taxonomy(taxonomy)
+      @post_attr_hash[taxonomy.label] ||= begin
+        taxonomy.terms.transform_values { |terms| terms.map(&:resource).sort.reverse }
+      end
+    end
+
+    def taxonomies
+      taxonomy_types.transform_values do |taxonomy|
+        resources_grouped_by_taxonomy(taxonomy)
+      end
+    end
+
     # Returns a hash of "tags" using {#post_attr_hash} where each tag is a key
     #  and each value is a post which contains the key.
     # @example
@@ -41,7 +53,7 @@ class Bridgetown::Site
     # @return [Hash{String, Array<Post>}] Returns a hash of all tags and their corresponding posts
     # @see post_attr_hash
     def tags
-      post_attr_hash("tags")
+      uses_resource? ? taxonomies.tag : post_attr_hash("tags")
     end
 
     # Returns a hash of "categories" using {#post_attr_hash} where each tag is
@@ -54,7 +66,7 @@ class Bridgetown::Site
     #   their corresponding posts
     # @see post_attr_hash
     def categories
-      post_attr_hash("categories")
+      uses_resource? ? taxonomies.category : post_attr_hash("categories")
     end
 
     # Returns the value of `data["site_metadata"]` or creates a new instance of
@@ -121,19 +133,25 @@ class Bridgetown::Site
     # An array of collection names.
     # @return [Array<String>] an array of collection names from the configuration,
     #   or an empty array if the `config["collections"]` key is not set.
-    # @raise ArgumentError Raise an error if `config["collections"]` is not
-    #   an Array or a Hash
     def collection_names
-      case config["collections"]
-      when Hash
-        config["collections"].keys
-      when Array
-        config["collections"]
-      when nil
-        []
-      else
-        raise ArgumentError, "Your `collections` key must be a hash or an array."
-      end
+      Array(config.collections&.keys)
+    end
+
+    # @return [Array<Bridgetown::Resource::TaxonomyType>]
+    def taxonomy_types
+      @taxonomy_types ||= config.taxonomies.map do |label, key_or_metadata|
+        key = key_or_metadata
+        tax_metadata = if key_or_metadata.is_a? Hash
+                         key = key_or_metadata["key"]
+                         key_or_metadata.reject { |k| k == "key" }
+                       else
+                         HashWithDotAccess::Hash.new
+                       end
+
+        [label, Bridgetown::Resource::TaxonomyType.new(
+          site: self, label: label, key: key, metadata: tax_metadata
+        ),]
+      end.to_h.with_dot_access
     end
 
     # Get all documents.
@@ -155,11 +173,28 @@ class Bridgetown::Site
       documents.select(&:write?)
     end
 
-    # Get all posts.
+    # Get all loaded resources.
+    # @return [Array<Bridgetown::Resource::Base>] an array of resources
+    def resources
+      collections.each_with_object(Set.new) do |(_, collection), set|
+        set.merge(collection.resources)
+      end.to_a
+    end
+
+    def resources_to_write
+      resources.select(&:write?)
+    end
+
+    # Get all posts. Deprecated, to be removed in v1.0.
     #
     # @return [Collection] Returns {#collections}`["posts"]`, creating it if need be
     # @see Collection
     def posts
+      unless @wrote_deprecation_msg
+        Bridgetown::Deprecator.deprecation_message "Call site.collections.posts " \
+                                                   "instead of site.posts (Ruby code)"
+      end
+      @wrote_deprecation_msg ||= true
       collections["posts"] ||= Bridgetown::Collection.new(self, "posts")
     end
 
@@ -177,7 +212,13 @@ class Bridgetown::Site
     #
     # @return [Array]
     def contents
+      return resources if uses_resource?
+
       pages + documents
     end
+
+    def add_generated_page(generated_page)
+      generated_pages << generated_page
+    end
   end
 end

data/lib/bridgetown-core/concerns/site/processable.rb

@@ -11,6 +11,7 @@ class Bridgetown::Site
     # @see #cleanup
     # @see #write
     def process
+      Bridgetown::Current.site = self
       reset
       read
       generate  # Extensible

data/lib/bridgetown-core/concerns/site/renderable.rb

@@ -29,6 +29,26 @@ class Bridgetown::Site
       end
     end
 
+    def matched_converters_for_convertible(convertible)
+      @layout_converters ||= {}
+
+      if convertible.is_a?(Bridgetown::Layout) && @layout_converters[convertible]
+        return @layout_converters[convertible]
+      end
+
+      matches = converters.select do |converter|
+        if converter.method(:matches).arity == 1
+          converter.matches(convertible.extname)
+        else
+          converter.matches(convertible.extname, convertible)
+        end
+      end
+
+      @layout_converters[convertible] = matches if convertible.is_a?(Bridgetown::Layout)
+
+      matches
+    end
+
     # Renders all documents
     # @return [void]
     def render_docs
@@ -38,6 +58,12 @@ class Bridgetown::Site
             render_regenerated document
           end
         end
+
+        collection.resources.each do |resource|
+          render_with_locale(resource) do
+            resource.transform!
+          end
+        end
       end
     end
 

data/lib/bridgetown-core/concerns/site/writable.rb

@@ -21,17 +21,27 @@ class Bridgetown::Site
     end
 
     # Yields all content objects while looping through {#pages},
-    #   {#static_files_to_write}, and {#docs_to_write}.
+    #   {#static_files_to_write}, {#docs_to_write}, {#resources_to_write}.
     #
     # @yieldparam item [Document, Page, StaticFile]
     #
     # @return [void]
     def each_site_file
-      %w(pages static_files_to_write docs_to_write).each do |type|
+      %w(pages static_files_to_write docs_to_write resources_to_write).each do |type|
         send(type).each do |item|
           yield item
         end
       end
     end
+
+    def resources_cache_manifest
+      resources.each_with_object({}) do |resource, hsh|
+        next if resource.relative_url == ""
+
+        hsh[resource.relative_url] = {
+          id: resource.model.id,
+        }
+      end
+    end
   end
 end

data/lib/bridgetown-core/concerns/validatable.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
 module Bridgetown
+  # TODO: to be retired once the Resource engine is made official
   module Validatable
-    # FIXME: there should be ONE TRUE METHOD to read the YAML frontmatter
-    # in the entire project. Both this and the equivalent Document method
-    # should be extracted and generalized.
-    #
     # Read the YAML frontmatter.
     #
     # base - The String path to the dir containing the file.

data/lib/bridgetown-core/configuration.rb

@@ -23,6 +23,9 @@ module Bridgetown
       "includes_dir"         => "_includes",
       "partials_dir"         => "_partials",
       "collections"          => {},
+      "taxonomies"           => {
+        category: { key: "categories", title: "Category" }, tag: { key: "tags", title: "Tag" },
+      },
 
       # Handling Reading
       "include"              => [".htaccess", "_redirects", ".well-known"],
@@ -32,6 +35,7 @@ module Bridgetown
       "markdown_ext"         => "markdown,mkdown,mkdn,mkd,md",
       "strict_front_matter"  => false,
       "slugify_categories"   => true,
+      "slugify_mode"         => "pretty",
 
       # Filtering Content
       "limit_posts"          => 0,
@@ -56,7 +60,7 @@ module Bridgetown
       # Output Configuration
       "available_locales"    => ["en"],
       "default_locale"       => "en",
-      "permalink"            => "date",
+      "permalink"            => nil, # default is set according to content engine
       "timezone"             => nil, # use the local timezone
 
       "quiet"                => false,
@@ -70,15 +74,16 @@ module Bridgetown
       },
 
       "kramdown"             => {
-        "auto_ids"      => true,
-        "toc_levels"    => (1..6).to_a,
-        "entity_output" => "as_char",
-        "smart_quotes"  => "lsquo,rsquo,ldquo,rdquo",
-        "input"         => "GFM",
-        "hard_wrap"     => false,
-        "guess_lang"    => true,
-        "footnote_nr"   => 1,
-        "show_warnings" => false,
+        "auto_ids"                => true,
+        "toc_levels"              => (1..6).to_a,
+        "entity_output"           => "as_char",
+        "smart_quotes"            => "lsquo,rsquo,ldquo,rdquo",
+        "input"                   => "GFM",
+        "hard_wrap"               => false,
+        "guess_lang"              => true,
+        "footnote_nr"             => 1,
+        "show_warnings"           => false,
+        "include_extraction_tags" => false,
       },
     }.each_with_object(Configuration.new) { |(k, v), hsh| hsh[k] = v.freeze }.freeze
 
@@ -95,8 +100,8 @@ module Bridgetown
       # user_config - a Hash or Configuration of overrides.
       #
       # Returns a Configuration filled with defaults.
-      def from(user_config)
-        Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config])
+      def from(user_config, starting_defaults = DEFAULTS)
+        Utils.deep_merge_hashes(starting_defaults.deep_dup, Configuration[user_config])
           .merge_environment_specific_options!
           .add_default_collections
           .add_default_excludes
@@ -139,7 +144,7 @@ module Bridgetown
     def safe_load_file(filename)
       case File.extname(filename)
       when %r!\.toml!i
-        Bridgetown::External.require_with_graceful_fail("tomlrb") unless defined?(Tomlrb)
+        Bridgetown::Utils::RequireGems.require_with_graceful_fail("tomlrb") unless defined?(Tomlrb)
         Tomlrb.load_file(filename)
       when %r!\.ya?ml!i
         SafeYAML.load_file(filename) || {}
@@ -242,23 +247,38 @@ module Bridgetown
       self
     end
 
-    def add_default_collections
+    def add_default_collections # rubocop:todo all
       # It defaults to `{}`, so this is only if someone sets it to null manually.
-      return self if self["collections"].nil?
+      return self if self[:collections].nil?
 
       # Ensure we have a hash.
-      if self["collections"].is_a?(Array)
-        self["collections"] = self["collections"].each_with_object({}) do |collection, hash|
+      if self[:collections].is_a?(Array)
+        self[:collections] = self[:collections].each_with_object({}) do |collection, hash|
           hash[collection] = {}
         end
       end
 
-      self["collections"] = Utils.deep_merge_hashes(
-        { "posts" => {} }, self["collections"]
-      ).tap do |collections|
-        collections["posts"]["output"] = true
-        if self["permalink"]
-          collections["posts"]["permalink"] ||= style_to_permalink(self["permalink"])
+      # Setup default collections
+      self[:collections][:posts] = {} unless self[:collections][:posts]
+      self[:collections][:posts][:output] = true
+      self[:collections][:posts][:sort_direction] ||= "descending"
+
+      if self[:content_engine] == "resource"
+        self[:permalink] = "pretty" if self[:permalink].blank?
+        self[:collections][:pages] = {} unless self[:collections][:pages]
+        self[:collections][:pages][:output] = true
+        self[:collections][:pages][:permalink] ||= "/:path/"
+
+        self[:collections][:data] = {} unless self[:collections][:data]
+        self[:collections][:data][:output] = false
+
+        unless self[:collections][:posts][:permalink]
+          self[:collections][:posts][:permalink] = self[:permalink]
+        end
+      else
+        self[:permalink] = "date" if self[:permalink].blank?
+        unless self[:collections][:posts][:permalink]
+          self[:collections][:posts][:permalink] = style_to_permalink(self[:permalink])
         end
       end
 
@@ -284,9 +304,9 @@ module Bridgetown
         self["ruby_in_front_matter"]
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity #
-    def style_to_permalink(permalink_style)
-      case permalink_style.to_sym
+    # Deprecated, to be removed when Bridgetown goes Resource-only
+    def style_to_permalink(permalink_style) # rubocop:todo Metrics/CyclomaticComplexity
+      case permalink_style.to_s.to_sym
       when :pretty
         "/:categories/:year/:month/:day/:title/"
       when :simple
@@ -303,7 +323,6 @@ module Bridgetown
         permalink_style.to_s
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity #
 
     def check_include_exclude
       %w(include exclude).each do |option|
@@ -314,8 +333,10 @@ module Bridgetown
               "'#{option}' should be set as an array, but was: #{self[option].inspect}."
       end
 
-      # add _pages to includes set
-      self[:include] << "_pages"
+      unless self[:include].include?("_pages") || self[:content_engine] == "resource"
+        # add _pages to includes set
+        self[:include] << "_pages"
+      end
 
       self
     end