tFormatCode.m

% Copyright 2025 The MathWorks, Inc.
classdef tFormatCode < matlab.unittest.TestCase
    properties (Constant)
        CodeToFormat = sprintf('if true\nx = 1;\nif true\ny = 2;\nend\nend');
    end

    methods (TestClassSetup)
        function isApplicable (testCase)
            % Determine if the test should be skipped in the current environment
            isTestingEnvironment = ~isempty(getenv('MATLAB_TEST_ENVIRONMENT'));
            shouldRun = ~(isMATLABReleaseOlderThan('R2024b') && isTestingEnvironment);

            testCase.assumeTrue(...
                shouldRun,...
                "Document formatting test cannot run prior to 24b in GitHub test environment.");
        end

        function setup (~)
            % Add function under test to path
            addpath("../../../../../matlab");
        end
    end

    methods (Test)
        % Test correct formatting with spaces when the tab size is 4.
        % Each indent should be represented by 4 spaces.
        function testFormatting4WithSpaces (testCase)
            options.insertSpaces = true;
            options.tabSize = 4;

            expected = sprintf('if true\n    x = 1;\n    if true\n        y = 2;\n    end\nend');
            actual = matlabls.handlers.formatting.formatCode(testCase.CodeToFormat, options);

            testCase.verifyEqual(actual, expected);
        end

        % Test correct formatting with tabs when the tab size is 4.
        % Each indent should be represented by 1 tab character.
        function testFormatting4WithTabs (testCase)
            options.insertSpaces = false;
            options.tabSize = 4;

            expected = sprintf('if true\n\tx = 1;\n\tif true\n\t\ty = 2;\n\tend\nend');
            actual = matlabls.handlers.formatting.formatCode(testCase.CodeToFormat, options);

            testCase.verifyEqual(actual, expected);
        end

        % Test correct formatting with spaces when the tab size is 6.
        % Each indent should be represented by 6 spaces.
        function testFormatting6WithSpaces (testCase)
            options.insertSpaces = true;
            options.tabSize = 6;

            expected = sprintf('if true\n      x = 1;\n      if true\n            y = 2;\n      end\nend');
            actual = matlabls.handlers.formatting.formatCode(testCase.CodeToFormat, options);

            testCase.verifyEqual(actual, expected);
        end

        % Test correct formatting with tabs when the tab size is 6.
        % Each indent should be represented by 1 tab character.
        function testFormatting6WithTabs (testCase)
            options.insertSpaces = false;
            options.tabSize = 4;

            expected = sprintf('if true\n\tx = 1;\n\tif true\n\t\ty = 2;\n\tend\nend');
            actual = matlabls.handlers.formatting.formatCode(testCase.CodeToFormat, options);

            testCase.verifyEqual(actual, expected);
        end
    end
end