Class: Jekyll::Site

Inherits:
Object
  • Object
show all
Defined in:
lib/jekyll/site.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Site

Initialize the site

+config+ is a Hash containing site configurations details

Returns <Site>



11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/jekyll/site.rb', line 11

def initialize(config)
  self.config          = config.clone

  self.source          = config['source']
  self.dest            = config['destination']
  self.lsi             = config['lsi']
  self.pygments        = config['pygments']
  self.permalink_style = config['permalink'].to_sym
  self.exclude         = config['exclude'] || []

  self.reset
  self.setup
end

Instance Attribute Details

#categories ⇒ Object

Returns the value of attribute categories.



4
5
6
 
# File 'lib/jekyll/site.rb', line 4

def categories
  @categories
end

#config ⇒ Object

Returns the value of attribute config.



4
5
6
 
# File 'lib/jekyll/site.rb', line 4

def config
  @config
end

#dest ⇒ Object

Returns the value of attribute dest.



5
6
7
 
# File 'lib/jekyll/site.rb', line 5

def dest
  @dest
end

#exclude ⇒ Object

Returns the value of attribute exclude.



4
5
6
 
# File 'lib/jekyll/site.rb', line 4

def exclude
  @exclude
end

#layouts ⇒ Object

Returns the value of attribute layouts.



4
5
6
 
# File 'lib/jekyll/site.rb', line 4

def layouts
  @layouts
end

#lsi ⇒ Object

Returns the value of attribute lsi.



5
6
7
 
# File 'lib/jekyll/site.rb', line 5

def lsi
  @lsi
end

#permalink_style ⇒ Object

Returns the value of attribute permalink_style.



5
6
7
 
# File 'lib/jekyll/site.rb', line 5

def permalink_style
  @permalink_style
end

#posts ⇒ Object

Returns the value of attribute posts.



4
5
6
 
# File 'lib/jekyll/site.rb', line 4

def posts
  @posts
end

#pygments ⇒ Object

Returns the value of attribute pygments.



5
6
7
 
# File 'lib/jekyll/site.rb', line 5

def pygments
  @pygments
end

#source ⇒ Object

Returns the value of attribute source.



5
6
7
 
# File 'lib/jekyll/site.rb', line 5

def source
  @source
end

Instance Method Details

#filter_entries(entries) ⇒ Object

