forked from jekyll/jekyll
/
post.rb
291 lines (256 loc) · 7.58 KB
/
post.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
module Jekyll
class Post < Item
include Comparable
# Valid post name regex.
MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
EXCERPT_ATTRIBUTES_FOR_LIQUID = %w[
title
url
dir
date
id
categories
next
previous
tags
path
]
# Attributes for Liquid templates
ATTRIBUTES_FOR_LIQUID = EXCERPT_ATTRIBUTES_FOR_LIQUID + %w[
content
excerpt
]
# Post name validator. Post filenames must be like:
# 2008-11-05-my-awesome-post.textile
#
# Returns true if valid, false if not.
def self.valid?(name)
name =~ MATCHER
end
attr_accessor :extracted_excerpt, :date, :slug, :published, :tags, :categories
# Initialize this Post instance.
#
# site - The Site.
# path - The String path of the post file.
#
# Returns the new Post.
def initialize(site, path)
super(site, path)
raise NameError, "Invalid filename" unless self.class.valid?(@name)
@dir = File.dirname(path).sub(site.source, '').sub(/(_posts|_drafts)/, '')
self.categories = @dir.downcase.split('/').reject { |x| x.empty? }
process(@name)
read_yaml(path)
if data.has_key?('date')
self.date = Time.parse(data["date"].to_s)
end
published = self.published?
populate_categories
populate_tags
raise RangeError, "Not published" unless published? && (site.future || self.date <= site.time)
site.aggregate_post_info(self)
end
def published?
if self.data.has_key?('published') && self.data['published'] == false
false
else
true
end
end
def populate_categories
if categories.empty?
self.categories = Utils.pluralized_array_from_hash(data, 'category', 'categories').map {|c| c.to_s.downcase}
end
categories.flatten!
end
def populate_tags
self.tags = Utils.pluralized_array_from_hash(data, "tag", "tags").flatten
end
# Read the YAML frontmatter.
#
# base - The String path to the dir containing the file.
# name - The String filename of the file.
#
# Returns nothing.
def read_yaml(path)
super(path)
self.extracted_excerpt = extract_excerpt
end
# The post excerpt. This is either a custom excerpt
# set in YAML front matter or the result of extract_excerpt.
#
# Returns excerpt string.
def excerpt
data.fetch('excerpt', extracted_excerpt.to_s)
end
# Public: the Post title, from the YAML Front-Matter or from the slug
#
# Returns the post title
def title
data.fetch("title", titleized_slug)
end
# Turns the post slug into a suitable title
def titleized_slug
slug.split('-').select {|w| w.capitalize! || w }.join(' ')
end
# Public: the path to the post relative to the site source,
# from the YAML Front-Matter or from a combination of
# the directory it's in, "_posts", and the name of the
# post file
#
# Returns the path to the file relative to the site source
def path
data.fetch('path', relative_path.sub(/\A\//, ''))
end
# The path to the post source file, relative to the site source
def relative_path
File.join(*[@dir, "_posts", @name].map(&:to_s).reject(&:empty?))
end
# Compares Post objects. First compares the Post date. If the dates are
# equal, it compares the Post slugs.
#
# other - The other Post we are comparing to.
#
# Returns -1, 0, 1
def <=>(other)
cmp = self.date <=> other.date
if 0 == cmp
cmp = self.slug <=> other.slug
end
return cmp
end
# Extract information from the post filename.
#
# name - The String filename of the post file.
#
# Returns nothing.
def process(name)
m, cats, date, slug, ext = *name.match(MATCHER)
self.date = Time.parse(date)
self.slug = slug
self.ext = ext
rescue ArgumentError
path = File.join(@dir || "", name)
msg = "Post '#{path}' does not have a valid date.\n"
msg << "Fix the date, or exclude the file or directory from being processed"
raise FatalException.new(msg)
end
# The generated directory into which the post will be placed
# upon generation. This is derived from the permalink or, if
# permalink is absent, set to the default date
# e.g. "/2008/11/05/" if the permalink style is :date, otherwise nothing.
#
# Returns the String directory.
def dir
File.dirname(url)
end
def template
case site.permalink_style
when :pretty
"/:categories/:year/:month/:day/:title/"
when :none
"/:categories/:title.html"
when :date
"/:categories/:year/:month/:day/:title.html"
when :ordinal
"/:categories/:year/:y_day/:title.html"
else
site.permalink_style.to_s
end
end
# The generated relative url of this post.
#
# Returns the String url.
def url
@url ||= URL.new({
:template => template,
:placeholders => url_placeholders,
:permalink => permalink
}).to_s
end
# Returns a hash of URL placeholder names (as symbols) mapping to the
# desired placeholder replacements. For details see "url.rb"
def url_placeholders
{
:year => date.strftime("%Y"),
:month => date.strftime("%m"),
:day => date.strftime("%d"),
:title => CGI.escape(slug),
:i_day => date.strftime("%d").to_i.to_s,
:i_month => date.strftime("%m").to_i.to_s,
:categories => (categories || []).map { |c| URI.escape(c.to_s) }.join('/'),
:short_month => date.strftime("%b"),
:y_day => date.strftime("%j"),
:output_ext => output_ext
}
end
# The UID for this post (useful in feeds).
# e.g. /2008/11/05/my-awesome-post
#
# Returns the String UID.
def id
File.join(dir, slug)
end
# Calculate related posts.
#
# Returns an Array of related Posts.
def related_posts(posts)
Jekyll::RelatedPosts.new(self).build
end
# Add any necessary layouts to this post.
#
# layouts - A Hash of {"name" => "layout"}.
# site_payload - The site payload hash.
#
# Returns nothing.
def render(layouts, site_payload)
template = {
"page" => self.to_liquid,
"site" => { "related_posts" => related_posts(site_payload["site"]["posts"]) }
}
super(template, layouts, site_payload)
end
# Obtain destination path.
#
# dest - The String path to the destination dir.
#
# Returns destination file path String.
def destination(dest)
# The url needs to be unescaped in order to preserve the correct filename
path = Jekyll.sanitized_path(dest, CGI.unescape(url))
path = File.join(path, "index.html") if path[/\.html$/].nil?
path
end
# Returns the shorthand String identifier of this Post.
def inspect
"<Post: #{id}>"
end
def next
pos = site.posts.index {|post| post.equal?(self) }
if pos && pos < site.posts.length - 1
site.posts[pos + 1]
else
nil
end
end
def previous
pos = site.posts.index {|post| post.equal?(self) }
if pos && pos > 0
site.posts[pos - 1]
else
nil
end
end
protected
def extract_excerpt
if generate_excerpt?
Jekyll::Excerpt.new(self)
else
""
end
end
def generate_excerpt?
!(site.config['excerpt_separator'].to_s.empty?)
end
end
end