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, ignore_pattern = '^$') ⇒ 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
+ignore_pattern+ is a regular expression String which
                 specifies a group of files which should not
                 be processed or appear in the generated
                 site. A regular expression matching any files
                 beginning with a `.' or a `_', other than
                 `.htaccess' and `_posts', will automatically
                 be appended to this parameter.

Returns <Site>



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/jekyll/site.rb', line 22

def initialize(source, dest, ignore_pattern = '^$')
  self.source = source
  self.dest = dest
  self.ignore_pattern = Regexp.new(ignore_pattern + '|^\.(?!htaccess).*$|^_(?!posts).*$')
  self.layouts = {}
  self.posts = []
  self.categories = Hash.new { |hash, key| hash[key] = Array.new }
  self.read_settings
  self.options = {}

  config_file_path = File.join(self.source, '.jekyllrc')
  if File.exists?(config_file_path)
    self.options = YAML.load(File.read(config_file_path))
  end
  
  self.options['layouts_path']  ||= File.join(self.source, '_layouts')
  self.options['includes_path'] ||= File.join(self.source, '_includes')
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

#dest ⇒ Object

Returns the value of attribute dest.



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

def dest
  @dest
end

#ignore_pattern ⇒ Object

Returns the value of attribute ignore_pattern.



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

def ignore_pattern
  @ignore_pattern
end

#layouts ⇒ Object

Returns the value of attribute layouts.



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

def layouts
  @layouts
end

#options ⇒ Object

Returns the value of attribute options.



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

def options
  @options
end

#posts ⇒ Object

Returns the value of attribute posts.



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

def posts
  @posts
end

#settings ⇒ Object

Returns the value of attribute settings.



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

def settings
  @settings
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’



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

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
  entries = entries.reject { |e| ignore_pattern.match(e) }
end

#post_attr_hash(post_attr) ⇒ Object

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

Returns => [<Post>]



174
175
176
177
178
179
180
181
 
# File 'lib/jekyll/site.rb', line 174

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



45
46
47
48
49
50
51
52
 
# File 'lib/jekyll/site.rb', line 45

def process
  self.read_layouts
  self.transform_pages
  if options['also_copy']
    self.transform_pages('', options['also_copy'])
  end
  self.write_posts
end

#read_layouts ⇒ Object

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

Returns nothing



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/jekyll/site.rb', line 67

def read_layouts
  base = options['layouts_path']
  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



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
 
# File 'lib/jekyll/site.rb', line 83

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

  self.posts.sort!
  
  # second pass renders each post now that full site payload is available
  self.posts.each_with_index do |post, idx|
    post.previous = posts[idx - 1] unless idx - 1 < 0
    post.next = posts[idx + 1] unless idx + 1 >= posts.size
    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

#read_settings ⇒ Object

read settings from _site.yaml



55
56
57
58
59
60
61
62
 
# File 'lib/jekyll/site.rb', line 55

def read_settings
  file = File.join(self.source, "_site.yaml")
  if File.exist?(file)
    self.settings = File.open(file) { |f| YAML::load(f) }
  else
    self.settings = {}
  end
end

#site_payload ⇒ Object

The Hash payload containing site-wide data

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

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/jekyll/site.rb', line 189

def site_payload
  all_posts = self.posts.sort { |a,b| b <=> a }
  latest_posts = all_posts[0..2]
  older_posts = all_posts[3..7]
  rss_posts = all_posts[0..25]
  
  {"site" => self.settings.merge({
    "time" => Time.now, 
    "posts" => all_posts,
    "latest_posts" => latest_posts,
    "older_posts" => older_posts,
    "rss_posts" => rss_posts,
    "categories" => post_attr_hash('categories'),
    "topics" => post_attr_hash('topics')
  })}
end

#transform_pages(dir = '', source = self.source) ⇒ Object

Copy all regular files from <source> to <dest>/ ignoring any files/directories that match the regular expression supplied when creating this.

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

Returns nothing



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/jekyll/site.rb', line 130

def transform_pages(dir = '', source = self.source)
  base = File.join(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 entries.include?('_posts')
    entries.delete('_posts')
    read_posts(dir)
  end
  [directories, files].each do |entries|
    entries.each do |f|
      if File.symlink?(File.join(base, f))
        # preserve symlinks
        FileUtils.mkdir_p(File.join(self.dest, dir))
        File.symlink(File.readlink(File.join(base, f)),
                     File.join(self.dest, dir, f))
      elsif File.directory?(File.join(base, f))
        next if self.dest.sub(/\/$/, '') == File.join(base, f)
        transform_pages(File.join(dir, f), source)
      else
        first3 = File.open(File.join(source, dir, f)) { |fd| fd.read(3) }
    
        # if the file appears to have a YAML header then process it as a page
        if first3 == "---"
          # file appears to have a YAML header so process it as a page
          page = Page.new(source, dir, f)
          page.add_layout(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(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



117
118
119
120
121
 
# File 'lib/jekyll/site.rb', line 117

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