Port scala-xml to v3 core.

Author: SimY4

gradle/check-codecoverage.gradle

@@ -18,9 +18,10 @@ jacocoTestCoverageVerification {
             element = 'CLASS'
             includes = ['com.github.simy4.xpath.*']
             excludes = [
-                    'com.github.simy4.xpath.scala.XmlBuilder.BuilderPartiallyApplied',
-                    'com.github.simy4.xpath.scala.impl.*',
-                    'com.github.simy4.xpath.scala.implicits.*',
+                    'com.github.simy4.xpath.scala.implicits.',
+                    'com.github.simy4.xpath.scala.navigator.Attribute.',
+                    'com.github.simy4.xpath.scala.navigator.Element.',
+                    'com.github.simy4.xpath.scala.navigator.Root.',
                     'com.github.simy4.xpath.scala.xpath.*',
             ]
 

xpath-to-xml-scala/src/main/scala/com/github/simy4/xpath/scala/XmlBuilder.scala

@@ -29,16 +29,9 @@ import xml.Elem
  * @since 2.2
  */
 object XmlBuilder extends compat.Converters {
-
-  def apply(effects: Effect*) = new BuilderPartiallyApplied(effects)
-
-  def apply(effects: Iterable[Effect]) = new BuilderPartiallyApplied(effects)
-
-  final class BuilderPartiallyApplied private[XmlBuilder] (private val effects: Iterable[Effect]) extends AnyVal {
-    def apply(xml: Elem): Either[XmlBuilderException, Elem] =
-      try Right(new ScalaXmlNavigatorSpi().process(xml, effects.map(_.effect)))
-      catch {
-        case xbe: XmlBuilderException => Left(xbe)
-      }
-  }
+  def apply(effect: Effect, rest: Effect*)(xml: Elem): Either[XmlBuilderException, Elem] =
+    try Right(new ScalaXmlNavigatorSpi().process(xml, effect.effect +: rest.map(_.effect)))
+    catch {
+      case xbe: XmlBuilderException => Left(xbe)
+    }
 }

xpath-to-xml-scala/src/main/scala/com/github/simy4/xpath/scala/impl/ToXmlElemOps.scala

@@ -15,7 +15,6 @@
  */
 package com.github.simy4.xpath.scala
 
-import impl.ToXmlElemOps
 import xpath.ToXPathLiteral
 
-object implicits extends ToXmlElemOps with ToXPathLiteral
+object implicits extends ToXPathLiteral

xpath-to-xml-scala/src/main/scala/com/github/simy4/xpath/scala/implicits.scala

@@ -17,42 +17,80 @@ package com.github.simy4.xpath
 package scala.navigator
 
 import navigator.Navigator
-import xml.{ Attribute => XmlAttribute, Elem, Null, Text }
+import xml.{ Attribute => XmlAttribute, Elem, Null, Text, TopScope }
 
 import javax.xml.namespace.QName
 
 @SuppressWarnings(Array("org.wartremover.warts.Throw"))
 class ScalaXmlNavigator(override val root: Root) extends Navigator[ScalaXmlNode] with scala.compat.Converters {
-  override def parentOf(node: ScalaXmlNode): ScalaXmlNode                                = node.parent
-  override def elementsOf(parent: ScalaXmlNode): java.lang.Iterable[? <: ScalaXmlNode]   = parent.elements
-  override def attributesOf(parent: ScalaXmlNode): java.lang.Iterable[? <: ScalaXmlNode] = parent.attributes
-  @throws[XmlBuilderException]("If unable to create attribute for given node")
-  override def createAttribute(parent: ScalaXmlNode, attribute: QName): ScalaXmlNode =
-    parent match {
-      case e: Element =>
-        val pre  = attribute.getPrefix
-        val attr = XmlAttribute(if (pre.nonEmpty) Some(pre) else None, attribute.getLocalPart, Text(""), Null)
-        e.node = e.node % attr
-        new Attribute(attr, e)
+  @SuppressWarnings(Array("org.wartremover.warts.Null"))
+  def parentOf(node: ScalaXmlNode): ScalaXmlNode                                = node.parent.orNull
+  def elementsOf(parent: ScalaXmlNode): java.lang.Iterable[? <: ScalaXmlNode]   = parent.elements
+  def attributesOf(parent: ScalaXmlNode): java.lang.Iterable[? <: ScalaXmlNode] = parent.attributes
+  def createAttribute(parent: ScalaXmlNode, attribute: QName): ScalaXmlNode = {
+    val pre  = attribute.getPrefix
+    val attr = XmlAttribute(if (pre.nonEmpty) Some(pre) else None, attribute.getLocalPart, Text(""), Null)
+    Attribute(attr)()
+  }
+  def createElement(parent: ScalaXmlNode, element: QName): ScalaXmlNode = {
+    val scope = parent.node match {
+      case e: Elem => e.scope
+      case _       => TopScope
+    }
+    val pre  = element.getPrefix
+    val elem = Elem(if (pre.nonEmpty) pre else null, element.getLocalPart, Null, scope, minimizeEmpty = true)
+    Element(elem)()
+  }
+  @throws[XmlBuilderException]("If unable to append prev element for given node")
+  def appendPrev(node: ScalaXmlNode, prepend: ScalaXmlNode): Unit =
+    (node, prepend) match {
+      case (e: Element, p: Element) =>
+        val parent     = e.parent.getOrElse(throw new XmlBuilderException("Unable to prepend to detached node"))
+        val idx        = e.index
+        val parentNode = parent.node
+        parent.node = parentNode.copy(child = parentNode.child.patch(idx, Seq(p.node, e.node), 1))
+        e.index += 1
+        p.parent = Some(parent)
       case _ =>
-        throw new XmlBuilderException(s"Unable to create attribute for ${parent.toString}")
+        throw new XmlBuilderException(s"Unable to prepend to ${node.toString}")
     }
-  @throws[XmlBuilderException]("If unable to create element for given node")
-  override def createElement(parent: ScalaXmlNode, element: QName): ScalaXmlNode =
-    parent match {
-      case e: Element =>
-        val node     = e.node
-        val children = node.child
-        val pre      = element.getPrefix
-        val elem = Elem(if (pre.nonEmpty) pre else null, element.getLocalPart, Null, node.scope, minimizeEmpty = true)
-        e.node = node.copy(child = children :+ elem)
-        new Element(elem, children.size, e)
+  @throws[XmlBuilderException]("If unable to append child element for given node")
+  def appendChild(parent: ScalaXmlNode, node: ScalaXmlNode): Unit =
+    (parent, node) match {
+      case (parent: Root, elem: Element) =>
+        val node  = parent.node
+        val child = node.child
+        parent.node = node.copy(child = child :+ elem.node)
+        elem.index = child.size
+        elem.parent = Some(parent)
+      case (parent: Element, elem: Element) =>
+        val node  = parent.node
+        val child = node.child
+        parent.node = node.copy(child = child :+ elem.node)
+        elem.index = child.size
+        elem.parent = Some(parent)
+      case (parent: Element, attr: Attribute) =>
+        parent.node = parent.node % attr.node
+        attr.parent = Some(parent)
       case _ =>
-        throw new XmlBuilderException(s"Unable to create element for ${parent.toString}")
+        throw new XmlBuilderException(s"Unable to append child ${node.toString}")
+    }
+  @throws[XmlBuilderException]("If unable to append next element for given node")
+  def appendNext(node: ScalaXmlNode, append: ScalaXmlNode): Unit =
+    (node, append) match {
+      case (e: Element, a: Element) =>
+        val parent     = e.parent.getOrElse(throw new XmlBuilderException("Unable to append to detached node"))
+        val idx        = e.index
+        val parentNode = parent.node
+        parent.node = parentNode.copy(child = parentNode.child.patch(idx, Seq(e.node, a.node), 1))
+        e.index += 1
+        a.parent = Some(parent)
+      case _ =>
+        throw new XmlBuilderException(s"Unable to append to ${node.toString}")
     }
   @SuppressWarnings(Array("org.wartremover.warts.IsInstanceOf"))
   @throws[XmlBuilderException]("If unable to set text to given node")
-  override def setText(node: ScalaXmlNode, text: String): Unit =
+  def setText(node: ScalaXmlNode, text: String): Unit =
     node match {
       case e: Element =>
         val elem = e.node
@@ -63,34 +101,23 @@ class ScalaXmlNavigator(override val root: Root) extends Navigator[ScalaXmlNode]
       case _ =>
         throw new XmlBuilderException(s"Unable to set text to ${node.toString}")
     }
-  @throws[XmlBuilderException]("If unable to prepend copy to given node")
-  override def prependCopy(node: ScalaXmlNode): Unit =
-    node match {
-      case e: Element =>
-        val toCopy     = e.node
-        val copy       = toCopy.copy()
-        val idx        = e.index
-        val parentNode = e.parent.node
-        e.parent.node = parentNode.copy(child = parentNode.child.patch(idx, Seq(copy, toCopy), 1))
-        e.index += 1
-      case _ =>
-        throw new XmlBuilderException(s"Unable to prepend copy to ${node.toString}")
-    }
   @throws[XmlBuilderException]("If unable to remove given node")
-  override def remove(node: ScalaXmlNode): Unit =
+  def remove(node: ScalaXmlNode): Unit =
     node match {
       case e: Element =>
         val idx        = e.index
-        val parentNode = e.parent.node
-        e.parent.node = parentNode.copy(child = parentNode.child.patch(idx, Nil, 1))
+        val parent     = e.parent.getOrElse(throw new XmlBuilderException("Unable to remove detached node"))
+        val parentNode = parent.node
+        parent.node = parentNode.copy(child = parentNode.child.patch(idx, Nil, 1))
       case a: Attribute =>
         val toDelete   = a.node
-        val parentNode = a.parent.node
+        val parent     = a.parent.getOrElse(throw new XmlBuilderException("Unable to remove detached node"))
+        val parentNode = parent.node
         val newAttr =
           if (toDelete.isPrefixed)
             parentNode.attributes.remove(toDelete.getNamespace(parentNode), parentNode, toDelete.key)
           else parentNode.attributes.remove(toDelete.key)
-        a.parent.node = parentNode.copy(attributes = newAttr)
+        parent.node = parentNode.copy(attributes = newAttr)
       case _ =>
         throw new XmlBuilderException(s"Unable to remove node ${node.toString}")
     }

xpath-to-xml-scala/src/main/scala/com/github/simy4/xpath/scala/navigator/ScalaXmlNavigator.scala

@@ -0,0 +1,109 @@
+/*
+ * Copyright 2018-2021 Alex Simkin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.github.simy4.xpath
+package scala.navigator
+
+import navigator.{ Node => NavigatorNode }
+import xml.{ Attribute => XmlAttribute, Elem, Text }
+
+import javax.xml.namespace.QName
+
+/**
+ * Scala XML node contract.
+ *
+ * @author
+ *   Alex Simkin
+ * @since 2.0
+ */
+sealed trait ScalaXmlNode extends NavigatorNode with Equals {
+  type N
+  def parent: Option[ScalaXmlNode]
+  @SuppressWarnings(Array("org.wartremover.warts.Var"))
+  private[navigator] var node: N
+  def elements: Iterable[ScalaXmlNode]
+  def attributes: Iterable[ScalaXmlNode]
+  override def toString: String = node.toString
+}
+
+@SerialVersionUID(1L)
+@SuppressWarnings(Array("org.wartremover.warts.Var"))
+final case class Root(var node: Elem) extends ScalaXmlNode {
+  type N = Elem
+  def getName: QName                = new QName(NavigatorNode.DOCUMENT)
+  def getText: String               = ""
+  def parent: None.type             = None
+  def elements: Iterable[Element]   = Element(node)(Some(this)) :: Nil
+  def attributes: Iterable[Nothing] = Nil
+}
+
+@SerialVersionUID(1L)
+@SuppressWarnings(Array("org.wartremover.warts.Var", "org.wartremover.warts.DefaultArguments"))
+final private[navigator] case class Element(
+  private var _node: Elem,
+  var index: Int = 0
+)(var parent: Option[ScalaXmlNode { type N = Elem }] = None)
+    extends ScalaXmlNode {
+  type N = Elem
+  def getName: QName = {
+    val node = _node
+    if (null != node.prefix) new QName(node.namespace, node.label, node.prefix)
+    else new QName(node.label)
+  }
+  def getText: String = node.child.collect { case Text(t) => t }.mkString
+  @SuppressWarnings(Array("org.wartremover.warts.Any"))
+  def elements: Iterable[Element] =
+    _node.child.view.zipWithIndex.collect { case (e: Elem, i) => Element(e, i)(Some(this)) }
+  def attributes: Iterable[Attribute] =
+    _node.attributes.view.collect { case a: XmlAttribute => Attribute(a)(Some(this)) }
+  private[navigator] def node: Elem = _node
+  @SuppressWarnings(Array("org.wartremover.warts.Throw"))
+  @throws[XmlBuilderException]("If setting an element to detached node")
+  private[navigator] def node_=(elem: Elem): Unit = {
+    val parent     = this.parent.getOrElse(throw new XmlBuilderException("Unable to set element to detached node"))
+    val parentNode = parent.node
+    parent.node =
+      if (parentNode eq _node) elem
+      else parentNode.copy(child = parentNode.child.updated(index, elem))
+    _node = elem
+  }
+}
+
+@SerialVersionUID(1L)
+@SuppressWarnings(Array("org.wartremover.warts.Var", "org.wartremover.warts.DefaultArguments"))
+final private[navigator] case class Attribute(
+  private var attr: XmlAttribute
+)(var parent: Option[ScalaXmlNode { type N = Elem }] = None)
+    extends ScalaXmlNode {
+  type N = XmlAttribute
+  def getName: QName = {
+    val attr = this.attr
+    parent match {
+      case Some(parent) if attr.isPrefixed => new QName(attr.getNamespace(parent.node), attr.key, attr.pre)
+      case _                               => new QName(attr.key)
+    }
+  }
+  def getText: String                       = attr.value.text
+  def elements: Iterable[Nothing]           = Nil
+  def attributes: Iterable[Nothing]         = Nil
+  private[navigator] def node: XmlAttribute = attr
+  @SuppressWarnings(Array("org.wartremover.warts.Throw"))
+  @throws[XmlBuilderException]("If setting an attribute to detached node")
+  private[navigator] def node_=(attr: XmlAttribute): Unit = {
+    val parent = this.parent.getOrElse(throw new XmlBuilderException("Unable to set attribute to detached node"))
+    parent.node = parent.node % attr
+    this.attr = attr
+  }
+}