first commit

.gitignore

@@ -0,0 +1,6 @@
+/target/
+.DS_Store
+.classpath
+#.project
+.settings
+.idea

README.md

@@ -0,0 +1,8 @@
+# Read and Write Document
+* **Objective** - To implement a `Document` object which uses a composite `File` and `FileWriter` to `read` and `write` to a 
+* **Purpose** -  To demonstrate use of exception handling
+
+
+
+## Instructions
+* Ensure each of the test classes passes with 100% pass rate.

pom.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>rocks.zipcode</groupId>
+    <artifactId>readandwrite</artifactId>
+    <version>1.0</version>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>8</source>
+                    <target>8</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+    <dependencies>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+
+</project>

readandwrite.iml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module org.jetbrains.idea.maven.project.MavenProjectsManager.isMavenModule="true" type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" LANGUAGE_LEVEL="JDK_1_8">
+    <output url="file://$MODULE_DIR$/target/classes" />
+    <output-test url="file://$MODULE_DIR$/target/test-classes" />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src/main/java" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/src/test/java" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/target" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="TEST" name="Maven: junit:junit:4.12" level="project" />
+    <orderEntry type="library" scope="TEST" name="Maven: org.hamcrest:hamcrest-core:1.3" level="project" />
+  </component>
+</module>

src/main/java/rocks/zipcode/AlphaCharDocument.java

@@ -0,0 +1,20 @@
+package rocks.zipcode;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class AlphaCharDocument extends Document {
+    public AlphaCharDocument(String fileName) throws IOException {
+        super(fileName);
+    }
+
+    @Override
+    public void write(String contentToBeWritten) {
+    }
+
+    private Boolean isAlpha(String s) {
+        return null;
+    }
+}

src/main/java/rocks/zipcode/Document.java

@@ -0,0 +1,64 @@
+package rocks.zipcode;
+
+import java.io.*;
+import java.nio.file.Files;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class Document implements DocumentInterface {
+
+    private final FileWriter fileWriter;
+    private final File file;
+
+    public Document(String fileName) throws IOException {
+        this(new File(fileName));
+    }
+
+    public Document(File file) throws IOException {
+        this.file = file;
+        this.fileWriter = new FileWriter(file);
+    }
+
+    @Override
+    public void write(String contentToBeWritten) {
+    }
+
+    @Override
+    public void write(Integer lineNumber, String valueToBeWritten) {
+    }
+
+    @Override
+    public String read(Integer lineNumber) {
+        return null;
+    }
+
+    @Override
+    public String read() {
+        return null;
+    }
+
+    @Override
+    public void replaceAll(String stringToReplace, String replacementString) {
+    }
+
+    @Override
+    public void overWrite(String content) {
+    }
+
+    public List<String> toList() {
+        return null;
+    }
+
+    @Override
+    public File getFile() {
+        return null;
+    }
+
+    @Override
+    public String toString() {
+        return null;
+    }
+}

src/main/java/rocks/zipcode/DocumentInterface.java

@@ -0,0 +1,28 @@
+package rocks.zipcode;
+
+import java.io.File;
+import java.util.List;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public interface DocumentInterface {
+    void write(String contentToBeWritten);
+
+    void write(Integer lineNumber, String valueToBeWritten);
+
+    String read(Integer lineNumber);
+
+    String read();
+
+    void replaceAll(String stringToReplace, String replacementString);
+
+    void overWrite(String content);
+
+    List<String> toList();
+
+    File getFile();
+
+    @Override
+    String toString();
+}

src/main/java/rocks/zipcode/NumericCharDocument.java

@@ -0,0 +1,20 @@
+package rocks.zipcode;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class NumericCharDocument extends Document {
+    public NumericCharDocument(String fileName) throws IOException {
+        super(fileName);
+    }
+
+    @Override
+    public void write(String contentToBeWritten) {
+    }
+
+    private Boolean isNumeric(String s) {
+        return null;
+    }
+}

