jekyll-embed-urls 0.5.15 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec6bd87ed1305e3c6b813f1a17ae6b1f57293f1e53f70052d4a92285f9d10674
-  data.tar.gz: a26acd7ccac02577798927a11d04bf7a6676da9d7b9efcf62c72d0400f10c949
+  metadata.gz: f36b8e03926204a17b34959a0216a6e2fa08a02a57f46826be1daf893865ede0
+  data.tar.gz: 92581158508c23138f1676284762f8df046c601f5b2afff205fbc43c00e691aa
 SHA512:
-  metadata.gz: a197fb8c7458e8e05610a111389d81552371e536ba56ebe7ab94cabc87ffc6c1ad36dfd8448a096cf541dcfe5cb815644503cb82bc1ce0194f9510da60ee752b
-  data.tar.gz: 55dbfd919087ebc2cda92a72e8cb51dcbcd5edfb40cd0f0f14bf5fb76460d32a1cc91477b0756075bf325a2515c6a6969389930cd081342fffdb52be225f99c2
+  metadata.gz: 596771a5208ad6f7abffdda7f4788ec26cd7f1b52bd93988f38bfff7aa64541a109a1ad1e4e814f987f87278bf9d32b00fb348b9a127fc90a0858b110f94bd12
+  data.tar.gz: ed39244b6769b3044e6b00a16666264d22eabea3a50cd97722122a5e18a5534ecbbfeef12267902a76000abc7204f8c2417ee4a52131aee6becf82e10a1d057b

data/README.md

@@ -47,7 +47,8 @@ embed:
   - canvas
   - area
   - map
-# Attribute values can be strings or array of strings
+# Attribute values can be strings or array of strings, or nil/false for
+# removing them, or true to add them without value
   attributes:
     referrerpolicy: strict-origin-when-cross-origin
     sandbox:
@@ -60,6 +61,8 @@ embed:
     - clipboard-write;
     loading: 'lazy'
     controls: true
+    width: nil
+    height: nil
     rel:
     - noopener
     - noreferrer

data/_includes/embed.html

@@ -0,0 +1,11 @@
+{% if page contains "<iframe " %}
+  <div class="embed embed-responsive embed-responsive-16by9 mb-3">
+    {{ page }}
+  </div>
+{% else %}
+  <article class="ogp card mb-3">
+    <div class="card-body">
+      {{ page }}
+    </div>
+  </article>
+{% endif %}

data/_includes/fallback.html

@@ -1,17 +1,13 @@
 {% if page.url contains "//archive.org/" or page.url contains "//www.archive.org/" %}
-  <iframe src="{{ page.url | replace: "/details/", "/embed/" | uri_escape }}"></iframe>
+  <div class="embed-responsive embed-responsive-16by9">
+    <iframe
+      class="embed-responsive-item"
+      allow="{{ embed.allow | join: " " }}"
+      sandbox="{{ embed.sandbox | join: " " }}"
+      loading="{{ embed.loading }}"
+      referrerpolicy="{{ embed.referrerpolicy }}"
+      src="{{ page.url | replace: "/details/", "/embed/" | uri_escape }}"></iframe>
+  </div>
 {% else %}
-  <article class="fallback" lang="{{ page.locale }}">
-    {%- if page.image -%}
-      <img src="{{ page.image | uri_escape }}" class="img-fluid" />
-    {%- endif -%}
-
-    <h1>{{ page.title | escape_once }}</h1>
-    <p class="lead">{{ page.description | escape_once }}</p>
-    <p>
-      <small>
-        <a href="{{ page.url | uri_escape }}">{{ page.url }}</a>
-      </small>
-    </p>
-  </article>
+  {% include ogp.html type="fallback" %}
 {% endif %}

data/_includes/ogp.html

@@ -1,19 +1,41 @@
-<article class="ogp" lang="{{ page.locale }}">
+<article class="{{ include.type | default: "ogp" }} card mb-3" lang="{{ page.locale }}">
   {%- if page.video -%}
-    <video poster="{{ page.image | uri_escape }}" class="img-fluid" src="{{ page.video | uri_escape }}"/>
+    <video
+      {% if embed.controls %}controls{% endif %}
+      poster="{{ page.image | uri_escape }}"
+      preload="none"
+      class="img-fluid"
+      src="{{ page.video | uri_escape }}"/>
   {%- elsif page.image -%}
