GedcomRecordFactory::gedcom() - Code Metrics - Inspection of "Static analysis checks" - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c9a927...3e5f5a )

by Greg

created 2020-05-12 20:38 UTC

GedcomRecordFactory::gedcom() A

↳ Parent: GedcomRecordFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	10
nc	1
nop	2
dl	0
loc	13
rs	9.9332
c	1
b	0
f	0

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2020 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\Factories;

use Closure;
use Fisharebest\Webtrees\Contracts\GedcomRecordFactoryInterface;
use Fisharebest\Webtrees\Factory;
use Fisharebest\Webtrees\Family;
use Fisharebest\Webtrees\Gedcom;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\Header;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Media;
use Fisharebest\Webtrees\Note;
use Fisharebest\Webtrees\Repository;
use Fisharebest\Webtrees\Source;
use Fisharebest\Webtrees\Submission;
use Fisharebest\Webtrees\Submitter;
use Fisharebest\Webtrees\Tree;
use Illuminate\Database\Capsule\Manager as DB;
use InvalidArgumentException;
use stdClass;

use function assert;

/**
 * Make a GedcomRecord object.
 */
class GedcomRecordFactory extends AbstractGedcomRecordFactory implements GedcomRecordFactoryInterface
{
    /**
     * Create a GedcomRecord object.
     *
     * @param string      $xref
     * @param Tree        $tree
     * @param string|null $gedcom
     *
     * @return GedcomRecord|null
     */
    public function make(string $xref, Tree $tree, string $gedcom = null): ?GedcomRecord
    {
        // We do not know the type of the record.  Try them all in turn.
        return
            Factory::family()->make($xref, $tree, $gedcom) ??
            Factory::individual()->make($xref, $tree, $gedcom) ??
            Factory::media()->make($xref, $tree, $gedcom) ??
            Factory::note()->make($xref, $tree, $gedcom) ??
            Factory::repository()->make($xref, $tree, $gedcom) ??
            Factory::source()->make($xref, $tree, $gedcom) ??
            Factory::submitter()->make($xref, $tree, $gedcom) ??
            Factory::submission()->make($xref, $tree, $gedcom) ??
            Factory::header()->make($xref, $tree, $gedcom) ??
            $this->cache->remember(__CLASS__ . $xref . '@' . $tree->id(), function () use ($xref, $tree, $gedcom) {
                $gedcom = $gedcom ?? $this->gedcom($xref, $tree);

                $pending = $this->pendingChanges($tree)->get($xref);

                if ($gedcom === null && $pending === null) {
                    return null;
                }

                $xref = $this->extractXref($gedcom ?? $pending, $xref);
                $type = $this->extractType($gedcom ?? $pending);

                return $this->newGedcomRecord($type, $xref, $gedcom ?? '', $pending, $tree);
            });
    }

    /**
     * Create a GedcomRecord object from raw GEDCOM data.
     *
     * @param string      $xref
     * @param string      $gedcom  an empty string for new/pending records
     * @param string|null $pending null for a record with no pending edits,
     *                             empty string for records with pending deletions
     * @param Tree        $tree
     *
     * @return GedcomRecord
     */
    public function new(string $xref, string $gedcom, ?string $pending, Tree $tree): GedcomRecord
    {
        return new GedcomRecord($xref, $gedcom, $pending, $tree);
    }

    /**
     * Create a GedcomRecord object from a row in the database.
     *
     * @param Tree $tree
     *
     * @return Closure
     */
    public function mapper(Tree $tree): Closure
    {
        return function (stdClass $row) use ($tree): GedcomRecord {
            $record = $this->make($row->o_id, $tree, $row->o_gedcom);
            assert($record instanceof GedcomRecord);

            return $record;
        };
    }

