middleman-ogp 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7a795f3654c7cc818de89ae7b305a490f35cf79
+  data.tar.gz: bea3e8661b877fcc400d3827f7bc151e7c768883
+SHA512:
+  metadata.gz: cc0818834f813e104131b5227f5aa9e72c125954957b8d89b4aa0690e0259129472ac4b140668053d9e1296b1d19392e6dcb30e9548f9405ca62ba8427f0973d
+  data.tar.gz: c0f4ef61d865266300ac2bd746dc1229b1fe2dd6a0e4dfca73fef78404bfd3fa5be5c093dd046396147210f5383c4246fbdc2e451990a96a80a58eadeac59ada

data/.gitignore

@@ -0,0 +1,17 @@
+.DS_Store
+coverage
+rdoc
+pkg
+.sass-cache
+.sassc
+.tmp
+Gemfile.lock
+docs
+.rbenv-*
+.*.swp
+build
+doc
+.yardoc
+tmp
+Makefile
+.mm-pid-*

data/.travis.yml

@@ -0,0 +1,14 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+
+# Bug in jRuby w/ Rouge: https://github.com/jruby/jruby/issues/1392
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+
+script: "bundle exec rake test"
+
+env: TEST=true

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+1.0.0
+-----
+
+* Initial release.

data/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace)
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/ngs/middleman-ogp/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake test`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake test`. If your specs fail, return to step 5.
+7. Add, commit, and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -0,0 +1,20 @@
+source "https://rubygems.org"
+
+gem "middleman-core", :github => "middleman/middleman", :branch => 'v3-stable'
+
+# Specify your gem's dependencies in middleman-ogp.gemspec
+gemspec
+
+gem "rake",     "~> 10.1.0", :require => false
+gem "yard",     "~> 0.8.0", :require => false
+
+# Test tools
+gem "cucumber", "~> 1.3.1"
+gem "fivemat"
+gem "aruba",    "~> 0.5.1"
+gem "rspec"
+
+gem "slim"
+
+# Code Quality
+gem "cane", :platforms => [:mri_19, :mri_20], :require => false

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Atsushi Nagase
+
+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.

data/README.md

