Inspection of "Tests: add unit tests to WelcomeBlock module" - jon48/webtrees-lib - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 9d419d...ad76dd )

by Jonathan

created 2022-05-28 22:29 UTC

Status

Indentation +100 added lines, -100 removed lines patch added patch discarded remove patch

@@ -29,113 +29,113 @@
 block discarded – undo
  */
 class MatomoStatsService
 {
-    protected ?HandlerStack $handler = null;
+	protected ?HandlerStack $handler = null;
 
-    /**
-     * Set or get the http handler for the service
-     *
-     * @param HandlerStack $handler
-     * @return HandlerStack
-     */
-    public function httpHandler(HandlerStack $handler = null): HandlerStack
-    {
-        if ($this->handler === null) {
-            $this->handler = HandlerStack::create();
-        }
-        if ($handler !== null) {
-            $this->handler = $handler;
-        }
-        return $this->handler;
-    }
+	/**
+	 * Set or get the http handler for the service
+	 *
+	 * @param HandlerStack $handler
+	 * @return HandlerStack
+	 */
+	public function httpHandler(HandlerStack $handler = null): HandlerStack
+	{
+		if ($this->handler === null) {
+			$this->handler = HandlerStack::create();
+		}
+		if ($handler !== null) {
+			$this->handler = $handler;
+		}
+		return $this->handler;
+	}
 
-    /**
-     * Returns the number of visits for the current year (up to the day before).
-     * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @return int|NULL
-     */
-    public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
-    {
-        return Registry::cache()->file()->remember(
-            $module->name() . '-matomovisits-yearly-' . $block_id,
-            function () use ($module, $block_id): ?int {
-                $visits_year = $this->visits($module, $block_id, 'year');
-                if ($visits_year === null) {
-                    return null;
-                }
-                $visits_today = (int) $this->visits($module, $block_id, 'day');
+	/**
+	 * Returns the number of visits for the current year (up to the day before).
+	 * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @return int|NULL
+	 */
+	public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
+	{
+		return Registry::cache()->file()->remember(
+			$module->name() . '-matomovisits-yearly-' . $block_id,
+			function () use ($module, $block_id): ?int {
+				$visits_year = $this->visits($module, $block_id, 'year');
+				if ($visits_year === null) {
+					return null;
+				}
+				$visits_today = (int) $this->visits($module, $block_id, 'day');
 
-                return $visits_year - $visits_today;
-            },
-            Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
-        );
-    }
+				return $visits_year - $visits_today;
+			},
+			Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
+		);
+	}
 
-    /**
-     * Returns the number of visits for the current day.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @return int|NULL
-     */
-    public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
-    {
-        return Registry::cache()->array()->remember(
-            $module->name() . '-matomovisits-daily-' . $block_id,
-            function () use ($module, $block_id): ?int {
-                return $this->visits($module, $block_id, 'day');
-            }
-        );
-    }
+	/**
+	 * Returns the number of visits for the current day.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @return int|NULL
+	 */
+	public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
+	{
+		return Registry::cache()->array()->remember(
+			$module->name() . '-matomovisits-daily-' . $block_id,
+			function () use ($module, $block_id): ?int {
+				return $this->visits($module, $block_id, 'day');
+			}
+		);
+	}
 
-    /**
-     * Invoke the Matomo API to retrieve the number of visits over a period.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @param string $period
-     * @return int|NULL
-     */
-    protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
-    {
-        $settings = $module->matomoSettings($block_id);
+	/**
+	 * Invoke the Matomo API to retrieve the number of visits over a period.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @param string $period
+	 * @return int|NULL
+	 */
+	protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
+	{
+		$settings = $module->matomoSettings($block_id);
 
-        if (
-            $settings['matomo_enabled'] === true
-            && mb_strlen($settings['matomo_url']) > 0
-            && mb_strlen($settings['matomo_token']) > 0
-            && $settings['matomo_siteid'] > 0
-        ) {
-            try {
-                $http_client = new Client([
-                    RequestOptions::TIMEOUT => 30,
-                    'handler'   => $this->handler
-                ]);
+		if (
+			$settings['matomo_enabled'] === true
+			&& mb_strlen($settings['matomo_url']) > 0
+			&& mb_strlen($settings['matomo_token']) > 0
+			&& $settings['matomo_siteid'] > 0
+		) {
+			try {
+				$http_client = new Client([
+					RequestOptions::TIMEOUT => 30,
+					'handler'   => $this->handler
+				]);
 
-                $response = $http_client->get($settings['matomo_url'], [
-                    'query' =>  [
-                        'module'    =>  'API',
-                        'method'    =>  'VisitsSummary.getVisits',
-                        'idSite'    =>  $settings['matomo_siteid'],
-                        'period'    =>  $period,
-                        'date'      =>  'today',
-                        'token_auth' =>  $settings['matomo_token'],
-                        'format'    =>  'json'
-                    ]
-                ]);
+				$response = $http_client->get($settings['matomo_url'], [
+					'query' =>  [
+						'module'    =>  'API',
+						'method'    =>  'VisitsSummary.getVisits',
+						'idSite'    =>  $settings['matomo_siteid'],
+						'period'    =>  $period,
+						'date'      =>  'today',
+						'token_auth' =>  $settings['matomo_token'],
+						'format'    =>  'json'
+					]
+				]);
 
-                if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
-                    $result = json_decode((string) $response->getBody(), true)['value'] ?? null;
-                    if ($result !== null) {
-                        return (int)$result;
-                    }
-                }
-            } catch (GuzzleException $ex) {
-            }
-        }
+				if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
+					$result = json_decode((string) $response->getBody(), true)['value'] ?? null;
+					if ($result !== null) {
+						return (int)$result;
+					}
+				}
+			} catch (GuzzleException $ex) {
+			}
+		}
 
-        return null;
-    }
+		return null;
+	}
 }

