jekyll-pwa-plugin 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d00791acb3f062e7183e0a5c84c173cb1e5dbf1
+  data.tar.gz: f37c8e7c126215fcc5e579b0160519140c0f6232
+SHA512:
+  metadata.gz: eead320aafa5338e9d090b16e1ec2d636f9bff5fe0fa7918badf73bc4e24bf874b85a64f5c192f14a634b837e5c3ffbf5b6bed173440c940bf7c978cd9fa0c83
+  data.tar.gz: fc2a2c38e9e8b21c20f87b39612afc806ebed86245828bfed0c372a1b3808de1aebfda740eb9dfb9e5ecc24ac7c2d6ca070222703d08bbf11a609d61b882d28a

data/lib/jekyll-pwa-plugin.rb

@@ -0,0 +1,159 @@
+class SWHelper
+    def initialize(site, config)
+        @site = site
+        @config = config
+        @sw_filename = @config['sw_filename'] || 'service-worker'
+    end
+
+    def write_sw_register()
+        sw_register_filename = 'sw-register.js'
+        sw_register_file = File.new(File.join(@site.dest, sw_register_filename), 'w')
+        # add build version in url params
+        sw_register_file.puts(
+        <<-SCRIPT
+            navigator.serviceWorker
+                && navigator.serviceWorker.register('/#{@sw_filename}?v=#{@site.time.to_i.to_s}');
+        SCRIPT
+        )
+        sw_register_file.close
+    end
+
+    def generate_workbox_precache()
+        directory = @config['precache_glob_directory'] || '/'
+        directory = File.join(@site.dest, 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 + url,
+                revision: md5.hexdigest
+            })
+        end
+    end
+
+    def write_sw()
+        cache_name = @config['cache_name'] || 'workbox'
+        precache_channel_name = @config['precache_channel_name'] || 'sw-precache'
+        runtime_cache = @config['runtime_cache'] || []
+
+        # generate precache list
+        precache_list_str = @precache_list.map do |precache_item|
+            precache_item.to_json
+        end
+        .join(",")
+
+        # generate runtime cache route
+        runtime_cache_str = runtime_cache.map do |runtime_item|
+            <<-SCRIPT
+                workboxSW.router.registerRoute(#{runtime_item['route']},
+                    workboxSW.strategies.#{runtime_item['strategy'] || 'networkFirst'}());
+            SCRIPT
+        end
+        .join("\n")
+
+        # write service-worker.js
+        sw_file = File.new(File.join(@site.dest, @sw_filename), 'w')
+        sw_file.puts(
+        <<-SCRIPT
+            importScripts('#{@site.baseurl}/js/broadcast-channel-polyfill.js');
+            importScripts('#{@site.baseurl}/js/workbox-sw.dev.v2.1.1.js');
+
+            const workboxSW = new WorkboxSW({
+                cacheId: '#{cache_name}',
+                ignoreUrlParametersMatching: [/^utm_/],
+                skipWaiting: true,
+                clientsClaim: true,
+                precacheChannelName: '#{precache_channel_name}'
+            });
+
+            workboxSW.precache([#{precache_list_str}]);
+            #{runtime_cache_str}
+        SCRIPT
+        )
+        sw_file.close
+    end
+
+    def self.insert_sw_register_into_body(page)
+        page.output = page.output.sub('</body>',
+        <<-SCRIPT
+            <script>
+                window.onload = function () {
+                    var script = document.createElement('script');
+                    var firstScript = document.getElementsByTagName('script')[0];
+                    script.type = 'text/javascript';
+                    script.async = true;
+                    script.src = '#{page.site.baseurl}/sw-register.js?v=' + Date.now();
+                    firstScript.parentNode.insertBefore(script, firstScript);
+                };
+            </script>
+            </body>
+        SCRIPT
+        )
+    end
+end
+
+module Jekyll
+
+    Hooks.register :pages, :post_render do |page|
+        # append <script> for sw-register.js in <body>
+        SWHelper.insert_sw_register_into_body(page)
+    end
+
+    Hooks.register :documents, :post_render do |document|
+        # append <script> for sw-register.js in <body>
+        SWHelper.insert_sw_register_into_body(document)
+    end
+
+    Hooks.register :site, :post_write do |site|
+        pwa_config = site.config['pwa'] || {}
+        sw_helper = SWHelper.new(site, pwa_config)
+
+        sw_helper.write_sw_register()
+        sw_helper.generate_workbox_precache()
+        sw_helper.write_sw()
+    end
+
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-pwa-plugin
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Pan Yuqi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-08 00:00:00.000000000 Z
+dependencies: []
+description: This plugin provides PWA support for Jekyll. Generate a service worker
+  and provides precache with Google Workbox.
+email: pyqiverson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-pwa-plugin.rb
+homepage: http://rubygems.org/gems/jekyll-pwa-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.6.12
+signing_key: 
+specification_version: 4
+summary: PWA support for Jekyll.
+test_files: []