    /**
     * @param string      $type
     * @param string      $xref
     * @param string      $gedcom
     * @param string|null $pending
     * @param Tree        $tree
     *
     * @return GedcomRecord
     */
    private function newGedcomRecord(string $type, string $xref, string $gedcom, ?string $pending, Tree $tree): GedcomRecord
    {
        switch ($type) {
            case Family::RECORD_TYPE:
                return Factory::family()->new($xref, $gedcom, $pending, $tree);

            case Header::RECORD_TYPE:
                return Factory::header()->new($xref, $gedcom, $pending, $tree);

            case Individual::RECORD_TYPE:
                return Factory::individual()->new($xref, $gedcom, $pending, $tree);

            case Media::RECORD_TYPE:
                return Factory::media()->new($xref, $gedcom, $pending, $tree);

            case Note::RECORD_TYPE:
                return Factory::note()->new($xref, $gedcom, $pending, $tree);

            case Repository::RECORD_TYPE:
                return Factory::repository()->new($xref, $gedcom, $pending, $tree);

            case Source::RECORD_TYPE:
                return Factory::source()->new($xref, $gedcom, $pending, $tree);

            case Submission::RECORD_TYPE:
                return Factory::submission()->new($xref, $gedcom, $pending, $tree);

            case Submitter::RECORD_TYPE:
                return Factory::submitter()->new($xref, $gedcom, $pending, $tree);

            default:
                return $this->new($xref, $gedcom, $pending, $tree);
        }
    }

    /**
     * Extract the type of a GEDCOM record
     *
     * @param string $gedcom
     *
     * @return string
     * @throws InvalidArgumentException
     */
    private function extractType(string $gedcom): string
    {
        if (preg_match('/^0(?: @' . Gedcom::REGEX_XREF . '@)? ([_A-Z0-9]+)/', $gedcom, $match)) {
            return $match[1];
        }

        throw new InvalidArgumentException('Invalid GEDCOM record: ' . $gedcom);
    }

