MT940::parseDescription() - Code Metrics - Inspection of "fix ing-diba: wrong bookingDate year #86" - mschindler83/fints-hbci-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#87)

unknown

created 2017-11-28 20:21 UTC

MT940::parseDescription() C

↳ Parent: MT940

Complexity

Conditions	18
Paths	24

Size

Total Lines	72
Code Lines	49

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	52
CRAP Score	18.0524

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
c	3
b	1
f	0
dl	0
loc	72
ccs	52
cts	55
cp	0.9455
rs	5.4523
cc	18
eloc	49
nc	24
nop	1
crap	18.0524

How to fix Long Method Complexity

<?php

namespace Fhp\Parser;

use Fhp\Parser\Exception\MT940Exception;

/**
 * Class MT940
 * @package Fhp\Parser
 */
class MT940
{
    const TARGET_ARRAY = 0;

    const CD_CREDIT = 'credit';
    const CD_DEBIT = 'debit';

    /** @var string */
    protected $rawData;
    /** @var string */
    protected $soaDate;

    /**
     * MT940 constructor.
     *
     * @param string $rawData
     */
    public function __construct($rawData)
    {
        $this->rawData = (string) $rawData;
    }

    /**
     * @param string $target
     * @return array
     * @throws MT940Exception
     */
    public function parse($target)
    {
        switch ($target) {
            case static::TARGET_ARRAY:
                return $this->parseToArray();
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            default:
                throw new MT940Exception('Invalid parse type provided');
        }
    }

    /**
     * @return array
     * @throws MT940Exception
     */
    protected function parseToArray()
    {
        // The divider can be either \r\n or @@
        $divider = substr_count($this->rawData, "\r\n-") > substr_count($this->rawData, '@@-') ? "\r\n" : '@@';

        $result = array();
        $days = preg_split('%' . $divider . '-$%', $this->rawData);
        foreach ($days as &$day) {
            $day = explode($divider . ':', $day);
            for ($i = 0, $cnt = count($day); $i < $cnt; $i++) {
                // handle start balance
                // 60F:C160401EUR1234,56

                if (preg_match('/^60(F|M):/', $day[$i])) {
                    // remove 60(F|M): for better parsing

                    $day[$i] = substr($day[$i], 4);
                    $this->soaDate = $this->getDate(substr($day[$i], 1, 6));

                    if (!isset($result[$this->soaDate])) {
                        $result[$this->soaDate] = array('start_balance' => array());
                    }

                    $cdMark = substr($day[$i], 0, 1);
                    if ($cdMark == 'C') {
                        $result[$this->soaDate]['start_balance']['credit_debit'] = static::CD_CREDIT;
                    } elseif ($cdMark == 'D') {
                        $result[$this->soaDate]['start_balance']['credit_debit'] = static::CD_DEBIT;
                    }

                    $amount = str_replace(',', '.', substr($day[$i], 10));
                    $result[$this->soaDate]['start_balance']['amount'] = $amount;
                } elseif (
                    // found transaction
                    // trx:61:1603310331DR637,39N033NONREF

                    0 === strpos($day[$i], '61:')
                    && isset($day[$i + 1])
                    && 0 === strpos($day[$i + 1], '86:')
                ) {
                    $transaction = substr($day[$i], 3);
                    $description = substr($day[$i + 1], 3);

                    if (!isset($result[$this->soaDate]['transactions'])) {
                        $result[$this->soaDate]['transactions'] = array();
                    }

                    // short form for better handling
                    $trx = &$result[$this->soaDate]['transactions'];

                    preg_match('/^\d{6}(\d{4})?(C|D|RC|RD)([A-Z]{1})?([^N]+)N/', $transaction, $trxMatch);
                    if ($trxMatch[2] == 'C') {
                        $trx[count($trx)]['credit_debit'] = static::CD_CREDIT;
                    } elseif ($trxMatch[2] == 'D') {
                        $trx[count($trx)]['credit_debit'] = static::CD_DEBIT;
                    } else {
                        throw new MT940Exception('cd mark not found in: ' . $transaction);
                    }

                    $amount = $trxMatch[4];
                    $amount = str_replace(',', '.', $amount);
                    $trx[count($trx) - 1]['amount'] = floatval($amount);

                    $description = $this->parseDescription($description);
                    $trx[count($trx) - 1]['description'] = $description;

                    // :61:1605110509D198,02NMSCNONREF

                    // 16 = year
                    // 0511 = valuta date
                    // 0509 = booking date
                    $year = substr($transaction, 0, 2);
                    $valutaDate = $this->getDate($year . substr($transaction, 2, 4));

                    $bookingDate = substr($transaction, 6, 4);
                    if (preg_match('/^\d{4}$/', $bookingDate)) {
                        // if valuta date is earlier than booking date, then it must be in the new year.
                        if (substr($transaction, 2, 2) == '12' && substr($transaction, 6, 2) == '01') {
                            $year++;
                        }
                        elseif (substr($transaction, 2, 2) == '01' && substr($transaction, 6, 2) == '12') {
                            $year--;
                        }
                        $bookingDate = $this->getDate($year . $bookingDate);
                    } else {
                        // if booking date not set in :61, then we have to take it from :60F
                        $bookingDate = $this->soaDate;
                    }

                    $trx[count($trx) - 1]['booking_date'] = $bookingDate;
                    $trx[count($trx) - 1]['valuta_date'] = $valutaDate;
                }
            }
        }

        return $result;
    }

