jekyll-embed-urls 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c799fb3a535b9debbe5e89f5e980924932487511d5bd763654869e30b002a212
-  data.tar.gz: fb20c78186c0a51ebbb31b243ded2046826a130a141707d6e84cafcb39df7cb0
+  metadata.gz: f36b8e03926204a17b34959a0216a6e2fa08a02a57f46826be1daf893865ede0
+  data.tar.gz: 92581158508c23138f1676284762f8df046c601f5b2afff205fbc43c00e691aa
 SHA512:
-  metadata.gz: f9de0be82e9c43c8c3527d93858974d6b1e59dcb0860bf0622143a0b9b7d86ba835cc5c28a0479dfac77cf06541cb221ad0a4825d92438631e5eba16ee5c62cc
-  data.tar.gz: 4b3632e48613bf7f07e0dcadbbf404ad35b7a98cc64f728d24c4c34908c21ceb0ba057fc3425d0449deb1d5ec37a7c40af6e7cd00f25e4d0da929bb45d586334
+  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,11 +1,13 @@
 {% if page.url contains "//archive.org/" or page.url contains "//www.archive.org/" %}
-  <iframe
-    class="w-100"
-    allow="{{ embed.allow | join: " " }}"
-    sandbox="{{ embed.sandbox | join: " " }}"
-    loading="{{ embed.loading }}"
-    referrerpolicy="{{ embed.referrerpolicy }}"
-    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 %}
   {% include ogp.html type="fallback" %}
 {% endif %}

data/_includes/ogp.html

@@ -22,10 +22,10 @@
   {%- endif -%}
 
   <header class="card-body">
-    <h1>{{ page.title | escape_once }}</h1>
+    <h1 class="lead">{{ page.title | escape_once | newline_to_br }}</h1>
     {% if page.description %}
-      <p class="lead">
-        {{- page.description | escape_once -}}
+      <p>
+        {{- page.description | escape_once | newline_to_br -}}
       </p>
     {% endif %}
 

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
@@ -64,6 +64,7 @@ module Jekyll
     # Templates
     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
@@ -84,7 +85,9 @@ module Jekyll
         '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
@@ -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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-embed-urls
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - f
@@ -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