OdsTest - Code Metrics - Inspection of "Remove extra lines" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( c46008...bae234 )

by Adrien

created 2017-12-31 13:04 UTC

OdsTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	210
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	210
rs	10
wmc	12

10 Methods

Rating	Name	Size	Complexity
A	testReadFileProperties()	13	1
A	testLoadWorksheets()	13	1
A	testReadRichText()	9	1
A	testReadCellsWithRepeatedSpaces()	9	1
A	testReadColors()	12	1
A	testReadValueAndComments()	63	1
A	loadDataFile()	11	2
A	testReadBoldItalicUnderline()	20	1
A	testReadHyperlinks()	10	1
A	loadOdsTestFile()	11	2

<?php

namespace PhpOffice\PhpSpreadsheetTests\Reader;

use PhpOffice\PhpSpreadsheet\Cell\DataType;
use PhpOffice\PhpSpreadsheet\Reader\Ods;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Style\Font;
use PHPUnit\Framework\TestCase;

/**
 * @todo The class doesn't read the bold/italic/underline properties (rich text)
 */
class OdsTest extends TestCase
{
    /**
     * @var Spreadsheet
     */
    private $spreadsheetOdsTest;

    /**
     * @var Spreadsheet
     */
    private $spreadsheetData;

    /**
     * @return Spreadsheet
     */
    private function loadOdsTestFile()
    {
        if (!$this->spreadsheetOdsTest) {
            $filename = __DIR__ . '/../../../samples/templates/OOCalcTest.ods';

            // Load into this instance
            $reader = new Ods();
            $this->spreadsheetOdsTest = $reader->loadIntoExisting($filename, new Spreadsheet());
        }

        return $this->spreadsheetOdsTest;
    }

    /**
     * @return Spreadsheet
     */
    protected function loadDataFile()
    {
        if (!$this->spreadsheetData) {
            $filename = __DIR__ . '/../../data/Reader/Ods/data.ods';

            // Load into this instance
            $reader = new Ods();
            $this->spreadsheetData = $reader->loadIntoExisting($filename, new Spreadsheet());
        }

        return $this->spreadsheetData;
    }

    public function testReadFileProperties()
    {
        $filename = __DIR__ . '/../../data/Reader/Ods/data.ods';

        // Load into this instance
        $reader = new Ods();

        // Test "listWorksheetNames" method

        self::assertEquals([
            'Sheet1',
            'Second Sheet',
        ], $reader->listWorksheetNames($filename));
    }

    public function testLoadWorksheets()
    {
        $spreadsheet = $this->loadDataFile();

        self::assertInstanceOf('PhpOffice\PhpSpreadsheet\Spreadsheet', $spreadsheet);

        self::assertEquals(2, $spreadsheet->getSheetCount());

        $firstSheet = $spreadsheet->getSheet(0);
        self::assertInstanceOf('PhpOffice\PhpSpreadsheet\Worksheet\Worksheet', $firstSheet);

        $secondSheet = $spreadsheet->getSheet(1);
        self::assertInstanceOf('PhpOffice\PhpSpreadsheet\Worksheet\Worksheet', $secondSheet);
    }

    public function testReadValueAndComments()
    {
        $spreadsheet = $this->loadOdsTestFile();

        $firstSheet = $spreadsheet->getSheet(0);

        self::assertEquals(29, $firstSheet->getHighestRow());
        self::assertEquals('N', $firstSheet->getHighestColumn());

        // Simple cell value
        self::assertEquals('Test String 1', $firstSheet->getCell('A1')->getValue());

        // Merged cell
        self::assertEquals('BOX', $firstSheet->getCell('B18')->getValue());

        // Comments/Annotations
        self::assertEquals(
            'Test for a simple colour-formatted string',
            $firstSheet->getComment('A1')->getText()->getPlainText()
        );

        // Data types
        self::assertEquals(DataType::TYPE_STRING, $firstSheet->getCell('A1')->getDataType());
        self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('B1')->getDataType()); // Int