-    <img src="{{ page.image | uri_escape }}" class="img-fluid" />
+    <img
+      src="{{ page.image | uri_escape }}"
+      class="img-fluid"
+      loading="{{ embed.loading }}"
+      referrerpolicy="{{ embed.referrerpolicy }}" />
   {%- endif -%}
 
   {%- if page.audio -%}
-    <audio class="img-fluid" src="{{ page.audio | uri_escape }}"/>
+    <audio
+      {% if embed.controls %}controls{% endif %}
+      class="w-100"
+      src="{{ page.audio | uri_escape }}"/>
   {%- endif -%}
 
-  <h1>{{ page.title | escape_once }}</h1>
-  <p class="lead">{{ page.description | escape_once }}</p>
-  <p>
-    <small>
-      <a href="{{ page.url | uri_escape }}">{{ page.url }}</a>
-    </small>
-  </p>
+  <header class="card-body">
+    <h1 class="lead">{{ page.title | escape_once | newline_to_br }}</h1>
+    {% if page.description %}
+      <p>
+        {{- page.description | escape_once | newline_to_br -}}
+      </p>
+    {% endif %}
+
+    <a
+      class="card-link"
+      rel="{{ embed.rel | join: " "}}"
+      target="{{ embed.target }}"
+      referrerpolicy="{{ embed.referrerpolicy }}"
+      href="{{ page.url | uri_escape }}">
+      {{- page.url -}}
+    </a>
+  </header>
 </article>

data/lib/jekyll/embed/content.rb

@@ -14,16 +14,13 @@ module Jekyll
         # @return [String]
         def embed(content)
           Nokogiri::HTML5.fragment(content).tap do |html|
-            html.css('p > a:first-of-type').each do |a|
-              next unless a.parent.children.last == a
+            html.css('p > a').each do |a|
+              next unless a.parent.children.size == 1
+              next unless a['href'] == a.text.strip
 
-              url = a['href']
+              embed = Jekyll::Embed.embed a['href']
 
-              next unless url == a.text.strip
-
-              embed = Jekyll::Embed.embed url
-
-              next if url == embed
+              next if a['href'] == embed
 
               a.parent.replace embed
             end

data/lib/jekyll/embed.rb

@@ -51,9 +51,9 @@ module Jekyll
   # legitimate reasons to remove media from the Internet.
   class Embed
     # Attributes to apply by HTMLElement
-    IFRAME_ATTRIBUTES = %w[allow sandbox referrerpolicy loading].freeze
-    IMAGE_ATTRIBUTES = %w[referrerpolicy loading].freeze
-    MEDIA_ATTRIBUTES = %w[controls].freeze
+    IFRAME_ATTRIBUTES = %w[allow sandbox referrerpolicy loading height width].freeze
+    IMAGE_ATTRIBUTES = %w[referrerpolicy loading height width].freeze
+    MEDIA_ATTRIBUTES = %w[controls height width].freeze
     A_ATTRIBUTES = %w[referrerpolicy rel target].freeze
 
     # Directive from Feature Policy
@@ -62,8 +62,9 @@ module Jekyll
                     encrypted-media execution-while-not-rendered execution-while-out-of-viewport fullscreen gamepad geolocation gyroscope layout-animations legacy-image-formats magnetometer microphone midi navigation-override oversized-images payment picture-in-picture publickey-credentials-get speaker-selection sync-xhr usb screen-wake-lock web-share xr-spatial-tracking].freeze
 
     # Templates
-    INCLUDE_OGP = '{% include ogp.html site=site page=page %}'
-    INCLUDE_FALLBACK = '{% include fallback.html site=site page=page %}'
+    INCLUDE_OGP = '{% include ogp.html %}'
+    INCLUDE_FALLBACK = '{% include fallback.html %}'
+    INCLUDE_EMBED = '{% include embed.html %}'
 
     # The default referrer policy only sends the origin URL (not the
     # full URL, only the protocol/scheme and domain part) if the remote
