Utility: TextAccess

Abstraction for file or text access.

review id = 16

fortune cookie message = Good news from someone dear is coming soon.

src/test/CMakeLists.txt

@@ -8,5 +8,6 @@ add_files(
 	MessageQueueTestSuite.h
 	TestSuiteFixture.cpp
 	TestSuiteFixture.h
+	TextAccessTestSuite.h
 	Vector2TestSuite.h
 )

src/test/ConfigManagerTestSuite.h

@@ -1,14 +1,14 @@
 #include "cxxtest/TestSuite.h"
 
 #include "utility/ConfigManager.h"
-
+#include "utility/text/TextAccess.h"
 
 class ConfigManagerTestSuite: public CxxTest::TestSuite
 {
 public:
 	void test_config_manager_returns_true_when_key_is_found()
 	{
-		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad("data/test_config.xml");
+		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad(getConfigTextAccess());
 
 		float value;
 		bool success = config->getValue("path/to/single_value", value);
@@ -19,7 +19,7 @@ public:
 
 	void test_config_manager_returns_false_when_key_is_not_found()
 	{
-		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad("data/test_config.xml");
+		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad(getConfigTextAccess());
 
 		float value;
 		bool success = config->getValue("path/to/nowhere", value);
@@ -30,7 +30,7 @@ public:
 
 	void test_config_manager_returns_correct_string_for_key()
 	{
-		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad("data/test_config.xml");
+		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad(getConfigTextAccess());
 
 		std::string value;
 		config->getValue("path/to/single_value", value);
@@ -41,7 +41,7 @@ public:
 
 	void test_config_manager_returns_correct_float_for_key()
 	{
-		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad("data/test_config.xml");
+		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad(getConfigTextAccess());
 
 		float value;
 		config->getValue("path/to/single_value", value);
@@ -51,7 +51,7 @@ public:
 
 	void test_config_manager_returns_correct_bool_for_key_if_value_is_true()
 	{
-		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad("data/test_config.xml");
+		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad(getConfigTextAccess());
 
 		float value;
 		bool success(config->getValue("path/to/bool_that_is_true", value));
@@ -62,7 +62,7 @@ public:
 
 	void test_config_manager_returns_correct_bool_for_key_if_value_is_false()
 	{
-		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad("data/test_config.xml");
+		std::shared_ptr<ConfigManager> config = ConfigManager::createAndLoad(getConfigTextAccess());
 
 		float value;
 		bool success(config->getValue("path/to/bool_that_is_false", value));
@@ -70,4 +70,22 @@ public:
 		TS_ASSERT(success);
 		TS_ASSERT(!value);
 	}
+
+private:
+	std::shared_ptr<TextAccess> getConfigTextAccess()
+	{
+		std::string text =
+			"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
+			"<config>\n"
+				"<path>\n"
+					"<to>\n"
+						"<single_value>42</single_value>\n"
+							"<bool_that_is_true>1</bool_that_is_true>\n"
+						"<bool_that_is_false>0</bool_that_is_false>\n"
+					"</to>\n"
+				"</path>\n"
+			"</config>\n";
+
+		return TextAccess::createFromString(text);
+	}
 };

src/test/TextAccessTestSuite.h

@@ -0,0 +1,149 @@
+#include "cxxtest/TestSuite.h"
+
+#include <memory>
+#include <string>
+
+#include "utility/text/TextAccess.h"
+
+class TextAccessTestSuite : public CxxTest::TestSuite
+{
+public:
+	void test_textAccessString_constructor()
+	{
+		std::string text = getTestText();
+
+		std::shared_ptr<TextAccess> textAccess = TextAccess::createFromString(text);
+
+		TS_ASSERT(textAccess.get() != NULL);
+	}
+
+	void test_textAccessString_lines_count()
+	{
+		std::string text = getTestText();
+		unsigned int lineCount = 8;
+
+		std::shared_ptr<TextAccess> textAccess = TextAccess::createFromString(text);
+
+		TS_ASSERT_EQUALS(textAccess->getLineCount(), lineCount);
+	}
+
+	void test_textAccessString_lines_content()
+	{
+		std::string text = getTestText();
+
+		std::shared_ptr<TextAccess> textAccess = TextAccess::createFromString(text);
+		std::vector<std::string> lines = textAccess->getLines(1, 4);
+
+		TS_ASSERT_EQUALS(lines.size(), 4);
+		TS_ASSERT_EQUALS(lines[0], "\"But the plans were on display . . .\"\n");
+		TS_ASSERT_EQUALS(lines[1], "\"On display? I eventually had to go down to the cellar to find them.\"\n");
+		TS_ASSERT_EQUALS(lines[2], "\"That's the display department.\"\n");
+		TS_ASSERT_EQUALS(lines[3], "\"With a torch.\"\n");
+	}
+
+	void test_textAccessString_lines_content_error_handling()
+	{
+		std::string text = getTestText();
+
+		std::shared_ptr<TextAccess> textAccess = TextAccess::createFromString(text);
+		std::vector<std::string> lines = textAccess->getLines(3, 2);
+
+		TS_ASSERT_EQUALS(lines.size(), 0);
+
+		lines = textAccess->getLines(10, 3);
+
+		TS_ASSERT_EQUALS(lines.size(), 0);
+
+		lines = textAccess->getLines(1, 10);
+
+		TS_ASSERT_EQUALS(lines.size(), 0);
+
+		std::string line = textAccess->getLine(0);
+
+		TS_ASSERT_EQUALS(line, "");
+
+		lines = textAccess->getLines(0, 2);
+
+		TS_ASSERT_EQUALS(line, "");
+	}
+
+	void test_textAccessString_single_line_content()
+	{
+		std::string text = getTestText();
+
+		std::shared_ptr<TextAccess> textAccess = TextAccess::createFromString(text);
+		std::string line = textAccess->getLine(6);
+
+		TS_ASSERT_EQUALS(line, "\"So had the stairs.\"\n");
+	}
+
+	void test_textAccessString_all_lines()
+	{
+		std::string text = getTestText();
+		unsigned int lineCount = 8;
+
+		std::shared_ptr<TextAccess> textAccess = TextAccess::createFromString(text);
+		std::vector<std::string> lines = textAccess->getAllLines();
+
+		TS_ASSERT_EQUALS(lines.size(), lineCount);
+	}
+
+	void test_textAccessFile_constructor()
+	{
+		std::string filePath = "data/test_text.txt";
+
+		std::shared_ptr<TextAccess> textAccess = TextAccess::createFromFile(filePath);
+
+		TS_ASSERT(textAccess.get() != NULL);
+	}
+
+	void test_textAccessFile_lines_count()
+	{
+		std::string filePath = "data/test_text.txt";
+		unsigned int lineCount = 7;
+
+		std::shared_ptr<TextAccess> textAccess = TextAccess::createFromFile(filePath);
+
+		TS_ASSERT_EQUALS(textAccess->getLineCount(), lineCount);
+	}
+
+	void test_textAccessFile_lines_content()
+	{
+		std::string filePath = "data/test_text.txt";
+
+		std::shared_ptr<TextAccess> textAccess = TextAccess::createFromFile(filePath);
+		std::vector<std::string> lines = textAccess->getLines(1, 4);
+
+		TS_ASSERT_EQUALS(lines.size(), 4);
+		TS_ASSERT_EQUALS(lines[0], "\"If you're a researcher on this book thing and you were on Earth, you must have been gathering material on it.\"\n");
+		TS_ASSERT_EQUALS(lines[1], "\"Well, I was able to extend the original entry a bit, yes.\"\n");
+		TS_ASSERT_EQUALS(lines[2], "\"Let me see what it says in this edition, then. I've got to see it.\"\n");
+		TS_ASSERT_EQUALS(lines[3], "... \"What? Harmless! Is that all it's got to say? Harmless! One word! ... Well, for God's sake I hope you managed to recitify that a bit.\"\n");
+	}
+
+	void test_textAccessFile_get_filePath()
+	{
+		std::string filePath = "data/test_text.txt";
+		std::shared_ptr<TextAccess> textAccess = TextAccess::createFromFile(filePath);
+
+		TS_ASSERT_EQUALS(textAccess->getFilePath(), filePath);
+	}
+
+private:
+	std::string getTestText()
+	{
+		std::string text =
+			"\"But the plans were on display . . .\"\n"
+			"\"On display? I eventually had to go down to the cellar to find them.\"\n"
+			"\"That's the display department.\"\n"
+			"\"With a torch.\"\n"
+			"\"Ah, well the lights had probably gone.\"\n"
+			"\"So had the stairs.\"\n"
+			"\"But look, you found the notice, didn't you?\"\n"
+			"\"Yes,\" said Arthur, \"yes I did. It was on display in the bottom of a locked"
+			" filing cabinet stuck in a disused lavatory with a sign on the door saying"
+			" Beware of the Leopard.\"\n";
+
+		return text;
+	}
+};