MetsDocumentTest::canGetLogicalStructure() - Code Metrics - Inspection of "[FEATURE] Integrate media player from slub_web_sac..." - kitodo/kitodo-presentation - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#818)

unknown

created 2022-07-01 14:00 UTC

MetsDocumentTest::canGetLogicalStructure() A

↳ Parent: MetsDocumentTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	52
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	34
c	2
b	0
f	0
nc	1
nop	0
dl	0
loc	52
rs	9.376

How to fix Long Method

<?php

namespace Kitodo\Dlf\Tests\Functional\Common;

use Kitodo\Dlf\Common\Doc;
use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;

class MetsDocumentTest extends FunctionalTestCase
{
    public function setUp(): void
    {
        parent::setUp();

        $this->importDataSet(__DIR__ . '/../../Fixtures/Common/metadata.xml');
        $this->importDataSet(__DIR__ . '/../../Fixtures/MetsDocument/metadata_mets.xml');
    }

    protected function doc(string $file)
    {
        $url = 'http://web:8001/Tests/Fixtures/MetsDocument/' . $file;
        $doc = Doc::getInstance($url);
        $this->assertNotNull($doc);
        return $doc;
    }

    /**
     * @test
     */
    public function canParseDmdAndAmdSec()
    {
        $doc = $this->doc('av_beispiel.xml');

        $titledata = $doc->getTitledata(20000);

        $this->assertEquals(['Odol-Mundwasser, 3 Werbespots'], $titledata['title']);
        $this->assertEquals(['24'], $titledata['frame_rate']);
        $this->assertEquals(['Sächsische Landesbibliothek - Staats- und Universitätsbibliothek Dresden'], $titledata['dvrights_owner']);
        $this->assertEquals(['https://katalog.slub-dresden.de/id/0-1703800435'], $titledata['dvlinks_reference']);

        $this->assertEquals([
            'DMDLOG_0000' => $doc->mdSec['DMDLOG_0000'],

        ], $doc->dmdSec);

    }

    /**
     * @test
     */
    public function canGetLogicalStructure()
    {
        $doc = $this->doc('av_beispiel.xml');

        $toc = $doc->tableOfContents[0] ?? [];

        $this->assertArrayMatches([
            'dmdId' => 'DMDLOG_0000',
            'admId' => 'AMD',
            'videoChapter' => [
                'fileId' => 'FILE_0000_DEFAULT_MOV',
                'timecode' => 0,
            ],
            'children' => [
                [
                    'id' => 'LOG_0001',
                    'dmdId' => '',
                    'admId' => '',
                    'videoChapter' => [
                        'fileId' => 'FILE_0000_DEFAULT_MOV',
                        'timecode' => 0,
                    ],
                ],
                [
                    'id' => 'LOG_0002',
                    'dmdId' => '',
                    'admId' => '',
                    'videoChapter' => [
                        'fileId' => 'FILE_0000_DEFAULT_MOV',
                        'timecode' => 20.5,
                    ],
                ],
                [
                    'id' => 'LOG_0003',
                    'dmdId' => '',
                    'admId' => '',
                    'videoChapter' => [
                        'fileId' => 'FILE_0000_DEFAULT_MOV',
                        'timecode' => 40,
                    ],
                ],
                [
                    'id' => 'LOG_0004',
                    'dmdId' => '',
                    'admId' => '',
                    'videoChapter' => [
                        'fileId' => 'FILE_0000_DEFAULT_MOV',
                        'timecode' => 60,
                    ],
                ],
            ],
        ], $toc, 'Expected TOC to contain the specified values');
    }

