VmlTest::testAddComments() - Code Metrics - Inspection of "Better Handling of legacyDrawing Xml" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#4122)

by Owen

created 2024-08-12 16:11 UTC

VmlTest::testAddComments() B

↳ Parent: VmlTest

Complexity

Conditions	5
Paths	1

Size

Total Lines	53
Code Lines	47

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	47
c	1
b	0
f	0
dl	0
loc	53
rs	8.8452
cc	5
nc	1
nop	0

How to fix Long Method

<?php

declare(strict_types=1);

namespace PhpOffice\PhpSpreadsheetTests\Reader\Xlsx;

use PhpOffice\PhpSpreadsheet\Reader\Xlsx as XlsxReader;
use PhpOffice\PhpSpreadsheet\Shared\File;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Writer\Xlsx as XlsxWriter;
use PHPUnit\Framework\TestCase;

class VmlTest extends TestCase
{
    private string $outfile1 = '';

    private string $outfile2 = '';

    protected function tearDown(): void
    {
        if ($this->outfile1 !== '') {
            unlink($this->outfile1);
            $this->outfile1 = '';
        }
        if ($this->outfile2 !== '') {
            unlink($this->outfile2);
            $this->outfile2 = '';
        }
    }

    public function testAddComments(): void
    {
        $spreadsheet = new Spreadsheet();
        $sheet = $spreadsheet->getActiveSheet();
        $sheet->getComment('A1')->getText()->createText('top left cell');
        $writer = new XlsxWriter($spreadsheet);
        $this->outfile1 = File::temporaryFileName();
        $writer->save($this->outfile1);
        $spreadsheet->disconnectWorksheets();

        $reader = new XlsxReader();
        $file = 'zip://' . $this->outfile1 . '#xl/worksheets/sheet1.xml';
        $sheetContents = file_get_contents($file) ?: '';
        self::assertStringContainsString('<legacyDrawing ', $sheetContents);
        $file = 'zip://' . $this->outfile1 . '#xl/drawings/vmlDrawing1.vml';
        $vmlContents = file_get_contents($file) ?: '';
        $count = substr_count($vmlContents, '<v:shape ');
        self::assertSame(1, $count);
        $count = substr_count($vmlContents, '<x:ClientData ObjectType="Note">');
        self::assertSame(1, $count);

        $spreadsheet2 = $reader->load($this->outfile1);
        $sheet2 = $spreadsheet2->getActiveSheet();
        self::assertSame('top left cell', $sheet2->getComment('A1')->getText()->getPlainText());
        self::assertNull($spreadsheet2->getLegacyDrawing($sheet2));
        $sheet2->getComment('H1')->getText()->createText('Show me');
        $sheet2->getComment('H2')->getText()->createText('Hide me');
        $sheet2->getComment('H1')->setVisible(true);
        $writer = new XlsxWriter($spreadsheet2);
        $this->outfile2 = File::temporaryFileName();
        $writer->save($this->outfile2);
        $spreadsheet2->disconnectWorksheets();

        $file = 'zip://' . $this->outfile2 . '#xl/worksheets/sheet1.xml';
        $sheetContents = file_get_contents($file) ?: '';
        self::assertStringContainsString('<legacyDrawing ', $sheetContents);
        $file = 'zip://' . $this->outfile2 . '#xl/drawings/vmlDrawing1.vml';
        $vmlContents = file_get_contents($file) ?: '';
        $count = substr_count($vmlContents, '<v:shape ');
        self::assertSame(3, $count);
        $count = substr_count($vmlContents, '<x:ClientData ObjectType="Note">');
        self::assertSame(3, $count);

        $reader = new XlsxReader();
        $spreadsheet3 = $reader->load($this->outfile2);
        $sheet3 = $spreadsheet3->getActiveSheet();
        self::assertSame('top left cell', $sheet3->getComment('A1')->getText()->getPlainText());
        self::assertSame('Show me', $sheet3->getComment('H1')->getText()->getPlainText());
        self::assertSame('Hide me', $sheet3->getComment('H2')->getText()->getPlainText());
        self::assertNull($spreadsheet3->getLegacyDrawing($sheet3));
        self::assertTrue($sheet3->getComment('H1')->getVisible());
        self::assertFalse($sheet3->getComment('H2')->getVisible());
        $spreadsheet3->disconnectWorksheets();
    }

