astzweig/swiftpm-mustache
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #24 from hummingbird-project/2.x.x

Browse Source 
Merge 2.x.x into main
This commit is contained in:
Adam Fowler
2024-03-08 10:53:44 +00:00
committed by GitHub
parent 6e08bcf4d2 071b182a00
commit f5177888f9
13 changed files with 72 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/api-breakage.yml vendored
View File

@@ -3,6 +3,8 @@ name: API breaking changes
on:
pull_request:
branches:
- main
jobs:
linux:

4
.github/workflows/ci.yml vendored
View File

@@ -10,6 +10,7 @@ on:
pull_request:
branches:
- main
- 2.x.x
paths:
- '**.swift'
- '**.yml'
@@ -39,9 +40,10 @@ jobs:
strategy:
matrix:
image:
- 'swift:5.6'
- 'swift:5.7'
- 'swift:5.8'
- 'swift:5.9'
- 'swiftlang/swift:nightly-5.10-jammy'
container:
image: ${{ matrix.image }}

3
.github/workflows/validate.yml vendored
View File

@@ -4,6 +4,7 @@ on:
pull_request:
branches:
- main
- 2.x.x
jobs:
validate:
@@ -16,6 +17,6 @@ jobs:
- name: Install Dependencies
run: |
brew install mint
mint install NickLockwood/SwiftFormat@0.48.17 --no-link
mint install NickLockwood/SwiftFormat@0.51.15 --no-link
- name: run script
run: ./scripts/validate.sh

3
Package.swift
View File

@@ -1,10 +1,11 @@
// swift-tools-version:5.3
// swift-tools-version:5.7
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
let package = Package(
name: "hummingbird-mustache",
platforms: [.macOS(.v10_15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6)],
products: [
.library(name: "HummingbirdMustache", targets: ["HummingbirdMustache"]),
],

2
Sources/HummingbirdMustache/ContentType.swift
View File

@@ -13,7 +13,7 @@
//===----------------------------------------------------------------------===//
/// Protocol for content types
public protocol HBMustacheContentType {
public protocol HBMustacheContentType: Sendable {
/// escape text for this content type eg for HTML replace "<" with "&lt;"
func escapeText(_ text: String) -> String
}

20
Sources/HummingbirdMustache/Context.swift
View File

@@ -19,14 +19,16 @@ struct HBMustacheContext {
let indentation: String?
let inherited: [String: HBMustacheTemplate]?
let contentType: HBMustacheContentType
let library: HBMustacheLibrary?
/// initialize context with a single objectt
init(_ object: Any) {
init(_ object: Any, library: HBMustacheLibrary? = nil) {
self.stack = [object]
self.sequenceContext = nil
self.indentation = nil
self.inherited = nil
self.contentType = HBHTMLContentType()
self.library = library
}
private init(
@@ -34,13 +36,15 @@ struct HBMustacheContext {
sequenceContext: HBMustacheSequenceContext?,
indentation: String?,
inherited: [String: HBMustacheTemplate]?,
contentType: HBMustacheContentType
contentType: HBMustacheContentType,
library: HBMustacheLibrary? = nil
) {
self.stack = stack
self.sequenceContext = sequenceContext
self.indentation = indentation
self.inherited = inherited
self.contentType = contentType
self.library = library
}
/// return context with object add to stack
@@ -52,7 +56,8 @@ struct HBMustacheContext {
sequenceContext: nil,
indentation: self.indentation,
inherited: self.inherited,
contentType: self.contentType
contentType: self.contentType,
library: self.library
)
}
@@ -79,7 +84,8 @@ struct HBMustacheContext {
sequenceContext: nil,
indentation: indentation,
inherited: inherits,
contentType: HBHTMLContentType()
contentType: HBHTMLContentType(),
library: self.library
)
}
@@ -92,7 +98,8 @@ struct HBMustacheContext {
sequenceContext: sequenceContext,
indentation: self.indentation,
inherited: self.inherited,
contentType: self.contentType
contentType: self.contentType,
library: self.library
)
}
@@ -103,7 +110,8 @@ struct HBMustacheContext {
sequenceContext: self.sequenceContext,
indentation: self.indentation,
inherited: self.inherited,
contentType: contentType
contentType: contentType,
library: self.library
)
}
}

