jekyll-seo-tag 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cc372667e8031faba02cb7bb2bf1e1a51be7fd6
-  data.tar.gz: 37b8a3f10ecffdf6a300834c2088c915f0ac95a6
+  metadata.gz: 07d7b830b127017c667a9e58bd5c214e594558bc
+  data.tar.gz: a69f4f9cee9f45644add22a57245366cdbc1ddc1
 SHA512:
-  metadata.gz: 021b61812fb8b3b08d8bf281ef2790ddad459e89349910bd434975d32b96a7b8cb9048bdfa138e44aa83114272ea9fc7b2689b7496c8c81187353331405376bc
-  data.tar.gz: d75c74ddfdd904a31e0fc5c9eaef1c407d700fc0276c92b53aa2597f3b01b97ea953548cc9ad343ddca85d456d43ec8dae8e8c5633742e7478491b6f46ac28c8
+  metadata.gz: 52c022b593902ef22131b0e96ef497d188e73469a07a6c2ffa33c0619de08393eeeaae729556a8d368a1d45b0d9ce7907f64e1eb40a177abcbce1213989e82b6
+  data.tar.gz: 0a7309abed4b88e3c9b95a8f349cfae6ad0305b304a4901d3fcf7e1c4d637a16d6381a3b2fd6fe64eba7f9d2817d8d410a23a3700b7fb36fb20f0cb655be3677

data/.rubocop.yml

@@ -1,3 +1,6 @@
+inherit_gem:
+  jekyll: .rubocop.yml
+
 Metrics/LineLength:
   Exclude:
     - spec/**/*
@@ -8,3 +11,7 @@ Style/Documentation:
 
 Style/FileName:
   Enabled: false
+
+AllCops:
+  Exclude:
+    - vendor/**/*

data/.travis.yml

@@ -1,7 +1,7 @@
 rvm:
   - 2.2.3
 before_install: gem install bundler
-langauage: ruby
+language: ruby
 script: script/cibuild
 sudo: false
 cache: bundler

data/Gemfile

@@ -9,6 +9,7 @@ group :development, :test do
   versions.delete('ruby')
   versions.delete('jekyll-seo-tag')
   versions.delete('github-pages')
+  versions.delete('jekyll') # Remove this line when GitHub Pages supports 3.3.0
 
   versions.each do |dep, version|
     gem dep, version

data/History.markdown

