jekyll-soopr-seo-tag 2.7.3

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+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/image_drop.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class SeoTag
+    # A drop representing the page image
+    # The image path will be 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
+    class ImageDrop < Jekyll::Drops::Drop
+      include Jekyll::SeoTag::UrlHelper
+
+      # Initialize a new ImageDrop
+      #
+      # page - The page hash (e.g., Page#to_liquid)
+      # context - the Liquid::Context
+      def initialize(page: nil, context: nil)
+        raise ArgumentError unless page && context
+
+        @mutations = {}
+        @page = page
+        @context = context
+      end
+
+      # Called path for backwards compatability, this is really
+      # the escaped, absolute URL representing the page's image
+      # Returns nil if no image path can be determined
+      def path
+        @path ||= filters.uri_escape(absolute_url) if absolute_url
+      end
+      alias_method :to_s, :path
+
+      private
+
+      attr_accessor :page
+      attr_accessor :context
+
+      # The normalized image hash with a `path` key (which may be nil)
+      def image_hash
+        @image_hash ||= begin
+          image_meta = page["image"]
+
+          if image_meta.is_a?(Hash)
+            { "path" => nil }.merge!(image_meta)
+          elsif image_meta.is_a?(String)
+            { "path" => image_meta }
+          else
+            { "path" => nil }
+          end
+        end
+      end
+      alias_method :fallback_data, :image_hash
+
+      def raw_path
+        @raw_path ||= begin
+          image_hash["path"] || image_hash["facebook"] || image_hash["twitter"]
+        end
+      end
+
+      def absolute_url
+        return unless raw_path
+        return @absolute_url if defined? @absolute_url
+
+        @absolute_url = if raw_path.is_a?(String) && absolute_url?(raw_path) == false
+                          filters.absolute_url raw_path
+                        else
+                          raw_path
+                        end
+      end
+
+      def filters
+        @filters ||= Jekyll::SeoTag::Filters.new(context)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class SeoTag
+    # This module is deprecated, but is included in the Gem to avoid a breaking
+    # change and should be removed at the next major version bump
+    module JSONLD
+      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
+
+      # Self should be a Jekyll::SeoTag::Drop instance (when extending the module)
+      def json_ld
+        Jekyll.logger.warn "Jekyll::SeoTag::JSONLD is deprecated"
+        @json_ld ||= JSONLDDrop.new(self)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class SeoTag
+    class JSONLDDrop < Jekyll::Drops::Drop
+      extend Forwardable
+
+      def_delegator :page_drop, :name,           :name
+      def_delegator :page_drop, :description,    :description
+      def_delegator :page_drop, :canonical_url,  :url
+      def_delegator :page_drop, :page_title,     :headline
+      def_delegator :page_drop, :date_modified,  :dateModified
+      def_delegator :page_drop, :date_published, :datePublished
+      def_delegator :page_drop, :links,          :sameAs
+      def_delegator :page_drop, :logo,           :logo
+      def_delegator :page_drop, :type,           :type
+
+      # Expose #type and #logo as private methods and #@type as a public method
+      alias_method :"@type", :type
+      private :type
+      private :logo
+
+      VALID_ENTITY_TYPES = %w(BlogPosting CreativeWork).freeze
+      VALID_AUTHOR_TYPES = %w(Organization Person).freeze
+      private_constant :VALID_ENTITY_TYPES, :VALID_AUTHOR_TYPES
+
+      # page_drop should be an instance of Jekyll::SeoTag::Drop
+      def initialize(page_drop)
+        @mutations = {}
+        @page_drop = page_drop
+      end
+
+      def fallback_data
+        @fallback_data ||= {
+          "@context" => "https://schema.org",
+        }
+      end
+
+      def author
+        return unless page_drop.author["name"]
+
+        author_type = page_drop.author["type"]
+        return if author_type && !VALID_AUTHOR_TYPES.include?(author_type)
+
+        {
+          "@type" => author_type || "Person",
+          "name"  => page_drop.author["name"],
+        }
+      end
+
+      def image
+        return unless page_drop.image
+        return page_drop.image.path if page_drop.image.keys.length == 1
+
+        hash = page_drop.image.to_h
+        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"] = page_drop.author.name if page_drop.author.name
+        output
+      end
+
+      def main_entity
+        return unless VALID_ENTITY_TYPES.include?(type)
+
+        {
+          "@type" => "WebPage",
+          "@id"   => page_drop.canonical_url,
+        }
+      end
+      alias_method :mainEntityOfPage, :main_entity
+      private :main_entity
+
+      def to_json
+        to_h.reject { |_k, v| v.nil? }.to_json
+      end
+
+      private
+
+      attr_reader :page_drop
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class SeoTag
+    # A drop representing soopr and soopr's publish token
+    # The publish key will be pulled from:
+    #
+    # 1. The `soopr` key if it's a string
+    # 2. The `soopr.publish_token`  if it's a hash
+    # 3. The `soopr.publish_key`  if it's a hash
+    class SooprDrop < Jekyll::Drops::Drop
+
+      # Initialize a new SooprDrop
+      #
+      # page - The page hash (e.g., Page#to_liquid)
+      # context - the Liquid::Context
+      def initialize(page: nil, site: nil)
+        raise ArgumentError unless page && site
+
+        @mutations = {}
+        @page = page
+        @site = site
+      end
+
+      def publish_token
+        soopr_hash["publish_token"] || soopr_hash["publish_key"] 
+      end
+      alias_method :to_s, :publish_token
+
+      private
+
+      attr_reader :page
+      attr_reader :site
+
+
+      def soopr_hash
+        @soopr_hash ||= begin
+          return {} unless site["soopr"].is_a?(Hash)
+
+          soopr_hash = site["soopr"]
+          soopr_hash.is_a?(Hash) ? soopr_hash : {}
+        end
+      end
+
+      # Since author_hash is aliased to fallback_data, any values in the hash
+      # will be exposed via the drop, allowing support for arbitrary metadata
+      alias_method :fallback_data, :soopr_hash
+    end
+
+    def filters
+      @filters ||= Jekyll::SeoTag::Filters.new(context)
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class SeoTag
+    # Mixin to share common URL-related methods between class
+    module UrlHelper
+      private
+
+      # Determines if the given string is an absolute URL
+      #
+      # Returns true if an absolute URL.
+      # Retruns false if it's a relative URL
+      # Returns nil if it is not a string or can't be parsed as a URL
+      def absolute_url?(string)
+        return unless string
+
+        Addressable::URI.parse(string).absolute?
+      rescue Addressable::URI::InvalidURIError
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Prevent bundler errors
+module Liquid; class Tag; end; end
+
+module Jekyll
+  class SeoTag < Liquid::Tag
+    VERSION = "2.7.3"
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll-seo-tag/version"
+
+module Jekyll
+  class SeoTag < Liquid::Tag
+    autoload :JSONLD,     "jekyll-seo-tag/json_ld"
+    autoload :AuthorDrop, "jekyll-seo-tag/author_drop"
+    autoload :ImageDrop,  "jekyll-seo-tag/image_drop"
+    autoload :JSONLDDrop, "jekyll-seo-tag/json_ld_drop"
+    autoload :UrlHelper,  "jekyll-seo-tag/url_helper"
+    autoload :Drop,       "jekyll-seo-tag/drop"
+    autoload :Filters,    "jekyll-seo-tag/filters"
+    autoload :SooprDrop,  "jekyll-seo-tag/soopr_drop"
+
+
+    attr_accessor :context
+
+    # 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+(?\!-)!.freeze
+
+    def initialize(_tag_name, text, _tokens)
+      super
+      @text = text
+    end
+
+    def render(context)
+      @context = context
+      SeoTag.template.render!(payload, info)
+    end
+
+    private
+
+    def options
+      {
+        "version" => Jekyll::SeoTag::VERSION,
+        "title"   => title?,
+      }
+    end
+
+    def payload
+      # site_payload is an instance of UnifiedPayloadDrop. See https://git.io/v5ajm
+      context.registers[:site].site_payload.tap do |site_payload|
+        site_payload["page"]      = context.registers[:page]
+        site_payload["paginator"] = context["paginator"]
+        site_payload["seo_tag"]   = drop
+      end
+    end
+
+    def drop
+      if context.registers[:site].liquid_renderer.respond_to?(:cache)
+        Jekyll::SeoTag::Drop.new(@text, @context)
+      else
+        @drop ||= Jekyll::SeoTag::Drop.new(@text, @context)
+      end
+    end
+
+    def info
+      {
+        :registers => context.registers,
+        :filters   => [Jekyll::Filters],
+      }
+    end
+
+    class << self
+      def template
+        @template ||= Liquid::Template.parse template_contents
+      end
+
+      private
+
+      def template_contents
+        @template_contents ||= begin
+          File.read(template_path).gsub(MINIFY_REGEX, "")
+        end
+      end
+
+      def template_path
+        @template_path ||= begin
+          File.expand_path "./template.html", File.dirname(__FILE__)
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("seo", Jekyll::SeoTag)

