Class: Jekyll::ImageLinks::MapRenderer

Inherits:
Object
  • Object
show all
Defined in:
lib/jekyll/image_links/map_renderer.rb

Constant Summary collapse

PORTABLE_FIGURE = 
/<figure\b[^>]*\bdata-jil-map="true"[^>]*>[\s\S]*?<\/figure>/i
PORTABLE_IMAGE = 
/<img\b[^>]*\bclass="[^"]*\bjil-map-image\b[^"]*"[^>]*\/?>(?:\s*<script\b[^>]*\bclass="jil-regions-data"[^>]*>[\s\S]*?<\/script>)?/i
REGIONS_SCRIPT = 
/<script\b[^>]*\bclass="jil-regions-data"[^>]*>([\s\S]*?)<\/script>/i

Class Method Summary collapse

Class Method Details

.enhance_html(html, site:, page:, cfg:) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/jekyll/image_links/map_renderer.rb', line 20

def enhance_html(html, site:, page:, cfg:)
  return html unless portable_markup?(html)

  html = html.gsub(PORTABLE_FIGURE) do |figure_html|
    enhance_portable_markup(figure_html, site: site, page: page, cfg: cfg)
  rescue StandardError => e
    Jekyll.logger.warn("jekyll-image-links:", "Failed to enhance portable figure: #{e.message}")
    figure_html
  end

  html.gsub(PORTABLE_IMAGE) do |image_html|
    next image_html unless portable_image?(image_html)

    enhance_portable_markup(image_html, site: site, page: page, cfg: cfg)
  rescue StandardError => e
    Jekyll.logger.warn("jekyll-image-links:", "Failed to enhance portable image map: #{e.message}")
    image_html
  end
end

.portable_markup?(html) ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
17
18
 
# File 'lib/jekyll/image_links/map_renderer.rb', line 14

def portable_markup?(html)
  return true if html.include?('data-jil-map="true"')

  html.scan(PORTABLE_IMAGE).any? { |fragment| portable_image?(fragment) }
end

.render_interactive(map_data, viewer:, inline:, labels:, alt:, display_style: nil) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/jekyll/image_links/map_renderer.rb', line 86

def render_interactive(map_data, viewer:, inline:, labels:, alt:, display_style: nil)
  map_json = JSON.generate(map_data)
  id = "jil-map-#{Digest::MD5.hexdigest(map_json)[0, 8]}"
  title = map_data["title"]
  caption_html = title ? %(<div class="jil-caption">#{escape_html(title)}</div>) : ""
  img_attrs = render_img_attrs(
    src: map_data["src"],
    alt: alt,
    native_width: nil,
    native_height: nil
  )
  host_class = "jil-map-host"
  host_class += " jil-height-constrained" if display_style.to_s.match?(/(?:^|;|\s)max-height\s*:/i)
  host_style_attr = display_style.to_s.strip.empty? ? "" : %( style="#{escape_attr(display_style)}")

  <<~HTML.strip
    <div class="jil-figure" data-jil-image-map="true"><div class="#{host_class}" id="#{id}" data-jil-map="#{escape_attr(map_json)}" data-jil-viewer="#{viewer}" data-jil-inline="#{inline}" data-jil-labels="#{labels}"#{host_style_attr.empty? ? "" : " #{host_style_attr}"}><img class="jil-map-image" #{img_attrs} loading="lazy" /></div>#{caption_html}</div>
  HTML
end

.render_portable_figure(attrs, site:, page: nil, liquid_context: nil, cfg: {}, regions_body: nil) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/jekyll/image_links/map_renderer.rb', line 40

def render_portable_figure(attrs, site:, page: nil, liquid_context: nil, cfg: {}, regions_body: nil)
  src = attrs["src"].to_s
  title = attrs["title"]
  alt = attrs["alt"] || title
  regions_file = attrs["file"]
  viewer = attrs["viewer"]
  inline = attrs["inline"]
  labels = attrs["labels"]

  resolved_src = resolve_url(src, site: site, page: page, liquid_context: liquid_context)
  map_source = load_map_source(
    site: site,
    regions_file: regions_file,
    regions_body: regions_body
  )
  native_from_source = native_dimensions_present?(map_source)
  display_style = build_display_style(attrs, native_from_source: native_from_source)

  regions_attr = regions_file ? %( data-jil-regions="#{escape_attr(regions_file)}") : ""
  viewer_attr = %( data-jil-viewer="#{viewer}") unless viewer.nil? || viewer.empty?
  inline_attr = %( data-jil-inline="#{inline}") unless inline.nil? || inline.empty?
  labels_attr = %( data-jil-labels="#{labels}") unless labels.nil? || labels.empty?
  title_attr = title ? %( data-jil-title="#{escape_attr(title)}") : ""

  regions_script = ""
  if regions_body && !regions_body.strip.empty? && regions_file.to_s.strip.empty?
    regions_script = %(\n<script type="application/yaml" class="jil-regions-data">#{regions_body.strip}\n</script>)
  end

  img_markup = render_img_attrs(
    src: resolved_src,
    alt: alt,
    native_width: native_from_source ? nil : attrs["width"],
    native_height: native_from_source ? nil : attrs["height"]
  )
  style_attr = display_style.empty? ? "" : %( style="#{escape_attr(display_style)}")

  <<~HTML.strip
    <img
      class="jil-map-image"
      #{img_markup}#{style_attr}
      loading="lazy"#{title_attr}#{regions_attr}#{viewer_attr}#{inline_attr}#{labels_attr}
    />#{regions_script}
  HTML
end