dnrops
/
tuist
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #34 from xcbuddy/localizable-files 

Add support for variant groups
This commit is contained in:
Pedro Piñera Buendía 2018-05-22 15:24:51 +02:00 committed by GitHub
parent 6853aa15f9 e6ec361a1c
commit 130987d515
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 141 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

150
App/xcbuddykit/Sources/Generator/ProjectFileElements.swift
View File

@ -68,7 +68,7 @@ class ProjectFileElements {
// Normal resources
if let resourceBuildFile = buildFile as? ResourcesBuildFile {
files.formUnion(resourceBuildFile.paths)
files.formUnion(resourceBuildFile.paths.map(normalize))
// Core Data model resoureces
} else if let coreDataModelBuildFile = buildFile as? CoreDataModelBuildFile {
@ -130,7 +130,9 @@ class ProjectFileElements {
let closestRelativeAbsolutePath = sourceRootPath.appending(closestRelativeRelativePath)
// Add the first relative element.
let firstElement = addElement(relativePath: closestRelativeRelativePath, from: sourceRootPath, toGroup: groups.project, objects: objects)
guard let firstElement = addElement(relativePath: closestRelativeRelativePath, from: sourceRootPath, toGroup: groups.project, objects: objects) else {
return
}
// If it matches the file that we are adding or it's not a group we can exit.
if (closestRelativeAbsolutePath == path) || !(firstElement.element is PBXGroup) {
@ -141,12 +143,14 @@ class ProjectFileElements {
var lastGroup: PBXGroup! = firstElement.element as! PBXGroup
var lastPath: AbsolutePath = firstElement.path
path.relative(to: lastPath).components.forEach { component in
for component in path.relative(to: lastPath).components {
if lastGroup == nil { return }
let element = addElement(relativePath: RelativePath(component),
from: lastPath,
toGroup: lastGroup!,
objects: objects)
guard let element = addElement(relativePath: RelativePath(component),
from: lastPath,
toGroup: lastGroup!,
objects: objects) else {
return
}
lastGroup = element.element as? PBXGroup
lastPath = element.path
}
@ -164,7 +168,7 @@ class ProjectFileElements {
@discardableResult func addElement(relativePath: RelativePath,
from: AbsolutePath,
toGroup: PBXGroup,
objects: PBXObjects) -> (element: PBXFileElement, path: AbsolutePath) {
objects: PBXObjects) -> (element: PBXFileElement, path: AbsolutePath)? {
let absolutePath = from.appending(relativePath)
if elements[absolutePath] != nil {
return (element: elements[absolutePath]!, path: from.appending(relativePath))
@ -179,13 +183,13 @@ class ProjectFileElements {
}
// Add the file element
if isVariantGroup(path: absolutePath) {
return addVariantGroupElement(from: from,
folderAbsolutePath: absolutePath,
folderRelativePath: relativePath,
name: name,
toGroup: toGroup,
objects: objects)
if isLocalized(path: absolutePath) {
addVariantGroup(from: from,
absolutePath: absolutePath,
relativePath: relativePath,
toGroup: toGroup,
objects: objects)
return nil
} else if isVersionGroup(path: absolutePath) {
return addVersionGroupElement(from: from,
folderAbsolutePath: absolutePath,
@ -201,36 +205,54 @@ class ProjectFileElements {
toGroup: toGroup,
objects: objects)
} else {
return addFileElement(from: from,
fileAbsolutePath: absolutePath,
fileRelativePath: relativePath,
name: name,
toGroup: toGroup,
objects: objects)
addFileElement(from: from,
fileAbsolutePath: absolutePath,
fileRelativePath: relativePath,
name: name,
toGroup: toGroup,
objects: objects)
return nil
}
}
/// Adds a variant group element.
/// Adds a localized element/s
///
/// - Parameters:
/// - from: absolute path of the group the group is being added to.
/// - folderAbsolutePath: folder absolute path.
/// - folderRelativePath: folder path relative to the group absolute path.
/// - name: element name.
/// - absolutePath: localized file absolute path.
/// - relativePath: localized path relative to the group absolute path.
/// - toGroup: group where the new group will be added.
/// - objects: Xcode project objects.
/// - Returns: added group.
func addVariantGroupElement(from: AbsolutePath,
folderAbsolutePath: AbsolutePath,
folderRelativePath: RelativePath,
name: String?,
toGroup: PBXGroup,
objects: PBXObjects) -> (element: PBXFileElement, path: AbsolutePath) {
let group = PBXVariantGroup(children: [], sourceTree: .group, name: name, path: folderRelativePath.asString)
let reference = objects.addObject(group)
toGroup.children.append(reference)
elements[folderAbsolutePath] = group
return (element: group, path: from.appending(folderRelativePath))
func addVariantGroup(from: AbsolutePath,
absolutePath: AbsolutePath,
relativePath _: RelativePath,
toGroup: PBXGroup,
objects: PBXObjects) {
// /path/to/*.lproj/*
absolutePath.glob("*").forEach { localizedFile in
let localizedName = localizedFile.components.last!
// Variant group
let variantGroupPath = absolutePath.parentDirectory.appending(component: localizedName)
var variantGroup: PBXVariantGroup! = elements[variantGroupPath] as? PBXVariantGroup
if variantGroup == nil {
variantGroup = PBXVariantGroup(sourceTree: .group, name: localizedName)
let variantGroupReference = objects.addObject(variantGroup)
toGroup.children.append(variantGroupReference)
elements[variantGroupPath] = variantGroup
}
// Localized element
let localizedFilePath = "\(absolutePath.components.last!)/\(localizedName)" // e.g: en.lproj/Main.storyboard
let lastKnownFileType = Xcode.filetype(extension: localizedName) // e.g. Main.storyboard
let name = absolutePath.components.last!.split(separator: ".").first! // e.g. en
let localizedFileReference = PBXFileReference(sourceTree: .group,
name: String(name),
lastKnownFileType: lastKnownFileType,
path: localizedFilePath)
let localizedFileReferenceReference = objects.addObject(localizedFileReference)
variantGroup.children.append(localizedFileReferenceReference)
}
}
/// Adds a version group element.
@ -293,19 +315,17 @@ class ProjectFileElements {
/// - name: element name.
/// - toGroup: group where the file will be added.
/// - objects: Xcode project objects.
/// - Returns: added file.
func addFileElement(from: AbsolutePath,
func addFileElement(from _: AbsolutePath,
fileAbsolutePath: AbsolutePath,
fileRelativePath: RelativePath,
name: String?,
toGroup: PBXGroup,
objects: PBXObjects) -> (element: PBXFileElement, path: AbsolutePath) {
objects: PBXObjects) {
let lastKnownFileType = Xcode.filetype(extension: fileAbsolutePath.extension!)
let file = PBXFileReference(sourceTree: .group, name: name, lastKnownFileType: lastKnownFileType, path: fileRelativePath.asString)
let reference = objects.addObject(file)
toGroup.children.append(reference)
elements[fileAbsolutePath] = file
return (element: file, path: from.appending(fileRelativePath))
}
/// Returns the group at the given path if it's been added to the file elements object.
@ -324,6 +344,19 @@ class ProjectFileElements {
return elements[path] as? PBXFileReference
}
/// Returns true if a path represents a localized resource *.lproj.
///
/// - Parameter path: path to be checked.
/// - Returns: true if the file is a localized file.
func isLocalized(path: AbsolutePath) -> Bool {
// swiftlint:disable:next force_try
let regex = try! NSRegularExpression(pattern: ".lproj$", options: [])
let pathString = path.asString
return regex.firstMatch(in: pathString,
options: [],
range: NSRange(location: 0, length: pathString.count)) != nil
}
/// Returns true if the path is a version group.
///
/// - Parameter path: path.
@ -332,20 +365,37 @@ class ProjectFileElements {
return path.extension == "xcdatamodeld"
}
/// Returns true if the group is a variant group.
///
/// - Parameter path: path.
/// - Returns: true if the group is a variant group.
func isVariantGroup(path: AbsolutePath) -> Bool {
return path.extension == "lproj"
}
/// Returns true if the path should be a group.
///
/// - Parameter path: path.
/// - Returns: true if the path should be represented as a group.
func isGroup(path: AbsolutePath) -> Bool {
return !isVariantGroup(path: path) && !isVersionGroup(path: path) && path.extension == nil
return !isVersionGroup(path: path) && path.extension == nil
}
/// Normalizes a path. Some paths have no direct representation in Xcode,
/// like localizable files. This method normalizes those and returns a project
/// representable path.
///
/// - Example:
/// /test/es.lproj/Main.storyboard ~> /test/es.lproj
///
/// - Parameter path: path to be normalized.
/// - Returns: normalized path.
func normalize(_ path: AbsolutePath) -> AbsolutePath {
// swiftlint:disable:next force_try
let localizedregex = try! NSRegularExpression(pattern: "(.+\\.lproj)/.+",
options: [])
let pathString = path.asString
let range = NSRange(location: 0, length: pathString.count)
if let localizedMatch = localizedregex.firstMatch(in: pathString,
options: [],
range: range) {
let lprojPath = (pathString as NSString).substring(with: localizedMatch.range(at: 1))
return AbsolutePath(lprojPath)
} else {
return path
}
}
/// Returns the relative path of the closest relative element to the source root path.

59
App/xcbuddykit/Tests/Generator/ProjectFileElementsTests.swift
View File

@ -99,23 +99,32 @@ final class ProjectFileElementsTests: XCTestCase {
XCTAssertEqual(file.sourceTree, .group)
}
func test_addVariantGroupElement() throws {
let from = AbsolutePath("/project/")
let folderAbsolutePath = AbsolutePath("/project/en.lproj")
let folderRelativePath = RelativePath("./en.lproj")
func test_addVariantGroup() throws {
let fileName = "localizable.strings"
let dir = try TemporaryDirectory()
let localizedDir = dir.path.appending(component: "en.lproj")
try localizedDir.mkpath()
try localizedDir.appending(component: fileName).write("test")
let from = dir.path.parentDirectory
let absolutePath = localizedDir
let relativePath = RelativePath("en.lproj")
let group = PBXGroup()
let objects = PBXObjects(objects: [:])
objects.addObject(group)
_ = subject.addVariantGroupElement(from: from,
folderAbsolutePath: folderAbsolutePath,
folderRelativePath: folderRelativePath,
name: nil,
toGroup: group,
objects: objects)
let variantGroup: PBXVariantGroup? = try group.children.first?.object()
XCTAssertEqual(variantGroup?.path, "en.lproj")
XCTAssertEqual(variantGroup?.sourceTree, .group)
XCTAssertNil(variantGroup?.name)
subject.addVariantGroup(from: from,
absolutePath: absolutePath,
relativePath: relativePath,
toGroup: group,
objects: objects)
let variantGroupPath = dir.path.appending(component: fileName)
let variantGroup: PBXVariantGroup = subject.group(path: variantGroupPath) as! PBXVariantGroup
XCTAssertEqual(variantGroup.name, fileName)
XCTAssertEqual(variantGroup.sourceTree, .group)
let fileReference: PBXFileReference? = try variantGroup.children.first?.object()
XCTAssertEqual(fileReference?.name, "en")
XCTAssertEqual(fileReference?.sourceTree, .group)
XCTAssertEqual(fileReference?.path, "en.lproj/\(fileName)")
}
func test_addVersionGroupElement() throws {
@ -172,21 +181,33 @@ final class ProjectFileElementsTests: XCTestCase {
XCTAssertEqual(subject.file(path: path), file)
}
func test_isLocalized() {
let path = AbsolutePath("/path/to/es.lproj")
XCTAssertTrue(subject.isLocalized(path: path))
}
func test_isVersionGroup() {
let path = AbsolutePath("/path/to/model.xcdatamodeld")
XCTAssertTrue(subject.isVersionGroup(path: path))
}
func test_isVariantGroup() {
let path = AbsolutePath("/path/to/en.lproj")
XCTAssertTrue(subject.isVariantGroup(path: path))
}
func test_isGroup() {
let path = AbsolutePath("/path/to/folder")
XCTAssertTrue(subject.isGroup(path: path))
}
func test_normalize_whenLocalized() {
let path = AbsolutePath("/test/es.lproj/Main.storyboard")
let normalized = subject.normalize(path)
XCTAssertEqual(normalized, AbsolutePath("/test/es.lproj"))
}
func test_normalize() {
let path = AbsolutePath("/test/file.swift")
let normalized = subject.normalize(path)
XCTAssertEqual(normalized, path)
}
func test_closestRelativeElementPath() {
let got = subject.closestRelativeElementPath(path: AbsolutePath("/a/framework/framework.framework"),
sourceRootPath: AbsolutePath("/a/b/c/project"))

1
CHANGELOG.md
View File

@ -9,6 +9,7 @@ Please, check out guidelines: https://keepachangelog.com/en/1.0.0/
* Files and groups generation https://github.com/xcbuddy/xcbuddy/pull/28 by @pepibumur.
* Sources build phase generation https://github.com/xcbuddy/xcbuddy/pull/30 by @pepibumur.
* Add `create-issue` command https://github.com/xcbuddy/xcbuddy/pull/32 by @pepibumur.
* Add support for variant groups https://github.com/xcbuddy/xcbuddy/pull/34 by @pepibumur.
### Changed