Implement filename renaming library

[TranceLove]

Description

It is a port of https://github.com/jonschlinkert/add-filename-increment for node.js into Kotlin, with some tweaks and tricks specific to Kotlin.

Issue tracker

Addresses #2078

Automatic tests

• Added test cases

Manual tests

• Done

Build tasks success

Successfully running following tasks on local:

• ./gradlew assembledebug
• ./gradlew spotlessCheck

Related PR

Related to PR #3886

[yatiksihag01]

Hi @TranceLove, I've noticed a couple of issues in your code:

• When renaming directories, the increment() function currently appends a dot (.) at the end of the directory name. It should append numbers like (1), (2), and so on. Please check line 155 in FilenameHelper.kt.
• If I pass value of startArg 0 or 1 (default), it starts from appending (2), (3) and so on. However, when I use a higher value like 5, it works correctly.

[TranceLove]

@yatiksihag01 thanks for the feedback. Added c4ad60f to address the first issue, please take a look.

But for the second problem... may you be more specific about the symptom(s) you have? Say when you call increment() with the default startArg, what should I expect and why setting startArg to high values would work?

[yatiksihag01]

Here is the second problem. Let's say startArg initial value is 1. When increment() function initially call format() , it'll simply return the same filename because n <= 1. Then increment() will call format() for n = 2 and it'll work fine. I don't know if there's specific reason to add this if (n>1) condition but in my case this is creating the problem.

[TranceLove]

I think it's understandable, if looking at the unit test for windows.

AmazeFileManager/app/src/test/java/com/amaze/filemanager/filesystem/FilenameHelperWindowsIncrementNameTest.kt

Lines 40 to 48 in bda6148

	fun testWindowsIncrementSimple() {
	val pairs = arrayOf(
	Pair("/test/file.txt", "/test/file (2).txt"),
	Pair("sub/foo.txt", "sub/foo (2).txt"),
	Pair("sub/nested/foo.txt", "sub/nested/foo (2).txt"),
	Pair("/test/afile", "/test/afile (2)")
	)
	performTest(pairs, true)
	}

Couldn't comment if it's right or wrong, as I was doing a direct port... but if I understand correctly, looks like you'd want to have filenames from starting with file (2).txt to file (1).txt, which is different from the original node.js implementation.

If that is the case, see if 1f2cd85 fits your needs.

[yatiksihag01]

Yes, now it's working fine.