Class: Jekyll::Page

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

Constant Summary collapse

ATTRIBUTES_FOR_LIQUID =

Attributes for Liquid templates

%w[
  url
  content
  path
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Convertible

#converter, #do_layout, #merged_file_read_opts, #output_ext, #read_yaml, #render_all_layouts, #render_liquid, #to_liquid, #to_s, #transform, #write

Constructor Details

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

Initialize a new Page.

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



23
24
25
26
27
28
29
30
31
 
# File 'lib/jekyll/page.rb', line 23

def initialize(site, base, dir, name)
  @site = site
  @base = base
  @dir  = dir
  @name = name

  self.process(name)
  self.read_yaml(File.join(base, dir), name)
end

Instance Attribute Details

#basename ⇒ Object

Returns the value of attribute basename.



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

def basename
  @basename
end

#content ⇒ Object

Returns the value of attribute content.



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

def content
  @content
end

#data ⇒ Object

Returns the value of attribute data.



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

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.



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

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

#ext ⇒ Object

Returns the value of attribute ext.



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

def ext
  @ext
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#output ⇒ Object

Returns the value of attribute output.



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

def output
  @output
end

#pager ⇒ Object

Returns the value of attribute pager.



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

def pager
  @pager
end

#site ⇒ Object

Returns the value of attribute site.



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

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.



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

def destination(dest)
  path = File.join(dest, self.url)
  path = File.join(path, "index.html") if self.url =~ /\/$/
  path
end

#html? ⇒ Boolean

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

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/jekyll/page.rb', line 147

def html?
  output_ext == '.html'
end

#index? ⇒ Boolean

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

Returns:

  • (Boolean) 


152
153
154
 
# File 'lib/jekyll/page.rb', line 152

def index?
  basename == 'index'
end

#inspect ⇒ Object

Returns the object as a debug String.



142
143
144
 
# File 'lib/jekyll/page.rb', line 142

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

#path ⇒ Object

The path to the source file

Returns the path to the source file



121
122
123
 
# File 'lib/jekyll/page.rb', line 121

def path
  self.data.fetch('path', self.relative_path.sub(/\A\//, ''))
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.



46
47
48
49
50
51
52
53
 
# File 'lib/jekyll/page.rb', line 46

def permalink
  return nil if self.data.nil? || self.data['permalink'].nil?
  if site.config['relative_permalinks']
    File.join(@dir, self.data['permalink'])
  else
    self.data['permalink']
  end
end

#process(name) ⇒ Object

Extract information from the page filename.

name - The String filename of the page file.

Returns nothing.



98
99
100
101
 
# File 'lib/jekyll/page.rb', line 98

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

#relative_path ⇒ Object

The path to the page source file, relative to the site source



126
127
128
 
# File 'lib/jekyll/page.rb', line 126

def relative_path
  File.join(@dir, @name)
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.



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

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.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/jekyll/page.rb', line 58

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

#url ⇒ Object

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

Returns the String url.



75
76
77
78
79
80
81
 
# File 'lib/jekyll/page.rb', line 75

def url
  @url ||= URL.new({
    :template => template,
    :placeholders => url_placeholders,
    :permalink => permalink
  }).to_s
end

#url_placeholders ⇒ Object

Returns a hash of URL placeholder names (as symbols) mapping to the desired placeholder replacements. For details see “url.rb”



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

def url_placeholders
  {
    :path       => @dir,
    :basename   => self.basename,
    :output_ext => self.output_ext
  }
end

#uses_relative_permalinks ⇒ Object 



156
157
158
 
# File 'lib/jekyll/page.rb', line 156

def uses_relative_permalinks
  permalink && @dir != "" && site.config['relative_permalinks']
end