serviceworker-rails 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d025ce1cde7d307ac23919e459e703f06702b9ad
-  data.tar.gz: 9d0239c076fcae84235b78ce35398cb8fe26a808
+  metadata.gz: 3752a3b8e5aab69a95949bf282791c5871a1297d
+  data.tar.gz: 22de311f4ed1728871bb3032673f03e3bac57e4e
 SHA512:
-  metadata.gz: 5b0e0c3e6599dd4f74efe555dc4271b5d51c1d0b1a07a0079e095055ff53d2cb57befa0f048a9e7d44ab1bad2108fcca3b975fb0e38d98d0456eebc6d43a6c4c
-  data.tar.gz: db588993939e6b722c3f5e968e1cbcd816cdd5100b6a553bab9252a2d67e7b38d2f536bc394ae2fe9e04babf59de8858b56d3f4ca6f38afa58ff692eb83fa07f
+  metadata.gz: e14a4a092b558e85a68d3dbef7f61d2fdf185d3510d9def1480a45d8abd7a96202f00da5ce2debe3a05fe2bd408d7a8ec26a801f19427fb6a8bd25aaae4c6c70
+  data.tar.gz: b439353ce2aa25da2df120f902b59ed431b873cf077cb48e3d3a612c71f6ae474f12cf57b5e4900ad70f66d220c82297b4e71dac0885178eda6aeb7bbbc920a8

data/.rubocop.yml

@@ -0,0 +1,87 @@
+AllCops:
+  Exclude:
+    - "test/tmp/**/*"
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/ModuleLength:
+  Max: 300
+
+Metrics/MethodLength:
+  Max: 100
+
+Metrics/ParameterLists:
+  Max: 8
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+Style/OneLineConditional:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/Not:
+  Enabled: false
+
+Documentation:
+  Enabled: false # TODO: Enable again once we have more docs
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: case
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': "[]"
+    '%W': "[]"
+
+Style/AccessModifierIndentation:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/IndentationWidth:
+  Enabled: false
+
+Style/TrivialAccessors:
+  ExactNameMatch: true
+
+Lint/DefEndAlignment:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.8
   - 2.2.5
   - 2.3.0
 before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -1,11 +1,14 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in serviceworker-rails.gemspec
 gemspec
 
 group :development, :test do
+  gem "rubocop", "0.39.0"
+
   unless ENV["TRAVIS"]
-    gem "pry-byebug", platforms: [:ruby_23]
+    gem "pry"
+    gem "pry-byebug", platforms: [:mri]
     gem "guard"
     gem "guard-minitest"
   end

data/Guardfile

@@ -19,7 +19,7 @@ guard :minitest do
   # with Minitest::Unit
   watch(%r{^test/(.*)\/?(.*)_test\.rb$})
   watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
-  watch(%r{^test/test_helper\.rb$})      { 'test' }
+  watch(%r{^test/test_helper\.rb$})      { "test" }
 
   # with Minitest::Spec
   # watch(%r{^spec/(.*)_spec\.rb$})

data/README.md

