Affiche les numéros légaux sur les fiches de sortie (ou pas) (#310)

Robert-2 · Dec 15, 2021 · d2d03c4 · d2d03c4
1 parent ea7fe25
commit d2d03c4
Show file tree

Hide file tree

Showing 13 changed files with 81 additions and 14 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,7 +14,7 @@ jobs:
             - uses: actions/setup-node@v2
               with: { node-version: '16' }
             - run: yarn install --non-interactive --pure-lockfile
-            - run: yarn lint:js --max-warnings 41 --color
+            - run: yarn lint:js --max-warnings 40 --color
 
     client-linting-scss:
         name     : "Client: Linting (SCSS)"

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ Ce projet adhère au principe du [Semantic Versioning](https://semver.org/spec/v
 - Il est maintenant possible de choisir ce qui est affiché ou non dans les événements sur le calendrier (#302).
 - Affiche le nom de l'utilisateur qui a créé l'événement dans la fenêtre d'événement.
 - Supprime automatiquement la sous-catégorie quand la catégorie change lors de la sauvegarde du matériel (#306).
+- Ajoute un paramètre permettant d'afficher ou non les numéros légaux sur les fiches de sortie (#310).
 - Permet la création des inventaires de retour dès le premier jour des événements, sans pouvoir les terminer avant leur dernier jour (#307).
 
 ## 0.16.2 (2021-11-04)

diff --git a/client/src/locale/en/pages.js b/client/src/locale/en/pages.js
@@ -377,6 +377,8 @@ export default {
         'event-summary': {
             'title': "Event summaries",
             'help': "Here you can customize the PDF event summaries",
+            'header': "Top of page",
+            'display-legal-numbers': "Display legal numbers?",
             'material-list': "Materials list",
             'display-mode': "Display mode",
             'list-display-mode-categories': "Sorted by categories",

diff --git a/client/src/locale/fr/pages.js b/client/src/locale/fr/pages.js
@@ -377,6 +377,8 @@ export default {
         'event-summary': {
             'title': "Fiches de sortie",
             'help': "Ici, vous pouvez personnaliser les fiches de sortie des événements.",
+            'header': "Haut de page",
+            'display-legal-numbers': "Afficher les numéros légaux\u00a0?",
             'material-list': "Liste du matériel",
             'display-mode': "Mode de présentation",
             'list-display-mode-categories': "Triée par catégories",

diff --git a/client/src/pages/Settings/EventSummary/Form/index.js b/client/src/pages/Settings/EventSummary/Form/index.js
@@ -1,4 +1,5 @@
 import './index.scss';
+import getFormDataAsJson from '@/utils/getFormDataAsJson';
 import FormField from '@/components/FormField';
 
 const LIST_MODES = ['categories', 'sub-categories', 'parks', 'flat'];
@@ -8,7 +9,7 @@ export default {
     name: 'EventSummarySettingsForm',
     props: {
         isSaving: Boolean,
-        errors: Object,
+        errors: { type: Object, default: null },
     },
     data() {
         const initialListModeOptions = LIST_MODES.map((mode) => (
@@ -39,9 +40,7 @@ export default {
     methods: {
         handleSubmit(e) {
             e.preventDefault();
-            const formData = new FormData(e.currentTarget);
-            const data = Object.fromEntries(formData);
-            this.$emit('save', data);
+            this.$emit('save', getFormDataAsJson(e.target));
         },
     },
     render() {
@@ -57,6 +56,21 @@ export default {
 
         return (
             <form class="EventSummarySettingsForm" onSubmit={handleSubmit}>
+                <section class="EventSummarySettingsForm__section">
+                    <h3>{__('page-settings.event-summary.header')}</h3>
+                    <FormField
+                        type="switch"
+                        label="page-settings.event-summary.display-legal-numbers"
+                        v-model={values.withLegalNumbers}
+                        errors={errors && errors['eventSummary.withLegalNumbers']}
+                    />
+                    <input
+                        type="hidden"
+                        name="eventSummary.withLegalNumbers"
+                        value={values.withLegalNumbers ? '1' : '0'}
+                        readonly
+                    />
+                </section>
                 <section class="EventSummarySettingsForm__section">
                     <h3>{__('page-settings.event-summary.material-list')}</h3>
                     <FormField
@@ -65,7 +79,7 @@ export default {
                         name="eventSummary.materialDisplayMode"
                         options={listModeOptions}
                         value={values.materialDisplayMode || defaultListMode}
-                        errors={errors?.eventSummary.materialDisplayMode}
+                        errors={errors && errors['eventSummary.materialDisplayMode']}
                     />
                 </section>
                 <section class="EventSummarySettingsForm__section">
@@ -75,14 +89,14 @@ export default {
                         label="page-settings.event-summary.custom-text-title"
                         name="eventSummary.customText.title"
                         value={values.customText.title || ''}
-                        errors={errors?.eventSummary.customText.title}
+                        errors={errors && errors['eventSummary.customText.title']}
                     />
                     <FormField
                         type="textarea"
                         label="page-settings.event-summary.custom-text-content"
                         name="eventSummary.customText.content"
                         value={values.customText.content || ''}
-                        errors={errors?.eventSummary.customText.content}
+                        errors={errors && errors['eventSummary.customText.content']}
                     />
                 </section>
                 <section class="EventSummarySettingsForm__actions">

diff --git a/client/src/stores/settings.js b/client/src/stores/settings.js
@@ -7,6 +7,7 @@ const getDefaults = () => ({
             'content': null,
         },
         'materialDisplayMode': 'sub-categories',
+        'withLegalNumbers': true,
     },
     'calendar': {
         'event': {

diff --git a/server/src/App/Models/Event.php b/server/src/App/Models/Event.php
@@ -363,6 +363,7 @@ public function getPdfContent(int $id): string
             'replacementAmount' => $EventData->getReplacementAmount(),
             'technicians' => $EventData->getTechnicians(),
             'customText' => Setting::getWithKey('eventSummary.customText'),
+            'withLegalNumbers' => Setting::getWithKey('eventSummary.withLegalNumbers'),
         ];
 
         $eventPdf = $this->_getPdfAsString($data);

diff --git a/server/src/App/Models/Setting.php b/server/src/App/Models/Setting.php
@@ -52,6 +52,11 @@ protected static function manifest()
                 'validation' => null,
                 'default' => null,
             ],
+            'eventSummary.withLegalNumbers' => [
+                'type' => 'boolean',
+                'validation' => V::boolVal(),
+                'default' => true,
+            ],
 
             //
             // - Calendrier

diff --git a/server/src/migrations/20211214140547_add_new_setting.php b/server/src/migrations/20211214140547_add_new_setting.php
@@ -0,0 +1,27 @@
+<?php
+declare(strict_types=1);
+
+use Phinx\Migration\AbstractMigration;
+use Robert2\API\Config\Config;
+
+final class AddNewSetting extends AbstractMigration
+{
+    public function up(): void
+    {
+        $data = [
+            'key' => 'eventSummary.withLegalNumbers',
+            'value' => '1',
+        ];
+        $this->table('settings')->insert($data)->saveData();
+    }
+
+    public function down(): void
+    {
+        $prefix = Config::getSettings('db')['prefix'];
+        $builder = $this->getQueryBuilder();
+        $builder
+            ->delete(sprintf('%ssettings', $prefix))
+            ->where(['key' => 'eventSummary.withLegalNumbers'])
+            ->execute();
+    }
+}
diff --git a/server/src/views/pdf/event-summary-default.twig b/server/src/views/pdf/event-summary-default.twig
@@ -8,7 +8,7 @@
         <td class="half">
             {{ include('blocks/company-address.twig', {
                 company: company,
-                withLegalNumbers: false,
+                withLegalNumbers: withLegalNumbers,
                 withLogo: true,
             }) }}
         </td>

diff --git a/server/tests/Fixtures/seed/settings.json b/server/tests/Fixtures/seed/settings.json
@@ -12,12 +12,14 @@
         "value": "Un petit contrat de test."
     },
     {
-
+        "key": "eventSummary.withLegalNumbers",
+        "value": "1"
+    },
+    {
         "key": "calendar.event.showLocation",
         "value": "1"
     },
     {
-
         "key": "calendar.event.showBorrower",
         "value": "0"
     }

diff --git a/server/tests/endpoints/SettingsTest.php b/server/tests/endpoints/SettingsTest.php
@@ -14,6 +14,7 @@ public function testGetAll()
                     'content' => "Un petit contrat de test.",
                 ],
                 'materialDisplayMode' => 'sub-categories',
+                'withLegalNumbers' => true,
             ],
             'calendar' => [
                 'event' => [
@@ -70,6 +71,7 @@ public function testUpdate(): void
             'eventSummary.materialDisplayMode' => 'flat',
             'eventSummary.customText.title' => null,
             'eventSummary.customText.content' => null,
+            'eventSummary.withLegalNumbers' => false,
         ]);
         $this->assertStatusCode(SUCCESS_OK);
         $this->assertResponseData([
@@ -79,6 +81,7 @@ public function testUpdate(): void
                     'content' => null,
                 ],
                 'materialDisplayMode' => 'flat',
+                'withLegalNumbers' => false,
             ],
             'calendar' => [
                 'event' => [

diff --git a/server/tests/models/SettingTest.php b/server/tests/models/SettingTest.php
@@ -24,6 +24,7 @@ public function testGetList(): void
                     'content' => "Un petit contrat de test.",
                 ],
                 'materialDisplayMode' => 'sub-categories',
+                'withLegalNumbers' => true,
             ],
             'calendar' => [
                 'event' => [
@@ -51,6 +52,10 @@ public function testGetAll(): void
                 'key' => 'eventSummary.customText.content',
                 'value' => "Un petit contrat de test.",
             ],
+            [
+                'key' => 'eventSummary.withLegalNumbers',
+                'value' => true,
+            ],
             [
                 'key' => 'calendar.event.showLocation',
                 'value' => true,
@@ -81,7 +86,8 @@ public function testGetWithKey(): void
                 'title' => 'Contrat',
                 'content' => 'Un petit contrat de test.',
             ],
-            'materialDisplayMode' => 'sub-categories'
+            'materialDisplayMode' => 'sub-categories',
+            'withLegalNumbers' => true,
         ];
         $this->assertEquals($expected, $result);
 
@@ -106,10 +112,12 @@ public function testUpdateBadValue(): void
     public function testUpdate(): void
     {
         Setting::staticEdit(null, [
-            'calendar.event.showLocation' => false,
             'eventSummary.materialDisplayMode' => 'flat',
             'eventSummary.customText.title' => 'test',
             'eventSummary.customText.content' => null,
+            'eventSummary.withLegalNumbers' => false,
+            'calendar.event.showLocation' => false,
+            'calendar.event.showBorrower' => true,
         ]);
         $expected = [
             'eventSummary' => [
@@ -118,11 +126,12 @@ public function testUpdate(): void
                     'content' => null,
                 ],
                 'materialDisplayMode' => 'flat',
+                'withLegalNumbers' => false,
             ],
             'calendar' => [
                 'event' => [
-                    'showBorrower' => false,
                     'showLocation' => false,
+                    'showBorrower' => true,
                 ],
             ],
         ];