bridgetown-core 0.15.0 → 0.17.1

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

@@ -8,6 +8,12 @@ module Bridgetown
       highlighter_prefix "\n"
       highlighter_suffix "\n"
 
+      def initialize(config = {})
+        super
+
+        self.class.input @config["markdown_ext"].split(",")
+      end
+
       def setup
         return if @setup ||= false
 
@@ -51,25 +57,6 @@ module Bridgetown
         self.class.constants - [:KramdownParser, :PRIORITIES]
       end
 
-      # Does the given extension match this converter's list of acceptable extensions?
-      # Takes one argument: the file's extension (including the dot).
-      #
-      # ext - The String extension to check.
-      #
-      # Returns true if it matches, false otherwise.
-      def matches(ext)
-        extname_list.include?(ext.downcase)
-      end
-
-      # Public: The extension to be given to the output file (including the dot).
-      #
-      # ext - The String extension or original file.
-      #
-      # Returns The String output file extension.
-      def output_ext(_ext)
-        ".html"
-      end
-
       # Logic to do the content conversion.
       #
       # content - String content of file (without front matter).
@@ -82,10 +69,6 @@ module Bridgetown
         end
       end
 
-      def extname_list
-        @extname_list ||= @config["markdown_ext"].split(",").map! { |e| ".#{e.downcase}" }
-      end
-
       private
 
       def custom_processor

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

@@ -30,16 +30,6 @@ module Bridgetown
         @config[:input] = :SmartyPants
       end
 
-      # Does the given extension match this converter's list of acceptable extensions?
-      # Takes one argument: the file's extension (including the dot).
-      #
-      # ext - The String extension to check.
-      #
-      # Returns true if it matches, false otherwise.
-      def matches(_ext)
-        false
-      end
-
       # Public: The extension to be given to the output file (including the dot).
       #
       # ext - The String extension or original file.

data/lib/bridgetown-core/document.rb

@@ -2,8 +2,12 @@
 
 module Bridgetown
   class Document
-    include Comparable
     extend Forwardable
+    include DataAccessible
+    include Comparable
+    include LayoutPlaceable
+    include LiquidRenderable
+    include Publishable
 
     attr_reader :path, :site, :extname, :collection, :type
     attr_accessor :content, :output
@@ -59,7 +63,7 @@ module Bridgetown
     # Returns a Hash containing the data. An empty hash is returned if
     #   no data was read.
     def data
-      @data ||= ActiveSupport::HashWithIndifferentAccess.new
+      @data ||= HashWithDotAccess::Hash.new
     end
 
     # Merge some data in with this document's data.
@@ -95,6 +99,9 @@ module Bridgetown
       @relative_path ||= path.sub("#{site.collections_path}/", "")
     end
 
+    # FIXME: spinning up a new Renderer object just to get an extension
+    # seems excessive
+    #
     # The output extension of the document.
     #
     # Returns the output extension
@@ -143,38 +150,6 @@ module Bridgetown
       YAML_FILE_EXTS.include?(extname)
     end
 
-    # TODO: Depricated
-    # Used to determine CoffeeScript and Sass/SCSS files.
-    def asset_file?
-      false
-    end
-
-    # Determine whether the file should be rendered with Liquid.
-    #
-    # Returns false if the document is either an asset file or a yaml file,
-    #   or if the document doesn't contain any Liquid Tags or Variables,
-    #   true otherwise.
-    def render_with_liquid?
-      return false if data["render_with_liquid"] == false
-
-      !(yaml_file? || !Utils.has_liquid_construct?(content))
-    end
-
-    # Determine whether the file should be rendered with a layout.
-    #
-    # Returns true if the Front Matter specifies that `layout` is set to `none`.
-    def no_layout?
-      data["layout"] == "none"
-    end
-
-    # Determine whether the file should be placed into layouts.
-    #
-    # Returns false if the document is set to `layouts: none`, or is either an
-    #   asset file or a yaml file. Returns true otherwise.
-    def place_in_layout?
-      !(asset_file? || yaml_file? || no_layout?)
-    end
-
     # The URL template where the document would be accessible.
     #
     # Returns the URL template for the document.
@@ -195,7 +170,7 @@ module Bridgetown
     #
     # Returns the permalink or nil if no permalink was set in the data.
     def permalink
-      data && data.is_a?(Hash) && data["permalink"]
+      data&.permalink
     end
 
     # The computed URL for the document. See `Bridgetown::URL#to_s` for more details.
@@ -209,10 +184,6 @@ module Bridgetown
       ).to_s
     end
 
-    def [](key)
-      data[key]
-    end
-
     # The full path to the output file.
     #
     # base_directory - the base path of the output directory
@@ -243,14 +214,6 @@ module Bridgetown
       trigger_hooks(:post_write)
     end
 
-    # Whether the file is published or not, as indicated in YAML front-matter
-    #
-    # Returns 'false' if the 'published' key is specified in the
-    # YAML front-matter and is 'false'. Otherwise returns 'true'.
-    def published?
-      !(data.key?("published") && data["published"] == false)
-    end
-
     # Read in the file and assign the content and data based on the file contents.
     # Merge the frontmatter of the file with the frontmatter default
     # values
