jekyll-webmention_io 2.9.7 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4f0b3379a499a748fbf15fe90655da033e7ea78
-  data.tar.gz: b0737d75fe40749f72e5834486c031bd3417da32
+  metadata.gz: 6830a7a6abb84d8ba34c51b817ad817147561818
+  data.tar.gz: 37956daf8a417c5a9fcbae7e1337c6993a82e746
 SHA512:
-  metadata.gz: 519b8c8d762f7061d974fb4e3b46d8915080f400c58c6caef595f7d11c72c7c2b90cec578f549aa20ccad113e6d25342088a84017a6e0e918dd4434609e8069b
-  data.tar.gz: 26ead8a785f7ae3990c4117c5d489f031335f7adde98a4d45737ae031e363509d8d1985dff41751d63d1d8bb66c8bedd8afd8270f29b639b4322c3a1ec4325fe
+  metadata.gz: 9db99babf8e9e508f875517cb5890d300362018384e56fa9ac3ca30763cca55d500ad836e4153b66516b2f1ad2f7b5549cab682e83c6da833cd7fa9e20e1da5a
+  data.tar.gz: 788ede8be0748a6baf69e23354996f51155cbd628dec2af8619ea8bcfb855071d5ed6fd57f66a0577884ebd03fc1e10c66991778cafb502fdc261d5f6069c135

data/lib/jekyll-webmention_io.rb

@@ -3,4 +3,6 @@
 require "jekyll"
 require "jekyll/webmention_io"
 
-Jekyll::WebmentionIO.bootstrap
+Jekyll::Hooks.register :site, :after_init do |site|
+  Jekyll::WebmentionIO.bootstrap(site)
+end

data/lib/jekyll/commands/webmention.rb

@@ -15,13 +15,13 @@ module Jekyll
       end
 
       def self.process(_args = [], _options = {})
-        if File.exist? "#{Jekyll::WebmentionIO.cache_folder}/#{Jekyll::WebmentionIO.file_prefix}sent.yml"
+        if File.exist? Jekyll::WebmentionIO.cache_file("sent.yml")
           Jekyll::WebmentionIO.log "error", "Your outgoing webmentions queue needs to be upgraded. Please re-build your project."
         end
         count = 0
         cached_outgoing = Jekyll::WebmentionIO.get_cache_file_path "outgoing"
         if File.exist?(cached_outgoing)
-          outgoing = open(cached_outgoing) { |f| YAML.load(f) }
+          outgoing = Jekyll::WebmentionIO.load_yaml(cached_outgoing)
           outgoing.each do |source, targets|
             targets.each do |target, response|
               next unless response == false

data/lib/jekyll/generators/compile_js.rb

@@ -45,7 +45,7 @@ module Jekyll
 
         @source_file_destination = (config["source"] == false ? Dir.mktmpdir : "#{@site.config["source"]}/#{config["destination"]}")
 
-        @javascript = String.new ""
+        @javascript = +"" # unfrozen String
 
         concatenate_asset_files
 
@@ -62,7 +62,9 @@ module Jekyll
         end
       end
 
-      private def add_webmention_types
+      private
+
+      def add_webmention_types
         js_types = []
         Jekyll::WebmentionIO.types.each do |type|
           js_types.push "'#{type}': '#{type.to_singular}'"
@@ -76,7 +78,7 @@ module Jekyll
         @javascript << types_js.sub(/TYPES/, js_types.join(","))
       end
 
-      private def concatenate_asset_files
+      def concatenate_asset_files
         source = File.expand_path("../assets/", __dir__)
         Dir["#{source}/*.js"].each do |file|
           handler = File.open(file, "rb")
@@ -84,19 +86,19 @@ module Jekyll
         end
       end
 
-      private def uglify
+      def uglify
         uglify_config = {
           :harmony => true,
         }
         @javascript = Uglifier.new(uglify_config).compile(@javascript)
       end
 
-      private def create_js_file
+      def create_js_file
         Dir.mkdir(@source_file_destination) unless File.exist?(@source_file_destination)
         File.open("#{@source_file_destination}/#{@file_name}", "w") { |f| f.write(@javascript) }
       end
 
-      private def deploy_js_file
+      def deploy_js_file
         js_file = Jekyll::WebmentionIO::JavaScriptFile.new(@site, @source_file_destination, "", @file_name)
         @site.static_files << js_file
       end

