Merge pull request 'cleanup' (#4) from cleanup into main

Reviewed-on: #4

.gitignore

@@ -86,3 +86,5 @@ dkms.conf
 *.out
 *.app
 
+# Custom
+bin/*

Dockerfile

@@ -2,6 +2,10 @@ FROM gcc:latest
 
 WORKDIR /app
 
-COPY bin/Bowling /app/
+COPY rolls.txt /app/
+COPY include/* /app/include/
+COPY src/* /app/src/
 
-CMD ["./Bowling"]
+RUN g++ src/*.cpp -o Bowling
+
+CMD ["./Bowling", "rolls.txt"]

README.md

@@ -1,3 +1,8 @@
 # Bowling
 
-If you want to try out the project, please use git clone with the HTTPS link to the repo, and not the SSH link, as only the owner can pull and push via SSH.
+To run the project, simply follow these steps: 
+1. `git clone https://git.rbwr.dk/owner/Bowling.git`
+2. `docker build -t bowling .`
+3. `docker run --rm bowling`
+
+To change bowling score, simply edit the `rolls.txt` file, and build the docker image again.

include/FileHelper.h

@@ -0,0 +1,13 @@
+#ifndef FILEHELPER_H
+#define FILEHELPER_H
+
+class FileHelper {
+    public:
+        FileHelper() = default;
+        
+        ~FileHelper() = default;
+        
+        static bool fileExists(char *path);
+};
+
+#endif

include/FileReader.h

@@ -0,0 +1,18 @@
+#ifndef FILEREADER_H
+#define FILEREADER_H
+
+#include <string>
+#include <vector>
+
+using namespace std;
+
+class FileReader {
+    public:
+        FileReader() = default;
+        
+        ~FileReader() = default;
+        
+        static string getFile(char *path);
+};
+
+#endif

include/NumberHelper.h

@@ -0,0 +1,19 @@
+#ifndef NUMBERHELPER_H
+#define NUMBERHELPER_H
+
+#include <string>
+#include <vector>
+
+using namespace std;
+
+class NumberHelper {
+    public:
+        NumberHelper() = default;
+        
+        ~NumberHelper() = default;
+        
+        static vector<int> getRolls(string csv);
+};
+
+
+#endif

include/PrintFrames.h

@@ -0,0 +1,18 @@
+#ifndef PRINTFRAMES_H
+#define PRINTFRAMES_H
+
+#include <vector>
+
+using namespace std;
+
+class PrintFrames {
+    public:
+        PrintFrames() = default;
+        
+        ~PrintFrames() = default;
+        
+        static void printHeader(vector<int> rolls);
+        static void printValue(vector<int> rolls);
+};
+
+#endif

include/ScoreCalculator.h

@@ -0,0 +1,18 @@
+#ifndef SCORECALCULATOR_H
+#define SCORECALCULATOR_H
+
+#include <string>
+#include <vector>
+
+using namespace std;
+
+class ScoreCalculator {
+    public:
+        ScoreCalculator() = default;
+        
+        ~ScoreCalculator() = default;
+        
+        static int getScore(vector<int> rolls);
+};
+
+#endif

rolls.txt

@@ -1,4 +1 @@
-5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5
-10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10
-10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 9, 1
 2, 3, 5, 4, 9, 1, 2, 5, 3, 2, 4, 2, 3, 3, 4, 6, 10, 3, 2

src/FileHelper.cpp

@@ -1,10 +1,7 @@
-#include "../Include/FileHelper.h"
+#include "../include/FileHelper.h"
 #include <sys/stat.h>
 
-FileHelper::FileHelper() {};
+bool FileHelper::fileExists(char *path){
-FileHelper::~FileHelper() {};
-
-bool FileHelper::FileExists(char *path){
     struct stat s;
     
     // Check if file exists, and if it isn't a folder.

src/FileReader.cpp

@@ -1,16 +1,13 @@
-#include "../Include/FileReader.h"
+#include "../include/FileReader.h"
 #include <string>
 #include <fstream>
 
-FileReader::FileReader() {};
+string FileReader::getFile(char *path){
-FileReader::~FileReader() {};
+    ifstream file(path);
-
-std::string FileReader::GetFile(char *path){
-    std::ifstream file(path);
     
-    std::string line;
+    string line;
     
-    std::getline(file, line);
+    getline(file, line);
     
     file.close();
     

src/NumberHelper.cpp

@@ -1,18 +1,16 @@
-#include "../Include/NumberHelper.h"
+#include "../include/NumberHelper.h"
 #include <string>
 #include <sstream>
 #include <vector>
 
-NumberHelper::NumberHelper() {};
+vector<int> NumberHelper::getRolls(string csv){
-NumberHelper::~NumberHelper() {};
+    vector<int> rolls;
-
+    stringstream ss(csv);
-std::vector<int> NumberHelper::GetNumbers(std::string csv){
+    string number;
-    std::vector<int> rolls;
-    std::stringstream ss(csv);
-    std::string number;
     
-    while (std::getline(ss, number, ',')) {
+    // Get number from the CSV file, split by comma, and convert to int.
-        rolls.push_back(std::stoi(number));
+    while (getline(ss, number, ',')) {
+        rolls.push_back(stoi(number));
     }
     
     return rolls;

src/PrintFrames.cpp

@@ -1,10 +1,7 @@
-#include "../Include/PrintFrames.h"
+#include "../include/PrintFrames.h"
 #include <iostream>
 
-PrintFrames::PrintFrames() {};
+void PrintFrames::printHeader(vector<int> rolls){
-PrintFrames::~PrintFrames() {};
-
-void PrintFrames::PrintHeader(vector<int> rolls){
     int frame = 0;
     int i = 1;
     
@@ -13,7 +10,7 @@ void PrintFrames::PrintHeader(vector<int> rolls){
         
         // Strike
         if (rolls[frame] == 10) {
-            // If we're on our last frame, and roll a 10.
+            // If we're on our last frame, and roll a strike, we're given two bonus rolls.
             if (frame + 3 == rolls.size() && rolls[frame - 3] == 10) {
                 cout << " f" << i << "   |" << endl;
                 break;
@@ -25,6 +22,7 @@ void PrintFrames::PrintHeader(vector<int> rolls){
         
         // Spare
         else if (rolls[frame] + rolls[frame + 1] == 10) {
+            // If we're on our last frame, and roll a spare, we're given a bonus roll.
             if (frame + 3 == rolls.size() && rolls[frame] + rolls[frame + 1] == 10)
             {
                 cout << " f" << i << "   |" << endl;
@@ -43,6 +41,7 @@ void PrintFrames::PrintHeader(vector<int> rolls){
         
         ++i;
         
+        // No more frames
         if (frame == rolls.size()) {
             cout << "|" << endl;
             break;
@@ -50,7 +49,7 @@ void PrintFrames::PrintHeader(vector<int> rolls){
     }
 }
 
-void PrintFrames::PrintValue(vector<int> rolls){
+void PrintFrames::printValue(vector<int> rolls){
     int frame = 0;
     
     while (true) {
@@ -58,7 +57,7 @@ void PrintFrames::PrintValue(vector<int> rolls){
         
         // Strike
         if (rolls[frame] == 10) {
-            // If we're on our last frame, and roll a 10.
+            // If we're on our last frame, and roll a strike, we're given two bonus rolls.
             if (frame + 3 == rolls.size() && rolls[frame - 3] == 10) {
                 if (rolls[frame + 1] == 10 && rolls[frame + 2] == 10) {
                     cout << "X, X, X|" << endl;
@@ -85,6 +84,7 @@ void PrintFrames::PrintValue(vector<int> rolls){
         
         // Spare
         else if (rolls[frame] + rolls[frame + 1] == 10) {
+            // If we're on our last frame, and roll a spare, we're given a bonus roll.
             if (frame + 3 == rolls.size() && rolls[frame] + rolls[frame + 1] == 10)
             {
                 cout << rolls[frame] << ", /" << ", " << rolls[frame + 1] << "|" << endl;

src/ScoreCalculator.cpp

@@ -1,16 +1,13 @@
-#include "../Include/ScoreCalculator.h"
+#include "../include/ScoreCalculator.h"
 
-ScoreCalculator::ScoreCalculator() {};
+int ScoreCalculator::getScore(vector<int> rolls) {
-ScoreCalculator::~ScoreCalculator() {};
-
-int ScoreCalculator::GetScore(vector<int> rolls) {
     int score = 0;
     int frame = 0;
     
     while (true) {
         // Strike
         if (rolls[frame] == 10) {
-            // If we're on our last frame, and roll a 10.
+            // If we're on our last frame, and roll a strike, we're given two bonus rolls.
             if (frame + 3 == rolls.size() && rolls[frame - 3] == 10) {
                 score += 10 + rolls[frame + 1] + rolls[frame + 2];
                 break;
@@ -18,11 +15,11 @@ int ScoreCalculator::GetScore(vector<int> rolls) {
             
             score += 10 + rolls[frame + 1] + rolls[frame + 2];
             frame += 1;
-            continue;
         }
         
         // Spare
-        if (rolls[frame] + rolls[frame + 1] == 10) {
+        else if (rolls[frame] + rolls[frame + 1] == 10) {
+            // If we're on our last frame, and roll a spare, we're given a bonus roll.
             if (frame + 3 == rolls.size() && rolls[frame] + rolls[frame + 1] == 10)
             {
                 score += 10 + rolls[frame + 1];
@@ -31,13 +28,15 @@ int ScoreCalculator::GetScore(vector<int> rolls) {
             
             score += 10 + rolls[frame + 2];
             frame += 2;
-            continue;
         }
         
         // Open Frame
-        score += rolls[frame] + rolls[frame + 1];
+        else {
-        frame += 2;
+            score += rolls[frame] + rolls[frame + 1];
+            frame += 2;
+        }
         
+        // No more frames
         if (frame == rolls.size()) {
             break;
         }

src/main.cpp

@@ -1,10 +1,10 @@
 #include <iostream>
 #include <string>
-#include "../Include/FileReader.h"
+#include "../include/FileReader.h"
-#include "../Include/FileHelper.h"
+#include "../include/FileHelper.h"
-#include "../Include/NumberHelper.h"
+#include "../include/NumberHelper.h"
-#include "../Include/ScoreCalculator.h"
+#include "../include/ScoreCalculator.h"
-#include "../Include/PrintFrames.h"
+#include "../include/PrintFrames.h"
 
 using namespace std;
 
@@ -14,18 +14,18 @@ int main(int argc, char *argv[]) {
         return 0;
     }
     
-    if (!FileHelper::FileExists(argv[1])) {
+    if (!FileHelper::fileExists(argv[1])) {
         cerr << "Filepath: " << argv[1] << " doesn't exist.";
         return 0;
     }
     
-    string file = FileReader::GetFile(argv[1]);
+    string file = FileReader::getFile(argv[1]);
-    vector<int> rolls = NumberHelper::GetNumbers(file);
+    vector<int> rolls = NumberHelper::getRolls(file);
     
-    PrintFrames::PrintHeader(rolls);
+    PrintFrames::printHeader(rolls);
-    PrintFrames::PrintValue(rolls);
+    PrintFrames::printValue(rolls);
     
-    int score = ScoreCalculator::GetScore(rolls);
+    int score = ScoreCalculator::getScore(rolls);
     cout << "Score: " << score << endl;
     
     return 0;