Please login to merge, or discard this patch.

		@@ -29,113 +29,113 @@
		block discarded – undo
29	29	*/
30	30	class MatomoStatsService
31	31	{
32		- protected ?HandlerStack $handler = null;
	32	+ protected ?HandlerStack $handler = null;
33	33
34		- /**
35		- * Set or get the http handler for the service
36		- *
37		- * @param HandlerStack $handler
38		- * @return HandlerStack
39		- */
40		- public function httpHandler(HandlerStack $handler = null): HandlerStack
41		- {
42		- if ($this->handler === null) {
43		- $this->handler = HandlerStack::create();
44		- }
45		- if ($handler !== null) {
46		- $this->handler = $handler;
47		- }
48		- return $this->handler;
49		- }
	34	+ /**
	35	+ * Set or get the http handler for the service
	36	+ *
	37	+ * @param HandlerStack $handler
	38	+ * @return HandlerStack
	39	+ */
	40	+ public function httpHandler(HandlerStack $handler = null): HandlerStack
	41	+ {
	42	+ if ($this->handler === null) {
	43	+ $this->handler = HandlerStack::create();
	44	+ }
	45	+ if ($handler !== null) {
	46	+ $this->handler = $handler;
	47	+ }
	48	+ return $this->handler;
	49	+ }
50	50
51		- /**
52		- * Returns the number of visits for the current year (up to the day before).
53		- * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
54		- *
55		- * @param WelcomeBlockModule $module
56		- * @param int $block_id
57		- * @return int\|NULL
58		- */
59		- public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
60		- {
61		- return Registry::cache()->file()->remember(
62		- $module->name() . '-matomovisits-yearly-' . $block_id,
63		- function () use ($module, $block_id): ?int {
64		- $visits_year = $this->visits($module, $block_id, 'year');
65		- if ($visits_year === null) {
66		- return null;
67		- }
68		- $visits_today = (int) $this->visits($module, $block_id, 'day');
	51	+ /**
	52	+ * Returns the number of visits for the current year (up to the day before).
	53	+ * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
	54	+ *
	55	+ * @param WelcomeBlockModule $module
	56	+ * @param int $block_id
	57	+ * @return int\|NULL
	58	+ */
	59	+ public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
	60	+ {
	61	+ return Registry::cache()->file()->remember(
	62	+ $module->name() . '-matomovisits-yearly-' . $block_id,
	63	+ function () use ($module, $block_id): ?int {
	64	+ $visits_year = $this->visits($module, $block_id, 'year');
	65	+ if ($visits_year === null) {
	66	+ return null;
	67	+ }
	68	+ $visits_today = (int) $this->visits($module, $block_id, 'day');
69	69
70		- return $visits_year - $visits_today;
71		- },
72		- Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
73		- );
74		- }
	70	+ return $visits_year - $visits_today;
	71	+ },
	72	+ Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
	73	+ );
	74	+ }
75	75
76		- /**
77		- * Returns the number of visits for the current day.
78		- *
79		- * @param WelcomeBlockModule $module
80		- * @param int $block_id
81		- * @return int\|NULL
82		- */
83		- public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
84		- {
85		- return Registry::cache()->array()->remember(
86		- $module->name() . '-matomovisits-daily-' . $block_id,
87		- function () use ($module, $block_id): ?int {
88		- return $this->visits($module, $block_id, 'day');
89		- }
90		- );
91		- }
	76	+ /**
	77	+ * Returns the number of visits for the current day.
	78	+ *
	79	+ * @param WelcomeBlockModule $module
	80	+ * @param int $block_id
	81	+ * @return int\|NULL
	82	+ */
	83	+ public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
	84	+ {
	85	+ return Registry::cache()->array()->remember(
	86	+ $module->name() . '-matomovisits-daily-' . $block_id,
	87	+ function () use ($module, $block_id): ?int {
	88	+ return $this->visits($module, $block_id, 'day');
	89	+ }
	90	+ );
	91	+ }
92	92
93		- /**
94		- * Invoke the Matomo API to retrieve the number of visits over a period.
95		- *
96		- * @param WelcomeBlockModule $module
97		- * @param int $block_id
98		- * @param string $period
99		- * @return int\|NULL
100		- */
101		- protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
102		- {
103		- $settings = $module->matomoSettings($block_id);
	93	+ /**
	94	+ * Invoke the Matomo API to retrieve the number of visits over a period.
	95	+ *
	96	+ * @param WelcomeBlockModule $module
	97	+ * @param int $block_id
	98	+ * @param string $period
	99	+ * @return int\|NULL
	100	+ */
	101	+ protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
	102	+ {
	103	+ $settings = $module->matomoSettings($block_id);
104	104
105		- if (
106		- $settings['matomo_enabled'] === true
107		- && mb_strlen($settings['matomo_url']) > 0
108		- && mb_strlen($settings['matomo_token']) > 0
109		- && $settings['matomo_siteid'] > 0
110		- ) {
111		- try {
112		- $http_client = new Client([
113		- RequestOptions::TIMEOUT => 30,
114		- 'handler' => $this->handler
115		- ]);
	105	+ if (
	106	+ $settings['matomo_enabled'] === true
	107	+ && mb_strlen($settings['matomo_url']) > 0
	108	+ && mb_strlen($settings['matomo_token']) > 0
	109	+ && $settings['matomo_siteid'] > 0
	110	+ ) {
	111	+ try {
	112	+ $http_client = new Client([
	113	+ RequestOptions::TIMEOUT => 30,
	114	+ 'handler' => $this->handler
	115	+ ]);
116	116
117		- $response = $http_client->get($settings['matomo_url'], [
118		- 'query' => [
119		- 'module' => 'API',
120		- 'method' => 'VisitsSummary.getVisits',
121		- 'idSite' => $settings['matomo_siteid'],
122		- 'period' => $period,
123		- 'date' => 'today',
124		- 'token_auth' => $settings['matomo_token'],
125		- 'format' => 'json'
126		- ]
127		- ]);
	117	+ $response = $http_client->get($settings['matomo_url'], [
	118	+ 'query' => [
	119	+ 'module' => 'API',
	120	+ 'method' => 'VisitsSummary.getVisits',
	121	+ 'idSite' => $settings['matomo_siteid'],
	122	+ 'period' => $period,
	123	+ 'date' => 'today',
	124	+ 'token_auth' => $settings['matomo_token'],
	125	+ 'format' => 'json'
	126	+ ]
	127	+ ]);
128	128
129		- if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
130		- $result = json_decode((string) $response->getBody(), true)['value'] ?? null;
131		- if ($result !== null) {
132		- return (int)$result;
133		- }
134		- }
135		- } catch (GuzzleException $ex) {
136		- }
137		- }
	129	+ if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
	130	+ $result = json_decode((string) $response->getBody(), true)['value'] ?? null;
	131	+ if ($result !== null) {
	132	+ return (int)$result;
	133	+ }
	134	+ }
	135	+ } catch (GuzzleException $ex) {
	136	+ }
	137	+ }
138	138
139		- return null;
140		- }
	139	+ return null;
	140	+ }
141	141	}

jon48 / webtrees-lib

Push — main ( 9d419d...ad76dd )

Status

Category

Indentation +100 added lines, -100 removed lines patch added patch discarded remove patch