Discount::scopeIsExpired() - Code Metrics - Inspection of "Add tests for discount expired scope" - scottbedard/oc-shop-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5eddcf...11d6c3 )

by Scott

created 2016-10-27 01:21 UTC

Discount::scopeIsExpired() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	1
eloc	4
nc	1
nop	1

<?php namespace Bedard\Shop\Models;

use Carbon\Carbon;
use Flash;
use Lang;
use Model;
use October\Rain\Database\ModelException;

/**
 * Discount Model.
 */
class Discount extends Model
{
    use \Bedard\Shop\Traits\Subqueryable,
        \October\Rain\Database\Traits\Purgeable,
        \October\Rain\Database\Traits\Validation;

    /**
     * @var string The database table used by the model.
     */
    public $table = 'bedard_shop_discounts';

    /**
     * @var array Default attributes
     */
    public $attributes = [
        'is_percentage' => true,
    ];

    /**
     * @var array Attribute casting
     */
    protected $casts = [
        //
    ];

    /**
     * @var array Date casting
     */
    protected $dates = [
        'end_at',
        'start_at',
    ];

    /**
     * @var array Guarded fields
     */
    protected $guarded = ['*'];

    /**
     * @var array Fillable fields
     */
    protected $fillable = [
        'amount',
        'amount_exact',
        'amount_percentage',
        'end_at',
        'is_percentage',
        'name',
        'start_at',
    ];

    /**
     * @var array Purgeable vields
     */
    protected $purgeable = [
        'amount_exact',
        'amount_percentage',
    ];

    /**
     * @var array Relations
     */
    public $hasMany = [];
    public $morphMany = [];

    /**
     * @var  array Validation rules
     */
    public $rules = [
        'end_at' => 'date',
        'name' => 'required',
        'start_at' => 'date',
        'amount_exact' => 'numeric|min:0',
        'amount_percentage' => 'integer|min:0',
    ];

    /**
     * After validate.
     *
     * @return void
     */
    public function afterValidate()
    {
        $this->validateDates();
    }

    /**
     * Before save.
     *
     * @return void
     */
    public function beforeSave()
    {
        $this->setAmount();
    }

    /**
     * Filter form fields.
     *
     * @param  object   $fields
     * @return void
     */
    public function filterFields($fields)
    {
        $fields->amount_exact->hidden = $this->is_percentage;
        $fields->amount_percentage->hidden = ! $this->is_percentage;
    }


    /**
     * Query discounts that are expired.
     *
     * @param  [type] $query [description]

     * @return [type]        [description]

     */
    public function scopeIsExpired($query)
    {
        return $query->where(function($discount) {
            return $discount->whereNotNull('end_at')
                ->where('end_at', '<=', (string) Carbon::now());
        });
    }

    /**
     * Query discounts that are not expired.
     *
     * @param  [type] $query [description]

     * @return [type]        [description]

     */
    public function scopeIsNotExpired($query)
    {
        return $query->where(function ($discount) {
            return $discount->whereNull('end_at')
                ->orWhere('end_at', '>', (string) Carbon::now());
        });
    }

    /**
     * This exists to makes statuses sortable by assigning them a value.
     *
     * Expired  0
     * Running  1
     * Upcoming 2
     *
     * @param  \October\Rain\Database\Builder   $query
     * @return \October\Rain\Database\Builder
     */
    public function scopeSelectStatus($query)
    {
        $grammar = $query->getQuery()->getGrammar();
        $start_at = $grammar->wrap($this->table.'.start_at');
        $end_at = $grammar->wrap($this->table.'.end_at');
        $now = Carbon::now();

        $subquery = 'CASE '.
            "WHEN ({$end_at} IS NOT NULL AND {$end_at} < '{$now}') THEN 0 ".
            "WHEN ({$start_at} IS NOT NULL AND {$start_at} > '{$now}') THEN 2 ".
            'ELSE 1 '.
        'END';

        return $query->selectSubquery($subquery, 'status');
    }

    /**
     * Set the discount amount.
     *
     * @return  void
     */
    public function setAmount()
    {
        $exact = $this->getOriginalPurgeValue('amount_exact');
        $percentage = $this->getOriginalPurgeValue('amount_percentage');

        $this->amount = $this->is_percentage
            ? $percentage
            : $exact;
    }

    /**
     * Ensure the start and end dates are valid.
     *
     * @return void
     */
    public function validateDates()
    {
        // Start date must be after the end date
        if ($this->start_at !== null &&
            $this->end_at !== null &&
            $this->start_at >= $this->end_at) {
            Flash::error(Lang::get('bedard.shop::lang.discounts.form.start_at_invalid'));
            throw new ModelException($this);
        }
    }
}


