jekyll-workbox-plugin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 073d7c6b7b494b9a1e4958b22108e998bfcfb40a
+  data.tar.gz: 1bc21f65b26ca7a33ae2d3fa7f035f5238711490
+SHA512:
+  metadata.gz: d5da36555245318273478130a6744b4103a15bc0bcf4418b75780448bebdaee71533c05f1dafce714e990ff6eb0c2a9ab6a71976d5b171347259aba2fe18e50d
+  data.tar.gz: 1a26d9c655caeeaea9dbd90cda12c155a76ad6877ccc042582558a72c2bcdfe276c6259c7a95e7de4859bd3f392f90616eb64cb09d0c25d989b562e1cc0c9cf9

data/lib/jekyll-workbox-plugin.rb

@@ -0,0 +1,97 @@
+class WorkboxHelper
+    WORKBOX_VERSION = '3.6.3'
+
+    def initialize(site, config)
+        @site = site
+        @config = config
+        @sw_filename = @config['sw_dest_filename'] || 'sw.js'
+        @sw_src_filepath = @config['sw_src_filepath'] || 'sw.js'
+    end
+
+    def generate_workbox_precache()
+        directory = @config['precache_glob_directory'] || '/'
+        directory = @site.in_dest_dir(directory)
+        patterns = @config['precache_glob_patterns'] || ['**/*.{html,js,css,eot,svg,ttf,woff}']
+        ignores = @config['precache_glob_ignores'] || []
+        recent_posts_num = @config['precache_recent_posts_num']
+
+        # according to workbox precache {url: 'main.js', revision: 'xxxx'}
+        @precache_list = []
+
+        # find precache files with glob
+        precache_files = []
+        patterns.each do |pattern|
+            Dir.glob(File.join(directory, pattern)) do |filepath|
+                precache_files.push(filepath)
+            end
+        end
+        precache_files = precache_files.uniq
+
+        # precache recent n posts
+        posts_path_url_map = {}
+        if recent_posts_num
+            precache_files.concat(
+                @site.posts.docs
+                    .reverse.take(recent_posts_num)
+                    .map do |post|
+                        posts_path_url_map[post.path] = post.url
+                        post.path
+                    end
+            )
+        end
+
+        # filter with ignores
+        ignores.each do |pattern|
+            Dir.glob(File.join(directory, pattern)) do |ignored_filepath|
+                precache_files.delete(ignored_filepath)
+            end
+        end
+
+        # generate md5 for each precache file
+        md5 = Digest::MD5.new
+        precache_files.each do |filepath|
+            md5.reset
+            md5 << File.read(filepath)
+            if posts_path_url_map[filepath]
+                url = posts_path_url_map[filepath]
+            else
+                url = filepath.sub(@site.dest, '')
+            end
+            @precache_list.push({
+                url: @site.baseurl.to_s + url,
+                revision: md5.hexdigest
+            })
+        end
+    end
+
+    def write_sw()
+        # read the sw.js source file
+        sw_js_str = File.read(@site.in_source_dir(@sw_src_filepath))
+
+        # prepend the import scripts
+        sw_js_str = "importScripts('https://storage.googleapis.com/workbox-cdn/releases/#{WorkboxHelper::WORKBOX_VERSION}/workbox-sw.js');\n#{sw_js_str}"
+
+        # generate precache list and inject it into the sw.js
+        precache_list_str = @precache_list.map do |precache_item|
+            precache_item.to_json
+        end.join(",")
+        sw_js_str = sw_js_str.sub(
+            "workbox.precaching.precacheAndRoute([])",
+            "workbox.precaching.precacheAndRoute([#{precache_list_str}])")
+
+        # write sw.js
+        sw_dest_file = File.new(@site.in_dest_dir(@sw_filename), 'w')
+        sw_dest_file.puts(sw_js_str)
+        sw_dest_file.close
+    end
+end
+
+module Jekyll
+    Hooks.register :site, :post_write do |site|
+        pwa_config = site.config['workbox'] || {}
+        sw_helper = WorkboxHelper.new(site, pwa_config)
+
+        sw_helper.generate_workbox_precache()
+        sw_helper.write_sw()
+    end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-workbox-plugin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benedikt Meurer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-06 00:00:00.000000000 Z
+dependencies: []
+description: This plugin provides workbox support for Jekyll. Generate a service worker
+  and provides precache with Google Workbox.
+email: benedikt.meurer@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-workbox-plugin.rb
+homepage: https://github.com/bmeurer/jekyll-workbox-plugin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Workbox support for Jekyll.
+test_files: []