jekyll-webmention_io 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6830a7a6abb84d8ba34c51b817ad817147561818
-  data.tar.gz: 37956daf8a417c5a9fcbae7e1337c6993a82e746
+  metadata.gz: 9aae045b55d22d92d88b0345073c4ffe64206da5
+  data.tar.gz: 28b163e15deda415f8ed2c6c5621654545a032cb
 SHA512:
-  metadata.gz: 9db99babf8e9e508f875517cb5890d300362018384e56fa9ac3ca30763cca55d500ad836e4153b66516b2f1ad2f7b5549cab682e83c6da833cd7fa9e20e1da5a
-  data.tar.gz: 788ede8be0748a6baf69e23354996f51155cbd628dec2af8619ea8bcfb855071d5ed6fd57f66a0577884ebd03fc1e10c66991778cafb502fdc261d5f6069c135
+  metadata.gz: 13af37e1c35dec286855885086586f7e8f9caca23ca672e7ef8ec64c4e21633a600e54e921466e67111d74e4fcfee3f99601dcab0f15db7ece76ce29406b9450
+  data.tar.gz: 7f5c71a216c6deb7cd13bba1c0fde8ea7d103cc9d33a004bd95e0c7796e4d6119e94b3b2aeacd7ac8bf86df5d52fa3ac480690b79401696bfc63c38a8d342c61

data/lib/jekyll/generators/compile_js.rb

@@ -13,12 +13,7 @@ module Jekyll
   module WebmentionIO
     class JavaScriptFile < StaticFile
       def destination_rel_dir
-        config = {
-          "destination" => "js",
-        }
-        js_config = Jekyll::WebmentionIO.config["js"] || {}
-        config = config.merge(js_config)
-        config["destination"]
+        Jekyll::WebmentionIO.js_handler.destination
       end
     end
 
@@ -28,38 +23,29 @@ module Jekyll
       priority :low
 
       def generate(site)
+        handler = Jekyll::WebmentionIO.js_handler
         @site = site
-        @file_name = "JekyllWebmentionIO.js"
+        @file_name = handler.resource_name
 
-        if @site.config.dig("webmentions", "js") == false
+        if handler.disabled?
           Jekyll::WebmentionIO.log "info", "Skipping JavaScript inclusion."
           return
         end
 
-        config = {
-          "destination" => "js",
-          "uglify"      => true,
-        }
-        site_config = @site.config.dig("webmentions", "js") || {}
-        config = config.merge(site_config)
-
-        @source_file_destination = (config["source"] == false ? Dir.mktmpdir : "#{@site.config["source"]}/#{config["destination"]}")
+        @source_file_destination = if handler.source?
+                                     @site.in_source_dir(handler.destination)
+                                   else
+                                     Dir.mktmpdir
+                                   end
 
         @javascript = +"" # unfrozen String
 
         concatenate_asset_files
-
         add_webmention_types
 
-        unless config["uglify"] == false
-          uglify
-        end
-
+        uglify if handler.uglify?
         create_js_file
-
-        unless config["deploy"] == false
-          deploy_js_file
-        end
+        deploy_js_file if handler.deploy?
       end
 
       private
@@ -75,27 +61,24 @@ module Jekyll
             JekyllWebmentionIO.types = { TYPES };
           }(this, this.JekyllWebmentionIO));
         EOF
-        @javascript << types_js.sub(/TYPES/, js_types.join(","))
+        @javascript << types_js.sub("TYPES", js_types.join(","))
       end
 
       def concatenate_asset_files
-        source = File.expand_path("../assets/", __dir__)
-        Dir["#{source}/*.js"].each do |file|
-          handler = File.open(file, "rb")
-          @javascript << File.read(handler)
+        assets_dir = File.expand_path("../assets/", __dir__)
+        Dir["#{assets_dir}/*.js"].each do |file|
+          file_handler = File.open(file, "rb")
+          @javascript << File.read(file_handler)
         end
       end
 
       def uglify
