Merge pull request #166 from cboehme/line-splitter-improvements

Improvements to LineSplitter

Author: cboehme

src/main/java/org/culturegraph/mf/stream/pipe/LineSplitter.java

@@ -19,6 +19,9 @@
 
 import org.culturegraph.mf.framework.DefaultObjectPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;
+import org.culturegraph.mf.framework.annotations.Description;
+import org.culturegraph.mf.framework.annotations.In;
+import org.culturegraph.mf.framework.annotations.Out;
 
 
 /**
@@ -27,7 +30,10 @@
  * @author Christoph Böhme
  *
  */
-public final class LineSplitter 
+@Description("Splits a string at new lines and sends each line to the receiver.")
+@In(String.class)
+@Out(String.class)
+public final class LineSplitter
 		extends DefaultObjectPipe<String, ObjectReceiver<String>> {
 
 	private static final char NEWLINE = '\n';
@@ -37,7 +43,7 @@ public final class LineSplitter
 	@Override
 	public void process(final String lines) {
 		assert !isClosed();
-		for (String record : LINE_PATTERN.split(lines)) {
+		for (final String record : LINE_PATTERN.split(lines)) {
 			getReceiver().process(record);
 		}
 	}

src/main/resources/flux-commands.properties

@@ -96,6 +96,7 @@ draw-uniform-sample org.culturegraph.mf.stream.pipe.UniformSampler
 catch-object-exception org.culturegraph.mf.stream.pipe.ObjectExceptionCatcher
 
 normalize-utf8 org.culturegraph.mf.stream.pipe.Utf8Normalizer
+split-lines org.culturegraph.mf.stream.pipe.LineSplitter
 
 morph	org.culturegraph.mf.morph.Metamorph
 filter	org.culturegraph.mf.stream.pipe.Filter

src/test/java/org/culturegraph/mf/stream/pipe/LineSplitterTest.java

@@ -0,0 +1,101 @@
+/*
+ *  Copyright 2013 Christoph Böhme
+ *
+ *  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.culturegraph.mf.stream.pipe;
+
+import static org.mockito.Mockito.inOrder;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoMoreInteractions;
+
+import org.culturegraph.mf.framework.ObjectReceiver;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.InOrder;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+/**
+ * Tests for class {@link LineSplitter}.
+ * 
+ * @author Christoph Böhme
+ *
+ */
+public final class LineSplitterTest {
+
+	private static final String PART1 = "One";
+	private static final String PART2 = "Two";
+	private static final String PART3 = "Three";
+	
+	private LineSplitter lineSplitter;
+	
+	@Mock
+	private ObjectReceiver<String> receiver;
+	
+	@Before
+	public void setup() {
+		MockitoAnnotations.initMocks(this);
+		lineSplitter = new LineSplitter();
+		lineSplitter.setReceiver(receiver);
+	}
+	
+	@Test
+	public void shouldSplitInputStringAtNewLines() {
+		lineSplitter.process(PART1 + "\n" + PART2 + "\n" + PART3);
+		
+		final InOrder ordered = inOrder(receiver);
+		ordered.verify(receiver).process(PART1);
+		ordered.verify(receiver).process(PART2);
+		ordered.verify(receiver).process(PART3);
+		ordered.verifyNoMoreInteractions();
+	}
+
+	@Test
+	public void shouldPassInputWithoutNewLinesUnchanged() {
+		lineSplitter.process(PART1);
+		
+		verify(receiver).process(PART1);
+		verifyNoMoreInteractions(receiver);
+	}
+
+	@Test
+	public void shouldOutputEmptyStringsForSequencesOfNewLines() {
+		lineSplitter.process(PART1 + "\n\n" + PART2);
+		
+		final InOrder ordered = inOrder(receiver);
+		ordered.verify(receiver).process(PART1);
+		ordered.verify(receiver).process("");
+		ordered.verify(receiver).process(PART2);
+		ordered.verifyNoMoreInteractions();
+	}
+	
+	@Test
+	public void shouldOutputEmptyStringForNewLinesAtStartOfTheInput() {
+		lineSplitter.process("\n" + PART1);
+		
+		final InOrder ordered = inOrder(receiver);
+		ordered.verify(receiver).process("");
+		ordered.verify(receiver).process(PART1);
+		ordered.verifyNoMoreInteractions();
+	}
+	
+	@Test
+	public void shouldNotOutputEmptyStringForNewLinesAtEndOfTheInput() {
+		lineSplitter.process(PART1 + "\n");
+		
+		verify(receiver).process(PART1);
+		verifyNoMoreInteractions(receiver);
+	}
+	
+}