Class: Jekyll::Site
- Inherits:
-
Object
- Object
- Jekyll::Site
- Defined in:
- lib/jekyll/site.rb
Instance Attribute Summary collapse
-
#categories ⇒ Object
Returns the value of attribute categories.
-
#dest ⇒ Object
Returns the value of attribute dest.
-
#layouts ⇒ Object
Returns the value of attribute layouts.
-
#posts ⇒ Object
Returns the value of attribute posts.
-
#source ⇒ Object
Returns the value of attribute source.
Instance Method Summary collapse
-
#initialize(source, dest) ⇒ Site
constructor
Initialize the site
source
is String path to the source directory containing the proto-sitedest
is the String path to the directory where the generated site should be written. -
#post_attr_hash(post_attr) ⇒ Object
Constructs a hash map of Posts indexed by the specified Post attribute.
-
#process ⇒ Object
Do the actual work of processing the site and generating the real deal.
-
#read_layouts ⇒ Object
Read all the files in <source>/_layouts except backup files (end with “~”) into memory for later use.
-
#read_posts(dir) ⇒ Object
Read all the files in <base>/_posts except backup files (end with “~”) and create a new Post object with each one.
-
#site_payload ⇒ Object
The Hash payload containing site-wide data.
-
#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 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. -
#write_posts ⇒ Object
Write each post to <dest>/<year>/<month>/<day>/<slug>.
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 |
# 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 } 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 |
#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
#post_attr_hash(post_attr) ⇒ Object
Constructs a hash map of Posts indexed by the specified Post attribute
Returns => [<Post>]
145 146 147 148 149 150 151 152 |
# File 'lib/jekyll/site.rb', line 145 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
26 27 28 29 30 |
# File 'lib/jekyll/site.rb', line 26 def process self.read_layouts self.transform_pages self.write_posts end |
#read_layouts ⇒ Object
Read all the files in <source>/_layouts except backup files (end with “~”) into memory for later use.
Returns nothing
36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/jekyll/site.rb', line 36 def read_layouts base = File.join(self.source, "_layouts") entries = Dir.entries(base) entries = entries.reject { |e| e[-1..-1] == '~' } entries = entries.reject { |e| File.directory?(File.join(base, e)) } 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 except backup files (end with “~”) 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 |
# File 'lib/jekyll/site.rb', line 54 def read_posts(dir) base = File.join(self.source, dir, '_posts') entries = [] Dir.chdir(base) { entries = Dir['**/*'] } entries = entries.reject { |e| e[-1..-1] == '~' } entries = entries.reject { |e| File.directory?(File.join(base, e)) } # 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} } rescue Errno::ENOENT => e # ignore missing layout dir end |
#site_payload ⇒ Object
The Hash payload containing site-wide data
Returns => {“time” => <Time>,
"posts" => [<Post>],
"categories" => [<Post>],
"topics" => [<Post>] }
160 161 162 163 164 165 166 167 |
# File 'lib/jekyll/site.rb', line 160 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 |
#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 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
103 104 105 106 107 108 109 110 111 112 113 114 115 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 |
# File 'lib/jekyll/site.rb', line 103 def transform_pages(dir = '') base = File.join(self.source, dir) entries = Dir.entries(base) entries = entries.reject { |e| e[-1..-1] == '~' } entries = entries.reject do |e| (e != '_posts') and ['.', '_'].include?(e[0..0]) unless ['.htaccess'].include?(e) end 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.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_posts ⇒ Object
Write each post to <dest>/<year>/<month>/<day>/<slug>
Returns nothing
88 89 90 91 92 |
# File 'lib/jekyll/site.rb', line 88 def write_posts self.posts.each do |post| post.write(self.dest) end end |