Class: Jekyll::Archives::Archive

Inherits:
Page
  • Object
show all
Defined in:
lib/jekyll-archives/archive.rb

Constant Summary collapse

ATTRIBUTES_FOR_LIQUID =

Attributes for Liquid templates

%w(
  posts
  type
  title
  date
  name
  path
  url
  permalink
).freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(site, title, type, posts) ⇒ Archive

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.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# 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"]
  @slug   = slugify_string_title

  # 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

Instance Attribute Details

#posts ⇒ Object

Returns the value of attribute posts.



6
7
8
 
# File 'lib/jekyll-archives/archive.rb', line 6

def posts
  @posts
end

#slug ⇒ Object

Returns the value of attribute slug.



6
7
8
 
# File 'lib/jekyll-archives/archive.rb', line 6

def slug
  @slug
end

#type ⇒ Object

Returns the value of attribute type.



6
7
8
 
# File 'lib/jekyll-archives/archive.rb', line 6

def type
  @type
end

Instance Method Details

#date ⇒ Object

Produce a date object if a date-based archive

Returns a Date.



98
99
100
101
102
103
104
105
 
# File 'lib/jekyll-archives/archive.rb', line 98

def date
  return unless @title.is_a?(Hash)

  @date ||= begin
    args = @title.values.map(&:to_i)
    Date.new(*args)
  end
end

#inspect ⇒ Object

Returns the object as a debug String.



119
120
121
 
# File 'lib/jekyll-archives/archive.rb', line 119

def inspect
  "#<Jekyll:Archive @type=#{@type} @title=#{@title} @data=#{@data.inspect}>"
end

#layout ⇒ Object

The layout to use for rendering

Returns the layout as a String



56
57
58
 
# File 'lib/jekyll-archives/archive.rb', line 56

def layout
  @config.dig("layouts", type) || @config["layout"]
end

#permalink ⇒ Object 



83
84
85
 
# File 'lib/jekyll-archives/archive.rb', line 83

def permalink
  data&.is_a?(Hash) && data["permalink"]
end

#relative_path ⇒ Object

Obtain the write path relative to the destination directory

Returns the destination relative path String.



110
111
112
113
114
115
116
 
# File 'lib/jekyll-archives/archive.rb', line 110

def relative_path
  @relative_path ||= begin
    path = URL.unescape_path(url).gsub(%r!^/!, "")
    path = File.join(path, "index.html") if url.end_with?("/")
    path
  end
end

#template ⇒ Object

The template of the permalink.

Returns the template String.



49
50
51
 
# File 'lib/jekyll-archives/archive.rb', line 49

def template
  @config.dig("permalinks", type)
end

#title ⇒ Object

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.



91
92
93
 
# File 'lib/jekyll-archives/archive.rb', line 91

def title
  @title if @title.is_a? String
end

#url ⇒ Object

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

Returns the String url.



73
74
75
76
77
78
79
80
81
 
# File 'lib/jekyll-archives/archive.rb', line 73

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 ⇒ Object

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



62
63
64
65
66
67
68
 
# File 'lib/jekyll-archives/archive.rb', line 62

def url_placeholders
  if @title.is_a? Hash
    @title.merge(:type => @type)
  else
    { :name => @slug, :type => @type }
  end
end