3.0.1

.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "friday"
+      timezone: "Australia/Sydney"
+    target-branch: "develop"
+
+  - package-ecosystem: "gitsubmodule"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "friday"
+      timezone: "Australia/Sydney"
+    target-branch: "develop"

.github/workflows/swift.yml → .github/workflows/build-and-test.yml

@@ -1,4 +1,4 @@
-name: Swift
+name: Build and Test
 
 on:
   push:

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: Lint
+
+on:
+  push:
+    branches: [ "master", "develop" ]
+  pull_request:
+    branches: [ "master", "develop" ]
+
+jobs:
+  SwiftLint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: irgaly/setup-mint@v1
+    - name: SwiftLint
+      run: mint run swiftlint --strict
+  SwiftFormat:
+    runs-on: ubuntu-latest
+    needs: SwiftLint
+    steps:
+    - uses: actions/checkout@v3
+    - uses: irgaly/setup-mint@v1
+    - name: SwiftFormat Lint
+      run: mint run swiftformat --lint .

.swiftformat

@@ -0,0 +1,11 @@
+--swiftversion 5.7
+--exclude .build
+
+# rules
+--disable redundantReturn
+--disable andOperator
+--disable wrapMultilineStatementBraces
+
+# format options
+--closingparen same-line
+--nospaceoperators ..<, ...

.swiftlint.yml

@@ -1,17 +1,12 @@
 disabled_rules:
   - line_length
-  - function_body_length
   - trailing_comma
+  - redundant_optional_initialization
 
 opt_in_rules:
 
 included:
 
 excluded:
-
-identifier_name:
-  min_length: 1
+  .build
 
-cyclomatic_complexity:
-  warning: 12
-  error: 20

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+<a name="3.0.1"></a>
+# [3.0.1](https://github.com/SwiftScream/URITemplate/compare/3.0.0...3.0.1) (2023-01-08)
+
+- Add SwiftLint, SwiftFormat, Dependabot
+
+
 <a name="3.0.0"></a>
 # [3.0.0](https://github.com/SwiftScream/URITemplate/compare/2.1.0...3.0.0) (2023-01-02)
 

Mintfile

@@ -0,0 +1,2 @@
+realm/SwiftLint
+nicklockwood/SwiftFormat

Package.swift

@@ -29,5 +29,4 @@ let package = Package(
             name: "ScreamURITemplateExample",
             dependencies: ["ScreamURITemplate"]),
     ],
-    swiftLanguageVersions: [.v5]
-)
+    swiftLanguageVersions: [.v5])

Sources/ScreamURITemplate/Internal/Components.swift