data/lib/template.html

@@ -0,0 +1,125 @@
+<!-- Begin Jekyll SEO tag v{{ seo_tag.version }} -->
+{% if seo_tag.title? %}
+  <title>{{ seo_tag.title }}</title>
+{% endif %}
+
+<meta name="generator" content="Jekyll v{{ jekyll.version }}" />
+
+{% if seo_tag.page_title %}
+  <meta property="og:title" content="{{ seo_tag.page_title }}" />
+{% endif %}
+
+{% if seo_tag.author.name %}
+  <meta name="author" content="{{ seo_tag.author.name }}" />
+{% endif %}
+
+<meta property="og:locale" content="{{ seo_tag.page_locale }}" />
+
+{% if seo_tag.description %}
+  <meta name="description" content="{{ seo_tag.description }}" />
+  <meta property="og:description" content="{{ seo_tag.description }}" />
+{% endif %}
+
+{% if site.url %}
+  <link rel="canonical" href="{{ seo_tag.canonical_url }}" />
+  <meta property="og:url" content="{{ seo_tag.canonical_url }}" />
+{% endif %}
+
+{% if seo_tag.site_title %}
+  <meta property="og:site_name" content="{{ seo_tag.site_title }}" />
+{% endif %}
+
+{% if seo_tag.image && seo_tag.image.path %}
+  <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 seo_tag.image.width %}
+    <meta property="og:image:width" content="{{ seo_tag.image.width }}" />
+  {% endif %}
+{% elsif seo_tag.soopr %}
+  <meta property="og:image" content="https://soopr.xyz/images/card?url={{ seo_tag.canonical_url }}" />
+{% endif %}
+
+{% if page.date %}
+  <meta property="og:type" content="article" />
+  <meta property="article:published_time" content="{{ page.date | date_to_xmlschema }}" />
+{% endif %}
+
+{% if paginator.previous_page %}
+  <link rel="prev" href="{{ paginator.previous_page_path | absolute_url }}" />
+{% endif %}
+{% if paginator.next_page %}
+  <link rel="next" href="{{ paginator.next_page_path | absolute_url }}" />
+{% endif %}
+
+
+{% if seo_tag.image %}
+  <meta name="twitter:card" content="{{ page.twitter.card | default: site.twitter.card | default: "summary_large_image" }}" />
+  <meta property="twitter:image" content="{{ seo_tag.image.path }}" />
+{% elsif seo_tag.soopr %}
+  <meta name="twitter:card" content="summary_large_image" />
+  <meta property="og:image" content="https://soopr.xyz/images/card?url={{ seo_tag.canonical_url }}" />
+{% else %}
+  <meta name="twitter:card" content="summary" />
+{% endif %}
+
+{% if seo_tag.page_title %}
+  <meta property="twitter:title" content="{{ seo_tag.page_title }}" />
+{% endif %}
+
+{% if site.twitter %}
+  <meta name="twitter:site" content="@{{ site.twitter.username | remove:'@' }}" />
+
+  {% if seo_tag.author.twitter %}
+    <meta name="twitter:creator" content="@{{ seo_tag.author.twitter | remove:'@' }}" />
+  {% endif %}
+{% endif %}
+
+{% if site.facebook %}
+  {% if site.facebook.admins %}
+    <meta property="fb:admins" content="{{ site.facebook.admins }}" />
+  {% endif %}
+
+  {% if site.facebook.publisher %}
+    <meta property="article:publisher" content="{{ site.facebook.publisher }}" />
+  {% endif %}
+
+  {% if site.facebook.app_id %}
+    <meta property="fb:app_id" content="{{ site.facebook.app_id }}" />
+  {% endif %}
+{% endif %}
+
+{% if site.webmaster_verifications %}
+  {% 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 %}
+
+  {% if site.webmaster_verifications.baidu %}
+    <meta name="baidu-site-verification" content="{{ site.webmaster_verifications.baidu }}" />
+  {% endif %}
+{% elsif site.google_site_verification %}
+  <meta name="google-site-verification" content="{{ site.google_site_verification }}" />
+{% endif %}
+
+<script type="application/ld+json">
+  {{ seo_tag.json_ld | jsonify }}
+</script>
+
+{% if seo_tag.soopr %}
+  <script async defer data-soopr-token="{{seo_tag.soopr.publish_token}}" src="https://sdk.soopr.co/soopr.js"  ></script>
+{% endif %}
+
+<!-- End Jekyll SEO tag -->