@@ -0,0 +1,23 @@
+## HEAD
+
+### Major Enhancement
+
+  * Use new URL filters (#123)
+
+### Minor Enhancements
+
+  * Wraps logo image json data in a publisher property (#133)
+  * Fix duplicated `escape_once` (#93)
+  * Simplify minify regex (#125)
+  * Don't mangle text with newlines #126
+
+### Documentation
+
+  * Add front matter default example for image (#132)
+  * Fix tiny typo (#106)
+  * add example usage of social profiles (#139)
+
+### Development
+
+  * Inherit Jekyll's rubocop config for consistency (#109)
+  * Correct spelling in .travis.yml (#112)

data/README.md

@@ -78,6 +78,19 @@ The SEO tag will respect any of the following if included in your site's `_confi
 * `social` - For [specifying social profiles](https://developers.google.com/structured-data/customize/social-profiles). The following properties are available:
   * `name` - If the user or organization name differs from the site's name
   * `links` - An array of links to social media profiles.
+
+  ```yml
+  social:
+    name: Ben Balter
+    links:
+      - https://twitter.com/BenBalter
+      - https://www.facebook.com/ben.balter
+      - https://www.linkedin.com/in/BenBalter
+      - https://plus.google.com/+BenBalter
+      - https://github.com/benbalter
+      - https://keybase.io/benbalter
+    ```
+
 * `google_site_verification` for verifying ownership via Google webmaster tools
 
 The SEO tag will respect the following YAML front matter if included in a post, page, or document:
@@ -101,7 +114,7 @@ If for some reason, you don't want the plugin to output `<title>` tags on each p
 
 ### Author information
 
-Author information is used to propagate the `creator` field of Twitter summary cards. This is should be an author-specific, not site-wide Twitter handle (the site-wide username be stored as `site.twitter.username`).
+Author information is used to propagate the `creator` field of Twitter summary cards. This should be an author-specific, not site-wide Twitter handle (the site-wide username be stored as `site.twitter.username`).
 
 *TL;DR: In most cases, put `author: [your Twitter handle]` in the document's front matter, for sites with multiple authors. If you need something more complicated, read on.*
 
@@ -184,6 +197,20 @@ image:
   width: 100
 ```
 
+### Setting a default image
+
+You can define a default image using [Front Matter default](https://jekyllrb.com/docs/configuration/#front-matter-defaults), to provide a default Twitter Card or OGP image to all of your posts and pages.
+
+Here is a very basic example, that you are encouraged to adapt to your needs:
+
+```yml
+defaults:
+  - scope:
+      path: ""
+    values:
+      image: /assets/images/default-card.png
+```
+
 ### SmartyPants Titles
 
 Titles will be processed using [Jekyll's `smartify` filter](https://jekyllrb.com/docs/templates/). This will use SmartyPants to translate plain ASCII punctuation into "smart" typographic punctuation. This will not render or strip any Markdown you may be using in a page title.

data/jekyll-seo-tag.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'jekyll', '~> 3.1'
+  spec.add_dependency 'jekyll', '~> 3.3'
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.3'

data/lib/jekyll-seo-tag.rb

@@ -1,11 +1,19 @@
-require 'jekyll-seo-tag/filters'
-require 'jekyll-seo-tag/version'
+require "jekyll-seo-tag/version"
 
 module Jekyll
   class SeoTag < Liquid::Tag
     attr_accessor :context
 
-    MINIFY_REGEX = /([>,]\n|[%}]})\s+?(<|{[{%]|[ ]+\")/
+    # Matches all whitespace that follows either
+    #   1. A '}', which closes a Liquid tag
+    #   2. A '{', which opens a JSON block
+    #   3. A '>' followed by a newline, which closes an XML tag or
+    #   4. A ',' followed by a newline, which ends a JSON line
+    # We will strip all of this whitespace to minify the template
+    # We will not strip any whitespace if the next character is a '-'
+    #   so that we do not interfere with the HTML comment at the
+    #   very begining
+    MINIFY_REGEX = %r!(?<=[{}]|[>,]\n)\s+(?\!-)!
 
     def initialize(_tag_name, text, _tokens)
       super
@@ -21,28 +29,28 @@ module Jekyll
 
     def options
       {
-        'version' => Jekyll::SeoTag::VERSION,
-        'title'   => title?
+        "version" => Jekyll::SeoTag::VERSION,
+        "title"   => title?
       }
     end
 
     def payload
       {
-        'page'    => context.registers[:page],
-        'site'    => context.registers[:site].site_payload['site'],
-        'paginator' => context['paginator'],
-        'seo_tag' => options
+        "page"      => context.registers[:page],
+        "site"      => context.registers[:site].site_payload["site"],
+        "paginator" => context["paginator"],
+        "seo_tag"   => options
       }
     end
 
     def title?
-      !(@text =~ /title=false/i)
+      !(@text =~ %r!title=false!i)
     end
 
     def info
       {
-        registers: context.registers,
-        filters: [Jekyll::Filters, JekyllSeoTag::Filters]
+        :registers => context.registers,
+        :filters   => [Jekyll::Filters]
       }
     end
 
@@ -52,16 +60,16 @@ module Jekyll
 
     def template_contents
       @template_contents ||= begin
-        File.read(template_path).gsub(MINIFY_REGEX, '\1\2').chomp
+        File.read(template_path).gsub(MINIFY_REGEX, "")
       end
     end
 
     def template_path
       @template_path ||= begin
-        File.expand_path './template.html', File.dirname(__FILE__)
+        File.expand_path "./template.html", File.dirname(__FILE__)
       end
     end
   end
 end
 
-Liquid::Template.register_tag('seo', Jekyll::SeoTag)
+Liquid::Template.register_tag("seo", Jekyll::SeoTag)

data/lib/jekyll-seo-tag/version.rb

@@ -3,6 +3,6 @@ module Liquid; class Tag; end; end
 
 module Jekyll
   class SeoTag < Liquid::Tag
-    VERSION = '2.0.0'.freeze
+    VERSION = "2.1.0".freeze
   end
 end

data/lib/template.html

@@ -4,10 +4,6 @@
   {% assign seo_homepage_or_about = true %}
 {% endif %}
 
-{% if site.url %}
-  {% assign seo_url = site.url | append: site.baseurl %}
-{% endif %}
-{% assign seo_url = seo_url | default: site.github.url %}
 {% assign seo_site_title = site.title | default: site.name %}
 
 {% if page.title %}
@@ -34,24 +30,24 @@
     {% assign seo_name = seo_site_title %}
 {% endif %}
 {% if seo_name %}
-  {% assign seo_name = seo_name | smartify | strip_html | strip_newlines | escape_once %}
+  {% assign seo_name = seo_name | smartify | strip_html | normalize_whitespace | escape_once %}
 {% endif %}
 
 {% if seo_title %}
-  {% assign seo_title = seo_title | smartify | strip_html | strip_newlines | escape_once | escape_once %}
+  {% assign seo_title = seo_title | smartify | strip_html | normalize_whitespace | escape_once %}
 {% endif %}
 
 {% if seo_site_title %}
-  {% assign seo_site_title = seo_site_title | smartify | strip_html | strip_newlines | escape_once %}
+  {% assign seo_site_title = seo_site_title | smartify | strip_html | normalize_whitespace | escape_once %}
 {% endif %}
 
 {% if seo_page_title %}
-  {% assign seo_page_title = seo_page_title | smartify | strip_html | strip_newlines | escape_once %}
+  {% assign seo_page_title = seo_page_title | smartify | strip_html | normalize_whitespace | escape_once %}
 {% endif %}
 
 {% assign seo_description = page.description | default: page.excerpt | default: site.description %}
 {% if seo_description %}
-  {% assign seo_description = seo_description | markdownify | strip_html | strip_newlines | escape_once %}
+  {% assign seo_description = seo_description | markdownify | strip_html | normalize_whitespace | escape_once %}
 {% endif %}
 
 {% assign seo_author = page.author | default: page.authors[0] | default: site.author %}
@@ -87,7 +83,7 @@
 {% if site.logo %}
   {% assign seo_site_logo = site.logo %}
   {% unless seo_site_logo contains "://" %}
-    {% assign seo_site_logo = seo_site_logo | prepend: seo_url %}
+    {% assign seo_site_logo = seo_site_logo | absolute_url %}
   {% endunless %}
   {% assign seo_site_logo = seo_site_logo | escape %}
 {% endif %}
@@ -95,7 +91,7 @@
 {% if page.image %}
   {% assign seo_page_image = page.image.path | default: page.image.facebook | default: page.image %}
   {% unless seo_page_image contains "://" %}
-    {% assign seo_page_image = seo_page_image | prepend: seo_url %}
+    {% assign seo_page_image = seo_page_image | absolute_url %}
   {% endunless %}
   {% assign seo_page_image = seo_page_image | escape %}
 {% endif %}
@@ -113,9 +109,9 @@
   <meta property="og:description" content="{{ seo_description }}" />
 {% endif %}
 
-{% if seo_url %}
-  <link rel="canonical" href="{{ page.url | prepend: seo_url | replace:'/index.html','/' }}" />
-  <meta property="og:url" content="{{ page.url | prepend: seo_url | replace:'/index.html','/' }}" />
+{% if page.url %}
+  <link rel="canonical" href="{{ page.url | replace:'/index.html','/' | absolute_url }}" />
+  <meta property="og:url" content="{{ page.url | replace:'/index.html','/' | absolute_url }}" />
 {% endif %}
 
 {% if seo_site_title %}
@@ -133,7 +129,7 @@
 {% endif %}
 
 {% if page.image.twitter %}
-  <meta name="twitter:image" content="{{ page.image.twitter | prepend: seo_url | escape }}" />
+  <meta name="twitter:image" content="{{ page.image.twitter | absolute_url }}" />
 {% endif %}
 
 {% if page.date %}
@@ -142,10 +138,10 @@
 {% endif %}
 
 {% if paginator.previous_page %}
-  <link rel="prev" href="{{ paginator.previous_page_path | prepend: seo_url }}">
+  <link rel="prev" href="{{ paginator.previous_page_path | absolute_url }}">
 {% endif %}
 {% if paginator.next_page %}
-  <link rel="next" href="{{ paginator.next_page_path | prepend: seo_url }}">
+  <link rel="next" href="{{ paginator.next_page_path | absolute_url }}">
 {% endif %}
 
 {% if site.twitter %}
@@ -209,14 +205,20 @@
 {% endif %}
 
 {% if seo_site_logo %}
-    "logo": {{ seo_site_logo | jsonify }},
+    "publisher": {
+        "@type": "Organization",
+        "logo": {
+            "@type": "ImageObject",
+            "url": {{ seo_site_logo | jsonify }}
+        }
+    },
 {% endif %}
 
 {% if seo_links %}
     "sameAs": {{ seo_links | jsonify }},
 {% endif %}
 
-    "url": {{ page.url | prepend: seo_url | replace:'/index.html','/' | jsonify }}
+    "url": {{ page.url | replace:'/index.html','/' | absolute_url | jsonify }}
   }
 </script>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-seo-tag
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-31 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,12 +106,12 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- History.markdown
 - LICENSE.txt
 - README.md
 - Rakefile
 - jekyll-seo-tag.gemspec
 - lib/jekyll-seo-tag.rb
-- lib/jekyll-seo-tag/filters.rb
 - lib/jekyll-seo-tag/version.rb
 - lib/template.html
 - script/bootstrap
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to add metadata tags for search engines and social networks

data/lib/jekyll-seo-tag/filters.rb

@@ -1,13 +0,0 @@
-module JekyllSeoTag
-  module Filters
-    # This is available in Liquid from version 3 which is required by Jekyll 3
-    # Provided here for compatibility with Jekyll 2.x
-    def default(input, default_value = ''.freeze)
-      if !input || input.respond_to?(:empty?) && input.empty?
-        default_value
-      else
-        input
-      end
-    end
-  end
-end