Filter out any files/directories that are hidden or backup files (start with “.” or “#” or end with “~”) or contain site content (start with “_”) unless they are “_posts” directories or web server files such as ‘.htaccess’



232
233
234
235
236
237
238
 
# File 'lib/jekyll/site.rb', line 232

def filter_entries(entries)
  entries = entries.reject do |e|
    unless ['_posts', '.htaccess'].include?(e)
      ['.', '_', '#'].include?(e[0..0]) || e[-1..-1] == '~' || self.exclude.include?(e)
    end
  end
end

#paginate_posts(file, dir) ⇒ Object

Paginates the blog’s posts. Renders the index.html file into paginated directories, ie: page2, page3… and adds more wite-wide data

=> { “page” => <Number>,

"per_page" => <Number>,
"posts" => [<Post>],
"total_posts" => <Number>,
"total_pages" => <Number>,
"previous_page" => <Number>,
"next_page" => <Number> }



250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/jekyll/site.rb', line 250

def paginate_posts(file, dir)
  all_posts = self.posts.sort { |a,b| b <=> a }
  page = Page.new(self, self.source, dir, file)

  pages = Pager.calculate_pages(all_posts, self.config['paginate'].to_i)

  (1..pages).each do |num_page|
    pager = Pager.new(self.config, num_page, all_posts, pages)

    page.render(self.layouts, site_payload.merge({'paginator' => pager.to_hash}))
    suffix = "page#{num_page}" if num_page > 1
    page.write(self.dest, suffix)
  end
end

#post_attr_hash(post_attr) ⇒ Object

Constructs a hash map of Posts indexed by the specified Post attribute

Returns => [<Post>]



204
205
206
207
208
209
210
211
 
# File 'lib/jekyll/site.rb', line 204

def post_attr_hash(post_attr)
  # Build a hash map based on the specified post attribute ( post attr => array of posts )
  # then sort each array in reverse order
  hash = Hash.new { |hash, key| hash[key] = Array.new }
  self.posts.each { |p| p.send(post_attr.to_sym).each { |t| hash[t] << p } }
  hash.values.map { |sortme| sortme.sort! { |a, b| b <=> a} }
  return hash
end

#process ⇒ Object

Do the actual work of processing the site and generating the real deal.

Returns nothing



90
91
92
93
94
95
 
# File 'lib/jekyll/site.rb', line 90

def process
  self.reset
  self.read_layouts
  self.transform_pages
  self.write_posts
end

#read_layouts ⇒ Object

Read all the files in <source>/_layouts into memory for later use.

Returns nothing



100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/jekyll/site.rb', line 100

def read_layouts
  base = File.join(self.source, "_layouts")
  entries = []
  Dir.chdir(base) { entries = filter_entries(Dir['*.*']) }

  entries.each do |f|
    name = f.split(".")[0..-2].join(".")
    self.layouts[name] = Layout.new(self, base, f)
  end
rescue Errno::ENOENT => e
  # ignore missing layout dir
end

#read_posts(dir) ⇒ Object

Read all the files in <base>/_posts and create a new Post object with each one.

Returns nothing



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/jekyll/site.rb', line 116

def read_posts(dir)
  base = File.join(self.source, dir, '_posts')
  entries = []
  Dir.chdir(base) { entries = filter_entries(Dir['**/*']) }

  # first pass processes, but does not yet render post content
  entries.each do |f|
    if Post.valid?(f)
      post = Post.new(self, self.source, dir, f)

      if post.published
        self.posts << post
        post.categories.each { |c| self.categories[c] << post }
      end
    end
  end

  self.posts.sort!

  # second pass renders each post now that full site payload is available
  self.posts.each do |post|
    post.render(self.layouts, site_payload)
  end

  self.categories.values.map { |cats| cats.sort! { |a, b| b <=> a} }
rescue Errno::ENOENT => e
  # ignore missing layout dir
end

#reset ⇒ Object 



25
26
27
28
29
 
# File 'lib/jekyll/site.rb', line 25

def reset
  self.layouts         = {}
  self.posts           = []
  self.categories      = Hash.new { |hash, key| hash[key] = Array.new }
end

#setup ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/jekyll/site.rb', line 31

def setup
  # Check to see if LSI is enabled.
  require 'classifier' if self.lsi

  # Set the Markdown interpreter (and Maruku self.config, if necessary)
  case self.config['markdown']
    when 'rdiscount'
      begin
        require 'rdiscount'

        def markdown(content)
          RDiscount.new(content).to_html
        end

      rescue LoadError
        puts 'You must have the rdiscount gem installed first'
      end
    when 'maruku'
      begin
        require 'maruku'

        def markdown(content)
          Maruku.new(content).to_html
        end

        if self.config['maruku']['use_divs']
          require 'maruku/ext/div'
          puts 'Maruku: Using extended syntax for div elements.'
        end

        if self.config['maruku']['use_tex']
          require 'maruku/ext/math'
          puts "Maruku: Using LaTeX extension. Images in `#{self.config['maruku']['png_dir']}`."

          # Switch off MathML output
          MaRuKu::Globals[:html_math_output_mathml] = false
          MaRuKu::Globals[:html_math_engine] = 'none'

          # Turn on math to PNG support with blahtex
          # Resulting PNGs stored in `images/latex`
          MaRuKu::Globals[:html_math_output_png] = true
          MaRuKu::Globals[:html_png_engine] =  self.config['maruku']['png_engine']
          MaRuKu::Globals[:html_png_dir] = self.config['maruku']['png_dir']
          MaRuKu::Globals[:html_png_url] = self.config['maruku']['png_url']
        end
      rescue LoadError
        puts "The maruku gem is required for markdown support!"
      end
  end
end

#site_payload ⇒ Object

The Hash payload containing site-wide data

Returns => {“time” => <Time>,

"posts" => [<Post>],
"categories" => [<Post>],
"topics" => [<Post>] }



219
220
221
222
223
224
225
226
 
# File 'lib/jekyll/site.rb', line 219

def site_payload
  {"site" => {
    "time" => Time.now,
    "posts" => self.posts.sort { |a,b| b <=> a },
    "categories" => post_attr_hash('categories'),
    "topics" => post_attr_hash('topics')
  }}
end

#textile(content) ⇒ Object 



82
83
84
 
# File 'lib/jekyll/site.rb', line 82

def textile(content)
  RedCloth.new(content).to_html
end

#transform_pages(dir = '') ⇒ Object

Copy all regular files from <source> to <dest>/ ignoring any files/directories that are hidden or backup files (start with “.” or “#” or end with “~”) or contain site content (start with “_”) unless they are “_posts” directories or web server files such as ‘.htaccess’

The +dir+ String is a relative path used to call this method
         recursively as it descends through directories

Returns nothing



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/jekyll/site.rb', line 163

def transform_pages(dir = '')
  base = File.join(self.source, dir)
  entries = filter_entries(Dir.entries(base))
  directories = entries.select { |e| File.directory?(File.join(base, e)) }
  files = entries.reject { |e| File.directory?(File.join(base, e)) }

  # we need to make sure to process _posts *first* otherwise they
  # might not be available yet to other templates as {{ site.posts }}
  if directories.include?('_posts')
    directories.delete('_posts')
    read_posts(dir)
  end
  
  [directories, files].each do |entries|
    entries.each do |f|
      if File.directory?(File.join(base, f))
        next if self.dest.sub(/\/$/, '') == File.join(base, f)
        transform_pages(File.join(dir, f))
      elsif Pager.pagination_enabled?(self.config, f)
        paginate_posts(f, dir)
      else
        first3 = File.open(File.join(self.source, dir, f)) { |fd| fd.read(3) }

        if first3 == "---"
          # file appears to have a YAML header so process it as a page
          page = Page.new(self, self.source, dir, f)
          page.render(self.layouts, site_payload)
          page.write(self.dest)
        else
          # otherwise copy the file without transforming it
          FileUtils.mkdir_p(File.join(self.dest, dir))
          FileUtils.cp(File.join(self.source, dir, f), File.join(self.dest, dir, f))
        end
      end
    end
  end
end

#write_posts ⇒ Object

Write each post to <dest>/<year>/<month>/<day>/<slug>

Returns nothing



148
149
150
151
152
 
# File 'lib/jekyll/site.rb', line 148

def write_posts
  self.posts.each do |post|
    post.write(self.dest)
  end
end