serviceworker-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5204e0b97606d5376b6f64929819f4a028112204
-  data.tar.gz: 3c670957542a61203341a539becb33998e22f449
+  metadata.gz: e15c642851a30d7cf973bc826cdd953de5248df2
+  data.tar.gz: ad30587132acd6fbf1052370d5dafa12f5d24edb
 SHA512:
-  metadata.gz: bc077d6c2e08e5f50d0f6c51abcba3c717c0ea78799cbbfdebb14c56175b1842e832b503d6a6737a0d598b2a94040ab7665d7496fd3b9156887114e6245cf01d
-  data.tar.gz: 8e830544524431c811c9505e3aefc98466fa6ec7afaa628fa44243559d2f0046d7963340888f69961ce75ebf0c4b69a4e6c1a061d091a5b21e916d11e7efa5bc
+  metadata.gz: c695e3493724c49d99b7f8b72174057abd43ca4b73e6782706c80843efeca64c54512a535490f31a171b2f4e19175233b9a81f413fe5158d92b0e0ddaa3ef911
+  data.tar.gz: 2e4a8f6c092de36eb47fcaab1d0fb30bd21fa1244e8aa9b14dacf4757bcc87e5f0d7a9778c14d9af722b2002e1732188c5b5108a6f245fb2b208beb0d37c0048

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in serviceworker-rails.gemspec
 gemspec
+
+gem "pry-byebug", platforms: [:ruby_23]
+gem "guard"
+gem "guard-minitest"

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+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' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/README.md

@@ -26,7 +26,40 @@ Or install it yourself as:
 
 ## Usage
 
