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(
  content
  dir
  name
  path
  url
)
HTML_EXTENSIONS =

A set of extensions that are considered HTML or HTML-like so we should not alter them, this includes .xhtml through XHTM5.

%W(
  .html
  .xhtml
  .htm
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Convertible

#[], #asset_file?, #coffeescript_file?, #converters, #do_layout, #hook_owner, #invalid_layout?, #merged_file_read_opts, #output_ext, #place_in_layout?, #published?, #read_yaml, #render_all_layouts, #render_liquid, #render_with_liquid?, #sass_file?, #to_liquid, #to_s, #transform, #type, #validate_data!, #validate_permalink!, #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.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/jekyll/page.rb', line 36

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

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

  data.default_proc = proc do |_, key|
    site.frontmatter_defaults.find(File.join(dir, name), type, key)
  end

  Jekyll::Hooks.trigger :pages, :post_init, self
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.



57
58
59
 
# File 'lib/jekyll/page.rb', line 57

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

#ext ⇒ Object Also known as: extname

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.



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

def destination(dest)
  path = site.in_dest_dir(dest, URL.unescape_path(url))
  path = File.join(path, "index") if url.end_with?("/")
  path << output_ext unless path.end_with? output_ext
  path
end

#html? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def html?
  HTML_EXTENSIONS.include?(output_ext)
end

#index? ⇒ Boolean

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

Returns:

  • (Boolean) 


161
162
163
 
# File 'lib/jekyll/page.rb', line 161

def index?
  basename == 'index'
end

#inspect ⇒ Object

Returns the object as a debug String.



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

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

#path ⇒ Object

The path to the source file

Returns the path to the source file



129
130
131
 
# File 'lib/jekyll/page.rb', line 129

def path
  data.fetch('path') { 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.



65
66
67
 
# File 'lib/jekyll/page.rb', line 65

def permalink
  data.nil? ? nil : data['permalink']
end

#process(name) ⇒ Object

Extract information from the page filename.

name - The String filename of the page file.

Returns nothing.



108
109
110
111
 
# File 'lib/jekyll/page.rb', line 108

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

#relative_path ⇒ Object

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



134
135
136
 
# File 'lib/jekyll/page.rb', line 134

def relative_path
  File.join(*[@dir, @name].map(&:to_s).reject(&:empty?))
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.



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

def render(layouts, site_payload)
  site_payload["page"] = to_liquid
  site_payload["paginator"] = pager.to_liquid

  do_layout(site_payload, layouts)
end

#template ⇒ Object

The template of the permalink.

Returns the template String.



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

def template
  if !html?
    "/:path/:basename:output_ext"
  elsif index?
    "/:path/"
  else
    Utils.add_permalink_suffix("/:path/:basename", site.permalink_style)
  end
end

#trigger_hooks(hook_name, *args) ⇒ Object 



165
166
167
 
# File 'lib/jekyll/page.rb', line 165

def trigger_hooks(hook_name, *args)
  Jekyll::Hooks.trigger :pages, hook_name, self, *args
end

#url ⇒ Object

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

Returns the String url.



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

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”



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

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

#write? ⇒ Boolean

Returns:

  • (Boolean) 


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

def write?
  true
end