Refactored code; fixed tests.

Author: SimonCahill

include/libdbc/dbc.hpp

@@ -40,11 +40,11 @@ class DbcParser : public Parser {
 	const std::vector<std::string>& unused_lines() const;
 
 	#if __cplusplus >= 201703L
-	static bool is_valid_dbc_file(const std::filesystem::path&);
+	static void validate_dbc_file(const std::filesystem::path&);
 	#else
-	static bool is_valid_dbc_file(const std::string&);
+	static void validate_dbc_file(const std::string&);
 	#endif // __cplusplus >= 201703L
-	static bool is_valid_dbc_file(std::istream& stream);
+	static void validate_dbc_file(std::istream& stream);
 
 private:
 	std::string version{};

include/libdbc/exceptions/error.hpp

@@ -22,10 +22,12 @@ class ValidityError : public Exception {
 
 class NonDbcFileFormatError : public ValidityError {
 public:
-	NonDbcFileFormatError(const std::string& path, const std::string& extension) {
-		error_msg = {"File is not of DBC format. Expected a .dbc extension. Cannot read this type of file (" + path + "). Found the extension (" + extension
-					 + ")."};
-	}
+	explicit NonDbcFileFormatError(const std::string& path, const std::string& extension):
+	error_msg("File is not of DBC format. Expected a .dbc extension. Cannot read this type of file ("
+				+ path + "). Found the extension (" + extension + ")."
+	) { }
+	explicit NonDbcFileFormatError(const std::string& error):
+	error_msg("File is not of DBC format. Cannot read this type of file (" + error + ").") { }
 
 	const char* what() const throw() override {
 		return error_msg.c_str();
@@ -35,32 +37,16 @@ class NonDbcFileFormatError : public ValidityError {
 	std::string error_msg;
 };
 
-class DbcFileIsMissingVersion : public ValidityError {
+class DbcFileIsMissingVersion : public NonDbcFileFormatError {
 public:
-	DbcFileIsMissingVersion(const std::string& line) {
-		error_msg = {"Invalid dbc file. Missing the required version header. Attempting to read line: (" + line + ")."};
-	}
-
-	const char* what() const throw() override {
-		return error_msg.c_str();
-	}
-
-private:
-	std::string error_msg;
+	explicit DbcFileIsMissingVersion(const std::string& line):
+		NonDbcFileFormatError("Invalid dbc file. Missing the required version header. Attempting to read line: (" + line + ").") { }
 };
 
-class DbcFileIsMissingBitTiming : public ValidityError {
+class DbcFileIsMissingBitTiming : public NonDbcFileFormatError {
 public:
-	DbcFileIsMissingBitTiming(const std::string& line) {
-		error_msg = {"Invalid dbc file. Missing required bit timing in the header. Attempting to read line: (" + line + ")."};
-	}
-
-	const char* what() const throw() override {
-		return error_msg.c_str();
-	}
-
-private:
-	std::string error_msg;
+	explicit DbcFileIsMissingBitTiming(const std::string& line):
+		NonDbcFileFormatError("Invalid dbc file. Missing required bit timing in the header. Attempting to read line: (" + line + ").") { }
 };
 
 } // libdbc

src/dbc.cpp

@@ -71,29 +71,21 @@ DbcParser::DbcParser()
 }
 
 #if __cplusplus >= 201703L
-bool DbcParser::is_valid_dbc_file(const std::filesystem::path& file_path) {
+void DbcParser::validate_dbc_file(const std::filesystem::path& file_path) {
 #else
-bool DbcParser::is_valid_dbc_file(const std::string& file_path) {
+void DbcParser::validate_dbc_file(const std::string& file_path) {
 #endif // __cplusplus >= 201703L
 
 	std::ifstream testStream{file_path};
-	if (!testStream.is_open()) { return false; }
 
-	return is_valid_dbc_file(testStream);
+	return validate_dbc_file(testStream);
 }
 
-bool DbcParser::is_valid_dbc_file(std::istream& stream) {
+void DbcParser::validate_dbc_file(std::istream& stream) {
 	stream.seekg(0, std::ios::beg);
 
-	try {
-		DbcParser parser{};
-		parser.parse_dbc_header(stream);
-	} catch (const Exception& e) {
-		// If the file is missing the version, it is not a valid DBC file
-		return false;
-	}
-
-	return true;
+	DbcParser parser{};
+	parser.parse_dbc_header(stream);
 }
 
 void DbcParser::parse_file(std::istream& stream) {
@@ -114,9 +106,7 @@ void DbcParser::parse_file(std::istream& stream) {
 }
 
 void DbcParser::parse_file(const std::string& file_name) {
-	if (!is_valid_dbc_file(file_name)) {
-		throw NonDbcFileFormatError(file_name, get_extension(file_name));
-	}
+	validate_dbc_file(file_name);
 
 	std::ifstream stream(file_name);
 

test/test_dbc.cpp

@@ -14,8 +14,7 @@ TEST_CASE("Testing dbc file loading error issues", "[fileio][error]") {
 	auto parser = std::unique_ptr<Libdbc::DbcParser>(new Libdbc::DbcParser());
 
 	SECTION("Loading a non dbc file should throw an error", "[error]") {
-		REQUIRE_THROWS_AS(parser->parse_file(TEXT_FILE), Libdbc::NonDbcFileFormatError);
-		REQUIRE_THROWS_WITH(parser->parse_file(TEXT_FILE), ContainsSubstring("TextFile.txt"));
+		REQUIRE_THROWS_AS(parser->validate_dbc_file(TEXT_FILE), Libdbc::NonDbcFileFormatError);
 	}
 
 	SECTION("Loading a dbc with missing version header throws an error (VERSION)", "[error]") {