Release v2.0.0 compatible with Kirby 3

Author: pedroborges

.editorconfig

@@ -10,6 +10,3 @@ trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
-
-[*.yml]
-indent_size = 2

.gitignore

@@ -1,3 +1,26 @@
+# OS files
 .DS_Store
-*.cache
-vendor
+
+# npm modules
+/node_modules
+
+# files of Composer dependencies that are not needed for the plugin
+/vendor/**/.*
+/vendor/**/*.json
+/vendor/**/*.txt
+/vendor/**/*.md
+/vendor/**/*.yml
+/vendor/**/*.yaml
+/vendor/**/*.xml
+/vendor/**/*.dist
+/vendor/**/readme.php
+/vendor/**/LICENSE
+/vendor/**/COPYING
+/vendor/**/VERSION
+/vendor/**/docs/*
+/vendor/**/example/*
+/vendor/**/examples/*
+/vendor/**/test/*
+/vendor/**/tests/*
+/vendor/**/php4/*
+/vendor/getkirby/composer-installer

LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) Pedro Borges
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

changelog.md

@@ -1,6 +1,11 @@
-# Change Log
+# Changelog
 All notable changes to this project will be documented in this file.
 
+## [2.0.0] - 2019-02-21
+This version adds support to Kirby 3. All options remain and work in the same way as they did in Kirby 2.
+
+For Kirby 2, you can download the [plugin v1.1.1](https://github.com/pedroborges/kirby-meta-tags/archive/v1.1.1.zip) and install it manually in the `site/plugins/meta-tags`.
+
 ## [1.1.1] - 2018-07-08
 ### Fixed
 - When capitalizing the `@type` first letter, other capital letters in the word were being converted to lowercase. This has been fixed.

composer.json

@@ -1,24 +1,27 @@
 {
     "name": "pedroborges/kirby-meta-tags",
-    "description": "HTML meta tags generator for Kirby.",
-    "version": "2.0.0-alpha-1",
-    "keywords": ["kirby-plugin"],
+    "description": "HTML meta tags generator for Kirby 3.",
+    "keywords": ["kirby-plugin", "meta-tags", "open-graph", "twitter-cards", "json-ld"],
+    "license": "MIT",
+    "homepage": "https://github.com/pedroborges/kirby-meta-tags",
+    "type": "kirby-plugin",
     "authors": [
         {
             "name": "Pedro Borges",
             "email": "[email protected]"
         }
     ],
+    "require": {
+        "php": ">=7.1.0",
+        "getkirby/composer-installer": "^1.1",
+        "pedroborges/meta-tags": "^0.0.2"
+    },
     "autoload": {
         "files": [
-            "config.php"
+            "helpers.php"
         ],
         "psr-4": {
             "PedroBorges\\KirbyMetaTags\\": "src/"
         }
-    },
-    "require": {
-        "php": ">=7.1.0",
-        "pedroborges/meta-tags": "^0.0.2"
     }
 }

composer.lock

@@ -1,16 +1,7 @@
 <?php
 
-use Kirby\Cms\Page;
 use PedroBorges\KirbyMetaTags\MetaTags;
 
-Kirby::plugin('pedroborges/metatags', [
-    'pageMethods' => [
-        'metaTags' => function ($groups = null) {
-            return metaTags($this)->render($groups);
-        }
-    ]
-]);
-
 if (! function_exists('metaTags')) {
     /**
      * Generate meta tags for a given page.

config.php renamed to helpers.php

@@ -1,3 +1,11 @@
 <?php
 
-require_once __DIR__ . '/vendor/autoload.php';
+require_once __DIR__.'/vendor/autoload.php';
+
+Kirby::plugin('pedroborges/meta-tags', [
+    'pageMethods' => [
+        'metaTags' => function ($groups = null) {
+            return metaTags($this)->render($groups);
+        }
+    ]
+]);

index.php

@@ -9,7 +9,19 @@ HTML meta tags generator for Kirby. Supports [Open Graph](http://ogp.me), [Twitt
 ## Installation
 
 ### Download
-[Download the files](https://github.com/pedroborges/kirby-meta-tags/releases/download/v2.0.0-alpha-1/meta-tags.zip) and place them inside `site/plugins/meta-tags`.
+Download and copy this repository to `site/plugins/meta-tags`.
+
+### Git submodule
+```
+git submodule add https://github.com/pedroborges/kirby-meta-tags.git site/plugins/meta-tags
+```
+
+### Composer
+```
+composer require pedroborges/kirby-meta-tags
+```
+
+> For Kirby 2, you can download [v1.1.1](https://github.com/pedroborges/kirby-meta-tags/archive/v1.1.1.zip) and copy the files to `site/plugins/meta-tags`.
 
 ## Basic Usage
 After installing the Meta Tags plugin, you need to add one line to the `head` element on your template, or `header.php` snippet:
@@ -40,7 +52,7 @@ The plugin ships with some default meta tags enabled for your convenience:
 ```php
 return [
     // other options...
-    'pedroborges.metatags.default' => function ($page, $site) {
+    'pedroborges.meta-tags.default' => function ($page, $site) {
         return [
             'title' => $site->title(),
             'meta' => [
@@ -62,15 +74,15 @@ return [
 ]
 ```
 
-**The `pedroborges.metatags.default` option is applied to all pages on your Kirby site.** Of course you can change the defaults. In order to do that, just copy this example to your `site/config/config.php` file and tweak it to fit your website needs.
+**The `pedroborges.meta-tags.default` option is applied to all pages on your Kirby site.** Of course you can change the defaults. In order to do that, just copy this example to your `site/config/config.php` file and tweak it to fit your website needs.
 
 ### Templates
 Following the flexible spirit of Kirby, you also have the option to add template specific meta tags:
 
 ```php
 return [
     // other options...
-    'pedroborges.metatags.templates' => function ($page, $site) {
+    'pedroborges.meta-tags.templates' => function ($page, $site) {
         return [
             'song' => [
                 'og' => [
@@ -96,13 +108,13 @@ For more information on all the `meta`, `link`, Open Graph and Twitter Card tags
 - [Twitter Cards](https://dev.twitter.com/cards/overview)
 
 ## Options
-Both the `pedroborges.metatags.default` and `pedroborges.metatags.templates` accept similar values:
+Both the `pedroborges.meta-tags.default` and `pedroborges.meta-tags.templates` accept similar values:
 
-### `pedroborges.metatags.default`
+### `pedroborges.meta-tags.default`
 It accepts an array containing any or all of the following keys: `title`, `meta`, `link`, `og`, and `twitter`. With the exception of `title`, all other groups must return an array of key-value pairs. Check out the [tag groups](#tag-groups) section to learn which value types are accepted by each key.
 
 ```php
-'pedroborges.metatags.default' => function ($page, $site) {
+'pedroborges.meta-tags.default' => function ($page, $site) {
     return [
         'title' => 'Site Name',
         'meta' => [ /* meta tags */ ],
