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.


17
18
19
20
21
22
# File 'lib/jekyll-seo-tag/drop.rb', line 17

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

Instance Method Details

#authorObject

A drop representing the page author


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

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

#canonical_urlObject


168
169
170
171
172
173
174
175
176
# File 'lib/jekyll-seo-tag/drop.rb', line 168

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_modifiedObject


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

def date_modified
  @date_modified ||= begin
    date = page_seo["date_modified"] || page["last_modified_at"].to_liquid || page["date"]
    filters.date_to_xmlschema(date) if date
  end
end

#date_publishedObject


120
121
122
# File 'lib/jekyll-seo-tag/drop.rb', line 120

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

#descriptionObject


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

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

#imageObject

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


108
109
110
111
# File 'lib/jekyll-seo-tag/drop.rb', line 108

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

#json_ldObject

A drop representing the JSON-LD output


102
103
104
# File 'lib/jekyll-seo-tag/drop.rb', line 102

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

138
139
140
141
142
143
144
145
146
# File 'lib/jekyll-seo-tag/drop.rb', line 138

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

#logoObject


148
149
150
151
152
153
154
155
156
157
158
# File 'lib/jekyll-seo-tag/drop.rb', line 148

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

#nameObject

rubocop:enable Metrics/CyclomaticComplexity


76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/jekyll-seo-tag/drop.rb', line 76

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_langObject


160
161
162
# File 'lib/jekyll-seo-tag/drop.rb', line 160

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

#page_localeObject


164
165
166
# File 'lib/jekyll-seo-tag/drop.rb', line 164

def page_locale
  @page_locale ||= (page["locale"] || site["locale"] || page_lang).tr("-", "_")
end

#page_titleObject

Page title without site title or description appended


49
50
51
# File 'lib/jekyll-seo-tag/drop.rb', line 49

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

#site_descriptionObject


44
45
46
# File 'lib/jekyll-seo-tag/drop.rb', line 44

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

#site_taglineObject


40
41
42
# File 'lib/jekyll-seo-tag/drop.rb', line 40

def site_tagline
  @site_tagline ||= format_string site["tagline"]
end

#site_tagline_or_descriptionObject


53
54
55
# File 'lib/jekyll-seo-tag/drop.rb', line 53

def site_tagline_or_description
  site_tagline || site_description
end

#site_titleObject


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

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

#titleObject

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


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/jekyll-seo-tag/drop.rb', line 59

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_tagline_or_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)

29
30
31
32
33
34
# File 'lib/jekyll-seo-tag/drop.rb', line 29

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

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

#typeObject


124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/jekyll-seo-tag/drop.rb', line 124

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

#versionObject


24
25
26
# File 'lib/jekyll-seo-tag/drop.rb', line 24

def version
  Jekyll::SeoTag::VERSION
end