    /**
     * @param string $descr
     * @return array
     */
    protected function parseDescription($descr)
    {
        $prepared = array();
        $result = array();

        // prefill with empty values
        for ($i = 0; $i <= 63; $i++) {
            $prepared[$i] = null;
        }

        $descr = str_replace("\r\n", '', $descr);
        $descr = str_replace('? ', '?', $descr);
        preg_match_all('/\?[\r\n]*(\d{2})([^\?]+)/', $descr, $matches, PREG_SET_ORDER);

        $descriptionLines = array();
        $description1 = ''; // Legacy, could be removed.
        $description2 = ''; // Legacy, could be removed.
        foreach ($matches as $m) {
            $index = (int) $m[1];
            if ((20 <= $index && $index <= 29) || (60 <= $index && $index <= 63)) {
                if (20 <= $index && $index <= 29) {
                    $description1 .= $m[2];
                } else {
                    $description2 .= $m[2];
                }
                $m[2] = trim($m[2]);
                if (!empty($m[2])) {
                    $descriptionLines[] = $m[2];
                }
            } else {
                $prepared[$index] = $m[2];
            }
        }

        $description = array();
        if (empty($descriptionLines) || strlen($descriptionLines[0]) < 5 || $descriptionLines[0][4] !== '+') {
            $description['SVWZ'] = implode('', $descriptionLines);
        } else {
            $lastType = null;
            foreach ($descriptionLines as $line) {
                if (strlen($line) > 5 && $line[4] === '+') {
                    if ($lastType != null) {

                        $description[$lastType] = trim($description[$lastType]);
                    }
                    $lastType = substr($line, 0, 4);
                    $description[$lastType] = substr($line, 5);
                } else {
                    $description[$lastType] .= $line;
                }
                if (strlen($line) < 27) {
                    // Usually, lines are 27 characters long. In case characters are missing, then it's either the end
                    // of the current type or spaces have been trimmed from the end. We want to collapse multiple spaces
                    // into one and we don't want to leave trailing spaces behind. So add a single space here to make up
                    // for possibly missing spaces, and if it's the end of the type, it will be trimmed off later.
                    $description[$lastType] .= ' ';
                }
            }
            $description[$lastType] = trim($description[$lastType]);
        }

        $result['description']       = $description;
        $result['booking_text']      = trim($prepared[0]);
        $result['primanoten_nr']     = trim($prepared[10]);
        $result['description_1']     = trim($description1);
        $result['bank_code']         = trim($prepared[30]);
        $result['account_number']    = trim($prepared[31]);
        $result['name']              = trim($prepared[32] . $prepared[33]);
        $result['text_key_addition'] = trim($prepared[34]);
        $result['description_2']     = trim($description2);

        return $result;
    }

    /**
     * @param string $val
     * @return string
     */
    protected function getDate($val)
    {
        $val = '20' . $val;
        preg_match('/(\d{4})(\d{2})(\d{2})/', $val, $m);
        return $m[1] . '-' . $m[2] . '-' . $m[3];
    }
}