10
Sources/HummingbirdMustache/Library+FileSystem.swift
View File

@@ -16,19 +16,20 @@ import Foundation
extension HBMustacheLibrary {
/// Load templates from a folder
func loadTemplates(from directory: String, withExtension extension: String = "mustache") throws {
static func loadTemplates(from directory: String, withExtension extension: String = "mustache") async throws -> [String: HBMustacheTemplate] {
var directory = directory
if !directory.hasSuffix("/") {
directory += "/"
}
let extWithDot = ".\(`extension`)"
let fs = FileManager()
guard let enumerator = fs.enumerator(atPath: directory) else { return }
guard let enumerator = fs.enumerator(atPath: directory) else { return [:] }
var templates: [String: HBMustacheTemplate] = [:]
for case let path as String in enumerator {
guard path.hasSuffix(extWithDot) else { continue }
guard let data = fs.contents(atPath: directory + path) else { continue }
let string = String(decoding: data, as: Unicode.UTF8.self)
let template: HBMustacheTemplate
var template: HBMustacheTemplate
do {
template = try HBMustacheTemplate(string: string)
} catch let error as HBMustacheTemplate.ParserError {
@@ -36,7 +37,8 @@ extension HBMustacheLibrary {
}
// drop ".mustache" from path to get name
let name = String(path.dropLast(extWithDot.count))
register(template, named: name)
templates[name] = template
}
return templates
}
}

25
Sources/HummingbirdMustache/Library.swift
View File

@@ -18,7 +18,7 @@
/// ```
/// {{#sequence}}{{>entry}}{{/sequence}}
/// ```
public final class HBMustacheLibrary {
public struct HBMustacheLibrary: Sendable {
/// Initialize empty library
public init() {
self.templates = [:]
@@ -30,17 +30,25 @@ public final class HBMustacheLibrary {
/// the folder is recursive and templates in subfolders will be registered with the name `subfolder/template`.
/// - Parameter directory: Directory to look for mustache templates
/// - Parameter extension: Extension of files to look for
public init(directory: String, withExtension extension: String = "mustache") throws {
self.templates = [:]
try loadTemplates(from: directory, withExtension: `extension`)
public init(templates: [String: HBMustacheTemplate]) {
self.templates = templates
}
/// Initialize library with contents of folder.
///
/// Each template is registered with the name of the file minus its extension. The search through
/// the folder is recursive and templates in subfolders will be registered with the name `subfolder/template`.
/// - Parameter directory: Directory to look for mustache templates
/// - Parameter extension: Extension of files to look for
public init(directory: String, withExtension extension: String = "mustache") async throws {
self.templates = try await Self.loadTemplates(from: directory, withExtension: `extension`)
}
/// Register template under name
/// - Parameters:
/// - template: Template
/// - name: Name of template
public func register(_ template: HBMustacheTemplate, named name: String) {
template.setLibrary(self)
public mutating func register(_ template: HBMustacheTemplate, named name: String) {
self.templates[name] = template
}
@@ -48,9 +56,8 @@ public final class HBMustacheLibrary {
/// - Parameters:
/// - mustache: Mustache text
/// - name: Name of template
public func register(_ mustache: String, named name: String) throws {
public mutating func register(_ mustache: String, named name: String) throws {
let template = try HBMustacheTemplate(string: mustache)
template.setLibrary(self)
self.templates[name] = template
}
@@ -68,7 +75,7 @@ public final class HBMustacheLibrary {
/// - Returns: Rendered text
public func render(_ object: Any, withTemplate name: String) -> String? {
guard let template = templates[name] else { return nil }
return template.render(object)
return template.render(object, library: self)
}
/// Error returned by init() when parser fails

2
Sources/HummingbirdMustache/Template+Render.swift
View File

@@ -80,7 +80,7 @@ extension HBMustacheTemplate {
}
case .partial(let name, let indentation, let overrides):
if let template = library?.getTemplate(named: name) {
if let template = context.library?.getTemplate(named: name) {
return template.render(context: context.withPartial(indented: indentation, inheriting: overrides))
}

25
Sources/HummingbirdMustache/Template.swift
View File

@@ -13,7 +13,7 @@
//===----------------------------------------------------------------------===//
/// Class holding Mustache template
public final class HBMustacheTemplate {
public struct HBMustacheTemplate: Sendable {
/// Initialize template
/// - Parameter string: Template text
/// - Throws: HBMustacheTemplate.Error
@@ -24,29 +24,15 @@ public final class HBMustacheTemplate {
/// Render object using this template
/// - Parameter object: Object to render
/// - Returns: Rendered text
public func render(_ object: Any) -> String {
self.render(context: .init(object))
public func render(_ object: Any, library: HBMustacheLibrary? = nil) -> String {
self.render(context: .init(object, library: library))
}
internal init(_ tokens: [Token]) {
self.tokens = tokens
}
internal func setLibrary(_ library: HBMustacheLibrary) {
self.library = library
for token in self.tokens {
switch token {
case .section(_, _, let template), .invertedSection(_, _, let template), .inheritedSection(_, let template):
template.setLibrary(library)
case .partial(_, _, let templates):
templates?.forEach { $1.setLibrary(library) }
default:
break
}
}
}
enum Token {
enum Token: Sendable {
case text(String)
case variable(name: String, transform: String? = nil)
case unescapedVariable(name: String, transform: String? = nil)
@@ -57,6 +43,5 @@ public final class HBMustacheTemplate {
case contentType(HBMustacheContentType)
}
let tokens: [Token]
var library: HBMustacheLibrary?
var tokens: [Token]
}

18
Tests/HummingbirdMustacheTests/LibraryTests.swift
View File

@@ -16,7 +16,7 @@
import XCTest
final class LibraryTests: XCTestCase {
func testDirectoryLoad() throws {
func testDirectoryLoad() async throws {
let fs = FileManager()
try? fs.createDirectory(atPath: "templates", withIntermediateDirectories: false)
defer { XCTAssertNoThrow(try fs.removeItem(atPath: "templates")) }
@@ -24,12 +24,12 @@ final class LibraryTests: XCTestCase {
try mustache.write(to: URL(fileURLWithPath: "templates/test.mustache"))
defer { XCTAssertNoThrow(try fs.removeItem(atPath: "templates/test.mustache")) }
let library = try HBMustacheLibrary(directory: "./templates")
let library = try await HBMustacheLibrary(directory: "./templates")
let object = ["value": ["value1", "value2"]]
XCTAssertEqual(library.render(object, withTemplate: "test"), "<test><value>value1</value><value>value2</value></test>")
}
func testPartial() throws {
func testPartial() async throws {
let fs = FileManager()
try? fs.createDirectory(atPath: "templates", withIntermediateDirectories: false)
let mustache = Data("<test>{{#value}}<value>{{.}}</value>{{/value}}</test>".utf8)
@@ -42,12 +42,12 @@ final class LibraryTests: XCTestCase {
XCTAssertNoThrow(try fs.removeItem(atPath: "templates"))
}
let library = try HBMustacheLibrary(directory: "./templates")
let library = try await HBMustacheLibrary(directory: "./templates")
let object = ["value": ["value1", "value2"]]
XCTAssertEqual(library.render(object, withTemplate: "test"), "<test><value>value1</value><value>value2</value></test>")
}
func testLibraryParserError() throws {
func testLibraryParserError() async throws {
let fs = FileManager()
try? fs.createDirectory(atPath: "templates", withIntermediateDirectories: false)
defer { XCTAssertNoThrow(try fs.removeItem(atPath: "templates")) }
@@ -62,11 +62,9 @@ final class LibraryTests: XCTestCase {
try mustache2.write(to: URL(fileURLWithPath: "templates/error.mustache"))
defer { XCTAssertNoThrow(try fs.removeItem(atPath: "templates/error.mustache")) }
XCTAssertThrowsError(try HBMustacheLibrary(directory: "./templates")) { error in
guard let parserError = error as? HBMustacheLibrary.ParserError else {
XCTFail("\(error)")
return
}
do {
_ = try await HBMustacheLibrary(directory: "./templates")
} catch let parserError as HBMustacheLibrary.ParserError {
XCTAssertEqual(parserError.filename, "error.mustache")
XCTAssertEqual(parserError.context.line, "{{{name}}")
XCTAssertEqual(parserError.context.lineNumber, 2)

13
Tests/HummingbirdMustacheTests/PartialTests.swift
View File

@@ -18,7 +18,6 @@ import XCTest
final class PartialTests: XCTestCase {
/// Testing partials
func testMustacheManualExample9() throws {
let library = HBMustacheLibrary()
let template = try HBMustacheTemplate(string: """
<h2>Names</h2>
{{#names}}
@@ -29,8 +28,7 @@ final class PartialTests: XCTestCase {
<strong>{{.}}</strong>
""")
library.register(template, named: "base")
library.register(template2, named: "user")
let library = HBMustacheLibrary(templates: ["base": template, "user": template2])
let object: [String: Any] = ["names": ["john", "adam", "claire"]]
XCTAssertEqual(library.render(object, withTemplate: "base"), """
@@ -45,7 +43,6 @@ final class PartialTests: XCTestCase {
/// Test where last line of partial generates no content. It should not add a
/// tab either
func testPartialEmptyLineTabbing() throws {
let library = HBMustacheLibrary()
let template = try HBMustacheTemplate(string: """
<h2>Names</h2>
{{#names}}
@@ -63,8 +60,9 @@ final class PartialTests: XCTestCase {
{{/empty(.)}}
""")
var library = HBMustacheLibrary()
library.register(template, named: "base")
library.register(template2, named: "user")
library.register(template2, named: "user") // , withTemplate: String)// = HBMustacheLibrary(templates: ["base": template, "user": template2])
let object: [String: Any] = ["names": ["john", "adam", "claire"]]
XCTAssertEqual(library.render(object, withTemplate: "base"), """
@@ -79,7 +77,6 @@ final class PartialTests: XCTestCase {
/// Testing dynamic partials
func testDynamicPartials() throws {
let library = HBMustacheLibrary()
let template = try HBMustacheTemplate(string: """
<h2>Names</h2>
{{partial}}
@@ -89,7 +86,7 @@ final class PartialTests: XCTestCase {
<strong>{{.}}</strong>
{{/names}}
""")
library.register(template, named: "base")
let library = HBMustacheLibrary(templates: ["base": template])
let object: [String: Any] = ["names": ["john", "adam", "claire"], "partial": template2]
XCTAssertEqual(library.render(object, withTemplate: "base"), """
@@ -103,7 +100,7 @@ final class PartialTests: XCTestCase {
/// test inheritance
func testInheritance() throws {
let library = HBMustacheLibrary()
var library = HBMustacheLibrary()
try library.register(
"""
<head>

11
Tests/HummingbirdMustacheTests/SpecTests.swift
View File

@@ -66,15 +66,15 @@ final class MustacheSpecTests: XCTestCase {
let expected: String
func run() throws {
print("Test: \(self.name)")
// print("Test: \(self.name)")
if let partials = self.partials {
let library = HBMustacheLibrary()
let template = try HBMustacheTemplate(string: self.template)
library.register(template, named: "__test__")
var templates: [String: HBMustacheTemplate] = ["__test__": template]
for (key, value) in partials {
let template = try HBMustacheTemplate(string: value)
library.register(template, named: key)
templates[key] = template
}
let library = HBMustacheLibrary(templates: templates)
let result = library.render(self.data.value, withTemplate: "__test__")
self.XCTAssertSpecEqual(result, self)
} else {
@@ -105,10 +105,12 @@ final class MustacheSpecTests: XCTestCase {
let spec = try JSONDecoder().decode(Spec.self, from: data)
print(spec.overview)
let date = Date()
for test in spec.tests {
guard !ignoring.contains(test.name) else { continue }
XCTAssertNoThrow(try test.run())
}
print(-date.timeIntervalSinceNow)
}
func testCommentsSpec() throws {
@@ -136,6 +138,7 @@ final class MustacheSpecTests: XCTestCase {
}
func testInheritanceSpec() throws {
try XCTSkipIf(true) // inheritance spec has been updated and has added requirements, we don't yet support
try self.testSpec(name: "~inheritance")
}
}