Class: Jekyll::Page

Inherits:
Object
  • Object
show all
Includes:
Convertible
Defined in:
lib/jekyll/page.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Convertible

#converter, #do_layout, #output_ext, #read_yaml, #to_s, #transform

Constructor Details

#initialize(site, source, dir, name) ⇒ Page

Initialize a new Page.

site - The Site object. source - The String path to the source. dir - The String path between the source and the file. name - The String filename of the file.



17
18
19
20
21
22
23
24
25
 
# File 'lib/jekyll/page.rb', line 17

def initialize(site, source, dir, name)
  @site = site
  @dir  = dir
  @base = File.join(source, @dir)
  @name = name

  self.process(name)
  self.read_yaml(@base, name)
end

Instance Attribute Details

#basename ⇒ Object

Returns the value of attribute basename.



8
9
10
 
# File 'lib/jekyll/page.rb', line 8

def basename
  @basename
end

#content ⇒ Object

Returns the value of attribute content.



9
10
11
 
# File 'lib/jekyll/page.rb', line 9

def content
  @content
end

#data ⇒ Object

Returns the value of attribute data.



9
10
11
 
# File 'lib/jekyll/page.rb', line 9

def data
  @data
end

#dir ⇒ Object

The generated directory into which the page will be placed upon generation. This is derived from the permalink or, if permalink is absent, we be ‘/’

Returns the String destination directory.



37
38
39
 
# File 'lib/jekyll/page.rb', line 37

def dir
  url[-1, 1] == '/' ? url : File.dirname(url)
end

#ext ⇒ Object

Returns the value of attribute ext.



8
9
10
 
# File 'lib/jekyll/page.rb', line 8

def ext
  @ext
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/jekyll/page.rb', line 8

def name
  @name
end

#output ⇒ Object

Returns the value of attribute output.



9
10
11
 
# File 'lib/jekyll/page.rb', line 9

def output
  @output
end

#pager ⇒ Object

Returns the value of attribute pager.



7
8
9
 
# File 'lib/jekyll/page.rb', line 7

def pager
  @pager
end

#site ⇒ Object

Returns the value of attribute site.



7
8
9
 
# File 'lib/jekyll/page.rb', line 7

def site
  @site
end

Instance Method Details

#destination(dest) ⇒ Object

Obtain destination path.

dest - The String path to the destination dir.

Returns the destination file path String.



122
123
124
125
126
127
128
 
# File 'lib/jekyll/page.rb', line 122

def destination(dest)
  # The url needs to be unescaped in order to preserve the correct
  # filename.
  path = File.join(dest, @dir, CGI.unescape(self.url))
  path = File.join(path, "index.html") if self.url =~ /\/$/
  path
end

#filename ⇒ Object

The source filename for this page.



28
29
30
 
# File 'lib/jekyll/page.rb', line 28

def filename
  File.join(@base, name)
end

#html? ⇒ Boolean

Returns the Boolean of whether this Page is HTML or not.

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/jekyll/page.rb', line 149

def html?
  output_ext == '.html'
end

#index? ⇒ Boolean

Returns the Boolean of whether this Page is an index file or not.

Returns:

  • (Boolean) 


154
155
156
 
# File 'lib/jekyll/page.rb', line 154

def index?
  basename == 'index'
end

#inspect ⇒ Object

Returns the object as a debug String.



144
145
146
 
# File 'lib/jekyll/page.rb', line 144

def inspect
  "#<Jekyll:Page @name=#{self.name.inspect}>"
end

#permalink ⇒ Object

The full path and filename of the post. Defined in the YAML of the post body.

Returns the String permalink or nil if none has been set.



45
46
47
 
# File 'lib/jekyll/page.rb', line 45

def permalink
  self.data && self.data['permalink']
end

#process(name) ⇒ Object

Extract information from the page filename.

name - The String filename of the page file.

Returns nothing.



88
89
90
91
 
# File 'lib/jekyll/page.rb', line 88

def process(name)
  self.ext = File.extname(name)
  self.basename = name[0 .. -self.ext.length-1]
end

#render(layouts, site_payload) ⇒ Object

Add any necessary layouts to this post

layouts - The Hash of => “layout”. site_payload - The site payload Hash.

Returns nothing.



99
100
101
102
103
104
105
106
 
# File 'lib/jekyll/page.rb', line 99

def render(layouts, site_payload)
  payload = {
    "page" => self.to_liquid,
    'paginator' => pager.to_liquid
  }.deep_merge(site_payload)

  do_layout(payload, layouts)
end

#template ⇒ Object

The template of the permalink.

Returns the template String.



52
53
54
55
56
57
58
 
# File 'lib/jekyll/page.rb', line 52

def template
  if self.site.permalink_style == :pretty && !index? && html?
    "/:basename/"
  else
    "/:basename:output_ext"
  end
end

#to_liquid ⇒ Object

Convert this Page’s data to a Hash suitable for use by Liquid.

Returns the Hash representation of this Page.



111
112
113
114
115
 
# File 'lib/jekyll/page.rb', line 111

def to_liquid
  self.data.deep_merge({
    "url"        => File.join(@dir, self.url),
    "content"    => self.content })
end

#url ⇒ Object

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

Returns the String url.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/jekyll/page.rb', line 63

def url
  return @url if @url

  url = if permalink
    permalink
  else
    {
      "basename"   => self.basename,
      "output_ext" => self.output_ext,
    }.inject(template) { |result, token|
      result.gsub(/:#{token.first}/, token.last)
    }.gsub(/\/\//, "/")
  end

  # sanitize url
  @url = url.split('/').reject{ |part| part =~ /^\.+$/ }.join('/')
  @url += "/" if url =~ /\/$/
  @url
end

#write(dest) ⇒ Object

Write the generated page file to the destination directory.

dest - The String path to the destination dir.

Returns nothing.



135
136
137
138
139
140
141
 
# File 'lib/jekyll/page.rb', line 135

def write(dest)
  path = destination(dest)
  FileUtils.mkdir_p(File.dirname(path))
  File.open(path, 'w') do |f|
    f.write(self.output)
  end
end