class Jekyll::SeoTag::JSONLDDrop

Constants

VALID_AUTHOR_TYPES
VALID_ENTITY_TYPES

Attributes

page_drop[R]

Public Class Methods

new(page_drop) click to toggle source

page_drop should be an instance of Jekyll::SeoTag::Drop

# File lib/jekyll-seo-tag/json_ld_drop.rb, line 27
def initialize(page_drop)
  @mutations = {}
  @page_drop = page_drop
end

Public Instance Methods

author() click to toggle source
# File lib/jekyll-seo-tag/json_ld_drop.rb, line 38
def author
  return unless page_drop.author["name"]

  author_type = page_drop.author["type"]
  return if author_type && !VALID_AUTHOR_TYPES.include?(author_type)

  hash = {
    "@type" => author_type || "Person",
    "name"  => page_drop.author["name"],
  }

  author_url = page_drop.author["url"]
  hash["url"] = author_url if author_url

  hash
end
fallback_data() click to toggle source
# File lib/jekyll-seo-tag/json_ld_drop.rb, line 32
def fallback_data
  @fallback_data ||= {
    "@context" => "https://schema.org",
  }
end
image() click to toggle source
# File lib/jekyll-seo-tag/json_ld_drop.rb, line 55
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
mainEntityOfPage()
Alias for: main_entity
publisher() click to toggle source
# File lib/jekyll-seo-tag/json_ld_drop.rb, line 65
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
to_json(state = nil) click to toggle source

Returns a JSON-encoded object containing the JSON-LD data. Keys are sorted.

# File lib/jekyll-seo-tag/json_ld_drop.rb, line 92
def to_json(state = nil)
  keys.sort.each_with_object({}) do |(key, _), result|
    v = self[key]
    result[key] = v unless v.nil?
  end.to_json(state)
end

Private Instance Methods

main_entity() click to toggle source
# File lib/jekyll-seo-tag/json_ld_drop.rb, line 79
def main_entity
  return unless VALID_ENTITY_TYPES.include?(type)

  {
    "@type" => "WebPage",
    "@id"   => page_drop.canonical_url,
  }
end
Also aliased as: mainEntityOfPage