fix encapsulated item with corresponding ReturnType

Author: rwecho

src/HtmlAgilityPack.Shared/HtmlNode.Encapsulator.cs

@@ -1,9 +1,9 @@
-// Description: Html Agility Pack - HTML Parsers, selectors, traversors, manupulators.
+// Description: Html Agility Pack - HTML Parsers, selectors, traversors, manupulators.
 // Website & Documentation: http://html-agility-pack.net
 // Forum & Issues: https://github.com/zzzprojects/html-agility-pack
 // License: https://github.com/zzzprojects/html-agility-pack/blob/master/LICENSE
 // More projects: http://www.zzzprojects.com/
-// Copyright © ZZZ Projects Inc. 2014 - 2017. All rights reserved.
+// Copyright © ZZZ Projects Inc. 2014 - 2017. All rights reserved.
 
 #if !METRO && !NETSTANDARD1_3
 
@@ -29,7 +29,7 @@ public partial class HtmlNode
         /// <exception cref="XPathException">Why it's thrown.</exception>
         /// <exception cref="NodeNotFoundException">Why it's thrown.</exception>
         /// <exception cref="NodeAttributeNotFoundException">Why it's thrown.</exception>
-        /// <exception cref="FormatException">Why it's thrown.</exception>                
+        /// <exception cref="FormatException">Why it's thrown.</exception>
         /// <exception cref="Exception">Why it's thrown.</exception>
         public T GetEncapsulatedData<T>()
         {
@@ -50,7 +50,7 @@ public T GetEncapsulatedData<T>()
         /// <exception cref="XPathException">Why it's thrown.</exception>
         /// <exception cref="NodeNotFoundException">Why it's thrown.</exception>
         /// <exception cref="NodeAttributeNotFoundException">Why it's thrown.</exception>
-        /// <exception cref="FormatException">Why it's thrown.</exception>                
+        /// <exception cref="FormatException">Why it's thrown.</exception>
         /// <exception cref="Exception">Why it's thrown.</exception>
         public T GetEncapsulatedData<T>(HtmlDocument htmlDocument)
         {
@@ -72,7 +72,7 @@ public T GetEncapsulatedData<T>(HtmlDocument htmlDocument)
         /// <exception cref="XPathException">Why it's thrown.</exception>
         /// <exception cref="NodeNotFoundException">Why it's thrown.</exception>
         /// <exception cref="NodeAttributeNotFoundException">Why it's thrown.</exception>
-        /// <exception cref="FormatException">Why it's thrown.</exception>                
+        /// <exception cref="FormatException">Why it's thrown.</exception>
         /// <exception cref="Exception">Why it's thrown.</exception>
         public object GetEncapsulatedData(Type targetType, HtmlDocument htmlDocument = null)
         {
@@ -177,7 +177,7 @@ public object GetEncapsulatedData(Type targetType, HtmlDocument htmlDocument = n
                                 {
                                     HtmlDocument innerHtmlDocument = new HtmlDocument();
 
-                                    innerHtmlDocument.LoadHtml(htmlNode.InnerHtml);
+                                    innerHtmlDocument.LoadHtml(GetEncapsulatedHtml(xPathAttribute.NodeReturnType, htmlNode));
 
                                     object o = GetEncapsulatedData(propertyInfo.PropertyType, innerHtmlDocument);
 
@@ -192,7 +192,7 @@ public object GetEncapsulatedData(Type targetType, HtmlDocument htmlDocument = n
                                 {
                                     string result = string.Empty;
 
-                                    if (xPathAttribute.AttributeName == null) // It target value of HTMLTag 
+                                    if (xPathAttribute.AttributeName == null) // It target value of HTMLTag
                                     {
                                         result = Tools.GetNodeValueBasedOnXPathReturnType<string>(htmlNode, xPathAttribute);
                                     }
@@ -295,7 +295,7 @@ public object GetEncapsulatedData(Type targetType, HtmlDocument htmlDocument = n
                                         foreach (HtmlNode node in nodeCollection)
                                         {
                                             HtmlDocument innerHtmlDocument = new HtmlDocument();
-                                            innerHtmlDocument.LoadHtml(node.InnerHtml);
+                                            innerHtmlDocument.LoadHtml(GetEncapsulatedHtml(xPathAttribute.NodeReturnType, node));
 
                                             object o = GetEncapsulatedData(T_Types[0], innerHtmlDocument);
 
@@ -384,6 +384,20 @@ public object GetEncapsulatedData(Type targetType, HtmlDocument htmlDocument = n
 
 
 
+        private static string GetEncapsulatedHtml(ReturnType returnType, HtmlNode node)
+        {
+            switch (returnType)
+            {
+                case ReturnType.InnerText:
+                    return node.InnerText;
+                case ReturnType.InnerHtml:
+                    return node.InnerHtml;
+                case ReturnType.OuterHtml:
+                    return node.OuterHtml;
+                default:
+                    throw new Exception("Unhandled ReturnType : " + returnType.ToString());
+            };
+        }
     }
 
 
@@ -797,7 +811,7 @@ internal static int CountOfIEnumerable<T>(this IEnumerable<T> source)
     public enum ReturnType
     {
         /// <summary>
-        /// The text between the start and end tags of the object.        
+        /// The text between the start and end tags of the object.
         /// </summary>
         InnerText,
 
@@ -896,18 +910,18 @@ public sealed class SkipNodeNotFoundAttribute : Attribute
     public class NodeNotFoundException : Exception
     {
         /// <summary>
-        /// 
+        ///
         /// </summary>
         public NodeNotFoundException() { }
 
         /// <summary>
-        /// 
+        ///
         /// </summary>
         /// <param name="message"></param>
         public NodeNotFoundException(string message) : base(message) { }
 
         /// <summary>
-        /// 
+        ///
         /// </summary>
         /// <param name="message"></param>
         /// <param name="inner"></param>
@@ -921,18 +935,18 @@ public NodeNotFoundException(string message, Exception inner) : base(message, in
     public class NodeAttributeNotFoundException : Exception
     {
         /// <summary>
-        /// 
+        ///
         /// </summary>
         public NodeAttributeNotFoundException() { }
 
         /// <summary>
-        /// 
+        ///
         /// </summary>
         /// <param name="message"></param>
         public NodeAttributeNotFoundException(string message) : base(message) { }
 
         /// <summary>
-        /// 
+        ///
         /// </summary>
         /// <param name="message"></param>
         /// <param name="inner"></param>
@@ -947,18 +961,18 @@ public class MissingXPathException : Exception
     {
 
         /// <summary>
-        /// 
+        ///
         /// </summary>
         public MissingXPathException() { }
 
         /// <summary>
-        /// 
+        ///
         /// </summary>
         /// <param name="message"></param>
         public MissingXPathException(string message) : base(message) { }
 
         /// <summary>
-        /// 
+        ///
         /// </summary>
         /// <param name="message"></param>
         /// <param name="inner"></param>
@@ -967,7 +981,7 @@ public MissingXPathException(string message, Exception inner) : base(message, in
 
 }
 
-#if FX20 
+#if FX20
 namespace System.Runtime.CompilerServices
 {
     [AttributeUsage(AttributeTargets.Method |

src/Tests/HtmlAgilityPack.Tests.NetStandard2_0/EncapsulatorTests.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
+using System.Reflection.Metadata;
 using Xunit;
 
 namespace HtmlAgilityPack.Tests.NetStandard2_0
@@ -29,8 +30,32 @@ public void Dictionary_Test()
 
             Assert.NotNull(wort);
         }
+
+        [Fact]
+        public void EncapsulatedOuterHtml_Test()
+        {
+            var html = @"
+<div>
+<a href='3.html' class='single'>3</a>
+<div>hello
+<a href='1.html'>1</a>
+<a href='2.html'>2</a>
+</div>
+<div>world</div>
+</div>
+";
+            var document = new HtmlDocument();
+            document.LoadHtml(html);
+            var outerHtml = document.DocumentNode.GetEncapsulatedData<OuterHtml>();
+            Assert.True(outerHtml.Item3.Href == "3.html");
+            Assert.True(outerHtml.Item3.Name == "3");
+
+            Assert.True(outerHtml.Items.Count == 3);
+            Assert.True(outerHtml.Items.All(o => o.Href != null));
+        }
     }
 
+
     #region StackOverFlow_TestClasses
 
     [HasXPath]
@@ -204,5 +229,29 @@ public class Example
 
     #endregion Dictionary_TestClasses
 
+    #region Encapsulated outer html test classes
+
+    [HasXPath]
+    public class OuterHtml
+    {
+        [XPath("//a", ReturnType.OuterHtml)]
+        public List<OuterHtmlItem> Items { get; set; }
+
+        [XPath("//a[@class='single']", ReturnType.OuterHtml)]
+        public OuterHtmlItem Item3 { get; set; }
 
+
+        [HasXPath]
+        public class OuterHtmlItem
+        {
+            [XPath("a", "href")]
+            [SkipNodeNotFound]
+            public string Href { get; set; }
+
+            [XPath("a")]
+            [SkipNodeNotFound]
+            public string Name { get; set; }
+        }
+    }
+    #endregion
 }