        self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('B6')->getDataType()); // Float
        self::assertEquals(1.23, $firstSheet->getCell('B6')->getValue());
        self::assertEquals(0, $firstSheet->getCell('G10')->getValue());

        self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A10')->getDataType()); // Date
        self::assertEquals(22269.0, $firstSheet->getCell('A10')->getValue());

        self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A13')->getDataType()); // Time
        self::assertEquals(25569.0625, $firstSheet->getCell('A13')->getValue());

        self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A15')->getDataType()); // Date + Time
        self::assertEquals(22269.0625, $firstSheet->getCell('A15')->getValue());

        self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A11')->getDataType()); // Fraction

        self::assertEquals(DataType::TYPE_BOOL, $firstSheet->getCell('D6')->getDataType());
        self::assertTrue($firstSheet->getCell('D6')->getValue());

        self::assertEquals(DataType::TYPE_FORMULA, $firstSheet->getCell('C6')->getDataType()); // Formula
        self::assertEquals('=TRUE()', $firstSheet->getCell('C6')->getValue()); // Formula

        // Percentage, Currency

        $spreadsheet = $this->loadDataFile();

        $firstSheet = $spreadsheet->getSheet(0);

        self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A1')->getDataType()); // Percentage (10%)

        self::assertEquals(0.1, $firstSheet->getCell('A1')->getValue());

        self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A2')->getDataType()); // Percentage (10.00%)

        self::assertEquals(0.1, $firstSheet->getCell('A2')->getValue());

        self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A4')->getDataType()); // Currency (€10.00)

        self::assertEquals(10, $firstSheet->getCell('A4')->getValue());

        self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A5')->getDataType()); // Currency ($20)

        self::assertEquals(20, $firstSheet->getCell('A5')->getValue());
    }

    public function testReadColors()
    {
        $spreadsheet = $this->loadOdsTestFile();
        $firstSheet = $spreadsheet->getSheet(0);

        // Background color

        $style = $firstSheet->getCell('K3')->getStyle();

        self::assertEquals('none', $style->getFill()->getFillType());
        self::assertEquals('FFFFFFFF', $style->getFill()->getStartColor()->getARGB());
        self::assertEquals('FF000000', $style->getFill()->getEndColor()->getARGB());
    }

    public function testReadRichText()
    {
        $spreadsheet = $this->loadOdsTestFile();
        $firstSheet = $spreadsheet->getSheet(0);

        self::assertEquals(
            "I don't know if OOCalc supports Rich Text in the same way as Excel, " .
            'And this row should be autofit height with text wrap',
            $firstSheet->getCell('A28')->getValue()
        );
    }

    public function testReadCellsWithRepeatedSpaces()
    {
        $spreadsheet = $this->loadDataFile();
        $firstSheet = $spreadsheet->getSheet(0);

        self::assertEquals('This has    4 spaces before and 2 after  ', $firstSheet->getCell('A8')->getValue());
        self::assertEquals('This only one after ', $firstSheet->getCell('A9')->getValue());
        self::assertEquals('Test with DIFFERENT styles     and multiple spaces:  ', $firstSheet->getCell('A10')->getValue());
        self::assertEquals("test with new \nLines", $firstSheet->getCell('A11')->getValue());
    }

    public function testReadHyperlinks()
    {
        $spreadsheet = $this->loadOdsTestFile();
        $firstSheet = $spreadsheet->getSheet(0);

        $hyperlink = $firstSheet->getCell('A29');

        self::assertEquals(DataType::TYPE_STRING, $hyperlink->getDataType());
        self::assertEquals('PhpSpreadsheet', $hyperlink->getValue());
        self::assertEquals('https://github.com/PHPOffice/phpspreadsheet', $hyperlink->getHyperlink()->getUrl());
    }

    // Below some test for features not implemented yet

    public function testReadBoldItalicUnderline()
    {
        $this->markTestIncomplete('Features not implemented yet');

        $spreadsheet = $this->loadOdsTestFile();
        $firstSheet = $spreadsheet->getSheet(0);

        // Font styles

        $style = $firstSheet->getCell('A1')->getStyle();
        self::assertEquals('FF000000', $style->getFont()->getColor()->getARGB());
        self::assertEquals(11, $style->getFont()->getSize());
        self::assertEquals(Font::UNDERLINE_NONE, $style->getFont()->getUnderline());

        $style = $firstSheet->getCell('E3')->getStyle();
        self::assertEquals(Font::UNDERLINE_SINGLE, $style->getFont()->getUnderline());

        $style = $firstSheet->getCell('E1')->getStyle();
        self::assertTrue($style->getFont()->getBold());
        self::assertTrue($style->getFont()->getItalic());
    }
}


