FixCemeteryTag::updateGedcom() - Code Metrics - Inspection of "Fix: #2979 - re-ordering deleted facts" - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 94abca...7bb122 )

by Greg

created 2020-01-18 21:58 UTC

FixCemeteryTag::updateGedcom() A

↳ Parent: FixCemeteryTag

Complexity

Conditions	4
Paths	5

Size

Total Lines	27
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	4
eloc	13
nc	5
nop	2
dl	0
loc	27
rs	9.8333
c	1
b	1
f	0

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2019 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Module;

use Fisharebest\Webtrees\Fact;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Services\DataFixService;
use Fisharebest\Webtrees\Tree;
use Illuminate\Database\Capsule\Manager as DB;
use Illuminate\Database\Query\Builder;
use Illuminate\Support\Collection;

use function preg_match;

/**
 * Class FixCemeteryTag
 */
class FixCemeteryTag extends AbstractModule implements ModuleDataFixInterface
{
    use ModuleDataFixTrait;


    /** @var DataFixService */
    private $data_fix_service;

    /**
     * FixMissingDeaths constructor.
     *
     * @param DataFixService $data_fix_service
     */
    public function __construct(DataFixService $data_fix_service)
    {
        $this->data_fix_service = $data_fix_service;
    }

    /**
     * How should this module be identified in the control panel, etc.?
     *
     * @return string
     */
    public function title(): string
    {
        /* I18N: Name of a module */
        return I18N::translate('Convert CEME tags to GEDCOM 5.5.1');
    }

    /**
     * A sentence describing what this module does.
     *
     * @return string
     */
    public function description(): string
    {
        /* I18N: Description of a “Data fix” module */
        return I18N::translate('Replace cemetery tags with burial places.');
    }

    /**
     * Options form.
     *
     * @param Tree $tree
     *
     * @return string
     */
    public function fixOptions(Tree $tree): string
    {
        $options = [
            'ADDR' => I18N::translate('Address'),
            'PLAC' => I18N::translate('Place'),
        ];

        $selected = 'ADDR';

        return view('modules/fix-ceme-tag/options', [
            'options'  => $options,
            'selected' => $selected,
        ]);
    }

    /**
     * A list of all records that need examining.  This may include records
     * that do not need updating, if we can't detect this quickly using SQL.
     *
     * @param Tree                 $tree
     * @param array<string,string> $params
     *
     * @return Collection<string>|null
     */
    protected function individualsToFix(Tree $tree, array $params): ?Collection
    {
        // No DB querying possible?  Select all.
        return DB::table('individuals')
            ->where('i_file', '=', $tree->id())
            ->where(static function (Builder $query): void {
                $query
                    ->where('i_gedcom', 'LIKE', "%\n2 CEME%")
                    ->orWhere('i_gedcom', 'LIKE', "%\n3 CEME%");
            })
            ->pluck('i_id');
    }

    /**
     * Does a record need updating?
     *
     * @param GedcomRecord         $record
     * @param array<string,string> $params
     *
     * @return bool
     */
    public function doesRecordNeedUpdate(GedcomRecord $record, array $params): bool
    {
        return $record->facts(['BURI'], false, null, false)
            ->filter(static function (Fact $fact): bool {
                return preg_match('/\n[23] CEME/', $fact->gedcom()) === 1;
            })
            ->isNotEmpty();
    }

    /**
     * Show the changes we would make
     *
     * @param GedcomRecord         $record
     * @param array<string,string> $params
     *
     * @return string
     */
    public function previewUpdate(GedcomRecord $record, array $params): string
    {
        $old = [];
        $new = [];

        foreach ($record->facts(['BURI'], false, null, false) as $fact) {
            $old[] = $fact->gedcom();
            $new[] = $this->updateGedcom($fact, $params);
        }

        $old = implode("\n", $old);
        $new = implode("\n", $new);

        return $this->data_fix_service->gedcomDiff($record->tree(), $old, $new);
    }

    /**
     * Fix a record
     *
     * @param GedcomRecord         $record
     * @param array<string,string> $params
     *
     * @return void
     */
    public function updateRecord(GedcomRecord $record, array $params): void
    {
        foreach ($record->facts(['BURI'], false, null, false) as $fact) {
            $record->updateFact($fact->id(), $this->updateGedcom($fact, $params), false);
        }
    }