@@ -287,13 +250,6 @@ module Bridgetown
       "#<#{self.class} #{relative_path} collection=#{collection.label}>"
     end
 
-    # The string representation for this document.
-    #
-    # Returns the content of the document
-    def to_s
-      output || content || "NO CONTENT"
-    end
-
     # Compare this document against another document.
     # Comparison is a comparison between the 2 paths of the documents.
     #
@@ -339,7 +295,7 @@ module Bridgetown
 
     def previous_doc
       pos = collection.docs.index { |post| post.equal?(self) }
-      collection.docs[pos - 1] if pos && pos.positive?
+      collection.docs[pos - 1] if pos&.positive?
     end
 
     def trigger_hooks(hook_name, *args)

data/lib/bridgetown-core/drops/site_drop.rb

@@ -8,7 +8,7 @@ module Bridgetown
       mutable false
 
       def_delegator  :@obj, :data
-      def_delegators :@obj, :time, :pages, :static_files, :tags, :categories
+      def_delegators :@obj, :locale, :time, :pages, :static_files, :tags, :categories
 
       private def_delegator :@obj, :config, :fallback_data
 

data/lib/bridgetown-core/errors.rb

@@ -16,5 +16,7 @@ module Bridgetown
     PostURLError                = Class.new(FatalException)
     InvalidURLError             = Class.new(FatalException)
     InvalidConfigurationError   = Class.new(FatalException)
+
+    WebpackAssetError           = Class.new(FatalException)
   end
 end

data/lib/bridgetown-core/excerpt.rb

@@ -3,6 +3,7 @@
 module Bridgetown
   class Excerpt
     extend Forwardable
+    include LiquidRenderable
 
     attr_accessor :doc
     attr_accessor :content, :ext
@@ -91,12 +92,6 @@ module Bridgetown
       false
     end
 
-    def render_with_liquid?
-      return false if data["render_with_liquid"] == false
-
-      !(yaml_file? || !Utils.has_liquid_construct?(content))
-    end
-
     protected
 
     # Internal: Extract excerpt from the content

data/lib/bridgetown-core/filters.rb

@@ -7,6 +7,7 @@ module Bridgetown
     include URLFilters
     include GroupingFilters
     include DateFilters
+    include ConditionHelpers
 
     # Convert a Markdown string into HTML output.
     #
@@ -30,6 +31,7 @@ module Bridgetown
       ).convert(input.to_s)
     end
 
+    # TODO: This should be removed, there is no Sass converter
     # Convert a Sass string into CSS output.
     #
     # input - The Sass String to convert.
@@ -41,6 +43,7 @@ module Bridgetown
       ).convert(input)
     end
 
+    # TODO: This should be removed, there is no Scss converter
     # Convert a Scss string into CSS output.
     #
     # input - The Scss String to convert.
@@ -135,6 +138,14 @@ module Bridgetown
       input.split.length
     end
 
+    # Calculates the average reading time of the supplied content.
+    # @param input [String] the String of content to analyze.
+    # @return [Float] the number of minutes required to read the content.
+    def reading_time(input, round_to = 0)
+      wpm = @context.registers[:site].config[:reading_time_wpm] || 250
+      (number_of_words(input).to_f / wpm).ceil(round_to)
+    end
+
     # Join an array of things into a string by separating with commas and the
     # word "and" for the last one.
     #
@@ -421,54 +432,6 @@ module Bridgetown
         end
       end
     end
-
-    # -----------   The following set of code was *adapted* from Liquid::If
-    # -----------   ref: https://git.io/vp6K6
-
-    # Parse a string to a Liquid Condition
-    def parse_condition(exp)
-      parser    = Liquid::Parser.new(exp)
-      condition = parse_binary_comparison(parser)
-
-      parser.consume(:end_of_string)
-      condition
-    end
-
-    # Generate a Liquid::Condition object from a Liquid::Parser object additionally processing
-    # the parsed expression based on whether the expression consists of binary operations with
-    # Liquid operators `and` or `or`
-    #
-    #  - parser: an instance of Liquid::Parser
-    #
-    # Returns an instance of Liquid::Condition
-    def parse_binary_comparison(parser)
-      condition = parse_comparison(parser)
-      first_condition = condition
-      while (binary_operator = parser.id?("and") || parser.id?("or"))
-        child_condition = parse_comparison(parser)
-        condition.send(binary_operator, child_condition)
-        condition = child_condition
-      end
-      first_condition
-    end
-
-    # Generates a Liquid::Condition object from a Liquid::Parser object based on whether the parsed
-    # expression involves a "comparison" operator (e.g. <, ==, >, !=, etc)
-    #
-    #  - parser: an instance of Liquid::Parser
-    #
-    # Returns an instance of Liquid::Condition
-    def parse_comparison(parser)
-      left_operand = Liquid::Expression.parse(parser.expression)
-      operator     = parser.consume?(:comparison)
-
-      # No comparison-operator detected. Initialize a Liquid::Condition using only left operand
-      return Liquid::Condition.new(left_operand) unless operator
-
-      # Parse what remained after extracting the left operand and the `:comparison` operator
-      # and initialize a Liquid::Condition object using the operands and the comparison-operator
-      Liquid::Condition.new(left_operand, operator, Liquid::Expression.parse(parser.expression))
-    end
   end
 end
 