@@ -114,11 +126,11 @@ It accepts an array containing any or all of the following keys: `title`, `meta`
 }
 ```
 
-### `pedroborges.metatags.templates`
+### `pedroborges.meta-tags.templates`
 This option allows you to define a template specific set of meta tags. It must return an array where each key corresponds to the template name you are targeting.
 
 ```php
-'pedroborges.metatags.default' => function ($page, $site) {
+'pedroborges.meta-tags.default' => function ($page, $site) {
     return [
         'article' => [ /* tags groups */ ],
         'about' => [ /* tags groups */ ],
@@ -127,7 +139,7 @@ This option allows you to define a template specific set of meta tags. It must r
 }
 ```
 
-When a key matches the current page template name, it is merged and overrides any repeating properties defined on the `pedroborges.metatags.default` option so you don't have to repeat yourself.
+When a key matches the current page template name, it is merged and overrides any repeating properties defined on the `pedroborges.meta-tags.default` option so you don't have to repeat yourself.
 
 ## Tag Groups
 These groups accept string, closure, or array as their values. Being so flexible, the sky is the limit to what you can do with Meta Tags!
@@ -232,7 +244,7 @@ Where you can define [Open Graph](http://ogp.me) `<meta>` elements.
 Of course you can use Open Graph [structured objects](http://ogp.me/#structured). Let's see a blog post example:
 
 ```php
-'pedroborges.metatags.templates' => function ($page, $site) {
+'pedroborges.meta-tags.templates' => function ($page, $site) {
     return [
         'article' => [ // template name
             'og' => [  // tags group name
@@ -368,6 +380,6 @@ Use this tag group to add [JSON Linked Data](https://json-ld.org) schemas to you
 All notable changes to this project will be documented at: <https://github.com/pedroborges/kirby-meta-tags/blob/master/changelog.md>
 
 ## License
-Meta Tags plugin is open-sourced software licensed under the [MIT license](http://www.opensource.org/licenses/mit-license.php).
+The Meta Tags plugin is open-sourced software licensed under the [MIT license](http://www.opensource.org/licenses/mit-license.php).
 
-Copyright © 2018 Pedro Borges <[email protected]>
+Copyright © 2019 Pedro Borges <[email protected]>

readme.md

@@ -20,12 +20,12 @@ class MetaTags
 
     public function __construct(Page $page)
     {
-        $this->indentation = option('pedroborges.metatags.indentation', null);
-        $this->order = option('pedroborges.metatags.order', null);
+        $this->indentation = option('pedroborges.meta-tags.indentation', null);
+        $this->order = option('pedroborges.meta-tags.order', null);
         $this->tags = new Tags($this->indentation, $this->order);
 
-        $templates = option('pedroborges.metatags.templates', []);
-        $default = option('pedroborges.metatags.default', [
+        $templates = option('pedroborges.meta-tags.templates', []);
+        $default = option('pedroborges.meta-tags.default', [
             'title' => $page->isHomePage() ? site()->title() : $page->title(),
             'meta' => [
                 'description' => site()->description()
@@ -46,11 +46,11 @@ public function __construct(Page $page)
         $templates = is_callable($templates) ? $templates($page, site()) : $templates;
 
         if (! is_array($this->data)) {
-            throw new Exception('Option "pedroborges.metatags.default" must return an array');
+            throw new Exception('Option "pedroborges.meta-tags.default" must return an array');
         }
 
         if (! is_array($templates)) {
-            throw new Exception('Option "pedroborges.metatags.templates" must return an array');
+            throw new Exception('Option "pedroborges.meta-tags.templates" must return an array');
         }
 
         if (isset($templates[$page->template()->name()])) {