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.

Sign up for GitHub

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 option disallow-numerical-affixes #78

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add option disallow-numerical-affixes #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions Sources/FengNiao/main.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import Rainbow
import FengNiaoKit
import PathKit

let appVersion = "0.9.0"
let appVersion = "0.9.1"

#if os(Linux)
let EX_OK: Int32 = 0
Expand Down Expand Up @@ -60,6 +60,11 @@ let isForceOption = BoolOption(
helpMessage: "Delete the found unused files without asking.")
cli.addOption(isForceOption)

let isDisallowNumericalAffixesOption = BoolOption(
longFlag: "disallow-numerical-affixes",
helpMessage: "Names with numerical affixes without '%' will not count as used if enabled (myImage -> 123myImage456).")
cli.addOption(isDisallowNumericalAffixesOption)

let excludePathOption = MultiStringOption(
shortFlag: "e", longFlag: "exclude",
helpMessage: "Exclude paths from search.")
Expand Down Expand Up @@ -120,11 +125,13 @@ let isForce = isForceOption.value
let excludePaths = excludePathOption.value ?? []
let resourceExtentions = resourceExtOption.value ?? ["imageset", "jpg", "png", "gif", "pdf"]
let fileExtensions = fileExtOption.value ?? ["h", "m", "mm", "swift", "xib", "storyboard", "plist"]
let isDisallowNumericalAffixes = isDisallowNumericalAffixesOption.value

let fengNiao = FengNiao(projectPath: projectPath,
excludedPaths: excludePaths,
resourceExtensions: resourceExtentions,
searchInFileExtensions: fileExtensions)
searchInFileExtensions: fileExtensions,
disallowNumericalAffixes: isDisallowNumericalAffixes)

