Class: Jekyll::Post

Inherits:
Object
  • Object
show all
Includes:
Comparable, Convertible
Defined in:
lib/jekyll/post.rb

Constant Summary collapse

MATCHER = 
/^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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
 
# 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)
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

#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>

Returns:

  • (Boolean) 


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



46
47
48
 
# File 'lib/jekyll/post.rb', line 46

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>



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/jekyll/post.rb', line 67

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>



101
102
103
 
# File 'lib/jekyll/post.rb', line 101

def id
  self.dir + self.slug
end

#inspect ⇒ Object 



169
170
171
 
# File 'lib/jekyll/post.rb', line 169

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>



85
86
87
 
# File 'lib/jekyll/post.rb', line 85

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



54
55
56
57
58
59
 
# File 'lib/jekyll/post.rb', line 54

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>]



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/jekyll/post.rb', line 108

def related_posts(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

    related = self.class.lsi.find_related(self.content, 11)
    related - [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



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/jekyll/post.rb', line 132

def render(layouts, site_payload)
  # construct payload
  payload =
  {
    "site" => { "related_posts" => 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>



160
161
162
163
164
165
166
167
 
# File 'lib/jekyll/post.rb', line 160

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>



93
94
95
 
# File 'lib/jekyll/post.rb', line 93

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



148
149
150
151
152
153
154
155
 
# File 'lib/jekyll/post.rb', line 148

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