Merge pull request #6 from filip26/feat/fr

Add Tests

Author: filip26

.github/workflows/codacy-coverage.yml

@@ -0,0 +1,31 @@
+# This workflow will build a Java project with Maven
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
+
+name: Codacy Coverage
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    permissions:
+      contents: read
+      pull-requests: write
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up JDK 8
+      uses: actions/setup-java@v4
+      with:
+        java-version: 8
+        distribution: 'temurin'
+    - name: Build with Maven
+      run: mvn -B package jacoco:report 
+    - name: Run codacy-coverage-reporter
+      uses: codacy/codacy-coverage-reporter-action@v1.3.0
+      with:
+        project-token: ${{secrets.CODACY_PROJECT_TOKEN}}
+        coverage-reports: ./target/site/jacoco/jacoco.xml

README.md

@@ -2,6 +2,8 @@
 
 An implementation of the [RFC 8785 JSON Canonicalization Scheme (JCS)](https://www.rfc-editor.org/rfc/rfc8785) specification in Java, utilizing [Jakarta JSON Processing](https://github.com/eclipse-ee4j/jsonp) as input. The canonical version is written to a provided `Writer`.
 
+Formerly part of [titanium-json-ld](https://github.com/filip26/titanium-json-ld).
+
 ## Resources
 
 - [RFC 8785 JSON Canonicalization Scheme (JCS)](https://www.rfc-editor.org/rfc/rfc8785)

pom.xml

@@ -22,17 +22,17 @@
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
         <argLine>-Dfile.encoding=UTF-8</argLine>
 
-        <jakarta.json.version>2.1.3</jakarta.json.version>
+        <jakarta.json.version>2.0.1</jakarta.json.version>
 
 
         <!--  test resources -->
         <junit.version>5.12.0</junit.version>
     </properties>
 
-    <name>Copper Multcodec</name>
+    <name>Titanium JCS</name>
 
     <description>
-        Multicodec &amp; Multihash API, Registry
+        An implementation of the RFC 8785 JSON Canonicalization Scheme (JCS) specification in Java, utilizing Jakarta JSON Processing.
     </description>
 
     <licenses>
@@ -80,6 +80,12 @@
             <version>${junit.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.glassfish</groupId>
+            <artifactId>jakarta.json</artifactId>
+            <version>${jakarta.json.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/com/apicatalog/jcs/JsonCanonicalizer.java

@@ -74,6 +74,7 @@ public static final void canonize(final JsonValue value, final Writer writer) th
 
         if (valueType == null || ValueType.NULL == valueType) {
             writer.write("null");
+            return;
         }
 
         switch (valueType) {
@@ -127,7 +128,7 @@ public static final void canonizeArray(final JsonArray value, final Writer write
 
         writer.write("[");
 
-        for (JsonValue item : value.asJsonArray()) {
+        for (final JsonValue item : value.asJsonArray()) {
 
             if (next) {
                 writer.write(",");
@@ -139,7 +140,6 @@ public static final void canonizeArray(final JsonArray value, final Writer write
         }
 
         writer.write("]");
-
     }
 
     private static final void canonizeObject(final JsonObject value, final Writer writer) throws IOException {
@@ -151,6 +151,7 @@ private static final void canonizeObject(final JsonObject value, final Writer wr
 
         if (properties != null && !properties.isEmpty()) {
             final ArrayList<String> sortedProperties = new ArrayList<>(properties);
+
             Collections.sort(sortedProperties);
 
             for (final String propertyName : sortedProperties) {

src/test/java/com/apicatalog/jcs/JsonCanonicalizerTest.java

@@ -0,0 +1,42 @@
+package com.apicatalog.jcs;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.io.BufferedInputStream;
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
+import java.util.stream.Collectors;
+
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+import jakarta.json.Json;
+import jakarta.json.JsonReader;
+import jakarta.json.JsonValue;
+
+class JsonCanonicalizerTest {
+
+    @ParameterizedTest
+    @ValueSource(strings = { "primitive-data-types", "uni-sort", "array", "object" })
+    void testCanonize(String name) throws IOException {
+        assertEquals(getResource(name + ".out.json"), JsonCanonicalizer.canonize(getJson(name + ".in.json")));
+    }
+
+    static String getResource(String name) throws IOException {
+        try (BufferedInputStream is = new BufferedInputStream(JsonCanonicalizerTest.class.getResourceAsStream(name))) {
+            return new BufferedReader(
+                    new InputStreamReader(is, StandardCharsets.UTF_8))
+                    .lines()
+                    .collect(Collectors.joining("\n"));
+        }
+    }
+
+    static JsonValue getJson(String name) {
+        try (JsonReader reader = Json.createReader(
+                JsonCanonicalizerTest.class.getResourceAsStream(name))) {
+            return reader.read();
+        }
+    }
+}

src/test/resources/com/apicatalog/jcs/array.in.json

@@ -0,0 +1,10 @@
+[
+  56
+,
+  {
+    "d": true,
+    "10": null,
+    "1": [ ],
+    "": false
+  }
+]

src/test/resources/com/apicatalog/jcs/array.out.json

@@ -0,0 +1 @@
+[56,{"":false,"1":[],"10":null,"d":true}]

src/test/resources/com/apicatalog/jcs/object.in.json

@@ -0,0 +1,26 @@
+{
+  "1": {
+    "f": {
+      "f": "hi",
+      "F": 5
+    },
+    "\n": 56.0
+  },
+  "10": {
+    
+  },
+  "": "empty",
+  "a": {
+    
+  },
+  "111": [
+    {
+      "e": "yes",
+      "E": "no"
+    }
+  ],
+  "A": {
+    "b": "123"
+  },
+  "České": "ěšĎů"
+}

src/test/resources/com/apicatalog/jcs/object.out.json

@@ -0,0 +1 @@
+{"":"empty","1":{"\n":56,"f":{"F":5,"f":"hi"}},"10":{},"111":[{"E":"no","e":"yes"}],"A":{"b":"123"},"a":{},"České":"ěšĎů"}

src/test/resources/com/apicatalog/jcs/primitive-data-types.in.json

@@ -0,0 +1,15 @@
+ {
+  "numbers": [
+    333333333.33333329,
+    1E30,
+    4.50,
+    2e-3,
+    0.000000000000000000000000001
+  ],
+  "string": "\u20ac$\u000F\u000aA'\u0042\u0022\u005c\\\"\/",
+  "literals": [
+    null,
+    true,
+    false
+  ]
+}

src/test/resources/com/apicatalog/jcs/primitive-data-types.out.json

@@ -0,0 +1 @@
+{"literals":[null,true,false],"numbers":[333333333.3333333,1e+30,4.5,0.002,1e-27],"string":"€$\u000f\nA'B\"\\\\\"/"}

src/test/resources/com/apicatalog/jcs/uni-sort.in.json

@@ -0,0 +1,9 @@
+  {
+    "\u20ac": "Euro Sign",
+    "\r": "Carriage Return",
+    "\ufb33": "Hebrew Letter Dalet With Dagesh",
+    "1": "One",
+    "\ud83d\ude00": "Emoji: Grinning Face",
+    "\u0080": "Control",
+    "\u00f6": "Latin Small Letter O With Diaeresis"
+  }

src/test/resources/com/apicatalog/jcs/uni-sort.out.json

@@ -0,0 +1 @@
+{"\r":"Carriage Return","1":"One","€":"Control","ö":"Latin Small Letter O With Diaeresis","€":"Euro Sign","😀":"Emoji: Grinning Face","דּ":"Hebrew Letter Dalet With Dagesh"}