FileUtils-test.js

/*
 * GNU AGPL-3.0 License
 *
 * Copyright (c) 2021 - present core.ai . All rights reserved.
 * Original work Copyright (c) 2013 - 2021 Adobe Systems Incorporated. All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see https://opensource.org/licenses/AGPL-3.0.
 *
 */

/*global describe, it, expect, beforeEach, afterEach, spyOn */
/*unittests: FileUtils*/

define(function (require, exports, module) {


    var FileUtils = require("file/FileUtils");

    describe("FileUtils", function () {
        describe("convertWindowsPathToUnixPath", function () {
            var origPlatform;

            beforeEach(function () {
                origPlatform = brackets.platform;
            });

            afterEach(function () {
                brackets.platform = origPlatform;
            });

            it("should convert a Windows path to a Unix-style path when on Windows", function () {
                brackets.platform = "win";
                expect(FileUtils.convertWindowsPathToUnixPath("C:\\foo\\bar\\baz.txt")).toBe("C:/foo/bar/baz.txt");
            });

            it("should not modify a native path when on Mac, even if it has backslashes", function () {
                brackets.platform = "mac";
                expect(FileUtils.convertWindowsPathToUnixPath("/some/back\\slash/path.txt")).toBe("/some/back\\slash/path.txt");
            });
        });

        describe("convertToNativePath", function () {
            it("should convert windows URL syntax to Windows native path.", function () {
                expect(FileUtils.convertToNativePath("/C:/foo/bar/baz.txt")).toBe("C:/foo/bar/baz.txt");
            });

            it("should not modify a windows non-URL path syntax.", function () {
                expect(FileUtils.convertToNativePath("C:/foo/bar/baz.txt")).toBe("C:/foo/bar/baz.txt");
            });

            it("should not modify a posix path.", function () {
                expect(FileUtils.convertToNativePath("/foo/bar/baz.txt")).toBe("/foo/bar/baz.txt");
                expect(FileUtils.convertToNativePath("foo/bar/baz.txt")).toBe("foo/bar/baz.txt");
                expect(FileUtils.convertToNativePath("/foo/bar/")).toBe("/foo/bar/");
                expect(FileUtils.convertToNativePath("foo/bar/")).toBe("foo/bar/");
            });
        });

        describe("getDirectoryPath", function () {

            it("should get the parent directory of a normalized win file path", function () {
                expect(FileUtils.getDirectoryPath("C:/foo/bar/baz.txt")).toBe("C:/foo/bar/");
            });

            it("should get the parent directory of a posix file path", function () {
                expect(FileUtils.getDirectoryPath("/foo/bar/baz.txt")).toBe("/foo/bar/");
            });

            it("should return the unchanged directory of a normalized win directory path", function () {
                expect(FileUtils.getDirectoryPath("C:/foo/bar/")).toBe("C:/foo/bar/");
            });

            it("should return the unchanged directory of a posix directory path", function () {
                expect(FileUtils.getDirectoryPath("/foo/bar/")).toBe("/foo/bar/");
            });

            it("should return the unchanged directory of a root path", function () {
                expect(FileUtils.getDirectoryPath("C:/")).toBe("C:/");
                expect(FileUtils.getDirectoryPath("/")).toBe("/");
            });
        });

        describe("getParentPath", function () {

            it("should get the parent directory of a normalized file path", function () {
                expect(FileUtils.getParentPath("C:/foo/bar/baz.txt")).toBe("C:/foo/bar/");
                expect(FileUtils.getParentPath("/foo/bar/baz.txt")).toBe("/foo/bar/");
            });

            it("should return the parent directory of a normalized directory path", function () {
                expect(FileUtils.getParentPath("C:/foo/bar/")).toBe("C:/foo/");
                expect(FileUtils.getParentPath("/foo/bar/")).toBe("/foo/");
            });

            it("should return '' given a root path", function () {
                expect(FileUtils.getParentPath("C:/")).toBe("");
                expect(FileUtils.getParentPath("/")).toBe("");
            });
        });

        describe("getBaseName", function () {

            it("should get the file name of a normalized win file path", function () {
                expect(FileUtils.getBaseName("C:/foo/bar/baz.txt")).toBe("baz.txt");
            });

            it("should get the file name of a posix file path", function () {
                expect(FileUtils.getBaseName("/foo/bar/baz.txt")).toBe("baz.txt");
            });

            it("should return the directory name of a normalized win directory path", function () {
                expect(FileUtils.getBaseName("C:/foo/bar/")).toBe("bar");
            });

            it("should return the directory name of a posix directory path", function () {
                expect(FileUtils.getBaseName("C:/foo/bar/")).toBe("bar");
            });

            it("should return the file name of a path containing #", function () {
                expect(FileUtils.getBaseName("C:/foo/bar/#baz/jaz.txt")).toBe("jaz.txt");
                expect(FileUtils.getBaseName("C:/foo/bar/baz/#jaz.txt")).toBe("#jaz.txt");
            });

            it("should return the directory name of a path containing #", function () {
                expect(FileUtils.getBaseName("C:/foo/bar/#baz/jaz/")).toBe("jaz");
                expect(FileUtils.getBaseName("C:/foo/bar/baz/#jaz/")).toBe("#jaz");
            });
        });

        describe("getFileExtension", function () {

            it("should get the extension of a normalized win file path", function () {
                expect(FileUtils.getFileExtension("C:/foo/bar/baz.txt")).toBe("txt");
            });

            it("should get the extension of a posix file path", function () {
                expect(FileUtils.getFileExtension("/foo/bar/baz.txt")).toBe("txt");
            });

            it("should return empty extension for a normalized win directory path", function () {
                expect(FileUtils.getFileExtension("C:/foo/bar/")).toBe("");
            });

            it("should return empty extension for a posix directory path", function () {
                expect(FileUtils.getFileExtension("bar")).toBe("");
            });

            it("should return the extension of a filename containing .", function () {
                expect(FileUtils.getFileExtension("C:/foo/bar/.baz/jaz.txt")).toBe("txt");
                expect(FileUtils.getFileExtension("foo/bar/baz/.jaz.txt")).toBe("txt");
                expect(FileUtils.getFileExtension("foo.bar.baz..jaz.txt")).toBe("txt");
            });
        });

        describe("getFilenameWithoutExtension", function () {

            it("should remove last extension segment only", function () {
                expect(FileUtils.getFilenameWithoutExtension("foo.txt")).toBe("foo");
                expect(FileUtils.getFilenameWithoutExtension("foo.min.txt")).toBe("foo.min");
                expect(FileUtils.getFilenameWithoutExtension("foo")).toBe("foo");

                expect(FileUtils.getFilenameWithoutExtension(".foo")).toBe("");
            });
        });

        describe("encodeFilePath", function () {

            it("should encode symbols in path", function () {
                expect(FileUtils.encodeFilePath("#?@test&\".js")).toBe("%23%3F%40test%26%22.js");
            });

            it("should work with a common path", function () {
                expect(FileUtils.encodeFilePath("C:/test/$data.txt")).toBe("C%3A/test/%24data.txt");
            });

            it("should work with a path with no special symbols", function () {
                expect(FileUtils.encodeFilePath("/Applications/Test/test.html")).toBe("/Applications/Test/test.html");
            });
        });

        describe("compareFilenames", function () {

            it("should compare filenames using German rules", function () {
                spyOn(brackets, "getLocale").and.returnValue("de-DE");
                // Should be like this: Äckerman, Adler, Rossi, Xavier
                expect(FileUtils.compareFilenames("Äckerman", "Adler", false)).toBeLessThan(0);
                expect(FileUtils.compareFilenames("Adler", "Rossi", false)).toBeLessThan(0);
                expect(FileUtils.compareFilenames("Rossi", "Xavier", false)).toBeLessThan(0);
            });

            it("should compare filenames using Swedish rules", function () {
                spyOn(brackets, "getLocale").and.returnValue("sv");
                // Should be like this: Adler, Rossie, Xavier, Äckerman
                expect(FileUtils.compareFilenames("Adler", "Rossie", false)).toBeLessThan(0);
                expect(FileUtils.compareFilenames("Rossie", "Xavier", false)).toBeLessThan(0);
                expect(FileUtils.compareFilenames("Xavier", "Äckerman", false)).toBeLessThan(0);
            });
        });
    });
});