VariableService::parseFilter() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master'" - Rello/analytics - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4c07a1...a9aa4a )

by Marcel

created 2022-02-21 22:05 UTC

VariableService::parseFilter() B

↳ Parent: VariableService

Complexity

Conditions	9
Paths	14

Size

Total Lines	65
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	9
eloc	40
c	1
b	0
f	0
nc	14
nop	2
dl	0
loc	65
rs	7.7244

How to fix Long Method

<?php
/**
 * Analytics
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the LICENSE.md file.
 *
 * @author Marcel Scherello <[email protected]>
 * @copyright 2021 Marcel Scherello
 */

namespace OCA\Analytics\Service;

use OCA\Analytics\Db\DatasetMapper;
use OCP\IDateTimeFormatter;
use Psr\Log\LoggerInterface;

class VariableService
{
    private $logger;
    private $DatasetMapper;
    private $IDateTimeFormatter;

    public function __construct(
        LoggerInterface $logger,
        DatasetMapper $DatasetMapper,
        IDateTimeFormatter $IDateTimeFormatter
    )
    {
        $this->logger = $logger;
        $this->DatasetMapper = $DatasetMapper;
        $this->IDateTimeFormatter = $IDateTimeFormatter;
    }

    /**
     * replace %*% text variables in name and subheader
     *
     * @param array $datasetMetadata
     * @return array
     */
    public function replaceTextVariables($datasetMetadata)
    {
        $fields = ['name', 'subheader'];
        foreach ($fields as $field) {
            isset($datasetMetadata[$field]) ? $name = $datasetMetadata[$field] : $name = '';

            preg_match_all("/%.*?%/", $name, $matches);
            if (count($matches[0]) > 0) {
                foreach ($matches[0] as $match) {
                    $replace = null;
                    if ($match === '%currentDate%') {
                        $replace = $this->IDateTimeFormatter->formatDate(time(), 'short');
                    } elseif ($match === '%currentTime%') {
                        $replace = $this->IDateTimeFormatter->formatTime(time(), 'short');
                    } elseif ($match === '%lastUpdateDate%') {
                        $timestamp = $this->DatasetMapper->getLastUpdate($datasetMetadata['dataset']);
                        $replace = $this->IDateTimeFormatter->formatDate($timestamp, 'short');
                    } elseif ($match === '%lastUpdateTime%') {
                        $timestamp = $this->DatasetMapper->getLastUpdate($datasetMetadata['dataset']);
                        $replace = $this->IDateTimeFormatter->formatTime($timestamp, 'short');
                    } elseif ($match === '%owner%') {
                        $owner = $this->DatasetMapper->getOwner($datasetMetadata['dataset']);
                        $replace = $owner;
                    }
                    if ($replace !== null) {
                        $datasetMetadata[$field] = preg_replace('/' . $match . '/', $replace, $datasetMetadata[$field]);
                    }
                }
            }
        }
        return $datasetMetadata;
    }

    /**
     * replace variables in filters and apply format
     *
     * @param $reportMetadata
     * @return array
     */
    public function replaceFilterVariables($reportMetadata)
    {
        $filteroptions = json_decode($reportMetadata['filteroptions'], true);
        if (isset($filteroptions['filter'])) {
            foreach ($filteroptions['filter'] as $key => $value) {
                $parsed = $this->parseFilter($value['value'], $value['option']);
                $format = $this->parseFormat($value['value']);

                if (!$parsed) break;
                $filteroptions['filter'][$key]['option'] = $parsed['option'];
                $filteroptions['filter'][$key]['value'] = date($format, $parsed['value']);
            }
        }
        $reportMetadata['filteroptions'] = json_encode($filteroptions);
        return $reportMetadata;
    }

