module Jekyll::Filters::URLFilters

Public Instance Methods

absolute_url(input) click to toggle source

Produces an absolute URL based on site.url and site.baseurl.

input - the URL to make absolute.

Returns the absolute URL as a String.

# File lib/jekyll/filters/url_filters.rb, line 11
def absolute_url(input)
  return if input.nil?

  cache = if input.is_a?(String)
            (@context.registers[:site].filter_cache[:absolute_url] ||= {})
          else
            (@context.registers[:cached_absolute_url] ||= {})
          end
  cache[input] ||= compute_absolute_url(input)

  # Duplicate cached string so that the cached value is never mutated by
  # a subsequent filter.
  cache[input].dup
end
relative_url(input) click to toggle source

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.

# File lib/jekyll/filters/url_filters.rb, line 32
def relative_url(input)
  return if input.nil?

  cache = if input.is_a?(String)
            (@context.registers[:site].filter_cache[:relative_url] ||= {})
          else
            (@context.registers[:cached_relative_url] ||= {})
          end
  cache[input] ||= compute_relative_url(input)

  # Duplicate cached string so that the cached value is never mutated by
  # a subsequent filter.
  cache[input].dup
end
strip_index(input) click to toggle source

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

# File lib/jekyll/filters/url_filters.rb, line 52
def strip_index(input)
  return if input.nil? || input.to_s.empty?

  input.sub(%r!/index\.html?$!, "/")
end

Private Instance Methods

compute_absolute_url(input) click to toggle source
# File lib/jekyll/filters/url_filters.rb, line 60
def compute_absolute_url(input)
  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
compute_relative_url(input) click to toggle source
# File lib/jekyll/filters/url_filters.rb, line 73
def compute_relative_url(input)
  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.map! { |part| ensure_leading_slash(part.to_s) }.join
  ).normalize.to_s
end
ensure_leading_slash(input) click to toggle source
# File lib/jekyll/filters/url_filters.rb, line 91
def ensure_leading_slash(input)
  return input if input.nil? || input.empty? || input.start_with?("/")

  "/#{input}"
end
sanitized_baseurl() click to toggle source
# File lib/jekyll/filters/url_filters.rb, line 83
def sanitized_baseurl
  site = @context.registers[:site]
  baseurl = site.config["baseurl"]
  return "" if baseurl.nil?

  baseurl.to_s.chomp("/")
end