bridgetown-core 0.19.3 → 0.21.0.beta4

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
@@ -41,8 +42,6 @@ class Bridgetown::Site
       @liquid_renderer.reset
       frontmatter_defaults.reset
 
-      raise ArgumentError, "limit_posts must be a non-negative number" if limit_posts.negative?
-
       Bridgetown::Cache.clear_if_config_changed config
       Bridgetown::Hooks.trigger :site, :after_reset, self
     end
@@ -60,8 +59,11 @@ class Bridgetown::Site
 
     # Limits the current posts; removes the posts which exceed the limit_posts
     def limit_posts!
-      if limit_posts.positive?
-        limit = posts.docs.length < limit_posts ? posts.docs.length : limit_posts
+      if config.limit_posts.positive?
+        Bridgetown::Deprecator.deprecation_message(
+          "The limit_posts config option will be removed prior to Bridgetown 1.0"
+        )
+        limit = posts.docs.length < config.limit_posts ? posts.docs.length : config.limit_posts
         posts.docs = posts.docs[-limit, limit]
       end
     end

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.
@@ -22,7 +19,7 @@ module Bridgetown
                                  **Utils.merged_file_read_opts(site, opts))
         if content =~ Document::YAML_FRONT_MATTER_REGEXP
           self.content = $POSTMATCH
-          self.data = SafeYAML.load(Regexp.last_match(1))&.with_dot_access
+          self.data = YAMLParser.load(Regexp.last_match(1))&.with_dot_access
         end
       rescue Psych::SyntaxError => e
         Bridgetown.logger.warn "YAML Exception reading #{filename}: #{e.message}"

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
@@ -113,7 +118,7 @@ module Bridgetown
     # override - the command-line options hash
     #
     # Returns the path to the Bridgetown root directory
-    def root_dir(override)
+    def root_dir(override = "")
       get_config_value_with_override("root_dir", override)
     end
 
@@ -122,7 +127,7 @@ module Bridgetown
     # override - the command-line options hash
     #
     # Returns the path to the Bridgetown source directory
-    def source(override)
+    def source(override = "")
       get_config_value_with_override("source", override)
     end
 
@@ -139,10 +144,10 @@ 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) || {}
+        YAMLParser.load_file(filename) || {}
       else
         raise ArgumentError,
               "No parser for '#{filename}' is available. Use a .y(a)ml or .toml file instead."
@@ -221,7 +226,7 @@ module Bridgetown
         raise ArgumentError, "Configuration file: (INVALID) #{file}".yellow
       end
 
-      Bridgetown.logger.info "Configuration file:", file
+      Bridgetown.logger.debug "Configuration file:", file
       next_config
     rescue SystemCallError
       if @default_config_file ||= nil
@@ -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,10 +333,19 @@ 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
+
+    # Whether or not PostCSS is being used to process stylesheets.
+    #
+    # @return [Boolean] true if `postcss.config.js` exists, false if not
+    def uses_postcss?
+      File.exist?(Bridgetown.sanitized_path(root_dir, "postcss.config.js"))
+    end
   end
 end

data/lib/bridgetown-core/configurations/bt-postcss.rb

@@ -4,23 +4,23 @@
 
 TEMPLATE_PATH = File.expand_path("./bt-postcss", __dir__)
 
-begin
-  find_in_source_paths("postcss.config.js")
-rescue Thor::Error
+unless File.exist?("postcss.config.js")
   error_message = "#{"postcss.config.js".bold} not found. Please configure postcss in your project."
 
   @logger.error "\nError:".red, "🚨 #{error_message}"
-  @logger.info "\nFor new projects, you can use #{"bridgetown new my_project --use-postcss".bold.blue}\n"
+  @logger.info "\nRun #{"bridgetown webpack enable-postcss".bold.blue} to set it up.\n"
 
   return
 end
 
+confirm = ask "This configuration will ovewrite your existing #{"postcss.config.js".bold.white}. Would you like to continue? [Yn]"
+return unless confirm.casecmp?("Y")
+
 plugins = %w(postcss-easy-import postcss-mixins postcss-color-function cssnano)
 
 say "Adding the following PostCSS plugins: #{plugins.join(' | ')}", :green
 run "yarn add -D #{plugins.join(' ')}"
 
