HasSubscriptions::forceCancelSubscription() - Code Metrics - Inspection of "Subscription Test" - sagitarius29/laravel-subscriptions - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( f351ab...661889 )

by Adolfo

created 2019-10-31 00:10 UTC

HasSubscriptions::forceCancelSubscription() A

↳ Parent: HasSubscriptions

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Sagitarius29\LaravelSubscriptions\Traits;

use Carbon\Carbon;
use Sagitarius29\LaravelSubscriptions\Entities\PlanInterval;
use Sagitarius29\LaravelSubscriptions\Entities\Subscription;
use Sagitarius29\LaravelSubscriptions\Contracts\PlanContract;
use Sagitarius29\LaravelSubscriptions\Contracts\SubscriptionContact;
use Sagitarius29\LaravelSubscriptions\Contracts\PlanIntervalContract;
use Sagitarius29\LaravelSubscriptions\Exceptions\SubscriptionErrorException;

trait HasSubscriptions
{
    /**
     * @param  PlanContract|PlanIntervalContract  $planOrInterval
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function subscribeTo($planOrInterval)
    {
        if ($planOrInterval instanceof PlanContract) {
            return $this->subscribeToPlan($planOrInterval);
        }

        return $this->subscribeToInterval($planOrInterval);
    }

    public function subscribeToPlan(PlanContract $plan)
    {
        if ($plan->hasManyIntervals()) {
            throw new SubscriptionErrorException(
                'This plan has many intervals, please use subscribeToInterval() function'
            );
        }

        $currentSubscription = $this->getActiveSubscription();
        $start_at = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $end_at = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        if ($currentSubscription == null) {
            $start_at = now();
        } else {
            $start_at = $currentSubscription->getExpirationDate();
        }

        if ($plan->isFree()) {
            $end_at = null;
        } else {
            $end_at = $this->calculateExpireDate($start_at, $plan->intervals()->first());
        }

        $subscription = Subscription::make($plan, $start_at, $end_at);
        $subscription = $this->subscriptions()->save($subscription);

        return $subscription;
    }

    public function getActiveSubscription(): ?SubscriptionContact
    {
        return $this->subscriptions()
            ->current()
            ->first();
    }

    public function hasActiveSubscription(): bool
    {
        return $this->subscriptions()
            ->current()
            ->exists();
    }

    public function subscriptions()
    {
        return $this->morphMany(config('subscriptions.entities.plan_subscription'), 'subscriber');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    private function calculateExpireDate(Carbon $start_at, PlanIntervalContract $interval)
    {
        $end_at = Carbon::createFromTimestamp($start_at->timestamp);

        switch ($interval->getType()) {
            case PlanInterval::$DAY:
                return $end_at->days($interval->getUnit());
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case PlanInterval::$MONTH:
                return $end_at->addMonths($interval->getUnit());
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case PlanInterval::$YEAR:
                return $end_at->addYears($interval->getUnit());
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            default:
                //TODO error exception
                break;
        }
    }

    public function subscribeToInterval(PlanIntervalContract $interval): SubscriptionContact
    {
        $currentSubscription = $this->getActiveSubscription();
        $start_at = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $end_at = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        if ($currentSubscription == null) {
            $start_at = now();
        } else {
            $start_at = $currentSubscription->getExpirationDate();
        }

        $end_at = $this->calculateExpireDate($start_at, $interval);

        $subscription = Subscription::make($interval->plan, $start_at, $end_at);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $subscription = $this->subscriptions()->save($subscription);

        return $subscription;
    }

    public function changePlanTo(PlanContract $plan, PlanIntervalContract $interval = null)
    {
        if (! $this->hasActiveSubscription()) {
            throw new SubscriptionErrorException('You need a subscription for upgrade to other.');
        }

        if ($plan->hasManyIntervals() && $interval == null) {
            throw new SubscriptionErrorException('The plan has many intervals, please indicate a interval.');
        }

        $currentSubscription = $this->getActiveSubscription();
        $currentPlan = $currentSubscription->plan;
        $currentIntervalPrice = $currentPlan->isFree() ? 0.00 : $currentPlan->getInterval()->getPrice();

        $toInterval = $plan->getInterval();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        if ($currentPlan->id == $plan->id) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            throw new SubscriptionErrorException('You can\'t change to same plan. You need change to other plan.');
        }

        if ($interval !== null) {
            $toInterval = $interval;
        }

        if ($currentIntervalPrice < $toInterval->getPrice()) {
            return $this->upgradeTo($toInterval);
        }

        return $this->downgradeTo($toInterval);
    }

    protected function upgradeTo(PlanIntervalContract $interval): SubscriptionContact
    {
        if(! $this->hasActiveSubscription()) {
            throw new SubscriptionErrorException('You need a subscription for upgrade to other.');
        }

        $this->forceCancelSubscription();

        return $this->subscribeToInterval($interval);
    }

    protected function downgradeTo(PlanIntervalContract $interval): SubscriptionContact
    {
        if(! $this->hasActiveSubscription()) {
            throw new SubscriptionErrorException('You need a subscription for upgrade to other.');
        }

        return $this->subscribeToInterval($interval);
    }

    public function renewSubscription(PlanIntervalContract $interval = null)
    {
        $currentSubscription = $this->getActiveSubscription();

        if ($interval === null) {
            $plan = $currentSubscription->plan;

            if ($plan->hasManyIntervals()) {
                throw new SubscriptionErrorException(
                    'The plan you want will subscribe has many intervals, please consider renew to a interval of plan'
                );
            }

            $interval = $plan->intervals()->first();
        }

        $newExpireDate = $this->calculateExpireDate($currentSubscription->end_at, $interval);

        $currentSubscription->end_at = $newExpireDate;
        $currentSubscription->save();

        return $currentSubscription;
    }

    public function cancelSubscription()
    {
        $currentSubscription = $this->getActiveSubscription();
        $currentSubscription->cancelled_at = now();
        $currentSubscription->save();
    }

    public function forceCancelSubscription()
    {
        $currentSubscription = $this->getActiveSubscription();
        $currentSubscription->end_at = now()->subSecond();
        $currentSubscription->cancelled_at = now();
        $currentSubscription->save();
    }

    public function getConsumables()
    {
    }
}


Push — develop ( f351ab...661889 )

HasSubscriptions::forceCancelSubscription() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace Sagitarius29\LaravelSubscriptions\Traits;
4
5			use Carbon\Carbon;
6			use Sagitarius29\LaravelSubscriptions\Entities\PlanInterval;
7			use Sagitarius29\LaravelSubscriptions\Entities\Subscription;
8			use Sagitarius29\LaravelSubscriptions\Contracts\PlanContract;
9			use Sagitarius29\LaravelSubscriptions\Contracts\SubscriptionContact;
10			use Sagitarius29\LaravelSubscriptions\Contracts\PlanIntervalContract;
11			use Sagitarius29\LaravelSubscriptions\Exceptions\SubscriptionErrorException;
12
13			trait HasSubscriptions
14			{
15			/**
16			* @param PlanContract\|PlanIntervalContract $planOrInterval
17			* @return \Illuminate\Database\Eloquent\Model
18			*/
19			public function subscribeTo($planOrInterval)
20			{
21			if ($planOrInterval instanceof PlanContract) {
22			return $this->subscribeToPlan($planOrInterval);
23			}
24
25			return $this->subscribeToInterval($planOrInterval);
26			}
27
28			public function subscribeToPlan(PlanContract $plan)
29			{
30			if ($plan->hasManyIntervals()) {
31			throw new SubscriptionErrorException(
32			'This plan has many intervals, please use subscribeToInterval() function'
33			);
34			}
35
36			$currentSubscription = $this->getActiveSubscription();
37			$start_at = null;
			0 ignored issues – show Unused Code introduced 2019-10-29 15:22 UTC by Report Bug Copy Issue Report `$start_at` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
38			$end_at = null;
			0 ignored issues – show Unused Code introduced 2019-10-30 06:48 UTC by Report Bug Copy Issue Report `$end_at` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
39
40			if ($currentSubscription == null) {
41			$start_at = now();
42			} else {
43			$start_at = $currentSubscription->getExpirationDate();
44			}
45
46			if ($plan->isFree()) {
47			$end_at = null;
48			} else {
49			$end_at = $this->calculateExpireDate($start_at, $plan->intervals()->first());
50			}
51
52			$subscription = Subscription::make($plan, $start_at, $end_at);
53			$subscription = $this->subscriptions()->save($subscription);
54
55			return $subscription;
56			}
57
58			public function getActiveSubscription(): ?SubscriptionContact
59			{
60			return $this->subscriptions()
61			->current()
62			->first();
63			}
64
65			public function hasActiveSubscription(): bool
66			{
67			return $this->subscriptions()
68			->current()
69			->exists();
70			}
71
72			public function subscriptions()
73			{
74			return $this->morphMany(config('subscriptions.entities.plan_subscription'), 'subscriber');
			0 ignored issues – show Bug introduced 2019-10-29 02:10 UTC by Report Bug Copy Issue Report It seems like `morphMany()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
75			}
76
77			private function calculateExpireDate(Carbon $start_at, PlanIntervalContract $interval)
78			{
79			$end_at = Carbon::createFromTimestamp($start_at->timestamp);
80
81			switch ($interval->getType()) {
82			case PlanInterval::$DAY:
83			return $end_at->days($interval->getUnit());
84			break;
			0 ignored issues – show Unused Code introduced 2019-10-29 15:22 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...
85			case PlanInterval::$MONTH:
86			return $end_at->addMonths($interval->getUnit());
87			break;
			0 ignored issues – show Unused Code introduced 2019-10-29 15:22 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...
88			case PlanInterval::$YEAR:
89			return $end_at->addYears($interval->getUnit());
90			break;
			0 ignored issues – show Unused Code introduced 2019-10-29 15:22 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...
91			default:
92			//TODO error exception
93			break;
94			}
95			}
96
97			public function subscribeToInterval(PlanIntervalContract $interval): SubscriptionContact
98			{
99			$currentSubscription = $this->getActiveSubscription();
100			$start_at = null;
			0 ignored issues – show Unused Code introduced 2019-10-30 06:48 UTC by Report Bug Copy Issue Report `$start_at` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
101			$end_at = null;
			0 ignored issues – show Unused Code introduced 2019-10-30 06:48 UTC by Report Bug Copy Issue Report `$end_at` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
102
103			if ($currentSubscription == null) {
104			$start_at = now();
105			} else {
106			$start_at = $currentSubscription->getExpirationDate();
107			}
108
109			$end_at = $this->calculateExpireDate($start_at, $interval);
110
111			$subscription = Subscription::make($interval->plan, $start_at, $end_at);
			0 ignored issues – show Bug introduced 2019-10-30 06:48 UTC by Report Bug Copy Issue Report Accessing `plan` on the interface `Sagitarius29\LaravelSubs...ts\PlanIntervalContract` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
112			$subscription = $this->subscriptions()->save($subscription);
113
114			return $subscription;
115			}
116
117			public function changePlanTo(PlanContract $plan, PlanIntervalContract $interval = null)
118			{
119			if (! $this->hasActiveSubscription()) {
120			throw new SubscriptionErrorException('You need a subscription for upgrade to other.');
121			}
122
123			if ($plan->hasManyIntervals() && $interval == null) {
124			throw new SubscriptionErrorException('The plan has many intervals, please indicate a interval.');
125			}
126
127			$currentSubscription = $this->getActiveSubscription();
128			$currentPlan = $currentSubscription->plan;
129			$currentIntervalPrice = $currentPlan->isFree() ? 0.00 : $currentPlan->getInterval()->getPrice();
130
131			$toInterval = $plan->getInterval();
			0 ignored issues – show Bug introduced 2019-10-31 00:12 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sagitarius29\LaravelSubs...\Contracts\PlanContract` as the method `getInterval()` does only exist in the following implementations of said interface: `Sagitarius29\LaravelSubscriptions\Entities\Plan`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
132
133			if ($currentPlan->id == $plan->id) {
			0 ignored issues – show Bug introduced 2019-10-31 00:12 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `Sagitarius29\LaravelSubs...\Contracts\PlanContract` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
134			throw new SubscriptionErrorException('You can\'t change to same plan. You need change to other plan.');
135			}
136
137			if ($interval !== null) {
138			$toInterval = $interval;
139			}
140
141			if ($currentIntervalPrice < $toInterval->getPrice()) {
142			return $this->upgradeTo($toInterval);
143			}
144
145			return $this->downgradeTo($toInterval);
146			}
147
148			protected function upgradeTo(PlanIntervalContract $interval): SubscriptionContact
149			{
150			if(! $this->hasActiveSubscription()) {
151			throw new SubscriptionErrorException('You need a subscription for upgrade to other.');
152			}
153
154			$this->forceCancelSubscription();
155
156			return $this->subscribeToInterval($interval);
157			}
158
159			protected function downgradeTo(PlanIntervalContract $interval): SubscriptionContact
160			{
161			if(! $this->hasActiveSubscription()) {
162			throw new SubscriptionErrorException('You need a subscription for upgrade to other.');
163			}
164
165			return $this->subscribeToInterval($interval);
166			}
167
168			public function renewSubscription(PlanIntervalContract $interval = null)
169			{
170			$currentSubscription = $this->getActiveSubscription();
171
172			if ($interval === null) {
173			$plan = $currentSubscription->plan;
174
175			if ($plan->hasManyIntervals()) {
176			throw new SubscriptionErrorException(
177			'The plan you want will subscribe has many intervals, please consider renew to a interval of plan'
178			);
179			}
180
181			$interval = $plan->intervals()->first();
182			}
183
184			$newExpireDate = $this->calculateExpireDate($currentSubscription->end_at, $interval);
185
186			$currentSubscription->end_at = $newExpireDate;
187			$currentSubscription->save();
188
189			return $currentSubscription;
190			}
191
192			public function cancelSubscription()
193			{
194			$currentSubscription = $this->getActiveSubscription();
195			$currentSubscription->cancelled_at = now();
196			$currentSubscription->save();
197			}
198
199			public function forceCancelSubscription()
200			{
201			$currentSubscription = $this->getActiveSubscription();
202			$currentSubscription->end_at = now()->subSecond();
203			$currentSubscription->cancelled_at = now();
204			$currentSubscription->save();
205			}
206
207			public function getConsumables()
208			{
209			}
210			}
211

sagitarius29 / laravel-subscriptions

Push — develop ( f351ab...661889 )

HasSubscriptions::forceCancelSubscription() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like