jekyll-webmention_io 2.8.5 → 2.9.0

data/lib/jekyll/generators/queue_webmentions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
@@ -11,26 +13,31 @@ module Jekyll
     priority :low
 
     def generate(site)
-      if site.config.dig("webmentions", "pause_lookups") == true
+      @site = site
+
+      if @site.config.dig("webmentions", "pause_lookups")
         Jekyll::WebmentionIO.log "info", "Webmention lookups are currently paused."
         return
       end
 
-      Jekyll::WebmentionIO.log "info", "Beginning to gather webmentions you’ve made. This may take a while."
+      Jekyll::WebmentionIO.log "msg", "Beginning to gather webmentions you’ve made. This may take a while."
 
       upgrade_outgoing_webmention_cache
 
-      cache_file = Jekyll::WebmentionIO.get_cache_file_path "outgoing"
-      webmentions = open(cache_file) { |f| YAML.safe_load(f) }
+      posts = Jekyll::WebmentionIO.gather_documents(@site)
+
+      gather_webmentions(posts)
+    end
+
+    private
+
+    def gather_webmentions(posts)
+      webmentions = Jekyll::WebmentionIO.read_cached_webmentions "outgoing"
 
-      posts = if Jekyll::VERSION >= "3.0.0"
-                site.posts.docs
-              else
-                site.posts
-              end
+      base_uri = @site.config["url"].chomp("/")
 
       posts.each do |post|
-        uri = "#{site.config["url"]}#{post.url}"
+        uri = "#{base_uri}#{post.url}"
         mentions = get_mentioned_uris(post)
         if webmentions.key? uri
           mentions.each do |mentioned_uri, response|
@@ -43,10 +50,20 @@ module Jekyll
         end
       end
 
-      cache_file = Jekyll::WebmentionIO.get_cache_file_path "outgoing"
-      File.open(cache_file, "w") { |f| YAML.dump(webmentions, f) }
+      Jekyll::WebmentionIO.cache_webmentions "outgoing", webmentions
+    end
 
