RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 14:57:34 +00:00
Code Issues Activity Actions

Libraries: Implement SemVer for version parsing and comparisons

Browse source 
Semantic Versioning (SemVer) is a versioning scheme for software that
uses MAJOR.MINOR.PATCH format. MAJOR for significant, possibly
breaking changes; MINOR for backward-compatible additions; PATCH for
bug fixes. It aids communication, compatibility prediction, and
dependency management. In apps dependent on specific library versions,
SemVer guides parsing and validates compatibility, ensuring apps use
appropriate dependencies.

    <valid semver> ::= <version core>
                     | <version core> "-" <pre-release>
                     | <version core> "+" <build>
                     | <version core> "-" <pre-release> "+" <build>
This commit is contained in:
Gurkirat Singh 2023-12-21 15:49:11 +05:30 • committed by Tim Schumacher
parent 14200de80b
commit ee639fa1df
8 changed files with 770 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

100
Userland/Libraries/LibSemVer/SemVer.h Normal file
View file

@ -0,0 +1,100 @@
/*
* Copyright (c) 2023, Gurkirat Singh <tbhaxor@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Error.h>
#include <AK/Format.h>
#include <AK/String.h>
#include <AK/StringView.h>
#include <AK/Types.h>
namespace SemVer {
enum class BumpType {
Major,
Minor,
Patch,
Prerelease,
};
enum class CompareType {
Exact,
Major,
Minor,
Patch
};
class SemVer {
public:
SemVer(u64 major, u64 minor, u64 patch, char m_number_separator)
: m_number_separator(m_number_separator)
, m_major(major)
, m_minor(minor)
, m_patch(patch)
{
}
SemVer(u64 major, u64 minor, u64 patch, char m_number_separator, Vector<String> const& prereleases, Vector<String> const& build_metadata)
: m_number_separator(m_number_separator)
, m_major(major)
, m_minor(minor)
, m_patch(patch)
, m_prerelease_identifiers(prereleases)
, m_build_metadata_identifiers(build_metadata)
{
}
[[nodiscard]] u64 major() const { return m_major; }
[[nodiscard]] u64 minor() const { return m_minor; }
[[nodiscard]] u64 patch() const { return m_patch; }
[[nodiscard]] ReadonlySpan<String> prerelease_identifiers() const { return m_prerelease_identifiers.span(); }
[[nodiscard]] String prerelease() const
{
return String::join('.', m_prerelease_identifiers).release_value_but_fixme_should_propagate_errors();
}
[[nodiscard]] ReadonlySpan<String> build_metadata_identifiers() const { return m_build_metadata_identifiers.span(); }
[[nodiscard]] String build_metadata() const { return String::join('.', m_build_metadata_identifiers).release_value_but_fixme_should_propagate_errors(); }
[[nodiscard]] SemVer bump(BumpType) const;
[[nodiscard]] bool is_same(SemVer const&, CompareType = CompareType::Exact) const;
[[nodiscard]] bool is_greater_than(SemVer const&) const;
[[nodiscard]] bool is_lesser_than(SemVer const& other) const { return !is_same(other) && !is_greater_than(other); }
[[nodiscard]] bool operator==(SemVer const& other) const { return is_same(other); }
[[nodiscard]] bool operator!=(SemVer const& other) const { return !is_same(other); }
[[nodiscard]] bool operator>(SemVer const& other) const { return is_lesser_than(other); }
[[nodiscard]] bool operator<(SemVer const& other) const { return is_greater_than(other); }
[[nodiscard]] bool operator>=(SemVer const& other) const { return *this == other || *this > other; }
[[nodiscard]] bool operator<=(SemVer const& other) const { return *this == other || *this < other; }
[[nodiscard]] bool satisfies(StringView const& semver_spec) const;
[[nodiscard]] String suffix() const;
[[nodiscard]] String to_string() const;
private:
char m_number_separator;
u64 m_major;
u64 m_minor;
u64 m_patch;
Vector<String> m_prerelease_identifiers;
Vector<String> m_build_metadata_identifiers;
};
ErrorOr<SemVer> from_string_view(StringView const&, char normal_version_separator = '.');
bool is_valid(StringView const&, char normal_version_separator = '.');
}
template<>
struct AK::Formatter<SemVer::SemVer> : Formatter<String> {
ErrorOr<void> format(FormatBuilder& builder, SemVer::SemVer const& value)
{
return Formatter<String>::format(builder, value.to_string());
}
};