Skip to content

Commit fe9d365

Browse files
author
Geobert Quach
committed
fix(tests): normalizing EOL management
Closes #241 add editorconfig add gitattributes
1 parent 8003c11 commit fe9d365

39 files changed

+612
-5
lines changed

‎.editorconfig

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
root = true
2+
3+
[*]
4+
end_of_line = lf
5+
insert_final_newline = true

‎.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# force LF on checkout to avoid rustfmt messing up the EOL
2+
* text eol=lf

‎Cargo.lock

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ serde = "1.0"
4343
serde_yaml = "0.7"
4444
serde_json = "1.0"
4545
toml = "0.4.0"
46+
normalize-line-endings = "0.2.2"
4647

4748
[dependencies.sass-rs]
4849
version = "0.2"

‎src/document.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ use std::collections::HashMap;
22
use std::collections::hash_map::Entry;
33
use std::default::Default;
44
use std::path::{Path, PathBuf};
5+
use std::iter::FromIterator;
56

67
use chrono::{Datelike, Timelike};
78
use itertools;
@@ -12,6 +13,7 @@ use pulldown_cmark as cmark;
1213
use regex::Regex;
1314
use rss;
1415
use serde_yaml;
16+
use normalize_line_endings::normalized;
1517

1618
use error::*;
1719
use cobalt_model::files;
@@ -194,6 +196,7 @@ impl Document {
194196
-> Result<Document> {
195197
trace!("Parsing {:?}", rel_path);
196198
let content = files::read_file(src_path)?;
199+
let content = String::from_iter(normalized(content.chars()));
197200
let builder =
198201
cobalt_model::DocumentBuilder::<cobalt_model::FrontmatterBuilder>::parse(&content)?;
199202
let (front, content) = builder.parts();
@@ -350,6 +353,7 @@ impl Document {
350353
self.file_path,
351354
e)
352355
})?;
356+
let layout_data = String::from_iter(normalized(layout_data.chars()));
353357
vacant.insert(layout_data)
354358
}
355359
Entry::Occupied(occupied) => occupied.into_mut(),

‎src/lib.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ extern crate lazy_static;
8585
#[macro_use]
8686
extern crate serde;
8787

88+
extern crate normalize_line_endings;
89+
8890
pub use cobalt::build;
8991
pub use error::Error;
9092
pub use cobalt_model::Config;

‎src/template.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
use std::collections::HashMap;
22
use std::path;
33
use std::result;
4+
use std::iter::FromIterator;
45

6+
use normalize_line_endings::normalized;
57
use liquid;
6-
78
use error::*;
89
use cobalt_model;
910
use cobalt_model::files;
@@ -39,6 +40,7 @@ impl InMemoryInclude {
3940
.to_owned();
4041
trace!("Loading snippet {:?}", rel_path);
4142
let content = files::read_file(file_path)?;
43+
let content = String::from_iter(normalized(content.chars()));
4244
self.templates.insert(rel_path, content);
4345
}
4446
Ok(self)

‎tests/fixtures/excerpts_CRLF/.editorconfig

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[*]
2+
end_of_line = crlf
3+
insert_final_newline = true

‎tests/fixtures/excerpts_CRLF/.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# force tests to keep their Windows EOL
2+
* text eol=crlf

‎tests/fixtures/excerpts_CRLF/_cobalt.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
source: "."
2+
site:
3+
title: cobalt blog

‎tests/fixtures/excerpts_CRLF/_includes/post.liquid

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<div>
2+
<h2>{{ page.title }}</h2>
3+
<p>
4+
{{ page.content }}
5+
</p>
6+
</div>

‎tests/fixtures/excerpts_CRLF/_layouts/default.liquid

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>{{ page.title }}</title>
5+
</head>
6+
<body>
7+
<div>
8+
{% if page.collection == "posts" %}
9+
{% include 'post.liquid' %}
10+
{% else %}
11+
{{ page.content }}
12+
{% endif %}
13+
</div>
14+
</body>
15+
</html>

‎tests/fixtures/excerpts_CRLF/index.liquid

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
layout: default.liquid
2+
---
3+
<div >
4+
<h2>Blog!</h2>
5+
<!--<br />-->
6+
<div>
7+
{% for post in collections.posts.pages %}
8+
<div>
9+
<h4>{{post.title}}</h4>
10+
<h4><a href="{{post.permalink}}">{{ post.title }}</a></h4>
11+
{{ post.excerpt }}
12+
</div>
13+
{% endfor %}
14+
</div>
15+
</div>

‎tests/fixtures/excerpts_CRLF/posts/post-1.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
layout: default.liquid
2+
3+
title: First block is an excerpt
4+
published_date: 2016-01-14 21:00:30 -0500
5+
---
6+
7+
# This is our first Post!
8+
9+
Welcome to the first post ever on cobalt.rs!

‎tests/fixtures/excerpts_CRLF/posts/post-10.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
layout: default.liquid
2+
3+
title: Reference-style links immediately above first block
4+
published_date: 2017-02-11 04:50:21 -0000
5+
---
6+
7+
[20]: /0
8+
[21]: /1
9+
[22]: /2
10+
[23]: /3
11+
References are placed immediately above the first paragraph:
12+
[20][] [21][] [22][] [23][]