1			<?php namespace Bedard\Shop\Models;
2
3			use Carbon\Carbon;
4			use Flash;
5			use Lang;
6			use Model;
7			use October\Rain\Database\ModelException;
8
9			/**
10			* Discount Model.
11			*/
12			class Discount extends Model
13			{
14			use \Bedard\Shop\Traits\Subqueryable,
15			\October\Rain\Database\Traits\Purgeable,
16			\October\Rain\Database\Traits\Validation;
17
18			/**
19			* @var string The database table used by the model.
20			*/
21			public $table = 'bedard_shop_discounts';
22
23			/**
24			* @var array Default attributes
25			*/
26			public $attributes = [
27			'is_percentage' => true,
28			];
29
30			/**
31			* @var array Attribute casting
32			*/
33			protected $casts = [
34			//
35			];
36
37			/**
38			* @var array Date casting
39			*/
40			protected $dates = [
41			'end_at',
42			'start_at',
43			];
44
45			/**
46			* @var array Guarded fields
47			*/
48			protected $guarded = ['*'];
49
50			/**
51			* @var array Fillable fields
52			*/
53			protected $fillable = [
54			'amount',
55			'amount_exact',
56			'amount_percentage',
57			'end_at',
58			'is_percentage',
59			'name',
60			'start_at',
61			];
62
63			/**
64			* @var array Purgeable vields
65			*/
66			protected $purgeable = [
67			'amount_exact',
68			'amount_percentage',
69			];
70
71			/**
72			* @var array Relations
73			*/
74			public $hasMany = [];
75			public $morphMany = [];
76
77			/**
78			* @var array Validation rules
79			*/
80			public $rules = [
81			'end_at' => 'date',
82			'name' => 'required',
83			'start_at' => 'date',
84			'amount_exact' => 'numeric\|min:0',
85			'amount_percentage' => 'integer\|min:0',
86			];
87
88			/**
89			* After validate.
90			*
91			* @return void
92			*/
93			public function afterValidate()
94			{
95			$this->validateDates();
96			}
97
98			/**
99			* Before save.
100			*
101			* @return void
102			*/
103			public function beforeSave()
104			{
105			$this->setAmount();
106			}
107
108			/**
109			* Filter form fields.
110			*
111			* @param object $fields
112			* @return void
113			*/
114			public function filterFields($fields)
115			{
116			$fields->amount_exact->hidden = $this->is_percentage;
117			$fields->amount_percentage->hidden = ! $this->is_percentage;
118			}
119
120
121			/**
122			* Query discounts that are expired.
123			*
124			* @param [type] $query [description]
			0 ignored issues – show Documentation introduced 2016-10-27 00:34 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
125			* @return [type] [description]
			0 ignored issues – show Documentation introduced 2016-10-27 00:34 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
126			*/
127			public function scopeIsExpired($query)
128			{
129			return $query->where(function($discount) {
130			return $discount->whereNotNull('end_at')
131			->where('end_at', '<=', (string) Carbon::now());
132			});
133			}
134
135			/**
136			* Query discounts that are not expired.
137			*
138			* @param [type] $query [description]
			0 ignored issues – show Documentation introduced 2016-10-27 01:23 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
139			* @return [type] [description]
			0 ignored issues – show Documentation introduced 2016-10-27 01:23 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
140			*/
141			public function scopeIsNotExpired($query)
142			{
143			return $query->where(function ($discount) {
144			return $discount->whereNull('end_at')
145			->orWhere('end_at', '>', (string) Carbon::now());
146			});
147			}
148
149			/**
150			* This exists to makes statuses sortable by assigning them a value.
151			*
152			* Expired 0
153			* Running 1
154			* Upcoming 2
155			*
156			* @param \October\Rain\Database\Builder $query
157			* @return \October\Rain\Database\Builder
158			*/
159			public function scopeSelectStatus($query)
160			{
161			$grammar = $query->getQuery()->getGrammar();
162			$start_at = $grammar->wrap($this->table.'.start_at');
163			$end_at = $grammar->wrap($this->table.'.end_at');
164			$now = Carbon::now();
165
166			$subquery = 'CASE '.
167			"WHEN ({$end_at} IS NOT NULL AND {$end_at} < '{$now}') THEN 0 ".
168			"WHEN ({$start_at} IS NOT NULL AND {$start_at} > '{$now}') THEN 2 ".
169			'ELSE 1 '.
170			'END';
171
172			return $query->selectSubquery($subquery, 'status');
173			}
174
175			/**
176			* Set the discount amount.
177			*
178			* @return void
179			*/
180			public function setAmount()
181			{
182			$exact = $this->getOriginalPurgeValue('amount_exact');
183			$percentage = $this->getOriginalPurgeValue('amount_percentage');
184
185			$this->amount = $this->is_percentage
186			? $percentage
187			: $exact;
188			}
189
190			/**
191			* Ensure the start and end dates are valid.
192			*
193			* @return void
194			*/
195			public function validateDates()
196			{
197			// Start date must be after the end date
198			if ($this->start_at !== null &&
199			$this->end_at !== null &&
200			$this->start_at >= $this->end_at) {
201			Flash::error(Lang::get('bedard.shop::lang.discounts.form.start_at_invalid'));
202			throw new ModelException($this);
203			}
204			}
205			}
206

scottbedard / oc-shop-plugin

Push — master ( 5eddcf...11d6c3 )

Discount::scopeIsExpired() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like