Class: Jekyll::SeoTag::Drop

Inherits:
Drops::Drop
  • Object
show all
Includes:
UrlHelper
Defined in:
lib/jekyll-seo-tag/drop.rb

Constant Summary collapse

TITLE_SEPARATOR = 
" | "
FORMAT_STRING_METHODS = 
[
  :markdownify, :strip_html, :normalize_whitespace, :escape_once,
].freeze
HOMEPAGE_OR_ABOUT_REGEX = 
%r!^/(about/)?(index.html?)?$!.freeze

Instance Method Summary collapse

Constructor Details

#initialize(text, context) ⇒ Drop

Returns a new instance of Drop.



14
15
16
17
18
19
 
# File 'lib/jekyll-seo-tag/drop.rb', line 14

def initialize(text, context)
  @obj = {}
  @mutations = {}
  @text    = text
  @context = context
end

Instance Method Details

#author ⇒ Object

A drop representing the page author



86
87
88
 
# File 'lib/jekyll-seo-tag/drop.rb', line 86

def author
  @author ||= AuthorDrop.new(:page => page, :site => site)
end

#canonical_url ⇒ Object 



159
160
161
162
163
164
165
166
167
 
# File 'lib/jekyll-seo-tag/drop.rb', line 159

def canonical_url
  @canonical_url ||= begin
    if page["canonical_url"].to_s.empty?
      filters.absolute_url(page["url"]).to_s.gsub(%r!/index\.html$!, "/")
    else
      page["canonical_url"]
    end
  end
end

#date_modified ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/jekyll-seo-tag/drop.rb', line 102

def date_modified
  @date_modified ||= begin
    date = if 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

#date_published ⇒ Object 



115
116
117
 
# File 'lib/jekyll-seo-tag/drop.rb', line 115

def date_published
  @date_published ||= filters.date_to_xmlschema(page["date"]) if page["date"]
end

#description ⇒ Object 



79
80
81
82
83
 
# File 'lib/jekyll-seo-tag/drop.rb', line 79

def description
  @description ||= begin
    format_string(page["description"] || page["excerpt"]) || site_description
  end
end

#image ⇒ Object

Returns a Drop representing the page’s image Returns nil if the image has no path, to preserve backwards compatability



97
98
99
100
 
# File 'lib/jekyll-seo-tag/drop.rb', line 97

def image
  @image ||= ImageDrop.new(:page => page, :context => @context)
  @image if @image.path
end

#json_ld ⇒ Object

A drop representing the JSON-LD output



91
92
93
 
# File 'lib/jekyll-seo-tag/drop.rb', line 91

def json_ld
  @json_ld ||= JSONLDDrop.new(self)
end

#links ⇒ Object 



133
134
135
136
137
138
139
140
141
 
# File 'lib/jekyll-seo-tag/drop.rb', line 133

def links
  @links ||= begin
    if page_seo["links"]
      page_seo["links"]
    elsif homepage_or_about? && site_social["links"]
      site_social["links"]
    end
  end
end

#logo ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/jekyll-seo-tag/drop.rb', line 143

def 
  @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

#name ⇒ Object

rubocop:enable Metrics/CyclomaticComplexity



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/jekyll-seo-tag/drop.rb', line 65

def name
  return @name if defined?(@name)

  @name = if seo_name
            seo_name
          elsif !homepage_or_about?
            nil
          elsif site_social["name"]
            format_string site_social["name"]
          elsif site_title
            site_title
          end
end

#page_lang ⇒ Object 



155
156
157
 
# File 'lib/jekyll-seo-tag/drop.rb', line 155

def page_lang
  @page_lang ||= page["lang"] || site["lang"] || "en_US"
end

#page_title ⇒ Object

Page title without site title or description appended



42
43
44
 
# File 'lib/jekyll-seo-tag/drop.rb', line 42

def page_title
  @page_title ||= format_string(page["title"]) || site_title
end

#site_description ⇒ Object 



37
38
39
 
# File 'lib/jekyll-seo-tag/drop.rb', line 37

def site_description
  @site_description ||= format_string site["description"]
end

#site_title ⇒ Object 



33
34
35
 
# File 'lib/jekyll-seo-tag/drop.rb', line 33

def site_title
  @site_title ||= format_string(site["title"] || site["name"])
end

#title ⇒ Object

Page title with site title or description appended rubocop:disable Metrics/CyclomaticComplexity



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/jekyll-seo-tag/drop.rb', line 48

def title
  @title ||= begin
    if site_title && page_title != site_title
      page_title + TITLE_SEPARATOR + site_title
    elsif site_description && site_title
      site_title + TITLE_SEPARATOR + site_description
    else
      page_title || site_title
    end
  end

  return page_number + @title if page_number

  @title
end

#title? ⇒ Boolean

Should the ‘<title>` tag be generated for this page?

Returns:

  • (Boolean) 


26
27
28
29
30
31
 
# File 'lib/jekyll-seo-tag/drop.rb', line 26

def title?
  return false unless title
  return @display_title if defined?(@display_title)

  @display_title = (@text !~ %r!title=false!i)
end

#type ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/jekyll-seo-tag/drop.rb', line 119

def type
  @type ||= begin
    if page_seo["type"]
      page_seo["type"]
    elsif homepage_or_about?
      "WebSite"
    elsif page["date"]
      "BlogPosting"
    else
      "WebPage"
    end
  end
end

#version ⇒ Object 



21
22
23
 
# File 'lib/jekyll-seo-tag/drop.rb', line 21

def version
  Jekyll::SeoTag::VERSION
end