data/lib/bridgetown-core/filters/condition_helpers.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Filters
+    module ConditionHelpers
+      # -----------   The following set of code was *adapted* from Liquid::If
+      # -----------   ref: https://git.io/vp6K6
+
+      # Parse a string to a Liquid Condition
+      def parse_condition(exp)
+        parser    = Liquid::Parser.new(exp)
+        condition = parse_binary_comparison(parser)
+
+        parser.consume(:end_of_string)
+        condition
+      end
+
+      # Generate a Liquid::Condition object from a Liquid::Parser object additionally processing
+      # the parsed expression based on whether the expression consists of binary operations with
+      # Liquid operators `and` or `or`
+      #
+      #  - parser: an instance of Liquid::Parser
+      #
+      # Returns an instance of Liquid::Condition
+      def parse_binary_comparison(parser)
+        condition = parse_comparison(parser)
+        first_condition = condition
+        while (binary_operator = parser.id?("and") || parser.id?("or"))
+          child_condition = parse_comparison(parser)
+          condition.send(binary_operator, child_condition)
+          condition = child_condition
+        end
+        first_condition
+      end
+
+      # Generates a Liquid::Condition object from a Liquid::Parser object based
+      # on whether the parsed expression involves a "comparison" operator
+      # (e.g. <, ==, >, !=, etc)
+      #
+      #  - parser: an instance of Liquid::Parser
+      #
+      # Returns an instance of Liquid::Condition
+      def parse_comparison(parser)
+        left_operand = Liquid::Expression.parse(parser.expression)
+        operator     = parser.consume?(:comparison)
+
+        # No comparison-operator detected. Initialize a Liquid::Condition using only left operand
+        return Liquid::Condition.new(left_operand) unless operator
+
+        # Parse what remained after extracting the left operand and the `:comparison` operator
+        # and initialize a Liquid::Condition object using the operands and the comparison-operator
+        Liquid::Condition.new(left_operand, operator, Liquid::Expression.parse(parser.expression))
+      end
+    end
+  end
+end

data/lib/bridgetown-core/frontmatter_defaults.rb

@@ -54,6 +54,10 @@ module Bridgetown
     #
     # Returns the default value or nil if none was found
     def find(path, type, setting)
+      merged_data = {}
+      merge_data_cascade_for_path(path, merged_data)
+      return merged_data[setting] if merged_data.key?(setting)
+
       value = nil
       old_scope = nil
 
@@ -74,6 +78,9 @@ module Bridgetown
     # Returns a hash with all default values (an empty hash if there are none)
     def all(path, type)
       defaults = {}
+
+      merge_data_cascade_for_path(path, defaults)
+
       old_scope = nil
       matching_sets(path, type).each do |set|
         if has_precedence?(old_scope, set["scope"])
@@ -88,6 +95,16 @@ module Bridgetown
 
     private
 
+    def merge_data_cascade_for_path(path, merged_data)
+      absolute_path = @site.in_source_dir(path)
+      @site.defaults_reader.path_defaults
+        .select { |k, _v| absolute_path.include? k }
+        .sort_by { |k, _v| k.length }
+        .each do |defaults|
+          merged_data.merge!(defaults[1])
+        end
+    end
+
     # Checks if a given default setting scope matches the given path and type
     #
     # scope - the hash indicating the scope, as defined in bridgetown.config.yml

data/lib/bridgetown-core/layout.rb

@@ -2,7 +2,9 @@
 
 module Bridgetown
   class Layout
-    include Convertible
+    include DataAccessible
+    include LiquidRenderable
+    include Validatable
 
     # Gets the Site object.
     attr_reader :site
@@ -25,6 +27,12 @@ module Bridgetown
     # Gets/Sets the content of this layout.
     attr_accessor :content
 
+    # Gets/Sets the current document (for layout-compatible converters)
+    attr_accessor :current_document
+
+    # Gets/Sets the document output (for layout-compatible converters)
+    attr_accessor :current_document_output
+
     # Initialize a new Layout.
     #
     # site - The Site.
@@ -51,6 +59,14 @@ module Bridgetown
       read_yaml(base, name)
     end
 
+    # The inspect string for this document.
+    # Includes the relative path and the collection label.
+    #
+    # Returns the inspect string for this document.
+    def inspect
+      "#<#{self.class} #{@path}>"
+    end
+
     # Extract information from the layout filename.
     #
     # name - The String filename of the layout file.
@@ -59,5 +75,12 @@ module Bridgetown
     def process(name)
       self.ext = File.extname(name)
     end
+
+    # Provide this Layout's data to a Hash suitable for use by Liquid.
+    #
+    # Returns the Hash representation of this Layout.
+    def to_liquid
+      data
+    end
   end
 end