‎tests/fixtures/excerpts_CRLF/posts/post-11.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
layout: default.liquid
2+
3+
title: Reference-style links immediately below first block do not resolve
4+
published_date: 2017-02-11 04:51:34 -0000
5+
---
6+
7+
References are placed immediately below the first paragraph:
8+
[30][] [31][] [32][] [33][]
9+
[30]: /0
10+
[31]: /1
11+
[32]: /2
12+
[33]: /3
13+
14+
Note that this is at it should be, as the markdown implementations I've tried
15+
(including CommonMark) do not render the above links (when the post is rendered
16+
individually).

‎tests/fixtures/excerpts_CRLF/posts/post-12.liquid

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
layout: default.liquid
2+
3+
title: Reference-style links in a non-markdown post do not resolve
4+
published_date: 2017-02-11 04:48:11 -0000
5+
---
6+
7+
References are placed below the first paragraph, and are separated from the
8+
first paragraph by a single blank line:
9+
[40][] [41][] [42][] [43][]
10+
11+
[40]: /0
12+
[41]: /1
13+
[42]: /2
14+
[43]: /3

‎tests/fixtures/excerpts_CRLF/posts/post-2.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
layout: default.liquid
2+
3+
title: An empty post means an empty excerpt
4+
published_date: 2016-01-14 21:01:30 -0500
5+
---

‎tests/fixtures/excerpts_CRLF/posts/post-3.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
layout: default.liquid
2+
3+
title: Explicit `excerpt`
4+
published_date: 2016-01-14 21:02:30 -0500
5+
excerpt: Is in `markdown`
6+
---
7+
8+
# This is our third Post!
9+
10+
Welcome to the third post ever on cobalt.rs!

‎tests/fixtures/excerpts_CRLF/posts/post-4.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
layout: default.liquid
2+
3+
title: Custom excerpt separator
4+
published_date: 2016-01-14 21:03:30 -0500
5+
excerpt_separator: <!-- more -->
6+
---
7+
8+
# Custom excerpt separator
9+
10+
Welcome to the 4th post on cobalt.rs!
11+
<!-- more -->
12+
13+
Something below the separator.

‎tests/fixtures/excerpts_CRLF/posts/post-5.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
layout: default.liquid
2+
3+
title: Both excerpt and excerpt separator are there
4+
published_date: 2016-01-14 21:04:30 -0500
5+
excerpt: "`excerpt` wins"
6+
excerpt_separator: <!-- more -->
7+
---
8+
9+
# Both excerpt and excerpt separator are there
10+
11+
Welcome to the 5th post on cobalt.rs!
12+
<!-- more -->
13+
14+
Something below the separator.

‎tests/fixtures/excerpts_CRLF/posts/post-6.liquid

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
layout: default.liquid
2+
3+
title: Implicit excerpts work only in markdown
4+
published_date: 2016-01-14 21:05:30 -0500
5+
excerpt_separator: <!-- more -->
6+
---
7+
8+
<h1>Custom excerpt separator</h1>
9+
10+
<p>Welcome to the 6th post on cobalt.rs!</p>
11+
<!-- more -->
12+
13+
<p>Something below the separator.</p>

‎tests/fixtures/excerpts_CRLF/posts/post-7.liquid

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
layout: default.liquid
2+
3+
title: Explicit excerpts work even in liquid
4+
published_date: 2016-01-14 21:06:30 -0500
5+
excerpt: <strong>explicit</strong> excerpt
6+
excerpt_separator: <!-- more -->
7+
---
8+
9+
<h1>Custom excerpt separator</h1>
10+
11+
<p>Welcome to the 7th post on cobalt.rs!</p>
12+
<!-- more -->
13+
14+
<p>Something below the separator.</p>

‎tests/fixtures/excerpts_CRLF/posts/post-8.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
layout: default.liquid
2+
3+
title: Reference-style links above first block and separated by blank line resolve
4+
published_date: 2017-02-11 04:45:01 -0000
5+
---
6+
7+
[00]: /0
8+
[01]: /1
9+
[02]: /2
10+
[03]: /3
11+
12+
References-style links are placed above the first paragraph, and are separated
13+
from the first paragraph by a single blank line:
14+
[00][] [01][] [02][] [03][]

‎tests/fixtures/excerpts_CRLF/posts/post-9.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
layout: default.liquid
2+
3+
title: Reference-style links below first block and separated by blank line resolve
4+
published_date: 2017-02-11 04:48:11 -0000
5+
---
6+
7+
References are placed below the first paragraph, and are separated from the
8+
first paragraph by a single blank line:
9+
[10][] [11][] [12][] [13][]
10+
11+
[10]: /0
12+
[11]: /1
13+
[12]: /2
14+
[13]: /3

‎tests/mod.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,7 @@ fn assert_dirs_eq(expected: &Path, actual: &Path) {
5959
.filter_map(|e| e.ok())
6060
.filter(|e| e.file_type().is_file());
6161
for entry in walker {
62-
let extra_file = entry
63-
.path()
64-
.strip_prefix(expected)
65-
.expect("Comparison error");
62+
let extra_file = entry.path().strip_prefix(expected).expect("Comparison error");
6663
let src_file = Path::new(actual).join(&extra_file);
6764

6865
File::open(&src_file).expect(&format!("File {:?} does not exist in reference ({:?}).",
@@ -238,6 +235,11 @@ pub fn excerpts() {
238235
run_test("excerpts").unwrap();
239236
}
240237

238+
#[test]
239+
pub fn excerpts_crlf() {
240+
run_test("excerpts_CRLF").unwrap();
241+
}
242+
241243
#[test]
242244
pub fn posts_in_subfolder() {
243245
run_test("posts_in_subfolder").unwrap();

0 commit comments

Comments
 (0)