Merge branch 'exercise/completed' into GP-26_Add_compleated_solution_to_exercise/completed

tboychuk · web-flow · commit 0dbe6dc80838 · 2021-01-06T11:47:59.000+02:00
diff --git a/2-0-data-structures-and-algorithms/src/main/java/com/bobocode/linked_list/LinkedList.java b/2-0-data-structures-and-algorithms/src/main/java/com/bobocode/linked_list/LinkedList.java
@@ -3,6 +3,7 @@
 import java.util.NoSuchElementException;
 import java.util.Objects;
 import java.util.stream.Stream;
+import com.bobocode.util.ExerciseNotCompletedException;
 
 /**
  * {@link LinkedList} is a list implementation that is based on singly linked generic nodes. A node is implemented as
diff --git a/3-0-java-core/pom.xml b/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>
diff --git a/3-0-java-core/src/main/java/com/bobocode/file_reader/FileReaders.java b/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
+    }
+}
diff --git a/3-0-java-core/src/test/java/com/bobocode/file_reader/FileReadersTest.java b/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);
+    }
+}
diff --git a/3-0-java-core/src/test/resources/empty.txt b/3-0-java-core/src/test/resources/empty.txt
diff --git a/3-0-java-core/src/test/resources/lines.txt b/3-0-java-core/src/test/resources/lines.txt
@@ -0,0 +1,5 @@
+Hey!
+
+What's up?
+
+Hi!
diff --git a/3-0-java-core/src/test/resources/simple.txt b/3-0-java-core/src/test/resources/simple.txt
@@ -0,0 +1,2 @@
+Hello!
+It's a test file.
diff --git a/4-0-object-oriented-programming/README.md b/4-0-object-oriented-programming/README.md
@@ -0,0 +1,14 @@
+# <img src="https://raw.githubusercontent.com/bobocode-projects/resources/master/image/logo_transparent_background.png" height=50/>Java OOP exercises
+The list of exercises dedicated to training your OOP skills in Java
+
+### No pain, No gain :heavy_exclamation_mark:
+
+> Skill is only developed by hours and hours and hours of beating on your craft
+
+Working on real problems, you're focused on finding a solution. Learning new things, you're trying to understand how it works.
+It is important to have a different type of activities, which purpose is improving your skill 
+
+***An exercise** is a predefined task that you continuously implement to improve a certain skill* :muscle:
+##
+* [Flights search](https://github.com/bobocode-projects/java-oop-exercises/tree/master/flight-search-simple)
+
diff --git a/4-0-object-oriented-programming/pom.xml b/4-0-object-oriented-programming/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>
diff --git a/4-0-object-oriented-programming/src/main/java/com/bobocode/flight_search/README.MD b/4-0-object-oriented-programming/src/main/java/com/bobocode/flight_search/README.MD
@@ -0,0 +1,21 @@
+# <img src="https://raw.githubusercontent.com/bobocode-projects/resources/master/image/logo_transparent_background.png" height=50/>Flight search exercise :muscle:
+Improve your OOP skills
+### Task
+`FlighService` and package `service` represent a component of the system that holds a business logic. `FlightDao` 
+and package `data` represent a component of the system that implements data access layer. Your job is to implement 
+the *todo* section of those classes **following OOP design principles.**  
+
+To verify your implementation, run `FlightSeriviceTest.java`
+ 
+### Pre-conditions :heavy_exclamation_mark:
+You're supposed to be familiar with Java and OOP
+
+### How to start :question:
+* Just clone the repository and start implementing the **todo** section, verify your changes by running tests
+* If you don't have enough knowladge about this domain, check out the [links below](#related-materials-information_source)
+* Don't worry if you got stuck, checkout the **exercise/completed** branch and see the final implementation
+ 
+### Related materials :information_source:
+ * [SOLID](https://en.wikipedia.org/wiki/SOLID)
+ 
+
diff --git a/4-0-object-oriented-programming/src/main/java/com/bobocode/flight_search/data/FlightDao.java b/4-0-object-oriented-programming/src/main/java/com/bobocode/flight_search/data/FlightDao.java
@@ -0,0 +1,37 @@
+package com.bobocode.flight_search.data;
+
+import com.bobocode.util.ExerciseNotCompletedException;
+
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * {@link FlightDao} represents a Data Access Object (DAO) for flights. The implementation is simplified, so it just
+ * uses {@link HashSet} to store flight numbers.
+ * <p>
+ * todo: 1. Implement a method {@link FlightDao#register(String)} that store new flight number into the set
+ * todo: 2. Implement a method {@link FlightDao#findAll()} that returns a set of all flight numbers
+ */
+public class FlightDao {
+    private Set<String> flights = new HashSet<>();
+
+    /**
+     * Stores a new flight number
+     *
+     * @param flightNumber a flight number to store
+     * @return {@code true} if a flight number was stored, {@code false} otherwise
+     */
+    public boolean register(String flightNumber) {
+        throw new ExerciseNotCompletedException();// todo: implement this method
+    }
+
+    /**
+     * Returns all stored flight numbers
+     *
+     * @return a set of flight numbers
+     */
+    public Set<String> findAll() {
+        throw new ExerciseNotCompletedException();// todo: implement this method
+    }
+
+}
diff --git a/4-0-object-oriented-programming/src/main/java/com/bobocode/flight_search/factory/FlightServiceFactory.java b/4-0-object-oriented-programming/src/main/java/com/bobocode/flight_search/factory/FlightServiceFactory.java
@@ -0,0 +1,21 @@
+package com.bobocode.flight_search.factory;
+
+import com.bobocode.flight_search.service.FlightService;
+import com.bobocode.util.ExerciseNotCompletedException;
+
+/**
+ * {@link FlightServiceFactory} is used to create an instance of {@link FlightService}
+ * <p>
+ * todo: 1. Implement method {@link FlightServiceFactory#creteFlightService()}
+ */
+public class FlightServiceFactory {
+
+    /**
+     * Create a new instance of {@link FlightService}
+     *
+     * @return FlightService
+     */
+    public FlightService creteFlightService() {
+        throw new ExerciseNotCompletedException();
+    }
+}
diff --git a/4-0-object-oriented-programming/src/main/java/com/bobocode/flight_search/service/FlightService.java b/4-0-object-oriented-programming/src/main/java/com/bobocode/flight_search/service/FlightService.java
@@ -0,0 +1,35 @@
+package com.bobocode.flight_search.service;
+
+import com.bobocode.flight_search.data.FlightDao;
+import com.bobocode.util.ExerciseNotCompletedException;
+
+import java.util.List;
+
+/**
+ * {@link FlightService} provides an API that allows to manage flight numbers
+ * <p>
+ * todo: 1. Using {@link FlightDao} implement method {@link FlightService#registerFlight(String)}
+ * todo: 2. Using {@link FlightDao} implement method {@link FlightService#searchFlights(String)}
+ */
+public class FlightService {
+
+    /**
+     * Adds a new flight number
+     *
+     * @param flightNumber a flight number to add
+     * @return {@code true} if a flight number was added, {@code false} otherwise
+     */
+    public boolean registerFlight(String flightNumber) {
+        throw new ExerciseNotCompletedException();
+    }
+
+    /**
+     * Returns all flight numbers that contains a provided key.
+     *
+     * @param query a search query
+     * @return a list of found flight numbers
+     */
+    public List<String> searchFlights(String query) {
+        throw new ExerciseNotCompletedException();
+    }
+}
diff --git a/4-0-object-oriented-programming/src/test/java/com/bobocode/flight_search/FlightServiceTest.java b/4-0-object-oriented-programming/src/test/java/com/bobocode/flight_search/FlightServiceTest.java
@@ -0,0 +1,65 @@
+package com.bobocode.flight_search;
+
+import com.bobocode.flight_search.factory.FlightServiceFactory;
+import com.bobocode.flight_search.service.FlightService;
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public class FlightServiceTest {
+
+    private FlightService flightService = new FlightServiceFactory().creteFlightService();
+
+    @Test
+    public void testRegisterFlight() {
+        boolean registered = flightService.registerFlight("PR344");
+
+        assertTrue(registered);
+    }
+
+    @Test
+    public void testRegisterSameFlightTwice() {
+        flightService.registerFlight("RB122");
+
+        boolean registeredSecondTime = flightService.registerFlight("RB122");
+
+        assertFalse(registeredSecondTime);
+    }
+
+    @Test
+    public void testSearchExistingFlightByFullNumber() {
+        flightService.registerFlight("OL234");
+        flightService.registerFlight("KM23234");
+        flightService.registerFlight("LTE114");
+        flightService.registerFlight("BRT14");
+
+        List<String> foundFlights = flightService.searchFlights("LTE114");
+
+        assertEquals(1, foundFlights.size());
+        assertEquals("LTE114", foundFlights.get(0));
+    }
+
+    @Test
+    public void testSearchNonExistingFlight() {
+        List<String> foundFlights = flightService.searchFlights("XXX");
+
+        assertNotNull(foundFlights);
+    }
+
+    @Test
+    public void testSearchFlights() {
+        flightService.registerFlight("OR1214");
+        flightService.registerFlight("BTR14");
+        flightService.registerFlight("BMK198");
+        flightService.registerFlight("RLR198");
+
+        List<String> foundFlights = flightService.searchFlights("R1");
+
+        assertTrue(foundFlights.contains("OR1214"));
+        assertTrue(foundFlights.contains("BTR14"));
+        assertTrue(foundFlights.contains("RLR198"));
+        assertEquals(3, foundFlights.size());
+    }
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +Hey!
++
 +What's up?
++
 +Hi!