README fixes and refactors

JaroslawZielinski · Oct 29, 2024 · 6eb29c5 · 6eb29c5
1 parent e622497
commit 6eb29c5
Show file tree

Hide file tree

Showing 24 changed files with 300 additions and 228 deletions.
diff --git a/Console/Command/CacheFlush.php b/Console/Command/CacheFlush.php
@@ -16,6 +16,8 @@ class CacheFlush extends Command
 {
     public const TRANSLATION = 'translation';
 
+    public const LIST = 'list';
+
     /**
      * @var array
      */
@@ -51,7 +53,8 @@ protected function configure()
     {
         $this->setName('torah:cache:flush');
         $this->setDescription('JaroslawZielinski Torah cache flush');
-        $this->addArgument(self::TRANSLATION, InputArgument::REQUIRED, (string)__('translation'));
+        $this->addOption(self::LIST,'l', $mode = null, (string)__('see translation codes avaiable.'));
+        $this->addArgument(self::TRANSLATION, InputArgument::OPTIONAL, (string)__('translation code'));
     }
 
     private function displayMessages(OutputInterface $output): int
@@ -67,38 +70,35 @@ private function addMessage(string $message, ...$args): void
         $this->messages[] = sprintf($message, ...$args);
     }
 
+    private function listTranslations(OutputInterface $output): void
+    {
+        foreach (Resources::TORAH_TRANSLATIONS as $code => $label) {
+            $output->writeln(
+                (string)__('%1 <fg=yellow;options=bold>%2</>', $code, str_replace(['&apos;'], ['\''], $label))
+            );
+        }
+    }
+
     /**
      * {@inheritDoc}
      * @throws \Exception
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        try {
-            $translation = $input->getArgument(self::TRANSLATION);
+        $translation = $input->getArgument(self::TRANSLATION) ?? null;
+        $list = $input->getOption(self::LIST);
+        if ($list) {
+            $this->listTranslations($output);
+        } else if ($translation && !$list) {
             $availableTranslations = array_keys(Resources::TORAH_TRANSLATIONS);
             if (!in_array($translation, $availableTranslations)) {
-                $availableTranslationsStr = print_r($availableTranslations, true);
-                $message = str_replace(['Array
-(
-', '
-)
-'], ['', ''], $availableTranslationsStr);
-            throw new \Exception(sprintf((string)__('Use the following available translations:
-%s'), $message));
+                throw new \Exception((string)__('Unkown translation: %1', $translation));
             }
             $result = $this->repository->delete($translation);
             $resultMsg = sprintf((string)__('For \'%s\' cache flushed with result \'%s\''), $translation, $result);
             $output->writeln($resultMsg);
-        } catch (\Exception $e) {
-                       $message = sprintf(
-                '<fg=red;options=bold>Something went wrong</>: <fg=white>\'%s\'</>: <fg=yellow>
-%s</>.',
-                $e->getMessage(),
-                $e->getTraceAsString()
-            );
-            $this->logger->error($e->getMessage(), $e->getTrace());
-            $output->writeln($message);
-            return 1;
+        } else {
+            throw new \Exception(sprintf((string)__('Translation parameter empty.')));
         }
         return $this->displayMessages($output);
     }

diff --git a/Console/Command/CacheWarm.php b/Console/Command/CacheWarm.php
@@ -20,6 +20,8 @@ class CacheWarm extends Command
 {
     public const TRANSLATION = 'translation';
 
+    public const LIST = 'list';
+
     /**
      * @var array
      */
@@ -67,7 +69,8 @@ protected function configure()
     {
         $this->setName('torah:cache:warm');
         $this->setDescription('JaroslawZielinski Torah cache warm');
-        $this->addArgument(self::TRANSLATION, InputArgument::REQUIRED, (string)__('Translation'));
+        $this->addOption(self::LIST,'l', $mode = null, (string)__('see translation codes avaiable.'));
+        $this->addArgument(self::TRANSLATION, InputArgument::OPTIONAL, (string)__('translation code'));
     }
 
     private function displayMessages(OutputInterface $output): int
@@ -83,42 +86,38 @@ private function addMessage(string $message, ...$args): void
         $this->messages[] = sprintf($message, ...$args);
     }
 
