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>



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/jekyll/site.rb', line 13

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

  self.safe            = config['safe']
  self.source          = File.expand_path(config['source'])
  self.dest            = File.expand_path(config['destination'])
  self.plugins         = File.expand_path(config['plugins'])
  self.lsi             = config['lsi']
  self.pygments        = config['pygments']
  self.permalink_style = config['permalink'].to_sym
  self.exclude         = config['exclude'] || []
  self.future          = config['future']

  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

#converters ⇒ Object

Returns the value of attribute converters.



7
8
9
 
# File 'lib/jekyll/site.rb', line 7

def converters
  @converters
end

#dest ⇒ Object

Returns the value of attribute dest.



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

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

#future ⇒ Object

Returns the value of attribute future.



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

def future
  @future
end

#generators ⇒ Object

Returns the value of attribute generators.



7
8
9
 
# File 'lib/jekyll/site.rb', line 7

def generators
  @generators
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.



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

def lsi
  @lsi
end

#pages ⇒ Object

Returns the value of attribute pages.



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

def pages
  @pages
end

#permalink_style ⇒ Object

Returns the value of attribute permalink_style.



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

def permalink_style
  @permalink_style
end

#plugins ⇒ Object

Returns the value of attribute plugins.



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

def plugins
  @plugins
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.



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

def pygments
  @pygments
end

#safe ⇒ Object

Returns the value of attribute safe.



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

def safe
  @safe
end

#source ⇒ Object

Returns the value of attribute source.



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

def source
  @source
end

#static_files ⇒ Object

Returns the value of attribute static_files.



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

def static_files
  @static_files
end

#tags ⇒ Object

Returns the value of attribute tags.



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

def tags
  @tags
end

#time ⇒ Object

Returns the value of attribute time.



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

def time
  @time
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 “_”), or are excluded in the site configuration, unless they are web server files such as ‘.htaccess’



226
227
228
229
230
231
232
 
# File 'lib/jekyll/site.rb', line 226

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

#generate ⇒ Object 



127
128
129
130
131
 
# File 'lib/jekyll/site.rb', line 127

def generate
  self.generators.each do |generator|
    generator.generate(self)
  end
end

#post_attr_hash(post_attr) ⇒ Object

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

Returns => [<Post>]



197
198
199
200
201
202
203
204
 
# File 'lib/jekyll/site.rb', line 197

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. 5 phases; reset, read, generate, render, write. This allows rendering to have full site payload available.

Returns nothing



73
74
75
76
77
78
79
 
# File 'lib/jekyll/site.rb', line 73

def process
  self.reset
  self.read
  self.generate
  self.render
  self.write
end

#read ⇒ Object 



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

def read
  self.read_layouts # existing implementation did this at top level only so preserved that
  self.read_directories
end

#read_directories(dir = '') ⇒ Object

Reads the directories and finds posts, pages and static files that will become part of the valid site according to the rules in filter_entries.

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

Returns nothing



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/jekyll/site.rb', line 169

def read_directories(dir = '')
  base = File.join(self.source, dir)
  entries = filter_entries(Dir.entries(base))

  self.read_posts(dir)

  entries.each do |f|
    f_abs = File.join(base, f)
    f_rel = File.join(dir, f)
    if File.directory?(f_abs)
      next if self.dest.sub(/\/$/, '') == f_abs
      read_directories(f_rel)
    elsif !File.symlink?(f_abs)
      first3 = File.open(f_abs) { |fd| fd.read(3) }
      if first3 == "---"
        # file appears to have a YAML header so process it as a page
        pages << Page.new(self, self.source, dir, f)
      else
        # otherwise treat it as a static file
        static_files << StaticFile.new(self, self.source, dir, f)
      end
    end
  end
end

#read_layouts(dir = '') ⇒ Object

Read all the files in <source>/<dir>/_layouts and create a new Layout object with each one.

Returns nothing



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/jekyll/site.rb', line 90

def read_layouts(dir = '')
  base = File.join(self.source, dir, "_layouts")
  return unless File.exists?(base)
  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
end

#read_posts(dir) ⇒ Object

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

Returns nothing



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/jekyll/site.rb', line 106

def read_posts(dir)
  base = File.join(self.source, dir, '_posts')
  return unless File.exists?(base)
  entries = Dir.chdir(base) { 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.future || post.date <= self.time)
        self.posts << post
        post.categories.each { |c| self.categories[c] << post }
        post.tags.each { |c| self.tags[c] << post }
      end
    end
  end

  self.posts.sort!
end

#render ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/jekyll/site.rb', line 133

def render
  self.posts.each do |post|
    post.render(self.layouts, site_payload)
  end

  self.pages.each do |page|
    page.render(self.layouts, site_payload)
  end

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

#reset ⇒ Object 



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

def reset
  self.time            = if self.config['time']
                           Time.parse(self.config['time'].to_s)
                         else
                           Time.now
                         end
  self.layouts         = {}
  self.posts           = []
  self.pages           = []
  self.static_files    = []
  self.categories      = Hash.new { |hash, key| hash[key] = [] }
  self.tags            = Hash.new { |hash, key| hash[key] = [] }
end

#setup ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/jekyll/site.rb', line 44

def setup
  require 'classifier' if self.lsi

  # If safe mode is off, load in any ruby files under the plugins
  # directory.
  unless self.safe
    Dir[File.join(self.plugins, "**/*.rb")].each do |f|
      require f
    end
  end

  self.converters = Jekyll::Converter.subclasses.select do |c|
    !self.safe || c.safe
  end.map do |c|
    c.new(self.config)
  end

  self.generators = Jekyll::Generator.subclasses.select do |c|
    !self.safe || c.safe
  end.map do |c|
    c.new(self.config)
  end
end

#site_payload ⇒ Object

The Hash payload containing site-wide data

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

"posts" => [<Post>],
"pages" => [<Page>],
"categories" => [<Post>]



212
213
214
215
216
217
218
219
220
 
# File 'lib/jekyll/site.rb', line 212

def site_payload
  {"site" => self.config.merge({
      "time"       => self.time,
      "posts"      => self.posts.sort { |a,b| b <=> a },
      "pages"      => self.pages,
      "html_pages" => self.pages.reject { |page| !page.html? },
      "categories" => post_attr_hash('categories'),
      "tags"       => post_attr_hash('tags')})}
end

#write ⇒ Object

Write static files, pages and posts

Returns nothing



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/jekyll/site.rb', line 151

def write
  self.posts.each do |post|
    post.write(self.dest)
  end
  self.pages.each do |page|
    page.write(self.dest)
  end
  self.static_files.each do |sf|
    sf.write(self.dest)
  end
end