    /**
     * @test
     */
    public function canReadChapterArea()
    {
        $doc = $this->doc('av_beispiel.xml');

        $ch3_page = $doc->physicalStructureInfo[$doc->physicalStructure[3]];
        $this->assertArrayMatches([
            'DEFAULT' => 'FILE_0000_DEFAULT_MP4',
        ], $ch3_page['files']);
        $this->assertArrayMatches([
            'DEFAULT' => [
                'FILE_0000_DEFAULT_MOV',
                'FILE_0000_DEFAULT_MP4',
            ],
        ], $ch3_page['all_files']);
        $this->assertArrayMatches([
            'FILE_0000_DEFAULT_MP4' => [
                'area' => [
                    'begin' => '00:00:40',
                    'betype' => 'TIME',
                    'extent' => '00:00:20',
                    'exttype' => 'TIME',
                ],
            ],
        ], $ch3_page['fileInfos']);
    }

    /**
     * @test
     */
    public function doesNotOverwriteFirstDmdSec()
    {
        $doc = $this->doc('two_dmdsec.xml');

        $titledata = $doc->getTitledata(20000);
        $toc = $doc->tableOfContents[0] ?? [];

        $this->assertEquals('DMDLOG_0000 DMDLOG_0000b', $toc['dmdId']); // TODO: Do we want the raw (non-split) value here?
        $this->assertEquals('Test Value in DMDLOG_0000', $titledata['test_value'][0]);
    }

    /**
     * @test
     */
    public function returnsEmptyMetadataWhenNoDmdSec()
    {
        $doc = $this->doc('two_dmdsec.xml');

        // DMD and AMD works
        $metadata = $doc->getMetadata('LOG_0000', 20000);
        $this->assertEquals('Test Value in DMDLOG_0000', $metadata['test_value'][0]);

        // DMD only works
        $metadata = $doc->getMetadata('LOG_0001', 20000);
        $this->assertEquals(['Test Value in DMDLOG_0000b'], $metadata['test_value']);

        // AMD only does not work
        $metadata = $doc->getMetadata('LOG_0002', 20000);
        $this->assertEquals([], $metadata);
    }
}


Scrutinizer GitHub App not installed

GitHub Access Token became invalid

