middleman-ogp 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96160b6adc9bfb778a9514674c56f7c123eebb84
-  data.tar.gz: 9423c6302a1cc61e14696c8b00ec4afc680ed35b
+  metadata.gz: d59dba42be8e5b8512bf6ec22df723f202d2dd40
+  data.tar.gz: 1f211db3d5f975d00ebe96a8851a83f7baa27b11
 SHA512:
-  metadata.gz: 317dd8172ab0d69f28f57b6005c92727f50c1970db9a6992033120b95d56d9c488774389da6236589ee35cbb7b6f8d3f231b686eae18bf5cc2ff036c3871dcbc
-  data.tar.gz: 6faa50f42a43ee59a7ce58b06327f7b8e22913d547baf9ef8b330565bc3b5af0c78891db88b6f26f00a576382814d4962bc692552c62cb890c9949d19a06621c
+  metadata.gz: 371fffa46683019462bf0969620cfbcbdc0c71951aa53d5dc14192c4e044b4d02e5f1010568efb6d6f1560306c51ec35205972f57a0cfec56fad7ea785898fc4
+  data.tar.gz: 55985da4cd0415f0b849e699f87601f3c0eb5c901145ca5cef34522107922ca82616cf58893e5b7aa185449a32f244a81db1de3694e371049803adea434dbac9

data/.gitignore

@@ -15,3 +15,4 @@ doc
 tmp
 Makefile
 .mm-pid-*
+*.gem

data/Gemfile

@@ -1,6 +1,7 @@
 source "https://rubygems.org"
 
 gem "middleman-core", '~> 3.2'
+gem "middleman-blog", '~> 3.5'
 
 # Specify your gem's dependencies in middleman-ogp.gemspec
 gemspec

data/README.md

@@ -20,6 +20,7 @@ activate :ogp do |ogp|
     og: data.ogp.og
     # from data/ogp/og.yml
   }
+  og.base_url = 'http://mysite.tld/'
 end
 ```
 
@@ -77,12 +78,34 @@ Hello
 This is the __content__
 ```
 