data/lib/jekyll/generators/queue_webmentions.rb

@@ -72,13 +72,13 @@ module Jekyll
     end
 
     def upgrade_outgoing_webmention_cache
-      old_sent_file = "#{Jekyll::WebmentionIO.cache_folder}/#{Jekyll::WebmentionIO.file_prefix}sent.yml"
-      old_outgoing_file = "#{Jekyll::WebmentionIO.cache_folder}/#{Jekyll::WebmentionIO.file_prefix}queued.yml"
+      old_sent_file = Jekyll::WebmentionIO.cache_file("sent.yml")
+      old_outgoing_file = Jekyll::WebmentionIO.cache_file("queued.yml")
       unless File.exist? old_sent_file
         return
       end
-      sent_webmentions = open(old_sent_file) { |f| YAML.load(f) }
-      outgoing_webmentions = open(old_outgoing_file) { |f| YAML.load(f) }
+      sent_webmentions = Jekyll::WebmentionIO.load_yaml(old_sent_file)
+      outgoing_webmentions = Jekyll::WebmentionIO.load_yaml(old_outgoing_file)
       merged = {}
       outgoing_webmentions.each do |source_url, webmentions|
         collection = {}

data/lib/jekyll/tags/bookmarks.rb

@@ -11,17 +11,12 @@
 #
 module Jekyll
   module WebmentionIO
-    class WebmentionBookmarksTag < WebmentionTag
+    class WebmentionBookmarksTag < WebmentionTypeTag
       def initialize(tag_name, text, tokens)
         super
         @text = text
         self.template = "bookmarks"
       end
-
-      def set_data(data, _types)
-        webmentions = extract_type @template_name, data
-        @data = { "webmentions" => webmentions.values }
-      end
     end
   end
 end

data/lib/jekyll/tags/likes.rb

@@ -11,17 +11,12 @@
 #
 module Jekyll
   module WebmentionIO
-    class WebmentionLikesTag < WebmentionTag
+    class WebmentionLikesTag < WebmentionTypeTag
       def initialize(tag_name, text, tokens)
         super
         @text = text
         self.template = "likes"
       end
-
-      def set_data(data, _types)
-        webmentions = extract_type @template_name, data
-        @data = { "webmentions" => webmentions.values }
-      end
     end
   end
 end

data/lib/jekyll/tags/links.rb

@@ -11,17 +11,12 @@
 #
 module Jekyll
   module WebmentionIO
-    class WebmentionLinksTag < WebmentionTag
+    class WebmentionLinksTag < WebmentionTypeTag
       def initialize(tag_name, text, tokens)
         super
         @text = text
         self.template = "links"
       end
-
-      def set_data(data, _types)
-        webmentions = extract_type @template_name, data
-        @data = { "webmentions" => webmentions.values }
-      end
     end
   end
 end

data/lib/jekyll/tags/posts.rb

@@ -11,17 +11,12 @@
 #
 module Jekyll
   module WebmentionIO
-    class WebmentionPostsTag < WebmentionTag
+    class WebmentionPostsTag < WebmentionTypeTag
       def initialize(tag_name, text, tokens)
         super
         @text = text
         self.template = "posts"
       end
-
-      def set_data(data, _types)
-        webmentions = extract_type @template_name, data
-        @data = { "webmentions" => webmentions.values }
-      end
     end
   end
 end

data/lib/jekyll/tags/replies.rb

@@ -11,17 +11,12 @@
 #
 module Jekyll
   module WebmentionIO
-    class WebmentionRepliesTag < WebmentionTag
+    class WebmentionRepliesTag < WebmentionTypeTag
       def initialize(tag_name, text, tokens)
         super
         @text = text
         self.template = "replies"
       end
-
-      def set_data(data, _types)
-        webmentions = extract_type @template_name, data
-        @data = { "webmentions" => webmentions.values }
-      end
     end
   end
 end

data/lib/jekyll/tags/reposts.rb

@@ -11,17 +11,12 @@
 #
 module Jekyll
   module WebmentionIO
-    class WebmentionRepostsTag < WebmentionTag
+    class WebmentionRepostsTag < WebmentionTypeTag
       def initialize(tag_name, text, tokens)
         super
         @text = text
         self.template = "reposts"
       end
-
-      def set_data(data, _types)
-        webmentions = extract_type @template_name, data
-        @data = { "webmentions" => webmentions.values }
-      end
     end
   end
 end

