class Tigefa::Page
Constants
- ATTRIBUTES_FOR_LIQUID
Attributes for Liquid templates
Attributes
Public Class Methods
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.
# File lib/tigefa/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
Public Instance Methods
Obtain destination path.
dest - The String path to the destination dir.
Returns the destination file path String.
# File lib/tigefa/page.rb, line 135 def destination(dest) path = File.join(dest, self.url) path = File.join(path, "index.html") if self.url =~ /\/$/ path end
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.
# File lib/tigefa/page.rb, line 38 def dir url[-1, 1] == '/' ? url : File.dirname(url) end
Returns the Boolean of whether this Page
is HTML or not.
# File lib/tigefa/page.rb, line 147 def html? output_ext == '.html' end
Returns the Boolean of whether this Page
is an index file or not.
# File lib/tigefa/page.rb, line 152 def index? basename == 'index' end
Returns the object as a debug String.
# File lib/tigefa/page.rb, line 142 def inspect "#<Tigefa:Page @name=#{self.name.inspect}>" end
The path to the source file
Returns the path to the source file
# File lib/tigefa/page.rb, line 121 def path self.data.fetch('path', self.relative_path.sub(/\A\//, '')) end
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.
# File lib/tigefa/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
Extract information from the page filename.
name - The String filename of the page file.
Returns nothing.
# File lib/tigefa/page.rb, line 98 def process(name) self.ext = File.extname(name) self.basename = name[0 .. -self.ext.length-1] end
The path to the page source file, relative to the site source
# File lib/tigefa/page.rb, line 126 def relative_path File.join(@dir, @name) end
Add any necessary layouts to this post
layouts - The Hash
of {“name” => “layout”}. site_payload - The site payload Hash
.
Returns nothing.
# File lib/tigefa/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
The template of the permalink.
Returns the template String.
# File lib/tigefa/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
The generated relative url of this page. e.g. /about.html.
Returns the String url.
# File lib/tigefa/page.rb, line 75 def url @url ||= URL.new({ :template => template, :placeholders => url_placeholders, :permalink => permalink }).to_s end
Returns a hash of URL
placeholder names (as symbols) mapping to the desired placeholder replacements. For details see “url.rb”
# File lib/tigefa/page.rb, line 85 def url_placeholders { :path => @dir, :basename => self.basename, :output_ext => self.output_ext } end
# File lib/tigefa/page.rb, line 156 def uses_relative_permalinks permalink && @dir != "" && site.config['relative_permalinks'] end