1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-10 13:12:50 +01:00

Purchase Order History Transformer

This commit is contained in:
David Bomba 2023-08-30 12:21:22 +10:00
parent b529998e00
commit 64ebecf626
7 changed files with 202 additions and 17 deletions

View File

@ -54,13 +54,13 @@ class Backup extends BaseModel
return $this->belongsTo(Activity::class);
}
public function storeRemotely(?string $html, Client $client)
public function storeRemotely(?string $html, Client | Vendor $client_or_vendor)
{
if (! $html || strlen($html) == 0) {
return;
}
$path = $client->backup_path().'/';
$path = $client_or_vendor->backup_path().'/';
$filename = now()->format('Y_m_d').'_'.md5(time()).'.html';
$file_path = $path.$filename;

View File

@ -274,4 +274,9 @@ class Vendor extends BaseModel
{
return $this->company->date_format();
}
public function backup_path() :string
{
return $this->company->company_key.'/'.$this->vendor_hash.'/backups';
}
}

View File

@ -11,21 +11,23 @@
namespace App\Repositories;
use App\Models\Activity;
use App\Models\User;
use App\Models\Quote;
use App\Models\Backup;
use App\Models\CompanyToken;
use App\Models\Credit;
use App\Models\Design;
use App\Models\Invoice;
use App\Models\Quote;
use App\Models\Activity;
use App\Utils\HtmlEngine;
use App\Models\CompanyToken;
use App\Models\PurchaseOrder;
use App\Utils\Traits\MakesHash;
use App\Utils\VendorHtmlEngine;
use App\Models\RecurringInvoice;
use App\Models\User;
use App\Utils\Traits\MakesInvoiceHtml;
use App\Services\PdfMaker\Design as PdfDesignModel;
use App\Services\PdfMaker\Design as PdfMakerDesign;
use App\Services\PdfMaker\PdfMaker as PdfMakerService;
use App\Utils\HtmlEngine;
use App\Utils\Traits\MakesHash;
use App\Utils\Traits\MakesInvoiceHtml;
/**
* Class for activity repository.
@ -85,13 +87,30 @@ class ActivityRepository extends BaseRepository
) {
$backup = new Backup();
$entity->load('client');
$contact = $entity->client->primary_contact()->first();
$backup->amount = $entity->amount;
$backup->activity_id = $activity->id;
$backup->json_backup = '';
$backup->save();
$backup->storeRemotely($this->generateHtml($entity), $entity->client);
return;
}
if(get_class($entity) == PurchaseOrder::class)
{
$backup = new Backup();
$entity->load('client');
$backup->amount = $entity->amount;
$backup->activity_id = $activity->id;
$backup->json_backup = '';
$backup->save();
$backup->storeRemotely($this->generateVendorHtml($entity), $entity->vendor);
return;
}
}
@ -109,6 +128,58 @@ class ActivityRepository extends BaseRepository
return false;
}
private function generateVendorHtml($entity)
{
$entity_design_id = $entity->design_id ? $entity->design_id : $this->decodePrimaryKey($entity->vendor->getSetting('purchase_order_design_id'));
$design = Design::withTrashed()->find($entity_design_id);
if (! $entity->invitations()->exists() || ! $design) {
nlog("No invitations for entity {$entity->id} - {$entity->number}");
return '';
}
$entity->load('vendor.company', 'invitations');
$html = new VendorHtmlEngine($entity->invitations->first()->load('purchase_order', 'contact'));
if ($design->is_custom) {
$options = [
'custom_partials' => json_decode(json_encode($design->design), true),
];
$template = new PdfMakerDesign(PdfDesignModel::CUSTOM, $options);
} else {
$template = new PdfMakerDesign(strtolower($design->name));
}
$state = [
'template' => $template->elements([
'vendor' => $entity->vendor,
'entity' => $entity,
'pdf_variables' => (array) $entity->company->settings->pdf_variables,
'$product' => $design->design->product,
]),
'variables' => $html->generateLabelsAndValues(),
'options' => [
'all_pages_header' => $entity->vendor->getSetting('all_pages_header'),
'all_pages_footer' => $entity->vendor->getSetting('all_pages_footer'),
],
'process_markdown' => $entity->vendor->company->markdown_enabled,
];
$maker = new PdfMakerService($state);
$html = $maker->design($template)
->build()
->getCompiledHTML(true);
$maker = null;
$state = null;
return $html;
}
private function generateHtml($entity)
{
$entity_design_id = '';
@ -128,8 +199,6 @@ class ActivityRepository extends BaseRepository
$entity_design_id = 'credit_design_id';
}
// $entity->load('client.company');
$entity_design_id = $entity->design_id ? $entity->design_id : $this->decodePrimaryKey($entity->client->getSetting($entity_design_id));
$design = Design::withTrashed()->find($entity_design_id);

View File

@ -0,0 +1,61 @@
<?php
/**
* Invoice Ninja (https://invoiceninja.com).
*
* @link https://github.com/invoiceninja/invoiceninja source repository
*
* @copyright Copyright (c) 2023. Invoice Ninja LLC (https://invoiceninja.com)
*
* @license https://www.elastic.co/licensing/elastic-license
*/
namespace App\Transformers;
use App\Models\Activity;
use App\Models\Backup;
use App\Utils\Traits\MakesHash;
class PurchaseOrderHistoryTransformer extends EntityTransformer
{
use MakesHash;
protected $defaultIncludes = [
// 'activity',
];
protected $availableIncludes = [
'activity',
];
public function transform(?Backup $backup)
{
if (! $backup) {
return [
'id' => '',
'activity_id' => '',
'json_backup' => (string) '',
'html_backup' => (string) '', //deprecated
'amount' => (float) 0,
'created_at' => (int) 0,
'updated_at' => (int) 0,
];
}
return [
'id' => $this->encodePrimaryKey($backup->id),
'activity_id' => $this->encodePrimaryKey($backup->activity_id),
'json_backup' => (string) '',
'html_backup' => (string) '', //deprecated
'amount' => (float) $backup->amount,
'created_at' => (int) $backup->created_at,
'updated_at' => (int) $backup->updated_at,
];
}
public function includeActivity(Backup $backup)
{
$transformer = new ActivityTransformer($this->serializer);
return $this->includeItem($backup->activity, $transformer, Activity::class);
}
}

