ActivityLogger::on() - Code Metrics - Inspection of "Merge pull request #622 from chrisrhymes/master" - spatie/laravel-activitylog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2ab150...1625e5 )

by Tom

created 2020-02-22 18:15 UTC

ActivityLogger::on() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	4
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

namespace Spatie\Activitylog;

use Spatie\String\Str;
use Illuminate\Support\Arr;
use Illuminate\Support\Carbon;
use Illuminate\Auth\AuthManager;
use Illuminate\Contracts\Config\Repository;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Arr;

use Illuminate\Support\Traits\Macroable;
use Spatie\Activitylog\Contracts\Activity as ActivityContract;
use Spatie\Activitylog\Exceptions\CouldNotLogActivity;
use Spatie\String\Str;

class ActivityLogger
{
    use Macroable;

    /** @var \Illuminate\Auth\AuthManager */
    protected $auth;

    protected $defaultLogName = '';

    /** @var string */
    protected $authDriver;

    /** @var \Spatie\Activitylog\ActivityLogStatus */
    protected $logStatus;

    /** @var \Spatie\Activitylog\Contracts\Activity */
    protected $activity;

    public function __construct(AuthManager $auth, Repository $config, ActivityLogStatus $logStatus)
    {
        $this->auth = $auth;

        $this->authDriver = $config['activitylog']['default_auth_driver'] ?? $auth->getDefaultDriver();

        $this->defaultLogName = $config['activitylog']['default_log_name'];

        $this->logStatus = $logStatus;
    }

    public function setLogStatus(ActivityLogStatus $logStatus)
    {
        $this->logStatus = $logStatus;

        return $this;
    }

    public function performedOn(Model $model)
    {
        $this->getActivity()->subject()->associate($model);

        return $this;
    }

    public function on(Model $model)
    {
        return $this->performedOn($model);
    }

    public function causedBy($modelOrId)
    {
        if ($modelOrId === null) {
            return $this;
        }

        $model = $this->normalizeCauser($modelOrId);

        $this->getActivity()->causer()->associate($model);

        return $this;
    }

    public function by($modelOrId)
    {
        return $this->causedBy($modelOrId);
    }

    public function causedByAnonymous()
    {
        $this->activity->causer_id = null;
        $this->activity->causer_type = null;

        return $this;
    }

    public function byAnonymous()
    {
        return $this->causedByAnonymous();
    }

    public function withProperties($properties)
    {
        $this->getActivity()->properties = collect($properties);

        return $this;
    }

    public function withProperty(string $key, $value)
    {
        $this->getActivity()->properties = $this->getActivity()->properties->put($key, $value);

        return $this;
    }

    public function createdAt(Carbon $dateTime)
    {
        $this->getActivity()->created_at = $dateTime;

        return $this;
    }

    public function useLog(string $logName)
    {
        $this->getActivity()->log_name = $logName;

        return $this;
    }

    public function inLog(string $logName)
    {
        return $this->useLog($logName);
    }

    public function tap(callable $callback, string $eventName = null)
    {
        call_user_func($callback, $this->getActivity(), $eventName);

        return $this;
    }

    public function enableLogging()
    {
        $this->logStatus->enable();

        return $this;
    }

    public function disableLogging()
    {
        $this->logStatus->disable();

        return $this;
    }

    public function log(string $description)
    {
        if ($this->logStatus->disabled()) {
            return;
        }

        $activity = $this->activity;

        $activity->description = $this->replacePlaceholders(
            $activity->description ?? $description,
            $activity
        );

        $activity->save();

        $this->activity = null;

        return $activity;
    }

    protected function normalizeCauser($modelOrId): Model
    {
        if ($modelOrId instanceof Model) {
            return $modelOrId;
        }

        $guard = $this->auth->guard($this->authDriver);
        $provider = method_exists($guard, 'getProvider') ? $guard->getProvider() : null;
        $model = method_exists($provider, 'retrieveById') ? $provider->retrieveById($modelOrId) : null;

        if ($model instanceof Model) {
            return $model;
        }

        throw CouldNotLogActivity::couldNotDetermineUser($modelOrId);
    }

    protected function replacePlaceholders(string $description, ActivityContract $activity): string
    {
        return preg_replace_callback('/:[a-z0-9._-]+/i', function ($match) use ($activity) {
            $match = $match[0];

            $attribute = (string) (new Str($match))->between(':', '.');

            if (! in_array($attribute, ['subject', 'causer', 'properties'])) {
                return $match;
            }

            $propertyName = substr($match, strpos($match, '.') + 1);

            $attributeValue = $activity->$attribute;

            if (is_null($attributeValue)) {
                return $match;
            }

            $attributeValue = $attributeValue->toArray();

            return Arr::get($attributeValue, $propertyName, $match);
        }, $description);
    }

    protected function getActivity(): ActivityContract
    {
        if (! $this->activity instanceof ActivityContract) {
            $this->activity = ActivitylogServiceProvider::getActivityModelInstance();
            $this
                ->useLog($this->defaultLogName)
                ->withProperties([])
                ->causedBy($this->auth->guard($this->authDriver)->user());
        }

        return $this->activity;
    }
}


1		<?php
2
3		namespace Spatie\Activitylog;
4
5		use Spatie\String\Str;
6		use Illuminate\Support\Arr;
7		use Illuminate\Support\Carbon;
8		use Illuminate\Auth\AuthManager;
9		use Illuminate\Contracts\Config\Repository;
10		use Illuminate\Database\Eloquent\Model;
11		use Illuminate\Support\Arr;
		0 ignored issues – show Bug introduced 2020-02-22 18:16 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Cannot use Illuminate\Support\Arr as Arr because the name is already in use Loading history...
