Merge pull request #111 from veselov/editable-builder

Allow builder to be fully editable

Author: stevespringett

src/main/java/com/github/packageurl/PackageURL.java

@@ -146,6 +146,23 @@ public PackageURL(final String type, final String namespace, final String name,
      */
     private String subpath;
 
+    public PackageURLBuilder toBuilder() {
+
+        PackageURLBuilder builder = PackageURLBuilder.aPackageURL()
+                .withType(getType())
+                .withNamespace(getNamespace())
+                .withName(getName())
+                .withVersion(getVersion())
+                .withSubpath(getSubpath());
+
+        if (qualifiers != null) {
+            qualifiers.forEach(builder::withQualifier);
+        }
+
+        return builder;
+
+    }
+
     /**
      * Returns the package url scheme.
      *

src/main/java/com/github/packageurl/PackageURLBuilder.java

@@ -124,6 +124,88 @@ public PackageURLBuilder withQualifier(final String key, final String value) {
         return this;
     }
 
+    /**
+     * Removes a package qualifier. This is a no-op if the qualifier is not present.
+     * @param key the package qualifier key to remove
+     * @return a reference to the builder
+     */
+    public PackageURLBuilder withoutQualifier(final String key) {
+        if (qualifiers != null) {
+            qualifiers.remove(key);
+            if (qualifiers.isEmpty()) { qualifiers = null; }
+        }
+        return this;
+    }
+
+    /**
+     * Removes all qualifiers, if any.
+     * @return a reference to this builder.
+     */
+    public PackageURLBuilder withNoQualifiers() {
+        qualifiers = null;
+        return this;
+    }
+
+    /**
+     * Returns current type value set in the builder.
+     * @return type set in this builder
+     */
+    public String getType() {
+        return type;
+    }
+
+    /**
+     * Returns current namespace value set in the builder.
+     * @return namespace set in this builder
+     */
+    public String getNamespace() {
+        return namespace;
+    }
+
+    /**
+     * Returns current name value set in the builder.
+     * @return name set in this builder
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Returns current version value set in the builder.
+     * @return version set in this builder
+     */
+    public String getVersion() {
+        return version;
+    }
+
+    /**
+     * Returns current subpath value set in the builder.
+     * @return subpath set in this builder
+     */
+    public String getSubpath() {
+        return subpath;
+    }
+
+    /**
+     * Returns sorted map containing all qualifiers set in this builder.
+     * An empty map is returned if no qualifiers is set.
+     * @return all qualifiers set in this builder, or an empty map if none are set.
+     */
+    public TreeMap<String, String> getQualifiers() {
+        if (qualifiers == null) { return new TreeMap<>(); }
+        return new TreeMap<>(qualifiers);
+    }
+
+    /**
+     * Returns a currently set qualifier value set in the builder for the specified key.
+     * @param key qualifier key
+     * @return qualifier value or {@code null} if one is not set.
+     */
+    public String getQualifier(String key) {
+        if (qualifiers == null) { return null; }
+        return qualifiers.get(key);
+    }
+
     /**
      * Builds the new PackageURL object.
      *

src/test/java/com/github/packageurl/PackageURLBuilderTest.java

@@ -26,6 +26,8 @@
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
 
+import java.util.Map;
+
 import static org.junit.Assert.*;
 
 public class PackageURLBuilderTest {
@@ -94,6 +96,7 @@ public void testPackageURLBuilder() throws MalformedPackageURLException {
     @Test
     public void testPackageURLBuilderException1() throws MalformedPackageURLException {
         exception.expect(MalformedPackageURLException.class);
+        exception.expectMessage("contains a qualifier key with an empty or null");
         PackageURL purl = PackageURLBuilder.aPackageURL()
                 .withType("type")
                 .withName("name")
@@ -102,6 +105,18 @@ public void testPackageURLBuilderException1() throws MalformedPackageURLExceptio
         Assert.fail("Build should fail due to invalid qualifier (empty value)");
     }
 
+    @Test
+    public void testPackageURLBuilderException1Null() throws MalformedPackageURLException {
+        exception.expect(MalformedPackageURLException.class);
+        exception.expectMessage("contains a qualifier key with an empty or null");
+        PackageURLBuilder.aPackageURL()
+                .withType("type")
+                .withName("name")
+                .withQualifier("key",null)
+                .build();
+        Assert.fail("Build should fail due to invalid qualifier (null value)");
+    }
+
     @Test
     public void testPackageURLBuilderException2() throws MalformedPackageURLException {
         exception.expect(MalformedPackageURLException.class);
@@ -156,4 +171,49 @@ public void testPackageURLBuilderException6() throws MalformedPackageURLExceptio
         Assert.fail("Build should fail due to invalid qualifier key");
     }
 
+    @Test
+    public void testEditBuilder1() throws MalformedPackageURLException {
+
+        PackageURL p = new PackageURL("pkg:generic/namespace/name@1.0.0?k=v#s");
+        PackageURLBuilder b = p.toBuilder();
+        assertBuilderMatch(p, b);
+
+        assertBuilderMatch(new PackageURL("pkg:generic/namespace/name@1.0.0#s"), b.withNoQualifiers());
+        b.withType("maven")
+                .withNamespace("org.junit")
+                .withName("junit5")
+                .withVersion("3.1.2")
+                .withSubpath("sub")
+                .withQualifier("repo", "maven")
+                .withQualifier("dark", "matter")
+                .withQualifier("ping", "pong")
+                .withoutQualifier("dark");
+
+        assertBuilderMatch(new PackageURL("pkg:maven/org.junit/junit5@3.1.2?repo=maven&ping=pong#sub"), b);
+
+    }
+
+    private void assertBuilderMatch(PackageURL expected, PackageURLBuilder actual) throws MalformedPackageURLException {
+
+        Assert.assertEquals(expected.toString(), actual.build().toString());
+        Assert.assertEquals(expected.getType(), actual.getType());
+        Assert.assertEquals(expected.getNamespace(), actual.getNamespace());
+        Assert.assertEquals(expected.getName(), actual.getName());
+        Assert.assertEquals(expected.getVersion(), actual.getVersion());
+        Assert.assertEquals(expected.getSubpath(), actual.getSubpath());
+
+        Map<String, String> eQualifiers = expected.getQualifiers();
+        Map<String, String> aQualifiers = actual.getQualifiers();
+
+        if (eQualifiers != null) {
+            eQualifiers.forEach((k,v)-> {
+                Assert.assertEquals(v, aQualifiers.remove(k));
+                Assert.assertEquals(v, actual.getQualifier(k));
+            });
+        }
+
+        Assert.assertTrue(aQualifiers.isEmpty());
+
+    }
+
 }