Pull Request — master (#818)

MetsDocumentTest::canGetLogicalStructure() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

1			<?php
2
3			namespace Kitodo\Dlf\Tests\Functional\Common;
4
5			use Kitodo\Dlf\Common\Doc;
6			use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
7
8			class MetsDocumentTest extends FunctionalTestCase
9			{
10			public function setUp(): void
11			{
12			parent::setUp();
13
14			$this->importDataSet(__DIR__ . '/../../Fixtures/Common/metadata.xml');
15			$this->importDataSet(__DIR__ . '/../../Fixtures/MetsDocument/metadata_mets.xml');
16			}
17
18			protected function doc(string $file)
19			{
20			$url = 'http://web:8001/Tests/Fixtures/MetsDocument/' . $file;
21			$doc = Doc::getInstance($url);
22			$this->assertNotNull($doc);
23			return $doc;
24			}
25
26			/**
27			* @test
28			*/
29			public function canParseDmdAndAmdSec()
30			{
31			$doc = $this->doc('av_beispiel.xml');
32
33			$titledata = $doc->getTitledata(20000);
34
35			$this->assertEquals(['Odol-Mundwasser, 3 Werbespots'], $titledata['title']);
36			$this->assertEquals(['24'], $titledata['frame_rate']);
37			$this->assertEquals(['Sächsische Landesbibliothek - Staats- und Universitätsbibliothek Dresden'], $titledata['dvrights_owner']);
38			$this->assertEquals(['https://katalog.slub-dresden.de/id/0-1703800435'], $titledata['dvlinks_reference']);
39
40			$this->assertEquals([
41			'DMDLOG_0000' => $doc->mdSec['DMDLOG_0000'],
			0 ignored issues – show Bug Best Practice introduced 2022-03-31 16:17 UTC by Report Bug Copy Issue Report The property `mdSec` does not exist on `Kitodo\Dlf\Common\Doc`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
42			], $doc->dmdSec);
			0 ignored issues – show Bug Best Practice introduced 2022-03-31 16:17 UTC by Report Bug Copy Issue Report The property `dmdSec` does not exist on `Kitodo\Dlf\Common\Doc`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
43			}
44
45			/**
46			* @test
47			*/
48			public function canGetLogicalStructure()
49			{
50			$doc = $this->doc('av_beispiel.xml');
51
52			$toc = $doc->tableOfContents[0] ?? [];
53
54			$this->assertArrayMatches([
55			'dmdId' => 'DMDLOG_0000',
56			'admId' => 'AMD',
57			'videoChapter' => [
58			'fileId' => 'FILE_0000_DEFAULT_MOV',
59			'timecode' => 0,
60			],
61			'children' => [
62			[
63			'id' => 'LOG_0001',
64			'dmdId' => '',
65			'admId' => '',
66			'videoChapter' => [
67			'fileId' => 'FILE_0000_DEFAULT_MOV',
68			'timecode' => 0,
69			],
70			],
71			[
72			'id' => 'LOG_0002',
73			'dmdId' => '',
74			'admId' => '',
75			'videoChapter' => [
76			'fileId' => 'FILE_0000_DEFAULT_MOV',
77			'timecode' => 20.5,
78			],
79			],
80			[
81			'id' => 'LOG_0003',
82			'dmdId' => '',
83			'admId' => '',
84			'videoChapter' => [
85			'fileId' => 'FILE_0000_DEFAULT_MOV',
86			'timecode' => 40,
87			],
88			],
89			[
90			'id' => 'LOG_0004',
91			'dmdId' => '',
92			'admId' => '',
93			'videoChapter' => [
94			'fileId' => 'FILE_0000_DEFAULT_MOV',
95			'timecode' => 60,
96			],
97			],
98			],
99			], $toc, 'Expected TOC to contain the specified values');
100			}
101
102			/**
103			* @test
104			*/
105			public function canReadChapterArea()
106			{
107			$doc = $this->doc('av_beispiel.xml');
108
109			$ch3_page = $doc->physicalStructureInfo[$doc->physicalStructure[3]];
110			$this->assertArrayMatches([
111			'DEFAULT' => 'FILE_0000_DEFAULT_MP4',
112			], $ch3_page['files']);
113			$this->assertArrayMatches([
114			'DEFAULT' => [
115			'FILE_0000_DEFAULT_MOV',
116			'FILE_0000_DEFAULT_MP4',
117			],
118			], $ch3_page['all_files']);
119			$this->assertArrayMatches([
120			'FILE_0000_DEFAULT_MP4' => [
121			'area' => [
122			'begin' => '00:00:40',
123			'betype' => 'TIME',
124			'extent' => '00:00:20',
125			'exttype' => 'TIME',
126			],
127			],
128			], $ch3_page['fileInfos']);
129			}
130
131			/**
132			* @test
133			*/
134			public function doesNotOverwriteFirstDmdSec()
135			{
136			$doc = $this->doc('two_dmdsec.xml');
137
138			$titledata = $doc->getTitledata(20000);
139			$toc = $doc->tableOfContents[0] ?? [];
140
141			$this->assertEquals('DMDLOG_0000 DMDLOG_0000b', $toc['dmdId']); // TODO: Do we want the raw (non-split) value here?
142			$this->assertEquals('Test Value in DMDLOG_0000', $titledata['test_value'][0]);
143			}
144
145			/**
146			* @test
147			*/
148			public function returnsEmptyMetadataWhenNoDmdSec()
149			{
150			$doc = $this->doc('two_dmdsec.xml');
151
152			// DMD and AMD works
153			$metadata = $doc->getMetadata('LOG_0000', 20000);
154			$this->assertEquals('Test Value in DMDLOG_0000', $metadata['test_value'][0]);
155
156			// DMD only works
157			$metadata = $doc->getMetadata('LOG_0001', 20000);
158			$this->assertEquals(['Test Value in DMDLOG_0000b'], $metadata['test_value']);
159
160			// AMD only does not work
161			$metadata = $doc->getMetadata('LOG_0002', 20000);
162			$this->assertEquals([], $metadata);
163			}
164			}
165

kitodo / kitodo-presentation

Scrutinizer GitHub App not installed

GitHub Access Token became invalid

Pull Request — master (#818)

MetsDocumentTest::canGetLogicalStructure() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like