-Currently, `serviceworker-rails` assumes your script resolves to `serviceworker.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
+middleware stack. You'll want to configure it by mapping serviceworker routes to
+Sprockets JavaScript assets, like the example below, in `application.rb`.
+
+```ruby
+# application.rb
+
+config.serviceworker.routes.draw do
+  get "/basic-serviceworker.js"
+
+  get "/proxied-serviceworker.js"
+    asset: "nested/asset/serviceworker.js"
+
+  get "/nested/serviceworker.js",
+    asset: "another/serviceworker.js"
+
+  get "/header-serviceworker.js",
+    asset: "another/serviceworker.js",
+    headers: { "X-Resource-Header" => "A resource" }
+
+  get "/*/serviceworker.js",
+    asset: "serviceworker.js"
+end
+```
+
+`Serviceworker-Rails` with 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.
+
+```ruby
+config.serviceworker.headers["Service-Worker-Allowed"] = "/"
+config.serviceworker.headers["X-Custom-Header"] = "foobar"
+```
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,11 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+APP_RAKEFILE = File.expand_path("../test/sample/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+
+Bundler::GemHelper.install_tasks
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"

data/bin/_guard-core

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/lib/serviceworker.rb

@@ -1,19 +1,8 @@
 module ServiceWorker
-  class << self
-    # The path to the root of the application. ServiceWorker.rb uses this property
-    # to . If you are using ServiceWorker.rb with Rails, you do not need to set
-    # this attribute manually.
-    #
-    # @return [String]
-    attr_accessor :root
-
-    # The logger to use when logging exception details and backtraces. If you
-    # are using Better Errors with Rails, you do not need to set this attribute
-    # manually. If this attribute is `nil`, nothing will be logged.
-    #
-    # @return [Logger, nil]
-    attr_accessor :logger
-  end
+  Error = Class.new(StandardError)
+  RouteError = Class.new(Error)
 end
 
+require "serviceworker/route"
+require "serviceworker/router"
 require "serviceworker/middleware"

data/lib/serviceworker/middleware.rb

@@ -3,64 +3,52 @@ module ServiceWorker
     def initialize(app, opts = {})
       @app = app
       @opts = opts
-
-      @logger = opts.fetch(:logger, ServiceWorker.logger)
+      @headers = opts.fetch(:headers, {}).merge(default_headers)
+      @router = opts.fetch(:routes, ServiceWorker::Router.new)
     end
 
     def call(env)
-      case env['REQUEST_METHOD']
-      when 'GET', 'HEAD'
-        path = env['PATH_INFO'].chomp('/')
+      case env["REQUEST_METHOD"]
+      when "GET", "HEAD"
+        path = env["PATH_INFO"].chomp("/")
         info("responding to #{path}")
-        return respond_to(path, env) if match?(path)
+        route = @router.match_route(path)
+        return respond_to_route(route, env) if route
       end
 
       @app.call(env)
     end
 
-    def match?(path)
-      path == '/serviceworker.js'
-    end
-
     private
 
-    def respond_to(path_info, env)
-      status, headers, body = handle_request(path_info, env)
-
-      headers['Cache-Control'] = 'private, max-age=0, no-cache'
-
-      [status, headers, body]
+    def default_headers
+      {
+        "Cache-Control" => "private, max-age=0, no-cache"
+      }
     end
 
-    def handle_request(path_info, env)
-      if config.compile
-        info "compiling #{path_info} from Sprockets"
-        sprockets_server.call(env)
-      else
-        file_path = asset_path(path_info)
-        info "Proxing #{path_info} from #{file_path}"
-        file_server.call(env.merge('PATH_INFO' => file_path))
-      end
-    end
+    def respond_to_route(route, env)
+      status, headers, body = process_handler(route, env)
 
-    def info(msg)
-      @logger.info "[#{self.class}] - #{msg}"
+      [status, headers.merge(@headers).merge(route.headers), body]
     end
 
-    def sprockets_server
-      ::Rails.application.assets
+    def process_handler(route, env)
+      handler.call(env.merge("serviceworker.asset_name" => route.asset_name))
     end
 
-    def file_server
-      @file_server ||= ::Rack::File.new(::Rails.root.join("public"))
+    def info(msg)
+      logger.info "[#{self.class}] - #{msg}"
     end
 
-    def config
-      ::Rails.application.config.assets
+    # TODO
+    # provide non-rails handler as default
+    def handler
+      @handler ||= @opts.fetch(:handler)
     end
 
-    def asset_path(path)
-      ::ActionController::Base.helpers.asset_path(path.gsub(/^\//, ''))
+    def logger
+      @logger ||= @opts.fetch(:logger, Logger.new(STDOUT))
     end
   end
 end

data/lib/serviceworker/rails.rb

@@ -1,8 +1,8 @@
-require "serviceworker/rails/version"
-require "serviceworker/railtie"
-
 module ServiceWorker
   module Rails
-
   end
 end
+
+require "serviceworker/rails/version"
+require "serviceworker/rails/handler"
+require "serviceworker/railtie"

data/lib/serviceworker/rails/handler.rb

@@ -0,0 +1,33 @@
+module ServiceWorker
+  module Rails
+    class Handler
+      def call(env)
+        path_info = env.fetch("serviceworker.asset_name")
+
+        if config.compile
+          sprockets_server.call(env.merge("PATH_INFO" => path_info))
+        else
+          file_server.call(env.merge("PATH_INFO" => asset_path(path_info)))
+        end
+      end
+
+      private
+
+      def sprockets_server
+        ::Rails.application.assets
+      end
+
+      def file_server
+        @file_server ||= ::Rack::File.new(::Rails.root.join("public"))
+      end
+
+      def config
+        ::Rails.configuration.assets
+      end
+
+      def asset_path(path)
+        ::ActionController::Base.helpers.asset_path(path)
+      end
+    end
+  end
+end

data/lib/serviceworker/rails/version.rb

@@ -1,5 +1,5 @@
 module ServiceWorker
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/serviceworker/railtie.rb

@@ -1,20 +1,19 @@
 require "rails"
 require "rails/railtie"
+require "serviceworker"
 
 module ServiceWorker
   class Railtie < ::Rails::Railtie
+    config.serviceworker = ActiveSupport::OrderedOptions.new
+    config.serviceworker.headers = {}
+    config.serviceworker.routes = ServiceWorker::Router.new
+    config.serviceworker.handler = ServiceWorker::Rails::Handler.new
+
     initializer "serviceworker-rails.configure_rails_initialization" do
-      insert_middleware
-      ServiceWorker.logger = ::Rails.logger
-      ServiceWorker.root = ::Rails.root.to_s
-    end
+      config.serviceworker.logger ||= ::Rails.logger
+      config.serviceworker.routes.draw_default unless config.serviceworker.routes.any?
 
-    def insert_middleware
-      if defined? ::Rack::SendFile
-        app.middleware.insert_after ::Rack::Sendfile, ServiceWorker::Middleware
-      else
-        app.middleware.use ServiceWorker::Middleware
-      end
+      app.middleware.use ServiceWorker::Middleware, config.serviceworker
     end
 
     def app

data/lib/serviceworker/route.rb

@@ -0,0 +1,49 @@
+module ServiceWorker
+  class Route
+    attr_reader :path, :options
+
+    def initialize(path, options = {})
+      @path = path
+      @options = options
+
+      @pattern = compile(path)
+    end
+
+    def match?(path)
+      @pattern =~ path
+    end
+
+    def asset_name
+      @options.fetch(:asset, @path.gsub(%r{^/}, ""))
+    rescue NoMethodError
+      raise RouteError, "Cannot determine asset name from #{path.inspect}. Please specify the :asset option for this path."
+    end
+
+    def headers
+      @options.fetch(:headers, {})
+    end
+
+    private
+
+    def compile(path)
+      if path.respond_to?(:to_str)
+        special_chars = %w[. + ( )]
+        pattern = path.to_str.gsub(/([\*#{special_chars.join}])/) do |match|
+          case match
+          when "*"
+            "(.*?)"
+          when *special_chars
+            Regexp.escape(match)
+          else
+            "([^/?&#]+)"
+          end
+        end
+        /^#{pattern}$/
+      elsif path.respond_to?(:match)
+        path
+      else
+        raise TypeError, path
+      end
+    end
+  end
+end

data/lib/serviceworker/router.rb

@@ -0,0 +1,46 @@
+module ServiceWorker
+  class Router
+    def self.default
+      new.draw_default
+    end
+
+    attr_reader :routes
+
+    def initialize
+      @routes = []
+
+      draw(&Proc.new) if block_given?
+    end
+
+    def draw(&block)
+      return self unless block_given?
+
+      if block.arity == 1
+        block.call(self)
+      else
+        instance_eval(&block)
+      end
+
+      self
+    end
+
+    def draw_default
+      draw { get "/serviceworker.js" }
+    end
+
+    def get(path, options = {})
+      Route.new(path, options).tap do |route|
+        @routes << route
+      end
+    end
+
+    def any?
+      @routes.any?
+    end
+
+    def match_route(path)
+      @routes.detect { |r| r.match?(path) }
+    end
+  end
+
+end

data/serviceworker-rails.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["rosskaff@gmail.com"]
 
   spec.summary       = %q{ServiceWorker for Rails 3+}
-  spec.description   = %q{Integrates ServiceWorker JavaScript support into the Rails asset pipeline.}
+  spec.description   = %q{Integrates ServiceWorker into the Rails asset pipeline.}
   spec.homepage      = "https://github.com/rossta/serviceworker-rails"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serviceworker-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ross Kaffenberger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-23 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Integrates ServiceWorker JavaScript support into the Rails asset pipeline.
+description: Integrates ServiceWorker into the Rails asset pipeline.
 email:
 - rosskaff@gmail.com
 executables: []
@@ -105,10 +105,13 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/_guard-core
 - bin/console
+- bin/guard
 - bin/rake
 - bin/rspec
 - bin/setup
@@ -116,8 +119,11 @@ files:
 - lib/serviceworker.rb
 - lib/serviceworker/middleware.rb
 - lib/serviceworker/rails.rb
+- lib/serviceworker/rails/handler.rb
 - lib/serviceworker/rails/version.rb
 - lib/serviceworker/railtie.rb
+- lib/serviceworker/route.rb
+- lib/serviceworker/router.rb
 - serviceworker-rails.gemspec
 homepage: https://github.com/rossta/serviceworker-rails
 licenses: