Merge branch 'release/4.0.0'

rhukster · rhukster · commit 53a65305af28 · 2019-03-20T12:20:37.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+# v4.0.0
+## 03/20/2019
+
+1. [](#improved)
+    * Improved way to handle shortcodeAssets from `Page::contentMeta()` - Fixes numerous issues 
+    * Allow `size` shortcode to handle non-numeric values (e.g. `%`, `x-large`, etc.) [#63](https://github.com/getgrav/grav-plugin-shortcode-core/pull/63)
+    * Added FontAwesome 5 support [#56](https://github.com/getgrav/grav-plugin-shortcode-core/pull/56)
+    
 # v3.1.2
 ## 03/15/2019
 
diff --git a/blueprints.yaml b/blueprints.yaml
@@ -1,5 +1,5 @@
 name: Shortcode Core
-version: 3.1.2
+version: 4.0.0
 description: "This plugin provides the core functionality for shortcode plugins"
 icon: code
 author:
@@ -13,7 +13,7 @@ bugs: https://github.com/getgrav/grav-plugin-shortcode-core/issues
 license: MIT
 
 dependencies:
-    - { name: grav, version: '~1.5' }
+    - { name: grav, version: '>=1.5.9' }
 
 form:
   validation: strict
@@ -99,3 +99,15 @@ form:
       label: Fontawesome URL
       help: You can change the location of fontawesome by changing this URL
       size: large
+
+    fontawesome.v5:
+      type: toggle
+      label: Use Fontawesome Version 5
+      help: Allows usage of the 'fab', 'fas' and other new font families of Fontawesome 5.
+      highlight: 0
+      default: 0
+      options:
+        1: Enabled
+        0: Disabled
+      validate:
+        type: bool
diff --git a/shortcode-core.php b/shortcode-core.php
@@ -1,6 +1,7 @@
 <?php
 namespace Grav\Plugin;
 
+use Grav\Common\Assets;
 use Grav\Common\Page\Page;
 use Grav\Common\Plugin;
 use Grav\Common\Utils;
@@ -45,7 +46,7 @@ public function onPluginsInitialized()
             'onMarkdownInitialized'     => ['onMarkdownInitialized', 0],
             'onShortcodeHandlers'       => ['onShortcodeHandlers', 0],
             'onPageContentProcessed'    => ['onPageContentProcessed', 0],
-            'onPageInitialized'         => ['onPageInitialized', 0],
+            'onPageContent'             => ['onPageContent', 0],
             'onTwigInitialized'         => ['onTwigInitialized', 0],
             'onTwigPageVariables'       => ['onTwigPageVariables', 0],
             'onTwigSiteVariables'       => ['onTwigSiteVariables', 0],
@@ -127,54 +128,35 @@ public function onPageContentProcessed(Event $e)
     /**
      * Handle the assets that might be associated with this page
      */
-    public function onPageInitialized(Event $event)
+    public function onPageContent(Event $event)
     {
         if (!$this->active) {
             return;
         }
 
         $page = $event['page'];
-        $assets = $this->grav['assets'];
-        $meta = [];
-
-        // Initialize all page content up front before Twig happens
-        if (isset($page->header()->content['items'])) {
-            foreach ($page->collection() as $item) {
-                // initialize modular item content
-                $item->content();
-
-                $item_meta = $item->getContentMeta('shortcodeMeta');
-                if ($item_meta) {
-                    $meta = array_merge_recursive($meta, $item_meta);
-                }
-            }
-        }
-
-        // Always initialize current page
-        $page->content();
 
         // get the meta and check for assets
         $page_meta = $page->getContentMeta('shortcodeMeta');
-        if ($page_meta) {
-            $meta = array_merge_recursive($meta, $page_meta);
-        }
 
-        // if assets found, add them to Assets manager
-        if (isset($meta['shortcodeAssets'])) {
-            $page_assets = (array) $meta['shortcodeAssets'];
-            if (!empty($page_assets)) {
-                // if we actually have data now, add it to asset manager
-                foreach ($page_assets as $type => $asset) {
-                    foreach ($asset as $item) {
-                        $method = 'add'.ucfirst($type);
-                        if (is_array($item)) {
-                            $assets->add($item[0], $item[1]);
-                        } else {
-                            $assets->$method($item);
-                        }
+        if (is_array($page_meta) && isset($page_meta['shortcodeAssets'])) {
+
+            $page_assets = (array) $page_meta['shortcodeAssets'];
+
+            /** @var Assets $assets */
+            $assets = $this->grav['assets'];
+            // if we actually have data now, add it to asset manager
+            foreach ($page_assets as $type => $asset) {
+                foreach ($asset as $item) {
+                    $method = 'add'.ucfirst($type);
+                    if (is_array($item)) {
+                        $assets->$method($item[0], $item[1]);
+                    } else {
+                        $assets->$method($item);
                     }
                 }
             }
+
         }
     }
 
diff --git a/shortcode-core.yaml b/shortcode-core.yaml
@@ -7,4 +7,5 @@ custom_shortcodes:
 fontawesome:
   load: true
   url: '//maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css'
+  v5: false
 
diff --git a/shortcodes/ColorShortcode.php b/shortcodes/ColorShortcode.php
@@ -8,7 +8,7 @@ class ColorShortcode extends Shortcode
     public function init()
     {
         $this->shortcode->getHandlers()->add('color', function(ShortcodeInterface $sc) {
-            $color = $sc->getParameter('color', $sc->getBbCode());
+            $color = $sc->getParameter('color', $this->getBbCode($sc));
             return '<span style="color: '.$color.';">'.$sc->getContent().'</span>';
         });
     }
diff --git a/shortcodes/FontAwesomeShortcode.php b/shortcodes/FontAwesomeShortcode.php
@@ -13,31 +13,42 @@ public function init()
             if ($this->config->get('plugins.shortcode-core.fontawesome.load', false)) {
                 $this->shortcode->addAssets('css', $this->config->get('plugins.shortcode-core.fontawesome.url'));
             }
+            if ($this->config->get('plugins.shortcode-core.fontawesome.v5', false)) {
+                $v5classes = array('fab', 'fal', 'fas', 'far');
+            } else {
+                $v5classes = array();
+            }
 
             // Get shortcode content and parameters
             $str = $sc->getContent();
-            $icon = $sc->getParameter('icon', $sc->getParameter('fa', $sc->getBbCode()));
+            $icon = $sc->getParameter('icon', $sc->getParameter('fa', $this->getBbCode($sc)));
 
             if (!Utils::startsWith($icon, 'fa-')) {
                 $icon = 'fa-'.$icon;
             }
 
-            if ($icon) {
-                $extras = explode(',',$sc->getParameter('extras', ''));
-                foreach ($extras as $extra) {
-                    if (!empty($extra)) {
-                        if (!Utils::startsWith($extra, 'fa-')) {
-                            $extra = 'fa-'.$extra;
+            if($icon) {
+                $fa_class = 'fa';
+                $extras = explode(',', $sc->getParameter('extras', ''));
+
+                foreach($extras as $extra) {
+                    if(!empty($extra)) {
+                        if(in_array($extra, $v5classes)) {
+                            $fa_class = $extra;
+                            continue;
+                        }
+                        if(!Utils::startsWith($extra, 'fa-')) {
+                            $extra = 'fa-' . $extra;
                         }
-                        $icon .= ' '.$extra;
+                        $icon .= ' ' . $extra;
                     }
                 }
 
-                $output = '<i class="fa '.$icon.'">'.$str.'</i>';
+                $output = '<i class="' . $fa_class . ' ' . $icon . '">' . $str . '</i>';
 
                 return $output;
             }
 
         });
     }
-}
+}
diff --git a/shortcodes/NoticeShortcode.php b/shortcodes/NoticeShortcode.php
@@ -9,7 +9,7 @@ public function init()
     {
         $this->shortcode->getHandlers()->add('notice', function(ShortcodeInterface $sc) {
             $this->shortcode->addAssets('css', 'plugin://shortcode-core/css/shortcode-notice.css');
-            $type = $sc->getParameter('notice', $sc->getBbCode()) ?: 'info';
+            $type = $sc->getParameter('notice', $this->getBbCode($sc)) ?: 'info';
             return '<div class="sc-notice '.$type.'"><div>'.$sc->getContent().'</div></div>';
         });
     }
diff --git a/shortcodes/SizeShortcode.php b/shortcodes/SizeShortcode.php
@@ -8,8 +8,9 @@ class SizeShortcode extends Shortcode
     public function init()
     {
         $this->shortcode->getHandlers()->add('size', function(ShortcodeInterface $sc) {
-            $size = $sc->getParameter('size', $sc->getBbCode());
-            return '<span style="font-size: '.$size.'px;">'.$sc->getContent().'</span>';
+            $size = $sc->getParameter('size', $this->getBbCode($sc));
+            if ( is_numeric($size) ) { $size = $size.'px' ; }
+            return '<span style="font-size: '.$size.';">'.$sc->getContent().'</span>';
         });
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ class ColorShortcode extends Shortcode`
`8`	`8`	`public function init()`
`9`	`9`	`{`
`10`	`10`	`$this->shortcode->getHandlers()->add('color', function(ShortcodeInterface $sc) {`
`11`		`- $color = $sc->getParameter('color', $sc->getBbCode());`
	`11`	`+ $color = $sc->getParameter('color', $this->getBbCode($sc));`
`12`	`12`	`return '<span style="color: '.$color.';">'.$sc->getContent().'</span>';`
`13`	`13`	`});`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ public function init()`
`9`	`9`	`{`
`10`	`10`	`$this->shortcode->getHandlers()->add('notice', function(ShortcodeInterface $sc) {`
`11`	`11`	`$this->shortcode->addAssets('css', 'plugin://shortcode-core/css/shortcode-notice.css');`
`12`		`- $type = $sc->getParameter('notice', $sc->getBbCode()) ?: 'info';`
	`12`	`+ $type = $sc->getParameter('notice', $this->getBbCode($sc)) ?: 'info';`
`13`	`13`	`return '<div class="sc-notice '.$type.'"><div>'.$sc->getContent().'</div></div>';`
`14`	`14`	`});`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,9 @@ class SizeShortcode extends Shortcode`
`8`	`8`	`public function init()`
`9`	`9`	`{`
`10`	`10`	`$this->shortcode->getHandlers()->add('size', function(ShortcodeInterface $sc) {`
`11`		`- $size = $sc->getParameter('size', $sc->getBbCode());`
`12`		`- return '<span style="font-size: '.$size.'px;">'.$sc->getContent().'</span>';`
	`11`	`+ $size = $sc->getParameter('size', $this->getBbCode($sc));`
	`12`	`+ if ( is_numeric($size) ) { $size = $size.'px' ; }`
	`13`	`+ return '<span style="font-size: '.$size.';">'.$sc->getContent().'</span>';`
`13`	`14`	`});`
`14`	`15`	`}`
`15`		`-}`
	`16`	`+}`