1			<?php
2
3			namespace PhpOffice\PhpSpreadsheetTests\Reader;
4
5			use PhpOffice\PhpSpreadsheet\Cell\DataType;
6			use PhpOffice\PhpSpreadsheet\Reader\Ods;
7			use PhpOffice\PhpSpreadsheet\Spreadsheet;
8			use PhpOffice\PhpSpreadsheet\Style\Font;
9			use PHPUnit\Framework\TestCase;
10
11			/**
12			* @todo The class doesn't read the bold/italic/underline properties (rich text)
13			*/
14			class OdsTest extends TestCase
15			{
16			/**
17			* @var Spreadsheet
18			*/
19			private $spreadsheetOdsTest;
20
21			/**
22			* @var Spreadsheet
23			*/
24			private $spreadsheetData;
25
26			/**
27			* @return Spreadsheet
28			*/
29			private function loadOdsTestFile()
30			{
31			if (!$this->spreadsheetOdsTest) {
32			$filename = __DIR__ . '/../../../samples/templates/OOCalcTest.ods';
33
34			// Load into this instance
35			$reader = new Ods();
36			$this->spreadsheetOdsTest = $reader->loadIntoExisting($filename, new Spreadsheet());
37			}
38
39			return $this->spreadsheetOdsTest;
40			}
41
42			/**
43			* @return Spreadsheet
44			*/
45			protected function loadDataFile()
46			{
47			if (!$this->spreadsheetData) {
48			$filename = __DIR__ . '/../../data/Reader/Ods/data.ods';
49
50			// Load into this instance
51			$reader = new Ods();
52			$this->spreadsheetData = $reader->loadIntoExisting($filename, new Spreadsheet());
53			}
54
55			return $this->spreadsheetData;
56			}
57
58			public function testReadFileProperties()
59			{
60			$filename = __DIR__ . '/../../data/Reader/Ods/data.ods';
61
62			// Load into this instance
63			$reader = new Ods();
64
65			// Test "listWorksheetNames" method
66
67			self::assertEquals([
68			'Sheet1',
69			'Second Sheet',
70			], $reader->listWorksheetNames($filename));
71			}
72
73			public function testLoadWorksheets()
74			{
75			$spreadsheet = $this->loadDataFile();
76
77			self::assertInstanceOf('PhpOffice\PhpSpreadsheet\Spreadsheet', $spreadsheet);
78
79			self::assertEquals(2, $spreadsheet->getSheetCount());
80
81			$firstSheet = $spreadsheet->getSheet(0);
82			self::assertInstanceOf('PhpOffice\PhpSpreadsheet\Worksheet\Worksheet', $firstSheet);
83
84			$secondSheet = $spreadsheet->getSheet(1);
85			self::assertInstanceOf('PhpOffice\PhpSpreadsheet\Worksheet\Worksheet', $secondSheet);
86			}
87
88			public function testReadValueAndComments()
89			{
90			$spreadsheet = $this->loadOdsTestFile();
91
92			$firstSheet = $spreadsheet->getSheet(0);
93
94			self::assertEquals(29, $firstSheet->getHighestRow());
95			self::assertEquals('N', $firstSheet->getHighestColumn());
96
97			// Simple cell value
98			self::assertEquals('Test String 1', $firstSheet->getCell('A1')->getValue());
99
100			// Merged cell
101			self::assertEquals('BOX', $firstSheet->getCell('B18')->getValue());
102
103			// Comments/Annotations
104			self::assertEquals(
105			'Test for a simple colour-formatted string',
106			$firstSheet->getComment('A1')->getText()->getPlainText()
107			);
108
109			// Data types
110			self::assertEquals(DataType::TYPE_STRING, $firstSheet->getCell('A1')->getDataType());
111			self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('B1')->getDataType()); // Int
112
113			self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('B6')->getDataType()); // Float
114			self::assertEquals(1.23, $firstSheet->getCell('B6')->getValue());
115			self::assertEquals(0, $firstSheet->getCell('G10')->getValue());
116
117			self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A10')->getDataType()); // Date
118			self::assertEquals(22269.0, $firstSheet->getCell('A10')->getValue());
119
120			self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A13')->getDataType()); // Time
121			self::assertEquals(25569.0625, $firstSheet->getCell('A13')->getValue());
122
123			self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A15')->getDataType()); // Date + Time
124			self::assertEquals(22269.0625, $firstSheet->getCell('A15')->getValue());
125
126			self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A11')->getDataType()); // Fraction
127
128			self::assertEquals(DataType::TYPE_BOOL, $firstSheet->getCell('D6')->getDataType());
129			self::assertTrue($firstSheet->getCell('D6')->getValue());
130
131			self::assertEquals(DataType::TYPE_FORMULA, $firstSheet->getCell('C6')->getDataType()); // Formula
132			self::assertEquals('=TRUE()', $firstSheet->getCell('C6')->getValue()); // Formula
133
134			// Percentage, Currency
135
136			$spreadsheet = $this->loadDataFile();
137
138			$firstSheet = $spreadsheet->getSheet(0);
139
140			self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A1')->getDataType()); // Percentage (10%)
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-20 20:59 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
141			self::assertEquals(0.1, $firstSheet->getCell('A1')->getValue());
142
143			self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A2')->getDataType()); // Percentage (10.00%)
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-20 20:59 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
144			self::assertEquals(0.1, $firstSheet->getCell('A2')->getValue());
145
146			self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A4')->getDataType()); // Currency (€10.00)
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-20 20:59 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
147			self::assertEquals(10, $firstSheet->getCell('A4')->getValue());
148
149			self::assertEquals(DataType::TYPE_NUMERIC, $firstSheet->getCell('A5')->getDataType()); // Currency ($20)
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-20 20:59 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
150			self::assertEquals(20, $firstSheet->getCell('A5')->getValue());
151			}
152
153			public function testReadColors()
154			{
155			$spreadsheet = $this->loadOdsTestFile();
156			$firstSheet = $spreadsheet->getSheet(0);
157
158			// Background color
159
160			$style = $firstSheet->getCell('K3')->getStyle();
161
162			self::assertEquals('none', $style->getFill()->getFillType());
163			self::assertEquals('FFFFFFFF', $style->getFill()->getStartColor()->getARGB());
164			self::assertEquals('FF000000', $style->getFill()->getEndColor()->getARGB());
165			}
166
167			public function testReadRichText()
168			{
169			$spreadsheet = $this->loadOdsTestFile();
170			$firstSheet = $spreadsheet->getSheet(0);
171
172			self::assertEquals(
173			"I don't know if OOCalc supports Rich Text in the same way as Excel, " .
174			'And this row should be autofit height with text wrap',
175			$firstSheet->getCell('A28')->getValue()
176			);
177			}
178
179			public function testReadCellsWithRepeatedSpaces()
180			{
181			$spreadsheet = $this->loadDataFile();
182			$firstSheet = $spreadsheet->getSheet(0);
183
184			self::assertEquals('This has 4 spaces before and 2 after ', $firstSheet->getCell('A8')->getValue());
185			self::assertEquals('This only one after ', $firstSheet->getCell('A9')->getValue());
186			self::assertEquals('Test with DIFFERENT styles and multiple spaces: ', $firstSheet->getCell('A10')->getValue());
187			self::assertEquals("test with new \nLines", $firstSheet->getCell('A11')->getValue());
188			}
189
190			public function testReadHyperlinks()
191			{
192			$spreadsheet = $this->loadOdsTestFile();
193			$firstSheet = $spreadsheet->getSheet(0);
194
195			$hyperlink = $firstSheet->getCell('A29');
196
197			self::assertEquals(DataType::TYPE_STRING, $hyperlink->getDataType());
198			self::assertEquals('PhpSpreadsheet', $hyperlink->getValue());
199			self::assertEquals('https://github.com/PHPOffice/phpspreadsheet', $hyperlink->getHyperlink()->getUrl());
200			}
201
202			// Below some test for features not implemented yet
203
204			public function testReadBoldItalicUnderline()
205			{
206			$this->markTestIncomplete('Features not implemented yet');
207
208			$spreadsheet = $this->loadOdsTestFile();
209			$firstSheet = $spreadsheet->getSheet(0);
210
211			// Font styles
212
213			$style = $firstSheet->getCell('A1')->getStyle();
214			self::assertEquals('FF000000', $style->getFont()->getColor()->getARGB());
215			self::assertEquals(11, $style->getFont()->getSize());
216			self::assertEquals(Font::UNDERLINE_NONE, $style->getFont()->getUnderline());
217
218			$style = $firstSheet->getCell('E3')->getStyle();
219			self::assertEquals(Font::UNDERLINE_SINGLE, $style->getFont()->getUnderline());
220
221			$style = $firstSheet->getCell('E1')->getStyle();
222			self::assertTrue($style->getFont()->getBold());
223			self::assertTrue($style->getFont()->getItalic());
224			}
225			}
226

PHPOffice / PhpSpreadsheet

Push — develop ( c46008...bae234 )

OdsTest A

Complexity

Size/Duplication

Importance

10 Methods

Duplication Side-by-Side

Filter issues like