Ignore commas at the end of links, too
[Sone.git] / src / test / java / net / pterodactylus / sone / text / SoneTextParserTest.java
index f0b0e1b..1161b8d 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Sone - SoneTextParserTest.java - Copyright © 2011 David Roden
+ * Sone - SoneTextParserTest.java - Copyright © 2011–2016 David Roden
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 
 package net.pterodactylus.sone.text;
 
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.isIn;
+import static org.hamcrest.Matchers.notNullValue;
+
 import java.io.IOException;
-import java.io.StringReader;
+import java.util.Collection;
+
+import net.pterodactylus.sone.data.Sone;
+import net.pterodactylus.sone.data.impl.IdOnlySone;
+import net.pterodactylus.sone.database.SoneProvider;
 
-import junit.framework.TestCase;
+import com.google.common.base.Function;
+import com.google.common.base.Optional;
+import org.junit.Test;
 
 /**
  * JUnit test case for {@link SoneTextParser}.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class SoneTextParserTest extends TestCase {
+public class SoneTextParserTest {
 
-       /**
-        * Tests basic plain-text operation of the parser.
-        *
-        * @throws IOException
-        *             if an I/O error occurs
-        */
+       @SuppressWarnings("static-method")
+       @Test
        public void testPlainText() throws IOException {
                SoneTextParser soneTextParser = new SoneTextParser(null, null);
                Iterable<Part> parts;
-               StringBuilder text = new StringBuilder();
 
                /* check basic operation. */
-               text.setLength(0);
-               parts = soneTextParser.parse(null, new StringReader("Test."));
-               assertNotNull("Parts", parts);
-               for (Part part : parts) {
-                       assertTrue("Part is PlainTextPart", part instanceof PlainTextPart);
-                       text.append(((PlainTextPart) part).getText());
-               }
-               assertEquals("Part Text", "Test.", text.toString());
+               parts = soneTextParser.parse("Test.", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Test.", is(convertText(parts, PlainTextPart.class)));
 
                /* check empty lines at start and end. */
-               text.setLength(0);
-               parts = soneTextParser.parse(null, new StringReader("\nTest.\n\n"));
-               assertNotNull("Parts", parts);
-               for (Part part : parts) {
-                       assertTrue("Part is PlainTextPart", part instanceof PlainTextPart);
-                       text.append(((PlainTextPart) part).getText());
-               }
-               assertEquals("Part Text", "Test.", text.toString());
+               parts = soneTextParser.parse("\nTest.\n\n", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Test.", is(convertText(parts, PlainTextPart.class)));
 
                /* check duplicate empty lines in the text. */
-               text.setLength(0);
-               parts = soneTextParser.parse(null, new StringReader("\nTest.\n\n\nTest."));
-               assertNotNull("Parts", parts);
+               parts = soneTextParser.parse("\nTest.\n\n\nTest.", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Test.\n\nTest.", is(convertText(parts, PlainTextPart.class)));
+       }
+
+       @SuppressWarnings("static-method")
+       @Test
+       public void testKSKLinks() throws IOException {
+               SoneTextParser soneTextParser = new SoneTextParser(null, null);
+               Iterable<Part> parts;
+
+               /* check basic links. */
+               parts = soneTextParser.parse("KSK@gpl.txt", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "[KSK@gpl.txt|gpl.txt|gpl.txt]", is(convertText(parts, FreenetLinkPart.class)));
+
+               /* check embedded links. */
+               parts = soneTextParser.parse("Link is KSK@gpl.txt\u200b.", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Link is [KSK@gpl.txt|gpl.txt|gpl.txt]\u200b.", is(convertText(parts, PlainTextPart.class, FreenetLinkPart.class)));
+
+               /* check embedded links and line breaks. */
+               parts = soneTextParser.parse("Link is KSK@gpl.txt\nKSK@test.dat\n", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Link is [KSK@gpl.txt|gpl.txt|gpl.txt]\n[KSK@test.dat|test.dat|test.dat]", is(convertText(parts, PlainTextPart.class, FreenetLinkPart.class)));
+       }
+
+       @SuppressWarnings({ "synthetic-access", "static-method" })
+       @Test
+       public void testEmptyLinesAndSoneLinks() throws IOException {
+               SoneTextParser soneTextParser = new SoneTextParser(new TestSoneProvider(), null);
+               Iterable<Part> parts;
+
+               /* check basic links. */
+               parts = soneTextParser.parse("Some text.\n\nLink to sone://DAxKQzS48mtaQc7sUVHIgx3fnWZPQBz0EueBreUVWrU and stuff.", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Some text.\n\nLink to [Sone|DAxKQzS48mtaQc7sUVHIgx3fnWZPQBz0EueBreUVWrU] and stuff.", is(convertText(parts, PlainTextPart.class, SonePart.class)));
+       }
+
+       @SuppressWarnings({ "synthetic-access", "static-method" })
+       @Test
+       public void testEmpyHttpLinks() throws IOException {
+               SoneTextParser soneTextParser = new SoneTextParser(new TestSoneProvider(), null);
+               Iterable<Part> parts;
+
+               /* check empty http links. */
+               parts = soneTextParser.parse("Some text. Empty link: http:// – nice!", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Some text. Empty link: http:// – nice!", is(convertText(parts, PlainTextPart.class)));
+       }
+
+       @Test
+       public void httpLinkWithoutParensEndsAtNextClosingParen() {
+               SoneTextParser soneTextParser = new SoneTextParser(null, null);
+               Iterable<Part> parts = soneTextParser.parse("Some text (and a link: http://example.sone/abc) – nice!", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Some text (and a link: [http://example.sone/abc|example.sone/abc|example.sone/abc]) – nice!", is(convertText(parts, PlainTextPart.class, LinkPart.class)));
+       }
+
+       @Test
+       public void httpLinkWithOpenedAndClosedParensEndsAtNextClosingParen() {
+               SoneTextParser soneTextParser = new SoneTextParser(null, null);
+               Iterable<Part> parts = soneTextParser.parse("Some text (and a link: http://example.sone/abc_(def)) – nice!", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Some text (and a link: [http://example.sone/abc_(def)|example.sone/abc_(def)|example.sone/abc_(def)]) – nice!", is(convertText(parts, PlainTextPart.class, LinkPart.class)));
+       }
+
+       @Test
+       public void punctuationIsIgnoredAtEndOfLinkBeforeWhitespace() {
+               SoneTextParser soneTextParser = new SoneTextParser(null, null);
+               Iterable<Part> parts = soneTextParser.parse("Some text and a link: http://example.sone/abc. Nice!", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Some text and a link: [http://example.sone/abc|example.sone/abc|example.sone/abc]. Nice!", is(convertText(parts, PlainTextPart.class, LinkPart.class)));
+       }
+
+       @Test
+       public void multiplePunctuationCharactersAreIgnoredAtEndOfLinkBeforeWhitespace() {
+               SoneTextParser soneTextParser = new SoneTextParser(null, null);
+               Iterable<Part> parts = soneTextParser.parse("Some text and a link: http://example.sone/abc... Nice!", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Some text and a link: [http://example.sone/abc|example.sone/abc|example.sone/abc]... Nice!", is(convertText(parts, PlainTextPart.class, LinkPart.class)));
+       }
+
+       @Test
+       public void commasAreIgnoredAtEndOfLinkBeforeWhitespace() {
+               SoneTextParser soneTextParser = new SoneTextParser(null, null);
+               Iterable<Part> parts = soneTextParser.parse("Some text and a link: http://example.sone/abc, nice!", null);
+               assertThat("Parts", parts, notNullValue());
+               assertThat("Part Text", "Some text and a link: [http://example.sone/abc|example.sone/abc|example.sone/abc], nice!", is(convertText(parts, PlainTextPart.class, LinkPart.class)));
+       }
+
+       /**
+        * Converts all given {@link Part}s into a string, validating that the
+        * part’s classes match only the expected classes.
+        *
+        * @param parts
+        *            The parts to convert to text
+        * @param validClasses
+        *            The valid classes; if no classes are given, all classes are
+        *            valid
+        * @return The converted text
+        */
+       private static String convertText(Iterable<Part> parts, Class<?>... validClasses) {
+               StringBuilder text = new StringBuilder();
                for (Part part : parts) {
-                       assertTrue("Part is PlainTextPart", part instanceof PlainTextPart);
-                       text.append(((PlainTextPart) part).getText());
+                       assertThat("Part", part, notNullValue());
+                       if (validClasses.length != 0) {
+                               assertThat("Part’s class", part.getClass(), isIn(validClasses));
+                       }
+                       if (part instanceof PlainTextPart) {
+                               text.append(((PlainTextPart) part).getText());
+                       } else if (part instanceof FreenetLinkPart) {
+                               FreenetLinkPart freenetLinkPart = (FreenetLinkPart) part;
+                               text.append('[').append(freenetLinkPart.getLink()).append('|').append(freenetLinkPart.isTrusted() ? "trusted|" : "").append(freenetLinkPart.getTitle()).append('|').append(freenetLinkPart.getText()).append(']');
+                       } else if (part instanceof LinkPart) {
+                               LinkPart linkPart = (LinkPart) part;
+                               text.append('[').append(linkPart.getLink()).append('|').append(linkPart.getTitle()).append('|').append(linkPart.getText()).append(']');
+                       } else if (part instanceof SonePart) {
+                               SonePart sonePart = (SonePart) part;
+                               text.append("[Sone|").append(sonePart.getSone().getId()).append(']');
+                       }
                }
-               assertEquals("Part Text", "Test.\n\nTest.", text.toString());
+               return text.toString();
+       }
+
+       /**
+        * Mock Sone provider.
+        *
+        * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+        */
+       private static class TestSoneProvider implements SoneProvider {
+
+               @Override
+               public Function<String, Optional<Sone>> soneLoader() {
+                       return new Function<String, Optional<Sone>>() {
+                               @Override
+                               public Optional<Sone> apply(String soneId) {
+                                       return getSone(soneId);
+                               }
+                       };
+               }
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public Optional<Sone> getSone(final String soneId) {
+                       return Optional.<Sone>of(new IdOnlySone(soneId));
+               }
+
+               /**
+                * {@inheritDocs}
+                */
+               @Override
+               public Collection<Sone> getSones() {
+                       return null;
+               }
+
+               /**
+                * {@inheritDocs}
+                */
+               @Override
+               public Collection<Sone> getLocalSones() {
+                       return null;
+               }
+
+               /**
+                * {@inheritDocs}
+                */
+               @Override
+               public Collection<Sone> getRemoteSones() {
+                       return null;
+               }
+
        }
 
 }