Class: Jekyll::Archives::Archive
- Inherits:
-
Page
- Object
- Page
- Jekyll::Archives::Archive
- 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
-
#posts ⇒ Object
Returns the value of attribute posts.
-
#slug ⇒ Object
Returns the value of attribute slug.
-
#type ⇒ Object
Returns the value of attribute type.
Instance Method Summary collapse
-
#date ⇒ Object
Produce a date object if a date-based archive.
-
#initialize(site, title, type, posts) ⇒ Archive
constructor
Initialize a new Archive page.
-
#inspect ⇒ Object
Returns the object as a debug String.
-
#layout ⇒ Object
The layout to use for rendering.
- #permalink ⇒ Object
-
#relative_path ⇒ Object
Obtain the write path relative to the destination directory.
-
#template ⇒ Object
The template of the permalink.
-
#title ⇒ Object
Produce a title object suitable for Liquid based on type of archive.
-
#url ⇒ Object
The generated relative url of this page.
-
#url_placeholders ⇒ Object
Returns a hash of URL placeholder names (as symbols) mapping to the desired placeholder replacements.
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 45 46 47 |
# 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 |
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.
105 106 107 108 109 110 |
# 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 ⇒ Object
Returns the object as a debug String.
122 123 124 |
# File 'lib/jekyll-archives/archive.rb', line 122 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
59 60 61 62 63 64 65 |
# File 'lib/jekyll-archives/archive.rb', line 59 def layout if @config["layouts"] && @config["layouts"][type] @config["layouts"][type] else @config["layout"] end end |
#permalink ⇒ Object
90 91 92 |
# File 'lib/jekyll-archives/archive.rb', line 90 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.
115 116 117 118 119 |
# 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 ⇒ Object
The template of the permalink.
Returns the template String.
52 53 54 |
# File 'lib/jekyll-archives/archive.rb', line 52 def template @config["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.
98 99 100 |
# File 'lib/jekyll-archives/archive.rb', line 98 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.
80 81 82 83 84 85 86 87 88 |
# 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 ⇒ Object
Returns a hash of URL placeholder names (as symbols) mapping to the desired placeholder replacements. For details see “url.rb”.
69 70 71 72 73 74 75 |
# 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 |