12		use Illuminate\Support\Traits\Macroable;
13		use Spatie\Activitylog\Contracts\Activity as ActivityContract;
14		use Spatie\Activitylog\Exceptions\CouldNotLogActivity;
15		use Spatie\String\Str;
16
17		class ActivityLogger
18		{
19		use Macroable;
20
21		/** @var \Illuminate\Auth\AuthManager */
22		protected $auth;
23
24		protected $defaultLogName = '';
25
26		/** @var string */
27		protected $authDriver;
28
29		/** @var \Spatie\Activitylog\ActivityLogStatus */
30		protected $logStatus;
31
32	340	/** @var \Spatie\Activitylog\Contracts\Activity */
33		protected $activity;
34	340
35		public function __construct(AuthManager $auth, Repository $config, ActivityLogStatus $logStatus)
36	340	{
37		$this->auth = $auth;
38	340
39		$this->authDriver = $config['activitylog']['default_auth_driver'] ?? $auth->getDefaultDriver();
40	340
41	340	$this->defaultLogName = $config['activitylog']['default_log_name'];
42
43	132	$this->logStatus = $logStatus;
44		}
45	132
46		public function setLogStatus(ActivityLogStatus $logStatus)
47	132	{
48		$this->logStatus = $logStatus;
49
50	232	return $this;
51		}
52	232
53		public function performedOn(Model $model)
54	232	{
55		$this->getActivity()->subject()->associate($model);
56
57	16	return $this;
58		}
59	16
60		public function on(Model $model)
61		{
62	340	return $this->performedOn($model);
63		}
64	340
65	332	public function causedBy($modelOrId)
66		{
67		if ($modelOrId === null) {
68	44	return $this;
69		}
70	44
71		$model = $this->normalizeCauser($modelOrId);
72	44
73		$this->getActivity()->causer()->associate($model);
74
75	20	return $this;
76		}
77	20
78		public function by($modelOrId)
79		{
80	8	return $this->causedBy($modelOrId);
81		}
82	8
83	8	public function causedByAnonymous()
84		{
85	8	$this->activity->causer_id = null;
86		$this->activity->causer_type = null;
87
88	4	return $this;
89		}
90	4
91		public function byAnonymous()
92		{
93	340	return $this->causedByAnonymous();
94		}
95	340
96		public function withProperties($properties)
97	340	{
98		$this->getActivity()->properties = collect($properties);
99
100	4	return $this;
101		}
102	4
103		public function withProperty(string $key, $value)
104	4	{
105		$this->getActivity()->properties = $this->getActivity()->properties->put($key, $value);
106
107	340	return $this;
108		}
109	340
110		public function createdAt(Carbon $dateTime)
111	340	{
112		$this->getActivity()->created_at = $dateTime;
113
114		return $this;
115		}
116
117		public function useLog(string $logName)
118		{
119	12	$this->getActivity()->log_name = $logName;
120
121	12	return $this;
122		}
123	12
124		public function inLog(string $logName)
125		{
126	4	return $this->useLog($logName);
127		}
128	4
129		public function tap(callable $callback, string $eventName = null)
130	4	{
131		call_user_func($callback, $this->getActivity(), $eventName);
132
133	4	return $this;
134		}
135	4
136		public function enableLogging()
137	4	{
138		$this->logStatus->enable();
139
140	340	return $this;
141		}
142	340
143	8	public function disableLogging()
144		{
145		$this->logStatus->disable();
146	332
147		return $this;
148	332	}
149	332
150	83	public function log(string $description)
151		{
152		if ($this->logStatus->disabled()) {
153	332	return;
154		}
155	332
156		$activity = $this->activity;
157	332
158		$activity->description = $this->replacePlaceholders(
159		$activity->description ?? $description,
160	44	$activity
161		);
162	44
163	40	$activity->save();
164
165		$this->activity = null;
166	4
167	4	return $activity;
168	4	}
169
170	4	protected function normalizeCauser($modelOrId): Model
171	4	{
172		if ($modelOrId instanceof Model) {
173		return $modelOrId;
174		}
175
176		$guard = $this->auth->guard($this->authDriver);
177	332	$provider = method_exists($guard, 'getProvider') ? $guard->getProvider() : null;
178		$model = method_exists($provider, 'retrieveById') ? $provider->retrieveById($modelOrId) : null;
179
180	12	if ($model instanceof Model) {
181		return $model;
182	12	}
183
184	12	throw CouldNotLogActivity::couldNotDetermineUser($modelOrId);
185	4	}
186
187		protected function replacePlaceholders(string $description, ActivityContract $activity): string
188	8	{
189		return preg_replace_callback('/:[a-z0-9._-]+/i', function ($match) use ($activity) {
190	8	$match = $match[0];
191
192	8	$attribute = (string) (new Str($match))->between(':', '.');
193	4
194		if (! in_array($attribute, ['subject', 'causer', 'properties'])) {
195		return $match;
196	4	}
197
198	4	$propertyName = substr($match, strpos($match, '.') + 1);
199	332
200		$attributeValue = $activity->$attribute;
201
202	340	if (is_null($attributeValue)) {
203		return $match;
204	340	}
205	340
206		$attributeValue = $attributeValue->toArray();
207	340
208	340	return Arr::get($attributeValue, $propertyName, $match);
209	340	}, $description);
210		}
211
212	340	protected function getActivity(): ActivityContract
213		{
214		if (! $this->activity instanceof ActivityContract) {
215		$this->activity = ActivitylogServiceProvider::getActivityModelInstance();
216		$this
217		->useLog($this->defaultLogName)
218		->withProperties([])
219		->causedBy($this->auth->guard($this->authDriver)->user());
220		}
221
222		return $this->activity;
223		}
224		}
225

spatie / laravel-activitylog

Push — master ( 2ab150...1625e5 )

ActivityLogger::on() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like