jekyll-webmention_io 3.3.7 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92d94de0add9cc4571ce7b0f312cce727c3b387e645101f8c190e025c58be261
-  data.tar.gz: 8dbd9f8960c7c5c427c861fc08bc368a901e04b51267219fc1030b81b33b25e7
+  metadata.gz: cc9d31a7e443e2a0b12a6d4b5ce65fff675e8302113f751eff6b5bbde3d090e3
+  data.tar.gz: 3c57fc8d14d3345def7d2bd432745fbcd9551d9931adc7ea870d7ae7ed638f6f
 SHA512:
-  metadata.gz: 676aa2fd229c06d44f077f3eb7fb7f52deec8bad2f082b101fffb6379b66f35e90a1fcfe31d06539f4baeb77f6a5f7712aa5319d09c463fe5d2cf2c02e34974d
-  data.tar.gz: f73660974098440e3b658183dd9a9a10817d8fc010db197766e80678d43e4e295341adef6e057eee33c5acc5b06b1f3ce38f1bd1cbbad776199c64a95129147f
+  metadata.gz: a650de9ca6309c29e09f5f9533ac5ca62dddec88f8dca8302efb9aee4254fb7445c86f68f4bc06f070189e6cf47f04efcaa6942e9cdd523536e2bc319b70c531
+  data.tar.gz: afd4a141acc8cb97e78e27f0bfcac62f4d8d3d355a4362b7ef94789ba3e5710023f3813bb04a7a9d6de27af0e84167524440d88181aaceb3d18469362deae115

data/lib/jekyll/assets/JekyllWebmentionIO.js

@@ -189,7 +189,7 @@
         incoming[plural_type].push( webmention );
       }
       
-      // If there’s a generic, add it there too
+      // If there's a generic, add it there too
       if ( incoming.webmentions )
       {
         incoming.webmentions.push( webmention );
@@ -528,4 +528,4 @@
   collectExistingWebmentions();
   identifyWebmentionCollections();
   
-}(this, this.document));
+}(this, this.document));

data/lib/jekyll/assets/_utils.js

