marko/semver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Implement relational operators on Basic_version class; Improve documentation; Fix bug in parser regarding prerelease token treatment on transition between prerelease and build parsing; Add unit tests for missing cases

Browse Source
This commit is contained in:
Marko Zivanovic
2015-10-08 23:27:01 +02:00
parent 1cc5568547
commit 284aa77e13
10 changed files with 155 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CMakeLists.txt
+1
View File
@@ -37,3 +37,4 @@ add_subdirectory(test)
enable_testing()
add_test(NAME semver200_parser_tests COMMAND semver200_parser_tests)
add_test(NAME semver200_comparator_tests COMMAND semver200_comparator_tests)
add_test(NAME semver200_version_tests COMMAND semver200_version_tests)
include/version.h
+70 -18
View File
@@ -24,11 +24,17 @@ SOFTWARE.
#pragma once
#include <iosfwd>
#include <string>
#include <vector>
namespace version {
/// Parse_error is thrown on all parsing and validation errors.
class Parse_error : public std::runtime_error {
using std::runtime_error::runtime_error;
};
/// Type of prerelease identifier: alphanumeric or numeric.
/**
Type of identifier affects comparison: alphanumeric identifiers are compared as ASCII strings, while
@@ -69,23 +75,46 @@ namespace version {
Build_identifiers build_ids;
};
/// Generic version class. Specializations are used to perform usefull work.
/// Generic version description and comparison class.
/**
This class describes general version object without prescribing parsing, validation and comparison rules.
These rules are contained in Parser and Comparator objects provided.
Basic_version class describes general version object without prescribing parsing,
validation and comparison rules. These rules are implemented by supplied Parser and
Comparator parameters.
*/
template<typename Parser, typename Comparator>
class Basic_version {
public:
/// Construct Basic_version object using Parser to parse version string and Comparator for comparison.
Basic_version(const std::string&, Parser, Comparator);
Basic_version(const std::string& v, Parser p, Comparator c)
: parser_{ p }, comparator_{ c }, ver_{ parser_.parse(v) } {};
bool operator>(const Basic_version&);
bool operator>=(const Basic_version&);
bool operator<(const Basic_version&);
bool operator<=(const Basic_version&);
bool operator==(const Basic_version&);
bool operator!=(const Basic_version&);
/// Compare if left version object is less than the right.
friend bool operator<(const Basic_version& l, const Basic_version& r) {
return l.comparator_.compare(l.ver_, r.ver_) == -1;
}
/// Compare if two version objects are equal.
friend bool operator==(const Basic_version& l, const Basic_version& r) {
return l.comparator_.compare(l.ver_, r.ver_) == 0;
}
/// Output version object to stream using standard semver format (X.Y.Z-PR+B).
friend std::ostream& operator<<(std::ostream& os, const Basic_version& v) {
os << v.ver_.major << "." << v.ver_.minor << "." << v.ver_.patch;
if (!v.ver_.prerelease_ids.empty()) {
os << "-";
for (auto& it = v.ver_.prerelease_ids.cbegin(); it < v.ver_.prerelease_ids.cend() - 1; ++it) {
os << it->first << ".";
}
os << v.ver_.prerelease_ids.crbegin()->first;
}
if (!v.ver_.build_ids.empty()) {
os << "+";
for (auto& it = v.ver_.build_ids.cbegin(); it < v.ver_.build_ids.cend() - 1; ++it) {
os << *it << ".";
}
os << *v.ver_.build_ids.crbegin();
}
return os;
}
private:
Parser parser_;
@@ -95,20 +124,43 @@ namespace version {
/// Parse string into Version_data structure according to semantic versioning 2.0.0 rules.
struct Semver200_parser {
Version_data parse(const std::string&);
Version_data parse(const std::string&) const;
};
/// Compare Version_data to another using semantic versioning 2.0.0 rules.
struct Semver200_comparator {
int compare(const Version_data&, const Version_data&);
int compare(const Version_data&, const Version_data&) const;
};
/// Concrete Basic_version class that binds all semver 2.0.0 functionality together.
class Semver200 : public Basic_version<Semver200_parser, Semver200_comparator> {};
/// Parse_error is thrown on all parsing and validation errors.
class Parse_error : public std::runtime_error {
using std::runtime_error::runtime_error;
/// Concrete version class that binds all semver 2.0.0 functionality together.
class Semver200_version : public Basic_version<Semver200_parser, Semver200_comparator> {
public:
Semver200_version(const std::string& v)
: Basic_version{ v, Semver200_parser(), Semver200_comparator() } {}
};
/// Compare if two version objects are different.
template<typename P, typename C>
inline bool operator!=(const Basic_version<P, C>& l, const Basic_version<P, C>& r) {
return !(l == r);
}
/// Compare if left version object is greater than the right.
template<typename P, typename C>
inline bool operator>(const Basic_version<P, C>& l, const Basic_version<P, C>& r) {
return r < l;
}
/// Compare if left version object is greater than or equal the right.
template<typename P, typename C>
inline bool operator>=(const Basic_version<P, C>& l, const Basic_version<P, C>& r) {
return !(l < r);
}
/// Compare if left version object is less than or equal the right.
template<typename P, typename C>
inline bool operator<=(const Basic_version<P, C>& l, const Basic_version<P, C>& r) {
return !(l > r);
}
}
src/CMakeLists.txt
+1 -1
View File
@@ -3,5 +3,5 @@ include_directories(
)
add_library(semver
Semver200_parser.cpp Semver200_comparator.cpp
Semver200_comparator.cpp Semver200_parser.cpp
)
src/Semver200_comparator.cpp
+1 -1
View File
@@ -61,7 +61,7 @@ namespace {
namespace version {
int Semver200_comparator::compare(const Version_data& l, const Version_data& r) {
int Semver200_comparator::compare(const Version_data& l, const Version_data& r) const {
int cmp = compare_normal(l, r);
if (cmp != 0) return cmp;
src/Semver200_parser.cpp
+2 -2
View File
@@ -44,9 +44,9 @@ namespace {
const vector<Transition>& transitions, string& target, Validator validate) {
for (const auto& t : transitions) {
if (c == get<0>(t)) {
if (get<2>(t)) get<2>(t)(target);
prev_phase = phase;
phase = get<1>(t);
if (get<2>(t)) get<2>(t)(target);
return;
}
}
@@ -76,7 +76,7 @@ namespace {
namespace version {
Version_data Semver200_parser::parse(const string& s) {
Version_data Semver200_parser::parse(const string& s) const {
string major;
string minor;
string patch;
test/CMakeLists.txt
+6 -1
View File
@@ -2,7 +2,6 @@ set(Boost_USE_STATIC_LIBS ON)
set(Boost_USE_MULTITHREADED ON)
find_package(Boost COMPONENTS unit_test_framework)
#find_package(Threads)
include_directories(../include)
@@ -21,3 +20,9 @@ target_link_libraries(semver200_comparator_tests
${Boost_UNIT_TEST_FRAMEWORK_LIBRARY}
semver
)
add_executable(semver200_version_tests semver200_version_tests.cpp)
target_link_libraries(semver200_version_tests
${Boost_UNIT_TEST_FRAMEWORK_LIBRARY}
semver
)
test/semver200_comparator_tests.cpp
+2 -2
View File
@@ -38,9 +38,9 @@ inline int compare(const std::string& l, const std::string& r) {
return c.compare(lv, rv);
}
#define GT(L, R) BOOST_CHECK(compare(L, R) > 0)
#define GT(L, R) BOOST_CHECK(compare(L, R) > 0)
#define GE(L, R) BOOST_CHECK(compare(L, R) >= 0)
#define LT(L, R) BOOST_CHECK(compare(L, R) < 0)
#define LT(L, R) BOOST_CHECK(compare(L, R) < 0)
#define LE(L, R) BOOST_CHECK(compare(L, R) <= 0)
#define EQ(L, R) BOOST_CHECK(compare(L, R) == 0)
test/semver200_parser_tests.cpp
+5 -1
View File
@@ -122,11 +122,15 @@ BOOST_AUTO_TEST_CASE(parse_build_empty_ids) {
// optional prerel must come after patch and build after prerel
BOOST_AUTO_TEST_CASE(parse_prerel_build_order) {
CHECK_PREREL_BUILD("1.2.3-r4+b5", 1, 2, 3, Prerelease_identifiers({ {"r4",A} }), Build_identifiers({ "b5" }));
CHECK_PREREL_BUILD("1.2.3+b4-r5",1,2,3, no_rel_ids, Build_identifiers({ "b4-r5" }));
CHECK_PREREL_BUILD("1.2.3+b4-r5", 1, 2, 3, no_rel_ids, Build_identifiers({ "b4-r5" }));
}
// check some corner cases
BOOST_AUTO_TEST_CASE(parse_corner_cases) {
CHECK_PARSE_ERROR("1.2.3-r4.+b5");
CHECK_PARSE_ERROR("1.2.3-r4+b5.");
CHECK_PREREL_BUILD("1.2.3-alpha+build.314", 1, 2, 3, Prerelease_identifiers({ {"alpha", A} }),
Build_identifiers({ "build","314" }));
}
test/semver200_validator_tests.cpp
-31
View File
@@ -1,31 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2015 Marko Zivanovic
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#define BOOST_TEST_MODULE semver200_validator_tests
#include <boost/test/unit_test.hpp>
#include "version.h"
using namespace version;
test/semver200_version_tests.cpp
+67
View File
@@ -0,0 +1,67 @@
/*
The MIT License (MIT)
Copyright (c) 2015 Marko Zivanovic
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#define BOOST_TEST_MODULE semver200_version_tests
#include <boost/test/unit_test.hpp>
#include "version.h"
using namespace version;
using v = Semver200_version;
/// Check parsing logic by performing roundtrip - parse string to version object, then
/// generate string from that object and check if it's identical to source.
#define CHECK_RT(SRC) { \
std::stringstream ss; \
ss << v(SRC); \
BOOST_CHECK_EQUAL(ss.str(), SRC); \
}
BOOST_AUTO_TEST_CASE(test_relational_operators) {
BOOST_CHECK(v("1.0.0-alpha") < v("1.0.0-alpha.1"));
BOOST_CHECK(v("1.0.0-alpha.1") < v("1.0.0-alpha.beta"));
BOOST_CHECK(v("1.0.0-alpha.beta") < v("1.0.0-beta"));
BOOST_CHECK(v("1.0.0-beta") < v("1.0.0-beta.2"));
BOOST_CHECK(v("1.0.0-beta.2") < v("1.0.0-beta.11"));
BOOST_CHECK(v("1.0.0-beta.11") < v("1.0.0-rc.1"));
BOOST_CHECK(v("1.0.0-rc.1") < v("1.0.0"));
BOOST_CHECK(v("1.0.0+rc.1") == v("1.0.0+rc22"));
BOOST_CHECK(v("1.0.0+rc.1") != v("1.0.0-rc22"));
BOOST_CHECK(v("1.0.0") >= v("1.0.0"));
BOOST_CHECK(v("1.0.0") >= v("0.0.9"));
}
BOOST_AUTO_TEST_CASE(test_ostream_output) {
CHECK_RT("1.2.3");
CHECK_RT("1.2.3-alpha");
CHECK_RT("1.2.3-alpha.1.2.3");
CHECK_RT("1.2.3+build.1.2.3");
CHECK_RT("1.2.3-alpha+build.314");
CHECK_RT("1.2.3-alpha.1+build.314");
CHECK_RT("1.2.3-alpha.1.2.3+build.314");
}