Merge pull request #217 from serj-lotutovici/sl/make_options_public

Make JsonReader.selectName and JsonReader.selectString public.

moshi/src/main/java/com/squareup/moshi/BufferedSourceJsonReader.java

@@ -47,10 +47,11 @@ final class BufferedSourceJsonReader extends JsonReader {
   private static final int PEEKED_SINGLE_QUOTED_NAME = 12;
   private static final int PEEKED_DOUBLE_QUOTED_NAME = 13;
   private static final int PEEKED_UNQUOTED_NAME = 14;
+  private static final int PEEKED_BUFFERED_NAME = 15;
   /** When this is returned, the integer value is stored in peekedLong. */
-  private static final int PEEKED_LONG = 15;
-  private static final int PEEKED_NUMBER = 16;
-  private static final int PEEKED_EOF = 17;
+  private static final int PEEKED_LONG = 16;
+  private static final int PEEKED_NUMBER = 17;
+  private static final int PEEKED_EOF = 18;
 
   /* State machine when parsing numbers */
   private static final int NUMBER_CHAR_NONE = 0;
@@ -98,6 +99,7 @@ final class BufferedSourceJsonReader extends JsonReader {
   // StackOverflowErrors.
   private final int[] stack = new int[32];
   private int stackSize = 0;
+
   {
     stack[stackSize++] = JsonScope.EMPTY_DOCUMENT;
   }
@@ -215,6 +217,7 @@ final class BufferedSourceJsonReader extends JsonReader {
       case PEEKED_SINGLE_QUOTED_NAME:
       case PEEKED_DOUBLE_QUOTED_NAME:
       case PEEKED_UNQUOTED_NAME:
+      case PEEKED_BUFFERED_NAME:
         return Token.NAME;
       case PEEKED_TRUE:
       case PEEKED_FALSE:
@@ -545,6 +548,8 @@ final class BufferedSourceJsonReader extends JsonReader {
       result = nextQuotedValue(DOUBLE_QUOTE_OR_SLASH);
     } else if (p == PEEKED_SINGLE_QUOTED_NAME) {
       result = nextQuotedValue(SINGLE_QUOTE_OR_SLASH);
+    } else if (p == PEEKED_BUFFERED_NAME) {
+      result = peekedString;
     } else {
       throw new JsonDataException("Expected a name but was " + peek() + " at path " + getPath());
     }
@@ -553,12 +558,12 @@ final class BufferedSourceJsonReader extends JsonReader {
     return result;
   }
 
-  @Override int selectName(Options options) throws IOException {
+  @Override public int selectName(Options options) throws IOException {
     int p = peeked;
     if (p == PEEKED_NONE) {
       p = doPeek();
     }
-    if (p != PEEKED_DOUBLE_QUOTED_NAME) {
+    if (p  < PEEKED_SINGLE_QUOTED_NAME || p > PEEKED_BUFFERED_NAME) {
       return -1;
     }
 
@@ -566,10 +571,32 @@ final class BufferedSourceJsonReader extends JsonReader {
     if (result != -1) {
       peeked = PEEKED_NONE;
       pathNames[stackSize - 1] = options.strings[result];
-    }
+
       return result;
     }
 
+    // The next name may be unnecessary escaped. Save the last recorded path name, so that we
+    // can restore the peek state in case we fail to find a match.
+    String lastPathName = pathNames[stackSize - 1];
+
+    String nextName = nextName();
+    for (int i = 0, size = options.strings.length; i < size; i++) {
+      if (nextName.equals(options.strings[i])) {
+        peeked = PEEKED_NONE;
+        pathNames[stackSize - 1] = nextName;
+
+        return i;
+      }
+    }
+
+    peeked = PEEKED_BUFFERED_NAME;
+    peekedString = nextName;
+    // We can't push the path further, make it seem like nothing happened.
+    pathNames[stackSize - 1] = lastPathName;
+
+    return -1;
+  }
+
   @Override public String nextString() throws IOException {
     int p = peeked;
     if (p == PEEKED_NONE) {
@@ -597,12 +624,12 @@ final class BufferedSourceJsonReader extends JsonReader {
     return result;
   }
 
-  @Override int selectString(Options options) throws IOException {
+  @Override public int selectString(Options options) throws IOException {
     int p = peeked;
     if (p == PEEKED_NONE) {
       p = doPeek();
     }
-    if (p != PEEKED_DOUBLE_QUOTED) {
+    if (p < PEEKED_SINGLE_QUOTED || p > PEEKED_BUFFERED) {
       return -1;
     }
 
@@ -610,10 +637,27 @@ final class BufferedSourceJsonReader extends JsonReader {
     if (result != -1) {
       peeked = PEEKED_NONE;
       pathIndices[stackSize - 1]++;
-    }
+
       return result;
     }
 
+    String nextString = nextString();
+    for (int i = 0, size = options.strings.length; i < size; i++) {
+      if (nextString.equals(options.strings[i])) {
+        peeked = PEEKED_NONE;
+        pathIndices[stackSize - 1]++;
+
+        return i;
+      }
+    }
+
+    peeked = PEEKED_BUFFERED;
+    peekedString = nextString;
+    pathIndices[stackSize - 1]--;
+
+    return -1;
+  }
+
   @Override public boolean nextBoolean() throws IOException {
     int p = peeked;
     if (p == PEEKED_NONE) {

moshi/src/main/java/com/squareup/moshi/JsonReader.java

@@ -274,7 +274,7 @@ public abstract class JsonReader implements Closeable {
    * If the next token is a {@linkplain Token#NAME property name} that's in {@code options}, this
    * consumes it and returns its index. Otherwise this returns -1 and no name is consumed.
    */
-  abstract int selectName(Options options) throws IOException;
+  public abstract int selectName(Options options) throws IOException;
 
   /**
    * Returns the {@linkplain Token#STRING string} value of the next token, consuming it. If the next
@@ -288,7 +288,7 @@ public abstract class JsonReader implements Closeable {
    * If the next token is a {@linkplain Token#STRING string} that's in {@code options}, this
    * consumes it and returns its index. Otherwise this returns -1 and no string is consumed.
    */
-  abstract int selectString(Options options) throws IOException;
+  public abstract int selectString(Options options) throws IOException;
 
   /**
    * Returns the {@linkplain Token#BOOLEAN boolean} value of the next token, consuming it.
@@ -359,13 +359,9 @@ public abstract class JsonReader implements Closeable {
 
   /**
    * A set of strings to be chosen with {@link #selectName} or {@link #selectString}. This prepares
-   * the encoded values of the strings so they can be read directly from the input source. It cannot
-   * read arbitrary encodings of the strings: if any of a string's characters are unnecessarily
-   * escaped in the source JSON, that string will not be selected. Similarly, if the string is
-   * unquoted or uses single quotes in the source JSON, it will not be selected. Client code that
-   * uses this class should fall back to another mechanism to accommodate this possibility.
+   * the encoded values of the strings so they can be read directly from the input source.
    */
-  static final class Options {
+  public static final class Options {
     final String[] strings;
     final okio.Options doubleQuoteSuffix;
 

moshi/src/main/java/com/squareup/moshi/ObjectJsonReader.java

@@ -158,7 +158,7 @@ final class ObjectJsonReader extends JsonReader {
     return result;
   }
 
-  @Override int selectName(Options options) throws IOException {
+  @Override public int selectName(Options options) throws IOException {
     Map.Entry<?, ?> peeked = require(Map.Entry.class, Token.NAME);
     String name = stringKey(peeked);
     for (int i = 0, length = options.strings.length; i < length; i++) {
@@ -178,7 +178,7 @@ final class ObjectJsonReader extends JsonReader {
     return peeked;
   }
 
-  @Override int selectString(Options options) throws IOException {
+  @Override public int selectString(Options options) throws IOException {
     String peeked = require(String.class, Token.STRING);
     for (int i = 0, length = options.strings.length; i < length; i++) {
       if (options.strings[i].equals(peeked)) {

moshi/src/test/java/com/squareup/moshi/BufferedSourceJsonReaderTest.java

@@ -1161,9 +1161,12 @@ public final class BufferedSourceJsonReaderTest {
     assertDocument("{\"name\":,", BEGIN_OBJECT, NAME, JsonEncodingException.class);
     assertDocument("{\"name\"=}", BEGIN_OBJECT, NAME, JsonEncodingException.class);
     assertDocument("{\"name\"=>}", BEGIN_OBJECT, NAME, JsonEncodingException.class);
-    assertDocument("{\"name\"=>\"string\":", BEGIN_OBJECT, NAME, STRING, JsonEncodingException.class);
-    assertDocument("{\"name\"=>\"string\"=", BEGIN_OBJECT, NAME, STRING, JsonEncodingException.class);
-    assertDocument("{\"name\"=>\"string\"=>", BEGIN_OBJECT, NAME, STRING, JsonEncodingException.class);
+    assertDocument("{\"name\"=>\"string\":", BEGIN_OBJECT, NAME, STRING,
+        JsonEncodingException.class);
+    assertDocument("{\"name\"=>\"string\"=", BEGIN_OBJECT, NAME, STRING,
+        JsonEncodingException.class);
+    assertDocument("{\"name\"=>\"string\"=>", BEGIN_OBJECT, NAME, STRING,
+        JsonEncodingException.class);
     assertDocument("{\"name\"=>\"string\",", BEGIN_OBJECT, NAME, STRING, EOFException.class);
     assertDocument("{\"name\"=>\"string\",\"name\"", BEGIN_OBJECT, NAME, STRING, NAME);
     assertDocument("[}", BEGIN_ARRAY, JsonEncodingException.class);
@@ -1224,41 +1227,6 @@ public final class BufferedSourceJsonReaderTest {
     assertThat(reader.nextString()).isEqualTo("string");
   }
 
-  /** Select doesn't match unquoted strings. */
-  @Test public void selectStringUnquoted() throws IOException {
-    JsonReader.Options abc = JsonReader.Options.of("a", "b", "c");
-
-    JsonReader reader = newReader("[a]");
-    reader.setLenient(true);
-    reader.beginArray();
-    assertEquals(-1, reader.selectString(abc));
-    assertEquals("a", reader.nextString());
-    reader.endArray();
-  }
-
-  /** Select doesn't match single quoted strings. */
-  @Test public void selectStringSingleQuoted() throws IOException {
-    JsonReader.Options abc = JsonReader.Options.of("a", "b", "c");
-
-    JsonReader reader = newReader("['a']");
-    reader.setLenient(true);
-    reader.beginArray();
-    assertEquals(-1, reader.selectString(abc));
-    assertEquals("a", reader.nextString());
-    reader.endArray();
-  }
-
-  /** Select doesn't match unnecessarily-escaped strings. */
-  @Test public void selectUnnecessaryEscaping() throws IOException {
-    JsonReader.Options abc = JsonReader.Options.of("a", "b", "c");
-
-    JsonReader reader = newReader("[\"\\u0061\"]");
-    reader.beginArray();
-    assertEquals(-1, reader.selectString(abc));
-    assertEquals("a", reader.nextString());
-    reader.endArray();
-  }
-
   private void assertDocument(String document, Object... expectations) throws IOException {
     JsonReader reader = newReader(document);
     reader.setLenient(true);

moshi/src/test/java/com/squareup/moshi/JsonReaderTest.java

@@ -28,6 +28,7 @@ import static com.squareup.moshi.JsonReader.Token.BEGIN_ARRAY;
 import static com.squareup.moshi.JsonReader.Token.BEGIN_OBJECT;
 import static com.squareup.moshi.JsonReader.Token.NAME;
 import static com.squareup.moshi.JsonReader.Token.STRING;
+import static com.squareup.moshi.TestUtil.newReader;
 import static com.squareup.moshi.TestUtil.repeat;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.Assert.assertEquals;
@@ -690,6 +691,78 @@ public final class JsonReaderTest {
     reader.endObject();
   }
 
+  /** Select does match necessarily escaping. The decoded value is used in the path. */
+  @Test public void selectNameNecessaryEscaping() throws IOException {
+    JsonReader.Options options = JsonReader.Options.of("\n", "\u0000", "\"");
+
+    JsonReader reader = newReader("{\"\\n\": 5,\"\\u0000\": 5, \"\\\"\": 5}");
+    reader.beginObject();
+    assertEquals(0, reader.selectName(options));
+    assertEquals(5, reader.nextInt());
+    assertEquals("$.\n", reader.getPath());
+    assertEquals(1, reader.selectName(options));
+    assertEquals(5, reader.nextInt());
+    assertEquals("$.\u0000", reader.getPath());
+    assertEquals(2, reader.selectName(options));
+    assertEquals(5, reader.nextInt());
+    assertEquals("$.\"", reader.getPath());
+    reader.endObject();
+  }
+
+  /** Select removes unnecessary escaping from the source JSON. */
+  @Test public void selectNameUnnecessaryEscaping() throws IOException {
+    JsonReader.Options options = JsonReader.Options.of("coffee", "tea");
+
+    JsonReader reader = newReader("{\"cof\\u0066ee\":5, \"\\u0074e\\u0061\":4, \"water\":3}");
+    reader.beginObject();
+    assertEquals(0, reader.selectName(options));
+    assertEquals(5, reader.nextInt());
+    assertEquals("$.coffee", reader.getPath());
+    assertEquals(1, reader.selectName(options));
+    assertEquals(4, reader.nextInt());
+    assertEquals("$.tea", reader.getPath());
+
+    // Ensure select name doesn't advance the stack in case there are no matches.
+    assertEquals(-1, reader.selectName(options));
+    assertEquals(JsonReader.Token.NAME, reader.peek());
+    assertEquals("$.tea", reader.getPath());
+
+    // Consume the last token.
+    assertEquals("water", reader.nextName());
+    assertEquals(3, reader.nextInt());
+    reader.endObject();
+  }
+
+  @Test public void selectNameUnquoted() throws Exception {
+    JsonReader.Options options = JsonReader.Options.of("a", "b");
+
+    JsonReader reader = newReader("{a:2}");
+    reader.setLenient(true);
+    reader.beginObject();
+
+    assertEquals(0, reader.selectName(options));
+    assertEquals("$.a", reader.getPath());
+    assertEquals(2, reader.nextInt());
+    assertEquals("$.a", reader.getPath());
+
+    reader.endObject();
+  }
+
+  @Test public void selectNameSingleQuoted() throws IOException {
+    JsonReader.Options abc = JsonReader.Options.of("a", "b");
+
+    JsonReader reader = newReader("{'a':5}");
+    reader.setLenient(true);
+    reader.beginObject();
+
+    assertEquals(0, reader.selectName(abc));
+    assertEquals("$.a", reader.getPath());
+    assertEquals(5, reader.nextInt());
+    assertEquals("$.a", reader.getPath());
+
+    reader.endObject();
+  }
+
   @Test public void selectString() throws IOException {
     JsonReader.Options abc = JsonReader.Options.of("a", "b", "c");
 
@@ -717,22 +790,64 @@ public final class JsonReaderTest {
     reader.endArray();
   }
 
-  /** Select does match necessarily escaping. The decoded value is used in the path. */
-  @Test public void selectNecessaryEscaping() throws IOException {
+  @Test public void selectStringNecessaryEscaping() throws Exception {
     JsonReader.Options options = JsonReader.Options.of("\n", "\u0000", "\"");
 
-    JsonReader reader = newReader("{\"\\n\": 5,\"\\u0000\": 5, \"\\\"\": 5}");
-    reader.beginObject();
-    assertEquals(0, reader.selectName(options));
-    assertEquals(5, reader.nextInt());
-    assertEquals("$.\n", reader.getPath());
-    assertEquals(1, reader.selectName(options));
-    assertEquals(5, reader.nextInt());
-    assertEquals("$.\u0000", reader.getPath());
-    assertEquals(2, reader.selectName(options));
-    assertEquals(5, reader.nextInt());
-    assertEquals("$.\"", reader.getPath());
-    reader.endObject();
+    JsonReader reader = newReader("[\"\\n\",\"\\u0000\", \"\\\"\"]");
+    reader.beginArray();
+    assertEquals(0, reader.selectString(options));
+    assertEquals(1, reader.selectString(options));
+    assertEquals(2, reader.selectString(options));
+    reader.endArray();
+  }
+
+  /** Select strips unnecessarily-escaped strings. */
+  @Test public void selectStringUnnecessaryEscaping() throws IOException {
+    JsonReader.Options abc = JsonReader.Options.of("a", "b", "c");
+
+    JsonReader reader = newReader("[\"\\u0061\", \"b\", \"\\u0063\"]");
+    reader.beginArray();
+    assertEquals(0, reader.selectString(abc));
+    assertEquals(1, reader.selectString(abc));
+    assertEquals(2, reader.selectString(abc));
+    reader.endArray();
+  }
+
+  @Test public void selectStringUnquoted() throws IOException {
+    JsonReader.Options abc = JsonReader.Options.of("a", "b", "c");
+
+    JsonReader reader = newReader("[a, \"b\", c]");
+    reader.setLenient(true);
+    reader.beginArray();
+    assertEquals(0, reader.selectString(abc));
+    assertEquals(1, reader.selectString(abc));
+    assertEquals(2, reader.selectString(abc));
+    reader.endArray();
+  }
+
+  @Test public void selectStringSingleQuoted() throws IOException {
+    JsonReader.Options abc = JsonReader.Options.of("a", "b", "c");
+
+    JsonReader reader = newReader("['a', \"b\", c]");
+    reader.setLenient(true);
+    reader.beginArray();
+    assertEquals(0, reader.selectString(abc));
+    assertEquals(1, reader.selectString(abc));
+    assertEquals(2, reader.selectString(abc));
+    reader.endArray();
+  }
+
+  @Test public void selectStringMaintainsReaderState() throws IOException {
+    JsonReader.Options abc = JsonReader.Options.of("a", "b", "c");
+
+    JsonReader reader = newReader("[\"\\u0061\", \"42\"]");
+    reader.beginArray();
+    assertEquals(0, reader.selectString(abc));
+    assertEquals(-1, reader.selectString(abc));
+    assertEquals(JsonReader.Token.STRING, reader.peek());
+    // Next long can retrieve a value from a buffered string.
+    assertEquals(42, reader.nextLong());
+    reader.endArray();
   }
 
   @Test public void stringToNumberCoersion() throws Exception {