Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add AccessModifier to make Literals can share outside of the Module #2

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Arguments:
Options:
--swiftfile [default: ${SRCROOT}/${TARGET_NAME}/Literals.swift] - The output Swift file directory.
--stringsfile [default: ${SRCROOT}/${TARGET_NAME}/Localizable.strings] - The output Strings file directory.
--access [default: public] - The access modifier.
--bundle [default: main] - The bundle modifier. It can be only `main` or `module`.
```

## Authors & Collaborators
Expand Down
108 changes: 69 additions & 39 deletions Sources/POEditorParser/Lib/LiteralsParser.swift
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ struct Variable {
- alreadyReadPages <- this should not be captialized (or we'll lose the Read and Pages capital letters)
*/

let words = rawKey.split(separator: " ").map(String.init)
let words = rawKey.components(separatedBy: .alphanumerics.inverted)
if words.count == 1 {
return words[0].lowercaseFirst
}
Expand Down Expand Up @@ -111,37 +111,55 @@ public struct Translation {
return rawKey.capitalized.replacingOccurrences(of: "_", with: "")
}

var swiftCode: String {
func swiftCode(accessModifier: AccessModifier = .public, bundleModifier: BundleModifier = .main) -> String {
if variables.isEmpty {
return generateVariableLessSwiftCode()
return generateVariableLessSwiftCode(accessModifier: accessModifier, bundleModifier: bundleModifier)
} else {
return generateVariableSwiftCode()
return generateVariableSwiftCode(accessModifier: accessModifier, bundleModifier: bundleModifier)
}
}

private func generateVariableLessSwiftCode() -> String {
private func generateVariableLessSwiftCode(
accessModifier: AccessModifier,
bundleModifier: BundleModifier
) -> String {
/*
static var Welcome: String {
return NSLocalizedString()
}
*/
return "\tstatic var \(prettyKey): String {\n\t\treturn \(localizedStringFunction)(\"\(rawKey)\", comment: \"\")\n\t}\n"
return "\t\(accessModifier.rawValue) static var \(prettyKey): String {\n\t\treturn \(localizedStringFunction)(\"\(rawKey)\", bundle: .\(bundleModifier.rawValue), comment: \"\")\n\t}\n"
}

private func generateVariableSwiftCode() -> String {
private func generateVariableSwiftCode(
accessModifier: AccessModifier,
bundleModifier: BundleModifier
) -> String {
/*
static func ReadBooksKey(readNumber: Int) -> String {
return ""
}
*/
let parameters = variables
let uniqueKeyVariables: [Variable] = {
guard variables.count > 1 else {
return variables
}

return variables
.enumerated()
.map { (index, variable) in
return .init(rawKey: variable.rawKey + "_\(index)")
}
}()

let parameters = uniqueKeyVariables
.map { $0.type.swiftParameter(key: $0.parameterKey) }
.joined(separator: ", ")
let localizedArguments = variables
let localizedArguments = uniqueKeyVariables
.map { $0.parameterKey }
.map { $0.snakeCased() }
.joined(separator: ", ")
return "\tstatic func \(prettyKey)(\(parameters)) -> String {\n\t\treturn String(format: \(localizedStringFunction)(\"\(rawKey)\", comment: \"\"), \(localizedArguments))\n\t}"
return "\t\(accessModifier.rawValue) static func \(prettyKey)(\(parameters)) -> String {\n\t\treturn String(format: \(localizedStringFunction)(\"\(rawKey)\", bundle: .\(bundleModifier.rawValue), comment: \"\"), \(localizedArguments))\n\t}"
}

}
Expand All @@ -156,17 +174,19 @@ enum SwiftCodeGeneratorConstants {
return formatter
}()

static let rootObjectHeader = """
// Generated using POEditorParser
// DO NOT EDIT
// Generated: \(SwiftCodeGeneratorConstants.dateFormatter.string(from: Date()))

// swiftlint:disable all
static func rootObjectHeader(accessModifier: AccessModifier = .public) -> String {
"""
// Generated using POEditorParser
// DO NOT EDIT
// Generated: \(SwiftCodeGeneratorConstants.dateFormatter.string(from: Date()))

// swiftlint:disable all

import Foundation

enum Literals {
"""
import Foundation

\(accessModifier.rawValue) enum Literals {
"""
}
static let rootObjectFooter = "\n}\n// swiftlint:enable all\n"

static let methodOrVariableHeader = "\n"
Expand All @@ -176,36 +196,28 @@ public protocol SwiftCodeGenerator {
func generateCode(translations: [Translation])
}

class StringCodeGenerator: SwiftCodeGenerator {

var generatedResult = ""

func generateCode(translations: [Translation]) {
generatedResult += SwiftCodeGeneratorConstants.rootObjectHeader

for t in translations {
generatedResult += SwiftCodeGeneratorConstants.methodOrVariableHeader
generatedResult += t.swiftCode
}

generatedResult += SwiftCodeGeneratorConstants.rootObjectFooter
}
}

public class FileCodeGenerator: SwiftCodeGenerator {

let fileHandle: FileHandle
public init(fileHandle: FileHandle) {
let accessModifier: AccessModifier
let bundleModifier: BundleModifier
public init(
fileHandle: FileHandle,
access: String,
bundle: String
) {
self.fileHandle = fileHandle
self.accessModifier = .init(accessString: access)
self.bundleModifier = .init(bundleName: bundle)
}

// TODO: Generalize!!! += (same code as in string)
public func generateCode(translations: [Translation]) {
fileHandle += SwiftCodeGeneratorConstants.rootObjectHeader
fileHandle += SwiftCodeGeneratorConstants.rootObjectHeader(accessModifier: accessModifier)

for t in translations {
fileHandle += SwiftCodeGeneratorConstants.methodOrVariableHeader
fileHandle += t.swiftCode
fileHandle += t.swiftCode(accessModifier: accessModifier, bundleModifier: bundleModifier)
}

fileHandle += SwiftCodeGeneratorConstants.rootObjectFooter
Expand Down Expand Up @@ -365,6 +377,24 @@ enum TranslationValueParser {
}


enum AccessModifier: String {
case `public`, `private`, `open`, `internal`

init(accessString: String) {
self = AccessModifier(rawValue: accessString) ?? .public
}
}

enum BundleModifier: String {
case main
case module

init(bundleName: String) {
self = BundleModifier(rawValue: bundleName) ?? .main
}
}


extension String {
var first: String {
return String(prefix(1))
Expand Down
8 changes: 5 additions & 3 deletions Sources/POEditorParser/main.swift
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ command(
Argument<Int>("id", description: "The id of the project"),
Argument<String>("language", description: "The language code"),
Option<String>("swiftfile", default: "${SRCROOT}/${TARGET_NAME}/Literals.swift", description: "The output Swift file directory."),
Option<String>("stringsfile", default: "${SRCROOT}/${TARGET_NAME}/Localizable.strings", description: "The output Strings file directory.")
) { (token: String, id: Int, language: String, swiftfile: String, stringsfile: String) in
Option<String>("stringsfile", default: "${SRCROOT}/${TARGET_NAME}/Localizable.strings", description: "The output Strings file directory."),
Option<String>("access", default: "public", description: "The access modifier."),
Option<String>("bundle", default: "main", description: "The bundle modifier.")
) { (token: String, id: Int, language: String, swiftfile: String, stringsfile: String, access: String, bundle: String) in

print("Fetching contents of strings at POEditor...".blue)

Expand Down Expand Up @@ -60,7 +62,7 @@ command(
print("Fatal error: Couldn't write to file located at \(swiftfile)".red)
return
}
let fileCodeGenerator = FileCodeGenerator(fileHandle: swiftHandle)
let fileCodeGenerator = FileCodeGenerator(fileHandle: swiftHandle, access: access, bundle: bundle)
fileCodeGenerator.generateCode(translations: translations)
print("Success! Literals generated at \(swiftfile)".green)

Expand Down
Binary file modified bin/poe
Binary file not shown.