Merge branch 'release'

.github/workflows/main.yml

@@ -1,34 +1,32 @@
-# Name of the github workflow
+# GitHub Actions workflow for building and running a Java application
+# Triggers on push to the repository
 name: A workflow for my Hello World App
-# When the repo is pushed it will run this workflow
-on: push
+on:
+  push:  # Runs the workflow when changes are pushed
 
 jobs:
-  build:
-  # Name of the action
+  build:  # Job for building application
     name: Hello world action
-  # Specifies what vm environment it's going to run
     runs-on: ubuntu-20.04
-  # List of steps to complete the workflow
+
     steps:
-    # Checkout the code from the repo
-      - name: Checkout
+      - name: Checkout  # Check out the code
         uses: actions/checkout@v2
-    # Set up the jdk for the vm and specify what version
+        with:
+          submodules: recursive  # Includes submodules
+
+      # Install JDK 11
       - name: Set up JDK 11
         uses: actions/setup-java@v2
         with:
           java-version: '11'
           distribution: 'adopt'
-    # Compile the project using maven running the command clean package
-      - name: Compile with Maven
-        run: mvn clean package
-    # Builds the docker image from the dockerfile
-      - name: Build Docker Image
-        run: docker build -t semimage .
-    # Runs the docker image to create a container
-      - name: Run image
-        run: docker run --name semcontainer -d semimage
-    # View the logs of the running container
-      - name: view logs
-        run: docker logs semcontainer
+
+      - name: Unit Tests
+        run: mvn -Dtest=com.napier.sem.AppTest test
+
+      - name: Build with Maven  # Build the application
+        run: mvn package -DskipTests  # Compiles and packages the application
+
+      - name: Run docker compose  # Run Docker Compose
+        run: docker compose up --abort-on-container-exit  # Starts services and aborts on container exit

CODE_OF_CONDUCT.md

@@ -0,0 +1,25 @@
+## Code of Conduct
+### Purpose
+This Code of Conduct outlines the expectations for members.
+
+### Expectations
+
+1. **Attend Code Reviews**
+    - Team members are required to attend the code reviews.
+
+2. **Attend Group Meetings**
+    - Regular attendance at group meetings/discussions.
+
+3. **Allocate Work Fairly**
+    - Work should be distributed equally among all team members.
+
+4. **Make Use The Kanban Board**
+    - Tasks and progress are to be tracked on the Kanban Board.
+    - All members are responsible for keeping their task cards up to date, moving them through stages as work progresses.
+
+5. **Deadlines**
+    - Members are expected to meet deadlines.
+    - Complete assigned tasks on time. If any difficulties arise, notify the team as soon as possible to find solutions.
+
+## Conclusion
+By following this Code of Conduct, we can create a respectful and effective working environment for everyone involved :)

DOCS/UseCase/Diagrams/Capital System.puml

@@ -1,17 +1,35 @@
-@startuml
+    @startuml
+    left to right direction
 
-actor mem as "Org. Member"
+    actor mem as "Data Analyst"
 
-rectangle Database
+    rectangle Database
 
-rectangle "Capital System" {
-    usecase UC1 as "Get capitals by population"
+    rectangle "Capital System" {
 
-    usecase UCa as "Print capitals"
+        usecase UC1 as "Get all capitals in the world"
+        usecase UC2 as "Get top N capitals"
+        usecase UC3 as "Get all capitals in a country"
+        usecase UC4 as "Print report"
 
-    mem - UC1
-    UC1 ..> UCa : include
-    UC1 - Database
-}
+        usecase UCa as "No user input provided"
+        usecase UCb as "No database connection"
 
-@enduml
+        mem -- UC1
+        mem -- UC2
+        mem -- UC3
+
+        UC1 --- Database
+        UC2 --- Database
+        UC3 --- Database
+
+        UC1 ..> UC4 : include
+        UC2 ..> UC4 : include
+        UC3 ..> UC4 : include
+
+        UC2 <. UCa : extends
+        UC1 <. UCb : extends
+
+    }
+
+    @enduml

DOCS/UseCase/Diagrams/City System.puml

@@ -1,17 +1,37 @@
 @startuml
+left to right direction
 