    /**
     * Fetch GEDCOM data from the database.
     *
     * @param string $xref
     * @param Tree   $tree
     *
     * @return string|null
     */
    private function gedcom(string $xref, Tree $tree): ?string
    {
        return DB::table('other')
            ->where('o_id', '=', $xref)
            ->where('o_file', '=', $tree->id())
            ->whereNotIn('o_type', [
                Header::RECORD_TYPE,
                Note::RECORD_TYPE,
                Repository::RECORD_TYPE,
                Submission::RECORD_TYPE,
                Submitter::RECORD_TYPE,
            ])
            ->value('o_gedcom');
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2020 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\Factories;
21
22			use Closure;
23			use Fisharebest\Webtrees\Contracts\GedcomRecordFactoryInterface;
24			use Fisharebest\Webtrees\Factory;
25			use Fisharebest\Webtrees\Family;
26			use Fisharebest\Webtrees\Gedcom;
27			use Fisharebest\Webtrees\GedcomRecord;
28			use Fisharebest\Webtrees\Header;
29			use Fisharebest\Webtrees\Individual;
30			use Fisharebest\Webtrees\Media;
31			use Fisharebest\Webtrees\Note;
32			use Fisharebest\Webtrees\Repository;
33			use Fisharebest\Webtrees\Source;
34			use Fisharebest\Webtrees\Submission;
35			use Fisharebest\Webtrees\Submitter;
36			use Fisharebest\Webtrees\Tree;
37			use Illuminate\Database\Capsule\Manager as DB;
38			use InvalidArgumentException;
39			use stdClass;
40
41			use function assert;
42
43			/**
44			* Make a GedcomRecord object.
45			*/
46			class GedcomRecordFactory extends AbstractGedcomRecordFactory implements GedcomRecordFactoryInterface
47			{
48			/**
49			* Create a GedcomRecord object.
50			*
51			* @param string $xref
52			* @param Tree $tree
53			* @param string\|null $gedcom
54			*
55			* @return GedcomRecord\|null
56			*/
57			public function make(string $xref, Tree $tree, string $gedcom = null): ?GedcomRecord
58			{
59			// We do not know the type of the record. Try them all in turn.
60			return
61			Factory::family()->make($xref, $tree, $gedcom) ??
62			Factory::individual()->make($xref, $tree, $gedcom) ??
63			Factory::media()->make($xref, $tree, $gedcom) ??
64			Factory::note()->make($xref, $tree, $gedcom) ??
65			Factory::repository()->make($xref, $tree, $gedcom) ??
66			Factory::source()->make($xref, $tree, $gedcom) ??
67			Factory::submitter()->make($xref, $tree, $gedcom) ??
68			Factory::submission()->make($xref, $tree, $gedcom) ??
69			Factory::header()->make($xref, $tree, $gedcom) ??
70			$this->cache->remember(__CLASS__ . $xref . '@' . $tree->id(), function () use ($xref, $tree, $gedcom) {
71			$gedcom = $gedcom ?? $this->gedcom($xref, $tree);
72
73			$pending = $this->pendingChanges($tree)->get($xref);
74
75			if ($gedcom === null && $pending === null) {
76			return null;
77			}
78
79			$xref = $this->extractXref($gedcom ?? $pending, $xref);
80			$type = $this->extractType($gedcom ?? $pending);
81
82			return $this->newGedcomRecord($type, $xref, $gedcom ?? '', $pending, $tree);
83			});
84			}
85
86			/**
87			* Create a GedcomRecord object from raw GEDCOM data.
88			*
89			* @param string $xref
90			* @param string $gedcom an empty string for new/pending records
91			* @param string\|null $pending null for a record with no pending edits,
92			* empty string for records with pending deletions
93			* @param Tree $tree
94			*
95			* @return GedcomRecord
96			*/
97			public function new(string $xref, string $gedcom, ?string $pending, Tree $tree): GedcomRecord
98			{
99			return new GedcomRecord($xref, $gedcom, $pending, $tree);
100			}
101
102			/**
103			* Create a GedcomRecord object from a row in the database.
104			*
105			* @param Tree $tree
106			*
107			* @return Closure
108			*/
109			public function mapper(Tree $tree): Closure
110			{
111			return function (stdClass $row) use ($tree): GedcomRecord {
112			$record = $this->make($row->o_id, $tree, $row->o_gedcom);
113			assert($record instanceof GedcomRecord);
114
115			return $record;
116			};
117			}
118
119			/**
120			* @param string $type
121			* @param string $xref
122			* @param string $gedcom
123			* @param string\|null $pending
124			* @param Tree $tree
125			*
126			* @return GedcomRecord
127			*/
128			private function newGedcomRecord(string $type, string $xref, string $gedcom, ?string $pending, Tree $tree): GedcomRecord
129			{
130			switch ($type) {
131			case Family::RECORD_TYPE:
132			return Factory::family()->new($xref, $gedcom, $pending, $tree);
133
134			case Header::RECORD_TYPE:
135			return Factory::header()->new($xref, $gedcom, $pending, $tree);
136
137			case Individual::RECORD_TYPE:
138			return Factory::individual()->new($xref, $gedcom, $pending, $tree);
139
140			case Media::RECORD_TYPE:
141			return Factory::media()->new($xref, $gedcom, $pending, $tree);
142
143			case Note::RECORD_TYPE:
144			return Factory::note()->new($xref, $gedcom, $pending, $tree);
145
146			case Repository::RECORD_TYPE:
147			return Factory::repository()->new($xref, $gedcom, $pending, $tree);
148
149			case Source::RECORD_TYPE:
150			return Factory::source()->new($xref, $gedcom, $pending, $tree);
151
152			case Submission::RECORD_TYPE:
153			return Factory::submission()->new($xref, $gedcom, $pending, $tree);
154
155			case Submitter::RECORD_TYPE:
156			return Factory::submitter()->new($xref, $gedcom, $pending, $tree);
157
158			default:
159			return $this->new($xref, $gedcom, $pending, $tree);
160			}
161			}
162
163			/**
164			* Extract the type of a GEDCOM record
165			*
166			* @param string $gedcom
167			*
168			* @return string
169			* @throws InvalidArgumentException
170			*/
171			private function extractType(string $gedcom): string
172			{
173			if (preg_match('/^0(?: @' . Gedcom::REGEX_XREF . '@)? ([_A-Z0-9]+)/', $gedcom, $match)) {
174			return $match[1];
175			}
176
177			throw new InvalidArgumentException('Invalid GEDCOM record: ' . $gedcom);
178			}
179
180			/**
181			* Fetch GEDCOM data from the database.
182			*
183			* @param string $xref
184			* @param Tree $tree
185			*
186			* @return string\|null
187			*/
188			private function gedcom(string $xref, Tree $tree): ?string
189			{
190			return DB::table('other')
191			->where('o_id', '=', $xref)
192			->where('o_file', '=', $tree->id())
193			->whereNotIn('o_type', [
194			Header::RECORD_TYPE,
195			Note::RECORD_TYPE,
196			Repository::RECORD_TYPE,
197			Submission::RECORD_TYPE,
198			Submitter::RECORD_TYPE,
199			])
200			->value('o_gedcom');
201			}
202			}
203

fisharebest / webtrees

Push — master ( c9a927...3e5f5a )

GedcomRecordFactory::gedcom() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like