bridgetown-core 0.20.0 → 0.21.0

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

@@ -11,7 +11,7 @@ module Bridgetown
     end
 
     def no_layout?
-      data["layout"] == "none" || data["layout"] == false
+      data.layout.nil? || data.layout == "none" || data.layout == false
     end
   end
 end

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

@@ -18,18 +18,13 @@ class Bridgetown::Site
       @root_dir        = File.expand_path(config["root_dir"]).freeze
       @source          = File.expand_path(config["source"]).freeze
       @dest            = File.expand_path(config["destination"]).freeze
-      @cache_dir       = in_root_dir(config["cache_dir"]).freeze
-
-      %w(lsi highlighter baseurl exclude include future unpublished
-         limit_posts keep_files).each do |opt|
-        send("#{opt}=", config[opt])
-      end
 
       configure_cache
       configure_component_paths
       configure_include_paths
       configure_file_read_opts
 
+      self.baseurl = config.baseurl
       self.permalink_style = (config["permalink"] || "pretty").to_sym
 
       @config
@@ -153,7 +148,8 @@ class Bridgetown::Site
 
     # Disable Marshaling cache to disk in Safe Mode
     def configure_cache
-      Bridgetown::Cache.cache_dir = in_root_dir(config["cache_dir"], "Bridgetown/Cache")
+      @cache_dir = in_root_dir(config["cache_dir"]).freeze
+      Bridgetown::Cache.cache_dir = File.join(cache_dir, "Bridgetown/Cache")
       Bridgetown::Cache.disable_disk_cache! if config["disable_disk_cache"]
     end
 

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

@@ -173,9 +173,8 @@ class Bridgetown::Site
       documents.select(&:write?)
     end
 
-    # Get all documents.
-    # @return [Array<Document>] an array of documents from the
-    # configuration
+    # 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)

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

@@ -5,13 +5,11 @@ class Bridgetown::Site
     # Returns the current and/or default configured locale
     # @return String
     def locale
-      if @locale
-        @locale
-      else
-        @locale = ENV.fetch("BRIDGETOWN_LOCALE", config[:default_locale]).to_sym
+      @locale ||= begin
+        locale = ENV.fetch("BRIDGETOWN_LOCALE", config[:default_locale]).to_sym
         I18n.load_path << Dir[in_source_dir("_locales") + "/*.yml"]
         I18n.available_locales = config[:available_locales]
-        I18n.default_locale = @locale
+        I18n.default_locale = locale
       end
     end
 

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

@@ -42,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
@@ -61,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/writable.rb

@@ -21,7 +21,7 @@ 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]
     #

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

@@ -3,10 +3,6 @@
 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.
@@ -23,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

@@ -74,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
 
@@ -117,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
 
@@ -126,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
 
@@ -143,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."
@@ -225,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
@@ -339,5 +340,12 @@ module Bridgetown
 
       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

@@ -53,6 +53,15 @@ module Bridgetown
       ".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

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)

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

@@ -18,7 +18,7 @@ module Bridgetown
       # Logic to do the Liquid 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.

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

@@ -69,7 +69,7 @@ module Bridgetown
           end
         else
           output = @parser.convert(content)
-          if @parser.respond_to?(:extractions)
+          if convertible && @parser.respond_to?(:extractions)
             convertible.data.markdown_extractions = @parser.extractions
           end
           output