xref: /webtrees/tests/app/Http/RequestHandlers/RedirectTimeLinePhpTest.php (revision 928e8f1ab8bf8a4eae9e8ec7a464d6b65ee174d5) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Http\RequestHandlers;
21
22use Fig\Http\Message\RequestMethodInterface;
23use Fig\Http\Message\StatusCodeInterface;
24use Fisharebest\Webtrees\Factories\IndividualFactory;
25use Fisharebest\Webtrees\Http\Exceptions\HttpGoneException;
26use Fisharebest\Webtrees\Individual;
27use Fisharebest\Webtrees\Module\TimelineChartModule;
28use Fisharebest\Webtrees\Registry;
29use Fisharebest\Webtrees\Services\ModuleService;
30use Fisharebest\Webtrees\Services\TreeService;
31use Fisharebest\Webtrees\TestCase;
32use Fisharebest\Webtrees\Tree;
33use Illuminate\Support\Collection;
34
35/**
36 * @covers \Fisharebest\Webtrees\Http\RequestHandlers\RedirectTimeLinePhp
37 */
38class RedirectTimeLinePhpTest extends TestCase
39{
40    protected static bool $uses_database = true;
41
42    public function testRedirect(): void
43    {
44        $tree = $this->createStub(Tree::class);
45        $tree
46            ->method('name')
47            ->willReturn('tree1');
48
49        $tree_service = $this->createStub(TreeService::class);
50        $tree_service
51            ->expects(self::once())
52            ->method('all')
53            ->willReturn(new Collection(['tree1' => $tree]));
54
55        $individual = $this->createStub(Individual::class);
56
57        $individual_factory = $this->createStub(IndividualFactory::class);
58        $individual_factory
59            ->expects(self::once())
60            ->method('make')
61            ->with('X123', $tree)
62            ->willReturn($individual);
63
64        Registry::individualFactory($individual_factory);
65
66        $module = $this->createStub(TimelineChartModule::class);
67        $module
68            ->expects(self::once())
69            ->method('chartUrl')
70            ->willReturn('https://www.example.com');
71
72        $module_service = $this->createStub(ModuleService::class);
73        $module_service
74            ->expects(self::once())
75            ->method('findByInterface')
76            ->with(TimelineChartModule::class)
77            ->willReturn(new Collection([$module]));
78
79        $handler = new RedirectTimeLinePhp($module_service, $tree_service);
80
81        $request = self::createRequest(
82            RequestMethodInterface::METHOD_GET,
83            ['ged' => 'tree1', 'pids' => ['X123']]
84        );
85
86        $response = $handler->handle($request);
87
88        self::assertSame(StatusCodeInterface::STATUS_MOVED_PERMANENTLY, $response->getStatusCode());
89        self::assertSame('https://www.example.com', $response->getHeaderLine('Location'));
90    }
91
92    public function testModuleDisabled(): void
93    {
94        $module_service = $this->createStub(ModuleService::class);
95        $module_service
96            ->expects(self::once())->method('findByInterface')
97            ->with(TimelineChartModule::class)
98            ->willReturn(new Collection());
99
100        $tree = $this->createStub(Tree::class);
101
102        $tree_service = $this->createStub(TreeService::class);
103        $tree_service
104            ->expects(self::once())
105            ->method('all')
106            ->willReturn(new Collection([$tree]));
107
108        $handler = new RedirectTimeLinePhp($module_service, $tree_service);
109
110        $request = self::createRequest(
111            RequestMethodInterface::METHOD_GET,
112            ['ged' => 'tree1', 'pids' => ['X123']]
113        );
114
115        $this->expectException(HttpGoneException::class);
116
117        $handler->handle($request);
118    }
119
120    public function testNoSuchTree(): void
121    {
122        $module = $this->createStub(TimelineChartModule::class);
123
124        $module_service  = $this->createStub(ModuleService::class);
125        $module_service
126            ->expects(self::once())
127            ->method('findByInterface')
128            ->with(TimelineChartModule::class)
129            ->willReturn(new Collection([$module]));
130
131        $tree_service = $this->createStub(TreeService::class);
132        $tree_service
133            ->expects(self::once())
134            ->method('all')
135            ->willReturn(new Collection([]));
136
137        $handler = new RedirectTimeLinePhp($module_service, $tree_service);
138
139        $request = self::createRequest(
140            RequestMethodInterface::METHOD_GET,
141            ['ged' => 'tree1', 'pids' => ['X123']]
142        );
143
144        $this->expectException(HttpGoneException::class);
145
146        $handler->handle($request);
147    }
148}
149