+Blog Support
+------------
+
+`middleman-ogp` supports adding [article] properties like `article:published_time`, `article:tag` automatically for [middleman-blog] articles.
+
+Set `ogp.blog` to `true` in your configuration. (Defaults to `false`)
+
+```ruby
+activate :ogp do |ogp|
+  #
+  # register namespace with default options
+  #
+  ogp.namespaces = {
+    fb: data.ogp.fb,
+    # from data/ogp/fb.yml
+    og: data.ogp.og
+    # from data/ogp/og.yml
+  }
+  ogp.blog = true
+end
+```
+
 
 Build & Dependency Status
 -------------------------
 
 [![Gem Version](https://badge.fury.io/rb/middleman-ogp.png)][gem]
-[![Build Status](https://travis-ci.org/ngs/middleman-ogp.png)][travis]
+[![Build Status](https://travis-ci.org/ngs/middleman-ogp.svg?branch=master)][travis]
 [![Dependency Status](https://gemnasium.com/ngs/middleman-ogp.png?travis)][gemnasium]
 [![Code Quality](https://codeclimate.com/github/ngs/middleman-ogp.png)][codeclimate]
 
@@ -92,9 +115,11 @@ License
 Copyright (c) 2014 [Atsushi Nagase]. MIT Licensed, see [LICENSE] for details.
 
 [middleman]: http://middlemanapp.com
+[middleman-blog]: https://github.com/middleman/middleman-blog
 [gem]: https://rubygems.org/gems/middleman-ogp
 [travis]: http://travis-ci.org/ngs/middleman-ogp
 [gemnasium]: https://gemnasium.com/ngs/middleman-ogp
 [codeclimate]: https://codeclimate.com/github/ngs/middleman-ogp
 [LICENSE]: https://github.com/ngs/middleman-ogp/blob/master/LICENSE.md
 [Atsushi Nagase]: http://ngs.io/
+[article]: http://ogp.me/#type_article

data/features/blog.feature

@@ -0,0 +1,21 @@
+Feature: Middleman Blog support
+
+  Scenario: Non article page
+    Given the Server is running at "test-blog"
+    When I go to "/"
+    Then I should see '<meta content="website" property="og:type" />'
+    Then I should see '<meta content="http://myblog.foo.tld/" property="og:url" />'
+    Then I should see '<meta content="Fixture page" property="og:title" />'
+
+  Scenario: article page
+    Given the Server is running at "test-blog"
+    When I go to "/2014/04/12/my-test.html"
+    Then I should see '<meta content="article" property="og:type" />'
+    Then I should see '<meta content="2014-04-12T04:00:00Z" property="article:published_time" />'
+    Then I should see '<meta content="ruby" property="article:tag" />'
+    Then I should see '<meta content="middleman" property="article:tag" />'
+    Then I should see '<meta content="blog" property="article:tag" />'
+    Then I should see '<meta content="http://myblog.foo.tld/2014/04/12/my-test.html" property="og:url" />'
+    Then I should see '<meta content="Fixture page" property="og:title" />'
+
+

data/features/helper.feature

@@ -9,7 +9,7 @@ Feature: OpenGraph Protocol Tags with the "ogp_tags" helper method
     Then I should see '<meta content="image/png" property="fb:image:type" />'
     Then I should see '<meta content="400" property="fb:image:width" />'
     Then I should see '<meta content="300" property="fb:image:height" />'
-    Then I should see '<meta content="This is my fixture Middleman site for OpenGraph." property="og:description" />'
+    Then I should see '<meta content="My Description" property="og:description" />'
     Then I should see '<meta content="http://mydomain.tld/path/to/og-site-image.png" property="og:image" />'
     Then I should see '<meta content="https://secure.mydomain.tld/path/to/og-site-image.png" property="og:image:secure_url" />'
     Then I should see '<meta content="image/png" property="og:image:type" />'
@@ -18,6 +18,8 @@ Feature: OpenGraph Protocol Tags with the "ogp_tags" helper method
     Then I should see '<meta content="en_us" property="og:locale" />'
     Then I should see '<meta content="ja_jp" property="og:locale:alternate" />'
     Then I should see '<meta content="zh_tw" property="og:locale:alternate" />'
+    Then I should see '<meta content="http://myshop.foo.tld/" property="og:url" />'
+    Then I should see '<meta content="My Title" property="og:title" />'
 
   Scenario: With page data
     Given the Server is running at "test-app"
@@ -28,7 +30,7 @@ Feature: OpenGraph Protocol Tags with the "ogp_tags" helper method
     Then I should see '<meta content="image/png" property="fb:image:type" />'
     Then I should see '<meta content="400" property="fb:image:width" />'
     Then I should see '<meta content="300" property="fb:image:height" />'
-    Then I should see '<meta content="This is my fixture Middleman article for OpenGraph." property="og:description" />'
+    Then I should see '<meta content="This is my fixture Middleman article." property="og:description" />'
     Then I should see '<meta content="http://mydomain.tld/path/to/og-article-image.png" property="og:image" />'
     Then I should see '<meta content="https://secure.mydomain.tld/path/to/og-article-image.png" property="og:image:secure_url" />'
     Then I should see '<meta content="image/png" property="og:image:type" />'
@@ -37,3 +39,5 @@ Feature: OpenGraph Protocol Tags with the "ogp_tags" helper method
     Then I should see '<meta content="en_us" property="og:locale" />'
     Then I should see '<meta content="ja_jp" property="og:locale:alternate" />'
     Then I should see '<meta content="zh_tw" property="og:locale:alternate" />'
+    Then I should see '<meta content="http://myshop.foo.tld/page.html" property="og:url" />'
+    Then I should see '<meta content="Fixture page" property="og:title" />'

data/features/support/env.rb

@@ -1,5 +1,6 @@
 PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
 ENV['TEST'] = 'true'
 require "middleman-core"
+require "middleman-blog"
 require "middleman-core/step_definitions"
 require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-ogp')

data/fixtures/test-app/config.rb

@@ -8,4 +8,5 @@ activate :ogp do |ogp|
     og: data.ogp.og
     # from data/ogp/og.yml
   }
-end
+  ogp.base_url = 'http://myshop.foo.tld/'
+end

data/fixtures/test-app/source/index.html.slim

@@ -1,7 +1,9 @@
 ---
-title: Fixture page
+description: My Description
+title: My Title
 ---
 
 h1 Hello index
 
 p This is index
+

data/fixtures/test-app/source/layout.slim

@@ -7,4 +7,4 @@ html
 
   body
     .container
-      = yield
+      = yield

data/fixtures/test-app/source/page.html.slim

@@ -1,5 +1,6 @@
 ---
 title: Fixture page
+description: 'This is my fixture Middleman article.'
 ogp:
   og:
     description: 'This is my fixture Middleman article for OpenGraph.'

data/fixtures/test-blog/config.rb

@@ -0,0 +1,11 @@
+activate :blog do |blog|
+end
+
+activate :ogp do |ogp|
+  ogp.namespaces = {
+    fb: data.ogp.fb,
+    og: data.ogp.og
+  }
+  ogp.base_url = 'http://myblog.foo.tld/'
+  ogp.blog = true
+end

data/fixtures/test-blog/data/ogp/fb.yml

@@ -0,0 +1,7 @@
+description: 'This is my fixture Middleman site for Facebook.'
+image:
+  '': http://mydomain.tld/path/to/fb-site-image.png
+  secure_url: https://secure.mydomain.tld/path/to/fb-site-image.png
+  type: image/png
+  width: 400
+  height: 300

data/fixtures/test-blog/data/ogp/og.yml

@@ -0,0 +1,12 @@
+description: 'This is my fixture Middleman site for OpenGraph.'
+image:
+  '': http://mydomain.tld/path/to/og-site-image.png
+  secure_url: https://secure.mydomain.tld/path/to/og-site-image.png
+  type: image/png
+  width: 400
+  height: 300
+locale:
+  '': en_us
+  alternate:
+    - ja_jp
+    - zh_tw

data/fixtures/test-blog/source/2014-04-12-my-test.html.slim

@@ -0,0 +1,10 @@
+---
+title: Fixture page
+description: This is a ficture page
+tags: ruby, middleman, blog
+date: 2014-04-12 04:00
+---
+
+h1 Hello article
+
+p This is article

data/fixtures/test-blog/source/index.html.slim

@@ -0,0 +1,11 @@
+---
+title: Fixture page
+description: This is a ficture page
+ogp:
+  og:
+    type: website
+---
+
+h1 Hello index
+
+p This is index

data/fixtures/test-blog/source/layout.slim

@@ -0,0 +1,10 @@
+html
+  head
+    meta charset="utf-8"
+    title= data.page.title
+    - ogp_tags do|name, value|
+      meta property=name content=value
+
+  body
+    .container
+      = yield

data/lib/middleman-ogp/extension.rb

@@ -2,14 +2,52 @@ module Middleman
   module OGP
     class OGPExtension < Extension
       option :namespaces, {}, 'Default namespaces'
+      option :blog,       false, 'Middleman Blog support'
+      option :auto,       %w{title url description}, 'Properties to automatically fill from page data.'
+      option :base_url,   nil, 'Base URL to generate permalink for og:url'
 
       def after_configuration
         Middleman::OGP::Helper.namespaces = options[:namespaces] || {}
+        Middleman::OGP::Helper.blog = options[:blog]
+        Middleman::OGP::Helper.auto = options[:auto]
+        Middleman::OGP::Helper.base_url = options[:base_url]
       end
 
       helpers do
         def ogp_tags(&block)
-          Middleman::OGP::Helper.ogp_tags(data.page.ogp) do|name, value|
+          opts = data.page.ogp || {}
+          is_blog_article = Middleman::OGP::Helper.blog && respond_to?(:is_blog_article?) && is_blog_article?
+          if is_blog_article
+            opts.deep_merge4!({
+              og: {
+                type: 'article',
+              },
+              article: {
+                published_time: current_article.date.to_time.utc.iso8601,
+                tag: current_article.tags,
+              }
+            })
+          end
+          opts[:og] ||= {}
+          if Middleman::OGP::Helper.auto.include?('title')
+            if current_resource.data['title']
+              opts[:og][:title] = current_resource.data['title']
+            elsif content_for?(:title)
+              opts[:og][:title] = yield_content(:title)
+            end
+          end
+          if Middleman::OGP::Helper.auto.include?('description')
+            if current_resource.data['description']
+              opts[:og][:description] = current_resource.data['description']
+            elsif content_for?(:description)
+              opts[:og][:description] = yield_content(:description)
+            end
+          end
+          if Middleman::OGP::Helper.auto.include?('url') &&
+            Middleman::OGP::Helper.base_url
+            opts[:og][:url] = URI.join(Middleman::OGP::Helper.base_url, URI.encode(current_resource.url))
+          end
+          Middleman::OGP::Helper.ogp_tags(opts) do|name, value|
             if block_given?
               block.call name, value
             else
@@ -23,6 +61,9 @@ module Middleman
     module Helper
       include Padrino::Helpers::TagHelpers
       mattr_accessor :namespaces
+      mattr_accessor :blog
+      mattr_accessor :auto
+      mattr_accessor :base_url
 
       def self.ogp_tags(opts = {}, &block)
         opts ||= {}

data/lib/middleman-ogp/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module OGP
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-ogp
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Atsushi Nagase
@@ -39,6 +39,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- features/blog.feature
 - features/helper.feature
 - features/support/env.rb
 - fixtures/test-app/config.rb
@@ -47,6 +48,12 @@ files:
 - fixtures/test-app/source/index.html.slim
 - fixtures/test-app/source/layout.slim
 - fixtures/test-app/source/page.html.slim
+- fixtures/test-blog/config.rb
+- fixtures/test-blog/data/ogp/fb.yml
+- fixtures/test-blog/data/ogp/og.yml
+- fixtures/test-blog/source/2014-04-12-my-test.html.slim
+- fixtures/test-blog/source/index.html.slim
+- fixtures/test-blog/source/layout.slim
 - lib/middleman-ogp.rb
 - lib/middleman-ogp/extension.rb
 - lib/middleman-ogp/middleman_extension.rb
@@ -79,6 +86,7 @@ signing_key:
 specification_version: 4
 summary: OpenGraph Protocol Helper for Middleman
 test_files:
+- features/blog.feature
 - features/helper.feature
 - features/support/env.rb
 - fixtures/test-app/config.rb
@@ -87,6 +95,12 @@ test_files:
 - fixtures/test-app/source/index.html.slim
 - fixtures/test-app/source/layout.slim
 - fixtures/test-app/source/page.html.slim
+- fixtures/test-blog/config.rb
+- fixtures/test-blog/data/ogp/fb.yml
+- fixtures/test-blog/data/ogp/og.yml
+- fixtures/test-blog/source/2014-04-12-my-test.html.slim
+- fixtures/test-blog/source/index.html.slim
+- fixtures/test-blog/source/layout.slim
 - spec/helper_spec.rb
 - spec/spec_helper.rb
 has_rdoc: