Merge pull request #3 from librarianphp/updates

Updating dependencies and adding templates
librarianphp · May 1, 2023 · 6189514 · 6189514
2 parents 20c0fc8 + 232d2f1
commit 6189514
Show file tree

Hide file tree

Showing 15 changed files with 150 additions and 75 deletions.
diff --git a/composer.json b/composer.json
@@ -13,7 +13,8 @@
     "ext-curl": "*",
     "ext-json": "*",
     "minicli/curly": "^0.2.0",
-    "league/commonmark": "^2.0"
+    "league/commonmark": "^2.0",
+    "minicli/stencil": "^0.1.1"
   },
   "require-dev": {
     "pestphp/pest": "^2.5",

diff --git a/composer.lock b/composer.lock
diff --git a/src/Content.php b/src/Content.php
@@ -8,17 +8,17 @@
  */
 class Content
 {
-    /** @var string Raw content */
-    public $raw;
+    /** @var ?string Raw content */
+    public ?string $raw = "";
 
     /** @var array Front-matter key-pairs */
-    public $front_matter = [];
+    public array $front_matter = [];
 
     /** @var string Body of content in markdown */
-    public $body_markdown;
+    public string $body_markdown = "";
 
     /** @var string Body of content in html */
-    public $body_html;
+    public string $body_html = "";
 
     /**
      * Content constructor.
@@ -56,10 +56,10 @@ public function frontMatterHas(string $key): bool
 
     /**
      * @param string $key
-     * @param string $default_value
-     * @return string|null
+     * @param ?string $default_value
+     * @return ?string
      */
-    public function frontMatterGet(string $key, $default_value = null)
+    public function frontMatterGet(string $key, ?string $default_value = null): ?string
     {
         if ($this->frontMatterHas($key)) {
             return $this->front_matter[$key] ?: $default_value;
@@ -72,7 +72,7 @@ public function frontMatterGet(string $key, $default_value = null)
      * @param string $key
      * @param string $value
      */
-    public function frontMatterSet(string $key, string $value)
+    public function frontMatterSet(string $key, string $value): void
     {
         $this->front_matter[$key] = $value;
     }
@@ -81,7 +81,7 @@ public function frontMatterSet(string $key, string $value)
      * @param ContentParser $parser
      * @param bool $parse_markdown
      */
-    public function parse(ContentParser $parser, bool $parse_markdown = false)
+    public function parse(ContentParser $parser, bool $parse_markdown = false): void
     {
         $parser->parse($this, $parse_markdown);
     }
@@ -100,7 +100,7 @@ public function getFrontMatter(): string
         return $content;
     }
 
-    public function updateRaw()
+    public function updateRaw(): void
     {
         $raw = $this->getFrontMatter();
         $raw .= $this->body_markdown;

diff --git a/src/ContentParser.php b/src/ContentParser.php
@@ -23,19 +23,19 @@
 class ContentParser
 {
     /** @var string  */
-    protected $original_content;
+    protected string $original_content;
 
     /** @var array */
-    protected $front_matter;
+    protected array $front_matter;
 
     /** @var string */
-    protected $markdown;
+    protected string $markdown;
 
     /** @var array */
-    protected $custom_tag_parsers;
+    protected array $custom_tag_parsers;
 
     /** @var array */
-    protected $parser_params;
+    protected array $parser_params;
 
     /**
      * ContentParser constructor.
@@ -51,7 +51,7 @@ public function __construct(array $parser_params = [])
         $this->addCustomTagParser('github', new GithubCustomTagParser());
     }
 
-    public function addCustomTagParser($name, CustomTagParserInterface $tag_parser)
+    public function addCustomTagParser($name, CustomTagParserInterface $tag_parser): void
     {
         $this->custom_tag_parsers[$name] = $tag_parser;
     }
@@ -98,11 +98,7 @@ public function getFrontMatter(string $front_matter): array
         return $vars;
     }
 
-    /**
-     * @return string|string[]|null
-     * @throws \Exception
-     */
-    public function getHtmlBody($markdown)
+    public function getHtmlBody($markdown): string|null
     {
         $environment = new Environment();
         $environment->addExtension(new CommonMarkCoreExtension());
@@ -128,7 +124,7 @@ public function getHtmlBody($markdown)
      * @param string $text
      * @return string
      */
-    public function parseSpecial($text)
+    public function parseSpecial(string $text): string
     {
         return preg_replace_callback_array([
             '/^\{%\s(.*)\s(.*)\s%}/m' => function ($match) {

diff --git a/src/CustomTagParser/AudioTagParser.php b/src/CustomTagParser/AudioTagParser.php
@@ -2,15 +2,20 @@
 
 namespace Parsed\CustomTagParser;
 
+use Minicli\FileNotFoundException;
+use Minicli\Stencil;
 use Parsed\CustomTagParserInterface;
 
 class AudioTagParser implements CustomTagParserInterface
 {
-    public function parse($tag_value, array $params = [])
+    /**
+     * @throws FileNotFoundException
+     */
+    public function parse(string $tag_value, array $params = []): string
     {
-        return "<audio controls>" .
-            "<source src=\"$tag_value\" type=\"audio/mpeg\">" .
-            "Your browser does not support the audio element." .
-            "</audio>";
+        $tplDir = $params['stencilDir'] ?? __DIR__ . '/../../tpl';
+
+        $stencil = new Stencil($tplDir);
+        return $stencil->applyTemplate('audio', ['tag_value' => $tag_value]);
     }
 }
diff --git a/src/CustomTagParser/GithubCustomTagParser.php b/src/CustomTagParser/GithubCustomTagParser.php
@@ -8,12 +8,12 @@
 class GithubCustomTagParser implements CustomTagParserInterface
 {
     /**
-     * Returns referred github content as a markdown code block.
-     * @param $tag_value
+     * Returns referred GitHub content as a Markdown code block.
+     * @param string $tag_value
      * @param array $params
      * @return string
      */
-    public function parse($tag_value, array $params = [])
+    public function parse(string $tag_value, array $params = []): string
     {
         if ($this->validateUrl($tag_value)) {
             $client = new Client();
@@ -30,10 +30,10 @@ public function parse($tag_value, array $params = [])
 
     /**
      * Validates a Github URL
-     * @param $github_url
+     * @param string $github_url
      * @return bool
      */
-    public function validateUrl($github_url)
+    public function validateUrl(string $github_url): bool
     {
         preg_match('@^(?:https://)?([^/]+)@i', $github_url, $matches);
         return ($matches[1] == 'github.com');
@@ -43,10 +43,10 @@ public function validateUrl($github_url)
      * Transforms URL to obtain raw version of content
      *   ex. web: https://github.com/minicli/librarian/blob/master/config_sample.php
      *   ex. raw: https://raw.githubusercontent.com/minicli/librarian/master/config_sample.php
-     * @param $github_url
+     * @param string $github_url
      * @return string
      */
-    public function getRawUrl($github_url)
+    public function getRawUrl(string $github_url): string
     {
         $raw_url = str_replace('github.com', 'raw.githubusercontent.com', $github_url);
         return str_replace('/blob', '', $raw_url);

diff --git a/src/CustomTagParser/TwitterCustomTagParser.php b/src/CustomTagParser/TwitterCustomTagParser.php
@@ -8,30 +8,30 @@
 class TwitterCustomTagParser implements CustomTagParserInterface
 {
     /**
-     * @param $tag_value
+     * @param string $tag_value
      * @param array $params
      * @return string
      */
-    public function parse($tag_value, array $params = [])
+    public function parse(string $tag_value, array $params = []): string
     {
         return $this->fetchTwitterEmbed($tag_value);
     }
 
     /**
      * Returns embeddable tweet
-     * @param $tweet_id
+     * @param string $tweet_id
      * @return string
      */
-    public function fetchTwitterEmbed($tweet_id)
+    public function fetchTwitterEmbed(string $tweet_id): string
     {
         $client = new Client();
 
-        $response = $client->get('https://publish.twitter.com/oembed?url=https://twitter.com/erikaheidi/status/' . $tweet_id);
+        $response = $client->get('https://publish.twitter.com/oembed?url=https://twitter.com/twitterdev/status/' . $tweet_id);
         if ($response['code'] == 200) {
             $body = json_decode($response['body'], true);
             return $body['html'];
         }
 
-        return " [ <a href='https://twitter.com/erikaheidi/status/$tweet_id'>Original Tweet</a> ]";
+        return " [ <a href='https://twitter.com/twitterdev/status/$tweet_id'>Original Tweet</a> ]";
     }
 }
diff --git a/src/CustomTagParser/VideoTagParser.php b/src/CustomTagParser/VideoTagParser.php
@@ -2,15 +2,20 @@
 
 namespace Parsed\CustomTagParser;
 
+use Minicli\FileNotFoundException;
+use Minicli\Stencil;
 use Parsed\CustomTagParserInterface;
 
 class VideoTagParser implements CustomTagParserInterface
 {
-    public function parse($tag_value, array $params = [])
+    /**
+     * @throws FileNotFoundException
+     */
+    public function parse(string $tag_value, array $params = []): string
     {
-        return "<video controls>" .
-         "<source src=\"$tag_value\" type=\"video/mp4\">" .
-         "Your browser does not support the video tag." .
-         "</video>";
+        $tplDir = $params['stencilDir'] ?? __DIR__ . '/../../tpl';
+
+        $stencil = new Stencil($tplDir);
+        return $stencil->applyTemplate('video', ['tag_value' => $tag_value]);
     }
 }