data/lib/jekyll/tags/rsvps.rb

@@ -11,17 +11,12 @@
 #
 module Jekyll
   module WebmentionIO
-    class WebmentionRsvpsTag < WebmentionTag
+    class WebmentionRsvpsTag < WebmentionTypeTag
       def initialize(tag_name, text, tokens)
         super
         @text = text
         self.template = "rsvps"
       end
-
-      def set_data(data, _types)
-        webmentions = extract_type @template_name, data
-        @data = { "webmentions" => webmentions.values }
-      end
     end
   end
 end

data/lib/jekyll/tags/{_.rb → webmention.rb}

@@ -17,7 +17,7 @@ module Jekyll
         super
         cache_file = Jekyll::WebmentionIO.get_cache_file_path "incoming"
         @cached_webmentions = if File.exist? cache_file
-                                open(cache_file) { |f| YAML.load(f) }
+                                Jekyll::WebmentionIO.load_yaml(cache_file)
                               else
                                 {}
                               end

data/lib/jekyll/tags/webmention_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+#  (c) Aaron Gustafson
+#  https://github.com/aarongustafson/jekyll-webmention_io
+#  Licence : MIT
+#
+#  this liquid plugin insert a webmentions into your Octopress or Jekyll blog
+#  using http://webmention.io/
+#
+module Jekyll
+  module WebmentionIO
+    # Superclass for Webmention types:
+    # [ bookmarks | likes | links | posts | replies | reposts | rsvps ]
+    class WebmentionTypeTag < WebmentionTag
+      def set_data(data, _types)
+        webmentions = extract_type @template_name, data
+        @data = { "webmentions" => webmentions.values }
+      end
+    end
+  end
+end

data/lib/jekyll/tags/webmentions_head.rb

@@ -11,7 +11,7 @@ module Jekyll
   module WebmentionIO
     class WebmentionHeadTag < Liquid::Tag
       def render(context)
-        head = String.new ""
+        head = +"" # unfrozen String
         head << '<link rel="dns-prefetch" href="https://webmention.io">'
         head << '<link rel="preconnect" href="https://webmention.io">'
         head << '<link rel="preconnect" href="ws://webmention.io:8080">'

data/lib/jekyll/tags/webmentions_js.rb

@@ -27,14 +27,15 @@ module Jekyll
         config = config.merge(site_config)
 
         # JS file
-        js = String.new ""
+        js = +"" # unfrozen String
         unless config["deploy"] == false
-          js_file_path = "#{site.config["baseurl"]}/#{config["destination"]}/JekyllWebmentionIO.js"
+          destination = config["destination"].chomp("/").reverse.chomp("/").reverse # removes prefix & suffix "/"
+          js_file_path = "#{site.config["baseurl"]}/#{destination}/JekyllWebmentionIO.js"
           js << "<script src=\"#{js_file_path}\" async></script>"
         end
 
         Jekyll::WebmentionIO.log "info", "Gathering templates for JavaScript."
-        templates = String.new ""
+        templates = +"" # unfrozen String
         template_files = Jekyll::WebmentionIO.types + %w(count webmentions)
         template_files.each do |template|
           templates << "<template style=\"display:none\" id=\"webmention-#{template}\">"

data/lib/jekyll/webmention_io.rb

@@ -41,21 +41,21 @@ module Jekyll
       OpenSSL::SSL::SSLError,
     ].freeze
 
-    def self.bootstrap
-      # @jekyll_config = Jekyll.configuration({ 'quiet' => true })
-      @jekyll_config = Jekyll.configuration({})
+    def self.bootstrap(site)
+      @site = site
+      @jekyll_config = site.config
       @config = @jekyll_config["webmentions"] || {}
 
       # Set up the cache folder & files
-      @cache_folder = @config["cache_folder"] || ".jekyll-cache"
+      @cache_folder = site.in_source_dir(@config["cache_folder"] || ".jekyll-cache")
       Dir.mkdir(@cache_folder) unless File.exist?(@cache_folder)
       @file_prefix = ""
       @file_prefix = "webmention_io_" unless @cache_folder.include? "webmention"
       @cache_files = {
-        "incoming" => "#{@cache_folder}/#{@file_prefix}received.yml",
-        "outgoing" => "#{@cache_folder}/#{@file_prefix}outgoing.yml",
-        "bad_uris" => "#{@cache_folder}/#{@file_prefix}bad_uris.yml",
-        "lookups"  => "#{@cache_folder}/#{@file_prefix}lookups.yml"
+        "incoming" => cache_file("received.yml"),
+        "outgoing" => cache_file("outgoing.yml"),
+        "bad_uris" => cache_file("bad_uris.yml"),
+        "lookups"  => cache_file("lookups.yml")
       }
       @cache_files.each_value do |file|
         unless File.exist?(file)
