<?php
/**
 * PHPCompatibility, an external standard for PHP_CodeSniffer.
 *
 * @package   PHPCompatibility
 * @copyright 2012-2020 PHPCompatibility Contributors
 * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
 * @link      https://github.com/PHPCompatibility/PHPCompatibility
 */

namespace PHPCompatibility\Tests\FunctionDeclarations;

use PHPCompatibility\Tests\BaseSniffTestCase;

/**
 * Test the NewTrailingComma sniff.
 *
 * @group newTrailingComma
 * @group syntax
 *
 * @covers \PHPCompatibility\Sniffs\FunctionDeclarations\NewTrailingCommaSniff
 *
 * @since 10.0.0
 */
class NewTrailingCommaUnitTest extends BaseSniffTestCase
{

    /**
     * Test correctly identifying trailing commas in function declarations.
     *
     * @dataProvider dataTrailingComma
     *
     * @param int $line The line number.
     *
     * @return void
     */
    public function testTrailingComma($line)
    {
        $file = $this->sniffFile(__FILE__, '7.4');
        $this->assertError($file, $line, 'Trailing commas are not allowed in function declaration parameter lists in PHP 7.4 or earlier');
    }

    /**
     * Data provider.
     *
     * @see testTrailingComma()
     *
     * @return array
     */
    public static function dataTrailingComma()
    {
        return [
            [39],
            [44],
            [48],
            [59],
            [75],
            [89],
            [94],
        ];
    }


    /**
     * Test correctly identifying trailing commas in closure use lists.
     *
     * @dataProvider dataTrailingCommaClosureUse
     *
     * @param int $line The line number.
     *
     * @return void
     */
    public function testTrailingCommaClosureUse($line)
    {
        $file = $this->sniffFile(__FILE__, '7.4');
        $this->assertError($file, $line, 'Trailing commas are not allowed in closure use lists in PHP 7.4 or earlier');
    }

    /**
     * Data provider.
     *
     * @see testTrailingCommaClosureUse()
     *
     * @return array
     */
    public static function dataTrailingCommaClosureUse()
    {
        return [
            [68],
            [79],
            [91],
        ];
    }


    /**
     * Verify the sniff does not throw false positives for valid code.
     *
     * @dataProvider dataNoFalsePositives
     *
     * @param int $line The line number.
     *
     * @return void
     */
    public function testNoFalsePositives($line)
    {
        $file = $this->sniffFile(__FILE__, '7.4');
        $this->assertNoViolation($file, $line);
    }

    /**
     * Data provider.
     *
     * @see testNoFalsePositives()
     *
     * @return array
     */
    public static function dataNoFalsePositives()
    {
        // No errors expected on the first 33 lines.
        $data = [];
        for ($line = 1; $line <= 33; $line++) {
            $data[] = [$line];
        }

        $data[] = [97];
        $data[] = [99];
        $data[] = [103];

        return $data;
    }


    /**
     * Verify no notices are thrown at all.
     *
     * @return void
     */
    public function testNoViolationsInFileOnValidVersion()
    {
        $file = $this->sniffFile(__FILE__, '8.0');
        $this->assertNoViolation($file);
    }
}
