invoiceninja/tests/Unit/SubscriptionsCalcTest.php

<?php
/**
 * Invoice Ninja (https://invoiceninja.com).
 *
 * @link https://github.com/invoiceninja/invoiceninja source repository
 *
 * @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
 *
 * @license https://www.elastic.co/licensing/elastic-license
 */

namespace Tests\Unit;

use App\Factory\InvoiceItemFactory;
use App\Helpers\Invoice\ProRata;
use App\Helpers\Subscription\SubscriptionCalculator;
use App\Models\Invoice;
use App\Models\Subscription;
use Illuminate\Support\Carbon;
use Tests\MockUnitData;
use Tests\TestCase;

/**
 * @test
 */
class SubscriptionsCalcTest extends TestCase
{
    use MockUnitData;

    /**
     * Important consideration with Base64
     * encoding checks.
     *
     * No method can guarantee against false positives.
     */
    protected function setUp(): void
    {
        parent::setUp();

        $this->makeTestData();
    }

    public function testCalcUpgradePrice()
    {
        $subscription = Subscription::factory()->create([
            'company_id' => $this->company->id,
            'user_id' => $this->user->id,
            'price' => 10,
        ]);

        $target = Subscription::factory()->create([
            'company_id' => $this->company->id,
            'user_id' => $this->user->id,
            'price' => 20,
        ]);

        $invoice = Invoice::factory()->create([
            'line_items' => $this->buildLineItems(),
            'company_id' => $this->company->id,
            'user_id' => $this->user->id,
            'client_id' => $this->client->id,
            'tax_rate1' => 0,
            'tax_name1' => '',
            'tax_rate2' => 0,
            'tax_name2' => '',
            'tax_rate3' => 0,
            'tax_name3' => '',
            'discount' => 0,
            'subscription_id' => $subscription->id,
            'date' => '2021-01-01',
        ]);

        $invoice = $invoice->calc()->getInvoice();

        $this->assertEquals(10, $invoice->amount);

        $invoice->service()->markSent()->save();

        $this->assertEquals(10, $invoice->amount);
        $this->assertEquals(10, $invoice->balance);

        $sub_calculator = new SubscriptionCalculator($target->fresh(), $invoice->fresh());

        $this->assertFalse($sub_calculator->isPaidUp());

        $invoice = $invoice->service()->markPaid()->save();

        $this->assertTrue($sub_calculator->isPaidUp());

        $this->assertEquals(10, $invoice->amount);
        $this->assertEquals(0, $invoice->balance);

        $pro_rata = new ProRata;

        $refund = $pro_rata->refund($invoice->amount, Carbon::parse('2021-01-01'), Carbon::parse('2021-01-06'), $subscription->frequency_id);

        // $this->assertEquals(1.61, $refund);

        $pro_rata = new ProRata;

        $upgrade = $pro_rata->charge($target->price, Carbon::parse('2021-01-01'), Carbon::parse('2021-01-06'), $subscription->frequency_id);

        // $this->assertEquals(3.23, $upgrade);
    }

    public function testProrataDiscountRatioPercentage()
    {
        $subscription = Subscription::factory()->create([
            'company_id' => $this->company->id,
            'user_id' => $this->user->id,
            'price' => 100,
        ]);

        $item = InvoiceItemFactory::create();
        $item->quantity = 1;

        $item->cost = 100;
        $item->product_key = 'xyz';
        $item->notes = 'test';
        $item->custom_value1 = 'x';
        $item->custom_value2 = 'x';
        $item->custom_value3 = 'x';
        $item->custom_value4 = 'x';

        $line_items[] = $item;

        $invoice = Invoice::factory()->create([
            'line_items' => $line_items,
            'company_id' => $this->company->id,
            'user_id' => $this->user->id,
            'client_id' => $this->client->id,
            'tax_rate1' => 0,
            'tax_name1' => '',
            'tax_rate2' => 0,
            'tax_name2' => '',
            'tax_rate3' => 0,
            'tax_name3' => '',
            'discount' => 0,
            'subscription_id' => $subscription->id,
            'date' => '2021-01-01',
            'discount' => 10,
            'is_amount_discount' => false,
            'status_id' => 1,
        ]);

        $invoice = $invoice->calc()->getInvoice();
        $this->assertEquals(90, $invoice->amount);
        $this->assertEquals(0, $invoice->balance);

        $invoice->service()->markSent()->save();

        $this->assertEquals(90, $invoice->amount);
        $this->assertEquals(90, $invoice->balance);


        $ratio = $subscription->service()->calculateDiscountRatio($invoice);

        $this->assertEquals(.1, $ratio);
    }

    public function testProrataDiscountRatioAmount()
    {
        $subscription = Subscription::factory()->create([
            'company_id' => $this->company->id,
            'user_id' => $this->user->id,
            'price' => 100,
        ]);

        $item = InvoiceItemFactory::create();
        $item->quantity = 1;

        $item->cost = 100;
        $item->product_key = 'xyz';
        $item->notes = 'test';
        $item->custom_value1 = 'x';
        $item->custom_value2 = 'x';
        $item->custom_value3 = 'x';
        $item->custom_value4 = 'x';

        $line_items[] = $item;

        $invoice = Invoice::factory()->create([
            'line_items' => $line_items,
            'company_id' => $this->company->id,
            'user_id' => $this->user->id,
            'client_id' => $this->client->id,
            'tax_rate1' => 0,
            'tax_name1' => '',
            'tax_rate2' => 0,
            'tax_name2' => '',
            'tax_rate3' => 0,
            'tax_name3' => '',
            'discount' => 0,
            'subscription_id' => $subscription->id,
            'date' => '2021-01-01',
            'discount' => 20,
            'is_amount_discount' => true,
            'status_id' => 1,
        ]);

        $invoice = $invoice->calc()->getInvoice();
        $this->assertEquals(80, $invoice->amount);
        $this->assertEquals(0, $invoice->balance);

        $invoice->service()->markSent()->save();

        $this->assertEquals(80, $invoice->amount);
        $this->assertEquals(80, $invoice->balance);


        $ratio = $subscription->service()->calculateDiscountRatio($invoice);

        $this->assertEquals(.2, $ratio);
    }
}