Merge pull request #10 from bobocode-projects/GP-28_Migrate_FileReader_into_main

GP-28 Migrate File Reader to main

Author: tboychuk

3-0-java-core/pom.xml

@@ -3,6 +3,14 @@
          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>
+    <dependencies>
+        <dependency>
+            <groupId>com.bobocode</groupId>
+            <artifactId>java-fundamentals-util</artifactId>
+            <version>1.0-SNAPSHOT</version>
+            <scope>compile</scope>
+        </dependency>
+    </dependencies>
 
     <parent>
         <groupId>com.bobocode</groupId>

3-0-java-core/src/main/java/com/bobocode/file_reader/FileReaders.java

@@ -0,0 +1,19 @@
+package com.bobocode.file_reader;
+
+import com.bobocode.util.ExerciseNotCompletedException;
+
+/**
+ * {@link FileReaders} provides an API that allow to read whole file into a {@link String} by file name.
+ */
+public class FileReaders {
+
+    /**
+     * Returns a {@link String} that contains whole text from the file specified by name.
+     *
+     * @param fileName a name of a text file
+     * @return string that holds whole file content
+     */
+    public static String readWholeFile(String fileName) {
+        throw new ExerciseNotCompletedException(); //todo
+    }
+}

3-0-java-core/src/test/java/com/bobocode/file_reader/FileReadersTest.java

@@ -0,0 +1,36 @@
+package com.bobocode.file_reader;
+
+import com.bobocode.file_reader.FileReaders;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+
+public class FileReadersTest {
+
+    @Test
+    void testReadWholeFileOnEmptyFile() {
+        String fileContent = FileReaders.readWholeFile("empty.txt");
+
+        assertEquals("", fileContent);
+
+    }
+
+    @Test
+    void testReadWholeFileOnFileWithEmptyLines() {
+        String fileContent = FileReaders.readWholeFile("lines.txt");
+
+        assertEquals("Hey!\n" +
+                "\n" +
+                "What's up?\n" +
+                "\n" +
+                "Hi!", fileContent);
+    }
+
+    @Test
+    void testReadWholeFile() {
+        String fileContent = FileReaders.readWholeFile("simple.txt");
+
+        assertEquals("Hello!\n" + "It's a test file.", fileContent);
+    }
+}

3-0-java-core/src/test/resources/empty.txt

@@ -0,0 +1,5 @@
+Hey!
+
+What's up?
+
+Hi!

3-0-java-core/src/test/resources/lines.txt

@@ -0,0 +1,2 @@
+Hello!
+It's a test file.