+    private function listTranslations(OutputInterface $output): void
+    {
+        foreach (Resources::TORAH_TRANSLATIONS as $code => $label) {
+            $output->writeln(
+                (string)__('%1 <fg=yellow;options=bold>%2</>', $code, str_replace(['&apos;'], ['\''], $label))
+            );
+        }
+    }
+
     /**
      * {@inheritDoc}
      * @throws \Exception
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $this->output = $output;
-        try {
-            $translation = $input->getArgument(self::TRANSLATION);
+        $translation = $input->getArgument(self::TRANSLATION) ?? null;
+        $list = $input->getOption(self::LIST);
+        if ($list) {
+            $this->listTranslations($output);
+        } else if ($translation && !$list) {
             $availableTranslations = array_keys(Resources::TORAH_TRANSLATIONS);
             if (!in_array($translation, $availableTranslations)) {
-                $availableTranslationsStr = print_r($availableTranslations, true);
-                $message = str_replace(['Array
-(
-', '
-)
-'], ['', ''], $availableTranslationsStr);
-            throw new \Exception(sprintf((string)__('Use one of the following available translations:
-%s'), $message));
+                throw new \Exception((string)__('Unkown translation: %1', $translation));
             }
             $this->warmCache->execute(
                 $translation,
                 [$this, 'start'],
                 [$this, 'iteration'],
                 [$this, 'end']
             );
-        } catch (\Exception $e) {
-            $message = sprintf(
-                '<fg=red;options=bold>Something went wrong</>: <fg=white>\'%s\'</>: <fg=yellow>
-%s</>.',
-                $e->getMessage(),
-                $e->getTraceAsString()
-            );
-            $this->logger->error($e->getMessage(), $e->getTrace());
-            $output->writeln($message);
-            return 1;
+        } else {
+            throw new \Exception(sprintf((string)__('Translation parameter empty.')));
         }
         return $this->displayMessages($output);
     }

diff --git a/Model/Config.php b/Model/Config.php
@@ -515,7 +515,8 @@ public function getTorahInputDivision(): string
 
     public function isTorahInputBibleToolsEnabled(): bool
     {
-        return $this->scopeConfig
+        $cacheEnable = $this->isTorahCacheEnabled();
+        return $cacheEnable && $this->scopeConfig
             ->isSetFlag(self::CONFIG_PATH_TORAHINPUT_BIBLETOOLSENABLED, ScopeInterface::SCOPE_STORE);
     }
 

diff --git a/Model/ResourceModel/Quote/Collection.php b/Model/ResourceModel/Quote/Collection.php
@@ -37,10 +37,16 @@ protected function _initSelect()
             ->joinLeft(
                 ['groups' => $this->getTable('torahverse_groups')],
                 'main_table.group_id = groups.group_id',
-                ['groupName' => 'groups.name', 'colour_value', 'groupCode' => 'groups.code']
+                [
+                    'groupName' => 'groups.name',
+                    'colour_value',
+                    'groupCode' => 'groups.code',
+                    'code' => 'main_table.code'
+                ]
             );
         $this->addFilterToMap('groupName', 'groups.name');
         $this->addFilterToMap('groupCode', 'groups.code');
         $this->addFilterToMap('name', 'main_table.name');
+        $this->addFilterToMap('code', 'main_table.code');
     }
 }
diff --git a/Model/ResourceModel/Verse/Collection.php b/Model/ResourceModel/Verse/Collection.php
@@ -37,10 +37,16 @@ protected function _initSelect()
             ->joinLeft(
                 ['groups' => $this->getTable('torahverse_groups')],
                 'main_table.group_id = groups.group_id',
-                ['groupName' => 'groups.name', 'colour_value', 'groupCode' => 'groups.code']
+                [
+                    'groupName' => 'groups.name',
+                    'colour_value',
+                    'groupCode' => 'groups.code',
+                    'code' => 'main_table.code'
+                ]
         );
         $this->addFilterToMap('groupName', 'groups.name');
         $this->addFilterToMap('groupCode', 'groups.code');
         $this->addFilterToMap('name', 'main_table.name');
+        $this->addFilterToMap('code', 'main_table.code');
     }
 }