add samples to the readme; rename HTMLTag.Name to Type; make HTMLDocu…

…ment point at the first actual node not #document; add HTMLTagTypeFilter
mvbalaw · Jul 16, 2010 · 6fbff4b · 6fbff4b
1 parent 16b3c3e
commit 6fbff4b
Show file tree

Hide file tree

Showing 16 changed files with 538 additions and 150 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,46 @@
-A simple utility that lets you use LINQ syntax to query HTML instead of XSLT. We use it in unit tests to verify that generated HTML correctly represents the generation inputs.
+A simple utility that lets you use LINQ syntax to query HTML.
 
 ## Samples
 
+    const string html = "<html><head><TITLE>The Title</TITLE></head><body>Hello World</body></html>";
+    var parsed = HTMLParser.Parse(html);
+
+    parsed
+        .DescendantTags
+        .OfType("title").IgnoreCase()
+        .Any()
+        .ShouldBeTrue();
 
+    parsed
+        .DescendantTags
+        .OfType("title")
+        .Any()
+        .ShouldBeFalse();
 
-## License		
+    parsed
+        .ChildTags
+        .Count()
+        .ShouldBeEqualTo(2);    // head, body
+        
+    parsed
+        .DescendantTags
+        .OfType("title").IgnoreCase()
+        .First()
+        .Parent
+        .TypeEqualsIgnoreCase("HEAD")
+        .ShouldBeTrue();    
+
+    parsed
+        .DescendantTags
+        .Count(x => x.Parent.TypeEqualsIgnoreCase("HTML"))
+        .ShouldBeEqualTo(2);   // head, body
+        
+    parsed
+        .Body
+        .Content
+        .ShouldBeEqualTo("Hello World");        
+        
+## License        
 
 [MIT License][mitlicense]
 

diff --git a/src/LinqToHtml.Tests/HTMLDocumentTests.cs b/src/LinqToHtml.Tests/HTMLDocumentTests.cs
@@ -10,7 +10,7 @@ namespace LinqToHtml.Tests
 	public class HTMLDocumentTests
 	{
 		[TestFixture]
-		public class When_asked_for_all_descendant_tags
+		public class When_asked_for_its_descendant_tags
 		{
 			private int _expectedTagCount;
 			private string _html;
@@ -21,7 +21,7 @@ public void Given_a_basic_html_document()
 			{
 				Test.Verify(
 					with_a_basic_html_document,
-					when_asked_for_all_descendant_tags,
+					when_asked_for_its_descendant_tags,
 					should_not_return_null,
 					should_not_return_an_empty_list,
 					should_return_the_correct_number_of_tags,
@@ -43,7 +43,7 @@ private void should_not_return_null()
 
 			private void should_return_the_body_tag()
 			{
-				_result.Single(x => x.Name == "body");
+				_result.Single(x => x.Type == "body");
 			}
 
 			private void should_return_the_correct_number_of_tags()
@@ -53,24 +53,24 @@ private void should_return_the_correct_number_of_tags()
 
 			private void should_return_the_head_tag()
 			{
-				_result.Single(x => x.Name == "head");
+				_result.Single(x => x.Type == "head");
 			}
 
 			private void should_return_the_title_tag()
 			{
-				_result.Single(x => x.Name == "title");
+				_result.Single(x => x.Type == "title");
 			}
 
-			private void when_asked_for_all_descendant_tags()
+			private void when_asked_for_its_descendant_tags()
 			{
 				_result = HTMLParser.Parse(_html)
-					.AllDescendantTags.ToList();
+					.DescendantTags.ToList();
 			}
 
 			private void with_a_basic_html_document()
 			{
 				_html = "<html><head><title>The Title</title></head><body>Hello World</body></html>";
-				_expectedTagCount = 4; // html, head, title, body
+				_expectedTagCount = 3; // head, title, body
 			}
 		}
 
@@ -109,7 +109,7 @@ private void should_not_return_null()
 
 			private void should_return_the_BODY_tag()
 			{
-				_result.NameEqualsIgnoreCase("BODY").ShouldBeTrue();
+				_result.TypeEqualsIgnoreCase("BODY").ShouldBeTrue();
 			}
 
 			private void when_asked_for_the_BODY_tag()
@@ -163,7 +163,7 @@ private void should_not_return_null()
 
 			private void should_return_the_HEAD_tag()
 			{
-				_result.NameEqualsIgnoreCase("HEAD").ShouldBeTrue();
+				_result.TypeEqualsIgnoreCase("HEAD").ShouldBeTrue();
 			}
 
 			private void when_asked_for_the_HEAD_tag()

diff --git a/src/LinqToHtml.Tests/HTMLParserTests.cs b/src/LinqToHtml.Tests/HTMLParserTests.cs
@@ -9,7 +9,7 @@ public class HTMLParserTests
 		[TestFixture]
 		public class When_asked_to_parse_an_HTML_string
 		{
-			private string _expectedName;
+			private string _expectedType;
 			private string _html;
 			private HTMLTag _result;
 
@@ -20,7 +20,7 @@ public void Given_a_basic_html_document()
 					with_a_basic_html_document,
 					when_asked_to_parse_the_string,
 					should_not_return_null,
-					should_return_an_html_document_with_the_correct_Name
+					should_return_an_html_document_with_the_correct_Type
 					);
 			}
 
@@ -29,9 +29,9 @@ private void should_not_return_null()
 				_result.ShouldNotBeNull();
 			}
 
-			private void should_return_an_html_document_with_the_correct_Name()
+			private void should_return_an_html_document_with_the_correct_Type()
 			{
-				_result.Name.ShouldBeEqualTo(_expectedName);
+				_result.Type.ShouldBeEqualTo(_expectedType);
 			}
 
 			private void when_asked_to_parse_the_string()
@@ -42,7 +42,7 @@ private void when_asked_to_parse_the_string()
 			private void with_a_basic_html_document()
 			{
 				_html = "<html><head><title>The Title</title></head><body>Hello World</body></html>";
-				_expectedName = HTMLDocument.DefaultName;
+				_expectedType = "html";
 			}
 		}
 	}

