mirror/Part-DB.Part-DB-server
1
0
Fork 1
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-06-20 17:15:51 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added placeholders for Part lots.

Browse source
This commit is contained in:
Jan Böhmer 2020-04-17 21:10:08 +02:00
parent a4e1a17b4a
commit 16c1f84eb3
7 changed files with 226 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
config/services.yaml
View file

@ -174,4 +174,9 @@ services:
App\Services\TranslationExtractor\PermissionExtractor:
tags:
- { name: 'translation.extractor', alias: 'permissionExtractor'}
- { name: 'translation.extractor', alias: 'permissionExtractor'}
# PartLotProvider must be invoked before all other providers, so it can override %%NAME%% placeholder
App\Services\LabelSystem\PlaceholderProviders\PartLotProvider:
tags:
- { name: 'app.label_placeholder_provider', priority: 10}

8
public/ckeditor/plugins/partdb_label/lang/de.js
View file

@ -22,6 +22,7 @@ CKEDITOR.plugins.setLang( 'partdb_label', 'de', {
label: 'Platzhalter',
'section.global': 'Global',
'section.part': 'Bauteil',
'section.part_lot': 'Bauteilbestand',
'part.id': 'Datenbank ID',
'part.name': 'Bauteilename',
'part.category': 'Kategorie',
@ -47,4 +48,11 @@ CKEDITOR.plugins.setLang( 'partdb_label', 'de', {
'global.time': 'Uhrzeit',
'global.install_name': 'Installationsname',
'global.type': 'Zieltyp',
'lot.id': 'Lot ID',
'lot.name': 'Lot Name',
'lot.comment': 'Lot Kommentar',
'lot.expiration_date': 'Ablaufdatum',
'lot.amount': 'Bestandsmenge',
'lot.location': 'Lagerort',
'lot.location_full': 'Lagerort (Ganzer Pfad)',
} );

8
public/ckeditor/plugins/partdb_label/lang/en.js
View file

@ -22,6 +22,7 @@ CKEDITOR.plugins.setLang( 'partdb_label', 'en', {
label: 'Placeholders',
'section.global': 'Globals',
'section.part': 'Part',
'section.part_lot': 'Part lot',
'part.id': 'Database ID',
'part.name': 'Part name',
'part.category': 'Category',
@ -47,4 +48,11 @@ CKEDITOR.plugins.setLang( 'partdb_label', 'en', {
'global.time': 'Current time',
'global.install_name': 'Instance name',
'global.type': 'Target type',
'lot.id': 'Lot ID',
'lot.name': 'Lot name',
'lot.comment': 'Lot comment',
'lot.expiration_date': 'Expiration date',
'lot.amount': 'Lot amount',
'lot.location': 'Storage location',
'lot.location_full': 'Storage location (Full path)',
} );

18
public/ckeditor/plugins/partdb_label/plugin.js
View file

@ -24,9 +24,9 @@ const PLACEHOLDERS = {
['%%ID%%', 'part.id'],
['%%NAME%%', 'part.name'],
['%%CATEGORY%%', 'part.category'],
['%%CATEGORY_FULL', 'part.category_full'],
['%%MANUFACTURER', 'part.manufacturer'],
['%%MANUFACTURER_FULL', 'part.manufacturer_full'],
['%%CATEGORY_FULL%%', 'part.category_full'],
['%%MANUFACTURER%%', 'part.manufacturer'],
['%%MANUFACTURER_FULL%%', 'part.manufacturer_full'],
['%%FOOTPRINT%%', 'part.footprint'],
['%%FOOTPRINT_FULL%%', 'part.footprint'],
['%%MASS%%', 'part.mass'],
@ -41,6 +41,18 @@ const PLACEHOLDERS = {
['%%CREATION_DATE%%', 'part.creation_date'],
]
},
part_lot: {
label: 'section.part_lot',
entries: [
['%%LOT_ID%%', 'lot.id'],
['%%LOT_NAME%%', 'lot.name'],
['%%LOT_COMMENT%%', 'lot.comment'],
['%%EXPIRATION_DATE%%', 'lot.expiration_date'],
['%%AMOUNT%%', 'lot.amount'],
['%%LOCATION%%', 'lot.location'],
['%%LOCATION_FULL%%', 'lot.location_full'],
]
},
global: {
label: 'section.global',
entries: [

91
src/Services/LabelSystem/PlaceholderProviders/PartLotProvider.php Normal file
View file

@ -0,0 +1,91 @@
<?php
/**
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
* Copyright (C) 2019 - 2020 Jan Böhmer (https://github.com/jbtronics)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
namespace App\Services\LabelSystem\PlaceholderProviders;
use App\Entity\Parts\PartLot;
use App\Services\AmountFormatter;
use App\Services\LabelSystem\LabelTextReplacer;
use IntlDateFormatter;
use Locale;
class PartLotProvider implements PlaceholderProviderInterface
{
protected $labelTextReplacer;
protected $amountFormatter;
public function __construct(LabelTextReplacer $labelTextReplacer, AmountFormatter $amountFormatter)
{
$this->labelTextReplacer = $labelTextReplacer;
$this->amountFormatter = $amountFormatter;
}
public function replace(string $placeholder, object $label_target, array $options = []): ?string
{
if ($label_target instanceof PartLot) {
if ($placeholder === '%%LOT_ID%%') {
return $label_target->getID() ?? 'unknown';
}
if ($placeholder === '%%LOT_NAME%%') {
return $label_target->getName();
}
if ($placeholder === '%%LOT_COMMENT%%') {
return $label_target->getComment();
}
if ($placeholder === '%%EXPIRATION_DATE%%') {
if ($label_target->getExpirationDate() === null) {
return '';
}
$formatter = IntlDateFormatter::create(
Locale::getDefault(),
IntlDateFormatter::SHORT,
IntlDateFormatter::NONE
//$label_target->getExpirationDate()->getTimezone()
);
return $formatter->format($label_target->getExpirationDate());
}
if ($placeholder === '%%AMOUNT%%') {
if ($label_target->isInstockUnknown()) {
return '?';
}
return $this->amountFormatter->format($label_target->getAmount(), $label_target->getPart()->getPartUnit());
}
if ($placeholder === '%%LOCATION%%') {
return $label_target->getStorageLocation() ? $label_target->getStorageLocation()->getName() : '';
}
if ($placeholder === '%%LOCATION_FULL%%') {
return $label_target->getStorageLocation() ? $label_target->getStorageLocation()->getFullPath() : '';
}
return $this->labelTextReplacer->handlePlaceholder($placeholder, $label_target->getPart());
}
return null;
}
}

15
tests/Services/LabelSystem/LabelTextReplacerTest.php
View file

@ -21,6 +21,7 @@
namespace App\Tests\Services\LabelSystem;
use App\Entity\Parts\Part;
use App\Entity\Parts\PartLot;
use App\Services\AmountFormatter;
use App\Services\LabelSystem\LabelTextReplacer;
use PHPUnit\Framework\TestCase;
@ -94,4 +95,18 @@ class LabelTextReplacerTest extends WebTestCase
{
$this->assertSame($expected, $this->service->replace($input, $this->target));
}
/**
* Test if the part lot has the highest priority of all providers.
*/
public function testPartLotPriority(): void
{
$part_lot = new PartLot();
$part_lot->setDescription('Test');
$part = new Part();
$part->setName('Part');
$part_lot->setPart($part);
$this->assertSame('Part', $this->service->handlePlaceholder('%%NAME%%', $part_lot));
}
}

83
tests/Services/LabelSystem/PlaceholderProviders/PartLotProviderTest.php Normal file
View file

@ -0,0 +1,83 @@
<?php
/**
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
* Copyright (C) 2019 - 2020 Jan Böhmer (https://github.com/jbtronics)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
namespace App\Tests\Services\LabelSystem\PlaceholderProviders;
use App\Entity\Contracts\NamedElementInterface;
use App\Entity\Parts\Part;
use App\Entity\Parts\PartLot;
use App\Entity\Parts\Storelocation;
use App\Services\LabelSystem\PlaceholderProviders\NamedElementProvider;
use App\Services\LabelSystem\PlaceholderProviders\PartLotProvider;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
class PartLotProviderTest extends WebTestCase
{
/** @var PartLotProvider */
protected $service;
protected $target;
public function setUp(): void
{
self::bootKernel();
\Locale::setDefault('en');
$this->service = self::$container->get(PartLotProvider::class);
$this->target = new PartLot();
$this->target->setDescription('Lot description');
$this->target->setComment('Lot comment');
$this->target->setExpirationDate(new \DateTime('1999-04-13'));
$this->target->setInstockUnknown(true);
$location = new Storelocation();
$location->setName('Location');
$location->setParent((new Storelocation())->setName('Parent'));
$this->target->setStorageLocation($location);
$part = new Part();
$part->setName('Part');
$part->setDescription('Part description');
$this->target->setPart($part);
}
public function dataProvider(): array
{
return [
['unknown', '%%LOT_ID%%'],
['Lot description', '%%LOT_NAME%%'],
['Lot comment', '%%LOT_COMMENT%%'],
['4/13/99', '%%EXPIRATION_DATE%%'],
['?', '%%AMOUNT%%'],
['Location', '%%LOCATION%%'],
['Parent → Location', '%%LOCATION_FULL%%'],
//Test part inheritance
['Part', '%%NAME%%'],
['Part description', '%%DESCRIPTION%%'],
];
}
/**
* @dataProvider dataProvider
*/
public function testReplace(string $expected, string $placeholder): void
{
$this->assertSame($expected, $this->service->replace($placeholder, $this->target));
}
}