class Jekyll::Archives::Archive

Constants

ATTRIBUTES_FOR_LIQUID

Attributes for Liquid templates

Attributes

posts[RW]
slug[RW]
type[RW]

Public Class Methods

new(site, title, type, posts) click to toggle source

Initialize a new Archive page

site - The Site object. title - The name of the tag/category or a Hash of the year/month/day in case of date.

e.g. { :year => 2014, :month => 08 } or "my-category" or "my-tag".

type - The type of archive. Can be one of “year”, “month”, “day”, “category”, or “tag” posts - The array of posts that belong in this archive.

# File lib/jekyll-archives/archive.rb, line 27
def initialize(site, title, type, posts)
  @site   = site
  @posts  = posts
  @type   = type
  @title  = title
  @config = site.config["jekyll-archives"]

  # Generate slug if tag or category
  # (taken from jekyll/jekyll/features/support/env.rb)
  @slug = Utils.slugify(title) if title.is_a? String

  # Use ".html" for file extension and url for path
  @ext  = File.extname(relative_path)
  @path = relative_path
  @name = File.basename(relative_path, @ext)

  @data = {
    "layout" => layout,
  }
  @content = ""
end

Public Instance Methods

date() click to toggle source

Produce a date object if a date-based archive

Returns a Date.

# File lib/jekyll-archives/archive.rb, line 105
def date
  if @title.is_a? Hash
    args = @title.values.map(&:to_i)
    Date.new(*args)
  end
end
inspect() click to toggle source

Returns the object as a debug String.

# File lib/jekyll-archives/archive.rb, line 122
def inspect
  "#<Jekyll:Archive @type=#{@type} @title=#{@title} @data=#{@data.inspect}>"
end
layout() click to toggle source

The layout to use for rendering

Returns the layout as a String

# File lib/jekyll-archives/archive.rb, line 59
def layout
  if @config["layouts"] && @config["layouts"][type]
    @config["layouts"][type]
  else
    @config["layout"]
  end
end
relative_path() click to toggle source

Obtain the write path relative to the destination directory

Returns the destination relative path String.

# File lib/jekyll-archives/archive.rb, line 115
def relative_path
  path = URL.unescape_path(url).gsub(%r!^\/!, "")
  path = File.join(path, "index.html") if url =~ %r!\/$!
  path
end
template() click to toggle source

The template of the permalink.

Returns the template String.

# File lib/jekyll-archives/archive.rb, line 52
def template
  @config["permalinks"][type]
end
title() click to toggle source

Produce a title object suitable for Liquid based on type of archive.

Returns a String (for tag and category archives) and nil for date-based archives.

# File lib/jekyll-archives/archive.rb, line 98
def title
  @title if @title.is_a? String
end
url() click to toggle source

The generated relative url of this page. e.g. /about.html.

Returns the String url.

# File lib/jekyll-archives/archive.rb, line 80
def url
  @url ||= URL.new(
    :template     => template,
    :placeholders => url_placeholders,
    :permalink    => nil
  ).to_s
rescue ArgumentError
  raise ArgumentError, "Template \"#{template}\" provided is invalid."
end
url_placeholders() click to toggle source

Returns a hash of URL placeholder names (as symbols) mapping to the desired placeholder replacements. For details see “url.rb”.

# File lib/jekyll-archives/archive.rb, line 69
def url_placeholders
  if @title.is_a? Hash
    @title.merge(:type => @type)
  else
    { :name => @slug, :type => @type }
  end
end