bridgetown-core 0.7.0 → 0.7.1

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

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Filters
+    module DateFilters
+      # Format a date in short format e.g. "27 Jan 2011".
+      # Ordinal format is also supported, in both the UK
+      # (e.g. "27th Jan 2011") and US ("e.g. Jan 27th, 2011") formats.
+      # UK format is the default.
+      #
+      # date - the Time to format.
+      # type - if "ordinal" the returned String will be in ordinal format
+      # style - if "US" the returned String will be in US format.
+      #         Otherwise it will be in UK format.
+      #
+      # Returns the formatting String.
+      def date_to_string(date, type = nil, style = nil)
+        stringify_date(date, "%b", type, style)
+      end
+
+      # Format a date in long format e.g. "27 January 2011".
+      # Ordinal format is also supported, in both the UK
+      # (e.g. "27th January 2011") and US ("e.g. January 27th, 2011") formats.
+      # UK format is the default.
+      #
+      # date - the Time to format.
+      # type - if "ordinal" the returned String will be in ordinal format
+      # style - if "US" the returned String will be in US format.
+      #         Otherwise it will be in UK format.
+      #
+      # Returns the formatted String.
+      def date_to_long_string(date, type = nil, style = nil)
+        stringify_date(date, "%B", type, style)
+      end
+
+      # Format a date for use in XML.
+      #
+      # date - The Time to format.
+      #
+      # Examples
+      #
+      #   date_to_xmlschema(Time.now)
+      #   # => "2011-04-24T20:34:46+08:00"
+      #
+      # Returns the formatted String.
+      def date_to_xmlschema(date)
+        return date if date.to_s.empty?
+
+        time(date).xmlschema
+      end
+
+      # Format a date according to RFC-822
+      #
+      # date - The Time to format.
+      #
+      # Examples
+      #
+      #   date_to_rfc822(Time.now)
+      #   # => "Sun, 24 Apr 2011 12:34:46 +0000"
+      #
+      # Returns the formatted String.
+      def date_to_rfc822(date)
+        return date if date.to_s.empty?
+
+        time(date).rfc822
+      end
+
+      private
+
+      # month_type: Notations that evaluate to 'Month' via `Time#strftime` ("%b", "%B")
+      # type: nil (default) or "ordinal"
+      # style: nil (default) or "US"
+      #
+      # Returns a stringified date or the empty input.
+      def stringify_date(date, month_type, type = nil, style = nil)
+        return date if date.to_s.empty?
+
+        time = time(date)
+        if type == "ordinal"
+          day = time.day
+          ordinal_day = "#{day}#{ordinal(day)}"
+          return time.strftime("#{month_type} #{ordinal_day}, %Y") if style == "US"
+
+          return time.strftime("#{ordinal_day} #{month_type} %Y")
+        end
+        time.strftime("%d #{month_type} %Y")
+      end
+
+      def ordinal(number)
+        return "th" if (11..13).cover?(number)
+
+        case number % 10
+        when 1 then "st"
+        when 2 then "nd"
+        when 3 then "rd"
+        else "th"
+        end
+      end
+
+      def time(input)
+        date = Liquid::Utils.to_date(input)
+        unless date.respond_to?(:to_time)
+          raise Errors::InvalidDateError,
+                "Invalid Date: '#{input.inspect}' is not a valid datetime."
+        end
+        date.to_time.dup.localtime
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Filters
+    module GroupingFilters
+      # Group an array of items by a property
+      #
+      # input - the inputted Enumerable
+      # property - the property
+      #
+      # Returns an array of Hashes, each looking something like this:
+      #  {"name"  => "larry"
+      #   "items" => [...] } # all the items where `property` == "larry"
+      def group_by(input, property)
+        if groupable?(input)
+          groups = input.group_by { |item| item_property(item, property).to_s }
+          grouped_array(groups)
+        else
+          input
+        end
+      end
+
+      # Group an array of items by an expression
+      #
+      # input - the object array
+      # variable - the variable to assign each item to in the expression
+      # expression -a Liquid comparison expression passed in as a string
+      #
+      # Returns the filtered array of objects
+      def group_by_exp(input, variable, expression)
+        return input unless groupable?(input)
+
+        parsed_expr = parse_expression(expression)
+        @context.stack do
+          groups = input.group_by do |item|
+            @context[variable] = item
+            parsed_expr.render(@context)
+          end
+          grouped_array(groups)
+        end
+      end
+
+      private
+
+      def parse_expression(str)
+        Liquid::Variable.new(str, Liquid::ParseContext.new)
+      end
+
+      def groupable?(element)
+        element.respond_to?(:group_by)
+      end
+
+      def grouped_array(groups)
+        groups.each_with_object([]) do |item, array|
+          array << {
+            "name"  => item.first,
+            "items" => item.last,
+            "size"  => item.last.size,
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Filters
+    module URLFilters
+      # Produces an absolute URL based on site.url and site.baseurl.
+      #
+      # input - the URL to make absolute.
+      #
+      # Returns the absolute URL as a String.
+      def absolute_url(input)
+        cache = (@context.registers[:cached_absolute_urls] ||= {})
+        cache[input] ||= compute_absolute_url(input)
+      end
+
+      # Produces a URL relative to the domain root based on site.baseurl
+      # unless it is already an absolute url with an authority (host).
+      #
+      # input - the URL to make relative to the domain root
+      #
+      # Returns a URL relative to the domain root as a String.
+      def relative_url(input)
+        cache = (@context.registers[:cached_relative_urls] ||= {})
+        cache[input] ||= compute_relative_url(input)
+      end
+
+      # Strips trailing `/index.html` from URLs to create pretty permalinks
+      #
+      # input - the URL with a possible `/index.html`
+      #
+      # Returns a URL with the trailing `/index.html` removed
+      def strip_index(input)
+        return if input.nil? || input.to_s.empty?
+
+        input.sub(%r!/index\.html?$!, "/")
+      end
+
+      private
+
+      def compute_absolute_url(input)
+        return if input.nil?
+
+        input = input.url if input.respond_to?(:url)
+        return input if Addressable::URI.parse(input.to_s).absolute?
+
+        site = @context.registers[:site]
+        site_url = site.config["url"]
+        return relative_url(input) if site_url.nil? || site_url == ""
+
+        Addressable::URI.parse(
+          site_url.to_s + relative_url(input)
+        ).normalize.to_s
+      end
+
+      def compute_relative_url(input)
+        return if input.nil?
+
+        input = input.url if input.respond_to?(:url)
+        return input if Addressable::URI.parse(input.to_s).absolute?
+
+        parts = [sanitized_baseurl, input]
+        Addressable::URI.parse(
+          parts.compact.map { |part| ensure_leading_slash(part.to_s) }.join
+        ).normalize.to_s
+      end
+
+      def sanitized_baseurl
+        site = @context.registers[:site]
+        site.config["baseurl"].to_s.chomp("/")
+      end
+
+      def ensure_leading_slash(input)
+        return input if input.nil? || input.empty? || input.start_with?("/")
+
+        "/#{input}"
+      end
+    end
+  end
+end

data/lib/bridgetown-core/frontmatter_defaults.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  # This class handles custom defaults for YAML frontmatter settings.
+  # These are set in bridgetown.config.yml and apply both to internal use (e.g. layout)
+  # and the data available to liquid.
+  #
+  # It is exposed via the frontmatter_defaults method on the site class.
+  class FrontmatterDefaults
+    # Initializes a new instance.
+    def initialize(site)
+      @site = site
+    end
+
+    def reset
+      @glob_cache = {} if @glob_cache
+    end
+
+    def update_deprecated_types(set)
+      return set unless set.key?("scope") && set["scope"].key?("type")
+
+      set["scope"]["type"] =
+        case set["scope"]["type"]
+        when "page"
+          Deprecator.defaults_deprecate_type("page", "pages")
+          "pages"
+        when "post"
+          Deprecator.defaults_deprecate_type("post", "posts")
+          "posts"
+        else
+          set["scope"]["type"]
+        end
+
+      set
+    end
+
+    def ensure_time!(set)
+      return set unless set.key?("values") && set["values"].key?("date")
+      return set if set["values"]["date"].is_a?(Time)
+
+      set["values"]["date"] = Utils.parse_date(
+        set["values"]["date"],
+        "An invalid date format was found in a front-matter default set: #{set}"
+      )
+      set
+    end
+
+    # Finds a default value for a given setting, filtered by path and type
+    #
+    # path - the path (relative to the source) of the page or
+    # post the default is used in
+    # type - a symbol indicating whether a :page,
+    # a :post calls this method
+    #
+    # Returns the default value or nil if none was found
+    def find(path, type, setting)
+      value = nil
+      old_scope = nil
+
+      matching_sets(path, type).each do |set|
+        if set["values"].key?(setting) && has_precedence?(old_scope, set["scope"])
+          value = set["values"][setting]
+          old_scope = set["scope"]
+        end
+      end
+      value
+    end
+
+    # Collects a hash with all default values for a page or post
+    #
+    # path - the relative path of the page or post
+    # type - a symbol indicating the type (:post or :page)
+    #
+    # Returns a hash with all default values (an empty hash if there are none)
+    def all(path, type)
+      defaults = {}
+      old_scope = nil
+      matching_sets(path, type).each do |set|
+        if has_precedence?(old_scope, set["scope"])
+          defaults = Utils.deep_merge_hashes(defaults, set["values"])
+          old_scope = set["scope"]
+        else
+          defaults = Utils.deep_merge_hashes(set["values"], defaults)
+        end
+      end
+      defaults
+    end
+
+    private
+
+    # 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
+    # path - the path to check for
+    # type - the type (:post or :page) to check for
+    #
+    # Returns true if the scope applies to the given type and path
+    def applies?(scope, path, type)
+      applies_type?(scope, type) && applies_path?(scope, path)
+    end
+
+    def applies_path?(scope, path)
+      rel_scope_path = scope["path"]
+      return true if !rel_scope_path.is_a?(String) || rel_scope_path.empty?
+
+      sanitized_path = sanitize_path(path)
+
+      if rel_scope_path.include?("*")
+        glob_scope(sanitized_path, rel_scope_path)
+      else
+        path_is_subpath?(sanitized_path, strip_collections_dir(rel_scope_path))
+      end
+    end
+
+    def glob_scope(sanitized_path, rel_scope_path)
+      site_source    = Pathname.new(@site.source)
+      abs_scope_path = site_source.join(rel_scope_path).to_s
+
+      glob_cache(abs_scope_path).each do |scope_path|
+        scope_path = Pathname.new(scope_path).relative_path_from(site_source).to_s
+        scope_path = strip_collections_dir(scope_path)
+        Bridgetown.logger.debug "Globbed Scope Path:", scope_path
+        return true if path_is_subpath?(sanitized_path, scope_path)
+      end
+      false
+    end
+
+    def glob_cache(path)
+      @glob_cache ||= {}
+      @glob_cache[path] ||= Dir.glob(path)
+    end
+
+    def path_is_subpath?(path, parent_path)
+      path.start_with?(parent_path)
+    end
+
+    def strip_collections_dir(path)
+      collections_dir  = @site.config["collections_dir"]
+      slashed_coll_dir = collections_dir.empty? ? "/" : "#{collections_dir}/"
+      return path if collections_dir.empty? || !path.to_s.start_with?(slashed_coll_dir)
+
+      path.sub(slashed_coll_dir, "")
+    end
+
+    # Determines whether the scope applies to type.
+    # The scope applies to the type if:
+    #   1. no 'type' is specified
+    #   2. the 'type' in the scope is the same as the type asked about
+    #
+    # scope - the Hash defaults set being asked about application
+    # type  - the type of the document being processed / asked about
+    #         its defaults.
+    #
+    # Returns true if either of the above conditions are satisfied,
+    #   otherwise returns false
+    def applies_type?(scope, type)
+      !scope.key?("type") || scope["type"].eql?(type.to_s)
+    end
+
+    # Checks if a given set of default values is valid
+    #
+    # set - the default value hash, as defined in bridgetown.config.yml
+    #
+    # Returns true if the set is valid and can be used in this class
+    def valid?(set)
+      set.is_a?(Hash) && set["values"].is_a?(Hash)
+    end
+
+    # Determines if a new scope has precedence over an old one
+    #
+    # old_scope - the old scope hash, or nil if there's none
+    # new_scope - the new scope hash
+    #
+    # Returns true if the new scope has precedence over the older
+    # rubocop: disable Naming/PredicateName
+    def has_precedence?(old_scope, new_scope)
+      return true if old_scope.nil?
+
+      new_path = sanitize_path(new_scope["path"])
+      old_path = sanitize_path(old_scope["path"])
+
+      if new_path.length != old_path.length
+        new_path.length >= old_path.length
+      elsif new_scope.key?("type")
+        true
+      else
+        !old_scope.key? "type"
+      end
+    end
+    # rubocop: enable Naming/PredicateName
+
+    # Collects a list of sets that match the given path and type
+    #
+    # Returns an array of hashes
+    def matching_sets(path, type)
+      @matched_set_cache ||= {}
+      @matched_set_cache[path] ||= {}
+      @matched_set_cache[path][type] ||= begin
+        valid_sets.select do |set|
+          !set.key?("scope") || applies?(set["scope"], path, type)
+        end
+      end
+    end
+
+    # Returns a list of valid sets
+    #
+    # This is not cached to allow plugins to modify the configuration
+    # and have their changes take effect
+    #
+    # Returns an array of hashes
+    def valid_sets
+      sets = @site.config["defaults"]
+      return [] unless sets.is_a?(Array)
+
+      sets.map do |set|
+        if valid?(set)
+          ensure_time!(update_deprecated_types(set))
+        else
+          Bridgetown.logger.warn "Defaults:", "An invalid front-matter default set was found:"
+          Bridgetown.logger.warn set.to_s
+          nil
+        end
+      end.compact
+    end
+
+    # Sanitizes the given path by removing a leading and adding a trailing slash
+
+    SANITIZATION_REGEX = %r!\A/|(?<=[^/])\z!.freeze
+
+    def sanitize_path(path)
+      if path.nil? || path.empty?
+        ""
+      else
+        path.gsub(SANITIZATION_REGEX, "")
+      end
+    end
+  end
+end