/*
* ModeShape (http://www.modeshape.org)
*
* 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.modeshape.jcr.value.basic;
import static org.hamcrest.core.Is.is;
import static org.hamcrest.core.IsNot.not;
import static org.junit.Assert.assertThat;
import static org.hamcrest.CoreMatchers.containsString;
import org.junit.Before;
import org.junit.Test;
import org.modeshape.common.text.Jsr283Encoder;
import org.modeshape.common.text.TextEncoder;
import org.modeshape.jcr.ModeShapeLexicon;
import org.modeshape.jcr.value.Name;
import org.modeshape.jcr.value.NamespaceRegistry;
import org.modeshape.jcr.value.Path;
/**
* @author Randall Hauch
* @author John Verhaeg
*/
public class BasicNameTest {
private NamespaceRegistry namespaceRegistry;
private Name name;
private String validNamespaceUri;
private String validLocalName;
private TextEncoder encoder;
private TextEncoder delimiterEncoder;
private String validNamespacePrefix;
@Before
public void beforeEach() {
this.validNamespacePrefix = ModeShapeLexicon.Namespace.PREFIX;
this.validNamespaceUri = ModeShapeLexicon.Namespace.URI;
this.validLocalName = "localPart";
this.name = new BasicName(validNamespaceUri, validLocalName);
this.encoder = Path.URL_ENCODER;
this.namespaceRegistry = new SimpleNamespaceRegistry();
this.namespaceRegistry.register(validNamespacePrefix, validNamespaceUri);
this.delimiterEncoder = new TextEncoder() {
@Override
public String encode( String text ) {
if (":".equals(text)) return "\\:";
if ("{".equals(text)) return "\\{";
if ("}".equals(text)) return "\\}";
return text;
}
};
}
@Test
public void shouldAllowNullNamespaceUriInConstructorAndConvertToEmptyString() {
name = new BasicName(null, validLocalName);
assertThat(name.getNamespaceUri(), is(""));
}
@Test
public void shouldAllowEmptyNamespaceUriInConstructor() {
name = new BasicName("", validLocalName);
assertThat(name.getNamespaceUri(), is(""));
}
@Test
public void shouldTrimNamespaceUriInConstructor() {
name = new BasicName(" " + validNamespaceUri + "\t \t", validLocalName);
assertThat(name.getNamespaceUri(), is(validNamespaceUri.trim()));
name = new BasicName(" \t \t", validLocalName);
assertThat(name.getNamespaceUri(), is(""));
}
@Test( expected = IllegalArgumentException.class )
public void shouldNotAllowNullLocalNameInConstructor() {
new BasicName(validNamespaceUri, null);
}
@Test
public void shouldAllowEmptyLocalNameInConstructor() {
new BasicName(validNamespaceUri, "");
}
@Test
public void shouldAcceptLocalNameWithColon() {
validLocalName = "some:name:with:colons";
name = new BasicName(validNamespaceUri, validLocalName);
assertThat(name.getLocalName(), is(validLocalName));
}
@Test
public void shouldReturnSameHashCodeForNamesWithSameNamespaceUriAndLocalPart() {
Name other = new BasicName(name.getNamespaceUri(), name.getLocalName());
assertThat(name.hashCode(), is(other.hashCode()));
}
@Test
public void shouldConsiderNamesEqualIfTheyHaveTheSameNamespaceUriAndLocalPart() {
Name other = new BasicName(name.getNamespaceUri(), name.getLocalName());
assertThat(name.equals(other), is(true));
assertThat(name.compareTo(other), is(0));
}
@Test
public void shouldConsiderSameInstanceEqualToItself() {
assertThat(name.equals(name), is(true));
assertThat(name.compareTo(name), is(0));
}
@Test( expected = NullPointerException.class )
public void shouldNotSupportNullInCompareTo() {
name.compareTo(null);
}
@Test
public void shouldSupportNullInEquals() {
assertThat(name.equals(null), is(false));
}
@Test
public void shouldUseFullNamespaceUriInResultFromGetStringWithoutNamespaceRegistry() {
String prefix = namespaceRegistry.getPrefixForNamespaceUri(validNamespaceUri, false);
String encodedLocalName = Path.DEFAULT_ENCODER.encode(validLocalName);
String result = name.getString();
assertThat(result, containsString(prefix));
assertThat(result, containsString(encodedLocalName));
assertThat(result, is(prefix + ":" + encodedLocalName));
}
@Test
public void shouldEncodeColonInLocalNameAndNamespaceUriInResultFromGetStringWithoutNamespaceRegistry() {
validLocalName = "some:name:with:colons";
name = new BasicName(validNamespaceUri, validLocalName);
String encodedNamespaceUri = encoder.encode(validNamespaceUri);
String encodedLocalName = encoder.encode(validLocalName);
String result = name.getString(encoder);
assertThat(result, is("mode:" + encodedLocalName));
assertThat(encodedNamespaceUri, is("http%3a%2f%2fwww.modeshape.org%2f1.0"));
assertThat(encodedLocalName, is("some%3aname%3awith%3acolons"));
}
@Test
public void shouldUseNamespacePrefixInResultFromGetStringWithNamespaceRegistry() {
String result = name.getString(namespaceRegistry, encoder);
assertThat(result, is("mode:" + validLocalName));
validLocalName = "some:name:with:colons";
name = new BasicName(validNamespaceUri, validLocalName);
result = name.getString(namespaceRegistry, encoder);
assertThat(result, is("mode:some%3aname%3awith%3acolons"));
}
@Test
public void shouldNotIncludeNamespacePrefixOrColonInResultFromGetStringWithNamespaceRegistry() {
validNamespaceUri = namespaceRegistry.getDefaultNamespaceUri();
name = new BasicName(validNamespaceUri, validLocalName);
String result = name.getString(namespaceRegistry, encoder);
assertThat(result, is(validLocalName));
result = name.getString(namespaceRegistry); // default encoder
assertThat(result, is(validLocalName));
validLocalName = "some:name:with:colons";
name = new BasicName(validNamespaceUri, validLocalName);
result = name.getString(namespaceRegistry, encoder);
assertThat(result, is(encoder.encode(validLocalName)));
}
@Test
public void shouldUseDelimiterEncoderToEncodeDelimiterBetweenPrefixAndLocalPart() {
encoder = new Jsr283Encoder();
name = new BasicName(ModeShapeLexicon.Namespace.URI, "some:name:with:colons");
assertThat(name.getString(namespaceRegistry, encoder, delimiterEncoder),
is("mode\\:some\uf03aname\uf03awith\uf03acolons"));
assertThat(name.getString(null, encoder, delimiterEncoder), is("mode:some\uf03aname\uf03awith\uf03acolons"));
}
@Test
public void shouldEncodeWhenNoNamespace() {
String nameForEncoding = "test name";
String encodedNameForEncoding = encoder.encode(nameForEncoding);
// Make sure that we're not testing a trivial encoding
assertThat(encodedNameForEncoding, not(nameForEncoding));
name = new BasicName(null, nameForEncoding);
String result = name.getString(namespaceRegistry, encoder);
assertThat(result, is(encodedNameForEncoding));
result = name.getString(encoder);
assertThat(result, is(encodedNameForEncoding));
}
}