@@ -1,7 +1,7 @@
 // @ts-check
 /**
  *  WebMentions.io JS
- *  A re-tooling of Aaron Parecki’s recommended JS for using the WebMention.io API
+ *  A re-tooling of Aaron Parecki's recommended JS for using the WebMention.io API
  * 
  *  Updates Webmentions on a static site immediately when the page is loaded and
  *  in real-time (using WebSockets) as the user engages with the page.
@@ -31,4 +31,4 @@
     return k;
   };
 
-}(this,this.document));
+}(this,this.document));

data/lib/jekyll/commands/webmention.rb

@@ -26,18 +26,17 @@ module Jekyll
           WebmentionIO.log "msg", "Getting ready to send webmentions (this may take a while)."
 
           count = 0
+          max_attempts = WebmentionIO.max_attempts()
           cached_outgoing = WebmentionIO.get_cache_file_path "outgoing"
           if File.exist?(cached_outgoing)
             outgoing = WebmentionIO.load_yaml(cached_outgoing)
             outgoing.each do |source, targets|
               targets.each do |target, response|
                 # skip ones we’ve handled
-                next unless response == false
+                next unless response == false or response.instance_of? Integer
 
-                # convert protocol-less links
-                if target.index("//").zero?
-                  target = "http:#{target}"
-                end
+                # skip protocol-less links, we'll need to revisit this again later
+                next if target.index("//").zero?
 
                 # produce an escaped version of the target (in case of special
                 # characters, etc).
@@ -46,6 +45,17 @@ module Jekyll
                 # skip bad URLs
                 next unless WebmentionIO.uri_ok?(escaped)
 
+                # give up if we've attempted this too many times
+                response = (response || 0) + 1
+
+                if ! max_attempts.nil? and response > max_attempts
+                  outgoing[source][target] = ""
+                  WebmentionIO.log "msg", "Giving up sending from #{source} to #{target}."
+                  next
+                else
+                  outgoing[source][target] = response
+                end
+
                 # get the endpoint
                 endpoint = WebmentionIO.get_webmention_endpoint(escaped)
                 next unless endpoint
@@ -64,9 +74,7 @@ module Jekyll
                 count += 1
               end
             end
-            if count.positive?
-              WebmentionIO.dump_yaml(cached_outgoing, outgoing)
-            end
+            WebmentionIO.dump_yaml(cached_outgoing, outgoing)
             WebmentionIO.log "msg", "#{count} webmentions sent."
           end # file exists (outgoing)
         end # def process

data/lib/jekyll/generators/compile_js.rb

@@ -18,7 +18,6 @@ module Jekyll
       end
     end
 
-    using StringInflection
     class CompileJS < Generator
       safe true
       priority :low
@@ -61,7 +60,7 @@ module Jekyll
       def add_webmention_types
         js_types = []
         WebmentionIO.types.each do |type|
-          js_types.push "'#{type}': '#{type.to_singular}'"
+          js_types.push "'#{type}': '#{ActiveSupport::Inflector.singularize(type)}'"
         end
         types_js = <<-EOF
           ;(function(window,JekyllWebmentionIO){

data/lib/jekyll/generators/queue_webmentions.rb

@@ -8,6 +8,8 @@
 #  This generator caches sites you mention so they can be mentioned
 #
 
+require "jsonpath"
+
 module Jekyll
   module WebmentionIO
     class QueueWebmentions < Generator
@@ -17,6 +19,7 @@ module Jekyll
       def generate(site)
         @site = site
         @site_url = site.config["url"].to_s
+        @syndication = site.config.dig("webmentions", "syndication")
 
         if @site.config['serving']
           Jekyll::WebmentionIO.log "msg", "Webmentions lookups are not run when running `jekyll serve`."
@@ -31,52 +34,193 @@ module Jekyll
           return
         end
 
-        if @site.config.dig("webmentions", "pause_lookups")
-          WebmentionIO.log "info", "Webmention lookups are currently paused."
-          return
-        end
+        compile_jsonpath_expressions() if ! @syndication.nil?
 
-        WebmentionIO.log "msg", "Beginning to gather webmentions you’ve made. This may take a while."
+        WebmentionIO.log "msg", "Collecting webmentions you’ve made. This may take a while."
 
         upgrade_outgoing_webmention_cache
 
-        posts = WebmentionIO.gather_documents(@site)
-
+        posts = WebmentionIO.gather_documents(@site).select { |p| ! p.data["draft"] }
         gather_webmentions(posts)
       end
 
       private
 
+      def compile_jsonpath_expressions()
+        @syndication.each do | target, config |
+          next if ! config.key? "response_mapping"
+
+          mapping = config["response_mapping"]
+
+          mapping.clone.each do | key, pattern |
+            begin
+              mapping[key] = JsonPath.new(pattern)
+            rescue StandardError => e
+              WebmentionIO.log "error", "Ignoring invalid JsonPath expression #{pattern}: #{e}"
+
+              mapping.delete(key)
+            end
+          end
+        end
+      end
+
+      def combine_values(a, b)
+        return case [ a.instance_of?(Array), b.instance_of?(Array) ]
+          when [ false, false ]
+            [ a, b ]
+          when [ false, true ]
+            [ a ] + b
+          when [ true, false ]
+            a << b
+          when [ true, true ]
+            a + b
+        end
+      end
+
+      def process_syndication(post, target, response)
+        # If this is a syndication target, and we have a response,
+        # and the syndication entry contains a response mapping, then
+        # go through that map and store the selected values into
+        # the page front matter.
+
+        response = JSON.generate(response)
+
+        target["response_mapping"].each do |key, pattern|
+          result = pattern.on(response)
+
+          if ! result
+            WebmentionIO.log "msg", "The path #{skey} doesn't exist in the response from #{target['endpoint']} for #{uri}"
+            next
+          elsif result.length == 1
+            result = result.first
+          end
+
+          if post.data[key].nil?
+            post.data[key] = result
+          else
+            post.data[key] = combine_values(post.data[key], result)
+          end
+        end
+      end
+
+      def get_collection_for_post(post)
+        @site.collections.each do |name, collection|
+          next if name == "posts"
+
+          return collection if collection.docs.include? post
+        end
+
+        return nil
+      end
+
+      def get_syndication_target(uri)
+        return nil if @syndication.nil?
+
+        @syndication.values.detect { |t| t["endpoint"] == uri }
+      end
+
       def gather_webmentions(posts)
         webmentions = WebmentionIO.read_cached_webmentions "outgoing"
 
         posts.each do |post|
-          uri = File.join(@site_url, post.url)
+          # Collect potential outgoing webmentions in this post.
           mentions = get_mentioned_uris(post)
-          if webmentions.key? uri
-            mentions.each do |mentioned_uri, response|
-              unless webmentions[uri].key? mentioned_uri
-                webmentions[uri][mentioned_uri] = response
+
+          mentions.each do |mentioned_uri, response|
+            # If this webmention was a product of a syndication instruction,
+            # this goes back into the configuration and pulls that syndication
+            # target config out.
+            #
+            # If this is just a normal webmention, this will return nil.
+            target = get_syndication_target(mentioned_uri)
+
+            fulluri = File.join(@site_url, post.url)
+            shorturi = post.data["shorturl"] || fulluri
+
+            # Old cached responses might use either the full or short URIs so
+            # we need to check for both.
+            cached_response =
+              webmentions.dig(shorturi, mentioned_uri) ||
+              webmentions.dig(fulluri, mentioned_uri)
+
+            if cached_response.nil?
+              if ! target.nil?
+                uri = target["shorturl"] ? shorturi : fulluri
+
+                if target.key? "fragment"
+                  uri += "#" + target["fragment"]
+                end
+              else
+                uri = fulluri
               end
+
+              webmentions[uri] ||= {}
+              webmentions[uri][mentioned_uri] = response
+            elsif ! target.nil? and target.key? "response_mapping"
+              process_syndication(post, target, cached_response)
             end
-          else
-            webmentions[uri] = mentions
           end
         end
 
-        WebmentionIO.cache_webmentions "outgoing", webmentions
+        # This check is moved down here because we still need the steps
+        # above to populate frontmatter during the site build, even
+        # if we're not going to modify the webmention cache.
+
+        if @site.config.dig("webmentions", "pause_lookups")
+          WebmentionIO.log "info", "Webmention lookups are currently paused."
+          return
+        else
+          WebmentionIO.cache_webmentions "outgoing", webmentions
+        end
       end
 
       def get_mentioned_uris(post)
+        collection = get_collection_for_post(post)
+
         uris = {}
+        parser = URI::Parser.new
+
+        syndication_targets = []
+        syndication_targets += post.data["syndicate_to"] || []
+
+        if ! collection.nil?
+          syndication_targets += collection.metadata["syndicate_to"] || []
+        end
+
+        syndication_targets.each do |endpoint|
+          if @syndication.key? endpoint
+            uris[@syndication[endpoint]["endpoint"]] = false
+          else
+            WebmentionIO.log "msg", "Found reference to syndication endpoint \"#{endpoint}\" without matching entry in configuration."
+          end
+        end
+
         if post.data["in_reply_to"]
           uris[post.data["in_reply_to"]] = false
         end
+
+        if post.data["bookmark_of"]
+          uris[post.data["bookmark_of"]] = false
+        end
+
         post.content.scan(/(?:https?:)?\/\/[^\s)#\[\]{}<>%|\^"']+/) do |match|
-          unless uris.key? match
-            uris[match] = false
+          begin
+            # We do this as a poor man's way to validate the URI.  We do most
+            # of the work with the regex scan above, then attempt a parse as
+            # the last test in case a bad URI fell through the cracks.
+            #
+            # Of course, better would be to fix the regex, but consider this
+            # belt-and-suspenders...
+            parser.parse(parser.escape(match))
+
+            unless uris.key? match
+              uris[match] = false
+            end
+          rescue => e
+            WebmentionIO.log "msg", "Encountered unexpected malformed URI '#{match}' in #{post.path}, skipping..."
           end
         end
+
         return uris
       end
 

data/lib/jekyll/tags/count.rb

@@ -18,7 +18,7 @@ module Jekyll
         self.template = "count"
       end
 
-      def set_data(data, types)
+      def set_data(data, types, html_proofer_ignore)
         @data = { "count" => data.length, "types" => types }
       end
     end

data/lib/jekyll/tags/webmention.rb

@@ -11,7 +11,6 @@ require "htmlbeautifier"
 
 module Jekyll
   module WebmentionIO
-    using StringInflection
     class WebmentionTag < Liquid::Tag
       def initialize(tag_name, text, tokens)
         super
@@ -40,8 +39,8 @@ module Jekyll
         WebmentionIO.log "info", "#{template.capitalize} template:\n\n#{@template}\n\n"
       end
 
-      def set_data(data, types)
-        @data = { "webmentions" => data, "types" => types }
+      def set_data(data, types, html_proofer_ignore)
+        @data = { "webmentions" => data, "types" => types, "html_proofer_ignore" => html_proofer_ignore }
       end
 
       def extract_type(type, webmentions)
@@ -50,7 +49,7 @@ module Jekyll
         if !WebmentionIO.types.include? type
           WebmentionIO.log "warn", "#{type} are not extractable"
         else
-          type = type.to_singular
+          type = ActiveSupport::Inflector.singularize(type)
           WebmentionIO.log "info", "Searching #{webmentions.length} webmentions for type==#{type}"
           if webmentions.is_a? Hash
             webmentions = webmentions.values
@@ -63,14 +62,23 @@ module Jekyll
       end
 
       def render(context)
+        # Initialize an empty set of webmentions (we'll populate later if
+        # there actually are any).
+        webmentions = []
+
+        # Capture the types in case JS needs them
+        types = []
+
+        # Retrieve the html_proofer_ignore config setting so we can pass
+        # it into the templates.
+        site = context.registers[:site]
+        html_proofer_ignore = site.config.dig("webmentions", "html_proofer_ignore") || "none"
+
         # Get the URI
         args = @text.split(/\s+/).map(&:strip)
         uri = args.shift
         uri = lookup(context, uri)
 
-        # capture the types in case JS needs them
-        types = []
-
         if @cached_webmentions.key? uri
           all_webmentions = @cached_webmentions[uri].clone
           WebmentionIO.log "info", "#{all_webmentions.length} total webmentions for #{uri}"
@@ -94,9 +102,9 @@ module Jekyll
           end
 
           webmentions = sort_webmentions(webmentions)
-          set_data(webmentions, types)
         end
 
+        set_data(webmentions, types, html_proofer_ignore)
         render_into_template(context.registers)
       end
 

data/lib/jekyll/tags/webmention_type.rb

@@ -12,9 +12,9 @@ module Jekyll
     # Superclass for Webmention types:
     # [ bookmarks | likes | links | posts | replies | reposts | rsvps ]
     class WebmentionTypeTag < WebmentionTag
-      def set_data(data, _types)
+      def set_data(data, _types, html_proofer_ignore)
         webmentions = extract_type @template_name, data
-        @data = { "webmentions" => webmentions.values }
+        @data = { "webmentions" => webmentions.values, "html_proofer_ignore" => html_proofer_ignore }
       end
     end
   end

data/lib/jekyll/templates/bookmarks.html

@@ -1,26 +1,65 @@
-<div class="webmentions webmentions--bookmarks">
+{%- if html_proofer_ignore == "all" -%}
+{%- assign html_proofer_attr = " data-proofer-ignore" -%}
+{%- endif -%}
+<div class="webmentions webmentions--bookmarks"{{ html_proofer_attr }}>
   {% if webmentions.size > 0 %}
     <ol class="webmentions__list">
       {% for webmention in webmentions %}
-        <li id="webmention-{{ webmention.id }}" class="webmentions__item webmention webmention--{{ webmention.type }}">
-          <div class="webmention__content p-content">
-            {{ webmention.content }}
-          </div>
-          <div class="webmention__meta">
+        <li id="webmention-{{ webmention.id }}" class="webmention webmentions__item webmention--{{ webmention.type }}">
+          <article class="h-cite
+            {% unless webmention.author %}webmention--no-author{% endunless %}
+            {% unless webmention.author.photo %}webmention--no-photo{% endunless %}
+            ">
             {% if webmention.author %}
-              <a class="webmention__author h-card u-url" href="{{ webmention.author.url }}" rel="nofollow">{{ webmention.author.name }}</a>
+            <div class="webmention__author p-author h-card">
+              {% capture author_id %}
+                {% if webmention.author.photo %}
+                  <img
+                    class="webmention__author__photo u-photo"
+                    src="{{ webmention.author.photo }}"
+                    alt=""
+                    {% if webmention.author.name %}
+                    title="{{ webmention.author.name }}"
+                    {% endif %}
+                    >
+                {% endif %}
+
+                {% if webmention.author.name %}
+                  <span class="webmention__author__name p-name">{{ webmention.author.name }}</span>
+                {% endif %}
+              {% endcapture %}
+
+              {% if webmention.author.url %}
+                <a class="u-url" href="{{ webmention.author.url }}" rel="nofollow">{{ author_id }}</a>
+              {% else %}
+                {{ author_id }}
+              {% endif %}
+            </div>
             {% endif %}
-            {% if webmention.pubdate and webmention.url %}on{% endif %}
-            {% if webmention.pubdate %}
-              <a class="webmention__source u-url" href="{{ webmention.url }}" rel="nofollow">
-                <time class="webmention__pubdate dt-published" datetime="{{ webmention.pubdate | date: '%FT%T%:z' }}">{{ webmention.pubdate | date: '%d %B %Y' }}</time>
-              </a>
-            {% endif %}
-          </div>
+
+            <div class="webmention__content p-content">
+              {% if webmention.content %}
+                {{ webmention.content }}
+              {% else %}
+                {{ webmention.title }}
+              {% endif %}
+            </div>
+
+            <div class="webmention__meta">
+              {% if webmention.pubdate %}
+                <time class="webmention__pubdate dt-published"
+                      datetime="{{ webmention.pubdate | date: '%FT%T%:z' }}">{{ webmention.pubdate | date: '%d %B %Y' }}</time>
+              {% endif %}
+              {% if webmention.pubdate and webmention.uri %}|{% endif %}
+              {% if webmention.uri %}
+                <a class="webmention__source u-url" href="{{ webmention.uri }}" rel="nofollow">Permalink</a>
+              {% endif %}
+            </div>
+          </article>
         </li>
       {% endfor %}
     </ol>
   {% else %}
     <p class="webmentions__not-found">No bookmarks were found.</p>
   {% endif %}
-</div>
+</div>

data/lib/jekyll/templates/likes.html

@@ -1,17 +1,46 @@
-<div class="webmentions webmentions--likes">
+{%- if html_proofer_ignore == "all" -%}
+{%- assign html_proofer_attr = " data-proofer-ignore" -%}
+{%- endif -%}
+<div class="webmentions webmentions--likes"{{ html_proofer_attr }}>
   {% if webmentions.size > 0 %}
     <ol class="webmentions__list">
       {% for webmention in webmentions %}
-        <li id="webmention-{{ webmention.id }}" class="webmentions__item webmention webmention--{{ webmention.type }}">
-          <div class="webmention__author p-author h-card">
-            <a class="u-url" href="{{ webmention.author.url }}" rel="nofollow">
-              <img class="webmention__author__photo u-photo" src="{{ webmention.author.photo }}" alt="" title="{{ webmention.author.name }}">
-            </a>
-          </div>
+        <li id="webmention-{{ webmention.id }}" class="webmention webmentions__item webmention--{{ webmention.type }}">
+          <article class="h-cite
+            {% unless webmention.author %}webmention--no-author{% endunless %}
+            {% unless webmention.author.photo %}webmention--no-photo{% endunless %}
+            ">
+            {% if webmention.author %}
+            <div class="webmention__author p-author h-card">
+              {% capture author_id %}
+                {% if webmention.author.photo %}
+                  <img
+                    class="webmention__author__photo u-photo"
+                    src="{{ webmention.author.photo }}"
+                    alt=""
+                    {% if webmention.author.name %}
+                    title="{{ webmention.author.name }}"
+                    {% endif %}
+                    >
+                {% endif %}
+
+                {% if webmention.author.name %}
+                  <span class="webmention__author__name p-name">{{ webmention.author.name }}</span>
+                {% endif %}
+              {% endcapture %}
+
+              {% if webmention.author.url %}
+                <a class="u-url" href="{{ webmention.author.url }}" rel="nofollow">{{ author_id }}</a>
+              {% else %}
+                {{ author_id }}
+              {% endif %}
+            </div>
+            {% endif %}
+          </article>
         </li>
       {% endfor %}
     </ol>
   {% else %}
-    <p class="webmentions__not-found">No likes were found.</p>
+    <p class="webmentions__not-found">No likes have been sent yet!</p>
   {% endif %}
-</div>
+</div>

data/lib/jekyll/templates/links.html

@@ -1,26 +1,65 @@
-<div class="webmentions webmentions--links">
+{%- if html_proofer_ignore == "all" -%}
+{%- assign html_proofer_attr = " data-proofer-ignore" -%}
+{%- endif -%}
+<div class="webmentions webmentions--links"{{ html_proofer_attr }}>
   {% if webmentions.size > 0 %}
     <ol class="webmentions__list">
       {% for webmention in webmentions %}
-        <li id="webmention-{{ webmention.id }}" class="webmentions__item webmention webmention--{{ webmention.type }}">
-          <div class="webmention__content p-content">
-            {{ webmention.content }}
-          </div>
-          <div class="webmention__meta">
+        <li id="webmention-{{ webmention.id }}" class="webmention webmentions__item webmention--{{ webmention.type }}">
+          <article class="h-cite
+            {% unless webmention.author %}webmention--no-author{% endunless %}
+            {% unless webmention.author.photo %}webmention--no-photo{% endunless %}
+            ">
             {% if webmention.author %}
-              <a class="webmention__author h-card u-url" href="{{ webmention.author.url }}" rel="nofollow">{{ webmention.author.name }}</a>
+            <div class="webmention__author p-author h-card">
+              {% capture author_id %}
+                {% if webmention.author.photo %}
+                  <img
+                    class="webmention__author__photo u-photo"
+                    src="{{ webmention.author.photo }}"
+                    alt=""
+                    {% if webmention.author.name %}
+                    title="{{ webmention.author.name }}"
+                    {% endif %}
+                    >
+                {% endif %}
+
+                {% if webmention.author.name %}
+                  <span class="webmention__author__name p-name">{{ webmention.author.name }}</span>
+                {% endif %}
+              {% endcapture %}
+
+              {% if webmention.author.url %}
+                <a class="u-url" href="{{ webmention.author.url }}" rel="nofollow">{{ author_id }}</a>
+              {% else %}
+                {{ author_id }}
+              {% endif %}
+            </div>
             {% endif %}
-            {% if webmention.pubdate and webmention.url %}on{% endif %}
-            {% if webmention.pubdate %}
-              <a class="webmention__source u-url" href="{{ webmention.url }}" rel="nofollow">
-                <time class="webmention__pubdate dt-published" datetime="{{ webmention.pubdate | date: '%FT%T%:z' }}">{{ webmention.pubdate | date: '%d %B %Y' }}</time>
-              </a>
-            {% endif %}
-          </div>
+
+            <div class="webmention__content p-content">
+              {% if webmention.content %}
+                {{ webmention.content }}
+              {% else %}
+                {{ webmention.title }}
+              {% endif %}
+            </div>
+
+            <div class="webmention__meta">
+              {% if webmention.pubdate %}
+                <time class="webmention__pubdate dt-published"
+                      datetime="{{ webmention.pubdate | date: '%FT%T%:z' }}">{{ webmention.pubdate | date: '%d %B %Y' }}</time>
+              {% endif %}
+              {% if webmention.pubdate and webmention.uri %}|{% endif %}
+              {% if webmention.uri %}
+                <a class="webmention__source u-url" href="{{ webmention.uri }}" rel="nofollow">Permalink</a>
+              {% endif %}
+            </div>
+          </article>
         </li>
       {% endfor %}
     </ol>
   {% else %}
     <p class="webmentions__not-found">No links were found.</p>
   {% endif %}
-</div>
+</div>