Completed
Pull Request — master (#12)
by Klochok
02:51
created

BillingContext::enumPrice()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 2
c 1
b 0
f 0
nc 1
nop 8
dl 0
loc 4
rs 10

How to fix   Many Parameters   

Many Parameters

Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.

There are several approaches to avoid long parameter lists:

1
<?php
2
3
namespace hiqdev\php\billing\tests\behat\bootstrap;
4
use PHPUnit\Framework\Assert;
5
6
class BillingContext extends BaseContext
7
{
8
    /**
9
     * @Given reseller :reseller
10
     */
11
    public function reseller($reseller)
12
    {
13
        $this->builder->buildReseller($reseller);
14
    }
15
16
    /**
17
     * @Given customer :customer
18
     */
19
    public function customer($customer)
20
    {
21
        $this->builder->buildCustomer($customer);
22
    }
23
24
    /**
25
     * @Given manager :manager
26
     */
27
    public function manager($manager)
28
    {
29
        $this->builder->buildManager($manager);
30
    }
31
32
    /**
33
     * @Given admin :login
34
     */
35
    public function admin($login)
36
    {
37
        $this->builder->buildAdmin($login);
38
    }
39
40
    /**
41
     * @Given /^(grouping )?(\S+) tariff plan (\S+)/
42
     */
43
    public function plan($grouping, $type, $plan)
44
    {
45
        $this->builder->buildPlan($plan, $type, !empty($grouping));
46
    }
47
48
    protected function fullPrice(array $data)
49
    {
50
        $this->builder->buildPrice($data);
51
    }
52
53
    /**
54
     * @Given /price for (\S+) is +(\S+) (\S+) per (\S+) for target (\S+)/
55
     */
56
    public function priceWithObject($type, $price, $currency, $unit, $target)
57
    {
58
        return $this->fullPrice(compact('type', 'price', 'currency', 'unit', 'target'));
0 ignored issues
show
Bug introduced by
Are you sure the usage of $this->fullPrice(compact...cy', 'unit', 'target')) targeting hiqdev\php\billing\tests...ingContext::fullPrice() seems to always return null.

This check looks for function or method calls that always return null and whose return value is used.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

The method getObject() can return nothing but null, so it makes no sense to use the return value.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
59
    }
60
61
    /**
62
     * @Given /price for (\S+) is +(\S+) (\S+) per (\S+) prepaid (\S+)/
63
     */
64
    public function priceWithOver($type, $price, $currency, $unit, $prepaid)
65
    {
66
        return $this->fullPrice(compact('type', 'price', 'currency', 'unit', 'prepaid'));
0 ignored issues
show
Bug introduced by
Are you sure the usage of $this->fullPrice(compact...y', 'unit', 'prepaid')) targeting hiqdev\php\billing\tests...ingContext::fullPrice() seems to always return null.

This check looks for function or method calls that always return null and whose return value is used.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

The method getObject() can return nothing but null, so it makes no sense to use the return value.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
67
    }
68
69
    /**
70
     * @Given /price for (\S+) is +(\S+) (\S+) per (\S+)$/
71
     */
72
    public function price($type, $price, $currency, $unit)
73
    {
74
        return $this->fullPrice(compact('type', 'price', 'currency', 'unit'));
0 ignored issues
show
Bug introduced by
Are you sure the usage of $this->fullPrice(compact...', 'currency', 'unit')) targeting hiqdev\php\billing\tests...ingContext::fullPrice() seems to always return null.

This check looks for function or method calls that always return null and whose return value is used.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

The method getObject() can return nothing but null, so it makes no sense to use the return value.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
75
    }
76
77
    /**
78
     * @Given /price for (\S+) is +(\S+) (\S+) per 1 (\S+) and (\S+) (\S+) per 2 (\S+) for target (\S+)/
79
     */
80
    public function enumPrice($type, $price, $currency, $unit, $price2, $currency2, $unit2, $target)
0 ignored issues
show
Unused Code introduced by
The parameter $currency2 is not used and could be removed. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unused  annotation

80
    public function enumPrice($type, $price, $currency, $unit, $price2, /** @scrutinizer ignore-unused */ $currency2, $unit2, $target)

This check looks for parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $unit2 is not used and could be removed. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unused  annotation

80
    public function enumPrice($type, $price, $currency, $unit, $price2, $currency2, /** @scrutinizer ignore-unused */ $unit2, $target)

This check looks for parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
81
    {
82
        $sums = [1 => $price, 2 => $price2];
83
        return $this->fullPrice(compact('type', 'sums', 'currency', 'unit', 'target'));
0 ignored issues
show
Bug introduced by
Are you sure the usage of $this->fullPrice(compact...cy', 'unit', 'target')) targeting hiqdev\php\billing\tests...ingContext::fullPrice() seems to always return null.

This check looks for function or method calls that always return null and whose return value is used.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

The method getObject() can return nothing but null, so it makes no sense to use the return value.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
84
    }
85
86
    /**
87
     * @Given /^remove and recreate tariff plan (\S+)/
88
     */
89
    public function recreatePlan($plan)
90
    {
91
        $this->builder->recreatePlan($plan);
92
    }
93
94
    /**
95
     * @Given /sale (\S+) for (\S+) plan:(\S+) time:(\S+)/
96
     */
97
    public function sale($id, $target, $plan, $time): void
98
    {
99
        $this->builder->buildSale($id, $target, $plan, $time);
100
    }
101
102
    /**
103
     * @Given /resource consumption for (\S+) is (\d+) (\S+) (\S+) for target (\S+)/
104
     */
105
    public function setConsumption(string $type, int $amount, string $unit, string $time, string $target): void
106
    {
107
        $this->builder->setConsumption($type, $amount, $unit, $time, $target);
108
    }
109
110
    /**
111
     * @Given /perform billing for time (\S+) for sales/
112
     */
113
    public function performBilling(string $time): void
114
    {
115
        $this->builder->performBilling($time);
116
    }
117
118
    /**
119
     * @Given /bill +for (\S+) is +(\S+) (\S+) per (\d+) (\S+) for target (\S+)$/
120
     */
121
    public function bill($type, $sum, $currency, $quantity, $unit, $target)
122
    {
123
        $target = $this->builder->buildTarget($target);
124
        $bill = $this->builder->findBill([
125
            'type' => $type,
126
            'target' => $target,
127
            'sum' => "$sum $currency",
128
            'quantity' => "$quantity $unit",
129
        ]);
130
        Assert::assertSame($type, $bill->getType()->getName());
131
        Assert::assertSame($target->getType(), $bill->getTarget()->getType());
132
        Assert::assertSame($target->getName(), $bill->getTarget()->getName());
133
        Assert::assertEquals($sum*100, $bill->getSum()->getAmount());
134
        Assert::assertSame($currency, $bill->getSum()->getCurrency()->getCode());
135
        Assert::assertEquals($quantity, $bill->getQuantity()->getQuantity());
136
        Assert::assertSame($unit, $bill->getQuantity()->getUnit()->getName());
137
    }
138
139
    /**
140
     * @Given /bills number is (\d+) for (\S+) for target (\S+)/
141
     */
142
    public function billsNumber($number, $type, $target)
143
    {
144
        $count = count($this->builder->findBills([
145
            'type' => $type,
146
            'target' => $target,
147
        ]));
148
149
        Assert::assertEquals($number, $count);
150
    }
151
152
    /**
153
     * @Given /charge for (\S+) is +(\S+) (\S+) per (\d+) (\S+) for target (\S+)$/
154
     */
155
    public function chargeWithTarget($type, $amount, $currency, $quantity, $unit, $target)
156
    {
157
        $target = $this->builder->buildTarget($target);
158
        $charge = $this->builder->getNextCharge();
159
        Assert::assertSame($type, $charge->getType()->getName());
160
        Assert::assertSame($target->getType(), $charge->getTarget()->getType());
161
        Assert::assertSame($target->getName(), $charge->getTarget()->getName());
162
        Assert::assertEquals($amount*100, $charge->getSum()->getAmount());
163
        Assert::assertSame($currency, $charge->getSum()->getCurrency()->getCode());
164
        Assert::assertEquals($quantity, $charge->getUsage()->getQuantity());
165
        Assert::assertSame($unit, $charge->getUsage()->getUnit()->getName());
166
    }
167
168
    /**
169
     * @Given /charge for (\S+) is +(\S+) (\S+) per (\d+) (\S+)$/
170
     */
171
    public function charge($type, $amount, $currency, $quantity, $unit)
172
    {
173
        $this->chargeWithTarget($type, $amount, $currency, $quantity, $unit, null);
174
    }
175
}
176