-        uglify_config = {
-          :harmony => true,
-        }
-        @javascript = Uglifier.new(uglify_config).compile(@javascript)
+        @javascript = Uglifier.new(:harmony => true).compile(@javascript)
       end
 
       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) }
+        File.open(File.join(@source_file_destination, @file_name), "wb") { |f| f.write(@javascript) }
       end
 
       def deploy_js_file

data/lib/jekyll/tags/webmention.rb

@@ -32,8 +32,9 @@ module Jekyll
       end
 
       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
+        unless Jekyll::WebmentionIO.supported_templates.include? template
+          Jekyll::WebmentionIO.log "error", "#{template.capitalize} is not supported"
+        end
         @template_name = template
         @template = Jekyll::WebmentionIO.get_template_contents(template)
         Jekyll::WebmentionIO.log "info", "#{template.capitalize} template:\n\n#{@template}\n\n"

data/lib/jekyll/tags/webmentions_js.rb

@@ -10,40 +10,8 @@
 module Jekyll
   module WebmentionIO
     class WebmentionJSTag < Liquid::Tag
-      def render(context)
-        site = context.registers[:site]
-
-        # JS can be turned off too
-        if site.config.dig("webmentions", "js") == false
-          Jekyll::WebmentionIO.log "info", "JavaScript output is disabled, so the {% webmentions_js %} tag is being skipped"
-          return ""
-        end
-
-        config = {
-          "destination" => "js",
-          "uglify"      => true,
-        }
-        site_config = site.config.dig("webmentions", "js") || {}
-        config = config.merge(site_config)
-
-        # JS file
-        js = +"" # unfrozen String
-        unless config["deploy"] == false
-          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 = +"" # unfrozen String
-        template_files = Jekyll::WebmentionIO.types + %w(count webmentions)
-        template_files.each do |template|
-          templates << "<template style=\"display:none\" id=\"webmention-#{template}\">"
-          templates << Jekyll::WebmentionIO.get_template_contents(template)
-          templates << "</template>"
-        end
-
-        "#{js}\n#{templates}"
+      def render(_context)
+        Jekyll::WebmentionIO.js_handler.render
       end
     end
   end

data/lib/jekyll/webmention_io.rb

@@ -9,6 +9,7 @@
 #
 require_relative "webmention_io/version"
 require_relative "webmention_io/webmention"
+require_relative "webmention_io/js_handler"
 
 require "json"
 require "net/http"
@@ -22,7 +23,7 @@ module Jekyll
     class << self
       # define simple getters and setters
       attr_reader :config, :jekyll_config, :cache_files, :cache_folder,
-                  :file_prefix, :types
+                  :file_prefix, :types, :supported_templates, :js_handler
       attr_writer :api_suffix
     end
 
@@ -32,7 +33,11 @@ module Jekyll
     @api_endpoint = @api_url
     @api_suffix = ""
 
-    @types = %w(bookmarks likes links posts replies reposts rsvps)
+    @types = %w(bookmarks likes links posts replies reposts rsvps).freeze
+    @supported_templates = (@types + %w(count webmentions)).freeze
+
+    @template_file_cache = {}
+    @template_content_cache = {}
 
     EXCEPTIONS = [
       SocketError, Timeout::Error,
@@ -58,10 +63,10 @@ module Jekyll
         "lookups"  => cache_file("lookups.yml")
       }
       @cache_files.each_value do |file|
-        unless File.exist?(file)
-          dump_yaml(file)
-        end
+        dump_yaml(file) unless File.exist?(file)
       end
+
+      @js_handler = Jekyll::WebmentionIO::JSHandler.new(site)
     end
 
     # Setter
@@ -75,17 +80,11 @@ module Jekyll
     end
 
     def self.get_cache_file_path(key)
-      path = false
-      if @cache_files.key? key
-        path = @cache_files[key]
-      end
-      return path
+      @cache_files[key] || false
     end
 
     def self.read_cached_webmentions(which)