-      Jekyll::WebmentionIO.log "info", "Webmentions have been gathered and cached."
+    def get_mentioned_uris(post)
+      uris = {}
+      if post.data["in_reply_to"]
+        uris[post.data["in_reply_to"]] = false
+      end
+      post.content.scan(/(?:https?:)?\/\/[^\s)#"]+/) do |match|
+        unless uris.key? match
+          uris[match] = false
+        end
+      end
+      return uris
     end
 
     def upgrade_outgoing_webmention_cache
@@ -55,8 +72,8 @@ module Jekyll
       unless File.exist? old_sent_file
         return
       end
-      sent_webmentions = open(old_sent_file) { |f| YAML.safe_load(f) }
-      outgoing_webmentions = open(old_outgoing_file) { |f| YAML.safe_load(f) }
+      sent_webmentions = open(old_sent_file) { |f| YAML.load(f) }
+      outgoing_webmentions = open(old_outgoing_file) { |f| YAML.load(f) }
       merged = {}
       outgoing_webmentions.each do |source_url, webmentions|
         collection = {}
@@ -69,23 +86,9 @@ module Jekyll
         end
         merged[source_url] = collection
       end
-      cached_outgoing = Jekyll::WebmentionIO.get_cache_file_path "outgoing"
-      File.open(cached_outgoing, "w") { |f| YAML.dump(merged, f) }
+      Jekyll::WebmentionIO.cache_webmentions "outgoing", merged
       File.delete old_sent_file, old_outgoing_file
-      Jekyll::WebmentionIO.log "info", "Upgraded your sent webmentions cache."
-    end
-
-    def get_mentioned_uris(post)
-      uris = {}
-      if post.data["in_reply_to"]
-        uris[post.data["in_reply_to"]] = false
-      end
-      post.content.scan(/(?:https?:)?\/\/[^\s)#"]+/) do |match|
-        unless uris.key? match
-          uris[match] = false
-        end
-      end
-      return uris
+      Jekyll::WebmentionIO.log "msg", "Upgraded your sent webmentions cache."
     end
   end
 end

data/lib/jekyll/tags/_.rb

@@ -1,71 +1,67 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
-#  https://github.com/aarongustafson/jekyll-webmention_io 
+#  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
-#  
+#
 #  Base webmention tag
 #
 
-require 'htmlbeautifier'
+require "htmlbeautifier"
 
 module Jekyll
   module WebmentionIO
     using StringInflection
     class WebmentionTag < Liquid::Tag
-      
-      def initialize(tagName, text, tokens)
+      def initialize(tag_name, text, tokens)
         super
-        cache_file = Jekyll::WebmentionIO::get_cache_file_path 'incoming'
-        if File.exists?(cache_file)
-          @cached_webmentions = open(cache_file) { |f| YAML.load(f) }
-        else
-          @cached_webmentions = {}
-        end
+        cache_file = Jekyll::WebmentionIO.get_cache_file_path "incoming"
+        @cached_webmentions = if File.exist? cache_file
+                                open(cache_file) { |f| YAML.load(f) }
+                              else
+                                {}
+                              end
       end
 
       def lookup(context, name)
         lookup = context
-        name&.split('.')&.each do |value|
+        name&.split(".")&.each do |value|
           lookup = lookup[value]
         end
         lookup
       end
-      
-      def set_template( template )
-        supported_templates = Jekyll::WebmentionIO::types + ['count', 'webmentions']        
-        Jekyll::WebmentionIO::log 'error', "#{template} is not supported" if ! supported_templates.include? template
-        @template = Jekyll::WebmentionIO::get_template_contents( template )
-        # Jekyll::WebmentionIO::log 'info', "template: #{@template}"
+
+      def template=(template)
+        supported_templates = Jekyll::WebmentionIO.types + %w(count webmentions)
+        Jekyll::WebmentionIO.log "error", "#{template.capitalize} is not supported" unless supported_templates.include? template
+        @template_name = template
+        @template = Jekyll::WebmentionIO.get_template_contents(template)
+        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)
+        @data = { "webmentions" => data, "types" => types }
       end
 
-      def extract_type( type, webmentions )
-        # Jekyll::WebmentionIO::log 'info', "Looking for #{type}"
+      def extract_type(type, webmentions)
+        Jekyll::WebmentionIO.log "info", "Looking for #{type}"
         keep = {}
-        if ! Jekyll::WebmentionIO::types.include? type
-          Jekyll::WebmentionIO::log 'warn', "#{type} are not extractable"
+        if !Jekyll::WebmentionIO.types.include? type
+          Jekyll::WebmentionIO.log "warn", "#{type} are not extractable"
         else
           type = type.to_singular
-          # Jekyll::WebmentionIO::log 'info', "Searching #{webmentions.length} webmentions for type==#{type}"
+          Jekyll::WebmentionIO.log "info", "Searching #{webmentions.length} webmentions for type==#{type}"
           if webmentions.is_a? Hash
             webmentions = webmentions.values
           end
           webmentions.each do |webmention|
-            keep[webmention['id']] = webmention if webmention['type'] == type
+            keep[webmention["id"]] = webmention if webmention["type"] == type
           end
         end
         keep
       end
 
-      def sort_webmentions( webmentions )
-        return webmentions.sort_by { |webmention| webmention['pubdate'].to_i }
-      end
-
       def render(context)
-        output = super
-        
         # Get the URI
         args = @text.split(/\s+/).map(&:strip)
         uri = args.shift
@@ -74,20 +70,21 @@ module Jekyll
         # capture the types in case JS needs them
         types = []
 
-        if @cached_webmentions.has_key? uri
-          all_webmentions =  @cached_webmentions[uri].clone
-          # Jekyll::WebmentionIO::log 'info', "#{all_webmentions.length} total webmentions for #{uri}"
-          if args.length > 0
-            # Jekyll::WebmentionIO::log 'info', "Requesting only #{args.inspect}"
+        if @cached_webmentions.key? uri
+          all_webmentions = @cached_webmentions[uri].clone
+          Jekyll::WebmentionIO.log "info", "#{all_webmentions.length} total webmentions for #{uri}"
+
+          if args.length.positive?
+            Jekyll::WebmentionIO.log "info", "Requesting only #{args.inspect}"
             webmentions = {}
             args.each do |type|
               types.push type
-              extracted = extract_type( type, all_webmentions )
-              # Jekyll::WebmentionIO::log 'info', "Merging in #{extracted.length} #{type}"
-              webmentions = webmentions.merge( extracted )
+              extracted = extract_type(type, all_webmentions)
+              Jekyll::WebmentionIO.log "info", "Merging in #{extracted.length} #{type}"
+              webmentions = webmentions.merge(extracted)
             end
           else
-            # Jekyll::WebmentionIO::log 'info', 'Grabbing all webmentions'
+            Jekyll::WebmentionIO.log "info", "Grabbing all webmentions"
             webmentions = all_webmentions
           end
 
@@ -95,32 +92,39 @@ module Jekyll
             webmentions = webmentions.values
           end
 
-          webmentions = sort_webmentions( webmentions )
-          
-          set_data( webmentions, types )
+          webmentions = sort_webmentions(webmentions)
+          set_data(webmentions, types)
         end
-        
-        args = nil
 
-        if @template and @data
-          # Jekyll::WebmentionIO::log 'info', "Preparing to render\n\n#{@data.inspect}\n\ninto\n\n#{@template}"
+        render_into_template
+      end
+
+      private
+
+      def render_into_template
+        if @template && @data
+          Jekyll::WebmentionIO.log "info", "Preparing to render webmention info into the #{@template_name} template."
           template = Liquid::Template.parse(@template, :error_mode => :strict)
-          html = template.render(@data, { strict_variables: false, strict_filters: true })
+          html = template.render(@data, { :strict_variables => false, :strict_filters => true })
           template.errors.each do |error|
-            Jekyll::WebmentionIO::log 'error', error
+            Jekyll::WebmentionIO.log "error", error
           end
           # Clean up the output
-          HtmlBeautifier.beautify html.each_line.reject{|x| x.strip == ""}.join
+          HtmlBeautifier.beautify html.each_line.reject { |x| x.strip == "" }.join
         else
-          if ! @template
-            Jekyll::WebmentionIO::log 'warn', "#{self.class} No template provided"
+          unless @template
+            Jekyll::WebmentionIO.log "warn", "#{self.class} No template provided"
           end
-          if ! @data
-            Jekyll::WebmentionIO::log 'warn', "#{self.class} No data provided"
+          unless @data
+            Jekyll::WebmentionIO.log "warn", "#{self.class} No data provided"
           end
           ""
         end
       end
+
+      def sort_webmentions(webmentions)
+        return webmentions.sort_by { |webmention| webmention["pubdate"].to_i }
+      end
     end
   end
-end
+end

data/lib/jekyll/tags/bookmarks.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: false
+
+#  (c) Aaron Gustafson
+#  https://github.com/aarongustafson/jekyll-webmention_io
+#  Licence : MIT
+#
+#  this liquid plugin insert a webmentions into your Octopress or Jekill blog
+#  using http://webmention.io/ and the following syntax:
+#
+#    {% webmention_bookmarks post.url %}
+#
+module Jekyll
+  module WebmentionIO
+    class WebmentionBookmarksTag < Jekyll::WebmentionIO::WebmentionTag
+      def initialize(tag_name, text, tokens)
+        super
+        @text = text
+        self.template = "bookmarks"
+      end
+
+      def set_data(data, _types)
+        webmentions = extract_type "bookmarks", data
+        @data = { "webmentions" => webmentions.values }
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("webmention_bookmarks", Jekyll::WebmentionIO::WebmentionBookmarksTag)

data/lib/jekyll/tags/count.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
@@ -5,15 +7,15 @@
 #  this liquid plugin insert a webmentions into your Octopress or Jekill blog
 #  using http://webmention.io/ and the following syntax:
 #
-#    {% webmention_count post.url [ likes | links | posts | replies | reposts ]*   %}
+#    {% webmention_count post.url [ bookmarks | likes | links | posts | replies | reposts | rsvps ]*   %}
 #
 module Jekyll
   module WebmentionIO
     class WebmentionCountTag < Jekyll::WebmentionIO::WebmentionTag
-      def initialize(tagName, text, tokens)
+      def initialize(tag_name, text, tokens)
         super
         @text = text
-        set_template "count"
+        self.template = "count"
       end
 
       def set_data(data, types)

data/lib/jekyll/tags/likes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
@@ -10,10 +12,10 @@
 module Jekyll
   module WebmentionIO
     class WebmentionLikesTag < Jekyll::WebmentionIO::WebmentionTag
-      def initialize(tagName, text, tokens)
+      def initialize(tag_name, text, tokens)
         super
         @text = text
-        set_template "likes"
+        self.template = "likes"
       end
 
       def set_data(data, _types)

data/lib/jekyll/tags/links.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
@@ -10,10 +12,10 @@
 module Jekyll
   module WebmentionIO
     class WebmentionLinksTag < Jekyll::WebmentionIO::WebmentionTag
-      def initialize(tagName, text, tokens)
+      def initialize(tag_name, text, tokens)
         super
         @text = text
-        set_template "links"
+        self.template = "links"
       end
 
       def set_data(data, _types)

data/lib/jekyll/tags/posts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
@@ -9,11 +11,11 @@
 #
 module Jekyll
   module WebmentionIO
-    class WebmentionRepostsTag < Jekyll::WebmentionIO::WebmentionTag
-      def initialize(tagName, text, tokens)
+    class WebmentionPostsTag < Jekyll::WebmentionIO::WebmentionTag
+      def initialize(tag_name, text, tokens)
         super
         @text = text
-        set_template "posts"
+        self.template = "posts"
       end
 
       def set_data(data, _types)
@@ -24,4 +26,4 @@ module Jekyll
   end
 end
 
-Liquid::Template.register_tag("webmention_posts", Jekyll::WebmentionIO::WebmentionRepostsTag)
+Liquid::Template.register_tag("webmention_posts", Jekyll::WebmentionIO::WebmentionPostsTag)

data/lib/jekyll/tags/replies.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
@@ -10,10 +12,10 @@
 module Jekyll
   module WebmentionIO
     class WebmentionRepliesTag < Jekyll::WebmentionIO::WebmentionTag
-      def initialize(tagName, text, tokens)
+      def initialize(tag_name, text, tokens)
         super
         @text = text
-        set_template "replies"
+        self.template = "replies"
       end
 
       def set_data(data, _types)

data/lib/jekyll/tags/reposts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
@@ -10,10 +12,10 @@
 module Jekyll
   module WebmentionIO
     class WebmentionRepostsTag < Jekyll::WebmentionIO::WebmentionTag
-      def initialize(tagName, text, tokens)
+      def initialize(tag_name, text, tokens)
         super
         @text = text
-        set_template "reposts"
+        self.template = "reposts"
       end
 
       def set_data(data, _types)