Added standalone app. Cleaned up.

Author: rimi-itk

CHANGELOG.md

@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 - [PR-3](https://github.com/itk-dev/tidy-feedback/pull/3)
-  Added translations
+  Added translations and standalone app
 - [PR-5](https://github.com/itk-dev/tidy-feedback/pull/5)
   Add styling. Make region and form draggable
 

README.md

@@ -24,7 +24,8 @@ drush tidy-feedback:doctrine:schema-update
 
 ### Symfony
 
-Create `config/routes/tidy_feedback.yaml`:
+Create `config/routes/tidy_feedback.yaml` (or copy
+[`resources/config/routes/tidy_feedback.yaml`](resources/config/routes/tidy_feedback.yaml)):
 
 ``` yaml
 #config/routes/tidy_feedback.yaml
@@ -34,7 +35,8 @@ tidy_feedback:
 ```
 
 > [!NOTE]
-> You can use any `prefix`, but for consistency with the Drupal version of Tidy feedback you should use `/tidy-feedback`.
+> You can use any path as `prefix`, but for consistency with the Drupal version of Tidy feedback you should use
+> `/tidy-feedback`.
 
 If [Symfony Flex](https://symfony.com/doc/current/setup/flex.html) hasn't already done so, you must enable the
 TidyFeedbackBundle bundle:
@@ -60,14 +62,14 @@ in the environment variable `TIDY_FEEDBACK_DATABASE_URL`, e.g.
 ``` dotenv
 # .env
 # See https://www.doctrine-project.org/projects/doctrine-dbal/en/4.2/reference/configuration.html#connecting-using-a-url for details.
-TIDY_FEEDBACK_DATABASE_URL="pdo-sqlite:////app/tidy-feedback.sqlite"
+TIDY_FEEDBACK_DATABASE_URL=pdo-sqlite://localhost//app/tidy-feedback.sqlite
 ```
 
 As an alternative for Drupal you can set `TIDY_FEEDBACK_DATABASE_URL` in `settings.local.php`:
 
 ``` php
 # web/sites/default/settings.local.php
-putenv('TIDY_FEEDBACK_DATABASE_URL=pdo-sqlite:////app/tidy-feedback.sqlite');
+putenv('TIDY_FEEDBACK_DATABASE_URL=pdo-sqlite://localhost//app/tidy-feedback.sqlite');
 ```
 
 `TIDY_FEEDBACK_USERS='{"admin": "password"}'`
@@ -118,3 +120,17 @@ In order to make this behave as both a Drupal module and a Synfony bundle, we us
 ### Twig
 
 We use a watered-down instance of Twig with only a `trans` filter and a `path` function.
+
+### Development app
+
+For development, you can start a Symfony app with Tidy feedback installed:
+
+``` shell
+task app:start
+```
+
+Run `task app:stop` to stop the app.
+
+> [!TIP]
+> Use `tidy-feedback-show=form` in the query string, e.g. `/tidy-feedback/test?tidy-feedback-show=form`, to
+> automatically show the feedback form when loading a page.

Taskfile.yml

@@ -5,6 +5,7 @@ dotenv: [".env.local", ".env"]
 
 vars:
     DOCKER_COMPOSE: '{{.TASK_DOCKER_COMPOSE | default "docker compose"}}'
+    APP_DOCKER_COMPOSE: docker compose --profile app
 
 tasks:
     compose:
@@ -157,3 +158,35 @@ tasks:
         cmds:
             - task --list-all
         silent: true
+
+    app:start:
+        desc: Start Symfony app with Tity feedback installed
+        cmds:
+            - |
+                echo ------------------------------------------------------------------------------------------------
+                echo For reasons yet unknown, you may have to run this command 2 or 3 times to make everything work …
+                echo ------------------------------------------------------------------------------------------------
+
+            - task app:compose -- pull
+            - task app:compose -- up --detach --remove-orphans --wait
+
+            - task app:compose -- exec symfony composer config repositories.tidy-feedback path /app
+            # https://github.com/itk-dev/tidy-feedback?tab=readme-ov-file#installation
+            - task app:compose -- exec symfony composer require itk-dev/tidy-feedback:dev-main
+
+            # https://github.com/itk-dev/tidy-feedback?tab=readme-ov-file#symfony
+            - task app:compose -- exec symfony cp /app/resources/config/routes/tidy_feedback.yaml config/routes/
+            - task app:compose -- exec symfony bin/console cache:clear
+
+            - task app:compose -- exec symfony bin/console tidy-feedback:doctrine:schema-update
+            - open "http://$(task app:compose -- port symfony 80)/tidy-feedback/test?tidy-feedback-show=form"
+        silent: true
+
+    app:stop:
+        desc: Stop Symfony app
+        cmds:
+            - task app:compose -- down --remove-orphans
+
+    app:compose:
+        cmds:
+            - "{{.APP_DOCKER_COMPOSE}} {{.CLI_ARGS}}"

compose.yaml

@@ -45,10 +45,23 @@ services:
     symfony:
         # https://hub.docker.com/r/shinsenter/symfony
         image: shinsenter/symfony:latest
-        # command: sh -c "
-        # composer require symfony/translation
-        # "
+        # For some reason it takes a while before composer.json appear in the project root
+        # @todo Investigate why
+        healthcheck:
+            test: ["CMD", "test", "-f", "composer.json"]
+            interval: 2s
+            timeout: 60s
+            retries: 20
         volumes:
             - ./:/app
         profiles:
             - dev
+            - app
+        ports:
+            - "80"
+        environment:
+            APP_ENV: dev
+            # Needed to run without requiring a cache
+            TIDY_FEEDBACK_DEV_MODE: true
+            TIDY_FEEDBACK_DEBUG: true
+            TIDY_FEEDBACK_DATABASE_URL: pdo-sqlite://localhost//app/app-tidy-feedback.sqlite

composer.json

@@ -7,6 +7,7 @@
         "doctrine/dbal": "^3 || ^4",
         "doctrine/orm": "^2.8 || ^3",
         "symfony/cache": "^6 || ^7",
+        "symfony/http-kernel": "^6 || ^7",
         "twig/twig": "^3"
     },
     "require-dev": {

resources/config/routes/tidy_feedback.yaml

@@ -0,0 +1,3 @@
+tidy_feedback:
+    resource: "@TidyFeedbackBundle/config/routes.php"
+    prefix: /tidy-feedback

src/TidyFeedbackHelper.php

@@ -91,7 +91,7 @@ private function trans(string $text, array $context = []): string
         }
 
         // @todo Get the locale from some context …
-        $locale = static::getConfig('default_locale');
+        $locale = self::getConfig('default_locale');
         $fallbackLocale = 'en';
 
         return self::$translations[$locale][$text] ?? self::$translations[$fallbackLocale][$text] ?? $text;
@@ -105,11 +105,13 @@ private function trans(string $text, array $context = []): string
     public static function getEntityManager(): EntityManagerInterface
     {
         if (empty(self::$entityManager)) {
-            $config = ORMSetup::createAttributeMetadataConfiguration(
+            $config = ORMSetup::createAttributeMetadataConfig(
                 paths: [__DIR__.'/Model'],
+                isDevMode: (bool) ($_ENV['TIDY_FEEDBACK_DEV_MODE'] ?? false),
             );
+            $config->enableNativeLazyObjects(true);
 
-            $dsn = static::getConfig('database_url');
+            $dsn = self::getConfig('database_url');
             $connectionParams = (new DsnParser())->parse($dsn);
             $connection = DriverManager::getConnection($connectionParams, $config);
 
@@ -127,13 +129,22 @@ public function createAssetResponse(string $asset): Response
             throw new NotFoundHttpException();
         }
 
-        return new BinaryFileResponse($filename, headers: [
+        $response = new BinaryFileResponse($filename, headers: [
             'content-type' => match (pathinfo($filename, PATHINFO_EXTENSION)) {
                 'css' => 'text/css',
                 'js' => 'text/javascript',
                 default => throw new NotFoundHttpException(),
             },
-        ]);
+        ],
+            autoEtag: true, autoLastModified: true
+        );
+
+        if (self::getConfig('debug')) {
+            // setExpires(null) does not seem to work as advertised, so we use a date in the far past.
+            $response->setExpires(new \DateTimeImmutable('2001-01-01'));
+        }
+
+        return $response;
     }
 
     public static function updateSchema(OutputInterface $output): bool
@@ -214,7 +225,7 @@ public function onKernelResponse(ResponseEvent $event): void
                 $response->setContent($content);
             }
         } catch (\Throwable $throwable) {
-            if (static::getConfig('debug')) {
+            if (self::getConfig('debug')) {
                 throw $throwable;
             }
             // Ignore all errors!