-remove_file "postcss.config.js"
-copy_file "#{TEMPLATE_PATH}/postcss.config.js", "postcss.config.js"
+copy_file "#{TEMPLATE_PATH}/postcss.config.js", "postcss.config.js", force: true
 
 # rubocop:enable all

data/lib/bridgetown-core/configurations/netlify.rb

@@ -4,3 +4,4 @@ TEMPLATE_PATH = File.expand_path("./netlify", __dir__)
 
 copy_file "#{TEMPLATE_PATH}/netlify.toml", "netlify.toml"
 copy_file "#{TEMPLATE_PATH}/netlify.sh", "bin/netlify.sh"
+`chmod a+x ./bin/netlify.sh`

data/lib/bridgetown-core/configurations/tailwindcss.rb

@@ -4,22 +4,22 @@
 
 TEMPLATE_PATH = File.expand_path("./tailwindcss", __dir__)
 
-begin
-  find_in_source_paths("postcss.config.js")
-rescue Thor::Error
+unless File.exist?("postcss.config.js")
   error_message = "#{"postcss.config.js".bold} not found. Please configure postcss in your project."
 
   @logger.error "\nError:".red, "🚨 #{error_message}"
-  @logger.info "\nFor new projects, you can use #{"bridgetown new my_project --use-postcss".bold.blue}\n"
+  @logger.info "\nRun #{"bridgetown webpack enable-postcss".bold.blue} to set it up.\n"
 
   return
 end
 
+confirm = ask "This configuration will ovewrite your existing #{"postcss.config.js".bold.white}. Would you like to continue? [Yn]"
+return unless confirm.casecmp?("Y")
+
 run "yarn add -D tailwindcss"
 run "npx tailwindcss init"
 
-remove_file "postcss.config.js"
-copy_file "#{TEMPLATE_PATH}/postcss.config.js", "postcss.config.js"
+copy_file "#{TEMPLATE_PATH}/postcss.config.js", "postcss.config.js", force: true
 
 prepend_to_file "frontend/styles/index.css",
                 File.read("#{TEMPLATE_PATH}/css_imports.css")

data/lib/bridgetown-core/converter.rb

@@ -23,6 +23,16 @@ module Bridgetown
       @config = config
     end
 
+    # Logic to do the content conversion.
+    #
+    # @param content [String] content of file (without front matter).
+    # @param convertible [Bridgetown::Document, Bridgetown::Layout, Bridgetown::Resource::Base]
+    #
+    # @return [String] the converted content.
+    def convert(content, convertible = nil) # rubocop:disable Lint/UnusedMethodArgument
+      content
+    end
+
     # Does the given extension match this converter's list of acceptable extensions?
     #
     # @param [String] ext
@@ -42,5 +52,18 @@ module Bridgetown
     def output_ext(_ext)
       ".html"
     end
+
+    def line_start(convertible)
+      if convertible.is_a?(Bridgetown::Resource::Base) &&
+          convertible.model.origin.respond_to?(:front_matter_line_count)
+        convertible.model.origin.front_matter_line_count + 4
+      else
+        1
+      end
+    end
+
+    def inspect
+      "#<#{self.class}#{self.class.extname_list ? " #{self.class.extname_list.join(", ")}" : nil}>"
+    end
   end
 end

data/lib/bridgetown-core/converters/erb_templates.rb

@@ -3,14 +3,26 @@
 require "tilt/erubi"
 
 module Bridgetown
-  class ERBBuffer < String
-    def concat_to_s(input)
-      concat input.to_s
+  class OutputBuffer < ActiveSupport::SafeBuffer
+    def initialize(*)
+      super
+      encode!
     end
 