@@ -69,7 +69,11 @@ module Jekyll
       @api_endpoint = "#{@api_url}/#{path}"
     end
 
-    # Heplers
+    # Helpers
+    def self.cache_file(filename)
+      Jekyll.sanitized_path(@cache_folder, "#{@file_prefix}#{filename}")
+    end
+
     def self.get_cache_file_path(key)
       path = false
       if @cache_files.key? key
@@ -84,9 +88,7 @@ module Jekyll
       end
 
       cache_file = get_cache_file_path which
-      cached_webmentions = open(cache_file) { |f| YAML.load(f) }
-
-      cached_webmentions
+      load_yaml(cache_file)
     end
 
     def self.cache_webmentions(which, webmentions)
@@ -140,8 +142,7 @@ module Jekyll
 
     def self.read_lookup_dates()
       cache_file = get_cache_file_path "lookups"
-      lookups = open(cache_file) { |f| YAML.load(f) }
-      lookups
+      load_yaml(cache_file)
     end
 
     def self.cache_lookup_dates(lookups)
@@ -286,6 +287,14 @@ module Jekyll
       File.open(file, "wb") { |f| f.puts YAML.dump(data) }
     end
 
+    # Utility Method
+    # Safely parse given YAML +file+ path and return data.
+    #
+    # Returns empty hash if parsing fails to return data
+    def self.load_yaml(file)
+      SafeYAML.load_file(file) || {}
+    end
+
     private
 
     def self.get_http_response(uri)
@@ -315,7 +324,7 @@ module Jekyll
       # Never cache webmention.io in here
       return if uri.host == "webmention.io"
       cache_file = @cache_files["bad_uris"]
-      bad_uris = open(cache_file) { |f| YAML.load(f) }
+      bad_uris = load_yaml(cache_file)
       bad_uris[uri.host] = Time.now.to_s
       dump_yaml(cache_file, bad_uris)
     end
@@ -323,7 +332,7 @@ module Jekyll
     def self.uri_ok?(uri)
       uri = URI.parse(URI.encode(uri))
       now = Time.now.to_s
-      bad_uris = open(@cache_files["bad_uris"]) { |f| YAML.load(f) }
+      bad_uris = load_yaml(@cache_files["bad_uris"])
       if bad_uris.key? uri.host
         last_checked = DateTime.parse(bad_uris[uri.host])
         cache_bad_uris_for = @config["cache_bad_uris_for"] || 1 # in days
@@ -345,5 +354,6 @@ end
 require_all "commands"
 require_all "generators"
 
-require_relative "tags/_.rb"
+require_relative "tags/webmention"
+require_relative "tags/webmention_type"
 require_all "tags"

data/lib/jekyll/webmention_io/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module WebmentionIO
-    VERSION = "2.9.7"
+    VERSION = "3.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-webmention_io
 version: !ruby/object:Gem::Version
-  version: 2.9.7
+  version: 3.0.0
 platform: ruby
 authors:
 - Aaron Gustafson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-04 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -232,7 +232,6 @@ files:
 - lib/jekyll/generators/compile_js.rb
 - lib/jekyll/generators/gather_webmentions.rb
 - lib/jekyll/generators/queue_webmentions.rb
-- lib/jekyll/tags/_.rb
 - lib/jekyll/tags/bookmarks.rb
 - lib/jekyll/tags/count.rb
 - lib/jekyll/tags/likes.rb
@@ -241,6 +240,8 @@ files:
 - lib/jekyll/tags/replies.rb
 - lib/jekyll/tags/reposts.rb
 - lib/jekyll/tags/rsvps.rb
+- lib/jekyll/tags/webmention.rb
+- lib/jekyll/tags/webmention_type.rb
 - lib/jekyll/tags/webmentions.rb
 - lib/jekyll/tags/webmentions_head.rb
 - lib/jekyll/tags/webmentions_js.rb