Merge pull request #14 from Shoobx/htmlformatter

Make a HTML snippet differ instead of RML
Shoobx · Sep 9, 2018 · 24d4ba8 · 24d4ba8
2 parents 94c2eca + c0ff692
commit 24d4ba8
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 7 deletions.
diff --git a/tests/test_data/example.expected.html b/tests/test_data/example.expected.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html xmlns:diff="http://namespaces.shoobx.com/diff">
+  <head>
+    <title><diff:insert>HTML </diff:insert>Example<diff:delete> HTML</diff:delete></title>
+  </head>
+  <body>
+    <h1>My <i diff:insert-formatting="">First</i> Heading</h1>
+    <p>My <diff:delete>first </diff:delete>paragraph<diff:insert> has changed</diff:insert>.</p>
+  </body>
+</html>
+
diff --git a/tests/test_data/example.left.html b/tests/test_data/example.left.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>Example HTML</title>
+</head>
+<body>
+
+<h1>My First Heading</h1>
+
+<p>My first paragraph.</p>
+
+</body>
+</html>
+
diff --git a/tests/test_data/example.right.html b/tests/test_data/example.right.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>HTML Example</title>
+</head>
+<body>
+
+<h1>My <i>First</i> Heading</h1>
+
+<p>My paragraph has changed.</p>
+
+</body>
+</html>
+
diff --git a/xmldiff/diff.py b/xmldiff/diff.py
@@ -48,6 +48,11 @@ def set_trees(self, left, right):
         self.clear()
 
         # Make sure we were passed two lxml elements:
+        if isinstance(left, etree._ElementTree):
+            left = left.getroot()
+        if isinstance(right, etree._ElementTree):
+            right = right.getroot()
+
         if not (etree.iselement(left) and etree.iselement(right)):
             raise TypeError("The 'left' and 'right' parameters must be "
                             "lxml Elements.")

diff --git a/xmldiff/formatting.py b/xmldiff/formatting.py
@@ -312,6 +312,11 @@ def format(self, diff, orig_tree):
         # and also because we don't want to modify the original tree.
 
         result = deepcopy(orig_tree)
+        if isinstance(result, etree._ElementTree):
+            root = result.getroot()
+        else:
+            root = result
+
         etree.register_namespace(DIFF_PREFIX, DIFF_NS)
 
         deferred = []
@@ -320,12 +325,12 @@ def format(self, diff, orig_tree):
                 # We need to do text updates last
                 deferred.append(action)
                 continue
-            self.handle_action(action, result)
+            self.handle_action(action, root)
 
         for action in reversed(deferred):
-            self.handle_action(action, result)
+            self.handle_action(action, root)
 
-        self.finalize(result)
+        self.finalize(root)
 
         etree.cleanup_namespaces(result, top_nsmap={DIFF_PREFIX: DIFF_NS})
         return etree.tounicode(result, pretty_print=self.pretty_print)

diff --git a/xmldiff/main.py b/xmldiff/main.py
@@ -16,10 +16,6 @@
 
 def diff_trees(left, right, F=0.5, uniqueattrs=None, formatter=None):
     """Takes two lxml root elements or element trees"""
-    if isinstance(left, etree._ElementTree):
-        left = left.getroot()
-    if isinstance(right, etree._ElementTree):
-        right = right.getroot()
     if formatter is not None:
         formatter.prepare(left, right)
     differ = diff.Differ(F=F, uniqueattrs=uniqueattrs)