@@ -0,0 +1,100 @@
+Middleman-OGP
+=============
+
+`middleman-opg` is an extension for the [Middleman] static site generator that adds OpenGraph Protocol support.
+
+
+Configuration
+-------------
+
+### In your `config.rb`
+
+```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
+  }
+end
+```
+
+### In your layout
+
+source/layout.slim
+
+```
+html
+  head
+    meta charset="utf-8"
+    title= data.page.title
+    - ogp_tags do|name, value|
+      meta property=name content=value
+
+  body
+    .container
+      = yield
+```
+
+### In your page source
+
+Page data overrides default options. (deep merge).
+
+
+```markdown
+---
+ogp:
+  og:
+    description: 'This is my fixture Middleman site.'
+    image:
+      '': http://mydomain.tld/path/to/fbimage.png
+      secure_url: https://secure.mydomain.tld/path/to/fbimage.png
+      type: image/png
+      width: 400
+      height: 300
+    locale:
+      '': en_us
+      alternate:
+        - ja_jp
+        - zh_tw
+  fb:
+    description: 'This is my fixture Middleman site.'
+    image:
+      '': http://mydomain.tld/path/to/fbimage.png
+      secure_url: https://secure.mydomain.tld/path/to/fbimage.png
+      type: image/png
+      width: 400
+      height: 300
+---
+
+Hello
+=====
+
+This is the __content__
+```
+
+
+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]
+[![Dependency Status](https://gemnasium.com/ngs/middleman-ogp.png?travis)][gemnasium]
+[![Code Quality](https://codeclimate.com/github/ngs/middleman-ogp.png)][codeclimate]
+
+License
+-------
+
+Copyright (c) 2014 [Atsushi Nagase]. MIT Licensed, see [LICENSE] for details.
+
+[middleman]: http://middlemanapp.com
+[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/

data/Rakefile

@@ -0,0 +1,35 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  exempt_tags = ""
+  exempt_tags << "--tags ~@nojava " if RUBY_PLATFORM == "java"
+  t.cucumber_opts = "--color --tags ~@wip #{exempt_tags} --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}"
+end
+
+require 'rake/clean'
+
+task :test => ["spec", "cucumber"]
+
+begin
+  require 'cane/rake_task'
+
+  desc "Run cane to check quality metrics"
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.no_style = true
+    cane.no_doc = true
+    cane.abc_glob = "lib/middleman-ogp/**/*.rb"
+  end
+rescue LoadError
+  # warn "cane not available, quality task not provided."
+end
+
+desc "Build HTML documentation"
+task :doc do
+  sh 'bundle exec yard'
+end

data/features/helper.feature

@@ -0,0 +1,39 @@
+Feature: OpenGraph Protocol Tags with the "ogp_tags" helper method
+
+  Scenario: Without page data
+    Given the Server is running at "test-app"
+    When I go to "/"
+    Then I should see '<meta content="This is my fixture Middleman site for Facebook." property="fb:description" />'
+    Then I should see '<meta content="http://mydomain.tld/path/to/fb-site-image.png" property="fb:image" />'
+    Then I should see '<meta content="https://secure.mydomain.tld/path/to/fb-site-image.png" property="fb:image:secure_url" />'
+    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="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" />'
+    Then I should see '<meta content="400" property="og:image:width" />'
+    Then I should see '<meta content="300" property="og:image:height" />'
+    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" />'
+
+  Scenario: With page data
+    Given the Server is running at "test-app"
+    When I go to "/page.html"
+    Then I should see '<meta content="This is my fixture Middleman article for Facebook." property="fb:description" />'
+    Then I should see '<meta content="http://mydomain.tld/path/to/fb-article-image.png" property="fb:image" />'
+    Then I should see '<meta content="https://secure.mydomain.tld/path/to/fb-article-image.png" property="fb:image:secure_url" />'
+    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="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" />'
+    Then I should see '<meta content="400" property="og:image:width" />'
+    Then I should see '<meta content="300" property="og:image:height" />'
+    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" />'

data/features/support/env.rb

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

data/fixtures/test-app/config.rb

@@ -0,0 +1,11 @@
+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
+  }
+end

data/fixtures/test-app/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-app/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-app/source/index.html.slim

@@ -0,0 +1,7 @@
+---
+title: Fixture page
+---
+
+h1 Hello index
+
+p This is index

data/fixtures/test-app/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/fixtures/test-app/source/page.html.slim

@@ -0,0 +1,29 @@
+---
+title: Fixture page
+ogp:
+  og:
+    description: 'This is my fixture Middleman article for OpenGraph.'
+    image:
+      '': http://mydomain.tld/path/to/og-article-image.png
+      secure_url: https://secure.mydomain.tld/path/to/og-article-image.png
+      type: image/png
+      width: 400
+      height: 300
+    locale:
+      '': en_us
+      alternate:
+        - ja_jp
+        - zh_tw
+  fb:
+    description: 'This is my fixture Middleman article for Facebook.'
+    image:
+      '': http://mydomain.tld/path/to/fb-article-image.png
+      secure_url: https://secure.mydomain.tld/path/to/fb-article-image.png
+      type: image/png
+      width: 400
+      height: 300
+---
+
+h1 Hello page
+
+p This is page

data/lib/middleman-ogp.rb

@@ -0,0 +1,7 @@
+require "middleman-core"
+require "middleman-ogp/version"
+
+::Middleman::Extensions.register(:ogp) do
+  require "middleman-ogp/extension"
+  ::Middleman::OGP::OGPExtension
+end

data/lib/middleman-ogp/extension.rb

@@ -0,0 +1,71 @@
+module Middleman
+  module OGP
+    class OGPExtension < Extension
+      option :namespaces, {}, 'Default namespaces'
+
+      def after_configuration
+        Middleman::OGP::Helper.namespaces = options[:namespaces] || {}
+      end
+
+      helpers do
+        def ogp_tags(&block)
+          Middleman::OGP::Helper.ogp_tags(data.page.ogp) do|name, value|
+            if block_given?
+              block.call name, value
+            else
+              concat_content tag(:meta, name: name, property: value)
+            end
+          end
+        end
+      end
+    end
+
+    module Helper
+      include Padrino::Helpers::TagHelpers
+      mattr_accessor :namespaces
+
+      def self.ogp_tags(opts = {}, &block)
+        options = namespaces.respond_to?(:to_h) ? namespaces.to_h : namespaces || {}
+        options = options.deep_merge(opts || {}) {|k, old_value, new_value|
+          if old_value.is_a?(Hash)
+            if new_value.is_a? Hash
+              old_value.deep_merge new_value
+            else
+              old_value[''] = new_value
+              old_value
+            end
+          else
+            new_value
+          end
+        }.symbolize_keys
+        options.map{|k, v|
+          og_tag([], v, k, &block)
+        }.join("\n")
+      end
+
+      def self.og_tag(key, obj = nil, prefix = 'og', &block)
+        case key
+        when String, Symbol
+          key = [key]
+        when Hash
+          prefix = obj if obj
+          obj = key
+          key = []
+        end
+        case obj
+        when Hash
+          obj.map{|k, v|
+            og_tag(k.to_s.empty? ? key.dup : (key.dup << k.to_sym) , v, prefix, &block)
+          }.join("\n")
+        when Array
+          obj.map{|v|
+            og_tag(key, v, prefix, &block)
+          }.join("\n")
+        else
+          block.call [prefix].concat(key).join(':'), obj.to_s
+        end
+      end
+
+    end
+  end
+end

data/lib/middleman-ogp/middleman_extension.rb

@@ -0,0 +1,2 @@
+require 'middleman-ogp'
+

data/lib/middleman-ogp/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module OGP
+    VERSION = "1.0.0"
+  end
+end

data/middleman-ogp.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "middleman-ogp/version"
+
+Gem::Specification.new do |s|
+  s.name = "middleman-ogp"
+  s.version = Middleman::OGP::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Atsushi Nagase"]
+  s.email = ["a@ngs.io"]
+  s.homepage = "https://github.com/ngs/middleman-ogp"
+  s.summary = %q{OpenGraph Protocol Helper for Middleman}
+  s.description = %q{OpenGraph Protocol Helper for Middleman}
+  s.license = "MIT"
+  s.files = `git ls-files -z`.split("\0")
+  s.test_files = `git ls-files -z -- {fixtures,features,spec}/*`.split("\0")
+  s.require_paths = ["lib"]
+  s.add_runtime_dependency("middleman-core", ["~> 3.2"])
+end

data/spec/helper_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe "Middleman::OGP::Helper" do
+  subject {
+    Middleman::OGP::Helper.namespaces = namespaces
+    Middleman::OGP::Helper.ogp_tags(options) do|name, value|
+      %Q{<meta property="#{name}" content="#{value}" />}
+    end
+  }
+  describe "default namespace and options are nil" do
+    let(:namespaces) { nil }
+    let(:options)    { nil }
+    it { subject.should eq '' }
+  end
+  context "with default namespaces" do
+    let(:namespaces) {
+      {
+        og: {
+          image: {
+            '' => 'http://mydomain.tld/mysite.png',
+            type: 'image/png',
+            'width' => 300,
+            'height' => 400
+          }
+        },
+        fb: {
+          description: 'foo'
+        }
+      }
+    }
+    describe "options is nil" do
+      let(:options)    { nil }
+      it {
+        subject.should eq <<-EOF.unindent
+          <meta property="og:image" content="http://mydomain.tld/mysite.png" />
+          <meta property="og:image:type" content="image/png" />
+          <meta property="og:image:width" content="300" />
+          <meta property="og:image:height" content="400" />
+          <meta property="fb:description" content="foo" />
+        EOF
+      }
+    end
+    describe "options is presented" do
+      let(:options)    {
+        {
+          og: {
+            image: 'http://mydomain.tld/myarticle.png'
+          },
+          fb: {
+            description: 'bar'
+          },
+          music: {
+            id: '123'
+          }
+        }
+      }
+      it {
+        subject.should eq <<-EOF.unindent
+          <meta property="og:image" content="http://mydomain.tld/myarticle.png" />
+          <meta property="og:image:type" content="image/png" />
+          <meta property="og:image:width" content="300" />
+          <meta property="og:image:height" content="400" />
+          <meta property="fb:description" content="bar" />
+          <meta property="music:id" content="123" />
+        EOF
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(__FILE__))
+
+require 'rubygems'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-ogp')
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-ogp/extension')
+
+class String
+  def unindent
+    gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "").sub(/\n$/, '')
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: middleman-ogp
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Atsushi Nagase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: OpenGraph Protocol Helper for Middleman
+email:
+- a@ngs.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- features/helper.feature
+- features/support/env.rb
+- fixtures/test-app/config.rb
+- fixtures/test-app/data/ogp/fb.yml
+- fixtures/test-app/data/ogp/og.yml
+- fixtures/test-app/source/index.html.slim
+- fixtures/test-app/source/layout.slim
+- fixtures/test-app/source/page.html.slim
+- lib/middleman-ogp.rb
+- lib/middleman-ogp/extension.rb
+- lib/middleman-ogp/middleman_extension.rb
+- lib/middleman-ogp/version.rb
+- middleman-ogp.gemspec
+- spec/helper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ngs/middleman-ogp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: OpenGraph Protocol Helper for Middleman
+test_files:
+- features/helper.feature
+- features/support/env.rb
+- fixtures/test-app/config.rb
+- fixtures/test-app/data/ogp/fb.yml
+- fixtures/test-app/data/ogp/og.yml
+- fixtures/test-app/source/index.html.slim
+- fixtures/test-app/source/layout.slim
+- fixtures/test-app/source/page.html.slim
+- spec/helper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: