webpacker-pwa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15d6f7e278d5f03064a42d65196183da6b78987d096c36b76948aadf61754e92
+  data.tar.gz: 10293b967d75603a0d69344684edd465cf567d9cb785b5d874bc67e39e4ec572
+SHA512:
+  metadata.gz: 6712abab6f9b293996a38fed02004b24e28cd750b70ec1a553b8a66ce9c1cac0b73b9f1b44b998cffc47ee682efd2da62fd2e55915d85bb8b0bb4af3926f016e
+  data.tar.gz: a967a9400f8d469eae6c0c86bc8db2159b17794fdba9b5a94b79aa30ef77332ee0355fd0379c7a10478a62af80401790cd5e41321a69e3367fdf0cabdf9d7175

data/.rspec_status

@@ -0,0 +1,5 @@
+example_id                                           | status | run_time        |
+---------------------------------------------------- | ------ | --------------- |
+./spec/webpacker/pwa/dev_server_proxy_spec.rb[1:1:1] | passed | 0.0414 seconds  |
+./spec/webpacker/pwa/dev_server_proxy_spec.rb[1:2:1] | passed | 0.00139 seconds |
+./spec/webpacker/pwa/version_spec.rb[1:1]            | passed | 0.00269 seconds |

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in webpacker-pwa.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    webpacker-pwa (0.1.0)
+      rack-proxy (>= 0.6.1)
+      webpacker (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.3.1)
+      actionview (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.1)
+      activesupport (= 6.0.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.5.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.2)
+    rack-proxy (0.6.5)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    semantic_range (2.3.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    webpacker (5.1.1)
+      activesupport (>= 5.2)
+      rack-proxy (>= 0.6.1)
+      railties (>= 5.2)
+      semantic_range (>= 2.3.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  webpacker-pwa!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,29 @@
+# webpacker-pwa
+
+A Rack Middleware to serve service workers when runnning webpack-dev-server.
+Webpacker middleware, by default, redirects only requests to `/packs` to webpack-dev-server, 
+and since our service workers live in the `public` folder, they cannot be served.
+
+This gem fixes this issue by adding a Rack Middleware responsible of serving service workers files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webpacker-pwa', group: :development
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install webpacker-pwa
+
+## 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "webpacker/pwa"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/webpacker/pwa.rb

@@ -0,0 +1,4 @@
+require "webpacker/pwa/dev_server_proxy"
+require "webpacker/pwa/version"
+
+require "webpacker/pwa/railtie" if defined?(Rails)

data/lib/webpacker/pwa/dev_server_proxy.rb

@@ -0,0 +1,45 @@
+require "rack/proxy"
+require "webpacker"
+
+module Webpacker
+  module Pwa
+    class DevServerProxy < Rack::Proxy
+      def initialize(app = nil, opts = {})
+        @webpacker = opts.delete(:webpacker) || Webpacker.instance
+        opts[:streaming] = false if Rails.env.test? && !opts.key?(:streaming)
+        super
+      end
+
+      def perform_request(env)
+        service_workers_entry_path = dev_server.config.send(:fetch, :service_workers_entry_path)
+        return unless service_workers_entry_path.present?
+        service_workers_folder = dev_server.config.source_path.join(service_workers_entry_path)
+        service_workers = Dir[service_workers_folder.join('*')].map { |e| "/#{File.basename(e)}" }
+        if (service_workers.include?(env["PATH_INFO"])) && dev_server.running?
+          env["HTTP_HOST"] = env["HTTP_X_FORWARDED_HOST"] = dev_server.host
+          env["HTTP_X_FORWARDED_SERVER"] = dev_server.host_with_port
+          env["HTTP_PORT"] = env["HTTP_X_FORWARDED_PORT"] = dev_server.port.to_s
+          env["HTTP_X_FORWARDED_PROTO"] = env["HTTP_X_FORWARDED_SCHEME"] = dev_server.protocol
+          unless dev_server.https?
+            env["HTTPS"] = env["HTTP_X_FORWARDED_SSL"] = "off"
+          end
+          env["SCRIPT_NAME"] = ""
+
+          super(env)
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def config
+        @webpacker.config
+      end
+
+      def dev_server
+        @webpacker.dev_server
+      end
+    end
+  end
+end

data/lib/webpacker/pwa/railtie.rb

@@ -0,0 +1,17 @@
+require "rails/railtie"
+
+module Webpacker
+  module Pwa
+    class Railtie < Rails::Railtie
+      initializer "webpacker-pwa.proxy" do |app|
+        insert_middleware = Webpacker.config.dev_server.present? rescue nil
+        if insert_middleware
+          app.middleware.insert_before 0,
+                                       Rails::VERSION::MAJOR >= 5 ?
+                                           Webpacker::Pwa::DevServerProxy : "Webpacker::Pwa::DevServerProxy",
+                                       ssl_verify_none: true
+        end
+      end
+    end
+  end
+end

data/lib/webpacker/pwa/version.rb

@@ -0,0 +1,5 @@
+module Webpacker
+  module Pwa
+    VERSION = "0.1.0"
+  end
+end

data/webpacker-pwa.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/webpacker/pwa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "webpacker-pwa"
+  spec.version       = Webpacker::Pwa::VERSION
+  spec.authors       = ["Alessandro Rodi"]
+  spec.email         = ["alessandro.rodi@renuo.ch"]
+
+  spec.summary       = %q{webpacker-pwa enables you to serve service workers with webpack-dev-server}
+  spec.homepage      = "https://github.com/coorasse/webpacker-pwa"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/coorasse/webpacker-pwa"
+  spec.metadata["changelog_uri"] = "https://github.com/coorasse/webpacker-pwa/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack-proxy",    ">= 0.6.1"
+  spec.add_dependency "webpacker",    ">= 4.0.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: webpacker-pwa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alessandro Rodi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: 
+email:
+- alessandro.rodi@renuo.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec_status"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/webpacker/pwa.rb
+- lib/webpacker/pwa/dev_server_proxy.rb
+- lib/webpacker/pwa/railtie.rb
+- lib/webpacker/pwa/version.rb
+- webpacker-pwa.gemspec
+homepage: https://github.com/coorasse/webpacker-pwa
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/coorasse/webpacker-pwa
+  source_code_uri: https://github.com/coorasse/webpacker-pwa
+  changelog_uri: https://github.com/coorasse/webpacker-pwa/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: webpacker-pwa enables you to serve service workers with webpack-dev-server
+test_files: []