    /**
     * parsing of %*% variables
     *
     * @param $filter
     * @param $option
     * @return array|bool
     */
    private function parseFilter($filter, $option) {
        preg_match_all("/(?<=%).*(?=%)/", $filter, $matches);
        if (count($matches[0]) > 0) {
            $filter = $matches[0][0];
            preg_match('/(last|next|current|to|yester)?/', $filter, $directionMatch);
            preg_match('/[0-9]+/', $filter, $offsetMatch);
            preg_match('/(day|days|week|weeks|month|months|year|years)$/', $filter, $unitMatch);

            if (!$directionMatch[0] || !$unitMatch[0]) {
                return false;
            }

            !$offsetMatch[0] ? $offset = 1: $offset = $offsetMatch[0];

            // remove s to unify e.g. weeks => week
            $unit = rtrim($unitMatch[0], 's');

            if ($directionMatch[0] === "last" || $directionMatch[0] === "yester") {
                $direction = '-';
                //$directionWord = $directionMatch[0];
            } elseif ($directionMatch[0] === "next") {
                $direction = '+';
                //$directionWord = $directionMatch[0];
            } else { // current
                $direction = '+';
                $offset = 0;
                //$directionWord = 'this';
            }

            $timestring = $direction . $offset . ' ' . $unit;
            $baseDate = strtotime($timestring);

            if ($unit === 'day') {
                $startString = 'today';
                //$endString = 'yesterday';
            } else {
                $startString = 'first day of this ' . $unit;
                //$endString = 'last day of ' . $directionWord . ' ' . $unit;
            }
            $startTS = strtotime($startString, $baseDate);
            $start = date("Y-m-d", $startTS);
            //$endTS = strtotime($endString);
            //$end = date("Y-m-d", $endTS);

            $return = [
                'value' => $startTS,
                'option' => 'GT',
                '1$filter' => $filter,
                '2$timestring' => $timestring,
                '3$target' => $baseDate,
                '4$target_clean' => date("Y-m-d", $baseDate),
                '5$startString' => $startString,
                '6$startDate' => $start,
                '7$startTS' => $startTS,
                //'8$endString' => $endString,
                //'9$endDate' => $end,
                //'9$endTS' => $endTS,
           ];
        } else {
            $return = [
                'value' => $filter,
                'option' => $option
            ];
        }
        return $return;
    }

    /**
     * parsing of ( ) format instructions
     *
     * @param $filter
     * @return string
     */
    private function parseFormat($filter) {
        preg_match_all("/(?<=\().*(?=\))/", $filter, $matches);
        if (count($matches[0]) > 0) {
            return $matches[0][0];
        } else {
            return 'Y-m-d H:m:s';
        }
    }
}

