Fix unit tests and add unit tests for path helper

DamirPorobic · DamirPorobic · commit 3965647d4e7b · 2020-05-31T10:55:22.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -67,4 +67,7 @@ perf.data*
 
 # clion
 *.idea
-*.idea/
+*.idea/
+
+# misc
+.directory
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -61,7 +61,7 @@ set(KIMAGEANNOTATOR_SRCS
 	${CMAKE_CURRENT_SOURCE_DIR}/annotations/items/helper/TextCursor.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/annotations/items/helper/CapsLockStatusChecker.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/annotations/items/helper/NumberRectHelper.cpp
-	${CMAKE_CURRENT_SOURCE_DIR}/annotations/items/helper/ShapeHelper.cpp
+	${CMAKE_CURRENT_SOURCE_DIR}/annotations/items/helper/AnnotationShapeCreator.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/annotations/undo/AddCommand.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/annotations/undo/DeleteCommand.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/annotations/undo/MoveCommand.cpp
diff --git a/src/annotations/items/AnnotationArrow.cpp b/src/annotations/items/AnnotationArrow.cpp
@@ -40,8 +40,8 @@ void AnnotationArrow::updateShape()
 	QLineF shaft(*mLine);
 	shaft.setLength(shaft.length() - 5);
 
-	auto arrow = ShapeHelper::createArrowHead(properties()->width() / 2);
-	arrow = ShapeHelper::translate(arrow, mLine->p2(), -mLine->angle());
+	auto arrow = AnnotationShapeCreator::createArrowHead(properties()->width() / 2);
+	arrow = AnnotationShapeCreator::translate(arrow, mLine->p2(), -mLine->angle());
 
 	QPainterPath path(shaft.p1());
 	path.lineTo(shaft.p2());
diff --git a/src/annotations/items/AnnotationArrow.h b/src/annotations/items/AnnotationArrow.h
@@ -21,7 +21,7 @@
 #define KIMAGEANNOTATOR_ANNOTATIONARROW_H
 
 #include "src/annotations/items/AbstractAnnotationLine.h"
-#include "src/annotations/items/helper/ShapeHelper.h"
+#include "src/annotations/items/helper/AnnotationShapeCreator.h"
 
 namespace kImageAnnotator {
 
diff --git a/src/annotations/items/AnnotationDoubleArrow.cpp b/src/annotations/items/AnnotationDoubleArrow.cpp
@@ -43,9 +43,9 @@ void AnnotationDoubleArrow::updateShape()
 	shaft.setPoints(shaft.p2(), shaft.p1());
 	shaft.setLength(shaft.length() - 5);
 
-	auto arrow = ShapeHelper::createArrowHead(properties()->width() / 2);
-	auto startArrowHead = ShapeHelper::translate(arrow, mLine->p2(), -mLine->angle());
-	auto endArrowHead = ShapeHelper::translate(arrow, mLine->p1(), -mLine->angle() + 180);
+	auto arrow = AnnotationShapeCreator::createArrowHead(properties()->width() / 2);
+	auto startArrowHead = AnnotationShapeCreator::translate(arrow, mLine->p2(), -mLine->angle());
+	auto endArrowHead = AnnotationShapeCreator::translate(arrow, mLine->p1(), -mLine->angle() + 180);
 
 	QPainterPath path(shaft.p1());
 	path.lineTo(shaft.p2());
diff --git a/src/annotations/items/AnnotationNumberPointer.cpp b/src/annotations/items/AnnotationNumberPointer.cpp
@@ -76,8 +76,8 @@ void AnnotationNumberPointer::updateShape()
 	mRect->moveCenter(mLine->p1());
 	BaseAnnotationNumber::updateRect(mRect, textProperties()->font());
 
-	auto pointer = ShapeHelper::createPointer(mRect->width() * 0.7, mLine->length());
-	auto finishedPointer = ShapeHelper::translate(pointer, mLine->p2(), -mLine->angle());
+	auto pointer = AnnotationShapeCreator::createPointer(mRect->width() * 0.7, mLine->length());
+	auto finishedPointer = AnnotationShapeCreator::translate(pointer, mLine->p2(), -mLine->angle());
 
 	QPainterPath path(mLine->p1());
 	path.setFillRule(Qt::WindingFill);
diff --git a/src/annotations/items/AnnotationNumberPointer.h b/src/annotations/items/AnnotationNumberPointer.h
@@ -22,7 +22,7 @@
 
 #include "src/annotations/items/AbstractAnnotationLine.h"
 #include "src/annotations/items/BaseAnnotationNumber.h"
-#include "src/annotations/items/helper/ShapeHelper.h"
+#include "src/annotations/items/helper/AnnotationShapeCreator.h"
 #include "src/annotations/properties/AnnotationTextProperties.h"
 
 namespace kImageAnnotator {
diff --git a/src/annotations/items/helper/AnnotationShapeCreator.cpp b/src/annotations/items/helper/AnnotationShapeCreator.cpp
@@ -17,11 +17,11 @@
  * Boston, MA 02110-1301, USA.
  */
 
-#include "ShapeHelper.h"
+#include "AnnotationShapeCreator.h"
 
 namespace kImageAnnotator {
 
-QPolygonF ShapeHelper::createPointer(qreal width, qreal length)
+QPolygonF AnnotationShapeCreator::createPointer(qreal width, qreal length)
 {
 	QPointF p0(0, 0);
 	QPointF p1(-length, width / 2);
@@ -31,7 +31,7 @@ QPolygonF ShapeHelper::createPointer(qreal width, qreal length)
 	return pointer << p0 << p1 << p2 << p0;
 }
 
-QPolygonF ShapeHelper::createArrowHead(int scaleFactor)
+QPolygonF AnnotationShapeCreator::createArrowHead(int scaleFactor)
 {
 	auto arrowHeadLength = 15 + scaleFactor;
 	auto arrowHeadWidth = 5 + scaleFactor;
@@ -46,7 +46,7 @@ QPolygonF ShapeHelper::createArrowHead(int scaleFactor)
 	return arrow << p0 << p1 << p2 << p3 << p0;
 }
 
-QPolygonF ShapeHelper::translate(const QPolygonF &shape, const QPointF &pos, qreal angle)
+QPolygonF AnnotationShapeCreator::translate(const QPolygonF &shape, const QPointF &pos, qreal angle)
 {
 	return QTransform().translate(pos.x(), pos.y()).rotate(angle).map(shape);
 }
diff --git a/src/annotations/items/helper/AnnotationShapeCreator.h b/src/annotations/items/helper/AnnotationShapeCreator.h
@@ -17,15 +17,15 @@
  * Boston, MA 02110-1301, USA.
  */
 
-#ifndef KIMAGEANNOTATOR_SHAPEHELPER_H
-#define KIMAGEANNOTATOR_SHAPEHELPER_H
+#ifndef KIMAGEANNOTATOR_ANNOTATIONSHAPECREATOR_H
+#define KIMAGEANNOTATOR_ANNOTATIONSHAPECREATOR_H
 
 #include <QPolygonF>
 #include <QTransform>
 
 namespace kImageAnnotator {
 
-class ShapeHelper
+class AnnotationShapeCreator
 {
 public:
 	static QPolygonF createPointer(qreal width, qreal length);
@@ -35,4 +35,4 @@ class ShapeHelper
 
 } // namespace kImageAnnotator
 
-#endif //KIMAGEANNOTATOR_SHAPEHELPER_H
+#endif //KIMAGEANNOTATOR_ANNOTATIONSHAPECREATOR_H
diff --git a/src/annotations/items/helper/NumberRectHelper.h b/src/annotations/items/helper/NumberRectHelper.h
@@ -17,8 +17,8 @@
  * Boston, MA 02110-1301, USA.
  */
 
-#ifndef NUMBERRECTHELPER_H
-#define NUMBERRECTHELPER_H
+#ifndef KIMAGEANNOTATOR_NUMBERRECTHELPER_H
+#define KIMAGEANNOTATOR_NUMBERRECTHELPER_H
 
 #include <QString>
 #include <QSizeF>
@@ -41,4 +41,4 @@ class NumberRectHelper
 
 } // namespace kImageAnnotator
 
-#endif //NUMBERRECTHELPER_H
+#endif //KIMAGEANNOTATOR_NUMBERRECTHELPER_H
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -27,6 +27,7 @@ set(UNITTEST_SRC
 	common/helper/MathHelperTest.cpp
 	common/helper/ItemHelperTest.cpp
 	common/helper/ShapeHelperTest.cpp
+	common/helper/PathHelperTest.cpp
 	gui/cropper/CropSelectionRestrictorTest.cpp
 	gui/cropper/CropSelectionMoveHelperTest.cpp
 	gui/cropper/CropSelectionHandlerTest.cpp
diff --git a/tests/annotations/core/AnnotationItemFactoryTest.cpp b/tests/annotations/core/AnnotationItemFactoryTest.cpp
@@ -66,7 +66,7 @@ void AnnotationItemFactoryTest::TestCreate_Should_ReturnNullPtrForUnknownType()
 {
 	auto config = new Config;
 	auto settingsProvider = new MockSettingsProvider();
-	settingsProvider->setToolType((ToolTypes) 13);
+	settingsProvider->setToolType((ToolTypes) 14);
 	AnnotationPropertiesFactory propertiesFactory(config, settingsProvider);
 	AnnotationItemFactory itemFactory(&propertiesFactory, settingsProvider);
 
diff --git a/tests/common/helper/PathHelperTest.cpp b/tests/common/helper/PathHelperTest.cpp
@@ -0,0 +1,71 @@
+/*
+ * Copyright (C) 2020 Damir Porobic <damir.porobic@gmx.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include "PathHelperTest.h"
+
+void PathHelperTest::TestExtractFilename_Should_ReturnOnlyFilename_When_FilenameHasFormat()
+{
+	auto expected = QStringLiteral("myFile");
+	auto filename = PathHelper::extractFilename(QStringLiteral("/home/kimageannotator/") + expected + QStringLiteral(".png"));
+
+	QCOMPARE(filename, expected);
+}
+
+void PathHelperTest::TestExtractFilename_Should_ReturnOnlyFilename_When_FilenameHasNoFormat()
+{
+	auto expected = QStringLiteral("myFile");
+	auto filename = PathHelper::extractFilename(QStringLiteral("/home/kimageannotator/") + expected);
+
+	QCOMPARE(filename, expected);
+}
+
+void PathHelperTest::TestExtractFilename_Should_ReturnOnlyFilename_When_FilenameWithoutPathWasProvided()
+{
+	auto expected = QStringLiteral("myFile");
+	auto filename = PathHelper::extractFilename(expected);
+
+	QCOMPARE(filename, expected);
+}
+
+void PathHelperTest::TestExtractFilenameWithFormat_Should_ReturnOnlyFilename_When_FilenameHasFormat()
+{
+	auto expected = QStringLiteral("myFile.png");
+	auto filename = PathHelper::extractFilenameWithFormat(QStringLiteral("/home/kimageannotator/") + expected);
+
+	QCOMPARE(filename, expected);
+}
+
+void PathHelperTest::TestExtractFilenameWithFormat_Should_ReturnOnlyFilename_When_FilenameWithoutPathWasProvided()
+{
+	auto expected = QStringLiteral("myFile.png");
+	auto filename = PathHelper::extractFilenameWithFormat(expected);
+
+	QCOMPARE(filename, expected);
+}
+
+void PathHelperTest::TestPrettyFilename_Should_ReplaceUnderscoresWithSpacesAndCapitalizeFirstLetters()
+{
+	auto input = QStringLiteral("my_test_File.png");
+	auto expected = QStringLiteral("My Test File.png");
+	auto filename = PathHelper::prettyFilename(input);
+
+	QCOMPARE(filename, expected);
+}
+
+QTEST_MAIN(PathHelperTest);
diff --git a/tests/common/helper/PathHelperTest.h b/tests/common/helper/PathHelperTest.h
@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2020 Damir Porobic <damir.porobic@gmx.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef KIMAGEANNOTATOR_PATHHELPERTEST_H
+#define KIMAGEANNOTATOR_PATHHELPERTEST_H
+
+#include <QtTest>
+
+#include "src/common/helper/PathHelper.h"
+
+using kImageAnnotator::PathHelper;
+
+class PathHelperTest : public QObject
+{
+Q_OBJECT
+private slots:
+	void TestExtractFilename_Should_ReturnOnlyFilename_When_FilenameHasFormat();
+	void TestExtractFilename_Should_ReturnOnlyFilename_When_FilenameHasNoFormat();
+	void TestExtractFilename_Should_ReturnOnlyFilename_When_FilenameWithoutPathWasProvided();
+	void TestExtractFilenameWithFormat_Should_ReturnOnlyFilename_When_FilenameHasFormat();
+	void TestExtractFilenameWithFormat_Should_ReturnOnlyFilename_When_FilenameWithoutPathWasProvided();
+	void TestPrettyFilename_Should_ReplaceUnderscoresWithSpacesAndCapitalizeFirstLetters();
+};
+
+
+#endif //KIMAGEANNOTATOR_PATHHELPERTEST_H

-Original file line number
+Diff line change
 # clion
 *.idea
 -*.idea/
 +*.idea/
++
 +# misc
 +.directory
Original file line number	Diff line number	Diff line change
`@@ -17,11 +17,11 @@`
`17`	`17`	`* Boston, MA 02110-1301, USA.`
`18`	`18`	`*/`
`19`	`19`
`20`		`-#include "ShapeHelper.h"`
	`20`	`+#include "AnnotationShapeCreator.h"`
`21`	`21`
`22`	`22`	`namespace kImageAnnotator {`
`23`	`23`
`24`		`-QPolygonF ShapeHelper::createPointer(qreal width, qreal length)`
	`24`	`+QPolygonF AnnotationShapeCreator::createPointer(qreal width, qreal length)`
`25`	`25`	`{`
`26`	`26`	`QPointF p0(0, 0);`
`27`	`27`	`QPointF p1(-length, width / 2);`
`@@ -31,7 +31,7 @@ QPolygonF ShapeHelper::createPointer(qreal width, qreal length)`
`31`	`31`	`return pointer << p0 << p1 << p2 << p0;`
`32`	`32`	`}`
`33`	`33`
`34`		`-QPolygonF ShapeHelper::createArrowHead(int scaleFactor)`
	`34`	`+QPolygonF AnnotationShapeCreator::createArrowHead(int scaleFactor)`
`35`	`35`	`{`
`36`	`36`	`auto arrowHeadLength = 15 + scaleFactor;`
`37`	`37`	`auto arrowHeadWidth = 5 + scaleFactor;`
`@@ -46,7 +46,7 @@ QPolygonF ShapeHelper::createArrowHead(int scaleFactor)`
`46`	`46`	`return arrow << p0 << p1 << p2 << p3 << p0;`
`47`	`47`	`}`
`48`	`48`
`49`		`-QPolygonF ShapeHelper::translate(const QPolygonF &shape, const QPointF &pos, qreal angle)`
	`49`	`+QPolygonF AnnotationShapeCreator::translate(const QPolygonF &shape, const QPointF &pos, qreal angle)`
`50`	`50`	`{`
`51`	`51`	`return QTransform().translate(pos.x(), pos.y()).rotate(angle).map(shape);`
`52`	`52`	`}`