Merge branch 'release/1.2.0'

Release: com.io7m.blackthorne 1.2.0
Change: Add logging for content handlers (Ticket: #3)
Change: Add more convenience methods for scalar elements (Ticket: #2)

README-CHANGES.xml

@@ -1,12 +1,26 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <c:changelog project="com.io7m.blackthorne" xmlns:c="urn:com.io7m.changelog:4.0">
   <c:releases>
-    <c:release date="2020-10-15T00:00:00+00:00" ticket-system="com.github.io7m.blackthorne" version="1.0.0">
+    <c:release date="2020-10-15T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.blackthorne" version="1.0.0">
       <c:changes/>
     </c:release>
-    <c:release date="2020-10-24T20:32:34+00:00" ticket-system="com.github.io7m.blackthorne" version="1.1.0">
+    <c:release date="2020-10-24T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.blackthorne" version="1.1.0">
       <c:changes>
-        <c:change date="2020-10-24T20:32:34+00:00" summary="Allow content handlers to throw raw exceptions">
+        <c:change date="2020-10-24T00:00:00+00:00" summary="Allow content handlers to throw raw exceptions">
+          <c:tickets>
+            <c:ticket id="2"/>
+          </c:tickets>
+        </c:change>
+      </c:changes>
+    </c:release>
+    <c:release date="2021-01-24T13:01:32+00:00" is-open="false" ticket-system="com.github.io7m.blackthorne" version="1.2.0">
+      <c:changes>
+        <c:change date="2021-01-24T00:00:00+00:00" summary="Add logging for content handlers">
+          <c:tickets>
+            <c:ticket id="3"/>
+          </c:tickets>
+        </c:change>
+        <c:change date="2021-01-24T00:00:00+00:00" summary="Add more convenience methods for scalar elements">
           <c:tickets>
             <c:ticket id="2"/>
           </c:tickets>

com.io7m.blackthorne.api/pom.xml

@@ -8,7 +8,7 @@
   <parent>
     <artifactId>com.io7m.blackthorne</artifactId>
     <groupId>com.io7m.blackthorne</groupId>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
   </parent>
 
   <artifactId>com.io7m.blackthorne.api</artifactId>

com.io7m.blackthorne.api/src/main/java/com/io7m/blackthorne/api/BTContentHandler.java

@@ -17,6 +17,8 @@
 package com.io7m.blackthorne.api;
 
 import com.io7m.jlexing.core.LexicalPosition;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.xml.sax.Attributes;
 import org.xml.sax.Locator;
 import org.xml.sax.SAXException;
@@ -40,6 +42,9 @@
 
 public final class BTContentHandler<T> extends DefaultHandler2
 {
+  private static final Logger LOG =
+    LoggerFactory.getLogger(BTContentHandler.class);
+
   private final URI fileURI;
   private final Consumer<BTParseError> errorReceiver;
   private Locator2 locator;
@@ -112,8 +117,10 @@ private static String messageOrException(
   public void setDocumentLocator(
     final Locator in_locator)
   {
-    this.locator = (Locator2) Objects.requireNonNull(in_locator, "locator");
-    this.stackHandler = new BTStackHandler<T>(this.locator, this.rootHandlers);
+    this.locator =
+      (Locator2) Objects.requireNonNull(in_locator, "locator");
+    this.stackHandler =
+      new BTStackHandler<>(this.locator, this.rootHandlers);
   }
 
   @Override
@@ -166,6 +173,8 @@ public void characters(
   public void warning(
     final SAXParseException e)
   {
+    LOG.warn("parse exception: ", e);
+
     this.errorReceiver.accept(
       BTParseError.builder()
         .setException(e)
@@ -179,6 +188,8 @@ public void warning(
   public void error(
     final SAXParseException e)
   {
+    LOG.error("parse exception: ", e);
+
     this.failed = true;
     this.errorReceiver.accept(
       BTParseError.builder()
@@ -194,6 +205,8 @@ public void fatalError(
     final SAXParseException e)
     throws SAXException
   {
+    LOG.error("fatal parse exception: ", e);
+
     this.failed = true;
     this.errorReceiver.accept(
       BTParseError.builder()

com.io7m.blackthorne.api/src/main/java/com/io7m/blackthorne/api/Blackthorne.java

@@ -276,6 +276,87 @@ public static <S> BTElementHandlerConstructorType<S, List<S>> forListPoly(
       ignoreUnrecognized);
   }
 
+  /**
+   * A convenience function for constructing content handlers that produce a scalar value from the
+   * text content of a single XML element.
+   *
+   * @param elementName The name of the element
+   *
+   * @return A content handler constructor
+   */
+
+  public static BTElementHandlerConstructorType<?, String> forScalarString(
+    final BTQualifiedName elementName)
+  {
+    return forScalar(elementName, (context, characters, offset, length) -> {
+      // CHECKSTYLE:OFF
+      return new String(characters, offset, length);
+      // CHECKSTYLE:ON
+    });
+  }
+
+  /**
+   * A convenience function for constructing content handlers that produce a scalar value from the
+   * text content of a single XML element.
+   *
+   * @param namespaceURI The namespace of the element
+   * @param localName    The local element name
+   *
+   * @return A content handler constructor
+   */
+
+  public static BTElementHandlerConstructorType<?, String> forScalarString(
+    final String namespaceURI,
+    final String localName)
+  {
+    return forScalar(
+      namespaceURI,
+      localName,
+      (context, characters, offset, length) -> {
+        // CHECKSTYLE:OFF
+        return new String(characters, offset, length);
+        // CHECKSTYLE:ON
+      });
+  }
+
+  /**
+   * A convenience function for constructing content handlers that produce a scalar value from the
+   * text content of a single XML element.
+   *
+   * @param elementName The name of the element
+   * @param parser      A function from strings to values of type {@code S}
+   * @param <S>         The type of returned values
+   *
+   * @return A content handler constructor
+   */
+
+  public static <S> BTElementHandlerConstructorType<?, S> forScalarFromString(
+    final BTQualifiedName elementName,
+    final Function<String, S> parser)
+  {
+    return mapConstructor(forScalarString(elementName), parser);
+  }
+
+  /**
+   * A convenience function for constructing content handlers that produce a scalar value from the
+   * text content of a single XML element.
+   *
+   * @param namespaceURI The namespace of the element
+   * @param localName    The local element name
+   * @param parser       A function from strings to values of type {@code S}
+   * @param <S>          The type of returned values
+   *
+   * @return A content handler constructor
+   */
+
+  public static <S> BTElementHandlerConstructorType<?, S> forScalarFromString(
+    final String namespaceURI,
+    final String localName,
+    final Function<String, S> parser)
+  {
+    return mapConstructor(forScalarString(namespaceURI, localName), parser);
+  }
+
   /**
    * A convenience method to configure and execute a parser.
    *

com.io7m.blackthorne.api/src/main/java/com/io7m/blackthorne/api/package-info.java

@@ -19,7 +19,7 @@
  */
 
 @Export
-@Version("1.1.0")
+@Version("1.2.0")
 package com.io7m.blackthorne.api;
 
 import org.osgi.annotation.bundle.Export;

com.io7m.blackthorne.jxe/pom.xml

@@ -8,7 +8,7 @@
   <parent>
     <artifactId>com.io7m.blackthorne</artifactId>
     <groupId>com.io7m.blackthorne</groupId>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
   </parent>
 
   <artifactId>com.io7m.blackthorne.jxe</artifactId>

com.io7m.blackthorne.tests/pom.xml

@@ -8,7 +8,7 @@
   <parent>
     <artifactId>com.io7m.blackthorne</artifactId>
     <groupId>com.io7m.blackthorne</groupId>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
   </parent>
 
   <artifactId>com.io7m.blackthorne.tests</artifactId>

com.io7m.blackthorne.tests/src/test/java/com/io7m/blackthorne/tests/BlackthorneTest.java

@@ -1278,4 +1278,123 @@ public void testLeafIntegerAttr0()
     Assertions.assertEquals(0, this.errors.size());
     Assertions.assertEquals(BigInteger.valueOf(23L), handler.result().get());
   }
+
+  /**
+   * Scalar element handlers work.
+   *
+   * @throws Exception On errors
+   */
+
+  @Test
+  public void testText0()
+    throws Exception
+  {
+    final var handler =
+      BTContentHandler.<String>builder()
+        .addHandler(
+          "urn:tests",
+          "string",
+          Blackthorne.forScalarString("urn:tests", "string"))
+        .build(URI.create("urn:text"), this::logError);
+
+    final var reader = createReader();
+    reader.setContentHandler(handler);
+    reader.setErrorHandler(handler);
+    reader.parse(resource("string.xml"));
+
+    Assertions.assertFalse(handler.failed());
+    Assertions.assertEquals(0, this.errors.size());
+    Assertions.assertEquals("This is some text.", handler.result().get());
+  }
+
+  /**
+   * Scalar element handlers work.
+   *
+   * @throws Exception On errors
+   */
+
+  @Test
+  public void testText1()
+    throws Exception
+  {
+    final var name =
+      BTQualifiedName.of("urn:tests", "string");
+
+    final var handler =
+      BTContentHandler.<String>builder()
+        .addHandler(name, Blackthorne.forScalarString(name))
+        .build(URI.create("urn:text"), this::logError);
+
+    final var reader = createReader();
+    reader.setContentHandler(handler);
+    reader.setErrorHandler(handler);
+    reader.parse(resource("string.xml"));
+
+    Assertions.assertFalse(handler.failed());
+    Assertions.assertEquals(0, this.errors.size());
+    Assertions.assertEquals("This is some text.", handler.result().get());
+  }
+
+  /**
+   * Scalar element handlers work.
+   *
+   * @throws Exception On errors
+   */
+
+  @Test
+  public void testText2()
+    throws Exception
+  {
+    final var handler =
+      BTContentHandler.<Exception>builder()
+        .addHandler(
+          "urn:tests",
+          "string",
+          Blackthorne.forScalarFromString(
+            "urn:tests",
+            "string",
+            Exception::new))
+        .build(URI.create("urn:text"), this::logError);
+
+    final var reader = createReader();
+    reader.setContentHandler(handler);
+    reader.setErrorHandler(handler);
+    reader.parse(resource("string.xml"));
+
+    Assertions.assertFalse(handler.failed());
+    Assertions.assertEquals(0, this.errors.size());
+    Assertions.assertEquals(
+      "This is some text.",
+      handler.result().get().getMessage());
+  }
+
+  /**
+   * Scalar element handlers work.
+   *
+   * @throws Exception On errors
+   */
+
+  @Test
+  public void testText3()
+    throws Exception
+  {
+    final var name =
+      BTQualifiedName.of("urn:tests", "string");
+
+    final var handler =
+      BTContentHandler.<Exception>builder()
+        .addHandler(name, Blackthorne.forScalarFromString(name, Exception::new))
+        .build(URI.create("urn:text"), this::logError);
+
+    final var reader = createReader();
+    reader.setContentHandler(handler);
+    reader.setErrorHandler(handler);
+    reader.parse(resource("string.xml"));
+
+    Assertions.assertFalse(handler.failed());
+    Assertions.assertEquals(0, this.errors.size());
+    Assertions.assertEquals(
+      "This is some text.",
+      handler.result().get().getMessage());
+  }
 }

com.io7m.blackthorne.tests/src/test/resources/com/io7m/blackthorne/tests/choice.xsd

@@ -5,6 +5,12 @@
             attributeFormDefault="qualified"
             targetNamespace="urn:tests">
 
+  <xsd:element name="string">
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:string"/>
+    </xsd:simpleType>
+  </xsd:element>
+
   <xsd:element name="int">
     <xsd:simpleType>
       <xsd:restriction base="xsd:integer"/>

com.io7m.blackthorne.tests/src/test/resources/com/io7m/blackthorne/tests/string.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<ts:string xmlns:ts="urn:tests">This is some text.</ts:string>

pom.xml

@@ -8,12 +8,12 @@
   <parent>
     <groupId>com.io7m.primogenitor</groupId>
     <artifactId>com.io7m.primogenitor.full</artifactId>
-    <version>6.0.0</version>
+    <version>6.2.0</version>
   </parent>
 
   <groupId>com.io7m.blackthorne</groupId>
   <artifactId>com.io7m.blackthorne</artifactId>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <packaging>pom</packaging>
 
   <name>com.io7m.blackthorne</name>
@@ -33,7 +33,7 @@
     <com.io7m.immutables.version>2.7.5</com.io7m.immutables.version>
     <com.io7m.junit.version>5.7.0</com.io7m.junit.version>
     <com.io7m.jxe.version>1.0.0</com.io7m.jxe.version>
-    <io7m.api.previousVersion>1.0.0</io7m.api.previousVersion>
+    <io7m.api.previousVersion>1.1.0</io7m.api.previousVersion>
   </properties>
 
   <licenses>