Class: Jekyll::Post
- Inherits:
-
Object
- Object
- Jekyll::Post
- Includes:
- Comparable, Convertible
- Defined in:
- lib/jekyll/post.rb
Constant Summary collapse
- MATCHER =
/^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
Class Attribute Summary collapse
-
.lsi ⇒ Object
Returns the value of attribute lsi.
Instance Attribute Summary collapse
-
#categories ⇒ Object
Returns the value of attribute categories.
-
#content ⇒ Object
Returns the value of attribute content.
-
#data ⇒ Object
Returns the value of attribute data.
-
#date ⇒ Object
Returns the value of attribute date.
-
#ext ⇒ Object
Returns the value of attribute ext.
-
#output ⇒ Object
Returns the value of attribute output.
-
#published ⇒ Object
Returns the value of attribute published.
-
#slug ⇒ Object
Returns the value of attribute slug.
-
#topics ⇒ Object
Returns the value of attribute topics.
Class Method Summary collapse
-
.valid?(name) ⇒ Boolean
Post name validator.
Instance Method Summary collapse
-
#<=>(other) ⇒ Object
Spaceship is based on Post#date.
-
#dir ⇒ Object
The generated directory into which the post will be placed upon generation.
-
#id ⇒ Object
The UID for this post (useful in feeds) e.g.
-
#initialize(source, dir, name) ⇒ Post
constructor
Initialize this Post instance.
- #inspect ⇒ Object
-
#permalink ⇒ Object
The full path and filename of the post.
-
#process(name) ⇒ Object
Extract information from the post filename
name
is the String filename of the post file. -
#related_posts(posts) ⇒ Object
Calculate related posts.
-
#render(layouts, site_payload) ⇒ Object
Add any necessary layouts to this post
layouts
is a Hash of => “layout”site_payload
is the site payload hash. -
#to_liquid ⇒ Object
Convert this post into a Hash for use in Liquid templates.
-
#url ⇒ Object
The generated relative url of this post e.g.
-
#write(dest) ⇒ Object
Write the generated post file to the destination directory.
Methods included from Convertible
#determine_content_type, #do_layout, #read_yaml, #to_s, #transform
Constructor Details
#initialize(source, dir, name) ⇒ Post
Initialize this Post instance.
+base+ is the String path to the dir containing the post file
+name+ is the String filename of the post file
+categories+ is an Array of Strings for the categories for this post
Returns <Post>
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 |
# File 'lib/jekyll/post.rb', line 30 def initialize(source, dir, name) @base = File.join(source, dir, '_posts') @name = name self.categories = dir.split('/').reject { |x| x.empty? } parts = name.split('/') self.topics = parts.size > 1 ? parts[0..-2] : [] self.process(name) self.read_yaml(@base, name) if self.data.has_key?('published') && self.data['published'] == false self.published = false else self.published = true end if self.categories.empty? if self.data.has_key?('category') self.categories << self.data['category'] elsif self.data.has_key?('categories') self.categories = self.data['categories'].split end end end |
Class Attribute Details
.lsi ⇒ Object
Returns the value of attribute lsi.
8 9 10 |
# File 'lib/jekyll/post.rb', line 8 def lsi @lsi end |
Instance Attribute Details
#categories ⇒ Object
Returns the value of attribute categories.
21 22 23 |
# File 'lib/jekyll/post.rb', line 21 def categories @categories end |
#content ⇒ Object
Returns the value of attribute content.
22 23 24 |
# File 'lib/jekyll/post.rb', line 22 def content @content end |
#data ⇒ Object
Returns the value of attribute data.
22 23 24 |
# File 'lib/jekyll/post.rb', line 22 def data @data end |
#date ⇒ Object
Returns the value of attribute date.
21 22 23 |
# File 'lib/jekyll/post.rb', line 21 def date @date end |
#ext ⇒ Object
Returns the value of attribute ext.
21 22 23 |
# File 'lib/jekyll/post.rb', line 21 def ext @ext end |
#output ⇒ Object
Returns the value of attribute output.
22 23 24 |
# File 'lib/jekyll/post.rb', line 22 def output @output end |
#published ⇒ Object
Returns the value of attribute published.
21 22 23 |
# File 'lib/jekyll/post.rb', line 21 def published @published end |
#slug ⇒ Object
Returns the value of attribute slug.
21 22 23 |
# File 'lib/jekyll/post.rb', line 21 def slug @slug end |
#topics ⇒ Object
Returns the value of attribute topics.
21 22 23 |
# File 'lib/jekyll/post.rb', line 21 def topics @topics end |
Class Method Details
.valid?(name) ⇒ Boolean
Post name validator. Post filenames must be like:
2008-11-05-my-awesome-post.textile
Returns <Bool>
17 18 19 |
# File 'lib/jekyll/post.rb', line 17 def self.valid?(name) name =~ MATCHER end |
Instance Method Details
#<=>(other) ⇒ Object
Spaceship is based on Post#date
Returns -1, 0, 1
60 61 62 |
# File 'lib/jekyll/post.rb', line 60 def <=>(other) self.date <=> other.date end |
#dir ⇒ Object
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 <String>
81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/jekyll/post.rb', line 81 def dir if permalink permalink.to_s.split("/")[0..-2].join("/") + '/' else prefix = self.categories.empty? ? '' : '/' + self.categories.join('/') if Jekyll.permalink_style == :date prefix + date.strftime("/%Y/%m/%d/") else prefix + '/' end end end |
#id ⇒ Object
The UID for this post (useful in feeds) e.g. /2008/11/05/my-awesome-post
Returns <String>
115 116 117 |
# File 'lib/jekyll/post.rb', line 115 def id self.dir + self.slug end |
#inspect ⇒ Object
183 184 185 |
# File 'lib/jekyll/post.rb', line 183 def inspect "<Post: #{self.id}>" end |
#permalink ⇒ Object
The full path and filename of the post. Defined in the YAML of the post body (Optional)
Returns <String>
99 100 101 |
# File 'lib/jekyll/post.rb', line 99 def permalink self.data && self.data['permalink'] end |
#process(name) ⇒ Object
Extract information from the post filename
+name+ is the String filename of the post file
Returns nothing
68 69 70 71 72 73 |
# File 'lib/jekyll/post.rb', line 68 def process(name) m, cats, date, slug, ext = *name.match(MATCHER) self.date = Time.parse(date) self.slug = slug self.ext = ext end |
#related_posts(posts) ⇒ Object
Calculate related posts.
Returns [<Post>]
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/jekyll/post.rb', line 122 def (posts) return [] unless posts.size > 1 if Jekyll.lsi self.class.lsi ||= begin puts "Running the classifier... this could take a while." lsi = Classifier::LSI.new posts.each { |x| $stdout.print(".");$stdout.flush;lsi.add_item(x) } puts "" lsi end = self.class.lsi.(self.content, 11) - [self] else (posts - [self])[0..9] end end |
#render(layouts, site_payload) ⇒ Object
Add any necessary layouts to this post
+layouts+ is a Hash of {"name" => "layout"}
+site_payload+ is the site payload hash
Returns nothing
146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/jekyll/post.rb', line 146 def render(layouts, site_payload) # construct payload payload = { "site" => { "related_posts" => (site_payload["site"]["posts"]) }, "page" => self.to_liquid } payload = payload.deep_merge(site_payload) do_layout(payload, layouts) end |
#to_liquid ⇒ Object
Convert this post into a Hash for use in Liquid templates.
Returns <Hash>
174 175 176 177 178 179 180 181 |
# File 'lib/jekyll/post.rb', line 174 def to_liquid { "title" => self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '), "url" => self.url, "date" => self.date, "id" => self.id, "topics" => self.topics, "content" => self.content }.deep_merge(self.data) end |
#url ⇒ Object
The generated relative url of this post e.g. /2008/11/05/my-awesome-post.html
Returns <String>
107 108 109 |
# File 'lib/jekyll/post.rb', line 107 def url permalink || self.dir + self.slug + ".html" end |
#write(dest) ⇒ Object
Write the generated post file to the destination directory.
+dest+ is the String path to the destination dir
Returns nothing
162 163 164 165 166 167 168 169 |
# File 'lib/jekyll/post.rb', line 162 def write(dest) FileUtils.mkdir_p(File.join(dest, dir)) path = File.join(dest, self.url) File.open(path, 'w') do |f| f.write(self.output) end end |