jekyll-seo-tag 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3aadbfac78b25f51bdf3988226662b0bec27d938
-  data.tar.gz: 31daa9c7be9db36224a7f7e4ea73bd65759e434c
+  metadata.gz: d007bd49496c661cf441f17dc25d6756ae9daf31
+  data.tar.gz: c1a2dc3f79edacd4d68fedc1c8f518249a5a59a3
 SHA512:
-  metadata.gz: 86935801e5cfa7a9615a3d43724883963cd4797cd77cd23c0acf269d673d812b54c046377b0c9cbefb60aba7de645d6a8e261014db70e1bfebe7d9a9e17b49b3
-  data.tar.gz: 22c5d2544893c1568669e1655ee242ee56207ce20c04f898b951089220357dbab5451a2a1bf29e6cfcf1dfef624e17faf78d77a7507cf7b20de05a5e6a1f901a
+  metadata.gz: 0eec356674ff4054de62b1d022cbf206496fc4eb17dc2933137764851310b5350d1b0b6bd8403ff80a2faf9e8184f8a85d4eeeecf572752d2ea8d5cfe0c68e36
+  data.tar.gz: 12088f4299da9829ab61d2c04ce1994cbcd3999f32cd3489aab59053bcf1b3584342e9c4e6bddf1cd082e95032094d2179c0713977f4eea5e4ab338e8e52e3f5

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
 --color
+--require spec_helper

data/History.markdown

@@ -1,5 +1,10 @@
 ## HEAD
 
