java: extract method Select.escapeQuotes to a separate class Quotes

Signed-off-by: Andreas Tolfsen <ato@mozilla.com>

Author: asolntsev

java/client/src/org/openqa/selenium/support/ui/Quotes.java

@@ -0,0 +1,66 @@
+/*
+Copyright 2015 Software Freedom Conservancy
+Copyright 2007-2009 Selenium committers
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+ */
+
+package org.openqa.selenium.support.ui;
+
+public class Quotes {
+
+  /**
+   * Convert strings with both quotes and ticks into a valid xpath component
+   * 
+   * For example,
+   * 
+   * <p>
+   *   {@code foo} will be converted to {@code "foo"},
+   * </p>
+   * <p>
+   *   {@code f"oo} will be converted to {@code 'f"oo'},
+   * </p>
+   * <p>
+   *   {@code foo'"bar} will be converted to {@code concat("foo'", '"', "bar")}
+   * </p>
+   * 
+   * @param toEscape a text to escape quotes in, e.g. {@code "f'oo"}
+   * @return the same text with escaped quoted, e.g. {@code "\"f'oo\""}
+   */
+  public static String escape(String toEscape) {
+    if (toEscape.contains("\"") && toEscape.contains("'")) {
+      boolean quoteIsLast = false;
+      if (toEscape.lastIndexOf("\"") == toEscape.length() - 1) {
+        quoteIsLast = true;
+      }
+      String[] substringsWithoutQuotes = toEscape.split("\"");
+
+      StringBuilder quoted = new StringBuilder("concat(");
+      for (int i = 0; i < substringsWithoutQuotes.length; i++) {
+        quoted.append("\"").append(substringsWithoutQuotes[i]).append("\"");
+        quoted
+            .append(((i == substringsWithoutQuotes.length - 1) ? (quoteIsLast ? ", '\"')" : ")")
+                                                           : ", '\"', "));
+      }
+      return quoted.toString();
+    }
+
+    // Escape string with just a quote into being single quoted: f"oo -> 'f"oo'
+    if (toEscape.contains("\"")) {
+      return String.format("'%s'", toEscape);
+    }
+
+    // Otherwise return the quoted string
+    return String.format("\"%s\"", toEscape);
+  }
+}

java/client/src/org/openqa/selenium/support/ui/Select.java