View File

@ -11,6 +11,7 @@
namespace App\Transformers;
use App\Models\Backup;
use App\Models\Vendor;
use App\Models\Expense;
use App\Models\Document;
@ -30,6 +31,7 @@ class PurchaseOrderTransformer extends EntityTransformer
protected $availableIncludes = [
'expense',
'vendor',
'history',
];
public function includeInvitations(PurchaseOrder $purchase_order)
@ -39,6 +41,12 @@ class PurchaseOrderTransformer extends EntityTransformer
return $this->includeCollection($purchase_order->invitations, $transformer, PurchaseOrderInvitation::class);
}
public function includeHistory(PurchaseOrder $purchase_order)
{
$transformer = new PurchaseOrderHistoryTransformer($this->serializer);
return $this->includeCollection($purchase_order->history, $transformer, Backup::class);
}
public function includeDocuments(PurchaseOrder $purchase_order)
{

View File

@ -11,14 +11,20 @@
namespace Tests\Feature;
use Tests\TestCase;
use App\Utils\Ninja;
use App\Models\Activity;
use Tests\MockAccountData;
use Illuminate\Support\Str;
use App\Models\PurchaseOrder;
use App\Utils\Traits\MakesHash;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Illuminate\Support\Facades\Session;
use Illuminate\Support\Str;
use Tests\MockAccountData;
use Tests\TestCase;
use App\Repositories\ActivityRepository;
use App\Events\PurchaseOrder\PurchaseOrderWasCreated;
use App\Events\PurchaseOrder\PurchaseOrderWasUpdated;
use App\Events\PurchaseOrder\PurchaseOrderWasAccepted;
use Illuminate\Foundation\Testing\DatabaseTransactions;
class PurchaseOrderTest extends TestCase
{
@ -26,6 +32,8 @@ class PurchaseOrderTest extends TestCase
use DatabaseTransactions;
use MockAccountData;
public $faker;
protected function setUp(): void
{
parent::setUp();
@ -39,6 +47,35 @@ class PurchaseOrderTest extends TestCase
$this->makeTestData();
}
public function testPurchaseOrderHistory()
{
event(new PurchaseOrderWasUpdated($this->purchase_order, $this->company, Ninja::eventVars($this->company, $this->user)));
event(new PurchaseOrderWasCreated($this->purchase_order, $this->company, Ninja::eventVars($this->company, $this->user)));
$ar = new ActivityRepository();
$fields = new \stdClass;
$fields->user_id = $this->purchase_order->user_id;
$fields->vendor_id = $this->purchase_order->vendor_id;
$fields->company_id = $this->purchase_order->company_id;
$fields->activity_type_id = Activity::UPDATE_PURCHASE_ORDER;
$fields->purchase_order_id = $this->purchase_order->id;
$ar->save($fields, $this->purchase_order, Ninja::eventVars($this->company, $this->user));
$response = $this->withHeaders([
'X-API-SECRET' => config('ninja.api_secret'),
'X-API-TOKEN' => $this->token,
])->get("/api/v1/purchase_orders/{$this->purchase_order->hashed_id}?include=history")
->assertStatus(200);
$arr = $response->json();
$history = $arr['data']['history'];
$this->assertTrue(count($history) >= 1);
}
public function testPurchaseOrderBulkActions()
{
$i = $this->purchase_order->invitations->first();
@ -194,7 +231,7 @@ class PurchaseOrderTest extends TestCase
$x = $purchase_order->service()->markSent()->getPurchaseOrderPdf();
nlog($x);
// nlog($x);
}
public function testPurchaseOrderRest()

View File

@ -184,6 +184,11 @@ trait MockAccountData
*/
public $scheduler;
/**
* @var
*/
public $purchase_order;
public $contact;
public $product;