@@ -79,12 +80,14 @@ module Jekyll
       'scrub' => %w[form input textarea button fieldset select option optgroup canvas area map],
       'attributes' => {
         'referrerpolicy' => 'strict-origin-when-cross-origin',
-        'sandbox' => %w[allow-scripts allow-popups],
+        'sandbox' => %w[allow-scripts allow-popups allow-popups-to-escape-sandbox],
         'allow' => %w[fullscreen; gyroscope; picture-in-picture; clipboard-write;],
         'loading' => 'lazy',
         'controls' => true,
         'rel' => %w[noopener noreferrer],
-        'target' => '_blank'
+        'target' => '_blank',
+        'height' => nil,
+        'width' => nil
       }
     }.freeze
 
@@ -191,7 +194,10 @@ module Jekyll
           # Prevent caching of nil?
           raise OEmbed::Error unless oembed.respond_to? :html
 
-          cleanup oembed.html, url
+          context = info.dup
+          context[:registers][:page] = payload['page'] = cleanup(oembed.html, url)
+
+          embed_template.render!(payload, context)
         end
       rescue OEmbed::Error
         nil
@@ -226,7 +232,7 @@ module Jekyll
       rescue ArgumentError
         Jekyll.logger.warn 'Invalid contents (OGP):', url
         nil
-      rescue OGP::MalformedSourceError, OGP::MissingAttributeError, Faraday::Error
+      rescue LL::ParserError, OGP::MalformedSourceError, OGP::MissingAttributeError, Faraday::Error
         nil
       end
 
@@ -292,7 +298,7 @@ module Jekyll
         # Add our own attributes
         html.css('iframe').each do |iframe|
           IFRAME_ATTRIBUTES.each do |attr|
-            iframe[attr] = value_for_attr(attr)
+            set_value_for_attr(iframe, attr)
           end
 
           # Embedding itself require allow-same-origin
@@ -301,7 +307,7 @@ module Jekyll
 
         html.css('audio, video').each do |media|
           MEDIA_ATTRIBUTES.each do |attr|
-            media[attr] = value_for_attr(attr)
+            set_value_for_attr(media, attr)
           end
 
           media['src'] = UrlPrivacy.clean media['src']
@@ -309,22 +315,22 @@ module Jekyll
 
         html.css('img').each do |img|
           IMAGE_ATTRIBUTES.each do |attr|
-            img[attr] = value_for_attr(attr)
+            set_value_for_attr(img, attr)
           end
         end
 
         html.css('a').each do |a|
           A_ATTRIBUTES.each do |attr|
-            a[attr] = value_for_attr(attr)
+            set_value_for_attr(a, attr)
           end
         end
 
         html.css('[src]').each do |element|
-          element['src'] = CGI.escapeHTML(UrlPrivacy.clean(CGI.unescapeHTML(element['src'])))
+          element['src'] = UrlPrivacy.clean(element['src'])
         end
 
         html.css('[href]').each do |element|
-          element['href'] = CGI.escapeHTML(UrlPrivacy.clean(CGI.unescapeHTML(element['href'])))
+          element['href'] = UrlPrivacy.clean(element['href'])
         end
 
         # Return the cleaned up HTML as a String
@@ -337,6 +343,10 @@ module Jekyll
 
       private
 
+      def embed_template
+        @embed_template ||= site.liquid_renderer.file('embed.html').parse(INCLUDE_EMBED)
+      end
+
       def fallback_template
         @fallback_template ||= site.liquid_renderer.file('fallback.html').parse(INCLUDE_FALLBACK)
       end
@@ -359,11 +369,22 @@ module Jekyll
         @value_for_attr ||= {}
         @value_for_attr[attr] ||=
           case (value = config.dig('attributes', attr))
-          when String then value
           when Array then value.join(' ')
+          else value
           end
       end
 
+      # @param element [Nokogiri::XML::Element]
+      # @param attr [String]
+      # @return [nil]
+      def set_value_for_attr(element, attr)
+        case (value = value_for_attr(attr))
+        when NilClass, FalseClass then element.delete(attr)
+        when TrueClass then element[attr] = nil
+        else element[attr] = value
+        end
+      end
+
       # If the iframe comes from the same site, we can allow the same
       # origin policy on the sandbox.
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-embed-urls
 version: !ruby/object:Gem::Version
-  version: 0.5.15
+  version: 0.6.1
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -155,6 +155,7 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- _includes/embed.html
 - _includes/fallback.html
 - _includes/ogp.html
 - lib/jekyll-embed-urls.rb