src/main/java/rocks/zipcode/SpecialCharDocument.java

@@ -0,0 +1,20 @@
+package rocks.zipcode;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 18/11/2018.
+ */
+public class SpecialCharDocument extends Document {
+    public SpecialCharDocument(String fileName) throws IOException {
+        super(fileName);
+    }
+
+    @Override
+    public void write(String contentToBeWritten) {
+    }
+
+    private Boolean isSpecialCharacters(String s) {
+        return null;
+    }
+}

src/test/java/rocks/zipcode/alphadocument/AlphaDocumentWriteTest.java

@@ -0,0 +1,52 @@
+package rocks.zipcode.alphadocument;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcode.AlphaCharDocument;
+import rocks.zipcode.Document;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class AlphaDocumentWriteTest {
+
+    @Test(expected = IllegalArgumentException.class)
+    public void writeNumericValuesToFile() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeWritten = "123";
+        Document documentWriter = new AlphaCharDocument(fileName);
+
+        // when
+        documentWriter.write(contentToBeWritten);
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void writeSpecialCharacter() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeWritten = "()";
+        Document documentWriter = new AlphaCharDocument(fileName);
+
+        // when
+        documentWriter.write(contentToBeWritten);
+    }
+
+
+    @Test
+    public void writeAlphaValuesTest() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String expected = "The quick brown foxy";
+        Document documentWriter = new AlphaCharDocument(fileName);
+
+        // when
+        documentWriter.write(expected);
+        String actual = documentWriter.read();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+}

src/test/java/rocks/zipcode/document/DocumentOverwriteTest.java

@@ -0,0 +1,46 @@
+package rocks.zipcode.document;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcode.Document;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class DocumentOverwriteTest {
+    @Test
+    public void writeTest1() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeOverwritten = "The quick brown fox";
+        String expected = "The quick browner fox";
+        Document documentWriter = new Document(fileName);
+        documentWriter.write(contentToBeOverwritten);
+
+        // when
+        documentWriter.overWrite(expected);
+        String actual = documentWriter.read();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+
+    @Test
+    public void writeTest2() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeOverwritten = "The quick brown fox";
+        String expected = "The quick brownest fox";
+        Document documentWriter = new Document(fileName);
+        documentWriter.write(contentToBeOverwritten);
+
+        // when
+        documentWriter.overWrite(expected);
+        String actual = documentWriter.read();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+}

src/test/java/rocks/zipcode/document/DocumentReadLineTest.java