-      unless %w(incoming outgoing).include? which
-        return {}
-      end
+      return {} unless %w(incoming outgoing).include?(which)
 
       cache_file = get_cache_file_path which
       load_yaml(cache_file)
@@ -136,7 +135,7 @@ module Jekyll
       if source
         JSON.parse(source)
       else
-        ""
+        {}
       end
     end
 
@@ -235,15 +234,36 @@ module Jekyll
       end
     end
 
+    def self.template_file(template)
+      @template_file_cache[template] ||= begin
+        configured_template = @config.dig("templates", template)
+        if configured_template
+          log "info", "Using custom #{template} template"
+          configured_template
+        else
+          File.expand_path("templates/#{template}.html", __dir__)
+        end
+      end
+    end
+
     def self.get_template_contents(template)
-      template_file = if @config.dig("templates", template)
-                        log "info", "Using custom #{template} template"
-                        @config["templates"][template]
-                      else
-                        File.expand_path("templates/#{template}.html", __dir__)
-                      end
-      log "info", "Template file: #{template_file}"
-      File.read(template_file)
+      template_file = template_file(template)
+      @template_content_cache[template_file] ||= begin
+        log "info", "Template file: #{template_file}"
+        File.read(template_file)
+      end
+    end
+
+    def self.html_templates
+      @html_templates ||= begin
+        templates = +"" # unfrozen String
+        supported_templates.each do |template|
+          templates << "<template style=\"display:none\" id=\"webmention-#{template}\">"
+          templates << get_template_contents(template)
+          templates << "</template>"
+        end
+        templates
+      end
     end
 
     # Connections

data/lib/jekyll/webmention_io/js_handler.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+#  (c) Aaron Gustafson
+#  https://github.com/aarongustafson/jekyll-webmention_io
+#  Licence : MIT
+#
+
+module Jekyll
+  module WebmentionIO
+    class JSHandler
+      attr_reader :destination, :resource_name, :resource_url
+
+      DEFAULTS = {
+        "destination" => "js",
+        "source"      => true,
+        "deploy"      => true,
+        "uglify"      => true,
+      }.freeze
+
+      def initialize(site)
+        js_config = site.config.dig("webmentions", "js")
+
+        @disabled = js_config == false
+
+        js_config = {} unless js_config.is_a?(Hash)
+        js_config = DEFAULTS.merge(js_config)
+
+        @deploy, @uglify, @source, @destination = js_config.values_at("deploy", "uglify", "source", "destination")
+        @resource_name = "JekyllWebmentionIO.js"
+        @resource_url = File.join(
+          "", site.config["baseurl"], @destination, @resource_name
+        )
+      end
+
+      def disabled?
+        @disabled == true
+      end
+
+      def deploy?
+        @deploy != false
+      end
+
+      def uglify?
+        @uglify != false
+      end
+
+      def source?
+        @source != false
+      end
+
+      def render
+        if disabled?
+          Jekyll::WebmentionIO.log "info",
+            "JavaScript output is disabled, so the {% webmentions_js %} tag is being skipped"
+          return ""
+        end
+
+        js_file = deploy? ? "<script src=\"#@resource_url\" async></script>" : ""
+
+        Jekyll::WebmentionIO.log "info", "Gathering templates for JavaScript."
+        "#{js_file}\n#{Jekyll::WebmentionIO.html_templates}"
+      end
+    end
+  end
+end

data/lib/jekyll/webmention_io/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-webmention_io
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Aaron Gustafson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2018-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -255,6 +255,7 @@ files:
 - lib/jekyll/templates/rsvps.html
 - lib/jekyll/templates/webmentions.html
 - lib/jekyll/webmention_io.rb
+- lib/jekyll/webmention_io/js_handler.rb
 - lib/jekyll/webmention_io/version.rb
 - lib/jekyll/webmention_io/webmention.rb
 homepage: https://github.com/aarongustafson/jekyll-webmention_io