Module: Jekyll::Convertible

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

Instance Method Summary collapse

Instance Method Details

#content_type ⇒ Object

Determine which formatting engine to use based on this convertible’s extension

Returns one of :textile, :markdown or :unknown



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/jekyll/convertible.rb', line 51

def content_type
  case self.ext[1..-1]
  when /textile/i
    return 'textile'
  when /markdown/i, /mkdn/i, /md/i
    return 'markdown'
  when /haml/i
    return 'haml'
  end
  return 'unknown'
end

#do_layout(payload, layouts) ⇒ Object

Add any necessary layouts to this convertible document

+layouts+ is a Hash of {"name" => "layout"}
+site_payload+ is the site payload hash

Returns nothing



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/jekyll/convertible.rb', line 80

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

  # render and transform content (this becomes the final content of the object)
  payload["content_type"] = self.content_type
  
  if self.content_type == "haml"
    self.transform
    self.content = render_haml_in_context(self.content,
      :site => self.site,
      :page => ClosedStruct.new(payload["page"]))
  else
    self.content = Liquid::Template.parse(self.content).render(payload, info)
    self.transform
  end

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

  # recursively render layouts
  layout = layouts[self.data["layout"]]
  while layout
    payload = payload.deep_merge({"content" => self.output, "page" => layout.data})
    
    if site.config['haml'] && layout.content.is_a?(Haml::Engine)
      self.output = render_haml_in_context(layout.content, 
        :site => ClosedStruct.new(payload["site"]),
        :page => ClosedStruct.new(payload["page"]),
        :content => payload["content"])
    else
      self.output = Liquid::Template.parse(layout.content).render(payload, info)
    end

    layout = layouts[layout.data["layout"]]
  end
end

#read_yaml(base, name) ⇒ Object

Read the YAML frontmatter

+base+ is the String path to the dir containing the file
+name+ is the String filename of the file

Returns nothing



18
19
20
21
22
23
24
25
26
27
 
# File 'lib/jekyll/convertible.rb', line 18

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

  if self.content =~ /^(---\s*\n.*?)\n---\s*\n/m
    self.content = self.content[($1.size + 5)..-1]

    self.data ||= {}
    self.data = self.data.merge(YAML.load($1))
  end
end

#render_haml_in_context(haml_engine, params = {}) ⇒ Object

Sets up a context for Haml and renders in it. The context has accessors matching the passed-in hash, e.g. “site”, “page” and “content”, and has helper modules mixed in.

Returns String.



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

def render_haml_in_context(haml_engine, params={})
  context = ClosedStruct.new(params)
  context.extend(HamlHelpers)
  context.extend(::Helpers) if defined?(::Helpers)
  haml_engine.render(context)
end

#to_s ⇒ Object

Return the contents as a string



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

def to_s
  self.content || ''
end

#transform ⇒ Object

Transform the contents based on the file extension.

Returns nothing



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

def transform
  case self.content_type
  when 'textile'
    self.ext = ".html"
    self.content = self.site.textile(self.content)
  when 'markdown'
    self.ext = ".html"
    self.content = self.site.markdown(self.content)
  when 'haml'
    self.ext = ".html"
    # Actually rendered in do_layout.
    self.content = Haml::Engine.new(self.content, :attr_wrapper => %{"})
  end
end