1		<?php
2
3		namespace Fhp\Parser;
4
5		use Fhp\Parser\Exception\MT940Exception;
6
7		/**
8		* Class MT940
9		* @package Fhp\Parser
10		*/
11		class MT940
12		{
13		const TARGET_ARRAY = 0;
14
15		const CD_CREDIT = 'credit';
16		const CD_DEBIT = 'debit';
17
18		/** @var string */
19		protected $rawData;
20		/** @var string */
21		protected $soaDate;
22
23		/**
24		* MT940 constructor.
25		*
26		* @param string $rawData
27		*/
28	1	public function __construct($rawData)
29		{
30	1	$this->rawData = (string) $rawData;
31	1	}
32
33		/**
34		* @param string $target
35		* @return array
36		* @throws MT940Exception
37		*/
38	1	public function parse($target)
39		{
40		switch ($target) {
41	1	case static::TARGET_ARRAY:
42	1	return $this->parseToArray();
43		break;
		0 ignored issues – show Unused Code introduced 2016-09-05 20:43 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
44		default:
45		throw new MT940Exception('Invalid parse type provided');
46		}
47		}
48
49		/**
50		* @return array
51		* @throws MT940Exception
52		*/
53	1	protected function parseToArray()
54		{
55		// The divider can be either \r\n or @@
56	1	$divider = substr_count($this->rawData, "\r\n-") > substr_count($this->rawData, '@@-') ? "\r\n" : '@@';
57
58	1	$result = array();
59	1	$days = preg_split('%' . $divider . '-$%', $this->rawData);
60	1	foreach ($days as &$day) {
61	1	$day = explode($divider . ':', $day);
62	1	for ($i = 0, $cnt = count($day); $i < $cnt; $i++) {
63		// handle start balance
64		// 60F:C160401EUR1234,56
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-09-05 20:43 UTC by Report Bug Copy Issue Report `50%` 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...
65	1	if (preg_match('/^60(F\|M):/', $day[$i])) {
66		// remove 60(F\|M): for better parsing
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-10 09:12 UTC by Report Bug Copy Issue Report `38%` 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...
67	1	$day[$i] = substr($day[$i], 4);
68	1	$this->soaDate = $this->getDate(substr($day[$i], 1, 6));
69
70	1	if (!isset($result[$this->soaDate])) {
71	1	$result[$this->soaDate] = array('start_balance' => array());
72	1	}
73
74	1	$cdMark = substr($day[$i], 0, 1);
75	1	if ($cdMark == 'C') {
76	1	$result[$this->soaDate]['start_balance']['credit_debit'] = static::CD_CREDIT;
77	1	} elseif ($cdMark == 'D') {
78		$result[$this->soaDate]['start_balance']['credit_debit'] = static::CD_DEBIT;
79		}
80
81	1	$amount = str_replace(',', '.', substr($day[$i], 10));
82	1	$result[$this->soaDate]['start_balance']['amount'] = $amount;
83	1	} elseif (
84		// found transaction
85		// trx:61:1603310331DR637,39N033NONREF
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-09-05 20:43 UTC by Report Bug Copy Issue Report `56%` 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...
86	1	0 === strpos($day[$i], '61:')
87	1	&& isset($day[$i + 1])
88	1	&& 0 === strpos($day[$i + 1], '86:')
89	1	) {
90	1	$transaction = substr($day[$i], 3);
91	1	$description = substr($day[$i + 1], 3);
92
93	1	if (!isset($result[$this->soaDate]['transactions'])) {
94	1	$result[$this->soaDate]['transactions'] = array();
95	1	}
96
97		// short form for better handling
98	1	$trx = &$result[$this->soaDate]['transactions'];
99
100	1	preg_match('/^\d{6}(\d{4})?(C\|D\|RC\|RD)([A-Z]{1})?([^N]+)N/', $transaction, $trxMatch);
101	1	if ($trxMatch[2] == 'C') {
102	1	$trx[count($trx)]['credit_debit'] = static::CD_CREDIT;
103	1	} elseif ($trxMatch[2] == 'D') {
104		$trx[count($trx)]['credit_debit'] = static::CD_DEBIT;
105		} else {
106		throw new MT940Exception('cd mark not found in: ' . $transaction);
107		}
108
109	1	$amount = $trxMatch[4];
110	1	$amount = str_replace(',', '.', $amount);
111	1	$trx[count($trx) - 1]['amount'] = floatval($amount);
112
113	1	$description = $this->parseDescription($description);
114	1	$trx[count($trx) - 1]['description'] = $description;
115
116		// :61:1605110509D198,02NMSCNONREF
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-09-05 20:43 UTC by Report Bug Copy Issue Report `67%` 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...
117		// 16 = year
118		// 0511 = valuta date
119		// 0509 = booking date
120	1	$year = substr($transaction, 0, 2);
121	1	$valutaDate = $this->getDate($year . substr($transaction, 2, 4));
122
123	1	$bookingDate = substr($transaction, 6, 4);
124	1	if (preg_match('/^\d{4}$/', $bookingDate)) {
125		// if valuta date is earlier than booking date, then it must be in the new year.
126	1	if (substr($transaction, 2, 2) == '12' && substr($transaction, 6, 2) == '01') {
127		$year++;
128		}
129	1	elseif (substr($transaction, 2, 2) == '01' && substr($transaction, 6, 2) == '12') {
130		$year--;
131		}
132	1	$bookingDate = $this->getDate($year . $bookingDate);
133	1	} else {
134		// if booking date not set in :61, then we have to take it from :60F
135		$bookingDate = $this->soaDate;
136		}
137
138	1	$trx[count($trx) - 1]['booking_date'] = $bookingDate;
139	1	$trx[count($trx) - 1]['valuta_date'] = $valutaDate;
140	1	}
141	1	}
142	1	}
143
144	1	return $result;
145		}
146
147		/**
148		* @param string $descr
149		* @return array
150		*/
151	1	protected function parseDescription($descr)
152		{
153	1	$prepared = array();
154	1	$result = array();
155
156		// prefill with empty values
157	1	for ($i = 0; $i <= 63; $i++) {
158	1	$prepared[$i] = null;
159	1	}
160
161	1	$descr = str_replace("\r\n", '', $descr);
162	1	$descr = str_replace('? ', '?', $descr);
163	1	preg_match_all('/\?[\r\n]*(\d{2})([^\?]+)/', $descr, $matches, PREG_SET_ORDER);
164
165	1	$descriptionLines = array();
166	1	$description1 = ''; // Legacy, could be removed.
167	1	$description2 = ''; // Legacy, could be removed.
168	1	foreach ($matches as $m) {
169	1	$index = (int) $m[1];
170	1	if ((20 <= $index && $index <= 29) \|\| (60 <= $index && $index <= 63)) {
171	1	if (20 <= $index && $index <= 29) {
172	1	$description1 .= $m[2];
173	1	} else {
174		$description2 .= $m[2];
175		}
176	1	$m[2] = trim($m[2]);
177	1	if (!empty($m[2])) {
178	1	$descriptionLines[] = $m[2];
179	1	}
180	1	} else {
181	1	$prepared[$index] = $m[2];
182		}
183	1	}
184
185	1	$description = array();
186	1	if (empty($descriptionLines) \|\| strlen($descriptionLines[0]) < 5 \|\| $descriptionLines[0][4] !== '+') {
187		$description['SVWZ'] = implode('', $descriptionLines);
188		} else {
189	1	$lastType = null;
190	1	foreach ($descriptionLines as $line) {
191	1	if (strlen($line) > 5 && $line[4] === '+') {
192	1	if ($lastType != null) {
		0 ignored issues – show Bug introduced 2016-11-13 19:46 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$lastType` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
193	1	$description[$lastType] = trim($description[$lastType]);
194	1	}
195	1	$lastType = substr($line, 0, 4);
196	1	$description[$lastType] = substr($line, 5);
197	1	} else {
198	1	$description[$lastType] .= $line;
199		}
200	1	if (strlen($line) < 27) {
201		// Usually, lines are 27 characters long. In case characters are missing, then it's either the end
202		// of the current type or spaces have been trimmed from the end. We want to collapse multiple spaces
203		// into one and we don't want to leave trailing spaces behind. So add a single space here to make up
204		// for possibly missing spaces, and if it's the end of the type, it will be trimmed off later.
205	1	$description[$lastType] .= ' ';
206	1	}
207	1	}
208	1	$description[$lastType] = trim($description[$lastType]);
209		}
210
211	1	$result['description'] = $description;
212	1	$result['booking_text'] = trim($prepared[0]);
213	1	$result['primanoten_nr'] = trim($prepared[10]);
214	1	$result['description_1'] = trim($description1);
215	1	$result['bank_code'] = trim($prepared[30]);
216	1	$result['account_number'] = trim($prepared[31]);
217	1	$result['name'] = trim($prepared[32] . $prepared[33]);
218	1	$result['text_key_addition'] = trim($prepared[34]);
219	1	$result['description_2'] = trim($description2);
220
221	1	return $result;
222		}
223
224		/**
225		* @param string $val
226		* @return string
227		*/
228	1	protected function getDate($val)
229		{
230	1	$val = '20' . $val;
231	1	preg_match('/(\d{4})(\d{2})(\d{2})/', $val, $m);
232	1	return $m[1] . '-' . $m[2] . '-' . $m[3];
233		}
234		}
235

mschindler83 / fints-hbci-php

Pull Request — master (#87)

MT940::parseDescription() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like