@@ -2,7 +2,29 @@
 
 [![Build Status](https://travis-ci.org/rossta/serviceworker-rails.svg?branch=master)](https://travis-ci.org/rossta/serviceworker-rails)
 
-Use [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) with the Rails asset pipeline.
+Turn your Rails app into a Progressive Web App. Use [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) with the Rails asset pipeline.
+
+## Why?
+
+The Rails asset pipeline makes a number of assumptions about what's best for deploying JavaScript, including asset digest fingerprints and long-lived cache headers - mostly to increase "cacheability". Rails also assumes a single parent directory, `/public/assets`, to make it easier to look up the file path for a given asset.
+
+Service worker assets must play by different rules. Consider these behaviors:
+
+* Service workers may only be active from within the scope from which they are
+served. So if you try to register a service worker from a Rails asset pipeline
+path, like `/assets/serviceworker-abcd1234.js`, it will only be able to interact
+with requests and responses within `/assets/`<em>**</em>. This is not what we want.
+
+* [MDN states](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API#Download_install_and_activate) browsers check for updated service worker scripts in the background every 24 hours (possibly less). Rails developers wouldn't be able to take advantage of this feature since the fingerprint strategy means assets at a given url are immutable. Beside fingerprintings, the `Cache-Control` headers used for static files served from Rails also work against browser's treatment of service workers.
+
+We want Sprockets to compile service worker JavaScript from ES6/7, CoffeeScript, ERB, etc. but must remove the caching and scoping mechanisms offered by Rails asset pipeline defaults. This is where `serviceworker-rails` comes in.
+
+*Check out the [blog post](https://rossta.net/blog/service-worker-on-rails.html)
+for more background.*
+
+### Demo
+
+See various examples of using Service Workers in the demo Rails app, [Service Worker Rails Sandbox](https://serviceworker-rails.herokuapp.com/). The [source code](https://github.com/rossta/serviceworker-rails-sandbox) is also on GitHub.
 
 ## Features
 
@@ -26,31 +48,169 @@ Or install it yourself as:
 
     $ gem install serviceworker-rails
 
-## Usage
+To set up your Rails project for use with a Service Worker, you either use the
+Rails generator and edit the generated files as needed, or you can follow the
+manual installation steps.
+
+### Automated setup
+
+After bundling the gem in your Rails project, run the generator from the root of
+your Rails project.
+
+```
+$ rails g serviceworker:install
+```
+
+### Manual setup
+
+Let's add a `ServiceWorker` to cache some of your JavaScript and CSS assets. We'll assume you already have a Rails application using the asset pipeline built on Sprockets.
+
+#### Add a service worker script
+
+Create a JavaScript file called `app/assets/javascripts/serviceworker.js.erb`:
+
+```javascript
+// app/assets/javascripts/serviceworker.js.erb
+console.log('[Service Worker] Hello world!');
+
+function onInstall(event) {
+  event.waitUntil(
+    caches.open('cached-assets').then(function prefill(cache) {
+      return cache.addAll([
+        '<%= asset_path "application.js" %>',
+        '<%= asset_path "application.css" %>',
+        '<%= asset_path "admin.css" %>',
+        // you get the idea ...
+      ]);
+    })
+  );
+}
+
+self.addEventListener('install', onInstall)
+```
+
+For use in production, instruct Sprockets to precompile service worker scripts separately from `application.js`, as in the following example:
+
+#### Precompile the asset
+
+```ruby
+# config/initializers/assets.rb
+
+Rails.application.configure do
+  config.assets.precompile += %w[
+    serviceworker.js
+  ]
+end
+```
+
+#### Register the service worker
+
+You'll need to register the service worker with a companion script in your main page JavaScript, like `application.js`. You can use the following:
+
+```javascript
+// app/assets/javascripts/serviceworker-companion.js
 
-To use `serviceworker-rails` in a Rails app, install the gem as above. When
-`serviceworker-rails` is required, it will insert a middleware into the Rails
+if (navigator.serviceWorker) {
+  navigator.serviceWorker.register('/serviceworker.js', { scope: './' })
+    .then(function(reg) {
+      console.log('[Page] Service worker registered!');
+    });
+}
+
+// app/assets/javascripts/application.js
+
+// ...
+//= require serviceworker-companion
+```
+
+#### Add a manifest
+
+You may also want to create a `manifest.json` file to make your web app installable.
+
+```
+// manifest.json
+{
+  "name": "My Rails App"
+  "name": "My Progressive Rails App",
+  "short_name": "Progressive",
+  "start_url": "/"
+}
+```
+
+You'd then link to your manifest from the application layout:
+
+```html
+<link rel="manifest" href="/manifest.json" />
+```
+
+#### Configure the middleware
+
+Next, add a new initializer as show below to instruct the `serviceworker-rails`
+middleware how to route requests for assets by canonical url.
+
+```ruby
+# config/initializers/serviceworker.rb
+
+Rails.application.configure do
+  config.serviceworker.routes.draw do
+    match "/serviceworker.js"
+    match "/manifest.json"
+  end
+end
+```
+
+#### Test the setup
+
+At this point, restart your Rails app and reload a page in your app in Chrome or Firefox. Using dev tools, you should be able to determine.
+
+1. The page requests a service worker at `/serviceworker.js`
+2. The Rails app responds to the request by compiling and rendering the file in `app/assets/javascripts/serviceworker.js.erb`.
+3. The console displays messages from the page and the service worker
+4. The application JavaScript and CSS assets are added to the browser's request/response [Cache](https://developer.mozilla.org/en-US/docs/Web/API/Cache).
+
+#### Using the cache
+
+So far so good? At this point, all we've done is pre-fetched assets and added them to the cache, but we're not doing anything with them yet.
+
+Now, we can use the service worker to intercept requests and either serve them from the cache if they exist there or fallback to the network response otherwise. In most cases, we can expect responses coming from the local cache to be much faster than those coming from the network.
+
+(...more coming soon, WIP)
+
+## Configuration
+
+When `serviceworker-rails` is required in your Gemfile, it will insert a middleware into the Rails
 middleware stack. You'll want to configure it by mapping serviceworker routes to
-Sprockets JavaScript assets, like the example below, in `application.rb`.
+Sprockets JavaScript assets in an initializer, like the example below.
 
 ```ruby
-# application.rb
+# config/initializers/serviceworker.rb
+
+Rails.application.configure do
+  config.serviceworker.routes.draw do
+    # maps to asset named 'serviceworker.js' implicitly
+    match "/serviceworker.js"
 
-config.serviceworker.routes.draw do
-  match "/basic-serviceworker.js"
+    # map to a named asset explicitly
+    match "/proxied-serviceworker.js" => "nested/asset/serviceworker.js"
+    match "/nested/serviceworker.js" => "another/serviceworker.js"
 
-  match "/proxied-serviceworker.js" => "nested/asset/serviceworker.js"
+    # capture named path segments and interpolate to asset name
+    match "/captures/*segments/serviceworker.js" => "%{segments}/serviceworker.js"
 
-  match "/nested/serviceworker.js" => "another/serviceworker.js"
+    # capture named parameter and interpolate to asset name
+    match "/parameter/:id/serviceworker.js" => "project/%{id}/serviceworker.js"
 
-  match "/header-serviceworker.js" => "another/serviceworker.js",
-    headers: { "X-Resource-Header" => "A resource" }
+    # insert custom headers
+    match "/header-serviceworker.js" => "another/serviceworker.js",
+      headers: { "X-Resource-Header" => "A resource" }
 
-  match "/*/serviceworker.js" => "serviceworker.js"
+    # anonymous glob exposes `paths` variable for interpolation
+    match "/*/serviceworker.js" => "%{paths}/serviceworker.js"
+  end
 end
 ```
 
-`Serviceworker::Rails` with insert a `Cache-Control` header to instruct browsers
+`Serviceworker::Rails` will insert a `Cache-Control` header to instruct browsers
 not to cache your serviceworkers by default. You can customize the headers for all service worker routes if you'd like,
 such as adding the experimental [`Service-Worker-Allowed`](https://slightlyoff.github.io/ServiceWorker/spec/service_worker/#service-worker-allowed) header to set the allowed scope.
 
@@ -59,15 +219,9 @@ config.serviceworker.headers["Service-Worker-Allowed"] = "/"
 config.serviceworker.headers["X-Custom-Header"] = "foobar"
 ```
 
-### Demo
-
-Check out the demo application, [Service Worker on Rails](https://serviceworker-rails.herokuapp.com/), to see various examples of using Service Workers in a Rails app.
-
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 

data/Rakefile

@@ -1,15 +1,16 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 APP_RAKEFILE = File.expand_path("../test/sample/Rakefile", __FILE__)
 load "rails/tasks/engine.rake"
 
-Bundler::GemHelper.install_tasks
+RuboCop::RakeTask.new
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: [:test, :rubocop]

data/bin/{rspec → rubocop}

@@ -2,7 +2,7 @@
 #
 # This file was generated by Bundler.
 #
-# The application 'rspec' is installed as part of a gem, and
+# The application 'rubocop' is installed as part of a gem, and
 # this file is here to facilitate running it.
 #
 
@@ -13,4 +13,4 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
 require "rubygems"
 require "bundler/setup"
 
-load Gem.bin_path("rspec-core", "rspec")
+load Gem.bin_path("rubocop", "rubocop")

data/lib/generators/serviceworker/install_generator.rb

@@ -0,0 +1,73 @@
+require "rails/generators"
+
+module Serviceworker
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Make your Rails app a progressive web app"
+      source_root File.join(File.dirname(__FILE__), "templates")
+
+      def create_assets
+        template "serviceworker.js",
+          File.join(javascripts_base_dir, "serviceworker.js")
+        template "serviceworker-companion.js",
+          File.join(javascripts_base_dir, "serviceworker-companion.js")
+        template "manifest.json",
+          File.join(javascripts_base_dir, "manifest.json")
+      end
+
+      def create_initializer
+        template "serviceworker.rb",
+          File.join(initializers_dir, "serviceworker.rb")
+      end
+
+      def update_application_js
+        ext, directive = detect_js_format
+        append_to_file application_js_path(ext), "#{directive} require serviceworker-companion\n"
+      end
+
+      def update_precompiled_assets
+        append_to_file File.join(initializers_dir, "assets.rb"),
+          "Rails.configuration.assets.precompile += %w[serviceworker.js]\n"
+      end
+
+      def update_application_layout
+        insert_into_file detect_layout,
+          %(<link rel="manifest" href="/manifest.json" />),
+          before: "</head>\n"
+      end
+
+      private
+
+      def application_js_path(ext)
+        File.join(javascripts_base_dir, "application#{ext}")
+      end
+
+      def detect_js_format
+        %w[.coffee .coffee.erb .js.coffee .js.coffee.erb .js .js.erb].each do |ext|
+          next unless File.exist?(File.join(javascripts_base_dir, "application#{ext}"))
+          return [ext, "#="] if ext.include?(".coffee")
+          return [ext, "//="]
+        end
+      end
+
+      def detect_layout
+        layouts = %w[.html.erb .html.haml .html.slim].map do |ext|
+          File.join(layouts_base_dir, "application#{ext}")
+        end
+        layouts.find { |layout| File.exist?(layout) }
+      end
+
+      def javascripts_base_dir
+        File.join("app", "assets", "javascripts")
+      end
+
+      def initializers_dir
+        File.join("config", "initializers")
+      end
+
+      def layouts_base_dir
+        File.join("app", "views", "layouts")
+      end
+    end
+  end
+end

data/lib/generators/serviceworker/templates/manifest.json

@@ -0,0 +1,66 @@
+{
+  "name": "My Progressive Rails App",
+  "short_name": "Progressive",
+  "start_url": "/",
+  "icons": [
+    {
+      "src": "/icons/icon36.png",
+      "sizes": "36x36",
+      "type": "image/png"
+    },
+    {
+      "src": "/icons/icon48.png",
+      "sizes": "48x48",
+      "type": "image/png"
+    },
+    {
+      "src": "/icons/icon60.png",
+      "sizes": "60x60",
+      "type": "image/png"
+    },
+    {
+      "src": "/icons/icon72.png",
+      "sizes": "72x72",
+      "type": "image/png"
+    },
+    {
+      "src": "/icons/icon76.png",
+      "sizes": "76x76",
+      "type": "image/png"
+    },
+    {
+      "src": "/icons/icon96.png",
+      "sizes": "96x96",
+      "type": "image/png"
+    },
+    {
+      "src": "/icons/icon120.png",
+      "sizes": "120x120",
+      "type": "image/png"
+    },
+    {
+      "src": "/icons/icon152.png",
+      "sizes": "152x152",
+      "type": "image/png"
+    },
+    {
+      "src": "/icons/icon180.png",
+      "sizes": "180x180",
+      "type": "image/png"
+    },
+    {
+      "src": "/icons/icon192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    },
+    {
+      "src": "/icons/icon512.png",
+      "sizes": "512x512",
+      "type": "image/png"
+    }
+  ],
+  "theme_color": "#000000",
+  "background_color": "#FFFFFF",
+  "display": "fullscreen",
+  "orientation": "portrait"
+}

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

@@ -0,0 +1,6 @@
+if (navigator.serviceWorker) {
+  navigator.serviceWorker.register('/serviceworker.js', { scope: './' })
+    .then(function(reg) {
+      console.log('[Companion]', 'Service worker registered!');
+    });
+}

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

@@ -0,0 +1,14 @@
+function onInstall() {
+  console.log('[Serviceworker]', "Installing!");
+}
+
+function onActivate() {
+  console.log('[Serviceworker]', "Activating!");
+}
+
+function onFetch() {
+}
+
+self.addEventListener('install', onInstall);
+self.addEventListener('activate', onActivate);
+self.addEventListener('fetch', onFetch);

data/lib/generators/serviceworker/templates/serviceworker.rb

@@ -0,0 +1,26 @@
+Rails.application.configure do
+  config.serviceworker.routes.draw do
+    # map to assets implicitly
+    match "/serviceworker.js"
+    match "/manifest.json"
+
+    # Examples
+    #
+    # map to a named asset explicitly
+    # match "/proxied-serviceworker.js" => "nested/asset/serviceworker.js"
+    # match "/nested/serviceworker.js" => "another/serviceworker.js"
+    #
+    # capture named path segments and interpolate to asset name
+    # match "/captures/*segments/serviceworker.js" => "%{segments}/serviceworker.js"
+    #
+    # capture named parameter and interpolate to asset name
+    # match "/parameter/:id/serviceworker.js" => "project/%{id}/serviceworker.js"
+    #
+    # insert custom headers
+    # match "/header-serviceworker.js" => "another/serviceworker.js",
+    #   headers: { "X-Resource-Header" => "A resource" }
+    #
+    # anonymous glob exposes `paths` variable for interpolation
+    # match "/*/serviceworker.js" => "%{paths}/serviceworker.js"
+  end
+end

data/lib/service_worker.rb

@@ -0,0 +1 @@
+require "serviceworker"

data/lib/serviceworker-rails.rb

@@ -1,2 +1,3 @@
+# rubocop:disable Style/FileName
 require "serviceworker"
 require "serviceworker/rails"

data/lib/serviceworker/handler.rb

@@ -0,0 +1,21 @@
+module ServiceWorker
+  class Handler
+    def initialize(root = Dir.getwd)
+      @root = root
+    end
+
+    def call(env)
+      path_info = env.fetch("serviceworker.asset_name")
+
+      file_server.call(env.merge("PATH_INFO" => path_info))
+    end
+
+    def file_path(path_info)
+      @root.join(path_info)
+    end
+
+    def file_server
+      @file_server ||= ::Rack::File.new(@root)
+    end
+  end
+end

data/lib/serviceworker/middleware.rb

@@ -5,16 +5,26 @@ module ServiceWorker
     GET = "GET".freeze
     HEAD = "HEAD".freeze
 
+    # Initialize the Rack middleware for responding to serviceworker asset
+    # requests
+    #
+    # @app [#call] middleware stack
+    # @opts [Hash] options to inject
+    # @param opts [#match_route] :routes matches routes on PATH_INFO
+    # @param opts [Hash] :headers default headers to use for matched routes
+    # @param opts [#call] :handler resolves response from matched asset name
+    # @param opts [#info] :logger logs requests
     def initialize(app, opts = {})
       @app = app
       @opts = opts
       @headers = opts.fetch(:headers, {}).merge(default_headers)
       @router = opts.fetch(:routes, ServiceWorker::Router.new)
+      @handler = @opts.fetch(:handler, default_handler)
     end
 
     def call(env)
       case env[REQUEST_METHOD]
-      when GET, HEAD
+        when GET, HEAD
         route_match = @router.match_route(env)
         return respond_to_match(route_match, env) if route_match
       end
@@ -22,7 +32,7 @@ module ServiceWorker
       @app.call(env)
     end
 
-    private
+  private
 
     def default_headers
       {
@@ -33,7 +43,7 @@ module ServiceWorker
     def respond_to_match(route_match, env)
       env = env.merge("serviceworker.asset_name" => route_match.asset_name)
 
-      status, headers, body = handler.call(env)
+      status, headers, body = @handler.call(env)
 
       [status, headers.merge(@headers).merge(route_match.headers), body]
     end
@@ -42,14 +52,13 @@ module ServiceWorker
       logger.info "[#{self.class}] - #{msg}"
     end
 
-    # TODO
-    # provide non-rails handler as default
-    def handler
-      @handler ||= @opts.fetch(:handler)
-    end
-
     def logger
       @logger ||= @opts.fetch(:logger, Logger.new(STDOUT))
     end
+
+    def default_handler
+      require "serviceworker/handler"
+      ServiceWorker::Handler.new
+    end
   end
 end

data/lib/serviceworker/rails/handler.rb

@@ -13,7 +13,7 @@ module ServiceWorker
         end
       end
 
-      private
+    private
 
       def sprockets_server
         ::Rails.application.assets

data/lib/serviceworker/rails/version.rb

@@ -1,5 +1,5 @@
 module ServiceWorker
   module Rails
-    VERSION = "0.3.1"
+    VERSION = "0.4.0".freeze
   end
 end

data/lib/serviceworker/route.rb

@@ -20,9 +20,7 @@ module ServiceWorker
     end
 
     def match(path)
-      if path.to_s.strip.empty?
-        raise ArgumentError.new("path is required")
-      end
+      raise ArgumentError, "path is required" if path.to_s.strip.empty?
 
       asset = resolver.call(path) or return nil
 
@@ -40,11 +38,11 @@ module ServiceWorker
     end
 
     class AssetResolver
-      PATH_INFO = 'PATH_INFO'.freeze
+      PATH_INFO = "PATH_INFO".freeze
       DEFAULT_WILDCARD_NAME = :paths
-      WILDCARD_PATTERN = /\/\*([^\/]*)/.freeze
-      NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([^:$\/]+)/.freeze
-      LEADING_SLASH_PATTERN = /^\//
+      WILDCARD_PATTERN = %r{\/\*([^\/]*)}
+      NAMED_SEGMENTS_PATTERN = %r{\/([^\/]*):([^:$\/]+)}
+      LEADING_SLASH_PATTERN = %r{^\/}
       INTERPOLATION_PATTERN = Regexp.union(
         /%%/,
         /%\{(\w+)\}/, # matches placeholders like "%{foo}"
@@ -58,9 +56,7 @@ module ServiceWorker
       end
 
       def call(path)
-        if path.to_s.strip.empty?
-          raise ArgumentError.new("path is required")
-        end
+        raise ArgumentError, "path is required" if path.to_s.strip.empty?
 
         captures = path_captures(regexp, path) or return nil
 
@@ -78,15 +74,16 @@ module ServiceWorker
       end
 
       def compiled_source(pattern)
-        if pattern_match = pattern.match(WILDCARD_PATTERN)
+        pattern_match = pattern.match(WILDCARD_PATTERN)
+        if pattern_match
           @wildcard_name = if pattern_match[1].to_s.strip.empty?
                              DEFAULT_WILDCARD_NAME
                            else
                              pattern_match[1].to_sym
                            end
-          pattern.gsub(WILDCARD_PATTERN,'(?:/(.*)|)')
+          pattern.gsub(WILDCARD_PATTERN, "(?:/(.*)|)")
         else
-          p = if pattern_match = pattern.match(NAMED_SEGMENTS_PATTERN)
+          p = if pattern.match(NAMED_SEGMENTS_PATTERN)
                 pattern.gsub(NAMED_SEGMENTS_PATTERN, '/\1(?<\2>[^.$/]+)')
               else
                 pattern
@@ -96,29 +93,25 @@ module ServiceWorker
       end
 
       def path_captures(regexp, path)
-        return nil unless path_match = path.match(regexp)
+        path_match = path.match(regexp) or return nil
         params = if @wildcard_name
-                   { @wildcard_name => path_match[1].to_s.split('/') }
+                   { @wildcard_name => path_match[1].to_s.split("/") }
                  else
                    Hash[path_match.names.map(&:to_sym).zip(path_match.captures)]
                  end
-        params.delete(:format) if params.has_key?(:format) && params[:format].nil?
+        params.delete(:format) if params.key?(:format) && params[:format].nil?
         params
       end
 
       def interpolate_captures(string, captures)
         string.gsub(INTERPOLATION_PATTERN) do |match|
-          if match == '%%'
-            '%'
+          if match == "%%"
+            "%"
           else
-            key = ($1 || $2).to_sym
-            value = if captures.key?(key)
-                      Array(captures[key]).join("/")
-                    else
-                      raise "Interpolation error: #{key} not captured in #{captures.inspect}"
-                    end
+            key = (Regexp.last_match(1) || Regexp.last_match(2)).to_sym
+            value = captures.key?(key) ? Array(captures[key]).join("/") : key
             value = value.call(captures) if value.respond_to?(:call)
-            $3 ? sprintf("%#{$3}", value) : value
+            Regexp.last_match(3) ? format("%#{Regexp.last_match(3)}", value) : value
           end
         end.gsub(LEADING_SLASH_PATTERN, "")
       end

data/lib/serviceworker/router.rb

@@ -19,7 +19,7 @@ module ServiceWorker
       return self unless block_given?
 
       if block.arity == 1
-        block.call(self)
+        yield(self)
       else
         instance_eval(&block)
       end
@@ -51,9 +51,7 @@ module ServiceWorker
     def match_route(env)
       path = env[PATH_INFO]
       @routes.each do |route|
-        if match = route.match(path)
-          return match
-        end
+        match = route.match(path) and return match
       end
       nil
     end

data/serviceworker-rails.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'serviceworker/rails/version'
+require "serviceworker/rails/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "serviceworker-rails"
@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ross Kaffenberger"]
   spec.email         = ["rosskaff@gmail.com"]
 
-  spec.summary       = %q{ServiceWorker for Rails 3+}
-  spec.description   = %q{Integrates ServiceWorker into the Rails asset pipeline.}
+  spec.summary       = "ServiceWorker for Rails 3+"
+  spec.description   = "Integrates ServiceWorker into the Rails asset pipeline."
   spec.homepage      = "https://github.com/rossta/serviceworker-rails"
   spec.license       = "MIT"
 
@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rails"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serviceworker-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ross Kaffenberger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Integrates ServiceWorker into the Rails asset pipeline.
 email:
 - rosskaff@gmail.com
@@ -102,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -114,10 +129,17 @@ files:
 - bin/console
 - bin/guard
 - bin/rake
-- bin/rspec
+- bin/rubocop
 - bin/setup
+- lib/generators/serviceworker/install_generator.rb
+- lib/generators/serviceworker/templates/manifest.json
+- lib/generators/serviceworker/templates/serviceworker-companion.js
+- lib/generators/serviceworker/templates/serviceworker.js
+- lib/generators/serviceworker/templates/serviceworker.rb
+- lib/service_worker.rb
 - lib/serviceworker-rails.rb
 - lib/serviceworker.rb
+- lib/serviceworker/handler.rb
 - lib/serviceworker/middleware.rb
 - lib/serviceworker/rails.rb
 - lib/serviceworker/rails/handler.rb
@@ -146,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: ServiceWorker for Rails 3+