rails-pwa 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4811d830ba5b148efc86a73fcf49d4d1a1b259f59ee50c0a6bfb1da8de7a164
-  data.tar.gz: 8d98f29ad9414c35261fb1c115ed8dc213e6d76e9dd860f42c2edcff3e4639a0
+  metadata.gz: 3244af30921cbd3649866dc9920f6ac7cc6928e2752e56dc8198c22ecb747c94
+  data.tar.gz: 9f124aeb326d6b8d70f2a981ad7e95101645c5727d0582a34f372f2f5889fbd8
 SHA512:
-  metadata.gz: a370a3dc95b8f933fae24df705c277227c282da8a7cc9754adf371c8be26729b158b81eb8ca56c64cbbdb34d974c56a4033b290d536e33ab605cd8ebd89c07f6
-  data.tar.gz: aa18469b4035d78c290601948f2af7d3ba129d2baadae3bc04d2b890def06d19ae3df33b217197f4be579384c8c1ccac50d03817eee6bf4a730aa2508f6d33d5
+  metadata.gz: 98868d94a06273931e040cf078fc241e117b383c8f0fdfd799e445a98340fdd603fb4658ba3495715f91812e73f12f872b5e904cece36f97991fd072a2c95bd4
+  data.tar.gz: c8ff81cc8c89efe14adcb1fc90b95741fdbcd48ef2a0dc7b6e16d7f2a2b86fcf687cd3654686a3262452b4d4ca73c983a1802a93aa7c9c52586c7033a2b9247b

data/README.md

@@ -1,8 +1,34 @@
-# Rails::Pwa
-Short description and motivation.
+# Rails::PWA
+A simple hack to serve service worker scripts from rails apps.
+
+_TLDR_: Serves the webpack defined at `app/javascripts/packs/worker.js` from `/worker.js`
+
+Service workers can only intercept requests in the directory and subdirectory they are served from. Rails serves webpacked javascript from paths similar to `/packs/js/application-abcd1234.js`. Any service worker served from a path like this would only be able to operate on paths under `/packs/js/`; generally not what you want.
+
+This gem lets you create a javascript pack for a service worker, and serve it from `/worker.js`.
 
 ## Usage
-How to use my plugin.
+Install the gem (see full instructions below).
+
+Restart your server (so the gem's middleware can be added to the app).
+
+Add a service worker pack by creating a file `app/javascript/packs/worker.js`. Here's a simple example to get started:
+
+```js
+for (const name of ["install", "activate", "fetch"]) {
+  self.addEventListener(name, event => console.log(event))
+}
+```
+
+You also need to register your worker, adding something like this to `app/javascript/packs/application.js`:
+
+```
+if ("serviceWorker" in navigator) {
+  window.addEventListener("load", function () {
+    navigator.serviceWorker.register("/worker.js")
+  })
+}
+```
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,8 +47,12 @@ Or install it yourself as:
 $ gem install rails-pwa
 ```
 
-## Contributing
-Contribution directions go here.
+## How it works
+
+This gem installs a very simple piece of `Rack::Middleware` into your app, which intercepts all requests to `/worker.js` and either:
+
+* In development: Rewrites and forwards the request to the rails app (where the usual webpacker magic will occure)
+* In other environments: Serves the precompiled `worker.js` pack directly from `/public/packs/js/`. N.B. You may want to use some other form of url rewriting in production, depending on how your app is deployed.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rails/pwa/railtie.rb

@@ -10,7 +10,7 @@ class Rails::PWA::Railtie < ::Rails::Railtie
     scripts = app.config.pwa.scripts
     root    = Rails.env.development? ? false : Rails.public_path
 
-    app.config.app_middleware.use Rails::PWA::Interceptor,
+    app.config.middleware.insert_before Rack::Sendfile, Rails::PWA::Interceptor,
       scripts: app.config.pwa.scripts,
       root: root
   end

data/lib/rails/pwa/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module PWA
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-pwa
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Tom Ward
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0.rc1
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0.rc1
+        version: 6.0.0
 description: Serves service worker scripts
 email:
 - tom@popdog.net