serviceworker-rails 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1375be90e53a9669b3c5cf8e87c9b60fc7358280
-  data.tar.gz: 1ca30b3dc68fe59b06d5b16fd3373820d281e861
+  metadata.gz: 31552ed751cd1b86fdd2c30a11e4ecb131e4e947
+  data.tar.gz: 9afb5f219f579eef75b06f99d69bbacfa67fc8c6
 SHA512:
-  metadata.gz: 5122e12977bddf53e9800f8c2995d5b21da94f21ef8569ee1e5a74f447123f26ddce865d7f8855f5b0919feeb6c7658267bdbe6ddf5044e126d4cd5ecd5c91af
-  data.tar.gz: 2846135d62fb691d98a3979d1d86ad86b57d8a7c2394d2e06495332018ddd158801b7838d219fd49a16852b2b9b8c10d0b47f59c7bbebeeff4d61571c119fbd7
+  metadata.gz: 335912fa3a5c4910004163a289e863467cde8eb5a5d96b9bade63287abd4e1c244944741a599c2c7f56c106d442b83eb7b8671916f7bdb61a6120316ea719588
+  data.tar.gz: f7ec9e6be9ad4dc3cf67f96dbbf14d1fc2c6345c59ba4eddf1d11575b9ac2cf30dec32a6314cbc565b69997b7526b76b4ef66b3b4bbc6616d2d5879b873c1d54

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - "test/tmp/**/*"
+    - "tmp/**/*"
 
 Metrics/LineLength:
   Max: 120
@@ -85,3 +86,6 @@ Style/SpecialGlobalVars:
 
 Style/TrivialAccessors:
   Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### 0.5.2 - 2017-01-07
+
+* enhancements
+  * Enable generated serviceworker.js with improved fetch logic
+* bug fixes
+  * Omit application.js from generated serviceworker.js to prevent circular
+    sprockets requires
+
+### 0.5.1 - 2016-11-17
+
+* enhancements
+  * Add support for Rails 3
+* bug fixes
+  * Fix syntax error in generated serviceworker.js
+  * Remove duplicate line in generated manifest.json (@brandonhilkert)
+
 ### 0.5.0 - 2016-11-10
 
 * enhancements

data/Gemfile

@@ -4,12 +4,10 @@ source "https://rubygems.org"
 gemspec
 
 group :development, :test do
-  gem "rubocop", "0.39.0"
-
   unless ENV["TRAVIS"]
+    gem "guard", require: false
+    gem "guard-minitest", require: false
     gem "pry"
     gem "pry-byebug", platforms: [:mri]
-    gem "guard"
-    gem "guard-minitest"
   end
 end

data/README.md

@@ -81,6 +81,8 @@ It will also make the following modifications to existing files:
 * Injects tags into the `head` of `app/views/layouts/application.html.erb` for
   linking to the web app manifest
 
+**NOTE** Given that Service Worker operates in a separate browser thread, outside the context of your web pages, you don't want to include `serviceworker.js` script in your `application.js`. So if you have a line like `require_tree .` in your `application.js` file, you'll either need to move your `serviceworker.js` to another location or replace `require_tree` with something more explicit.
+
 To learn more about each of the changes or to perform the set up yourself, check
 out the manual setup section below.
 