    public function testDeleteNullLegacy(): void
    {
        $spreadsheet = new Spreadsheet();
        $sheet = $spreadsheet->getActiveSheet();
        $sheet->getComment('A1')->getText()->createText('top left cell');
        self::assertNull($spreadsheet->getLegacyDrawing($sheet));
        $spreadsheet->deleteLegacyDrawing($sheet);
        $writer = new XlsxWriter($spreadsheet);
        $this->outfile1 = File::temporaryFileName();
        $writer->save($this->outfile1);
        $spreadsheet->disconnectWorksheets();

        $reader = new XlsxReader();
        $file = 'zip://' . $this->outfile1 . '#xl/worksheets/sheet1.xml';
        $sheetContents = file_get_contents($file) ?: '';
        self::assertStringContainsString('<legacyDrawing ', $sheetContents);
        $file = 'zip://' . $this->outfile1 . '#xl/drawings/vmlDrawing1.vml';
        $vmlContents = file_get_contents($file) ?: '';
        $count = substr_count($vmlContents, '<v:shape ');
        self::assertSame(1, $count);
        $count = substr_count($vmlContents, '<x:ClientData ObjectType="Note">');
        self::assertSame(1, $count);

        $spreadsheet2 = $reader->load($this->outfile1);
        $sheet2 = $spreadsheet2->getActiveSheet();
        self::assertSame('top left cell', $sheet2->getComment('A1')->getText()->getPlainText());
        $spreadsheet2->disconnectWorksheets();
    }

