zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-06-27 14:54:51 +02:00
Code Issues Projects Releases Packages Wiki Activity

Remove patharg classes

Browse source 
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=121238717
This commit is contained in:
jart 2016-05-01 19:18:46 -07:00 • committed by Justine Tunney
parent 6082146d55
commit b672643194
2 changed files with 0 additions and 144 deletions
Download patch file Download diff file Expand all files Collapse all files

69
java/google/registry/util/PathargMatcher.java
View file

@ -1,69 +0,0 @@
// Copyright 2016 The Domain Registry Authors. All Rights Reserved.
//
// 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 google.registry.util;
import java.util.regex.Pattern;
/** Helper for extracting pathargs from the servlet request pathinfo with colon notation. */
public final class PathargMatcher {
private static final Pattern PATHARG_MATCHER = Pattern.compile(":(?<name>[^/]+)");
/**
* Returns regex pattern for parsing an HTTP path using Java 7 named groups.
*
* <p>The named groups should use colon notation. For example:<pre> {@code
*
* Pattern pattern = PathargMatcher.forPath("/task/:tld/:registrar");
* Matcher matcher = pattern.matcher("/task/soy/TheRegistrar");
* assertTrue(matcher.matches());
* assertEquals("soy", matcher.group("soy"));
* assertEquals("TheRegistrar", matcher.group("registrar"));}</pre>
*
* <h3>Best Practices</h3>
*
* <p>Pathargs is a good choice for parameters that:
*
* <ol>
* <li>Are mandatory
* <li>Never contain slashes
* <li>Part of the resource name
* <li>About 1-10 characters in length
* <li>Matches the pattern {@code [-._a-zA-Z0-9]+} (not enforced)
* </ol>
*
* <p>Otherwise you may want to consider using normal parameters.
*
* <h3>Trailing Slash</h3>
*
* <p>This class does not allow you to make the trailing slash in the path optional. You must
* either forbid it (recommended) or require it (not recommended). If you wish to make the
* trailing slash optional, you should configure your frontend webserver to 30x redirect to the
* canonical path.
*
* <p>There's no consensus in the web development community about whether or not the canonical
* path should include or omit the trailing slash. The Django community prefers to keep the
* trailing slash; whereas the Ruby on Rails community has traditionally omitted it.
*
* @see java.util.regex.Matcher
*/
public static Pattern forPath(String pathSpec) {
return Pattern.compile(convertPathSpecToRegex(pathSpec));
}
private static String convertPathSpecToRegex(String pathSpec) {
return PATHARG_MATCHER.matcher(pathSpec).replaceAll("(?<${name}>[^/]+)");
}
}

75
javatests/google/registry/util/PathargMatcherTest.java
View file

@ -1,75 +0,0 @@
// Copyright 2016 The Domain Registry Authors. All Rights Reserved.
//
// 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 google.registry.util;
import static com.google.common.truth.Truth.assertThat;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/** Unit tests for {@link PathargMatcher}. */
@RunWith(JUnit4.class)
public final class PathargMatcherTest {
@Test
public void testForPath_extractsPathargs() throws Exception {
Pattern pattern = PathargMatcher.forPath("/task/:tld/:registrar");
Matcher matcher = pattern.matcher("/task/soy/TheRegistrar");
assertThat(matcher.matches()).isTrue();
assertThat(matcher.group("tld")).isEqualTo("soy");
assertThat(matcher.group("registrar")).isEqualTo("TheRegistrar");
}
@Test
public void testForPath_missingPatharg_failure() throws Exception {
Pattern pattern = PathargMatcher.forPath("/task/:tld/:registrar");
assertThat(pattern.matcher("/task/soy").matches()).isFalse();
assertThat(pattern.matcher("/task/soy/").matches()).isFalse();
}
@Test
public void testForPath_extraSlash_failure() throws Exception {
Pattern pattern = PathargMatcher.forPath("/task/:tld/:registrar");
assertThat(pattern.matcher("/task/soy/TheRegistrar/").matches()).isFalse();
}
@Test
public void testForPath_extraPatharg_failure() throws Exception {
Pattern pattern = PathargMatcher.forPath("/task/:tld/:registrar");
assertThat(pattern.matcher("/task/soy/TheRegistrar/blob").matches()).isFalse();
}
@Test
public void testForPath_emptyPatharg_failure() throws Exception {
Pattern pattern = PathargMatcher.forPath("/task/:tld/:registrar");
assertThat(pattern.matcher("/task//TheRegistrar").matches()).isFalse();
}
@Test
public void testForPath_badFront_failure() throws Exception {
Pattern pattern = PathargMatcher.forPath("/task/:tld/:registrar");
assertThat(pattern.matcher("/dog/soy/TheRegistrar").matches()).isFalse();
}
@Test
public void testForPath_badCasing_failure() throws Exception {
Pattern pattern = PathargMatcher.forPath("/task/:tld/:registrar");
assertThat(pattern.matcher("/TASK/soy/TheRegistrar").matches()).isFalse();
}
}