@@ -1,4 +1,5 @@
 /*
+Copyright 2015 Software Freedom Conservancy
 Copyright 2007-2009 Selenium committers
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -111,7 +112,7 @@ public WebElement getFirstSelectedOption() {
   public void selectByVisibleText(String text) {
     // try to find the option via XPATH ...
     List<WebElement> options =
-        element.findElements(By.xpath(".//option[normalize-space(.) = " + escapeQuotes(text) + "]"));
+        element.findElements(By.xpath(".//option[normalize-space(.) = " + Quotes.escape(text) + "]"));
 
     boolean matched = false;
     for (WebElement option : options) {
@@ -132,7 +133,7 @@ public void selectByVisibleText(String text) {
         // get candidates via XPATH ...
         candidates =
             element.findElements(By.xpath(".//option[contains(., " +
-                escapeQuotes(subStringWithoutSpace) + ")]"));
+                Quotes.escape(subStringWithoutSpace) + ")]"));
       }
       for (WebElement option : candidates) {
         if (text.equals(option.getText())) {
@@ -163,7 +164,7 @@ private String getLongestSubstringWithoutSpace(String s) {
   }
 
   /**
-   * Select the option at the given index. This is done by examing the "index" attribute of an
+   * Select the option at the given index. This is done by examining the "index" attribute of an
    * element, and not merely by counting.
    * 
    * @param index The option at this index will be selected
@@ -197,10 +198,8 @@ public void selectByIndex(int index) {
    * @throws NoSuchElementException If no matching option elements are found
    */
   public void selectByValue(String value) {
-    StringBuilder builder = new StringBuilder(".//option[@value = ");
-    builder.append(escapeQuotes(value));
-    builder.append("]");
-    List<WebElement> options = element.findElements(By.xpath(builder.toString()));
+    List<WebElement> options = element.findElements(By.xpath(
+        ".//option[@value = " + Quotes.escape(value) + "]"));
 
     boolean matched = false;
     for (WebElement option : options) {
@@ -244,10 +243,9 @@ public void deselectAll() {
    * @throws NoSuchElementException If no matching option elements are found
    */
   public void deselectByValue(String value) {
-    StringBuilder builder = new StringBuilder(".//option[@value = ");
-    builder.append(escapeQuotes(value));
-    builder.append("]");
-    List<WebElement> options = element.findElements(By.xpath(builder.toString()));
+    List<WebElement> options = element.findElements(By.xpath(
+        ".//option[@value = " + Quotes.escape(value) + "]"));
+
     for (WebElement option : options) {
       if (option.isSelected()) {
         option.click();
@@ -256,7 +254,7 @@ public void deselectByValue(String value) {
   }
 
   /**
-   * Deselect the option at the given index. This is done by examing the "index" attribute of an
+   * Deselect the option at the given index. This is done by examining the "index" attribute of an
    * element, and not merely by counting.
    * 
    * @param index The option at this index will be deselected
@@ -282,44 +280,16 @@ public void deselectByIndex(int index) {
    * @throws NoSuchElementException If no matching option elements are found
    */
   public void deselectByVisibleText(String text) {
-    StringBuilder builder = new StringBuilder(".//option[normalize-space(.) = ");
-    builder.append(escapeQuotes(text));
-    builder.append("]");
-    List<WebElement> options = element.findElements(By.xpath(builder.toString()));
+    List<WebElement> options = element.findElements(By.xpath(
+        ".//option[normalize-space(.) = " + Quotes.escape(text) + "]"));
+
     for (WebElement option : options) {
       if (option.isSelected()) {
         option.click();
       }
     }
   }
 
-  protected String escapeQuotes(String toEscape) {
-    // Convert strings with both quotes and ticks into: foo'"bar -> concat("foo'", '"', "bar")
-    if (toEscape.indexOf("\"") > -1 && toEscape.indexOf("'") > -1) {
-      boolean quoteIsLast = false;
-      if (toEscape.lastIndexOf("\"") == toEscape.length() - 1) {
-        quoteIsLast = true;
-      }
-      String[] substrings = toEscape.split("\"");
-
-      StringBuilder quoted = new StringBuilder("concat(");
-      for (int i = 0; i < substrings.length; i++) {
-        quoted.append("\"").append(substrings[i]).append("\"");
-        quoted
-            .append(((i == substrings.length - 1) ? (quoteIsLast ? ", '\"')" : ")") : ", '\"', "));
-      }
-      return quoted.toString();
-    }
-
-    // Escape string with just a quote into being single quoted: f"oo -> 'f"oo'
-    if (toEscape.indexOf("\"") > -1) {
-      return String.format("'%s'", toEscape);
-    }
-
-    // Otherwise return the quoted string
-    return String.format("\"%s\"", toEscape);
-  }
-
   private void setSelected(WebElement option) {
     if (!option.isSelected()) {
       option.click();

java/client/src/org/openqa/selenium/support/ui/build.desc

@@ -32,6 +32,7 @@ java_library(name = "components",
 java_library(name = "elements",
   srcs = [
     "Select.java",
+    "Quotes.java",
     "UnexpectedTagNameException.java",
   ],
   deps = [

java/client/test/org/openqa/selenium/support/SmallTests.java

@@ -26,6 +26,7 @@
 import org.openqa.selenium.support.ui.ExpectedConditionsTest;
 import org.openqa.selenium.support.ui.FluentWaitTest;
 import org.openqa.selenium.support.ui.LoadableComponentTest;
+import org.openqa.selenium.support.ui.QuotesTest;
 import org.openqa.selenium.support.ui.SelectTest;
 import org.openqa.selenium.support.ui.SlowLoadableComponentTest;
 import org.openqa.selenium.support.ui.WebDriverWaitTest;
@@ -49,6 +50,7 @@
     LocatingElementListHandlerTest.class,
     PageFactoryTest.class,
     SelectTest.class,
+    QuotesTest.class,
     SlowLoadableComponentTest.class,
     ThreadGuardTest.class,
     WebDriverWaitTest.class

java/client/test/org/openqa/selenium/support/ui/QuotesTest.java

@@ -0,0 +1,57 @@
+/*
+Copyright 2015 Software Freedom Conservancy
+Copyright 2007-2009 Selenium committers
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package org.openqa.selenium.support.ui;
+
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+public class QuotesTest {
+  @Test
+  public void shouldConvertAnUnquotedStringIntoOneWithQuotes() {
+    assertEquals("\"foo\"", Quotes.escape("foo"));
+  }
+
+  @Test
+  public void shouldConvertAStringWithATickIntoOneWithQuotes() {
+    assertEquals("\"f'oo\"", Quotes.escape("f'oo"));
+  }
+
+  @Test
+  public void shouldConvertAStringWithAQuotIntoOneWithTicks() {
+    assertEquals("'f\"oo'", Quotes.escape("f\"oo"));
+  }
+
+  @Test
+  public void shouldProvideConcatenatedStringsWhenStringToEscapeContainsTicksAndQuotes() {
+    assertEquals("concat(\"f\", '\"', \"o'o\")", Quotes.escape("f\"o'o"));
+  }
+
+  /**
+   * Tests that Quotes.escape returns concatenated strings when the given
+   * string contains a tick and and ends with a quote.
+   */
+  @Test
+  public void shouldProvideConcatenatedStringsWhenStringEndsWithQuote() {
+    assertEquals("concat(\"Bar \", '\"', \"Rock'n'Roll\", '\"')", Quotes.escape(
+        "Bar \"Rock'n'Roll\""));
+  }
+}

java/client/test/org/openqa/selenium/support/ui/SelectElementTest.java

@@ -1,6 +1,6 @@
 /*
+Copyright 2015 Software Freedom Conservancy
 Copyright 2012 Selenium committers
-Copyright 2012 Software Freedom Conservancy
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -18,6 +18,11 @@
 
 package org.openqa.selenium.support.ui;
 
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.openqa.selenium.testing.Ignore.Driver.MARIONETTE;
+
 import org.junit.Before;
 import org.junit.Test;
 import org.openqa.selenium.By;
@@ -27,10 +32,6 @@
 
 import java.util.List;
 
-import static org.junit.Assert.*;
-
-import static org.openqa.selenium.testing.Ignore.Driver.MARIONETTE;
-
 public class SelectElementTest extends JUnit4TestBase {
 
   @Before
@@ -257,53 +258,4 @@ public void shouldAllowOptionsToBeDeselectedByReturnedValue() {
 
     assertEquals(1,returnedOptions.size());
   }
-
-  @Test
-  public void shouldConvertAnUnquotedStringIntoOneWithQuotes() {
-    WebElement selectElement = driver.findElement(By.name("multi"));
-    Select select = new Select(selectElement);
-    String result = select.escapeQuotes("foo");
-
-    assertEquals("\"foo\"", result);
-  }
-
-  @Test
-  public void shouldConvertAStringWithATickIntoOneWithQuotes() {
-    WebElement selectElement = driver.findElement(By.name("multi"));
-    Select select = new Select(selectElement);
-    String result = select.escapeQuotes("f'oo");
-
-    assertEquals("\"f'oo\"", result);
-  }
-
-  @Test
-  public void shouldConvertAStringWithAQuotIntoOneWithTicks() {
-    WebElement selectElement = driver.findElement(By.name("multi"));
-    Select select = new Select(selectElement);
-    String result = select.escapeQuotes("f\"oo");
-
-    assertEquals("'f\"oo'", result);
-  }
-
-  @Test
-  public void shouldProvideConcatenatedStringsWhenStringToEscapeContainsTicksAndQuotes() {
-    WebElement selectElement = driver.findElement(By.name("multi"));
-    Select select = new Select(selectElement);
-    String result = select.escapeQuotes("f\"o'o");
-
-    assertEquals("concat(\"f\", '\"', \"o'o\")", result);
-  }
-
-  /**
-   * Tests that escapeQuotes returns concatenated strings when the given
-   * string contains a tick and and ends with a quote.
-   */
-  @Test
-  public void shouldProvideConcatenatedStringsWhenStringEndsWithQuote() {
-    WebElement selectElement = driver.findElement(By.name("multi"));
-    Select select = new Select(selectElement);
-    String result = select.escapeQuotes("Bar \"Rock'n'Roll\"");
-
-    assertEquals("concat(\"Bar \", '\"', \"Rock'n'Roll\", '\"')", result);
-  }
 }