@@ -27,7 +27,7 @@ extension Component {
 
 internal struct LiteralComponent: Component {
     let literal: Substring
-    init (_ string: Substring) {
+    init(_ string: Substring) {
         literal = string
     }
 
@@ -42,7 +42,7 @@ internal struct LiteralComponent: Component {
 
 internal struct LiteralPercentEncodedTripletComponent: Component {
     let literal: Substring
-    init (_ string: Substring) {
+    init(_ string: Substring) {
         literal = string
     }
 
@@ -56,12 +56,13 @@ internal struct ExpressionComponent: Component {
     let variableList: [VariableSpec]
     let templatePosition: String.Index
 
-    init (expressionOperator: ExpressionOperator, variableList: [VariableSpec], templatePosition: String.Index) {
+    init(expressionOperator: ExpressionOperator, variableList: [VariableSpec], templatePosition: String.Index) {
         self.expressionOperator = expressionOperator
         self.variableList = variableList
         self.templatePosition = templatePosition
     }
 
+    // swiftlint:disable:next cyclomatic_complexity
     func expand(variables: [String: VariableValue]) throws -> String {
         let configuration = expressionOperator.expansionConfiguration()
         let expansions = try variableList.compactMap { variableSpec -> String? in
@@ -92,7 +93,7 @@ internal struct ExpressionComponent: Component {
                 } else {
                     throw FormatError.failure(reason: "Invalid Value Type")
                 }
-            } catch FormatError.failure(let reason) {
+            } catch let FormatError.failure(reason) {
                 throw URITemplate.Error.expansionFailure(position: templatePosition, reason: "Failed expanding variable \"\(variableSpec.name)\": \(reason)")
             }
         }

Sources/ScreamURITemplate/Internal/Scanner.swift

@@ -25,8 +25,8 @@ internal struct Scanner {
 
     public init(string: String) {
         self.string = string
-        self.unicodeScalars = string.unicodeScalars
-        self.currentIndex = string.startIndex
+        unicodeScalars = string.unicodeScalars
+        currentIndex = string.startIndex
     }
 
     public var isComplete: Bool {
@@ -62,10 +62,10 @@ internal struct Scanner {
     private mutating func scanExpressionOperator() throws -> ExpressionOperator {
         let expressionOperator: ExpressionOperator
         if expressionOperatorCharacterSet.contains(unicodeScalars[currentIndex]) {
-            guard let op = ExpressionOperator(rawValue: unicodeScalars[currentIndex]) else {
+            guard let `operator` = ExpressionOperator(rawValue: unicodeScalars[currentIndex]) else {
                 throw URITemplate.Error.malformedTemplate(position: currentIndex, reason: "Unsupported Operator")
             }
-            expressionOperator = op
+            expressionOperator = `operator`
             currentIndex = unicodeScalars.index(after: currentIndex)
         } else {
             expressionOperator = .simple
@@ -119,7 +119,7 @@ internal struct Scanner {
             let secondIndex = remainingVariableName.index(after: index)
             let thirdIndex = remainingVariableName.index(after: secondIndex)
             if !hexCharacterSet.contains(unicodeScalars[secondIndex]) ||
-               !hexCharacterSet.contains(unicodeScalars[thirdIndex]) {
+                !hexCharacterSet.contains(unicodeScalars[thirdIndex]) {
                 throw URITemplate.Error.malformedTemplate(position: currentIndex, reason: "% must be percent-encoded in variable name")
             }
             let nextIndex = remainingVariableName.index(after: thirdIndex)
@@ -151,7 +151,7 @@ internal struct Scanner {
                 throw URITemplate.Error.malformedTemplate(position: currentIndex, reason: "Cannot parse prefix modifier length")
             }
             currentIndex = endIndex
-            return .prefix(length:length)
+            return .prefix(length: length)
         default:
             return .none
         }
@@ -174,7 +174,7 @@ internal struct Scanner {
         let thirdIndex = unicodeScalars.index(after: secondIndex)
 
         if !hexCharacterSet.contains(unicodeScalars[secondIndex]) ||
-           !hexCharacterSet.contains(unicodeScalars[thirdIndex]) {
+            !hexCharacterSet.contains(unicodeScalars[thirdIndex]) {
             throw URITemplate.Error.malformedTemplate(position: currentIndex, reason: "% must be percent-encoded in literal")
         }
 

Sources/ScreamURITemplate/Internal/ValueFormatting.swift

@@ -15,7 +15,6 @@
 import Foundation
 
 internal enum FormatError: Error {
-    //swiftlint:disable:next identifier_name superfluous_disable_command
     case failure(reason: String)
 }
 
@@ -30,7 +29,7 @@ internal extension StringProtocol {
     func formatForTemplateExpansion(variableSpec: VariableSpec, expansionConfiguration: ExpansionConfiguration) throws -> String {
         let modifiedValue: String
         if let prefixLength = variableSpec.prefixLength() {
-            modifiedValue = String(self.prefix(prefixLength))
+            modifiedValue = String(prefix(prefixLength))
         } else {
             modifiedValue = String(self)
         }
@@ -48,7 +47,7 @@ internal extension StringProtocol {
 internal extension Array where Element: StringProtocol {
     func formatForTemplateExpansion(variableSpec: VariableSpec, expansionConfiguration: ExpansionConfiguration) throws -> String? {
         let separator = ","
-        let encodedExpansions = try self.map { element -> String in
+        let encodedExpansions = try map { element -> String in
             return try percentEncode(string: String(element), withAllowedCharacters: expansionConfiguration.percentEncodingAllowedCharacterSet)
         }
         if encodedExpansions.count == 0 {
@@ -66,7 +65,7 @@ internal extension Array where Element: StringProtocol {
 
     func explodeForTemplateExpansion(variableSpec: VariableSpec, expansionConfiguration: ExpansionConfiguration) throws -> String? {
         let separator = expansionConfiguration.separator
-        let encodedExpansions = try self.map { element -> String in
+        let encodedExpansions = try map { element -> String in
             let encodedElement = try percentEncode(string: String(element), withAllowedCharacters: expansionConfiguration.percentEncodingAllowedCharacterSet)
             if expansionConfiguration.named {
                 if encodedElement.isEmpty && expansionConfiguration.omittOrphanedEquals {
@@ -85,7 +84,7 @@ internal extension Array where Element: StringProtocol {
 
 internal extension Dictionary where Key: StringProtocol, Value: StringProtocol {
     func formatForTemplateExpansion(variableSpec: VariableSpec, expansionConfiguration: ExpansionConfiguration) throws -> String? {
-        let encodedExpansions = try self.map { key, value -> String in
+        let encodedExpansions = try map { key, value -> String in
             let encodedKey = try percentEncode(string: String(key), withAllowedCharacters: expansionConfiguration.percentEncodingAllowedCharacterSet)
             let encodedValue = try percentEncode(string: String(value), withAllowedCharacters: expansionConfiguration.percentEncodingAllowedCharacterSet)
             return "\(encodedKey),\(encodedValue)"
@@ -102,7 +101,7 @@ internal extension Dictionary where Key: StringProtocol, Value: StringProtocol {
 
     func explodeForTemplateExpansion(variableSpec: VariableSpec, expansionConfiguration: ExpansionConfiguration) throws -> String? {
         let separator = expansionConfiguration.separator
-        let encodedExpansions = try self.map { key, value -> String in
+        let encodedExpansions = try map { key, value -> String in
             let encodedKey = try percentEncode(string: String(key), withAllowedCharacters: expansionConfiguration.percentEncodingAllowedCharacterSet)
             let encodedValue = try percentEncode(string: String(value), withAllowedCharacters: expansionConfiguration.percentEncodingAllowedCharacterSet)
             if expansionConfiguration.named && encodedValue.isEmpty && expansionConfiguration.omittOrphanedEquals {

Sources/ScreamURITemplate/Internal/VariableSpec.swift

@@ -16,7 +16,6 @@ import Foundation
 
 internal struct VariableSpec {
     enum Modifier {
-        // swiftlint:disable:next identifier_name superfluous_disable_command
         case prefix(length: Int)
         case explode
         case none
@@ -26,7 +25,7 @@ internal struct VariableSpec {
     let modifier: Modifier
 
     func prefixLength() -> Int? {
-        guard case .prefix(let length) = self.modifier else {
+        guard case let .prefix(length) = modifier else {
             return nil
         }
         return length

Sources/ScreamURITemplate/URITemplate.swift

@@ -21,10 +21,8 @@ extension Dictionary: VariableValue where Key: StringProtocol, Value: StringProt
 
 public struct URITemplate {
     public enum Error: Swift.Error {
-        // swiftlint:disable identifier_name superfluous_disable_command
         case malformedTemplate(position: String.Index, reason: String)
         case expansionFailure(position: String.Index, reason: String)
-        // swiftlint:enable identifier_name superfluous_disable_command
     }
 
     private let string: String
@@ -63,7 +61,7 @@ extension URITemplate: CustomStringConvertible {
 
 extension URITemplate: ExpressibleByStringLiteral {
     public init(stringLiteral value: StaticString) {
-        //swiftlint:disable:next force_try
+        // swiftlint:disable:next force_try
         try! self.init(string: "\(value)")
     }
 }

Tests/ScreamURITemplateTests/JSONValue.swift

@@ -16,14 +16,12 @@ import Foundation
 
 public enum JSONValue: Decodable {
     case null
-    //swiftlint:disable identifier_name superfluous_disable_command
     case string(String)
     case int(Int)
     case double(Double)
     case bool(Bool)
     case object([String: JSONValue])
     case array([JSONValue])
-    //swiftlint:enable identifier_name superfluous_disable_command
 
     public init(from decoder: Decoder) throws {
         let container = try decoder.singleValueContainer()

Tests/ScreamURITemplateTests/TestFileTests.swift

@@ -12,11 +12,10 @@
 //   See the License for the specific language governing permissions and
 //   limitations under the License.
 
-import XCTest
 import ScreamURITemplate
+import XCTest
 
 class TestFileTests: XCTestCase {
-
     private var templateString: String!
     private var variables: [String: VariableValue]!
     private var acceptableExpansions: [String]!
@@ -42,15 +41,15 @@ class TestFileTests: XCTestCase {
             let template = try URITemplate(string: templateString)
             _ = try template.process(variables: variables)
             XCTFail("Did not throw")
-        } catch URITemplate.Error.malformedTemplate(let position, let reason) {
+        } catch let URITemplate.Error.malformedTemplate(position, reason) {
             if failReason != nil {
                 XCTAssertEqual(failReason, reason)
             }
             if failPosition != nil {
                 let characters = templateString[..<position].count
                 XCTAssertEqual(failPosition, characters)
             }
-        } catch URITemplate.Error.expansionFailure(let position, let reason) {
+        } catch let URITemplate.Error.expansionFailure(position, reason) {
             if failReason != nil {
                 XCTAssertEqual(failReason, reason)
             }
@@ -105,5 +104,4 @@ class TestFileTests: XCTestCase {
 
         return fileTestSuite
     }
-
 }