+* Convert template logic to a Liquid Drop (significant performance improvement) (#184)
+* Fix for JSON-LD validation warning for images missing required properties (#183)
+
+## 2.2.0
+
 ### Major Enhancements
 
   * Add author meta (#103)

data/lib/jekyll-seo-tag.rb

@@ -1,7 +1,12 @@
+require "jekyll"
 require "jekyll-seo-tag/version"
 
 module Jekyll
   class SeoTag < Liquid::Tag
+    autoload :JSONLD,  "jekyll-seo-tag/json_ld"
+    autoload :Drop,    "jekyll-seo-tag/drop"
+    autoload :Filters, "jekyll-seo-tag/filters"
+
     attr_accessor :context
 
     # Matches all whitespace that follows either
@@ -39,12 +44,12 @@ module Jekyll
         "page"      => context.registers[:page],
         "site"      => context.registers[:site].site_payload["site"],
         "paginator" => context["paginator"],
-        "seo_tag"   => options,
+        "seo_tag"   => drop,
       }
     end
 
-    def title?
-      @text !~ %r!title=false!i
+    def drop
+      @drop ||= Jekyll::SeoTag::Drop.new(@text, @context)
     end
 
     def info

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

@@ -0,0 +1,244 @@
+module Jekyll
+  class SeoTag
+    class Drop < Jekyll::Drops::Drop
+      include Jekyll::SeoTag::JSONLD
+
+      TITLE_SEPARATOR = " | ".freeze
+      FORMAT_STRING_METHODS = %i[
+        markdownify strip_html normalize_whitespace escape_once
+      ].freeze
+      HOMEPAGE_OR_ABOUT_REGEX = %r!^/(about/)?(index.html?)?$!
+
+      def initialize(text, context)
+        @obj = {}
+        @mutations = {}
+        @text    = text
+        @context = context
+      end
+
+      def version
+        Jekyll::SeoTag::VERSION
+      end
+
+      # Should the `<title>` tag be generated for this page?
+      def title?
+        return false unless title
+        return @display_title if defined?(@display_title)
+        @display_title = (@text !~ %r!title=false!i)
+      end
+
+      def site_title
+        @site_title ||= format_string(site["title"] || site["name"])
+      end
+
+      # Page title without site title or description appended
+      def page_title
+        @page_title ||= format_string(page["title"] || site_title)
+      end
+
+      # Page title with site title or description appended
+      def title
+        @title ||= begin
+          if page["title"] && site_title
+            page_title + TITLE_SEPARATOR + site_title
+          elsif site["description"] && site_title
+            site_title + TITLE_SEPARATOR + format_string(site["description"])
+          else
+            page_title || site_title
+          end
+        end
+      end
+
+      def name
+        return @name if defined?(@name)
+        @name = if seo_name
+                  seo_name
+                elsif !homepage_or_about?
+                  nil
+                elsif site["social"] && site["social"]["name"]
+                  format_string site["social"]["name"]
+                elsif site_title
+                  format_string site_title
+                end
+      end
+
+      def description
+        @description ||= format_string(
+          page["description"] || page["excerpt"] || site["description"]
+        )
+      end
+
+      # Returns a nil or a hash representing the author
+      # Author name will be pulled from:
+      #
+      # 1. The `author` key, if the key is a string
+      # 2. The first author in the `authors` key
+      # 3. The `author` key in the site config
+      #
+      # If the result from the name search is a string, we'll also check
+      # to see if the author exists in `site.data.authors`
+      def author
+        @author ||= begin
+          return if author_string_or_hash.to_s.empty?
+
+          author = if author_string_or_hash.is_a?(String)
+                     author_hash(author_string_or_hash)
+                   else
+                     author_string_or_hash
+                   end
+
+          author["twitter"] ||= author["name"]
+          author["twitter"].delete! "@"
+          author.to_liquid
+        end
+      end
+
+      def date_modified
+        @date_modified ||= begin
+          date = if page["seo"] && page["seo"]["date_modified"]
+                   page["seo"]["date_modified"]
+                 elsif page["last_modified_at"]
+                   page["last_modified_at"].to_liquid
+                 else
+                   page["date"]
+                 end
+          filters.date_to_xmlschema(date) if date
+        end
+      end
+
+      def date_published
+        @date_published ||= filters.date_to_xmlschema(page["date"]) if page["date"]
+      end
+
+      def type
+        @type ||= begin
+          if page["seo"] && page["seo"]["type"]
+            page["seo"]["type"]
+          elsif homepage_or_about?
+            "WebSite"
+          elsif page["date"]
+            "BlogPosting"
+          else
+            "WebPage"
+          end
+        end
+      end
+
+      def links
+        @links ||= begin
+          if page["seo"] && page["seo"]["links"]
+            page["seo"]["links"]
+          elsif homepage_or_about? && site["social"] && site["social"]["links"]
+            site["social"]["links"]
+          end
+        end
+      end
+
+      def logo
+        @logo ||= begin
+          return unless site["logo"]
+          if absolute_url? site["logo"]
+            filters.uri_escape site["logo"]
+          else
+            filters.uri_escape filters.absolute_url site["logo"]
+          end
+        end
+      end
+
+      # Returns nil or a hash representing the page image
+      # The image hash will always contain a path, pulled from:
+      #
+      # 1. The `image` key if it's a string
+      # 2. The `image.path` key if it's a hash
+      # 3. The `image.facebook` key
+      # 4. The `image.twitter` key
+      #
+      # The resulting path is always an absolute URL
+      def image
+        return @image if defined?(@image)
+
+        image = page["image"]
+        return @image = nil unless image
+
+        image = { "path" => image } if image.is_a?(String)
+        image["path"] ||= image["facebook"] || image["twitter"]
+
+        unless absolute_url? image["path"]
+          image["path"] = filters.absolute_url image["path"]
+        end
+
+        image["path"] = filters.uri_escape image["path"]
+
+        @image = image.to_liquid
+      end
+
+      def page_lang
+        @page_lang ||= page["lang"] || site["lang"] || "en_US"
+      end
+
+      def canonical_url
+        @canonical_url ||= filters.absolute_url(page["url"]).gsub(%r!/index\.html$!, "/")
+      end
+
+      private
+
+      def filters
+        @filters ||= Jekyll::SeoTag::Filters.new(@context)
+      end
+
+      def page
+        @page ||= @context.registers[:page].to_liquid
+      end
+
+      def site
+        @site ||= @context.registers[:site].site_payload["site"].to_liquid
+      end
+
+      def homepage_or_about?
+        page["url"] =~ HOMEPAGE_OR_ABOUT_REGEX
+      end
+
+      attr_reader :context
+
+      def fallback_data
+        @fallback_data ||= {}
+      end
+
+      def absolute_url?(string)
+        Addressable::URI.parse(string).absolute?
+      end
+
+      def format_string(string)
+        string = FORMAT_STRING_METHODS.reduce(string) do |memo, method|
+          filters.public_send(method, memo)
+        end
+
+        string unless string.empty?
+      end
+
+      def author_string_or_hash
+        @author_string_or_hash ||= begin
+          author = page["author"]
+          author = page["authors"][0] if author.to_s.empty? && page["authors"]
+          author = site["author"] if author.to_s.empty?
+          author
+        end
+      end
+
+      def author_hash(author_string)
+        if site.data["authors"] && site.data["authors"][author_string]
+          hash = site.data["authors"][author_string]
+          hash["name"]    ||= author_string
+          hash["twitter"] ||= author_string
+          hash
+        else
+          { "name" => author_string }
+        end
+      end
+
+      def seo_name
+        @seo_name ||= format_string(page["seo"]["name"]) if page["seo"]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Jekyll
+  class SeoTag
+    class Filters
+      include Jekyll::Filters
+      include Liquid::StandardFilters
+
+      def initialize(context)
+        @context = context
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+module Jekyll
+  class SeoTag
+    module JSONLD
+
+      # A hash of instance methods => key in resulting JSON-LD hash
+      METHODS_KEYS = {
+        :json_context   => "@context",
+        :type           => "@type",
+        :name           => "name",
+        :page_title     => "headline",
+        :json_author    => "author",
+        :json_image     => "image",
+        :date_published => "datePublished",
+        :date_modified  => "dateModified",
+        :description    => "description",
+        :publisher      => "publisher",
+        :main_entity    => "mainEntityOfPage",
+        :links          => "sameAs",
+        :canonical_url  => "url",
+      }.freeze
+
+      def json_ld
+        @json_ld ||= begin
+          output = {}
+          METHODS_KEYS.each do |method, key|
+            value = send(method)
+            output[key] = value unless value.nil?
+          end
+          output
+        end
+      end
+
+      private
+
+      def json_context
+        "http://schema.org"
+      end
+
+      def json_author
+        return unless author
+        {
+          "@type" => "Person",
+          "name"  => author["name"],
+        }
+      end
+
+      def json_image
+        return unless image
+        return image["path"] if image.length == 1
+
+        hash = image.dup
+        hash["url"]   = hash.delete("path")
+        hash["@type"] = "imageObject"
+        hash
+      end
+
+      def publisher
+        return unless logo
+        output = {
+          "@type" => "Organization",
+          "logo"  => {
+            "@type" => "ImageObject",
+            "url"   => logo,
+          },
+        }
+        output["name"] = author["name"] if author
+        output
+      end
+
+      def main_entity
+        return unless %w(BlogPosting CreativeWork).include?(type)
+        {
+          "@type" => "WebPage",
+          "@id"   => canonical_url,
+        }
+      end
+    end
+  end
+end

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.2.0".freeze
+    VERSION = "2.2.1".freeze
   end
 end

data/lib/template.html

@@ -1,143 +1,39 @@
 <!-- Begin Jekyll SEO tag v{{ seo_tag.version }} -->
-
-{% if page.url == "/" or page.url == "/about/" %}
-  {% assign seo_homepage_or_about = true %}
-{% endif %}
-
-{% assign seo_site_title = site.title | default: site.name %}
-{% assign seo_page_title = page.title | default: seo_site_title %}
-{% assign seo_title = page.title | default: seo_site_title %}
-
-{% if page.title and seo_site_title %}
-  {% assign seo_title = page.title | append:" | " | append: seo_site_title %}
-{% elsif site.description and seo_site_title %}
-  {% assign seo_title = seo_site_title | append:" | " | append: site.description %}
-{% endif %}
-
-{% if page.seo and page.seo.name %}
-    {% assign seo_name = page.seo.name %}
-{% elsif seo_homepage_or_about and site.social and site.social.name %}
-    {% assign seo_name = site.social.name %}
-{% elsif seo_homepage_or_about and seo_site_title %}
-    {% assign seo_name = seo_site_title %}
-{% endif %}
-{% if seo_name %}
-  {% assign seo_name = seo_name | smartify | strip_html | normalize_whitespace | escape_once %}
-{% endif %}
-
-{% if seo_title %}
-  {% 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 | normalize_whitespace | escape_once %}
-{% endif %}
-
-{% if seo_page_title %}
-  {% 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 | normalize_whitespace | escape_once %}
-{% endif %}
-
-{% assign seo_author = page.author | default: page.authors[0] | default: site.author %}
-{% if seo_author %}
-  {% if seo_author.name %}
-    {% assign seo_author_name = seo_author.name %}
-  {% else %}
-    {% if site.data.authors and site.data.authors[seo_author] %}
-      {% assign seo_author_name = site.data.authors[seo_author].name %}
-    {% else %}
-      {% assign seo_author_name = seo_author  %}
-    {% endif %}
-  {% endif %}
-  {% if seo_author.twitter %}
-    {% assign seo_author_twitter = seo_author.twitter %}
-  {% else %}
-    {% if site.data.authors and site.data.authors[seo_author] %}
-      {% assign seo_author_twitter = site.data.authors[seo_author].twitter  %}
-    {% else %}
-      {% assign seo_author_twitter = seo_author  %}
-    {% endif %}
-  {% endif %}
-  {% assign seo_author_twitter = seo_author_twitter | replace:"@","" %}
-{% endif %}
-
-{% if page.date_modified or page.last_modified_at or page.date %}
-  {% assign seo_date_modified = page.seo.date_modified | default: page.last_modified_at %}
-{% endif %}
-
-{% if page.seo and page.seo.type %}
-    {% assign seo_type = page.seo.type %}
-{% elsif seo_homepage_or_about %}
-    {% assign seo_type = "WebSite" %}
-{% elsif page.date %}
-    {% assign seo_type = "BlogPosting" %}
-{% else %}
-    {% assign seo_type = "WebPage" %}
-{% endif %}
-
-{% if page.seo and page.seo.links %}
-    {% assign seo_links = page.seo.links %}
-{% elsif seo_homepage_or_about and site.social and site.social.links %}
-    {% assign seo_links = site.social.links %}
-{% endif %}
-
-{% if site.logo %}
-  {% assign seo_site_logo = site.logo %}
-  {% unless seo_site_logo contains "://" %}
-    {% assign seo_site_logo = seo_site_logo | absolute_url %}
-  {% endunless %}
-  {% assign seo_site_logo = seo_site_logo | escape %}
-{% endif %}
-
-{% if page.image %}
-  {% assign seo_page_image = page.image.path | default: page.image.facebook | default: page.image.twitter | default: page.image %}
-  {% unless seo_page_image contains "://" %}
-    {% assign seo_page_image = seo_page_image | absolute_url %}
-  {% endunless %}
-  {% assign seo_page_image = seo_page_image | escape %}
+{% if seo_tag.title? %}
+  <title>{{ seo_tag.title }}</title>
 {% endif %}
 
-{% assign seo_page_lang = page.lang | default: site.lang | default: "en_US" %}
-
-{% if seo_tag.title and seo_title %}
-  <title>{{ seo_title }}</title>
-{% endif %}
-
-{% if seo_page_title %}
-  <meta property="og:title" content="{{ seo_page_title }}" />
+{% if seo_tag.page_title %}
+  <meta property="og:title" content="{{ seo_tag.page_title }}" />
 {% endif %}
 
-{% if seo_author_name %}
-  <meta name="author" content="{{ seo_author_name }}" />
+{% if seo_tag.author.name %}
+  <meta name="author" content="{{ seo_tag.author.name }}" />
 {% endif %}
 
-<meta property="og:locale" content="{{ seo_page_lang | replace:'-','_' }}" />
+<meta property="og:locale" content="{{ seo_tag.page_lang | replace:'-','_' }}" />
 
-{% if seo_description %}
-  <meta name="description" content="{{ seo_description }}" />
-  <meta property="og:description" content="{{ seo_description }}" />
+{% if seo_tag.description %}
+  <meta name="description" content="{{ seo_tag.description }}" />
+  <meta property="og:description" content="{{ seo_tag.description }}" />
 {% endif %}
 
-{% 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 }}" />
+{% if site.url %}
+  <link rel="canonical" href="{{ seo_tag.canonical_url }}" />
+  <meta property="og:url" content="{{ seo_tag.canonical_url }}" />
 {% endif %}
 
-{% if seo_site_title %}
-  <meta property="og:site_name" content="{{ seo_site_title }}" />
+{% if seo_tag.site_title %}
+  <meta property="og:site_name" content="{{ seo_tag.site_title }}" />
 {% endif %}
 
-{% if seo_page_image %}
-  <meta property="og:image" content="{{ seo_page_image }}" />
-  {% if page.image.height %}
-    <meta property="og:image:height" content="{{ page.image.height }}" />
+{% if seo_tag.image %}
+  <meta property="og:image" content="{{ seo_tag.image.path }}" />
+  {% if seo_tag.image.height %}
+    <meta property="og:image:height" content="{{ seo_tag.image.height }}" />
   {% endif %}
-  {% if page.image.width %}
-    <meta property="og:image:width" content="{{ page.image.width }}" />
+  {% if seo_tag.image.width %}
+    <meta property="og:image:width" content="{{ seo_tag.image.width }}" />
   {% endif %}
 {% endif %}
 
@@ -154,7 +50,7 @@
 {% endif %}
 
 {% if site.twitter %}
-  {% if seo_page_image or page.image.twitter %}
+  {% if seo_tag.image %}
     <meta name="twitter:card" content="summary_large_image" />
   {% else %}
     <meta name="twitter:card" content="summary" />
@@ -162,8 +58,8 @@
 
   <meta name="twitter:site" content="@{{ site.twitter.username | replace:"@","" }}" />
 
-  {% if seo_author_twitter %}
-    <meta name="twitter:creator" content="@{{ seo_author_twitter }}" />
+  {% if seo_tag.author.twitter %}
+    <meta name="twitter:creator" content="@{{ seo_tag.author.twitter }}" />
   {% endif %}
 {% endif %}
 
@@ -185,12 +81,15 @@
   {% if site.webmaster_verifications.google %}
     <meta name="google-site-verification" content="{{ site.webmaster_verifications.google }}">
   {% endif %}
+
   {% if site.webmaster_verifications.bing %}
     <meta name="msvalidate.01" content="{{ site.webmaster_verifications.bing }}">
   {% endif %}
+
   {% if site.webmaster_verifications.alexa %}
     <meta name="alexaVerifyID" content="{{ site.webmaster_verifications.alexa }}">
   {% endif %}
+
   {% if site.webmaster_verifications.yandex %}
     <meta name="yandex-verification" content="{{ site.webmaster_verifications.yandex }}">
   {% endif %}
@@ -198,72 +97,8 @@
   <meta name="google-site-verification" content="{{ site.google_site_verification }}" />
 {% endif %}
 
-
 <script type="application/ld+json">
-  {
-    "@context": "http://schema.org",
-
-{% if seo_type %}
-    "@type": {{ seo_type | jsonify }},
-{% endif %}
-
-{% if seo_name %}
-    "name": {{ seo_name | jsonify }},
-{% endif %}
-
-{% if seo_page_title %}
-    "headline": {{ seo_page_title | jsonify }},
-{% endif %}
-
-{% if seo_author %}
-    "author": {
-       "@type": "Person",
-       "name": {{ seo_author | jsonify }}
-    },
-{% endif %}
-
-{% if seo_page_image %}
-    "image": {{ seo_page_image | jsonify }},
-{% endif %}
-
-{% if page.date %}
-    "datePublished": {{ page.date | date_to_xmlschema | jsonify }},
-{% endif %}
-
-{% if seo_date_modified %}
-    "dateModified": {{ seo_date_modified | date_to_xmlschema | jsonify }},
-{% endif %}
-
-{% if seo_description %}
-    "description": {{ seo_description | jsonify }},
-{% endif %}
-
-{% if seo_site_logo %}
-    "publisher": {
-        "@type": "Organization",
-        {% if seo_author %}
-            "name": {{ seo_author | jsonify }},
-        {% endif %}
-        "logo": {
-            "@type": "ImageObject",
-            "url": {{ seo_site_logo | jsonify }}
-        }
-    },
-{% endif %}
-
-{% if seo_type == "BlogPosting" or seo_type == "CreativeWork"%}
-    "mainEntityOfPage": {
-        "@type": "WebPage",
-        "@id": {{ page.url | replace:'/index.html','/' | absolute_url | jsonify }}
-    },
-{% endif %}
-
-{% if seo_links %}
-    "sameAs": {{ seo_links | jsonify }},
-{% endif %}
-
-    "url": {{ page.url | replace:'/index.html','/' | absolute_url | jsonify }}
-  }
+  {{ seo_tag.json_ld | jsonify }}
 </script>
 
 <!-- End Jekyll SEO tag -->

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-seo-tag
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -97,6 +97,9 @@ files:
 - README.md
 - jekyll-seo-tag.gemspec
 - lib/jekyll-seo-tag.rb
+- lib/jekyll-seo-tag/drop.rb
+- lib/jekyll-seo-tag/filters.rb
+- lib/jekyll-seo-tag/json_ld.rb
 - lib/jekyll-seo-tag/version.rb
 - lib/template.html
 - script/bootstrap
@@ -123,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to add metadata tags for search engines and social networks