    /**
     * @param Fact                 $fact
     * @param array<string,string> $params
     *
     * @return string
     */
    private function updateGedcom(Fact $fact, array $params): string
    {
        $gedcom = $fact->gedcom();

        if (preg_match('/\n\d CEME ?(.+)(?:\n\d PLOT ?(.+))?/', $gedcom, $match)) {
            $ceme = $match[1];
            $plot = $match[2];

            // Merge PLOT with CEME
            if ($plot !== '') {
                $ceme = $plot . ', ' . $ceme;
            }

            // Remove CEME/PLOT
            $gedcom = strtr($gedcom, [$match[0] => '']);

            // Add PLAC/ADDR
            $convert = $params['convert'];

            if (strpos($gedcom, "\n2 " . $convert . ' ') === false) {
                $gedcom .= "\n2 " . $convert . ' ' . $ceme;
            } else {
                $gedcom = strtr($gedcom, ["\n2 " . $convert . ' ' => "\n2 " . $convert . ' ' . $ceme . ', ']);
            }
        }

        return $gedcom;
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16			*/
17
18			declare(strict_types=1);
19
20			namespace Fisharebest\Webtrees\Module;
21
22			use Fisharebest\Webtrees\Fact;
23			use Fisharebest\Webtrees\GedcomRecord;
24			use Fisharebest\Webtrees\I18N;
25			use Fisharebest\Webtrees\Services\DataFixService;
26			use Fisharebest\Webtrees\Tree;
27			use Illuminate\Database\Capsule\Manager as DB;
28			use Illuminate\Database\Query\Builder;
29			use Illuminate\Support\Collection;
30
31			use function preg_match;
32
33			/**
34			* Class FixCemeteryTag
35			*/
36			class FixCemeteryTag extends AbstractModule implements ModuleDataFixInterface
37			{
38			use ModuleDataFixTrait;
			1 ignored issue – show Bug introduced 2020-01-18 22:03 UTC by Report Bug Copy Issue Report The trait `Fisharebest\Webtrees\Module\ModuleDataFixTrait` requires the property `$xref` which is not provided by `Fisharebest\Webtrees\Module\FixCemeteryTag`. Loading history...
39
40			/** @var DataFixService */
41			private $data_fix_service;
42
43			/**
44			* FixMissingDeaths constructor.
45			*
46			* @param DataFixService $data_fix_service
47			*/
48			public function __construct(DataFixService $data_fix_service)
49			{
50			$this->data_fix_service = $data_fix_service;
51			}
52
53			/**
54			* How should this module be identified in the control panel, etc.?
55			*
56			* @return string
57			*/
58			public function title(): string
59			{
60			/* I18N: Name of a module */
61			return I18N::translate('Convert CEME tags to GEDCOM 5.5.1');
62			}
63
64			/**
65			* A sentence describing what this module does.
66			*
67			* @return string
68			*/
69			public function description(): string
70			{
71			/* I18N: Description of a “Data fix” module */
72			return I18N::translate('Replace cemetery tags with burial places.');
73			}
74
75			/**
76			* Options form.
77			*
78			* @param Tree $tree
79			*
80			* @return string
81			*/
82			public function fixOptions(Tree $tree): string
83			{
84			$options = [
85			'ADDR' => I18N::translate('Address'),
86			'PLAC' => I18N::translate('Place'),
87			];
88
89			$selected = 'ADDR';
90
91			return view('modules/fix-ceme-tag/options', [
92			'options' => $options,
93			'selected' => $selected,
94			]);
95			}
96
97			/**
98			* A list of all records that need examining. This may include records
99			* that do not need updating, if we can't detect this quickly using SQL.
100			*
101			* @param Tree $tree
102			* @param array<string,string> $params
103			*
104			* @return Collection<string>\|null
105			*/
106			protected function individualsToFix(Tree $tree, array $params): ?Collection
107			{
108			// No DB querying possible? Select all.
109			return DB::table('individuals')
110			->where('i_file', '=', $tree->id())
111			->where(static function (Builder $query): void {
112			$query
113			->where('i_gedcom', 'LIKE', "%\n2 CEME%")
114			->orWhere('i_gedcom', 'LIKE', "%\n3 CEME%");
115			})
116			->pluck('i_id');
117			}
118
119			/**
120			* Does a record need updating?
121			*
122			* @param GedcomRecord $record
123			* @param array<string,string> $params
124			*
125			* @return bool
126			*/
127			public function doesRecordNeedUpdate(GedcomRecord $record, array $params): bool
128			{
129			return $record->facts(['BURI'], false, null, false)
130			->filter(static function (Fact $fact): bool {
131			return preg_match('/\n[23] CEME/', $fact->gedcom()) === 1;
132			})
133			->isNotEmpty();
134			}
135
136			/**
137			* Show the changes we would make
138			*
139			* @param GedcomRecord $record
140			* @param array<string,string> $params
141			*
142			* @return string
143			*/
144			public function previewUpdate(GedcomRecord $record, array $params): string
145			{
146			$old = [];
147			$new = [];
148
149			foreach ($record->facts(['BURI'], false, null, false) as $fact) {
150			$old[] = $fact->gedcom();
151			$new[] = $this->updateGedcom($fact, $params);
152			}
153
154			$old = implode("\n", $old);
155			$new = implode("\n", $new);
156
157			return $this->data_fix_service->gedcomDiff($record->tree(), $old, $new);
158			}
159
160			/**
161			* Fix a record
162			*
163			* @param GedcomRecord $record
164			* @param array<string,string> $params
165			*
166			* @return void
167			*/
168			public function updateRecord(GedcomRecord $record, array $params): void
169			{
170			foreach ($record->facts(['BURI'], false, null, false) as $fact) {
171			$record->updateFact($fact->id(), $this->updateGedcom($fact, $params), false);
172			}
173			}
174
175			/**
176			* @param Fact $fact
177			* @param array<string,string> $params
178			*
179			* @return string
180			*/
181			private function updateGedcom(Fact $fact, array $params): string
182			{
183			$gedcom = $fact->gedcom();
184
185			if (preg_match('/\n\d CEME ?(.+)(?:\n\d PLOT ?(.+))?/', $gedcom, $match)) {
186			$ceme = $match[1];
187			$plot = $match[2];
188
189			// Merge PLOT with CEME
190			if ($plot !== '') {
191			$ceme = $plot . ', ' . $ceme;
192			}
193
194			// Remove CEME/PLOT
195			$gedcom = strtr($gedcom, [$match[0] => '']);
196
197			// Add PLAC/ADDR
198			$convert = $params['convert'];
199
200			if (strpos($gedcom, "\n2 " . $convert . ' ') === false) {
201			$gedcom .= "\n2 " . $convert . ' ' . $ceme;
202			} else {
203			$gedcom = strtr($gedcom, ["\n2 " . $convert . ' ' => "\n2 " . $convert . ' ' . $ceme . ', ']);
204			}
205			}
206
207			return $gedcom;
208			}
209			}
210

fisharebest / webtrees

Push — master ( 94abca...7bb122 )

FixCemeteryTag::updateGedcom() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like