    public function testAddCommentDeleteFormControls(): void
    {
        $infile = 'samples/Reader2/sampleData/formscomments.xlsx';
        $reader = new XlsxReader();
        $reader->setLoadSheetsOnly('FormsComments');
        $spreadsheet = $reader->load($infile);
        self::assertTrue(true);
        $sheet = $spreadsheet->getActiveSheet();
        self::assertSame('row1', $sheet->getCell('H1')->getValue());
        self::assertStringContainsString('Hello', $sheet->getComment('F1')->getText()->getPlainText());
        $vmlContents = $spreadsheet->getLegacyDrawing($sheet) ?? '';
        $count = substr_count($vmlContents, '<v:shape ');
        self::assertSame(4, $count);
        $count = substr_count($vmlContents, '<x:ClientData ');
        self::assertSame(4, $count);
        $count = substr_count($vmlContents, '<x:ClientData ObjectType="Note"');
        self::assertSame(1, $count);
        $spreadsheet->deleteLegacyDrawing($sheet);
        $sheet->getComment('F2')->getText()->createText('Goodbye');
        $writer = new XlsxWriter($spreadsheet);
        $this->outfile1 = File::temporaryFileName();
        $writer->save($this->outfile1);
        $spreadsheet->disconnectWorksheets();

        $reader2 = new XlsxReader();
        $spreadsheet2 = $reader2->load($this->outfile1);
        $sheet2 = $spreadsheet2->getActiveSheet();
        self::assertNull($spreadsheet2->getLegacyDrawing($sheet2));
        self::assertSame('row1', $sheet2->getCell('H1')->getValue());
        self::assertStringContainsString('Hello', $sheet2->getComment('F1')->getText()->getPlainText());
        self::assertStringContainsString('Goodbye', $sheet2->getComment('F2')->getText()->getPlainText());
        $spreadsheet2->disconnectWorksheets();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace PhpOffice\PhpSpreadsheetTests\Reader\Xlsx;
6
7			use PhpOffice\PhpSpreadsheet\Reader\Xlsx as XlsxReader;
8			use PhpOffice\PhpSpreadsheet\Shared\File;
9			use PhpOffice\PhpSpreadsheet\Spreadsheet;
10			use PhpOffice\PhpSpreadsheet\Writer\Xlsx as XlsxWriter;
11			use PHPUnit\Framework\TestCase;
12
13			class VmlTest extends TestCase
14			{
15			private string $outfile1 = '';
16
17			private string $outfile2 = '';
18
19			protected function tearDown(): void
20			{
21			if ($this->outfile1 !== '') {
22			unlink($this->outfile1);
23			$this->outfile1 = '';
24			}
25			if ($this->outfile2 !== '') {
26			unlink($this->outfile2);
27			$this->outfile2 = '';
28			}
29			}
30
31			public function testAddComments(): void
32			{
33			$spreadsheet = new Spreadsheet();
34			$sheet = $spreadsheet->getActiveSheet();
35			$sheet->getComment('A1')->getText()->createText('top left cell');
36			$writer = new XlsxWriter($spreadsheet);
37			$this->outfile1 = File::temporaryFileName();
38			$writer->save($this->outfile1);
39			$spreadsheet->disconnectWorksheets();
40
41			$reader = new XlsxReader();
42			$file = 'zip://' . $this->outfile1 . '#xl/worksheets/sheet1.xml';
43			$sheetContents = file_get_contents($file) ?: '';
44			self::assertStringContainsString('<legacyDrawing ', $sheetContents);
45			$file = 'zip://' . $this->outfile1 . '#xl/drawings/vmlDrawing1.vml';
46			$vmlContents = file_get_contents($file) ?: '';
47			$count = substr_count($vmlContents, '<v:shape ');
48			self::assertSame(1, $count);
49			$count = substr_count($vmlContents, '<x:ClientData ObjectType="Note">');
50			self::assertSame(1, $count);
51
52			$spreadsheet2 = $reader->load($this->outfile1);
53			$sheet2 = $spreadsheet2->getActiveSheet();
54			self::assertSame('top left cell', $sheet2->getComment('A1')->getText()->getPlainText());
55			self::assertNull($spreadsheet2->getLegacyDrawing($sheet2));
56			$sheet2->getComment('H1')->getText()->createText('Show me');
57			$sheet2->getComment('H2')->getText()->createText('Hide me');
58			$sheet2->getComment('H1')->setVisible(true);
59			$writer = new XlsxWriter($spreadsheet2);
60			$this->outfile2 = File::temporaryFileName();
61			$writer->save($this->outfile2);
62			$spreadsheet2->disconnectWorksheets();
63
64			$file = 'zip://' . $this->outfile2 . '#xl/worksheets/sheet1.xml';
65			$sheetContents = file_get_contents($file) ?: '';
66			self::assertStringContainsString('<legacyDrawing ', $sheetContents);
67			$file = 'zip://' . $this->outfile2 . '#xl/drawings/vmlDrawing1.vml';
68			$vmlContents = file_get_contents($file) ?: '';
69			$count = substr_count($vmlContents, '<v:shape ');
70			self::assertSame(3, $count);
71			$count = substr_count($vmlContents, '<x:ClientData ObjectType="Note">');
72			self::assertSame(3, $count);
73
74			$reader = new XlsxReader();
75			$spreadsheet3 = $reader->load($this->outfile2);
76			$sheet3 = $spreadsheet3->getActiveSheet();
77			self::assertSame('top left cell', $sheet3->getComment('A1')->getText()->getPlainText());
78			self::assertSame('Show me', $sheet3->getComment('H1')->getText()->getPlainText());
79			self::assertSame('Hide me', $sheet3->getComment('H2')->getText()->getPlainText());
80			self::assertNull($spreadsheet3->getLegacyDrawing($sheet3));
81			self::assertTrue($sheet3->getComment('H1')->getVisible());
82			self::assertFalse($sheet3->getComment('H2')->getVisible());
83			$spreadsheet3->disconnectWorksheets();
84			}
85
86			public function testDeleteNullLegacy(): void
87			{
88			$spreadsheet = new Spreadsheet();
89			$sheet = $spreadsheet->getActiveSheet();
90			$sheet->getComment('A1')->getText()->createText('top left cell');
91			self::assertNull($spreadsheet->getLegacyDrawing($sheet));
92			$spreadsheet->deleteLegacyDrawing($sheet);
93			$writer = new XlsxWriter($spreadsheet);
94			$this->outfile1 = File::temporaryFileName();
95			$writer->save($this->outfile1);
96			$spreadsheet->disconnectWorksheets();
97
98			$reader = new XlsxReader();
99			$file = 'zip://' . $this->outfile1 . '#xl/worksheets/sheet1.xml';
100			$sheetContents = file_get_contents($file) ?: '';
101			self::assertStringContainsString('<legacyDrawing ', $sheetContents);
102			$file = 'zip://' . $this->outfile1 . '#xl/drawings/vmlDrawing1.vml';
103			$vmlContents = file_get_contents($file) ?: '';
104			$count = substr_count($vmlContents, '<v:shape ');
105			self::assertSame(1, $count);
106			$count = substr_count($vmlContents, '<x:ClientData ObjectType="Note">');
107			self::assertSame(1, $count);
108
109			$spreadsheet2 = $reader->load($this->outfile1);
110			$sheet2 = $spreadsheet2->getActiveSheet();
111			self::assertSame('top left cell', $sheet2->getComment('A1')->getText()->getPlainText());
112			$spreadsheet2->disconnectWorksheets();
113			}
114
115			public function testAddCommentDeleteFormControls(): void
116			{
117			$infile = 'samples/Reader2/sampleData/formscomments.xlsx';
118			$reader = new XlsxReader();
119			$reader->setLoadSheetsOnly('FormsComments');
120			$spreadsheet = $reader->load($infile);
121			self::assertTrue(true);
122			$sheet = $spreadsheet->getActiveSheet();
123			self::assertSame('row1', $sheet->getCell('H1')->getValue());
124			self::assertStringContainsString('Hello', $sheet->getComment('F1')->getText()->getPlainText());
125			$vmlContents = $spreadsheet->getLegacyDrawing($sheet) ?? '';
126			$count = substr_count($vmlContents, '<v:shape ');
127			self::assertSame(4, $count);
128			$count = substr_count($vmlContents, '<x:ClientData ');
129			self::assertSame(4, $count);
130			$count = substr_count($vmlContents, '<x:ClientData ObjectType="Note"');
131			self::assertSame(1, $count);
132			$spreadsheet->deleteLegacyDrawing($sheet);
133			$sheet->getComment('F2')->getText()->createText('Goodbye');
134			$writer = new XlsxWriter($spreadsheet);
135			$this->outfile1 = File::temporaryFileName();
136			$writer->save($this->outfile1);
137			$spreadsheet->disconnectWorksheets();
138
139			$reader2 = new XlsxReader();
140			$spreadsheet2 = $reader2->load($this->outfile1);
141			$sheet2 = $spreadsheet2->getActiveSheet();
142			self::assertNull($spreadsheet2->getLegacyDrawing($sheet2));
143			self::assertSame('row1', $sheet2->getCell('H1')->getValue());
144			self::assertStringContainsString('Hello', $sheet2->getComment('F1')->getText()->getPlainText());
145			self::assertStringContainsString('Goodbye', $sheet2->getComment('F2')->getText()->getPlainText());
146			$spreadsheet2->disconnectWorksheets();
147			}
148			}
149

PHPOffice / PhpSpreadsheet

Pull Request — master (#4122)

VmlTest::testAddComments() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like