Skip to content

Commit 0457a65

Browse files
ValeriyShnurovoyDrahmaSilverFire
authored
HP-1848/Rename_Leasing_to_Installment (#62)
* HP-1848/Rename_Leasing_to_Installment * HP-1848/Fixed date condition * Update tests/behat/Leasing.feature Co-authored-by: Dmytro Naumenko <d.naumenko.a@gmail.com> * Update Leasing.feature * HP-1848/Rename_Leasing_to_Installment --------- Co-authored-by: Drahma <drahma@hiqdev.com> Co-authored-by: Dmytro Naumenko <d.naumenko.a@gmail.com>
1 parent cd6b779 commit 0457a65

File tree

9 files changed

+86
-67
lines changed

9 files changed

+86
-67
lines changed

‎src/charge/modifiers/Leasing.php ‎src/charge/modifiers/Installment.php

+25-21
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
use hiqdev\php\billing\charge\Charge;
1818
use hiqdev\php\billing\charge\ChargeInterface;
1919
use hiqdev\php\billing\charge\modifiers\addons\Period;
20-
use hiqdev\php\billing\charge\modifiers\event\LeasingWasFinished;
21-
use hiqdev\php\billing\charge\modifiers\event\LeasingWasStarted;
20+
use hiqdev\php\billing\charge\modifiers\event\InstallmentWasFinished;
21+
use hiqdev\php\billing\charge\modifiers\event\InstallmentWasStarted;
2222
use hiqdev\php\billing\formula\FormulaSemanticsError;
2323
use hiqdev\php\billing\price\SinglePrice;
2424
use hiqdev\php\billing\target\Target;
@@ -27,11 +27,11 @@
2727
use Money\Money;
2828

2929
/**
30-
* Leasing.
30+
* Installment.
3131
*
3232
* @author Andrii Vasyliev <sol@hiqdev.com>
3333
*/
34-
class Leasing extends Modifier
34+
class Installment extends Modifier
3535
{
3636
public function buildPrice(Money $sum)
3737
{
@@ -44,7 +44,11 @@ public function buildPrice(Money $sum)
4444

4545
public function getType()
4646
{
47-
return new Type(Type::ANY, 'monthly,leasing');
47+
$since = $this->getSince();
48+
if ($since->getValue() < new DateTimeImmutable('2024-01-01')) {
49+
return new Type(Type::ANY, 'monthly,leasing');
50+
}
51+
return new Type(Type::ANY, 'monthly,installment');
4852
}
4953

5054
public function getTarget()
@@ -54,13 +58,13 @@ public function getTarget()
5458

5559
public function till($dummy)
5660
{
57-
throw new FormulaSemanticsError('till can not be defined for leasing');
61+
throw new FormulaSemanticsError('till can not be defined for installment');
5862
}
5963

6064
public function modifyCharge(?ChargeInterface $charge, ActionInterface $action): array
6165
{
6266
if ($charge === null) {
63-
throw new \Exception('unexpected null charge in Leasing, to be implemented');
67+
throw new \Exception('unexpected null charge in Installment, to be implemented');
6468
}
6569

6670
$this->ensureIsValid();
@@ -72,30 +76,30 @@ public function modifyCharge(?ChargeInterface $charge, ActionInterface $action):
7276

7377
$month = $action->getTime()->modify('first day of this month midnight');
7478
if (!$this->checkPeriod($month)) {
75-
if ($this->isFirstMonthAfterLeasingPassed($month)) {
76-
return [$this->createLeasingFinishingCharge($charge, $month)];
79+
if ($this->isFirstMonthAfterInstallmentPassed($month)) {
80+
return [$this->createInstallmentFinishingCharge($charge, $month)];
7781
}
7882

7983
return [];
8084
}
8185

82-
return [$this->createLeasingCharge($charge, $month)];
86+
return [$this->createInstallmentCharge($charge, $month)];
8387
}
8488

8589
protected function ensureIsValid(): void
8690
{
8791
$since = $this->getSince();
8892
if ($since === null) {
89-
throw new FormulaSemanticsError('no since given for leasing');
93+
throw new FormulaSemanticsError('no since given for installment');
9094
}
9195

9296
$term = $this->getTerm();
9397
if ($term === null) {
94-
throw new FormulaSemanticsError('no term given for leasing');
98+
throw new FormulaSemanticsError('no term given for installment');
9599
}
96100
}
97101

98-
private function isFirstMonthInLeasingPassed(DateTimeImmutable $time): bool
102+
private function isFirstMonthInInstallmentPassed(DateTimeImmutable $time): bool
99103
{
100104
$since = $this->getSince();
101105
if ($since && $since->getValue() > $time) {
@@ -109,7 +113,7 @@ private function isFirstMonthInLeasingPassed(DateTimeImmutable $time): bool
109113
return false;
110114
}
111115

112-
private function isFirstMonthAfterLeasingPassed(DateTimeImmutable $time): bool
116+
private function isFirstMonthAfterInstallmentPassed(DateTimeImmutable $time): bool
113117
{
114118
$since = $this->getSince();
115119
if ($since && $since->getValue() > $time) {
@@ -131,7 +135,7 @@ private function isFirstMonthAfterLeasingPassed(DateTimeImmutable $time): bool
131135
return false;
132136
}
133137

134-
private function createLeasingFinishingCharge(ChargeInterface $charge, DateTimeImmutable $month): ChargeInterface
138+
private function createInstallmentFinishingCharge(ChargeInterface $charge, DateTimeImmutable $month): ChargeInterface
135139
{
136140
$result = new Charge(
137141
null,
@@ -142,22 +146,22 @@ private function createLeasingFinishingCharge(ChargeInterface $charge, DateTimeI
142146
$charge->getUsage(),
143147
new Money(0, $charge->getSum()->getCurrency())
144148
);
145-
$result->recordThat(LeasingWasFinished::onCharge($result, $month));
149+
$result->recordThat(InstallmentWasFinished::onCharge($result, $month));
146150
if ($charge->getComment()) {
147151
$result->setComment($charge->getComment());
148152
}
149153

150154
return $result;
151155
}
152156

153-
private function createLeasingStartingCharge(ChargeInterface $charge, DateTimeImmutable $month): ChargeInterface
157+
private function createInstallmentStartingCharge(ChargeInterface $charge, DateTimeImmutable $month): ChargeInterface
154158
{
155-
$charge->recordThat(LeasingWasStarted::onCharge($charge, $month));
159+
$charge->recordThat(InstallmentWasStarted::onCharge($charge, $month));
156160

157161
return $charge;
158162
}
159163

160-
private function createLeasingCharge(ChargeInterface $charge, DateTimeImmutable $month): ChargeInterface
164+
private function createInstallmentCharge(ChargeInterface $charge, DateTimeImmutable $month): ChargeInterface
161165
{
162166
$result = new Charge(
163167
null,
@@ -173,8 +177,8 @@ private function createLeasingCharge(ChargeInterface $charge, DateTimeImmutable
173177
$result->setComment($charge->getComment());
174178
}
175179

176-
if ($this->isFirstMonthInLeasingPassed($month)) {
177-
return $this->createLeasingStartingCharge($result, $month);
180+
if ($this->isFirstMonthInInstallmentPassed($month)) {
181+
return $this->createInstallmentStartingCharge($result, $month);
178182
}
179183

180184
return $result;

‎src/charge/modifiers/Modifier.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ public function cap()
6969
return new Cap($this->addons);
7070
}
7171

72-
public function leasing()
72+
public function installment()
7373
{
74-
return new Leasing($this->addons);
74+
return new Installment($this->addons);
7575
}
7676

7777
public function getNext()

‎src/charge/modifiers/event/LeasingWasFinished.php ‎src/charge/modifiers/event/InstallmentWasFinished.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
use hiqdev\php\billing\charge\ChargeInterface;
1414
use League\Event\AbstractEvent;
1515

16-
class LeasingWasFinished extends AbstractEvent implements \JsonSerializable
16+
class InstallmentWasFinished extends AbstractEvent implements \JsonSerializable
1717
{
1818
/**
1919
* @var ChargeInterface

‎src/charge/modifiers/event/LeasingWasStarted.php ‎src/charge/modifiers/event/InstallmentWasStarted.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use League\Event\AbstractEvent;
1616
use DateTimeImmutable;
1717

18-
class LeasingWasStarted extends AbstractEvent implements \JsonSerializable
18+
class InstallmentWasStarted extends AbstractEvent implements \JsonSerializable
1919
{
2020
/**
2121
* @var ChargeInterface

‎src/formula/FormulaEngine.php

+7-7
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use hiqdev\php\billing\charge\modifiers\Cap;
1616
use hiqdev\php\billing\charge\modifiers\Discount;
1717
use hiqdev\php\billing\charge\modifiers\Increase;
18-
use hiqdev\php\billing\charge\modifiers\Leasing;
18+
use hiqdev\php\billing\charge\modifiers\Installment;
1919
use Hoa\Ruler\Context;
2020
use Hoa\Ruler\Model\Model;
2121
use Hoa\Ruler\Ruler;
@@ -52,7 +52,7 @@ class FormulaEngine implements FormulaEngineInterface
5252
/**
5353
* @var ChargeModifier
5454
*/
55-
protected $leasing;
55+
protected $installment;
5656

5757
/**
5858
* @var ChargeModifier
@@ -199,7 +199,7 @@ protected function buildContext(): Context
199199
{
200200
$context = new Context();
201201
$context['discount'] = $this->getDiscount();
202-
$context['leasing'] = $this->getLeasing();
202+
$context['installment'] = $this->getInstallment();
203203
$context['increase'] = $this->getIncrease();
204204
$context['cap'] = $this->getCap();
205205

@@ -215,13 +215,13 @@ public function getDiscount(): ChargeModifier
215215
return $this->discount;
216216
}
217217

218-
public function getLeasing(): ChargeModifier
218+
public function getInstallment(): ChargeModifier
219219
{
220-
if ($this->leasing === null) {
221-
$this->leasing = new Leasing();
220+
if ($this->installment === null) {
221+
$this->installment = new Installment();
222222
}
223223

224-
return $this->leasing;
224+
return $this->installment;
225225
}
226226

227227
public function getIncrease(): ChargeModifier

‎tests/behat/Leasing.feature

+25-12
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,29 @@ Feature: Leasing
2121
| 2018-11-01 | leasing 0 USD reason TEST | LeasingWasFinished |
2222
| 2028-01-01 | | |
2323

24-
Scenario Outline: leasing will not work when price is zero
25-
Given server monthly price is 0 USD per item
26-
And formula is leasing.since('08.2018').lasts('3 months').reason('TEST')
27-
When action date is <date>
28-
Then first charge is <first> with <events>
24+
Scenario Outline: simple installment with reason
25+
Given formula is leasing.since('01.2024').lasts('3 months').reason('TEST')
26+
When action date is <date>
27+
Then first charge is <first> with <events>
2928
Examples:
30-
| date | first | events |
31-
| 2018-07-01 | | |
32-
| 2018-08-01 | leasing 0 USD reason TEST | LeasingWasStarted |
33-
| 2018-09-01 | leasing 0 USD reason TEST | |
34-
| 2018-10-01 | leasing 0 USD reason TEST | |
35-
| 2018-11-01 | leasing 0 USD reason TEST | LeasingWasFinished |
36-
| 2028-01-01 | | |
29+
| date | first | events |
30+
| 2023-12-01 | | |
31+
| 2024-01-01 | installment 100 USD reason TEST | InstallmentWasStarted |
32+
| 2024-02-01 | installment 100 USD reason TEST | |
33+
| 2024-03-01 | installment 100 USD reason TEST | |
34+
| 2024-04-01 | installment 0 USD reason TEST | InstallmentWasFinished |
35+
| 2028-01-01 | | |
36+
37+
Scenario Outline: leasing will not work when price is zero
38+
Given server monthly price is 0 USD per item
39+
And formula is leasing.since('08.2018').lasts('3 months').reason('TEST')
40+
When action date is <date>
41+
Then first charge is <first> with <events>
42+
Examples:
43+
| date | first | events |
44+
| 2018-07-01 | | |
45+
| 2018-08-01 | leasing 0 USD reason TEST | LeasingWasStarted |
46+
| 2018-09-01 | leasing 0 USD reason TEST | |
47+
| 2018-10-01 | leasing 0 USD reason TEST | |
48+
| 2018-11-01 | leasing 0 USD reason TEST | LeasingWasFinished |
49+
| 2028-01-01 | | |

‎tests/behat/bootstrap/FeatureContext.php

+2
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,8 @@ private function normalizeType($string): string
334334
return 'discount';
335335
case 'monthly,leasing':
336336
return 'leasing';
337+
case 'monthly,installment':
338+
return 'installment';
337339
default:
338340
return $string;
339341
}

‎tests/unit/charge/modifiers/LeasingTest.php ‎tests/unit/charge/modifiers/InstallmentTest.php

+16-16
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
use DateTimeImmutable;
1414
use hiqdev\php\billing\charge\modifiers\addons\MonthPeriod;
1515
use hiqdev\php\billing\charge\modifiers\addons\YearPeriod;
16-
use hiqdev\php\billing\charge\modifiers\event\LeasingWasStarted;
16+
use hiqdev\php\billing\charge\modifiers\event\InstallmentWasStarted;
1717
use hiqdev\php\billing\charge\modifiers\Leasing;
1818
use hiqdev\php\billing\price\SinglePrice;
1919
use hiqdev\php\billing\tests\unit\action\ActionTest;
@@ -22,61 +22,61 @@
2222
/**
2323
* @author Andrii Vasyliev <sol@hiqdev.com>
2424
*/
25-
class LeasingTest extends ActionTest
25+
class InstallmentTest extends ActionTest
2626
{
2727
protected $reason = 'test reason string';
2828

2929
protected function setUp(): void
3030
{
3131
parent::setUp();
32-
$this->type = new Type(Type::ANY, 'monthly,leasing');
32+
$this->type = new Type(Type::ANY, 'monthly,installment');
3333
$this->price = new SinglePrice(5, $this->type, $this->target, null, $this->prepaid, $this->money);
3434
}
3535

36-
protected function buildLeasing($term)
36+
protected function buildInstallment($term)
3737
{
3838
$month = (new DateTimeImmutable())->modify('first day of this month midnight');
3939

40-
return (new Leasing())->since($month)->lasts($term);
40+
return (new Installment())->since($month)->lasts($term);
4141
}
4242

4343
public function testCreateMonth()
4444
{
45-
$leasing = $this->buildLeasing('12 months');
46-
$period = $leasing->getTerm();
45+
$installment = $this->buildInstallment('12 months');
46+
$period = $installment->getTerm();
4747
$this->assertInstanceOf(MonthPeriod::class, $period);
4848
$this->assertSame(12, $period->getValue());
4949
}
5050

5151
public function testTill()
5252
{
5353
$this->expectException(\Exception::class);
54-
$this->buildLeasing('month')->till('08.2018');
54+
$this->buildInstallment('month')->till('08.2024');
5555
}
5656

5757
public function testReason()
5858
{
59-
$leasing = $this->buildLeasing('12 months');
60-
$leasing = $leasing->reason($this->reason);
61-
$this->assertSame($this->reason, $leasing->getReason()->getValue());
59+
$installment = $this->buildInstallment('12 months');
60+
$installment = $installment->reason($this->reason);
61+
$this->assertSame($this->reason, $installment->getReason()->getValue());
6262
}
6363

6464
public function testCreateYear()
6565
{
66-
$leasing = $this->buildLeasing('1 year');
67-
$period = $leasing->getTerm();
66+
$installment = $this->buildInstallment('1 year');
67+
$period = $installment->getTerm();
6868
$this->assertInstanceOf(YearPeriod::class, $period);
6969
$this->assertSame(1, $period->getValue());
7070
}
7171

7272
public function testModifyCharge()
7373
{
74-
$leasing = $this->buildLeasing('6 months');
74+
$installment = $this->buildInstallment('6 months');
7575
$action = $this->createAction($this->prepaid->multiply(2));
7676
$charge = $this->calculator->calculateCharge($this->price, $action);
77-
$charges = $leasing->modifyCharge($charge, $action);
77+
$charges = $installment->modifyCharge($charge, $action);
7878
$event = $charges[0]->releaseEvents()[0];
79-
$this->assertInstanceOf(LeasingWasStarted::class, $event);
79+
$this->assertInstanceOf(InstallmentWasStarted::class, $event);
8080
$this->assertIsArray($charges);
8181
$this->assertSame(1, count($charges));
8282
$this->assertEquals($charge, $charges[0]);

‎tests/unit/formula/FormulaEngineTest.php

+7-7
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
use hiqdev\php\billing\charge\modifiers\addons\Reason;
1717
use hiqdev\php\billing\charge\modifiers\addons\Since;
1818
use hiqdev\php\billing\charge\modifiers\FixedDiscount;
19-
use hiqdev\php\billing\charge\modifiers\Leasing;
19+
use hiqdev\php\billing\charge\modifiers\Installment;
2020
use hiqdev\php\billing\formula\FormulaEngine;
2121
use PHPUnit\Framework\TestCase;
2222

@@ -52,17 +52,17 @@ public function testSimpleDiscount()
5252
$this->assertNull($formula->getTill());
5353
}
5454

55-
public function testSimpleLeasing()
55+
public function testSimpleInstallment()
5656
{
57-
$this->checkSimpleLeasing('2018-08-01', 2, 'test reason');
58-
$this->checkSimpleLeasing('2018-09-01', 3, 'test reason');
57+
$this->checkSimpleInstallment('2024-08-01', 2, 'test reason');
58+
$this->checkSimpleInstallment('2024-09-01', 3, 'test reason');
5959
}
6060

61-
protected function checkSimpleLeasing($date, $num, $reason)
61+
protected function checkSimpleInstallment($date, $num, $reason)
6262
{
63-
$formula = $this->engine->build("leasing.since('$date').lasts('$num months').reason('$reason')");
63+
$formula = $this->engine->build("installment.since('$date').lasts('$num months').reason('$reason')");
6464

65-
$this->assertInstanceOf(Leasing::class, $formula);
65+
$this->assertInstanceOf(Installment::class, $formula);
6666
$this->assertInstanceOf(MonthPeriod::class, $formula->getTerm());
6767
$this->assertSame($num, $formula->getTerm()->getValue());
6868
$this->assertInstanceOf(Since::class, $formula->getSince());

0 commit comments

Comments
 (0)