-actor mem as "Org. Member"
+actor mem as "Researcher"
 
 rectangle Database
 
 rectangle "City System" {
-    usecase UC1 as "Get cities by population"
 
-    usecase UCa as "Print cities"
+        usecase UC1 as "Get all cities in the world"
+        usecase UC2 as "Get top N cities in a country"
+        usecase UC3 as "Get all cities in a continent"
+        usecase UC4 as "Print report"
+
+        usecase UCa as "User input invalid"
+        usecase UCb as "No database connection"
+
+        mem -- UC1
+        mem -- UC2
+        mem -- UC3
+
+        UC1 --- Database
+        UC2 --- Database
+        UC3 --- Database
+
+        UC1 ..> UC4 : include
+        UC2 ..> UC4 : include
+        UC3 ..> UC4 : include
+
+        UC2 <.. UCa : extends
+        UC1 <. UCb : extends
+        UCb .> UC2 : extends
+        UCb .> UC3 : extends
 
-    mem - UC1
-    UC1 ..> UCa : include
-    UC1 - Database
 }
 
 @enduml

DOCS/UseCase/Diagrams/Country System.puml

@@ -1,17 +1,36 @@
 @startuml
-
+left to right direction
 actor mem as "Org. Member"
 
 rectangle Database
 
 rectangle "Country System" {
-    usecase UC1 as "Get countries by population"
 
-    usecase UCa as "Print countries"
+        usecase UC1 as "Get all countries in the world"
+        usecase UC2 as "Get top N counties in a continent"
+        usecase UC3 as "Get all cities in a region"
+        usecase UC4 as "Print report"
+
+        usecase UCa as "User input invalid"
+        usecase UCb as "No database connection"
+
+        mem -- UC1
+        mem -- UC2
+        mem -- UC3
+
+        UC1 --- Database
+        UC2 --- Database
+        UC3 --- Database
+
+        UC1 ..> UC4 : include
+        UC2 ..> UC4 : include
+        UC3 ..> UC4 : include
+
+        UC2 <.. UCa : extends
+        UC1 <. UCb : extends
+        UCb .> UC2 : extends
+        UCb .> UC3 : extends
 
-    mem - UC1
-    UC1 ..> UCa : include
-    UC1 - Database
 }
 
 @enduml

DOCS/UseCase/Diagrams/Language System.puml

@@ -1,17 +1,27 @@
 @startuml
+left to right direction
 
-actor mem as "Org. Member"
+actor mem as "Linguist"
 
 rectangle Database
 
 rectangle "Language System" {
-    usecase UC1 as "Get languages by global speakers"
+    usecase UC1 as "Get languages data ordered by
+                    global speakers"
+    usecase UC2 as "Get languages data for a region"
 
     usecase UCa as "Print languages"
+    usecase UCb as "No database connection"
 
-    mem - UC1
+    mem -- UC1
+    mem -- UC2
+    UC1 --- Database
     UC1 ..> UCa : include
-    UC1 - Database
+    UCb <. UC1 : extends
+
+    UC2 --- Database
+    UC2 .> UCa : include
+    UC2 .> UCb : extends
 }
 
 @enduml

DOCS/UseCase/Diagrams/Population System.puml

@@ -1,18 +1,34 @@
 @startuml
+left to right direction
 
-actor mem as "Org. Member"
+actor mem as "Sociologist"
 
 rectangle Database
 
 rectangle "Population System" {
-    usecase UC1 as "Get populations
-    by country"
+    usecase UC1 as "Get population data for each continent"
+    usecase UC2 as "Get population data for each country"
+    usecase UC3 as "Get population data for each region"
 
-    usecase UCa as "Print populations"
+    usecase UCa as "Print languages"
+    usecase UCb as "No database connection"
+
+    mem -- UC1
+    mem -- UC2
+    mem -- UC3
+
+    UC1 --- Database
+    UC2 --- Database
+    UC3 --- Database
 
-    mem - UC1
     UC1 ..> UCa : include
-    UC1 - Database
+    UC2 ..> UCa : include
+    UC3 ..> UCa : include
+
+
+    UCb .> UC2 : extends
+    UCb .> UC1 : extends
+    UCb .> UC3 : extends
 }
 
 @enduml