From 6304f2603fab9395324d4fcb84fd7805ec1f35de Mon Sep 17 00:00:00 2001 From: ChrisPawley Date: Tue, 19 Jul 2016 10:55:51 +0000 Subject: [PATCH 1/2] changed variable and function names to consistent style made function and class names all CapitalCamelCase and variable names lowerCamelCase --- Cabinet/Cabinet/main.cpp | 2 +- Cabinet/HardwareDemo/CurrentTime.cpp | 2 +- Cabinet/TestCabinet/CodeCheckTest.cpp | 6 +++--- Cabinet/TestCabinet/HTTPPostClientSpy.cpp | 2 +- Cabinet/TestCabinet/HTTPPostClientSpy.h | 2 +- Cabinet/TestCabinet/POSTTests.cpp | 25 ++++------------------- Cabinet/TestCabinet/TestTime.cpp | 2 +- Cabinet/libCabinet/Cabinet.cpp | 2 +- Cabinet/libCabinet/CodeCheck.cpp | 6 +++--- Cabinet/libCabinet/CodeCheck.hpp | 2 +- Cabinet/libCabinet/CurrentTime.hpp | 2 +- Cabinet/libCabinet/HBridgeLock.cpp | 4 ++-- Cabinet/libCabinet/HBridgeLock.hpp | 2 +- Cabinet/libCabinet/HTTPPostClient.h | 2 +- Cabinet/libCabinet/LibCurlPostClient.cpp | 9 ++++---- Cabinet/libCabinet/LibCurlPostClient.h | 2 +- Cabinet/libCabinet/MatrixKeypad.cpp | 2 +- Cabinet/libCabinet/MatrixKeypad.hpp | 2 +- Cabinet/libCabinet/Postman.cpp | 4 ++-- Cabinet/libCabinet/Postman.h | 2 +- Cabinet/libCabinet/Switch.cpp | 12 +++++------ Cabinet/libCabinet/Switch.hpp | 2 +- 22 files changed, 40 insertions(+), 56 deletions(-) diff --git a/Cabinet/Cabinet/main.cpp b/Cabinet/Cabinet/main.cpp index b37cd5b..7410073 100644 --- a/Cabinet/Cabinet/main.cpp +++ b/Cabinet/Cabinet/main.cpp @@ -12,7 +12,7 @@ #define SERVICE_SLEEP_TIME_MILLISECONDS 1 using namespace std; -chrono::high_resolution_clock::time_point currentTime() +chrono::high_resolution_clock::time_point CurrentTime() { return chrono::high_resolution_clock::now(); } diff --git a/Cabinet/HardwareDemo/CurrentTime.cpp b/Cabinet/HardwareDemo/CurrentTime.cpp index 6d5dc7f..dafeefd 100644 --- a/Cabinet/HardwareDemo/CurrentTime.cpp +++ b/Cabinet/HardwareDemo/CurrentTime.cpp @@ -2,7 +2,7 @@ using namespace std::chrono; -high_resolution_clock::time_point currentTime() +high_resolution_clock::time_point CurrentTime() { return high_resolution_clock::now(); } diff --git a/Cabinet/TestCabinet/CodeCheckTest.cpp b/Cabinet/TestCabinet/CodeCheckTest.cpp index 34e2805..3fc3486 100644 --- a/Cabinet/TestCabinet/CodeCheckTest.cpp +++ b/Cabinet/TestCabinet/CodeCheckTest.cpp @@ -6,17 +6,17 @@ using namespace testing; TEST(CodeCheckTests, test_if_no_code_has_been_entered) { CodeCheck checker; - EXPECT_EQ(false, checker.inputCheck("")); + EXPECT_EQ(false, checker.InputCheck("")); } TEST(CodeCheckTests, test_if_incorrect_code_is_entered_returns_false) { CodeCheck checker; - EXPECT_EQ(false, checker.inputCheck("12364")); + EXPECT_EQ(false, checker.InputCheck("12364")); } TEST(CodeCheckTests, test_if_the_strings_match) { CodeCheck checker; - EXPECT_EQ(true, checker.inputCheck("1234")); + EXPECT_EQ(true, checker.InputCheck("1234")); } diff --git a/Cabinet/TestCabinet/HTTPPostClientSpy.cpp b/Cabinet/TestCabinet/HTTPPostClientSpy.cpp index 34c81fb..dd90fc5 100644 --- a/Cabinet/TestCabinet/HTTPPostClientSpy.cpp +++ b/Cabinet/TestCabinet/HTTPPostClientSpy.cpp @@ -1,6 +1,6 @@ #include "HTTPPostClientSpy.h" -bool HTTPPostClientSpy::sendPostMsg(std::string URL, std::string data) +bool HTTPPostClientSpy::SendPostMsg(std::string URL, std::string data) { lastPOSTURL = URL; lastPOSTData = data; diff --git a/Cabinet/TestCabinet/HTTPPostClientSpy.h b/Cabinet/TestCabinet/HTTPPostClientSpy.h index 982ea6a..8bf3ae2 100644 --- a/Cabinet/TestCabinet/HTTPPostClientSpy.h +++ b/Cabinet/TestCabinet/HTTPPostClientSpy.h @@ -7,7 +7,7 @@ class HTTPPostClientSpy : public HTTPPostClient { public: - bool sendPostMsg(std::string URL, std::string data); + bool SendPostMsg(std::string URL, std::string data); bool sendPostMsgResult = false; std::string lastPOSTURL; std::string lastPOSTData; diff --git a/Cabinet/TestCabinet/POSTTests.cpp b/Cabinet/TestCabinet/POSTTests.cpp index e874b5a..f5857d7 100644 --- a/Cabinet/TestCabinet/POSTTests.cpp +++ b/Cabinet/TestCabinet/POSTTests.cpp @@ -5,29 +5,12 @@ using namespace testing; -/********************************* - ****Actual Libcurl Post**********/ -/*TEST(LibCurlPOSTTests, Curl_send_attempt_to_HTTPBinOrg_returns_true) -{ - LibCurlPostClient testClient; - EXPECT_EQ(true, testClient.sendPostMsg("http://httpbin.org/post", "TEST")); -} - -TEST(LibCurlPOSTTests, Curl_send_attempt_to_GibberishInvalid_returns_false) -{ - LibCurlPostClient testClient; - EXPECT_EQ(false, testClient.sendPostMsg("http://gibberish.invalid", "TEST")); -}*/ - -/********************************* - *******Postman Tests*************/ - TEST(PostmanTests, Postman_returns_false_when_client_fails) { HTTPPostClientSpy testClient; testClient.sendPostMsgResult = false; Postman pat("http://gibberish.invalid", &testClient); - EXPECT_EQ(false, pat.sendEventNotification("AAE114", "Open", "Available")); + EXPECT_EQ(false, pat.SendEventNotification("AAE114", "Open", "Available")); } TEST(PostmanTests, Postman_returns_true_when_client_succeeds) @@ -35,7 +18,7 @@ TEST(PostmanTests, Postman_returns_true_when_client_succeeds) HTTPPostClientSpy testClient; testClient.sendPostMsgResult = true; Postman pat("http://gibberish.invalid", &testClient); - EXPECT_EQ(true, pat.sendEventNotification("AAE114", "Open", "Available")); + EXPECT_EQ(true, pat.SendEventNotification("AAE114", "Open", "Available")); } TEST(PostmanTests, Postman_sends_to_URL_given) @@ -43,7 +26,7 @@ TEST(PostmanTests, Postman_sends_to_URL_given) HTTPPostClientSpy testClient; testClient.sendPostMsgResult = true; Postman pat("http://gibberish.invalid", &testClient); - pat.sendEventNotification("AAE114", "Open", "Available"); + pat.SendEventNotification("AAE114", "Open", "Available"); EXPECT_EQ("http://gibberish.invalid", testClient.lastPOSTURL); } @@ -58,6 +41,6 @@ TEST(PostmanTests, Postman_sends_data_formatted_correctly) HTTPPostClientSpy testClient; testClient.sendPostMsgResult = true; Postman pat("http://gibberish.invalid", &testClient); - pat.sendEventNotification("AAE114", "Open", "Available"); + pat.SendEventNotification("AAE114", "Open", "Available"); EXPECT_EQ(boxPOSTData, testClient.lastPOSTData); } diff --git a/Cabinet/TestCabinet/TestTime.cpp b/Cabinet/TestCabinet/TestTime.cpp index 2d4230e..d08e668 100644 --- a/Cabinet/TestCabinet/TestTime.cpp +++ b/Cabinet/TestCabinet/TestTime.cpp @@ -3,7 +3,7 @@ using namespace ::std::chrono; high_resolution_clock::time_point fakeTime; -high_resolution_clock::time_point currentTime() +high_resolution_clock::time_point CurrentTime() { return fakeTime; } diff --git a/Cabinet/libCabinet/Cabinet.cpp b/Cabinet/libCabinet/Cabinet.cpp index 9011cef..69eacbd 100644 --- a/Cabinet/libCabinet/Cabinet.cpp +++ b/Cabinet/libCabinet/Cabinet.cpp @@ -17,7 +17,7 @@ bool Cabinet::DoorEventCallback(bool doorOpen) if(doorOpen) { - return postie->sendEventNotification(boxID, "Open", "Available"); + return postie->SendEventNotification(boxID, "Open", "Available"); } return false; diff --git a/Cabinet/libCabinet/CodeCheck.cpp b/Cabinet/libCabinet/CodeCheck.cpp index 2924bd4..efeb694 100644 --- a/Cabinet/libCabinet/CodeCheck.cpp +++ b/Cabinet/libCabinet/CodeCheck.cpp @@ -2,10 +2,10 @@ #include #include -bool CodeCheck::inputCheck(std::string inputCode) +bool CodeCheck::InputCheck(std::string inputCode) { -std::string correctCode = "1234"; -if((inputCode == correctCode)) + std::string correctCode = "1234"; + if((inputCode == correctCode)) { return true; } diff --git a/Cabinet/libCabinet/CodeCheck.hpp b/Cabinet/libCabinet/CodeCheck.hpp index 095611a..808ac73 100644 --- a/Cabinet/libCabinet/CodeCheck.hpp +++ b/Cabinet/libCabinet/CodeCheck.hpp @@ -5,7 +5,7 @@ class CodeCheck { public: - bool inputCheck(std::string inputCode); + bool InputCheck(std::string inputCode); protected: private: }; diff --git a/Cabinet/libCabinet/CurrentTime.hpp b/Cabinet/libCabinet/CurrentTime.hpp index 28cc056..e0f3158 100644 --- a/Cabinet/libCabinet/CurrentTime.hpp +++ b/Cabinet/libCabinet/CurrentTime.hpp @@ -2,6 +2,6 @@ #define CURRENTTIME_H #include -std::chrono::high_resolution_clock::time_point currentTime(); +std::chrono::high_resolution_clock::time_point CurrentTime(); #endif diff --git a/Cabinet/libCabinet/HBridgeLock.cpp b/Cabinet/libCabinet/HBridgeLock.cpp index fa21baf..14bac36 100644 --- a/Cabinet/libCabinet/HBridgeLock.cpp +++ b/Cabinet/libCabinet/HBridgeLock.cpp @@ -38,11 +38,11 @@ void RunRequest(bool &requested, bool &inProgress, { requested = false; inProgress = true; - startTime = currentTime(); + startTime = CurrentTime(); pin->State(true); } - if(inProgress && (currentTime() - startTime) >= milliseconds(500)) + if(inProgress && (CurrentTime() - startTime) >= milliseconds(500)) { inProgress = false; pin->State(false); diff --git a/Cabinet/libCabinet/HBridgeLock.hpp b/Cabinet/libCabinet/HBridgeLock.hpp index d3afc37..ee6c281 100644 --- a/Cabinet/libCabinet/HBridgeLock.hpp +++ b/Cabinet/libCabinet/HBridgeLock.hpp @@ -7,7 +7,7 @@ class HBridgeLock { public: - using current_time_point_t = decltype(currentTime()); + using current_time_point_t = decltype(CurrentTime()); private: OutputPin *openPin; OutputPin *closePin; diff --git a/Cabinet/libCabinet/HTTPPostClient.h b/Cabinet/libCabinet/HTTPPostClient.h index d3579c0..e6310b5 100644 --- a/Cabinet/libCabinet/HTTPPostClient.h +++ b/Cabinet/libCabinet/HTTPPostClient.h @@ -6,7 +6,7 @@ class HTTPPostClient { public: - virtual bool sendPostMsg(std::string URL, std::string data) = 0; + virtual bool SendPostMsg(std::string URL, std::string data) = 0; virtual ~HTTPPostClient(){}; protected: private: diff --git a/Cabinet/libCabinet/LibCurlPostClient.cpp b/Cabinet/libCabinet/LibCurlPostClient.cpp index 29039c3..ed47f00 100644 --- a/Cabinet/libCabinet/LibCurlPostClient.cpp +++ b/Cabinet/libCabinet/LibCurlPostClient.cpp @@ -3,14 +3,14 @@ #include "LibCurlPostClient.h" -size_t writeData(char *receivedBuffer, size_t receivedSize, +size_t WriteData(char *receivedBuffer, size_t receivedSize, size_t newMemoryBytes, std::string *stringPointer) { stringPointer->append(receivedBuffer, newMemoryBytes); return receivedSize * newMemoryBytes; } -bool LibCurlPostClient::sendPostMsg(std::string URL, std::string data) +bool LibCurlPostClient::SendPostMsg(std::string URL, std::string data) { /* get a curl handle */ curl = curl_easy_init(); @@ -18,13 +18,14 @@ bool LibCurlPostClient::sendPostMsg(std::string URL, std::string data) { std::string receivedData; + /* First set the URL that is about to receive our POST. This URL can just as well be a https:// URL if that is what should receive the data. */ - curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, writeData); + curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteData); curl_easy_setopt(curl, CURLOPT_WRITEDATA, &receivedData); - curl_easy_setopt(curl, CURLOPT_URL, URL.c_str()); + /* Now specify the POST data */ curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data.c_str()); diff --git a/Cabinet/libCabinet/LibCurlPostClient.h b/Cabinet/libCabinet/LibCurlPostClient.h index f5f279b..51a2c31 100644 --- a/Cabinet/libCabinet/LibCurlPostClient.h +++ b/Cabinet/libCabinet/LibCurlPostClient.h @@ -6,7 +6,7 @@ class LibCurlPostClient : public HTTPPostClient { public: - bool sendPostMsg(std::string URL, std::string data); + bool SendPostMsg(std::string URL, std::string data); protected: private: CURL *curl; diff --git a/Cabinet/libCabinet/MatrixKeypad.cpp b/Cabinet/libCabinet/MatrixKeypad.cpp index 5fefbc2..76bb0e7 100644 --- a/Cabinet/libCabinet/MatrixKeypad.cpp +++ b/Cabinet/libCabinet/MatrixKeypad.cpp @@ -18,7 +18,7 @@ void MatrixKeypad::SetKeyPressedCallback(key_pressed_callback_t callback) void MatrixKeypad::Service() { uint16_t states = reader->Read(); - time_point_t now = currentTime(); + time_point_t now = CurrentTime(); for(size_t key = 0; key < numberOfKeys; key++) { diff --git a/Cabinet/libCabinet/MatrixKeypad.hpp b/Cabinet/libCabinet/MatrixKeypad.hpp index dbf1335..54cc58f 100644 --- a/Cabinet/libCabinet/MatrixKeypad.hpp +++ b/Cabinet/libCabinet/MatrixKeypad.hpp @@ -9,7 +9,7 @@ class MatrixKeypad { public: using key_pressed_callback_t = std::function; - using time_point_t = decltype(currentTime()); + using time_point_t = decltype(CurrentTime()); static const size_t numberOfKeys{12}; private: diff --git a/Cabinet/libCabinet/Postman.cpp b/Cabinet/libCabinet/Postman.cpp index 25b9ce6..d22c38a 100644 --- a/Cabinet/libCabinet/Postman.cpp +++ b/Cabinet/libCabinet/Postman.cpp @@ -6,7 +6,7 @@ Postman::Postman(std::string serverAddress, HTTPPostClient *client) this->serverAddress = serverAddress; } -bool Postman::sendEventNotification(std::string boxID, std::string doorStatus, std::string defibStatus) +bool Postman::SendEventNotification(std::string boxID, std::string doorStatus, std::string defibStatus) { std::string boxPOSTData = "{\n" @@ -15,6 +15,6 @@ bool Postman::sendEventNotification(std::string boxID, std::string doorStatus, s " \"defib_status\" : \"" + defibStatus + "\" \n" "}"; - return postClient->sendPostMsg(serverAddress, boxPOSTData); + return postClient->SendPostMsg(serverAddress, boxPOSTData); } diff --git a/Cabinet/libCabinet/Postman.h b/Cabinet/libCabinet/Postman.h index db9473c..30cbaba 100644 --- a/Cabinet/libCabinet/Postman.h +++ b/Cabinet/libCabinet/Postman.h @@ -9,7 +9,7 @@ class Postman { public: Postman(std::string serverAddress, HTTPPostClient *client); - bool sendEventNotification(std::string boxID, std::string doorStatus, std::string defibStatus); + bool SendEventNotification(std::string boxID, std::string doorStatus, std::string defibStatus); protected: private: std::string serverAddress; diff --git a/Cabinet/libCabinet/Switch.cpp b/Cabinet/libCabinet/Switch.cpp index 5f21616..90e341e 100644 --- a/Cabinet/libCabinet/Switch.cpp +++ b/Cabinet/libCabinet/Switch.cpp @@ -10,12 +10,12 @@ Switch::Switch(InputPin *switchPin, doorCallback doorEventCallback) doorCallbackFunction = doorEventCallback; pin = switchPin; previouslyPressed = false; - PressedState = false; + pressedState = false; } bool Switch::IsPressed() { - return PressedState; + return pressedState; } void Switch::StateCheck() @@ -23,7 +23,7 @@ void Switch::StateCheck() if(pin->State() == false) { - PressedState = false; + pressedState = false; previouslyPressed = false; } else @@ -31,15 +31,15 @@ void Switch::StateCheck() if (previouslyPressed == false) { - firstTime = currentTime(); + firstTime = CurrentTime(); } else { - if (((currentTime() - firstTime) >= milliseconds(10)) && !PressedState) + if (((CurrentTime() - firstTime) >= milliseconds(10)) && !pressedState) { doorCallbackFunction(true); - PressedState = true; + pressedState = true; } } previouslyPressed = true; diff --git a/Cabinet/libCabinet/Switch.hpp b/Cabinet/libCabinet/Switch.hpp index 418c17c..ae70ea6 100644 --- a/Cabinet/libCabinet/Switch.hpp +++ b/Cabinet/libCabinet/Switch.hpp @@ -17,7 +17,7 @@ class Switch void Service(); private: InputPin *pin; - bool PressedState; + bool pressedState; bool previouslyPressed; std::chrono::high_resolution_clock::time_point firstTime; doorCallback doorCallbackFunction; From 5c723ee8c7fac21f7e77a3cfffe96ba0a1fa99e5 Mon Sep 17 00:00:00 2001 From: ChrisPawley Date: Tue, 19 Jul 2016 16:08:41 +0000 Subject: [PATCH 2/2] Renamed function inputCheck to InputCheck in CodeCheck class --- Cabinet/libCabinet/CodeCheck.cpp | 8 ++++---- Cabinet/libCabinet/CodeCheck.hpp | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Cabinet/libCabinet/CodeCheck.cpp b/Cabinet/libCabinet/CodeCheck.cpp index b942291..e5cceaa 100644 --- a/Cabinet/libCabinet/CodeCheck.cpp +++ b/Cabinet/libCabinet/CodeCheck.cpp @@ -19,10 +19,10 @@ CodeCheck::CodeCheck() } -bool CodeCheck::inputCheck(std::string inputCode) +bool CodeCheck::InputCheck(std::string inputCode) { -std::string correctCode = "1234"; -if((inputCode == correctCode)) + std::string correctCode = "1234"; + if((inputCode == correctCode)) { if(unlockCallback) @@ -54,7 +54,7 @@ void CodeCheck::keyPressed(int keyID) } else if (inputConversion[keyID] == 'E') { - if (!inputCheck(codeEntered)) + if (!InputCheck(codeEntered)) { codeEntered = ""; } diff --git a/Cabinet/libCabinet/CodeCheck.hpp b/Cabinet/libCabinet/CodeCheck.hpp index b59e0c3..4cae4f2 100644 --- a/Cabinet/libCabinet/CodeCheck.hpp +++ b/Cabinet/libCabinet/CodeCheck.hpp @@ -10,7 +10,7 @@ class CodeCheck { public: CodeCheck(); - bool inputCheck(std::string inputCode); + bool InputCheck(std::string inputCode); void keyPressed(int keyID); std::string getCodeEntered(); void SetUnlockCallback (std::function callback);