diff --git a/src/LinqToHtml.Tests/HTMLTagAttributeExtensionsTests.cs b/src/LinqToHtml.Tests/HTMLTagAttributeExtensionsTests.cs
@@ -58,7 +58,6 @@ private void should_return_true()
 			private void when_asked_if_its_name_equals_ignore_case()
 			{
 				_result = HTMLParser.Parse("<body " + _attributeName + "='foo' />")
-					.ChildTags.First()
 					.Attributes.First().NameEqualsIgnoreCase(_name);
 			}
 

diff --git a/src/LinqToHtml.Tests/HTMLTagExtensionsTests.cs b/src/LinqToHtml.Tests/HTMLTagExtensionsTests.cs
@@ -1,5 +1,3 @@
-using System.Linq;
-
 using FluentAssert;
 
 using NUnit.Framework;
@@ -9,39 +7,39 @@ namespace LinqToHtml.Tests
 	public class HTMLTagExtensionsTests
 	{
 		[TestFixture]
-		public class When_asked_if_its_name_equals_ignore_case
+		public class When_asked_if_its_type_equals_ignore_case
 		{
-			private string _name;
 			private bool _result;
-			private string _tagName;
+			private string _tagType;
+			private string _type;
 
 			[Test]
-			public void Given_the_name_has_different_case()
+			public void Given_the_type_has_different_case()
 			{
 				Test.Verify(
-					with_a_name_that_differs_only_by_case,
+					with_a_type_that_differs_only_by_case,
-					when_asked_if_its_name_equals_ignore_case,
+					when_asked_if_its_type_equals_ignore_case,
 					should_return_true
 					);
 			}
 
 			[Test]
-			public void Given_the_name_matches_exactly()
+			public void Given_the_type_is_completely_different()
 			{
 				Test.Verify(
-					with_a_name_that_matches_exactly,
+					with_a_type_that_is_completely_different,
-					when_asked_if_its_name_equals_ignore_case,
+					when_asked_if_its_type_equals_ignore_case,
-					should_return_true
+					should_return_false
 					);
 			}
 
 			[Test]
-			public void Given_the_name_that_is_completely_different()
+			public void Given_the_type_matches_exactly()
 			{
 				Test.Verify(
-					with_a_name_that_is_completely_different,
+					with_a_type_that_matches_exactly,
-					when_asked_if_its_name_equals_ignore_case,
+					when_asked_if_its_type_equals_ignore_case,
-					should_return_false
+					should_return_true
 					);
 			}
 
@@ -55,29 +53,28 @@ private void should_return_true()
 				_result.ShouldBeTrue();
 			}
 
-			private void when_asked_if_its_name_equals_ignore_case()
+			private void when_asked_if_its_type_equals_ignore_case()
 			{
-				_result = HTMLParser.Parse("<" + _tagName + " />")
+				_result = HTMLParser.Parse("<" + _tagType + " />")
-					.ChildTags.First()
+					.TypeEqualsIgnoreCase(_type);
-					.NameEqualsIgnoreCase(_name);
 			}
 
-			private void with_a_name_that_differs_only_by_case()
+			private void with_a_type_that_differs_only_by_case()
 			{
-				_name = "HeAd";
+				_type = "HeAd";
-				_tagName = "head";
+				_tagType = "head";
 			}
 
-			private void with_a_name_that_is_completely_different()
+			private void with_a_type_that_is_completely_different()
 			{
-				_name = "HeAd";
+				_type = "HeAd";
-				_tagName = "tail";
+				_tagType = "tail";
 			}
 
-			private void with_a_name_that_matches_exactly()
+			private void with_a_type_that_matches_exactly()
 			{
-				_name = "HeAd";
+				_type = "HeAd";
-				_tagName = _name;
+				_tagType = _type;
 			}
 		}
 	}