版本

一个支持主版本号、（可选）次版本号、（可选）补丁版本号和（可选）构建版本号的 NumericalVersioning 类。

为什么？

我需要解析来自 JSON 和 XML 编码文件的版本字符串，这些字符串需要满足以下要求…

可选的次版本号/补丁版本号/构建版本号字段
从字符串表示形式中提取版本，例如 "5.6.*"
使用通配符来支持简单的版本检查的能力
版本范围检查
Swift Codable 支持

此类使用数字状态版本控制方案 (major.minor.patch.build)。

请注意，您不需要提供所有字段！如果您的项目中只需要主版本号/次版本号的组合，此类也可以很好地工作。

TL;DR：简单例子

let lowerBound = Version(10,4)
let upperBound = Version(10,5)

assert(lowerBound < upperBound)

// Simple checks to see version ordering
let testValue = Version(10,4,5,1001)
assert(testValue > lowerBound)
assert(upperBound > testValue)

// Read from somewhere, and try to convert to a version definition
let strVer = "10.4.5"
let myVersion = try Version(strVer)   // Throws if strVer isn't a compatible version string

assert(myVersion.major.rawValue == 10)
assert(myVersion.minor.rawValue == 4)
assert(myVersion.patch.rawValue == 5)

// Simple comparison to verify if 'myVersion' is greater than our lower bound
assert(lowerBound < myVersion)

// See whether 'myVersion' was within our required version range
let range = lowerBound ..< upperBound
assert(range.contains(myVersion))

集成

使用 Swift Package Manager 将 https://github.com/dagronf/DSFVersion 添加到您的项目。

规则

构造时未提供的字段被假定为 0。

Version(10,4) ⟺ Version(10,4,0) ⟺ Version(10,4,0,0)
Version("5.6.3") ⟺ Version(5,6,3,0) ⟺ Version(5,6,3)

分配给 `UInt.wildcard` 的字段被定义为通配符 (*)

通配符将与其自身的位置和任何较低有效的位置匹配

Version("14.7.*") ⟺ Version(14, 7, .wildcard)

Version(1, .wildcard).contains(Version(1, 1, 101))             // 1.* contains 1.1.101
Version(6, 0, 0, .wildcard).contains(Version(6, 0, 0, 101))    // 6.0.0.* contains 6.0.0.101

一旦找到通配符，任何较低有效的位置都将被忽略。

Version(1, .wildcard, 1, 101) ⟺ Version(1, .wildcard)                // 1.*.1.101 is equivalent to 1.*

创建

简单

let v1 = Version(1)                  // 1
let v2 = Version(2, 56)              // 2.56
let v3 = Version(15, 3, 4)           // 15.3.4
let v4 = Version(15, 3, 4, 10001)    // 15.3.4.10001

assert(v4.major.value == 15)
assert(v4.patch.value == 4)

通配符

通配符值在构造期间指定为 UInt.wildcard

let w1 = Version(1, .wildcard)           // 1.*
let w2 = Version(1, 15, 9, .wildcard)    // 1.15.9.*

从字符串解析

// Version constructor throws if provided an incorrect version string
let v1   = try Version("10.2.3.*")      // OK
let v1_e = try Version("10..2.3.*")     // Throws VersionError.InvalidVersionString
let v2_e = try Version("1.2.0-rc.3")    // Throws VersionError.InvalidVersionString

let v3   = try Version("15.4.3")        // OK
let v3_e = try Version("15.a4.3")       // returns nil

相等

简单

try Version("4.5.6") == Version(4,5,6)
try Version("12.4.0") == Version(12,4)

通配符匹配从通配符位置开始的任何值

Version(4,.wildcard) == Version(4,5,6)    // 4.* == 4.5.6
Version(4,5,6) == Version(4,.wildcard)    // 4.5.6 == 4.*
Version(4,5,6) == Version(4,5,.wildcard)  // 4.5.6 == 4.5.*

比较

版本类支持标准运算符 <、>、==、!=、>=、<=

// Basic comparison

let v0 = Version(10, 4)
let v1 = Version(10, 4, 4)
assert(v1 >= v0)             // v1 is a later version number

// Wildcard comparison

let v3 = Version(10, 4, .wildcard)
v3.contains(v0)              // 10.4.* contains the value 10.4

let v4 = Version(10, 5, .wildcard)
!v4.contains(v0)              // 10.5.* DOES NOT contain the value 10.4

范围

您可以将标准 Swift 范围运算符用于版本检查

let range = Version(1,0) ..< Version(1,2)
XCTAssertTrue(range.contains(Version(1,1)))

闭合范围 Through (包含)

一个包含上限的范围

let range = Version(4) ... Version(5)
   
range.contains(Version(4))       // YES
range.contains(Version(4,5,3))   // YES
range.contains(Version(5))       // YES
range.contains(Version(5,1))     // NO

闭合范围 Up To (不包含)

一个不包含上限的范围

let rangeUpTo = Version(4) ..< Version(5)

range.contains(Version(3,9,100))  // NO
range.contains(Version(4))        // YES
range.contains(Version(4,5,3))    // YES
range.contains(Version(5))        // NO

部分范围支持

let rangeAfter = Version(1,2) ...                   // All version numbers AFTER and including 1.2
assert(rangeAfter.contains(Version(1,2,0))
assert(rangeAfter.contains(Version(3,2))

let rangeBeforeInclusive = ... Version(7,8,1)       // All version numbers BEFORE and including 7.8.1
let rangeBeforeNonInclusive = ..< Version(7,8,1)    // All version numbers BEFORE not including 7.8.1

增量器

简单的增量支持。

let vv12 = Version(1,2)                 // Start with v1.2

let vv1201 = try vv12.increment(.build)    // Move to v1.2.0.1
assert(vv1201 == Version(1,2,0,1))

let vv121 = try vv1201.increment(.patch)   // Move from v1.2.0.1 -> v1.2.1
assert(vv121 == Version(1,2,1))

let vv13 = try vv121.increment(.minor)     // Move from v1.2.1 -> v1.3
assert(vv13 == Version(1,3))

let vv2 = try vv13.increment(.major)       // Move from v1.3 -> v2.0
assert(vv2 == Version(2))

Codable 支持

Version 完全可编码，因此您可以在可编码的结构体/类中使用 Version 对象。

编码后的值是版本的字符串版本（例如 "15.3.*"），以便在编码文本中可以轻松清晰地解释它。

let v1 = Version(55, .wildcard)
let data1 = try JSONEncoder().encode(v1)
// Data contains "55.*"

let v2 = Version(1,3,4,9)
let data2 = try JSONEncoder().encode(v1)
// Data contains "1.3.4.9"
let v2rec = try JSONDecoder().decode(Version.self, from: data2)
XCTAssertEqual(v2, v2rec)

许可

MIT License

Copyright (c) 2024 Darren Ford

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.

版本