1			<?php
2			/**
3			* Analytics
4			*
5			* This file is licensed under the Affero General Public License version 3 or
6			* later. See the LICENSE.md file.
7			*
8			* @author Marcel Scherello <[email protected]>
9			* @copyright 2021 Marcel Scherello
10			*/
11
12			namespace OCA\Analytics\Service;
13
14			use OCA\Analytics\Db\DatasetMapper;
15			use OCP\IDateTimeFormatter;
16			use Psr\Log\LoggerInterface;
17
18			class VariableService
19			{
20			private $logger;
21			private $DatasetMapper;
22			private $IDateTimeFormatter;
23
24			public function __construct(
25			LoggerInterface $logger,
26			DatasetMapper $DatasetMapper,
27			IDateTimeFormatter $IDateTimeFormatter
28			)
29			{
30			$this->logger = $logger;
31			$this->DatasetMapper = $DatasetMapper;
32			$this->IDateTimeFormatter = $IDateTimeFormatter;
33			}
34
35			/**
36			* replace %*% text variables in name and subheader
37			*
38			* @param array $datasetMetadata
39			* @return array
40			*/
41			public function replaceTextVariables($datasetMetadata)
42			{
43			$fields = ['name', 'subheader'];
44			foreach ($fields as $field) {
45			isset($datasetMetadata[$field]) ? $name = $datasetMetadata[$field] : $name = '';
46
47			preg_match_all("/%.*?%/", $name, $matches);
48			if (count($matches[0]) > 0) {
49			foreach ($matches[0] as $match) {
50			$replace = null;
51			if ($match === '%currentDate%') {
52			$replace = $this->IDateTimeFormatter->formatDate(time(), 'short');
53			} elseif ($match === '%currentTime%') {
54			$replace = $this->IDateTimeFormatter->formatTime(time(), 'short');
55			} elseif ($match === '%lastUpdateDate%') {
56			$timestamp = $this->DatasetMapper->getLastUpdate($datasetMetadata['dataset']);
57			$replace = $this->IDateTimeFormatter->formatDate($timestamp, 'short');
58			} elseif ($match === '%lastUpdateTime%') {
59			$timestamp = $this->DatasetMapper->getLastUpdate($datasetMetadata['dataset']);
60			$replace = $this->IDateTimeFormatter->formatTime($timestamp, 'short');
61			} elseif ($match === '%owner%') {
62			$owner = $this->DatasetMapper->getOwner($datasetMetadata['dataset']);
63			$replace = $owner;
64			}
65			if ($replace !== null) {
66			$datasetMetadata[$field] = preg_replace('/' . $match . '/', $replace, $datasetMetadata[$field]);
67			}
68			}
69			}
70			}
71			return $datasetMetadata;
72			}
73
74			/**
75			* replace variables in filters and apply format
76			*
77			* @param $reportMetadata
78			* @return array
79			*/
80			public function replaceFilterVariables($reportMetadata)
81			{
82			$filteroptions = json_decode($reportMetadata['filteroptions'], true);
83			if (isset($filteroptions['filter'])) {
84			foreach ($filteroptions['filter'] as $key => $value) {
85			$parsed = $this->parseFilter($value['value'], $value['option']);
86			$format = $this->parseFormat($value['value']);
87
88			if (!$parsed) break;
89			$filteroptions['filter'][$key]['option'] = $parsed['option'];
90			$filteroptions['filter'][$key]['value'] = date($format, $parsed['value']);
91			}
92			}
93			$reportMetadata['filteroptions'] = json_encode($filteroptions);
94			return $reportMetadata;
95			}
96
97			/**
98			* parsing of %*% variables
99			*
100			* @param $filter
101			* @param $option
102			* @return array\|bool
103			*/
104			private function parseFilter($filter, $option) {
105			preg_match_all("/(?<=%).*(?=%)/", $filter, $matches);
106			if (count($matches[0]) > 0) {
107			$filter = $matches[0][0];
108			preg_match('/(last\|next\|current\|to\|yester)?/', $filter, $directionMatch);
109			preg_match('/[0-9]+/', $filter, $offsetMatch);
110			preg_match('/(day\|days\|week\|weeks\|month\|months\|year\|years)$/', $filter, $unitMatch);
111
112			if (!$directionMatch[0] \|\| !$unitMatch[0]) {
113			return false;
114			}
115
116			!$offsetMatch[0] ? $offset = 1: $offset = $offsetMatch[0];
117
118			// remove s to unify e.g. weeks => week
119			$unit = rtrim($unitMatch[0], 's');
120
121			if ($directionMatch[0] === "last" \|\| $directionMatch[0] === "yester") {
122			$direction = '-';
123			//$directionWord = $directionMatch[0];
124			} elseif ($directionMatch[0] === "next") {
125			$direction = '+';
126			//$directionWord = $directionMatch[0];
127			} else { // current
128			$direction = '+';
129			$offset = 0;
130			//$directionWord = 'this';
131			}
132
133			$timestring = $direction . $offset . ' ' . $unit;
134			$baseDate = strtotime($timestring);
135
136			if ($unit === 'day') {
137			$startString = 'today';
138			//$endString = 'yesterday';
139			} else {
140			$startString = 'first day of this ' . $unit;
141			//$endString = 'last day of ' . $directionWord . ' ' . $unit;
142			}
143			$startTS = strtotime($startString, $baseDate);
144			$start = date("Y-m-d", $startTS);
145			//$endTS = strtotime($endString);
146			//$end = date("Y-m-d", $endTS);
147
148			$return = [
149			'value' => $startTS,
150			'option' => 'GT',
151			'1$filter' => $filter,
152			'2$timestring' => $timestring,
153			'3$target' => $baseDate,
154			'4$target_clean' => date("Y-m-d", $baseDate),
155			'5$startString' => $startString,
156			'6$startDate' => $start,
157			'7$startTS' => $startTS,
158			//'8$endString' => $endString,
159			//'9$endDate' => $end,
160			//'9$endTS' => $endTS,
161			];
162			} else {
163			$return = [
164			'value' => $filter,
165			'option' => $option
166			];
167			}
168			return $return;
169			}
170
171			/**
172			* parsing of ( ) format instructions
173			*
174			* @param $filter
175			* @return string
176			*/
177			private function parseFormat($filter) {
178			preg_match_all("/(?<=\().*(?=\))/", $filter, $matches);
179			if (count($matches[0]) > 0) {
180			return $matches[0][0];
181			} else {
182			return 'Y-m-d H:m:s';
183			}
184			}
185			}

Rello / analytics

Push — master ( 4c07a1...a9aa4a )

VariableService::parseFilter() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like