Read in static files info `collection.files` as `StaticFile`s.
This commit is contained in:
parent
f16a5cbae1
commit
530e049d2d
|
@ -22,14 +22,28 @@ module Jekyll
|
||||||
@docs ||= []
|
@docs ||= []
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Fetch the static files in this collection.
|
||||||
|
# Defaults to an empty array if no static files have been read in.
|
||||||
|
#
|
||||||
|
# Returns an array of Jekyll::StaticFile objects.
|
||||||
|
def files
|
||||||
|
@files ||= []
|
||||||
|
end
|
||||||
|
|
||||||
# Read the allowed documents into the collection's array of docs.
|
# Read the allowed documents into the collection's array of docs.
|
||||||
#
|
#
|
||||||
# Returns the sorted array of docs.
|
# Returns the sorted array of docs.
|
||||||
def read
|
def read
|
||||||
filtered_entries.each do |file_path|
|
filtered_entries.each do |file_path|
|
||||||
doc = Jekyll::Document.new(Jekyll.sanitized_path(directory, file_path), { site: site, collection: self })
|
full_path = Jekyll.sanitized_path(directory, file_path)
|
||||||
|
if Utils.has_yaml_header? full_path
|
||||||
|
doc = Jekyll::Document.new(full_path, { site: site, collection: self })
|
||||||
doc.read
|
doc.read
|
||||||
docs << doc
|
docs << doc
|
||||||
|
else
|
||||||
|
relative_dir = File.join(relative_directory, File.dirname(file_path)).chomp("/.")
|
||||||
|
files << StaticFile.new(site, site.source, relative_dir, File.basename(full_path), self)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
docs.sort!
|
docs.sort!
|
||||||
end
|
end
|
||||||
|
@ -118,6 +132,7 @@ module Jekyll
|
||||||
metadata.merge({
|
metadata.merge({
|
||||||
"label" => label,
|
"label" => label,
|
||||||
"docs" => docs,
|
"docs" => docs,
|
||||||
|
"files" => files,
|
||||||
"directory" => directory,
|
"directory" => directory,
|
||||||
"output" => write?,
|
"output" => write?,
|
||||||
"relative_directory" => relative_directory
|
"relative_directory" => relative_directory
|
||||||
|
|
|
@ -97,20 +97,12 @@ module Jekyll
|
||||||
'.coffee'.eql?(extname)
|
'.coffee'.eql?(extname)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Determine whether the document has a YAML header.
|
|
||||||
#
|
|
||||||
# Returns true if the file starts with three dashes
|
|
||||||
def has_yaml_header?
|
|
||||||
@has_yaml_header unless @has_yaml_header.nil?
|
|
||||||
@has_yaml_header = !!(File.open(path, 'rb') { |f| f.read(5) } =~ /\A---\r?\n/)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Determine whether the file should be rendered with Liquid.
|
# Determine whether the file should be rendered with Liquid.
|
||||||
#
|
#
|
||||||
# Returns false if the document is either an asset file or a yaml file,
|
# Returns false if the document is either an asset file or a yaml file,
|
||||||
# true otherwise.
|
# true otherwise.
|
||||||
def render_with_liquid?
|
def render_with_liquid?
|
||||||
!(coffeescript_file? || yaml_file?) && has_yaml_header?
|
!(coffeescript_file? || yaml_file?)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Determine whether the file should be placed into layouts.
|
# Determine whether the file should be placed into layouts.
|
||||||
|
@ -118,7 +110,7 @@ module Jekyll
|
||||||
# Returns false if the document is either an asset file or a yaml file,
|
# Returns false if the document is either an asset file or a yaml file,
|
||||||
# true otherwise.
|
# true otherwise.
|
||||||
def place_in_layout?
|
def place_in_layout?
|
||||||
!(asset_file? || yaml_file?) && has_yaml_header?
|
!(asset_file? || yaml_file?)
|
||||||
end
|
end
|
||||||
|
|
||||||
# The URL template where the document would be accessible.
|
# The URL template where the document would be accessible.
|
||||||
|
@ -214,7 +206,7 @@ module Jekyll
|
||||||
unless defaults.empty?
|
unless defaults.empty?
|
||||||
@data = defaults
|
@data = defaults
|
||||||
end
|
end
|
||||||
@content = File.open(path, "rb", merged_file_read_opts(opts)) { |f| f.read }
|
@content = File.read(path, merged_file_read_opts(opts))
|
||||||
if content =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
|
if content =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
|
||||||
@content = $POSTMATCH
|
@content = $POSTMATCH
|
||||||
data_file = SafeYAML.load($1)
|
data_file = SafeYAML.load($1)
|
||||||
|
|
|
@ -144,7 +144,7 @@ module Jekyll
|
||||||
if File.directory?(f_abs)
|
if File.directory?(f_abs)
|
||||||
f_rel = File.join(dir, f)
|
f_rel = File.join(dir, f)
|
||||||
read_directories(f_rel) unless dest.sub(/\/$/, '') == f_abs
|
read_directories(f_rel) unless dest.sub(/\/$/, '') == f_abs
|
||||||
elsif has_yaml_header?(f_abs)
|
elsif Utils.has_yaml_header?(f_abs)
|
||||||
page = Page.new(self, source, dir, f)
|
page = Page.new(self, source, dir, f)
|
||||||
pages << page if publisher.publish?(page)
|
pages << page if publisher.publish?(page)
|
||||||
else
|
else
|
||||||
|
@ -432,7 +432,7 @@ module Jekyll
|
||||||
|
|
||||||
def documents
|
def documents
|
||||||
collections.reduce(Set.new) do |docs, (_, collection)|
|
collections.reduce(Set.new) do |docs, (_, collection)|
|
||||||
docs.merge(collection.docs)
|
docs + collection.docs + collection.files
|
||||||
end.to_a
|
end.to_a
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@ -454,10 +454,6 @@ module Jekyll
|
||||||
pages.any? { |page| page.uses_relative_permalinks }
|
pages.any? { |page| page.uses_relative_permalinks }
|
||||||
end
|
end
|
||||||
|
|
||||||
def has_yaml_header?(file)
|
|
||||||
!!(File.open(file, 'rb') { |f| f.read(5) } =~ /\A---\r?\n/)
|
|
||||||
end
|
|
||||||
|
|
||||||
def limit_posts!
|
def limit_posts!
|
||||||
limit = posts.length < limit_posts ? posts.length : limit_posts
|
limit = posts.length < limit_posts ? posts.length : limit_posts
|
||||||
self.posts = posts[-limit, limit]
|
self.posts = posts[-limit, limit]
|
||||||
|
|
|
@ -9,11 +9,12 @@ module Jekyll
|
||||||
# base - The String path to the <source>.
|
# base - The String path to the <source>.
|
||||||
# dir - The String path between <source> and the file.
|
# dir - The String path between <source> and the file.
|
||||||
# name - The String filename of the file.
|
# name - The String filename of the file.
|
||||||
def initialize(site, base, dir, name)
|
def initialize(site, base, dir, name, collection = nil)
|
||||||
@site = site
|
@site = site
|
||||||
@base = base
|
@base = base
|
||||||
@dir = dir
|
@dir = dir
|
||||||
@name = name
|
@name = name
|
||||||
|
@collection = collection
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns source file path.
|
# Returns source file path.
|
||||||
|
@ -23,7 +24,11 @@ module Jekyll
|
||||||
|
|
||||||
# Returns the source file path relative to the site source
|
# Returns the source file path relative to the site source
|
||||||
def relative_path
|
def relative_path
|
||||||
@relative_path ||= path.sub(/\A#{@site.source}/, '')
|
@relative_path ||= File.join(*[@dir, @name].compact)
|
||||||
|
end
|
||||||
|
|
||||||
|
def extname
|
||||||
|
File.extname(path)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Obtain destination path.
|
# Obtain destination path.
|
||||||
|
@ -32,8 +37,12 @@ module Jekyll
|
||||||
#
|
#
|
||||||
# Returns destination file path.
|
# Returns destination file path.
|
||||||
def destination(dest)
|
def destination(dest)
|
||||||
|
if @collection
|
||||||
|
File.join(*[dest, @dir.gsub(/\A_/, ''), @name].compact)
|
||||||
|
else
|
||||||
File.join(*[dest, @dir, @name].compact)
|
File.join(*[dest, @dir, @name].compact)
|
||||||
end
|
end
|
||||||
|
end
|
||||||
|
|
||||||
# Returns last modification time for this file.
|
# Returns last modification time for this file.
|
||||||
def mtime
|
def mtime
|
||||||
|
@ -47,6 +56,13 @@ module Jekyll
|
||||||
@@mtimes[path] != mtime
|
@@mtimes[path] != mtime
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Whether to write the file to the filesystem
|
||||||
|
#
|
||||||
|
# Returns true.
|
||||||
|
def write?
|
||||||
|
true
|
||||||
|
end
|
||||||
|
|
||||||
# Write the static file to the destination directory (if modified).
|
# Write the static file to the destination directory (if modified).
|
||||||
#
|
#
|
||||||
# dest - The String path to the destination dir.
|
# dest - The String path to the destination dir.
|
||||||
|
@ -75,7 +91,7 @@ module Jekyll
|
||||||
|
|
||||||
def to_liquid
|
def to_liquid
|
||||||
{
|
{
|
||||||
"path" => relative_path,
|
"path" => File.join("", relative_path),
|
||||||
"modified_time" => mtime.to_s,
|
"modified_time" => mtime.to_s,
|
||||||
"extname" => File.extname(relative_path)
|
"extname" => File.extname(relative_path)
|
||||||
}
|
}
|
||||||
|
|
|
@ -2,3 +2,5 @@
|
||||||
title: Example slide
|
title: Example slide
|
||||||
layout: slide
|
layout: slide
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Wooot
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
---
|
||||||
|
---
|
||||||
|
|
||||||
|
I'm a file with dots.
|
|
@ -62,7 +62,7 @@ class TestDocument < Test::Unit::TestCase
|
||||||
}]
|
}]
|
||||||
}))
|
}))
|
||||||
@site.process
|
@site.process
|
||||||
@document = @site.collections["slides"].docs.first
|
@document = @site.collections["slides"].docs.select{|d| d.is_a?(Document) }.first
|
||||||
end
|
end
|
||||||
|
|
||||||
should "know the frontmatter defaults" do
|
should "know the frontmatter defaults" do
|
||||||
|
@ -199,20 +199,24 @@ class TestDocument < Test::Unit::TestCase
|
||||||
"destination" => dest_dir
|
"destination" => dest_dir
|
||||||
}))
|
}))
|
||||||
@site.process
|
@site.process
|
||||||
@document = @site.collections["slides"].docs.find { |doc| doc.relative_path == "_slides/octojekyll.png" }
|
@document = @site.collections["slides"].files.find { |doc| doc.relative_path == "_slides/octojekyll.png" }
|
||||||
@dest_file = dest_dir("slides/octojekyll.png")
|
@dest_file = dest_dir("slides/octojekyll.png")
|
||||||
end
|
end
|
||||||
|
|
||||||
should "be a document" do
|
should "be a static file" do
|
||||||
assert !@document.nil?
|
assert_equal true, @document.is_a?(StaticFile)
|
||||||
end
|
end
|
||||||
|
|
||||||
should "not be rendered with Liquid" do
|
should "be set to write" do
|
||||||
assert !@document.render_with_liquid?
|
assert @document.write?
|
||||||
|
end
|
||||||
|
|
||||||
|
should "be in the list of docs_to_write" do
|
||||||
|
assert @site.docs_to_write.include?(@document)
|
||||||
end
|
end
|
||||||
|
|
||||||
should "be output in the correct place" do
|
should "be output in the correct place" do
|
||||||
assert File.file? @dest_file
|
assert_equal true, File.file?(@dest_file)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
|
@ -190,12 +190,12 @@ class TestSite < Test::Unit::TestCase
|
||||||
|
|
||||||
should "read pages with yaml front matter" do
|
should "read pages with yaml front matter" do
|
||||||
abs_path = File.expand_path("about.html", @site.source)
|
abs_path = File.expand_path("about.html", @site.source)
|
||||||
assert_equal true, @site.send(:has_yaml_header?, abs_path)
|
assert_equal true, Utils.has_yaml_header?(abs_path)
|
||||||
end
|
end
|
||||||
|
|
||||||
should "enforce a strict 3-dash limit on the start of the YAML front-matter" do
|
should "enforce a strict 3-dash limit on the start of the YAML front-matter" do
|
||||||
abs_path = File.expand_path("pgp.key", @site.source)
|
abs_path = File.expand_path("pgp.key", @site.source)
|
||||||
assert_equal false, @site.send(:has_yaml_header?, abs_path)
|
assert_equal false, Utils.has_yaml_header?(abs_path)
|
||||||
end
|
end
|
||||||
|
|
||||||
should "expose jekyll version to site payload" do
|
should "expose jekyll version to site payload" do
|
||||||
|
|
Loading…
Reference in New Issue