Merge branch 'beta'

Author: scholejo

CHANGELOG.md

@@ -1,21 +1,31 @@
 # Release Notes for Altify
 
-# [1.0.0-beta.3] (2024-04-25)
+# [1.0.0-beta.4] (2024-04-26)
+
+### Features
+
+* Added the possibility to register own generators and translators via events
 
 ### Changes
 
-* Refactored the connector settings for simplicity and future extensibility
+* Refactored Settings and Services a bit for easier integration of the registration events
 
-# [1.0.0-beta.2] (2024-04-24)
+# [1.0.0-beta.3] (2024-04-25)
 
 ### Changes
 
-* The plugin is called Altify from now on
+* Refactored the connector settings for simplicity and future extensibility
+
+# [1.0.0-beta.2] (2024-04-24)
 
 ### Features
 
 * Add translation services DeepL, Opus MT and Flan T5 small
 
+### Changes
+
+* The plugin is called Altify from now on
+
 # [1.0.0-beta.1] (2024-02-23)
 
 ### Features

README.md

@@ -35,7 +35,7 @@ cd /path/to/my-project.test
 composer require fork/craft-altify
 
 # tell Craft to install the plugin
-./craft plugin/install alt
+./craft plugin/install altify
 ```
 
 ## Usage
@@ -53,22 +53,18 @@ You can also set the model via ENV variable. This can be a class name, or one of
     <tr>
         <th>Model name</th>
         <th>Link</th>
-        <th>Config name</th>
     </tr>
     <tr>
         <td>BLIP (large)</td>
         <td><a>https://huggingface.co/Salesforce/blip-image-captioning-large</a></td>
-        <td>BLIP large model (Hugging Face)</td>
     </tr>
     <tr>
         <td>BLIP (base)</td>
         <td><a>https://huggingface.co/Salesforce/blip-image-captioning-base</a></td>
-        <td>BLIP base model (Hugging Face)</td>
     </tr>
     <tr>
         <td>...</td>
         <td>...</td>
-        <td>...</td>
     </tr>
 </table>
 
@@ -78,37 +74,59 @@ You can also set the model via ENV variable. This can be a class name, or one of
     <tr>
         <th>Model name</th>
         <th>Link</th>
-        <th>Config name</th>
     </tr>
     <tr>
-        <td>DeepL</td>
+        <td>DeepL API</td>
         <td><a>https://developers.deepl.com/docs</a></td>
-        <td>DeepL</td>
     </tr>
     <tr>
         <td>OPUS MT (EN → DE)</td>
         <td><a>https://huggingface.co/Helsinki-NLP/opus-mt-en-de</a></td>
-        <td>OPUS MT En -> De</td>
     </tr>
     <tr>
         <td>Google T5 small (EN → DE)</td>
         <td><a>https://huggingface.co/google-t5/t5-small</a></td>
-        <td>T5 small En -> De</td>
     </tr>
     <tr>
         <td>...</td>
         <td>...</td>
-        <td>...</td>
     </tr>
 </table>
 
-### Implementing own alt text generator services
+### Implementing own alt text generators and translators
 
 You can implement your own alt text generator service by implementing the interface
-`fork\alt\connectors\alttextgeneration\AltTextGeneratorInterface` and configuring this plugin to use it
-by setting your own generator's class name via ENV variable.
+`fork\alt\connectors\alttextgeneration\AltTextGeneratorInterface` and registering it via the `EVENT_REGISTER_GENERATORS`
+event like this:
+
+```
+use fork\altify\events\RegisterGeneratorsEvent;
+use fork\altify\services\Generator;
+
+Event::on(
+    Generator::class,
+    Generator::EVENT_REGISTER_GENERATORS,
+    function (RegisterGeneratorsEvent $event) {
+        $event->generators['myGenerator'] = MyGenerator::class;
+    }
+);
+```
+
+The same goes for translator services. Implement `fork\altify\connectors\translation\TranslatorInterface` and register
+your translator like this:
 
-In a future release it should be possible to register alt text generators with an event.
+```
+use fork\altify\events\RegisterTranslatorsEvent;
+use fork\altify\services\Translator;
+
+Event::on(
+    Translator::class,
+    Translator::EVENT_REGISTER_TRANSLATORS,
+    function (RegisterTranslatorsEvent $event) {
+        $event->translators['myTranslator'] = MyTranslator::class;
+    }
+);
+```
 
 ---
 
@@ -117,7 +135,7 @@ In a future release it should be possible to register alt text generators with a
 * Make translation services site based to respect languages
 * Implement more alt text generation services
 * Maybe implement a self-hosted alt text generation service
-* Maybe implement an alt text generation service running in browser with TensorFlow JS
+* Maybe implement an alt text generation service running in browser with TensorFlow JS or something similar
 * Implement an alt text generator registering event
 * Make public on GitHub, release on Packagist and the Craft Plugin Store
 

composer.json

@@ -26,7 +26,7 @@
     },
     "extra": {
         "handle": "altify",
-        "name": "altify",
+        "name": "Altify",
         "developer": "Fork",
         "documentationUrl": "https://github.com/fork/craft-altify"
     },

src/Plugin.php

@@ -16,8 +16,8 @@
 use fork\altify\elements\actions\TranslateAltText as TranslateAltTextAction;
 use fork\altify\jobs\GenerateAltText as GenerateAltTextJob;
 use fork\altify\models\Settings;
-use fork\altify\services\AltTextGeneration;
-use fork\altify\services\Translation;
+use fork\altify\services\Generator;
+use fork\altify\services\Translator;
 use Twig\Error\LoaderError;
 use Twig\Error\RuntimeError;
 use Twig\Error\SyntaxError;
@@ -32,9 +32,9 @@
  * @author Fork <obj@fork.de>
  * @copyright Fork
  * @license MIT
- * @property-read AltTextGeneration $altTextGeneration
+ * @property-read Generator $generator
  * @property-read Settings $settings
- * @property-read Translation $translation
+ * @property-read Translator $translator
  */
 class Plugin extends BasePlugin
 {
@@ -46,8 +46,8 @@ public static function config(): array
     {
         return [
             'components' => [
-                'altTextGeneration' => AltTextGeneration::class,
-                'translation' => Translation::class
+                'generator' => Generator::class,
+                'translator' => Translator::class
             ],
         ];
     }

src/connectors/translation/DeeplTranslator.php

@@ -39,5 +39,4 @@ public function translateAltTextForImage(Asset $image): ?string
 
         return $altText;
     }
-
 }

src/controllers/GenerateAltTextController.php

@@ -32,7 +32,7 @@ public function actionIndex(): Response
         $assetId = Craft::$app->request->getBodyParam('assetId');
 
         try {
-            Plugin::getInstance()->altTextGeneration->generateAltTextForImage($assetId);
+            Plugin::getInstance()->generator->generateAltTextForImage($assetId);
         } catch (Exception|Throwable $e) {
             Craft::$app->getSession()->setError($e->getMessage());
         }

src/controllers/TranslateAltTextController.php

@@ -32,7 +32,7 @@ public function actionIndex(): Response
         $assetId = Craft::$app->request->getBodyParam('assetId');
 
         try {
-            Plugin::getInstance()->translation->translateAltTextForImage($assetId);
+            Plugin::getInstance()->translator->translateAltTextForImage($assetId);
         } catch (Exception|Throwable $e) {
             Craft::$app->getSession()->setError($e->getMessage());
         }

src/elements/actions/GenerateAltText.php

@@ -58,7 +58,7 @@ public function performAction(Craft\elements\db\ElementQueryInterface $query): b
         $elements = $query->all();
         foreach ($elements as $element) {
             try {
-                Plugin::getInstance()->altTextGeneration->generateAltTextForImage($element->id);
+                Plugin::getInstance()->generator->generateAltTextForImage($element->id);
             } catch (Exception|Throwable $e) {
                 Craft::$app->getSession()->setError($e->getMessage());
             }

src/elements/actions/TranslateAltText.php

@@ -58,7 +58,7 @@ public function performAction(Craft\elements\db\ElementQueryInterface $query): b
         $elements = $query->all();
         foreach ($elements as $element) {
             try {
-                Plugin::getInstance()->translation->translateAltTextForImage($element->id);
+                Plugin::getInstance()->translator->translateAltTextForImage($element->id);
             } catch (Exception|Throwable $e) {
                 Craft::$app->getSession()->setError($e->getMessage());
             }

src/events/RegisterGeneratorsEvent.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace fork\altify\events;
+
+use yii\base\Event;
+
+class RegisterGeneratorsEvent extends Event
+{
+    public array $generators = [];
+}