initial commit

Author: xyzpw

.gitignore

@@ -0,0 +1,3 @@
+.vscode/
+/test.csv
+ascii-data-visualizer

Makefile

@@ -0,0 +1,8 @@
+CC = g++
+TARGET = ascii-data-visualizer
+SOURCES = ascii-data-visualizer.cpp src/*.cpp
+FLAGS = -o ascii-data-visualizer -Iinclude
+
+$(TARGET): $(SOURCES)
+	$(CC) $(FLAGS) $(SOURCES)
+

README.md

@@ -0,0 +1,43 @@
+# ascii-graph
+A terminal application which visualizes statistical data via ascii characters.
+
+## Requirements
+- g++
+- Support for `make` command (which compiles c++ code)
+- c++17
+
+
+
+## Installation
+To build/execute the file, `cd` into the directory of the repo and use the `make` command.<br>
+After compiling the file, it will create an executable file.<br>
+
+Build and execute example:
+```bash
+$ make
+$ ./ascii-data-visualizer file.csv
+```
+
+## Usage
+To visualize data, you must first specify a csv file to read.<br>
+The first command line argument will be the file, e.g.:
+```bash
+$ ./ascii-data-visualizer file.csv
+```
+
+### Arguments
+Command line arguments can be used to change how you visualize your data.<br>
+If you want your chart to be vertical, you can use the `orientation` argument:
+```bash
+$ ./ascii-data-visualizer file.csv --orientation vertical
+```
+
+### File Format
+Format follows `label,value` format:
+```csv
+title: Programming languages used by programmers (percent)
+
+C,20
+C++,23
+Python,51
+```

ascii-data-visualizer.cpp

@@ -0,0 +1,30 @@
+#include <iostream>
+#include <string>
+#include <fstream>
+#include <regex>
+#include <filesystem>
+#include <cmath>
+#include <unordered_map>
+#include "chart_manager.h"
+#include "file_reader.h"
+#include "arg_handler.h"
+
+int main(int argc, char **argv)
+{
+    std::string fileName = getFileNameFromArgs(argc, argv);
+    auto cmdArgs = getCommandLineArgs(argc, argv);
+
+    std::string orientation = getArgValue(cmdArgs, "orientation", "horizontal");
+    int length = std::stoi(getArgValue(cmdArgs, "length", "10"));
+    std::string chartString = "";
+    if (orientation == "vertical"){
+        int height = std::stoi(getArgValue(cmdArgs, "height", "10"));
+        VerticalBarChart myChart(fileName, length, height);
+        chartString = myChart.drawChart();
+    } else{
+        HorizontalBarChart myChart(fileName, length);
+        chartString = myChart.drawChart();
+    }
+    std::cout << chartString;
+    return 0;
+}

include/arg_handler.h

@@ -0,0 +1,16 @@
+#pragma once
+
+#include <iostream>
+#include <string>
+#include <regex>
+#include <unordered_map>
+
+const std::regex commandLineArgsPattern{"(?:--)(\\w+?)\\s(\\w+)"};
+
+std::string getArgValue(
+    std::unordered_map<std::string, std::string>,
+    std::string argName, std::string defaultValue
+);
+
+std::string getFileNameFromArgs(int argc, char **argv);
+std::unordered_map<std::string, std::string> getCommandLineArgs(int argc, char **argv);

include/bar_chart_utilities.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#include <iostream>
+#include <string>
+#include <vector>
+
+const std::string HORIZONTAL_BORDER_CHAR = "\u2500";
+const std::string HORIZONTAL_BAR_CHAR = "#";
+const std::string VERTICAL_BAR_CHAR = "\u2588";
+
+std::string drawHorizontalBorder(int length);
+std::string drawHorizontalBar(int length);
+int getMaxStringLength(std::vector<std::string> strings);

include/chart_manager.h

@@ -0,0 +1,34 @@
+#pragma once
+
+#include <iostream>
+#include <string>
+#include <vector>
+
+struct ChartDataPoint{
+    std::string label;
+    double value;
+};
+
+struct BarChartInfo{
+    std::string title = "";
+    std::vector<ChartDataPoint> dataPoints;
+};
+
+BarChartInfo getBarChartInfoFromFile(std::string filename);
+
+class HorizontalBarChart{
+    public:
+        int maxLength;
+        std::string title;
+        std::vector<ChartDataPoint> dataPoints;
+        std::string drawChart();
+        HorizontalBarChart(std::string filename, int maxLength = 10);
+};
+class VerticalBarChart{
+    public:
+        int width, height;
+        std::string title;
+        std::vector<ChartDataPoint> dataPoints;
+        std::string drawChart();
+        VerticalBarChart(std::string filename, int width = 10, int height = 10);
+};

include/data_utilities.h

@@ -0,0 +1,9 @@
+#pragma once
+
+#include <iostream>
+#include <string>
+#include <regex>
+
+const std::regex lastDecimalPattern{"^([\\d.]+?(?:[1-9]?$|(?=0+?$)))"};
+
+std::string doubleToStringPrecision(double value);

include/file_reader.h

@@ -0,0 +1,11 @@
+#pragma once
+
+#include <iostream>
+#include <string>
+#include <regex>
+#include <unordered_map>
+
+const std::regex csvFilePattern{"^(.+?),([\\d.]+)(?=,|$)"};
+const std::regex csvDelimiterPattern{"^(\\w+?):\\s*(.+?)$"};
+const std::regex validFilePattern{"^[a-z0-9_-]*\\.csv$", std::regex_constants::icase};
+std::vector<std::string> getFileLines(std::string filename);

src/arg_handler.cpp

@@ -0,0 +1,46 @@
+#include <iostream>
+#include <string>
+#include <unordered_map>
+#include <regex>
+#include "arg_handler.h"
+
+std::string getArgValue(
+    std::unordered_map<std::string, std::string> args,
+    std::string argName, std::string defaultValue = "")
+{
+    if (!args.count(argName))
+        return defaultValue;
+    return args.at(argName);
+}
+
+std::string getFileNameFromArgs(int argc, char **argv)
+{
+    if (argc > 1)
+        return argv[1];
+    throw std::runtime_error("no file specified");
+}
+
+std::unordered_map<std::string, std::string> getCommandLineArgs(int argc, char **argv)
+{
+    std::unordered_map<std::string, std::string> args;
+    if (argc == 1)
+        return args;
+    std::smatch argMatch;
+    std::string argsString("");
+    for (int i = 1; i < argc; ++i){
+        argsString += argv[i];
+        if (i+1 < argc)
+            argsString += " ";
+    }
+    for (std::sregex_iterator i = std::sregex_iterator(
+            argsString.begin(), argsString.end(), commandLineArgsPattern);
+            i != std::sregex_iterator();
+            ++i)
+    {
+        std::smatch argMatch = *i;
+        std::string arg = argMatch[1].str();
+        std::string argValue = argMatch[2].str();
+        args[arg] = argValue;
+    }
+    return args;
+}