Add custom boolean attribute support jhy#503

Legioth · Legioth · commit eafba57cb72a · 2015-04-18T21:44:43.000+03:00
* Adds BooleanAttribute that writes out itself without a value
* Adds API in Element for setting boolean attributes
* Update parser to distinguish between no value and empty value
diff --git a/src/main/java/org/jsoup/nodes/Attribute.java b/src/main/java/org/jsoup/nodes/Attribute.java
@@ -121,7 +121,11 @@ protected boolean isDataAttribute() {
     protected final boolean shouldCollapseAttribute(Document.OutputSettings out) {
         return ("".equals(value) || value.equalsIgnoreCase(key))
                 && out.syntax() == Document.OutputSettings.Syntax.html
-                && Arrays.binarySearch(booleanAttributes, key) >= 0;
+                && isBooleanAttribute();
+    }
+
+    protected boolean isBooleanAttribute() {
+        return Arrays.binarySearch(booleanAttributes, key) >= 0;
     }
 
     @Override
diff --git a/src/main/java/org/jsoup/nodes/Attributes.java b/src/main/java/org/jsoup/nodes/Attributes.java
@@ -48,6 +48,18 @@ public void put(String key, String value) {
         Attribute attr = new Attribute(key, value);
         put(attr);
     }
+    
+    /**
+    Set a new boolean attribute, remove attribute if value is false.
+    @param key attribute key
+    @param value attribute value
+    */
+    public void put(String key, boolean value) {
+        if (value)
+            put(new BooleanAttribute(key));
+        else
+            remove(key);
+    }
 
     /**
      Set a new attribute, or replace an existing one by key.
diff --git a/src/main/java/org/jsoup/nodes/BooleanAttribute.java b/src/main/java/org/jsoup/nodes/BooleanAttribute.java
@@ -0,0 +1,19 @@
+package org.jsoup.nodes;
+
+/**
+ * A boolean attribute that is written out without any value.
+ */
+public class BooleanAttribute extends Attribute {
+    /**
+     * Create a new boolean attribute from unencoded (raw) key.
+     * @param key attribute key
+     */
+    public BooleanAttribute(String key) {
+        super(key, "");
+    }
+
+    @Override
+    protected boolean isBooleanAttribute() {
+        return true;
+    }
+}
diff --git a/src/main/java/org/jsoup/nodes/Element.java b/src/main/java/org/jsoup/nodes/Element.java
@@ -116,6 +116,21 @@ public Element attr(String attributeKey, String attributeValue) {
         super.attr(attributeKey, attributeValue);
         return this;
     }
+    
+    /**
+     * Set a boolean attribute value on this element. Setting to <code>true</code> sets the attribute value to "" and
+     * marks the attribute as boolean so no value is written out. Setting to <code>false</code> removes the attribute
+     * with the same key if it exists.
+     * 
+     * @param attributeKey the attribute key
+     * @param attributeValue the attribute value
+     * 
+     * @return this element
+     */
+    public Element attr(String attributeKey, boolean attributeValue) {
+        attributes.put(attributeKey, attributeValue);
+        return this;
+    }
 
     /**
      * Get this element's HTML5 custom data attributes. Each attribute in the element that has a key
diff --git a/src/main/java/org/jsoup/parser/Token.java b/src/main/java/org/jsoup/parser/Token.java
@@ -3,6 +3,7 @@
 import org.jsoup.helper.Validate;
 import org.jsoup.nodes.Attribute;
 import org.jsoup.nodes.Attributes;
+import org.jsoup.nodes.BooleanAttribute;
 
 /**
  * Parse tokens for the Tokeniser.
@@ -69,6 +70,7 @@ static abstract class Tag extends Token {
         protected String tagName;
         private String pendingAttributeName; // attribute names are generally caught in one hop, not accumulated
         private StringBuilder pendingAttributeValue = new StringBuilder(); // but values are accumulated, from e.g. & in hrefs
+        private boolean hasEmptyAttributeValue = false; // distinguish boolean attribute from empty string value
         private boolean hasPendingAttributeValue = false;
         boolean selfClosing = false;
         Attributes attributes; // start tags get attributes on construction. End tags get attributes on first new attribute (but only for parser convenience, not used).
@@ -78,6 +80,7 @@ Tag reset() {
             tagName = null;
             pendingAttributeName = null;
             reset(pendingAttributeValue);
+            hasEmptyAttributeValue = false;
             hasPendingAttributeValue = false;
             selfClosing = false;
             attributes = null;
@@ -90,13 +93,17 @@ final void newAttribute() {
 
             if (pendingAttributeName != null) {
                 Attribute attribute;
-                if (!hasPendingAttributeValue)
+                if (hasPendingAttributeValue)
+                    attribute = new Attribute(pendingAttributeName, pendingAttributeValue.toString());
+                else if (hasEmptyAttributeValue)
                     attribute = new Attribute(pendingAttributeName, "");
                 else
-                    attribute = new Attribute(pendingAttributeName, pendingAttributeValue.toString());
+                    attribute = new BooleanAttribute(pendingAttributeName);
                 attributes.put(attribute);
             }
             pendingAttributeName = null;
+            hasEmptyAttributeValue = false;
+            hasPendingAttributeValue = false;
             reset(pendingAttributeValue);
         }
 
@@ -158,6 +165,10 @@ final void appendAttributeValue(char[] append) {
             ensureAttributeValue();
             pendingAttributeValue.append(append);
         }
+        
+        final void setEmptyAttributeValue() {
+            hasEmptyAttributeValue = true;
+        }
 
         private void ensureAttributeValue() {
             hasPendingAttributeValue = true;
diff --git a/src/main/java/org/jsoup/parser/TokeniserState.java b/src/main/java/org/jsoup/parser/TokeniserState.java
@@ -782,6 +782,8 @@ void read(Tokeniser t, CharacterReader r) {
             String value = r.consumeToAnySorted(attributeDoubleValueCharsSorted);
             if (value.length() > 0)
                 t.tagPending.appendAttributeValue(value);
+            else
+                t.tagPending.setEmptyAttributeValue();
 
             char c = r.consume();
             switch (c) {
@@ -812,6 +814,8 @@ void read(Tokeniser t, CharacterReader r) {
             String value = r.consumeToAnySorted(attributeSingleValueCharsSorted);
             if (value.length() > 0)
                 t.tagPending.appendAttributeValue(value);
+            else
+                t.tagPending.setEmptyAttributeValue();
 
             char c = r.consume();
             switch (c) {
diff --git a/src/test/java/org/jsoup/nodes/ElementTest.java b/src/test/java/org/jsoup/nodes/ElementTest.java
@@ -294,6 +294,22 @@ public class ElementTest {
             assertEquals(i, ps.get(i).siblingIndex);
         }
     }
+    
+    @Test public void testAddBooleanAttribute() {
+        Element div = new Element(Tag.valueOf("div"), "");
+        
+        div.attr("true", true);
+        
+        div.attr("false", "value");
+        div.attr("false", false);
+        
+        assertTrue(div.hasAttr("true"));
+        assertEquals("", div.attr("true"));
+        
+        assertFalse(div.hasAttr("false"));
+ 
+        assertEquals("<div true></div>", div.outerHtml());
+    }    
 
     @Test public void testAppendRowToTable() {
         Document doc = Jsoup.parse("<table><tr><td>1</td></tr></table>");
diff --git a/src/test/java/org/jsoup/parser/AttributeParseTest.java b/src/test/java/org/jsoup/parser/AttributeParseTest.java
@@ -66,4 +66,16 @@ public class AttributeParseTest {
         Elements els = Jsoup.parse(html).select("a");
         assertEquals("&wr_id=123&mid-size=true&ok=&wr", els.first().attr("href"));
     }
+    
+    @Test public void parsesBooleanAttributes() {
+        String html = "<a normal=\"123\" boolean empty=\"\"></a>";
+        Element el = Jsoup.parse(html).select("a").first();
+        
+        assertEquals("123", el.attr("normal"));
+        assertEquals("", el.attr("boolean"));
+        assertEquals("", el.attr("empty"));
+        
+        assertEquals(html, el.outerHtml());
+    }
+    
 }
diff --git a/src/test/java/org/jsoup/parser/HtmlParserTest.java b/src/test/java/org/jsoup/parser/HtmlParserTest.java
@@ -43,11 +43,11 @@ public class HtmlParserTest {
         String html = "<p =a>One<a <p>Something</p>Else";
         // this gets a <p> with attr '=a' and an <a tag with an attribue named '<p'; and then auto-recreated
         Document doc = Jsoup.parse(html);
-        assertEquals("<p =a=\"\">One<a <p=\"\">Something</a></p>\n" +
-                "<a <p=\"\">Else</a>", doc.body().html());
+        assertEquals("<p =a>One<a <p>Something</a></p>\n" +
+                "<a <p>Else</a>", doc.body().html());
 
         doc = Jsoup.parse("<p .....>");
-        assertEquals("<p .....=\"\"></p>", doc.body().html());
+        assertEquals("<p .....></p>", doc.body().html());
     }
 
     @Test public void parsesComments() {