-    alias_method :safe_append=, :concat_to_s
-    alias_method :append=, :concat_to_s
-    alias_method :safe_expr_append=, :concat_to_s
+    def <<(value)
+      return self if value.nil?
+
+      super(value.to_s)
+    end
+    alias_method :append=, :<<
+
+    def safe_expr_append=(val)
+      return self if val.nil? # rubocop:disable Lint/ReturnInVoidContext
+
+      safe_concat val.to_s
+    end
+
+    alias_method :safe_append=, :safe_concat
   end
 
   class ERBEngine < Erubi::Engine
@@ -22,24 +34,47 @@ module Bridgetown
       @src << ";" unless code[Erubi::RANGE_LAST] == "\n"
     end
 
+    def add_text(text)
+      return if text.empty?
+
+      src << bufvar << ".safe_append='"
+      src << text.gsub(%r{['\\]}, '\\\\\&')
+      src << "'.freeze;"
+    end
+
     # pulled from Rails' ActionView
     BLOCK_EXPR = %r!\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z!.freeze
 
     def add_expression(indicator, code)
+      src << bufvar << if (indicator == "==") || @escape
+                         ".safe_expr_append="
+                       else
+                         ".append="
+                       end
+
       if BLOCK_EXPR.match?(code)
-        src << "#{@bufvar}.append= " << code
+        src << " " << code
       else
-        super
+        src << "(" << code << ");"
       end
     end
+  end
 
-    # Don't allow == to output escaped strings, as that's the opposite of Rails
-    def add_expression_result_escaped(code)
-      add_expression_result(code)
+  module ERBCapture
+    def capture(*args)
+      previous_buffer_state = @_erbout
+      @_erbout = OutputBuffer.new
+      result = yield(*args)
+      result = @_erbout.presence || result
+      @_erbout = previous_buffer_state
+
+      result.is_a?(String) ? ERB::Util.h(result) : result
     end
   end
 
   class ERBView < RubyTemplateView
+    include ERBCapture
+
     def h(input)
       Erubi.h(input)
     end
@@ -55,30 +90,10 @@ module Bridgetown
       Tilt::ErubiTemplate.new(
         site.in_source_dir(site.config[:partials_dir], "#{partial_name}.erb"),
         outvar: "@_erbout",
-        bufval: "Bridgetown::ERBBuffer.new",
+        bufval: "Bridgetown::OutputBuffer.new",
         engine_class: ERBEngine
       ).render(self, options)
     end
-
-    def markdownify(input = nil, &block)
-      content = Bridgetown::Utils.reindent_for_markdown(
-        block.nil? ? input.to_s : capture(&block)
-      )
-      converter = site.find_converter_instance(Bridgetown::Converters::Markdown)
-      result = converter.convert(content).strip
-      result.respond_to?(:html_safe) ? result.html_safe : result
-    end
-
-    def capture(*args, &block)
-      return capture_in_view_component(*args, &block) if @in_view_component
-
-      previous_buffer_state = @_erbout
-      @_erbout = ERBBuffer.new
-      result = yield(*args)
-      @_erbout = previous_buffer_state
-
-      result.respond_to?(:html_safe) ? result.html_safe : result
-    end
   end
 
   module Converters
@@ -89,7 +104,7 @@ module Bridgetown
       # Logic to do the ERB content conversion.
       #
       # @param content [String] Content of the file (without front matter).
-      # @params convertible [Bridgetown::Page, Bridgetown::Document, Bridgetown::Layout]
+      # @param convertible [Bridgetown::Page, Bridgetown::Document, Bridgetown::Layout]
       #   The instantiated object which is processing the file.
       #
       # @return [String] The converted content.
@@ -100,14 +115,15 @@ module Bridgetown
 
         erb_renderer = Tilt::ErubiTemplate.new(
           convertible.relative_path,
+          line_start(convertible),
           outvar: "@_erbout",
-          bufval: "Bridgetown::ERBBuffer.new",
+          bufval: "Bridgetown::OutputBuffer.new",
           engine_class: ERBEngine
         ) { content }
 
         if convertible.is_a?(Bridgetown::Layout)
           erb_renderer.render(erb_view) do
-            convertible.current_document_output
+            convertible.current_document_output.html_safe
           end
         else
           erb_renderer.render(erb_view)