@@ -157,7 +159,7 @@ if (navigator.serviceWorker) {
 
 You may also want to create a `manifest.json` file to make your web app installable.
 
-```
+```javascript
 // app/assets/javascripts/manifest.json
 {
   "name": "My Progressive Rails App",
@@ -224,7 +226,7 @@ function onFetch(event) {
   if (request.method !== 'GET') { return; }
 
   event.respondWith(
-    fetch(request).                                       // first, the network
+    fetch(request)                                        // first, the network
       .catch(function fallback() {
          caches.match(request).then(function(response) {  // then, the cache
            response || caches.match("/offline.html");     // then, /offline cache
@@ -287,7 +289,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/serviceworker-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rossta/serviceworker-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/bin/_guard-core

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # This file was generated by Bundler.
 #

data/bin/guard

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # This file was generated by Bundler.
 #

data/lib/generators/serviceworker/templates/serviceworker.js

@@ -1,53 +1,64 @@
-// function onInstall(event) {
-//   console.log('[Serviceworker]', "Installing!", event);
-//   event.waitUntil(
-//     caches.open('cached-assets-v1').then(function prefill(cache) {
-//       return cache.addAll([
-//         '<%%= asset_path "application.js" %>',
-//         '<%%= asset_path "application.css" %>',
-//         '/offline.html'
-//       ]);
-//     })
-//   );
-// }
-//
-// function onActivate(event) {
-//   console.log('[Serviceworker]', "Activating!", event);
-//   event.waitUntil(
-//     caches.keys().then(function(cacheNames) {
-//       return Promise.all(
-//         cacheNames.filter(function(cacheName) {
-//           // Return true if you want to remove this cache,
-//           // but remember that caches are shared across
-//           // the whole origin
-//            return key.indexOf('v1') !== 0;
-//         }).map(function(cacheName) {
-//           return caches.delete(cacheName);
-//         })
-//       );
-//     })
-//   );
-// }
-//
-// function onFetch(event) {
-//   // Fetch from network, fallback to cached content, then offline.html for same-origin GET requests
-//   var request = event.request;
-//
-//   if (!request.url.match(/^https?:\/\/example.com/) ) { return; }
-//   if (request.method !== 'GET') { return; }
-//
-//   event.respondWith(
-//     fetch(request).                                       // first, the network
-//       .catch(function fallback() {
-//          caches.match(request).then(function(response) {  // then, the cache
-//            response || caches.match("/offline.html");     // then, /offline cache
-//          })
-//        })
-//   );
-//
-//   // See https://jakearchibald.com/2014/offline-cookbook/#on-network-response for more examples
-// }
-//
-// self.addEventListener('install', onInstall);
-// self.addEventListener('activate', onActivate);
-// self.addEventListener('fetch', onFetch);
+var CACHE_VERSION = 'v1'
+var CACHE_NAME = 'sw-cache-' + CACHE_VERSION;
+
+function onInstall(event) {
+  console.log('[Serviceworker]', "Installing!", event);
+  event.waitUntil(
+    caches.open(CACHE_NAME).then(function prefill(cache) {
+      return cache.addAll([
+
+        // make sure serviceworker.js is not required by application.js
+        // if you want to reference application.js from here
+        '<%%#= asset_path "application.js" %>',
+
+        '<%%= asset_path "application.css" %>',
+
+        '/offline.html',
+
+      ]);
+    })
+  );
+}
+
+function onActivate(event) {
+  console.log('[Serviceworker]', "Activating!", event);
+  event.waitUntil(
+    caches.keys().then(function(cacheNames) {
+      return Promise.all(
+        cacheNames.filter(function(cacheName) {
+          // Return true if you want to remove this cache,
+          // but remember that caches are shared across
+          // the whole origin
+          return key.indexOf(CACHE_VERSION) !== 0;
+        }).map(function(cacheName) {
+          return caches.delete(cacheName);
+        })
+      );
+    })
+  );
+}
+
+// Borrowed from https://github.com/TalAter/UpUp
+function onFetch(event) {
+  event.respondWith(
+    // try to return untouched request from network first
+    fetch(event.request).catch(function() {
+      // if it fails, try to return request from the cache
+      return caches.match(event.request).then(function(response) {
+        if (response) {
+          return response;
+        }
+        // if not found in cache, return default offline content for navigate requests
+        if (event.request.mode === 'navigate' ||
+          (event.request.method === 'GET' && event.request.headers.get('accept').includes('text/html'))) {
+          console.log('[Serviceworker]', "Fetching offline content", event);
+          return caches.match('/offline.html');
+        }
+      })
+    })
+  );
+}
+
+self.addEventListener('install', onInstall);
+self.addEventListener('activate', onActivate);
+self.addEventListener('fetch', onFetch);

data/lib/serviceworker/rails/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module ServiceWorker
   module Rails
-    VERSION = "0.5.1".freeze
+    VERSION = "0.5.2".freeze
   end
 end

data/lib/serviceworker/route.rb

@@ -75,6 +75,7 @@ module ServiceWorker
       end
 
       def compiled_source(pattern)
+        @wildcard_name = nil
         pattern_match = pattern.match(WILDCARD_PATTERN)
         if pattern_match
           @wildcard_name = if pattern_match[1].to_s.strip.empty?

data/serviceworker-rails.gemspec

@@ -23,9 +23,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "sprockets-rails"
   spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 11.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rubocop", "0.46.0"
   spec.add_development_dependency "rails"
   spec.add_development_dependency "appraisal", "~> 2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serviceworker-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Ross Kaffenberger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2017-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.46.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -201,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: ServiceWorker for Rails 3+