let unusedFiles: [FileInfo]
do {
Expand Down
15 changes: 9 additions & 6 deletions Sources/FengNiaoKit/FengNiao.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,18 +100,20 @@ public struct FengNiao {
let excludedPaths: [Path]
let resourceExtensions: [String]
let searchInFileExtensions: [String]

let disallowNumericalAffixes: Bool

let regularDirExtensions = ["imageset", "launchimage", "appiconset", "stickersiconset", "complicationset", "bundle"]
var nonDirExtensions: [String] {
return resourceExtensions.filter { !regularDirExtensions.contains($0) }
}

public init(projectPath: String, excludedPaths: [String], resourceExtensions: [String], searchInFileExtensions: [String]) {
public init(projectPath: String, excludedPaths: [String], resourceExtensions: [String], searchInFileExtensions: [String], disallowNumericalAffixes: Bool) {
let path = Path(projectPath).absolute()
self.projectPath = path
self.excludedPaths = excludedPaths.map { path + Path($0) }
self.resourceExtensions = resourceExtensions
self.searchInFileExtensions = searchInFileExtensions
self.disallowNumericalAffixes = disallowNumericalAffixes
}

public func unusedFiles() throws -> [FileInfo] {
Expand All @@ -125,7 +127,7 @@ public struct FengNiao {
let allResources = allResourceFiles()
let usedNames = allUsedStringNames()

return FengNiao.filterUnused(from: allResources, used: usedNames).map( FileInfo.init )
return FengNiao.filterUnused(from: allResources, used: usedNames, disallowNumericalAffixes: disallowNumericalAffixes).map( FileInfo.init )
}

// Return a failed list of deleting
Expand Down Expand Up @@ -253,10 +255,10 @@ public struct FengNiao {
return Set(result)
}

static func filterUnused(from all: [String: Set<String>], used: Set<String>) -> Set<String> {
static func filterUnused(from all: [String: Set<String>], used: Set<String>, disallowNumericalAffixes: Bool) -> Set<String> {
let unusedPairs = all.filter { key, _ in
return !used.contains(key) &&
!used.contains { $0.similarPatternWithNumberIndex(other: key) }
!used.contains { $0.similarPatternWithNumberIndex(other: key, disallowNumericalAffixes: disallowNumericalAffixes) }
}
return Set( unusedPairs.flatMap { $0.value } )
}
Expand All @@ -265,9 +267,10 @@ public struct FengNiao {
let digitalRex = try! NSRegularExpression(pattern: "(\\d+)", options: .caseInsensitive)
extension String {

func similarPatternWithNumberIndex(other: String) -> Bool {
func similarPatternWithNumberIndex(other: String, disallowNumericalAffixes: Bool) -> Bool {
// self -> pattern "image%02d"
// other -> name "image01"
guard !disallowNumericalAffixes || contains("%") else { return false }
let matches = digitalRex.matches(in: other, options: [], range: other.fullRange)
// No digital found in resource key.
guard matches.count >= 1 else { return false }
Expand Down
86 changes: 69 additions & 17 deletions Tests/FengNiaoKitTests/FengNiaoKitSpec.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,8 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
let fengniao = FengNiao(projectPath: project.string,
excludedPaths: [],
resourceExtensions: ["png", "jpg"],
searchInFileExtensions: ["txt"])
searchInFileExtensions: ["txt"],
disallowNumericalAffixes: false)
let result = fengniao.allUsedStringNames()
let expected: Set<String> = ["image", "another-image"]

Expand All @@ -188,7 +189,8 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
let fengniao = FengNiao(projectPath: project.string,
excludedPaths: [],
resourceExtensions: ["png", "jpg"],
searchInFileExtensions: ["swift"])
searchInFileExtensions: ["swift"],
disallowNumericalAffixes: false)
let result = fengniao.allUsedStringNames()
let expected: Set<String> = ["common.login",
"common.logout",
Expand All @@ -205,7 +207,8 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
let fengniao = FengNiao(projectPath: project.string,
excludedPaths: [],
resourceExtensions: ["png", "jpg"],
searchInFileExtensions: ["m", "mm"])
searchInFileExtensions: ["m", "mm"],
disallowNumericalAffixes: false)
let result = fengniao.allUsedStringNames()
let expected: Set<String> = ["info.error.memory.full.confirm",
"info.error.memory.full.ios",
Expand All @@ -222,7 +225,8 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
let fengniao = FengNiao(projectPath: project.string,
excludedPaths: [],
resourceExtensions: ["png"],
searchInFileExtensions: ["xib", "storyboard"])
searchInFileExtensions: ["xib", "storyboard"],
disallowNumericalAffixes: false)
let result = fengniao.allUsedStringNames()
let expected: Set<String> = ["profile_image",
"bottom",
Expand All @@ -239,7 +243,8 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
let fengniao = FengNiao(projectPath: project.string,
excludedPaths: [],
resourceExtensions: [],
searchInFileExtensions: ["plist"])
searchInFileExtensions: ["plist"],
disallowNumericalAffixes: false)
let result = fengniao.allUsedStringNames()
let expected: Set<String> = ["some_image", "some_type", "Some Image"]

Expand All @@ -251,7 +256,8 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
let fengniao = FengNiao(projectPath: project.string,
excludedPaths: [],
resourceExtensions: [],
searchInFileExtensions: ["pbxproj"])
searchInFileExtensions: ["pbxproj"],
disallowNumericalAffixes: false)
let result = fengniao.allUsedStringNames()
let expected: Set<String> = ["AppIcon", "MessagesIcon", "iMessage App Icon", "Complication"]

Expand All @@ -263,7 +269,8 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
let fengniao = FengNiao(projectPath: project.string,
excludedPaths: [],
resourceExtensions: ["png", "jpg"],
searchInFileExtensions: ["m", "xib"])
searchInFileExtensions: ["m", "xib"],
disallowNumericalAffixes: false)
let result = fengniao.allUsedStringNames()
let expected: Set<String> = ["profile_image",
"bottom",
Expand All @@ -280,7 +287,8 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
let fengniao = FengNiao(projectPath: project.string,
excludedPaths: ["SubFolder2"],
resourceExtensions: ["png", "jpg"],
searchInFileExtensions: ["m", "xib"])
searchInFileExtensions: ["m", "xib"],
disallowNumericalAffixes: false)
let result = fengniao.allUsedStringNames()
let expected: Set<String> = ["info.error.memory.full.confirm",
"info.error.memory.full.ios",
Expand All @@ -296,7 +304,8 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
let fengniao = FengNiao(projectPath: project.string,
excludedPaths: [],
resourceExtensions: ["png", "jpg", "imageset"],
searchInFileExtensions: [])
searchInFileExtensions: [],
disallowNumericalAffixes: false)
let result = fengniao.allResourceFiles()
let expected: [String: Set<String>] = [
"file1": [(project + "file1.png").string],
Expand All @@ -311,7 +320,8 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
let fengniao = FengNiao(projectPath: project.string,
excludedPaths: ["Ignore"],
resourceExtensions: ["png", "jpg", "imageset"],
searchInFileExtensions: [])
searchInFileExtensions: [],
disallowNumericalAffixes: false)
let result = fengniao.allResourceFiles()
let expected: [String: Set<String>] = [
"normal": [(project + "normal.png").string],
Expand All @@ -325,7 +335,8 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
let fengniao = FengNiao(projectPath: project.string,
excludedPaths: [],
resourceExtensions: ["png"],
searchInFileExtensions: [])
searchInFileExtensions: [],
disallowNumericalAffixes: false)
let result = fengniao.allResourceFiles()
let expected: [String: Set<String>] = [
"image": [(project + "[email protected]").string, (project + "[email protected]").string],
Expand All @@ -344,7 +355,7 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
]
let used: Set<String> = ["book"]

let result = FengNiao.filterUnused(from: all, used: used)
let result = FengNiao.filterUnused(from: all, used: used, disallowNumericalAffixes: false)
let expected: Set<String> = ["face.png", "moon.png"]
try expect(result) == expected

Expand All @@ -358,11 +369,11 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
]
let used: Set<String> = ["book"]

let result = FengNiao.filterUnused(from: all, used: used)
let result = FengNiao.filterUnused(from: all, used: used, disallowNumericalAffixes: false)
let expected: Set<String> = ["face1.png", "face2.png", "moon.png"]
try expect(result) == expected
}

$0.it("should not filter similar pattern") {
let all: [String: Set<String>] = [
"face": ["face.png"],
Expand All @@ -383,14 +394,55 @@ public let testFengNiaoKit: ((ContextType) -> Void) = {
"unused_3": ["unused_3.png"],
]
let used: Set<String> = ["image%02d", "%d_set", "middle_%d_bird","suffix_"]
let result = FengNiao.filterUnused(from: all, used: used)
let result = FengNiao.filterUnused(from: all, used: used, disallowNumericalAffixes: false)
let expected: Set<String> = ["face.png", "unused_1.png", "unused_2.png", "unused_3.png"]
try expect(result) == expected
}
}


$0.describe("FengNiao File Filter with allowNumericalAffixes") {
$0.it("should filter files with affixes correctly when allowed") {
let all: [String: Set<String>] = [
"suffix20": ["suffix20.png", "[email protected]"],
"50prefix": ["50prefix.png", "[email protected]"],
"10both20": ["10both20.png", "[email protected]"],
]
let used: Set<String> = ["suffix", "prefix", "both"]

let result = FengNiao.filterUnused(from: all, used: used, disallowNumericalAffixes: false)
let expected: Set<String> = ["[email protected]", "10both20.png"]
try expect(result) == expected
}

$0.it("should filter files with affixes correctly when not allowed") {
let all: [String: Set<String>] = [
"suffix20": ["suffix20.png", "[email protected]"],
"50prefix": ["50prefix.png", "[email protected]"],
"10both20": ["10both20.png", "[email protected]"],
]
let used: Set<String> = ["suffix", "prefix", "both"]

let result = FengNiao.filterUnused(from: all, used: used, disallowNumericalAffixes: true)
let expected: Set<String> = ["suffix20.png", "[email protected]", "50prefix.png", "[email protected]", "[email protected]", "10both20.png"]
try expect(result) == expected
}

$0.it("should filter files with percent sign correctly when not allowed") {
let all: [String: Set<String>] = [
"suffix20": ["suffix20.png", "[email protected]"],
"50prefix": ["50prefix.png", "[email protected]"],
"10both20": ["10both20.png", "[email protected]"],
]
let used: Set<String> = ["suffix%d", "%dprefix", "%dboth%d"]

let result = FengNiao.filterUnused(from: all, used: used, disallowNumericalAffixes: true)
let expected: Set<String> = ["[email protected]", "10both20.png"]
try expect(result) == expected
}
}

$0.describe("FengNiao Deleting File") {

let file = fixtures + "DeleteFiles/file_in_root"
let folder = fixtures + "DeleteFiles/Folder"

Expand Down