Module: Jekyll::Convertible

Included in:
Excerpt, Layout, Page, Post
Defined in:
lib/jekyll/convertible.rb

Instance Method Summary collapse

Instance Method Details

#converterObject

Determine which converter to use based on this convertible's extension.

Returns the Converter instance.



69
70
71
# File 'lib/jekyll/convertible.rb', line 69

def converter
  @converter ||= self.site.converters.find { |c| c.matches(self.ext) }
end

#do_layout(payload, layouts) ⇒ Object

Add any necessary layouts to this convertible document.

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

Returns nothing.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/jekyll/convertible.rb', line 122

def do_layout(payload, layouts)
  info = { :filters => [Jekyll::Filters], :registers => { :site => self.site, :page => payload['page'] } }

  # render and transform content (this becomes the final content of the object)
  payload["pygments_prefix"] = converter.pygments_prefix
  payload["pygments_suffix"] = converter.pygments_suffix

  self.content = self.render_liquid(self.content,
                                    payload.merge({:file => self.name}),
                                    info)
  self.transform

  # output keeps track of what will finally be written
  self.output = self.content

  self.render_all_layouts(layouts, payload, info)
end

#output_extObject

Determine the extension depending on content_type.

Returns the String extension for the output file.

e.g. ".html" for an HTML output file.


61
62
63
# File 'lib/jekyll/convertible.rb', line 61

def output_ext
  converter.output_ext(self.ext)
end

#read_yaml(base, name) ⇒ Object

Read the YAML frontmatter.

base - The String path to the dir containing the file. name - The String filename of the file.

Returns nothing.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/jekyll/convertible.rb', line 29

def read_yaml(base, name)
  begin
    self.content = File.read(File.join(base, name))

    if self.content =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
      self.content = $POSTMATCH
      self.data = YAML.safe_load($1)
    end
  rescue SyntaxError => e
    puts "YAML Exception reading #{File.join(base, name)}: #{e.message}"
  rescue Exception => e
    puts "Error reading file #{File.join(base, name)}: #{e.message}"
  end

  self.data ||= {}
end

#render_all_layouts(layouts, payload, info) ⇒ Object

Recursively render layouts

layouts - a list of the layouts payload - the payload for Liquid info - the info for Liquid

Returns nothing



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/jekyll/convertible.rb', line 94

def render_all_layouts(layouts, payload, info)
  # recursively render layouts
  layout = layouts[self.data["layout"]]
  used = Set.new([layout])

  while layout
    payload = payload.deep_merge({"content" => self.output, "page" => layout.data})

    self.output = self.render_liquid(layout.content,
                                     payload.merge({:file => layout.name}),
                                     info)

    if layout = layouts[layout.data["layout"]]
      if used.include?(layout)
        layout = nil # avoid recursive chain
      else
        used << layout
      end
    end
  end
end

#render_liquid(content, payload, info) ⇒ Object

Render Liquid in the content

content - the raw Liquid content to render payload - the payload for Liquid info - the info for Liquid

Returns the converted content



80
81
82
83
84
85
# File 'lib/jekyll/convertible.rb', line 80

def render_liquid(content, payload, info)
  Liquid::Template.parse(content).render!(payload, info)
rescue Exception => e
  Jekyll.logger.error "Liquid Exception:", "#{e.message} in #{payload[:file]}"
  raise e
end

#to_sObject

Returns the contents as a String.



19
20
21
# File 'lib/jekyll/convertible.rb', line 19

def to_s
  self.content || ''
end

#transformObject

Transform the contents based on the content type.

Returns nothing.



49
50
51
52
53
54
55
# File 'lib/jekyll/convertible.rb', line 49

def transform
  self.content = converter.convert(self.content)
rescue => e
  Jekyll.logger.error "Conversion error:", "There was an error converting" +
    " '#{self.path}'."
  raise e
end

#write(dest) ⇒ Object

Write the generated page file to the destination directory.

dest - The String path to the destination dir.

Returns nothing.



145
146
147
148
149
150
151
# File 'lib/jekyll/convertible.rb', line 145

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