@@ -0,0 +1,46 @@
+package rocks.zipcode.document;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcode.Document;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class DocumentReadLineTest {
+    @Test
+    public void testReadFirstLine() throws IOException {
+        // given
+        String expected = "The";
+        String fileName = "file.txt";
+        Document documentWriter = new Document(fileName);
+        String contentToBeWritten = "The\nquick\nbrown\nfox";
+        documentWriter.write(contentToBeWritten);
+
+        // when
+        String actual = documentWriter.read(0);
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+
+
+    @Test
+    public void testReadSecondLine() throws IOException {
+        // given
+        String expected = "quick";
+        String fileName = "file.txt";
+        Document documentWriter = new Document(fileName);
+        String contentToBeWritten = "The\nquick\nbrown\nfox";
+        documentWriter.write(contentToBeWritten);
+
+        // when
+        String actual = documentWriter.read(1);
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+}
+

src/test/java/rocks/zipcode/document/DocumentReadTest.java

@@ -0,0 +1,43 @@
+package rocks.zipcode.document;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcode.Document;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class DocumentReadTest {
+    @Test
+    public void testRead1() throws IOException {
+        // given
+        String fileName = "file.txt";
+        Document documentWriter = new Document(fileName);
+        String expected = "The\nquick\nbrown\nfox";
+        documentWriter.write(expected);
+
+        // when
+        String actual = documentWriter.read();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+
+    @Test
+    public void testRead2() throws IOException {
+        // given
+        String fileName = "file.txt";
+        Document documentWriter = new Document(fileName);
+        String expected = "The\nquicker\nbrown\nfox";
+        documentWriter.write(expected);
+
+        // when
+        String actual = documentWriter.read();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+
+}

src/test/java/rocks/zipcode/document/DocumentReplaceAllTest.java

@@ -0,0 +1,50 @@
+package rocks.zipcode.document;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcode.Document;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class DocumentReplaceAllTest {
+    @Test
+    public void testReplace_e_withUnderscore() throws IOException {
+        // given
+        String fileName = "file.txt";
+        Document documentWriter = new Document(fileName);
+        String contentToBeWritten = "Lorem ipsum dolor sit amet,\nconsectetur adipiscing elit,\nsed do eiusmod tempor incididunt\nut labore et dolore\nmagna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris\nnisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate\nvelit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat\nnon proident, sunt in culpa qui officia deserunt mollit anim id est laborum";
+        String valueToReplace = "e";
+        String replacementValue = "_";
+        String expected = contentToBeWritten.replaceAll(valueToReplace, replacementValue);
+        documentWriter.write(contentToBeWritten);
+
+        // when
+        documentWriter.replaceAll(valueToReplace, replacementValue);
+
+        // then
+        String actual = documentWriter.read();
+        Assert.assertEquals(expected, actual);
+    }
+
+    @Test
+    public void testReplace_newLine_withEmptyString() throws IOException {
+        // given
+        String fileName = "file.txt";
+        Document documentWriter = new Document(fileName);
+        String contentToBeWritten = "Lorem ipsum dolor sit amet,\nconsectetur adipiscing elit,\nsed do eiusmod tempor incididunt\nut labore et dolore\nmagna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris\nnisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate\nvelit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat\nnon proident, sunt in culpa qui officia deserunt mollit anim id est laborum";
+        String valueToReplace = "\n";
+        String replacementValue = "";
+        String expected = contentToBeWritten.replaceAll(valueToReplace, replacementValue);
+        documentWriter.write(contentToBeWritten);
+
+        // when
+        documentWriter.replaceAll(valueToReplace, replacementValue);
+
+        // then
+        String actual = documentWriter.read();
+        Assert.assertEquals(expected, actual);
+    }
+}

src/test/java/rocks/zipcode/document/DocumentToStringTest.java

@@ -0,0 +1,52 @@
+package rocks.zipcode.document;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcode.Document;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class DocumentToStringTest {
+    @Test
+    public void toStringTest1() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeWritten = "The quick brown fox";
+        Document documentWriter = new Document(fileName);
+        String expected = new StringBuilder(fileName)
+                .append("{")
+                .append(contentToBeWritten)
+                .append("}")
+                .toString();
+
+        // when
+        documentWriter.write(contentToBeWritten);
+        String actual = documentWriter.toString();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+
+    @Test
+    public void toStringTest2() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeWritten = "The quicker browner fox";
+        Document documentWriter = new Document(fileName);
+        String expected = new StringBuilder(fileName)
+                .append("{")
+                .append(contentToBeWritten)
+                .append("}")
+                .toString();
+
+        // when
+        documentWriter.write(contentToBeWritten);
+        String actual = documentWriter.toString();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+}

src/test/java/rocks/zipcode/document/DocumentWriteTest.java

@@ -0,0 +1,58 @@
+package rocks.zipcode.document;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcode.Document;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class DocumentWriteTest {
+
+    @Test
+    public void writeAlphaValuesTest() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String expected = "The quick brown fox";
+        Document documentWriter = new Document(fileName);
+
+        // when
+        documentWriter.write(expected);
+        String actual = documentWriter.read();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+
+    @Test
+    public void writeSpecialCharactersTest() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String expected = "()";
+        Document documentWriter = new Document(fileName);
+
+        // when
+        documentWriter.write(expected);
+        String actual = documentWriter.read();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+
+    @Test
+    public void writeNumericValuesTest() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String expected = "123";
+        Document documentWriter = new Document(fileName);
+
+        // when
+        documentWriter.write(expected);
+        String actual = documentWriter.read();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+}

src/test/java/rocks/zipcode/document/DocumentWriteToLineTest.java

@@ -0,0 +1,48 @@
+package rocks.zipcode.document;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcode.Document;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class DocumentWriteToLineTest {
+    @Test
+    public void writeToLineTest1() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeWritten = "The\nquick\nbrown\nfox";
+        String replacement = "quicker";
+        String expected = contentToBeWritten.replaceAll("quick", replacement);
+
+        Document documentWriter = new Document(fileName);
+        documentWriter.write(contentToBeWritten);
+
+        // when
+        documentWriter.write(1, replacement);
+
+        // then
+        Assert.assertEquals(expected, documentWriter.read());
+    }
+
+    @Test
+    public void writeToLineTest2() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeWritten = "The\nquick\nbrown\nfox";
+        String replacement = "quickest";
+        String expected = contentToBeWritten.replaceAll("The", replacement);
+
+        Document documentWriter = new Document(fileName);
+        documentWriter.write(contentToBeWritten);
+
+        // when
+        documentWriter.write(0, replacement);
+
+        // then
+        Assert.assertEquals(expected, documentWriter.read());
+    }
+}

src/test/java/rocks/zipcode/numericdocument/NumericDocumentWriteTest.java

@@ -0,0 +1,52 @@
+package rocks.zipcode.numericdocument;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcode.Document;
+import rocks.zipcode.NumericCharDocument;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 16/11/2018.
+ */
+public class NumericDocumentWriteTest {
+
+    @Test
+    public void writeNumericValuesToFile() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeWritten = "123";
+        Document documentWriter = new NumericCharDocument(fileName);
+
+        // when
+        documentWriter.write(contentToBeWritten);
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void writeSpecialCharacter() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeWritten = "()";
+        Document documentWriter = new NumericCharDocument(fileName);
+
+        // when
+        documentWriter.write(contentToBeWritten);
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void writeAlphaValuesTest() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String expected = "The quick brown foxy";
+        Document documentWriter = new NumericCharDocument(fileName);
+
+        // when
+        documentWriter.write(expected);
+        String actual = documentWriter.read();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+
+}

src/test/java/rocks/zipcode/specialdocument/SpecialCharDocumentTest.java

@@ -0,0 +1,64 @@
+package rocks.zipcode.specialdocument;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcode.Document;
+import rocks.zipcode.SpecialCharDocument;
+
+import java.io.IOException;
+
+/**
+ * @author leon on 18/11/2018.
+ */
+public class SpecialCharDocumentTest {
+
+    @Test(expected = IllegalArgumentException.class)
+    public void writeNumericValuesToFile() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeWritten = "123";
+        Document documentWriter = new SpecialCharDocument(fileName);
+
+        // when
+        documentWriter.write(contentToBeWritten);
+    }
+
+    @Test
+    public void writeSpecialCharacter1() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeWritten = "()";
+        Document documentWriter = new SpecialCharDocument(fileName);
+
+        // when
+        documentWriter.write(contentToBeWritten);
+    }
+
+
+    @Test
+    public void writeSpecialCharacter2() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String contentToBeWritten = "()_*";
+        Document documentWriter = new SpecialCharDocument(fileName);
+
+        // when
+        documentWriter.write(contentToBeWritten);
+    }
+
+
+    @Test(expected = IllegalArgumentException.class)
+    public void writeAlphaValuesTest() throws IOException {
+        // given
+        String fileName = "file.txt";
+        String expected = "The quick brown foxy";
+        Document documentWriter = new SpecialCharDocument(fileName);
+
+        // when
+        documentWriter.write(expected);
+        String actual = documentWriter.read();
+
+        // then
+        Assert.assertEquals(expected, actual);
+    }
+}