Genesis

Author: pedroborges

.gitignore

@@ -0,0 +1 @@
+.DS_Store

changelog.md

@@ -0,0 +1,5 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [1.0.0-alpha] - 2017-02-26
+### Initial release

composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "chriskonnertz/open-graph": "^1.0"
+    }
+}

composer.lock

@@ -0,0 +1,74 @@
+<?php
+
+/**
+ * Kirby Open Graph Plugin
+ *
+ * @version   1.0.0-alpha
+ * @author    Pedro Borges <[email protected]>
+ * @copyright Pedro Borges <[email protected]>
+ * @link      https://github.com/pedroborges/kirby-autogit
+ * @license   MIT
+ */
+
+// Load Composer dependencies
+require __DIR__ . DS . 'vendor' . DS . 'autoload.php';
+
+function openGraph($page)
+{
+    $og = new ChrisKonnertz\OpenGraph\OpenGraph(true);
+    $og->template("<meta property=\"{{name}}\" content=\"{{value}}\">\n");
+
+    if (c::get('open-graph.validate', true) && c::get('debug', false)) {
+        $og->validate();
+    }
+
+    $attributes = null;
+    $pageTemplate = $page->intendedTemplate();
+    $templates = c::get('open-graph.templates', []);
+    $properties = c::get('open-graph.default', [
+        'title' => $page->title(),
+        'url' => $page->url(),
+        'site_name' => site()->title(),
+        'type' => 'website'
+    ]);
+
+    if (isset($templates[$pageTemplate])) {
+        $properties = array_merge($properties, $templates[$pageTemplate]);
+    }
+
+    foreach($properties as $tag => $value) {
+        if (is_int($tag)) {
+            $tag = $value;
+            $value = null;
+        }
+
+        if ($tag === 'attributes' && is_callable($value)) {
+            $attributes = $value($page);
+        } elseif (is_callable($value)) {
+            $value = $value($page);
+        } elseif (is_null($value)) {
+            $value = $page->$tag();
+        } elseif ($value instanceof Field && $value->isEmpty()) {
+            $value = null;
+        }
+
+        if (! is_null($attributes) && isset($properties['type'])) {
+            $type = $properties['type'];
+            $og->attributes($type, $attributes);
+        } elseif ($tag === 'locale:alternate' && is_array($value)) {
+            foreach ($value as $locale) {
+                $og->tag($tag, $locale);
+            }
+        } elseif (! empty($value)) {
+            $og->tag($tag, $value);
+        }
+    }
+
+    if (count($og->tags()) > 0) {
+        return $og->renderTags();
+    }
+}
+
+kirby()->set('page::method', 'openGraph', function($page) {
+    return openGraph($page);
+});

open-graph.php

@@ -0,0 +1,8 @@
+{
+  "name": "open-graph",
+  "author": "Pedro Borges <[email protected]>",
+  "version": "1.0.0-alpha",
+  "description": "Kirby Open Graph",
+  "type": "kirby-plugin",
+  "license": "MIT"
+}

package.json

@@ -0,0 +1,96 @@
+# Kirby Open Graph (WIP) [![Release](https://img.shields.io/github/release/pedroborges/kirby-open-graph.svg)](https://github.com/pedroborges/kirby-open-graph/releases) [![Issues](https://img.shields.io/github/issues/pedroborges/kirby-open-graph.svg)](https://github.com/pedroborges/kirby-open-graph/issues)
+
+A Kirby CMS plugin that builds [Open Graph](http://ogp.me) meta tags for your site.
+
+## Requirements
+- Kirby 2.3.2+
+- PHP 5.4+
+
+## Installation
+
+### Download
+[Download the files](https://github.com/pedroborges/kirby-open-graph/archive/master.zip) and place them inside `site/plugins/open-graph`.
+
+### Kirby CLI
+Kirby's [command line interface](https://github.com/getkirby/cli) is the easiest way to install the Open Graph plugin:
+
+    $ kirby plugin:install pedroborges/kirby-open-graph
+
+To update it simply run:
+
+    $ kirby plugin:update pedroborges/kirby-open-graph
+
+### Git Submodule
+You can add the Open Graph as a Git submodule.
+
+<details>
+    <summary><strong>Show Git Submodule instructions</strong> 👁</summary><p>
+
+    $ cd your/project/root
+    $ git submodule add https://github.com/pedroborges/kirby-open-graph.git site/plugins/open-graph
+    $ git submodule update --init --recursive
+    $ git commit -am "Add Open Graph Git"
+
+Updating is as easy as running a few commands.
+
+    $ cd your/project/root
+    $ git submodule foreach git checkout master
+    $ git submodule foreach git pull
+    $ git commit -am "Update submodules"
+    $ git submodule update --init --recursive
+
+</p></details>
+
+## Usage
+Once installed, you can use Open Graph in two ways:
+
+### Page method
+    <?php echo $page->openGraph() ?>
+
+### Function
+    <?php echo openGraph($page) ?>
+
+Add your preferred method in the `head` of your HTML page and you are done! Well... not so fast. You will probably want to tweak the default meta tags or add new ones, so head over to the next section.
+
+## Options
+The Open Graph plugin allows you to use a default set of meta tags via the `open-graph.default` option as well as use template specific sets by using the `open-graph.templates` option. Check out some examples:
+
+```php
+c::get('open-graph.default', [
+    'title' => page()->title(),
+    'url' => page()->url(),
+    'site_name' => site()->title(),
+    'type' => 'website'
+]);
+
+c::set('open-graph.templates', [
+    'article' => [
+        'type' => 'article',
+        'image' => page()->cover()->url(),
+        'attributes' => function($page) {
+            return [
+                // if strftime, use $page->date('%F')
+                'published_time' => $page->date('c'),
+                'modified_time' => $page->modified('c'),
+            ];
+        }
+    ],
+]);
+```
+
+When the current page has a specific Open Graph template defined at `open-graph.templates`, it will be merged and will override the default properties so you don't need to repeat yourself!
+
+For more information on all the available open graph objects, check out the [specification](http://ogp.me).
+
+## Roadmap
+- [ ] Add image attributes (width, height, type)
+- [ ] Add author profile
+- [ ] Enable tags array
+
+## Change Log
+All notable changes to this project will be documented at: <https://github.com/pedroborges/kirby-open-graph/blob/master/changelog.md>
+
+## License
+Open Graph plugin is open-sourced software licensed under the [MIT license](http://www.opensource.org/licenses/mit-license.php).
+
+Copyright © 2017 Pedro Borges <[email protected]>

readme.md

@@ -0,0 +1,7 @@
+<?php
+
+// autoload.php @generated by Composer
+
+require_once __DIR__ . '/composer/autoload_real.php';
+
+return ComposerAutoloaderInitcf01207af6e29b7b2fa627a56709c040::getLoader();

vendor/autoload.php

@@ -0,0 +1,12 @@
+language: php
+
+php: 
+  - 5.3
+  - 5.4
+  - 5.5
+
+before_script:
+  - curl -s http://getcomposer.org/installer | php
+  - php composer.phar install --dev
+
+script: phpunit

vendor/chriskonnertz/open-graph/.travis.yml

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 mcamara
+
+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.