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(source, dest) ⇒ Site

Initialize the site

+source+ is String path to the source directory containing
         the proto-site
+dest+ is the String path to the directory where the generated
       site should be written

Returns <Site>



14
15
16
17
18
19
20
21
 
# File 'lib/jekyll/site.rb', line 14

def initialize(source, dest)
  self.source = source
  self.dest = dest
  self.layouts = {}
  self.posts = []
  self.categories = Hash.new { |hash, key| hash[key] = Array.new }
  self.collated = {}
end

Instance Attribute Details

#categories ⇒ Object

Returns the value of attribute categories.



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

def categories
  @categories
end

#collated ⇒ Object

Returns the value of attribute collated.



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

def collated
  @collated
end

#dest ⇒ Object

Returns the value of attribute dest.



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

def dest
  @dest
end

#layouts ⇒ Object

Returns the value of attribute layouts.



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

def layouts
  @layouts
end

#posts ⇒ Object

Returns the value of attribute posts.



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

def posts
  @posts
end

#source ⇒ Object

Returns the value of attribute source.



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

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’



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

def filter_entries(entries)
  entries = entries.reject do |e|
    unless ['_posts', '.htaccess'].include?(e)
      # Reject backup/hidden
      ['.', '_', '#'].include?(e[0..0]) or e[-1..-1] == '~'
    end
  end
end

#post_attr_hash(post_attr) ⇒ Object

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

Returns => [<Post>]



201
202
203
204
205
206
207
208
 
# File 'lib/jekyll/site.rb', line 201

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



27
28
29
30
31
32
33
 
# File 'lib/jekyll/site.rb', line 27

def process
  self.read_layouts
  self.transform_pages
  self.write_posts
  self.write_archives
  self.write_category_indexes
end

#read_layouts ⇒ Object

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

Returns nothing



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

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(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



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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/jekyll/site.rb', line 54

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.source, dir, f)

      if post.published
        self.posts << post
        post.categories.each { |c| self.categories[c] << post }
      end
    end
  end
  
  # 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.posts.sort!
  self.categories.values.map { |cats| cats.sort! { |a, b| b <=> a} }

  # build collated post structure for archives
  self.posts.reverse.each do |post|
    y, m, d = post.date.year, post.date.month, post.date.day
    unless self.collated.key? y
      self.collated[y] = {}
    end
    unless self.collated[y].key? m
      self.collated[y][m] = {}
    end
    unless self.collated[y][m].key? d
      self.collated[y][m][d] = []
    end
    self.collated[y][m][d] += [post]
  end
rescue Errno::ENOENT => e
  # ignore missing layout dir
end

#site_payload ⇒ Object

The Hash payload containing site-wide data

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

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



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

def site_payload
  {"site" => {
    "time" => Time.now, 
    "posts" => self.posts.sort { |a,b| b <=> a },
    "collated_posts" => self.collated,
    "categories" => post_attr_hash('categories'),
    "topics" => post_attr_hash('topics')
  }}
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
 
# 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))
      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.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_archive(dir, type) ⇒ Object 



106
107
108
109
110
 
# File 'lib/jekyll/site.rb', line 106

def write_archive(dir, type)
  archive = Archive.new(self.source, dir, type)
  archive.render(self.layouts, site_payload)
  archive.write(self.dest)
end

#write_archives ⇒ Object

Write out archive pages based on special layouts. Yearly, monthly, and daily archives will be written if layouts exist. Yearly archives will be in <dest>/<year>/index.html and other archives will be generated similarly.

Returns nothing.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/jekyll/site.rb', line 118

def write_archives
  self.collated.keys.each do |year|
    if self.layouts.key? 'archive_yearly'
      self.write_archive(year.to_s, 'archive_yearly')
    end

    self.collated[year].keys.each do |month|
      if self.layouts.key? 'archive_monthly'
        self.write_archive(File.join(year.to_s, "%02d" % month), 'archive_monthly')
      end

      self.collated[year][month].keys.each do |day|
        if self.layouts.key? 'archive_daily'
          self.write_archive(File.join(year.to_s, "%02d" % month, "%02d" % day), 'archive_daily')
        end
      end
    end
  end
end

#write_category_index(dir, category) ⇒ Object 



138
139
140
141
142
 
# File 'lib/jekyll/site.rb', line 138

def write_category_index(dir, category)
  index = CategoryIndex.new(self.source, dir, category)
  index.render(self.layouts, site_payload)
  index.write(self.dest)
end

#write_category_indexes ⇒ Object

Write out category indexes if a layout called category_index.html exists The category indexes will be created in <dest>/category/<category>/index.html



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

def write_category_indexes
  if self.layouts.key? 'category_index'
    self.categories.keys.each do |category|
      self.write_category_index(File.join('category', category), category)
    end
  end
end

#write_posts ⇒ Object

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

Returns nothing



100
101
102
103
104
 
# File 'lib/jekyll/site.rb', line 100

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