# frozen_string_literal: true require "helper" class TestDocument < JekyllUnitTest def assert_equal_value(key, one, other) assert_equal(one[key], other[key]) end def setup_encoded_document(filename) site = fixture_site("collections" => ["encodings"]) site.process Document.new(site.in_source_dir(File.join("_encodings", filename)), :site => site, :collection => site.collections["encodings"]).tap(&:read) end def setup_document_with_dates(filename) site = fixture_site("collections" => ["dates"]) site.process docs = nil with_env("TZ", "UTC") do docs = Document.new(site.in_source_dir(File.join("_dates", filename)), :site => site, :collection => site.collections["dates"]).tap(&:read) end docs end context "a document in a collection" do setup do @site = fixture_site( "collections" => ["methods"] ) @site.process @document = @site.collections["methods"].docs.detect do |d| d.relative_path == "_methods/configuration.md" end end should "exist" do assert !@document.nil? end should "know its relative path" do assert_equal "_methods/configuration.md", @document.relative_path end should "knows its extname" do assert_equal ".md", @document.extname end should "know its basename" do assert_equal "configuration.md", @document.basename end should "know its basename without extname" do assert_equal "configuration", @document.basename_without_ext end should "know its type" do assert_equal :methods, @document.type end should "know whether it's a YAML file" do assert_equal false, @document.yaml_file? end should "know its data" do assert_equal "Jekyll.configuration", @document.data["title"] assert_equal "foo.bar", @document.data["whatever"] end should "know its date" do assert_nil @document.data["date"] assert_equal Time.now.strftime("%Y/%m/%d"), @document.date.strftime("%Y/%m/%d") assert_equal Time.now.strftime("%Y/%m/%d"), @document.to_liquid["date"].strftime("%Y/%m/%d") end should "be jsonify-able" do page_json = @document.to_liquid.to_json parsed = JSON.parse(page_json) assert_equal "Jekyll.configuration", parsed["title"] assert_equal "foo.bar", parsed["whatever"] assert_equal "_methods/collection/entries", parsed["previous"]["path"] assert_equal "Collection#entries", parsed["previous"]["title"] next_doc = parsed["next"] assert_equal "_methods/escape-+ #%20[].md", next_doc["path"] assert_equal "Jekyll.escape", next_doc["title"] next_prev_doc = next_doc["previous"] assert_equal "Jekyll.configuration", next_prev_doc["title"] assert_equal "_methods/configuration.md", next_prev_doc["path"] assert_equal "_methods/escape-+ #%20[].md", next_prev_doc["next"]["path"] assert_equal "_methods/collection/entries", next_prev_doc["previous"]["path"] assert_nil next_prev_doc["next"]["next"] assert_nil next_prev_doc["next"]["previous"] assert_nil next_prev_doc["next"]["content"] assert_nil next_prev_doc["next"]["excerpt"] assert_nil next_prev_doc["next"]["output"] next_next_doc = next_doc["next"] assert_equal "Jekyll.sanitized_path", next_next_doc["title"] assert_equal "_methods/sanitized_path.md", next_next_doc["path"] assert_equal "_methods/escape-+ #%20[].md", next_next_doc["previous"]["path"] assert_equal "_methods/site/generate.md", next_next_doc["next"]["path"] assert_nil next_next_doc["next"]["next"] assert_nil next_next_doc["next"]["previous"] assert_nil next_next_doc["next"]["content"] assert_nil next_next_doc["next"]["excerpt"] assert_nil next_next_doc["next"]["output"] assert_nil next_next_doc["previous"]["next"] assert_nil next_next_doc["previous"]["previous"] assert_nil next_next_doc["previous"]["content"] assert_nil next_next_doc["previous"]["excerpt"] assert_nil next_next_doc["previous"]["output"] end context "with the basename (without extension) ending with dot(s)" do setup do @site = fixture_site("collections" => ["methods"]) @site.process @document = @site.collections["methods"].docs.detect do |d| d.relative_path == "_methods/trailing-dots...md" end end should "render into the proper url" do assert_equal "/methods/trailing-dots.html", @document.url trailing_dots_doc = @site.posts.docs.detect do |d| d.relative_path == "_posts/2018-10-12-trailing-dots...markdown" end assert_equal "/2018/10/12/trailing-dots.html", trailing_dots_doc.url end end context "with YAML ending in three dots" do setup do @site = fixture_site("collections" => ["methods"]) @site.process @document = @site.collections["methods"].docs.detect do |d| d.relative_path == "_methods/yaml_with_dots.md" end end should "know its data" do assert_equal "YAML with Dots", @document.data["title"] assert_equal "foo.bar", @document.data["whatever"] end end should "output the collection name in the #to_liquid method" do assert_equal "methods", @document.to_liquid["collection"] end should "output its relative path as path in Liquid" do assert_equal "_methods/configuration.md", @document.to_liquid["path"] end end context "a document as part of a collection with front matter defaults" do setup do @site = fixture_site( "collections" => ["slides"], "defaults" => [{ "scope" => { "path" => "", "type" => "slides" }, "values" => { "nested" => { "key" => "myval", }, }, }] ) @site.process @document = @site.collections["slides"].docs.select { |d| d.is_a?(Document) }.first end should "know the front matter defaults" do assert_equal "Example slide", @document.data["title"] assert_equal "slide", @document.data["layout"] assert_equal({ "key"=>"myval" }, @document.data["nested"]) end should "return front matter defaults via to_liquid" do hash = @document.to_liquid assert hash.key? "nested" assert_equal({ "key"=>"myval" }, hash["nested"]) end end context "a document as part of a collection with overridden default values" do setup do @site = fixture_site( "collections" => ["slides"], "defaults" => [{ "scope" => { "path" => "", "type" => "slides" }, "values" => { "nested" => { "test1" => "default1", "test2" => "default1", }, }, }] ) @site.process @document = @site.collections["slides"].docs[1] end should "override default values in the document front matter" do assert_equal "Override title", @document.data["title"] assert_equal "slide", @document.data["layout"] assert_equal( { "test1" => "override1", "test2" => "override2" }, @document.data["nested"] ) end end context "a document as part of a collection with valid path" do setup do @site = fixture_site( "collections" => ["slides"], "defaults" => [{ "scope" => { "path" => "_slides", "type" => "slides" }, "values" => { "nested" => { "key" => "value123", }, }, }] ) @site.process @document = @site.collections["slides"].docs.first end should "know the front matter defaults" do assert_equal "Example slide", @document.data["title"] assert_equal "slide", @document.data["layout"] assert_equal({ "key"=>"value123" }, @document.data["nested"]) end end context "a document as part of a collection with invalid path" do setup do @site = fixture_site( "collections" => ["slides"], "defaults" => [{ "scope" => { "path" => "somepath", "type" => "slides" }, "values" => { "nested" => { "key" => "myval", }, }, }] ) @site.process @document = @site.collections["slides"].docs.first end should "not know the specified front matter defaults" do assert_equal "Example slide", @document.data["title"] assert_equal "slide", @document.data["layout"] assert_nil @document.data["nested"] end end context "a document in a collection with a custom permalink" do setup do @site = fixture_site( "collections" => ["slides"] ) @site.process @document = @site.collections["slides"].docs[2] @dest_file = dest_dir("slide/3/index.html") end should "know its permalink" do assert_equal "/slide/3/", @document.permalink end should "produce the right URL" do assert_equal "/slide/3/", @document.url end end context "a document in a collection with custom filename permalinks" do setup do @site = fixture_site( "collections" => { "slides" => { "output" => true, "permalink" => "/slides/test/:name", }, }, "permalink" => "pretty" ) @site.process @document = @site.collections["slides"].docs[0] @dest_file = dest_dir("slides/test/example-slide-1.html") end should "produce the right URL" do assert_equal "/slides/test/example-slide-1", @document.url end should "produce the right destination file" do assert_equal @dest_file, @document.destination(dest_dir) end should "honor the output extension of its permalink" do assert_equal ".html", @document.output_ext end end context "a document in a collection with pretty permalink style" do setup do @site = fixture_site( "collections" => { "slides" => { "output" => true, }, } ) @site.permalink_style = :pretty @site.process @document = @site.collections["slides"].docs[0] @dest_file = dest_dir("slides/example-slide-1/index.html") end should "produce the right URL" do assert_equal "/slides/example-slide-1/", @document.url end should "produce the right destination file" do assert_equal @dest_file, @document.destination(dest_dir) end end context "a document in a collection with cased file name" do setup do @site = fixture_site( "collections" => { "slides" => { "output" => true, }, } ) @site.permalink_style = :pretty @site.process @document = @site.collections["slides"].docs[7] @dest_file = dest_dir("slides/example-slide-Upper-Cased/index.html") end should "produce the right cased URL" do assert_equal "/slides/example-slide-Upper-Cased/", @document.url end end context "a document in a collection with cased file name" do setup do @site = fixture_site( "collections" => { "slides" => { "output" => true, }, } ) @site.process @document = @site.collections["slides"].docs[6] @dest_file = dest_dir("slides/example-slide-7.php") end should "be written out properly" do assert_exist @dest_file end should "produce the permalink as the url" do assert_equal "/slides/example-slide-7.php", @document.url end should "be written to the proper directory" do assert_equal @dest_file, @document.destination(dest_dir) end should "honor the output extension of its permalink" do assert_equal ".php", @document.output_ext end end context "documents in a collection with custom title permalinks" do setup do @site = fixture_site( "collections" => { "slides" => { "output" => true, "permalink" => "/slides/:title", }, } ) @site.process @document = @site.collections["slides"].docs[3] @document_without_slug = @site.collections["slides"].docs[4] @document_with_strange_slug = @site.collections["slides"].docs[5] end should "produce the right URL if they have a slug" do assert_equal "/slides/so-what-is-jekyll-exactly", @document.url end should "produce the right destination file if they have a slug" do dest_file = dest_dir("slides/so-what-is-jekyll-exactly.html") assert_equal dest_file, @document.destination(dest_dir) end should "produce the right URL if they don't have a slug" do assert_equal "/slides/example-slide-5", @document_without_slug.url end should "produce the right destination file if they don't have a slug" do dest_file = dest_dir("slides/example-slide-5.html") assert_equal dest_file, @document_without_slug.destination(dest_dir) end should "produce the right URL if they have a wild slug" do assert_equal( "/slides/Well,-so-what-is-Jekyll,-then", @document_with_strange_slug.url ) end should "produce the right destination file if they have a wild slug" do dest_file = dest_dir("/slides/Well,-so-what-is-Jekyll,-then.html") assert_equal dest_file, @document_with_strange_slug.destination(dest_dir) end end context "document with a permalink with dots & a trailing slash" do setup do @site = fixture_site("collections" => { "with.dots" => { "output" => true }, }) @site.process @document = @site.collections["with.dots"].docs.last @dest_file = dest_dir("with.dots", "permalink.with.slash.tho", "index.html") end should "yield an HTML document" do assert_equal @dest_file, @document.destination(dest_dir) end should "be written properly" do assert_exist @dest_file end should "get the right output_ext" do assert_equal ".html", @document.output_ext end end context "documents in a collection" do setup do @site = fixture_site( "collections" => { "slides" => { "output" => true, }, } ) @site.process @files = @site.collections["slides"].docs end context "without output overrides" do should "be output according to collection defaults" do refute_nil @files.find do |doc| doc.relative_path == "_slides/example-slide-4.html" end assert_exist dest_dir("slides/example-slide-4.html") end end context "with output overrides" do should "be output according its front matter" do assert @files.find do |doc| doc.relative_path == "_slides/non-outputted-slide.html" end refute_exist dest_dir("slides/non-outputted-slide.html") end end end context "a static file in a collection" do setup do @site = fixture_site( "collections" => { "slides" => { "output" => true, }, } ) @site.process @document = @site.collections["slides"].files.find do |doc| doc.relative_path == "_slides/octojekyll.png" end @dest_file = dest_dir("slides/octojekyll.png") end should "be a static file" do assert_equal true, @document.is_a?(StaticFile) end should "be set to write" do assert @document.write? end should "be in the list of docs_to_write" do assert @site.docs_to_write.include?(@document) end should "be output in the correct place" do assert File.file?(@dest_file) end end context "a document in a collection with non-alphabetic file name" do setup do @site = fixture_site( "collections" => { "methods" => { "output" => true, }, } ) @site.process @document = @site.collections["methods"].docs.find do |doc| doc.relative_path == "_methods/escape-+ #%20[].md" end @dest_file = dest_dir("methods/escape-+ #%20[].html") end should "produce the right URL" do assert_equal "/methods/escape-+%20%23%2520%5B%5D.html", @document.url end should "produce the right destination" do assert_equal @dest_file, @document.destination(dest_dir) end should "be output in the correct place" do assert_equal true, File.file?(@dest_file) end end context "a document in a collection with dash-separated numeric file name" do setup do @site = fixture_site( "collections" => { "methods" => { "output" => true, }, } ) @site.process @document = @site.collections["methods"].docs.find do |doc| doc.relative_path == "_methods/3940394-21-9393050-fifif1323-test.md" end @dest_file = dest_dir("methods/3940394-21-9393050-fifif1323-test.html") end should "produce the right URL" do assert_equal "/methods/3940394-21-9393050-fifif1323-test.html", @document.url end should "produce the right destination" do assert_equal @dest_file, @document.destination(dest_dir) end should "be output in the correct place" do assert_equal true, File.file?(@dest_file) end end context "a document with UTF-8 CLRF" do setup do @document = setup_encoded_document "UTF8CRLFandBOM.md" end should "not throw an error" do Jekyll::Renderer.new(@document.site, @document).render_document end end context "a document with UTF-16LE CLRF" do setup do @document = setup_encoded_document "Unicode16LECRLFandBOM.md" end should "not throw an error" do Jekyll::Renderer.new(@document.site, @document).render_document end end context "a document with a date with timezone" do setup do @document = setup_document_with_dates "time_with_timezone.md" end should "have the expected date" do assert_equal "2015/09/30", @document.data["date"].strftime("%Y/%m/%d") end should "return the expected date via Liquid" do assert_equal "2015/09/30", @document.to_liquid["date"].strftime("%Y/%m/%d") end end context "a document with a date with time but without timezone" do setup do @document = setup_document_with_dates "time_without_timezone.md" end should "have the expected date" do assert_equal "2015/10/01", @document.data["date"].strftime("%Y/%m/%d") end should "return the expected date via Liquid" do assert_equal "2015/10/01", @document.to_liquid["date"].strftime("%Y/%m/%d") end end context "a document with a date without time" do setup do @document = setup_document_with_dates "date_without_time.md" end should "have the expected date" do assert_equal "2015/10/01", @document.data["date"].strftime("%Y/%m/%d") end should "return the expected date via Liquid" do assert_equal "2015/10/01", @document.to_liquid["date"].strftime("%Y/%m/%d") end end end