jekyll-embed-urls 0.5.3 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7618c2e879ce3a3864fe5c6a9beb1d38a0a5407539d40f1ee1ee458c3364e45
-  data.tar.gz: 42dc8458446cc5dfa8223e18fe4bf8a7734b470c39fb5011c3856bfcbf845730
+  metadata.gz: '009ec95cb733855d621b7b063e4922c79873296fdebd99f16ad6f2856854a7af'
+  data.tar.gz: e56ca532db963a099a4c4c6950c4382ca25d83c5102703b8bf2d66fd98d8f2a9
 SHA512:
-  metadata.gz: 0110ccca37a34d67d8d366b3ee2154cd775274dfbedb47a614e0705841f2a9933ac2715ab6714118d19aeca1e292924f09b593511884ce95a53a2b794cddad90
-  data.tar.gz: 24970ebc4d97c10afbc24d280c223330ce1cfa75624c9edaaceb330157090bcdf961657fc325c0ed76be4bcc52f9e8956da5fbafe5e6e295c1684cf8fc324abc
+  metadata.gz: d60e0cfb3395976201a2b9b4174aaf1b888ef88fede4c802302002787471a0d8268c89d8d1cb447fa24bcebee7ac5f4ce83865b5770e0fe5ca38cd93ebb7e8e4
+  data.tar.gz: 4310e1aa4409b2724e8dfc9b68ecc96e4eabe83709a19cb7e5d3745a895b9e7bb32af78dece340f6c4e37807813582cdb07517253a40f739c7206db03db606f3

data/_includes/fallback.html

@@ -6,8 +6,8 @@
       <img src="{{ page.image | uri_escape }}" class="img-fluid" />
     {%- endif -%}
 
-    <h1>{{ page.title }}</h1>
-    <p class="lead">{{ page.description }}</p>
+    <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>

data/_includes/ogp.html

@@ -9,8 +9,8 @@
     <audio class="img-fluid" src="{{ page.audio | uri_escape }}"/>
   {%- endif -%}
 
-  <h1>{{ page.title }}</h1>
-  <p class="lead">{{ page.description }}</p>
+  <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>

data/lib/jekyll/embed/cache.rb

@@ -10,7 +10,7 @@ module Jekyll
 
       def read(key)
         self[key]
-      rescue
+      rescue StandardError
         nil
       end
     end

data/lib/jekyll/embed/content.rb

@@ -5,15 +5,22 @@ require 'cgi'
 module Jekyll
   class Embed
     class Content
-      URL_RE = /(<p[^>]*>[\s\n]*(<a[^>]*>)?[\s\n]*(https?:\/\/[^<\s\n]+)[\s\n]*(<\/a>)?[\s\n]*<\/p>)/m.freeze
+      URL_RE = %r{(<p[^>]*>[\s\n]*(<a[^>]*>)?[\s\n]*(https?://[^<\s\n]+)[\s\n]*(</a>)?[\s\n]*</p>)}m.freeze
 
       class << self
         # Find URLs on paragraphs.  We do it after rendering because
         # sometimes we use HTML instead of pure Markdown and this way we
         # catch both.
         def embed!(content)
-          content.gsub!(URL_RE) do |_|
-            Jekyll::Embed.embed CGI.unescapeHTML($3)
+          content.gsub!(URL_RE) do |match|
+            url = CGI.unescapeHTML(Regexp.last_match(3))
+            embed = Jekyll::Embed.embed url
+
+            if embed == url
+              match
+            else
+              embed
+            end
           end
         end
       end

data/lib/jekyll/embed.rb

@@ -13,7 +13,7 @@ require_relative 'embed/cache'
 if Gem::Version.new(Jekyll::VERSION) >= Gem::Version.new('4.2.0')
   require_relative 'embed/content'
 else
-  Jekyll.logger.warn "Upgrade to Jekyll >= 4.2.0 to embed URLs in content"
+  Jekyll.logger.warn 'Upgrade to Jekyll >= 4.2.0 to embed URLs in content'
 end
 
 OEmbed::Providers.register_all
@@ -57,7 +57,8 @@ module Jekyll
 
     # Directive from Feature Policy
     # @see {https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Feature-Policy#directives}
-    DIRECTIVES = %w[accelerometer ambient-light-sensor autoplay battery camera display-capture document-domain 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
+    DIRECTIVES = %w[accelerometer ambient-light-sensor autoplay battery camera display-capture document-domain
+                    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 %}'
@@ -84,13 +85,13 @@ module Jekyll
         'rel' => %w[noopener noreferrer],
         'target' => '_blank'
       }
-    }
+    }.freeze
 
     class << self
       def site
         unless @site
           raise Jekyll::Errors::InvalidConfigurationError,
-            "Site is missing, configure with `Jekyll::Embed.site = site`"
+                'Site is missing, configure with `Jekyll::Embed.site = site`'
         end
 
         @site
@@ -101,7 +102,7 @@ module Jekyll
       # @param [Jekyll::Site]
       # @return [Jekyll::Site]
       def site=(site)
-        raise ArgumentError, "Site must be a Jekyll::Site" unless site.is_a? Jekyll::Site
+        raise ArgumentError, 'Site must be a Jekyll::Site' unless site.is_a? Jekyll::Site
 
         @site = site
 
@@ -130,15 +131,15 @@ module Jekyll
       def reset
         @allow_same_origin =
           @cache =
-          @config =
-          @fallback_template =
-          @get_cache =
-          @http_client =
-          @info =
-          @ogp_template =
-          @payload =
-          @value_for_attr =
-          nil
+            @config =
+              @fallback_template =
+                @get_cache =
+                  @http_client =
+                    @info =
+                      @ogp_template =
+                        @payload =
+                          @value_for_attr =
+                            nil
       end
 
       # Render the URL as HTML
@@ -160,7 +161,7 @@ module Jekyll
         # TODO: Use Addressable
         URI.parse url
 
-        oembed(url) || ogp(url) || fallback(url)
+        oembed(url) || ogp(url) || fallback(url) || url
       rescue URI::Error
         Jekyll.logger.warn "#{url.inspect} is not a valid URL"
 
@@ -170,7 +171,9 @@ module Jekyll
       # @return [Hash]
       def config
         @config ||= Jekyll::Utils.deep_merge_hashes(DEFAULT_CONFIG, (site.config['embed'] || {})).tap do |c|
-          c['attributes']['allow'].concat (DIRECTIVES - c.dig('attributes', 'allow').join.split(';').map { |s| s.split(' ').first }).join(" 'none';|").split('|')
+          c['attributes']['allow'].concat (DIRECTIVES - c.dig('attributes', 'allow').join.split(';').map do |s|
+                                                          s.split(' ').first
+                                                        end).join(" 'none';|").split('|')
         end
       end
 
@@ -197,8 +200,23 @@ module Jekyll
       def ogp(url)
         cache.getset("ogp+#{url}") do
           ogp = OGP::OpenGraph.new get(url).body
+          page = {
+            locale: ogp.locales.first,
+            title: ogp.title,
+            url: ogp.url,
+            description: ogp.description,
+            type: ogp.type,
+            data: ogp.data
+          }.transform_keys(&:to_s)
+
+          %w[image video audio].each do |attr|
+            page[attr] = ogp.public_send(:"#{attr}s").find do |a|
+              http? a.url
+            end&.url
+          end
+
           context = info.dup
-          context[:registers][:page] = payload['page'] = ogp.data
+          context[:registers][:page] = payload['page'] = page
 
           cleanup ogp_template.render!(payload, context), url
         end
@@ -328,8 +346,8 @@ module Jekyll
         @value_for_attr ||= {}
         @value_for_attr[attr] ||=
           case (value = config.dig('attributes', attr))
-            when String then value
-            when Array then value.join(' ')
+          when String then value
+          when Array then value.join(' ')
           end
       end
 
@@ -340,7 +358,7 @@ module Jekyll
       # @return [String]
       def allow_same_origin(url)
         unless site.config['url']
-          Jekyll.logger.warn "Add url to _config.yml to determine if the site can embed itself"
+          Jekyll.logger.warn 'Add url to _config.yml to determine if the site can embed itself'
           return ' allow-same-origin'
         end
 
@@ -355,6 +373,16 @@ module Jekyll
       def payload
         @payload ||= site.site_payload
       end
+
+      # Discover if a string is a valid HTTP URL
+      #
+      # @param :url [String]
+      # @return [Boolean]
+      def http?(url)
+        url.start_with?('http') && URI.parse(url).is_a?(URI::HTTP)
+      rescue URI::Error
+        false
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-embed-urls
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.7
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -58,14 +58,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Replaces URLs for their previsualization in Jekyll posts
 email:
 - f@sutty.nl