pwa 4.0.4 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02526d09194fef00e23397bb5ebd9d64ac9bd7eb16ed732a9ca9aa1d967ee1cf
-  data.tar.gz: 7255bbba581943f3ad41a6df455966ad13b936b07c96dde2d4b20e91eb5b6bcf
+  metadata.gz: c68c3a4139644a4c822ef4fbe2f936d9d5ba77dbc5bce4e923e548d6b23cbf11
+  data.tar.gz: 4a6579f0c4b6d2870259356120edb5d7122c394891d538bd035d887ada96bc93
 SHA512:
-  metadata.gz: ba19e0f45aef7ab901b56b06d0b10c1e9082e9d0502ddd82d5cfcdb78bbffd28d1485463f7de1d588f3e05ffdd09321645df22f2fb9664e878396654b41efa16
-  data.tar.gz: 2a1ea7518c06dfc2dcd50596c5a2981e1308e13930006bf2f1d4c6daa0f2881365484e96aea1d17a3f7d79122e547a6e422d0105b6aa77c486740c1c77f27c34
+  metadata.gz: 4c4c231793d21253b628c85289aa7e454de852b85533a660278a61e7349394c050b6e2742dcfeae3393096206a832c71f9aca98109501fa2681a3ff4fafe28b5
+  data.tar.gz: a0e7d149368d756950f0fa5f01181392ab13b6d6d0a7e08e92108cbcbcac9499235d8d0123051a19cc8c02cb5e8f17e82f5fc35804d810eb2d411a44b1f88fd8

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2018 Jonas Hübotter
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,234 +1,234 @@
-# Progressive Web Apps for Rails
-
-[![Gem Version](https://badge.fury.io/rb/pwa.svg)](https://badge.fury.io/rb/pwa) <img src="https://travis-ci.org/jonhue/pwa.svg?branch=master" />
-
-This gem only provides the foundation you can build your Progressive Web App upon. It simplifies adding a service worker and a manifest to your app, so it can be recognized as an PWA and be accessed without a network connection.
-
-[Google](https://developers.google.com/web/progressive-web-apps/) defines Progressive Web Apps as:
-
-* **Reliable** - Load instantly and never show the downasaur, even in uncertain network conditions.
-    * This is handled by Progressive Web Apps for Rails.
-* **Fast** - Respond quickly to user interactions with silky smooth animations and no janky scrolling.
-    * There are two technologies helping you with performance: *Turbolinks* & *AMP*. When you are using Turbolinks, use [TurbolinksAnimate](https://github.com/jonhue/turbolinks-animate) to get XHR requests + smooth page transitions that add some delight to using to your app. If you want to use AMP, take a look at [amp-html](https://github.com/jonhue/amp-html), an Accelerated Mobile Pages library for Rails apps.
-* **Engaging** - Feel like a natural app on the device, with an immersive user experience.
-    * When you think about making your app more engaging, you can't get around user-notifications. OneSignal is a powerful (& free) solution. With [OnSignal](https://github.com/jonhue/onsignal) and [notification-pusher-onesignal](https://github.com/jonhue/notifications-rails/tree/master/notification-pusher/notification-pusher-onesignal) adding native notification capabilities to your app becomes dead simple.
-
----
-
-If a PWA is not enough and you want to bring your Web App into the store - check out [NativeGap](https://github.com/NativeGap/nativegap-rails).
-
----
-
-## Table of Contents
-
-* [Installation](#installation)
-* [Usage](#usage)
-    * [Quick start](#quick-start)
-    * [Apps](#apps)
-        * [Manifest](#manifest)
-        * [Offline pages](#offline-pages)
-    * [Themes](#themes)
-    * [Service worker](#service-worker)
-    * [Styles](#styles)
-* [Configuration](#configuration)
-* [To Do](#to-do)
-* [Contributing](#contributing)
-    * [Contributors](#contributors)
-    * [Semantic versioning](#semantic-versioning)
-* [License](#license)
-
----
-
-## Installation
-
-Progressive Web Apps for Rails works with Rails 5 onwards. You can add it to your `Gemfile` with:
-
-```ruby
-gem 'pwa'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install pwa
-
-If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
-
-```ruby
-gem 'pwa', github: 'jonhue/pwa'
-```
-
----
-
-## Usage
-
-### Quick start
-
-Run the generators:
-
-    $ rails g mozaic:install
-    $ rails g pwa:install
-    $ rails g pwa:app -n "App"
-
-Now define your app:
-
-```ruby
-Pwa.configure do |config|
-    config.define_app 'App'
-end
-```
-
-Add the following to the `head` tag of your layout file:
-
-```haml
-= component 'pwa/manifest', url: request.base_url
-```
-
-Now add the `pwa-rails` NPM package and initialize it:
-
-```js
-import ProgressiveWebApp from 'pwa-rails';
-document.addEventListener( 'turbolinks:load', () => {
-    const progressiveWebApp = new ProgressiveWebApp();
-})
-```
-
-**Note:** If the name of the service worker is not the default `/pwa-sw.js` you can specify a custom path: `new ProgressiveWebApp('/custom-path.js')`
-
-Lastly, go to your routes file (`config/routes.rb`) and mount the `Pwa::Engine` class:
-
-```ruby
-mount Pwa::Engine, at: ''
-```
-
-**Note:** The path `Pwa::Engine` is being mounted at, is currently required to be `''`.
-
-### Apps
-
-Progressive Web Apps for Rails allows for multiple Progressive Web Apps per Rails app:
-
-```ruby
-Pwa.configure do |config|
-    config.define_app 'Subdomain', ['subdomain.example.com', 'subdomain.lvh.me:3000']
-    config.define_app 'Example', ['example.com', 'localhost:3000', 'lvh.me:3000']
-end
-```
-
-**Note:** You can omit the array of URL scopes if you have just one PWA.
-
-When looking for an app, the first app specified with a matching scope will be used.
-
-#### Manifest
-
-The app generator generates a manifest file located in the `app/views/pwa/apps/manifests` directory. It is accessible through `/manifest.json`. You can customize it to your liking.
-
-#### Offline pages
-
-Progressive Web Apps for Rails automatically stores a copy of the offline page (`app/views/pwa/apps/offline/_app.html.erb`) in the users cache, so your app is accessible at any time, even if requested URLs have not been cached yet.
-
-### Themes
-
-Progressive Web Apps for Rails simplifies adding themes reflected in browsers to your site. Add the following to the `head` tag in your layout file:
-
-```haml
-= component 'pwa/theme', default: '#000000'
-```
-
-**Note:** `default` falls back to `#FFFFFF`.
-
-You can now override the default theme color from your views:
-
-```haml
-- area :pwa_theme, '#FF0000'
-```
-
-### Service worker
-
-The generator also generates a service worker which caches visited pages to the local storage so they can get accessed even if the device has no network connection.
-
-You can customize the page that shows up when a requested page has not been cached by editing the contents of `app/views/pwa/offline/index.html.erb`
-
-**Note:** When using Progressive Web Apps for Rails with a service worker provided by a third party service like OneSignal, remove the require statement from `app/assets/javascripts/application.js` and manually import your apps service worker in the third party script:
-
-```js
-importScripts('https://example.com/pwa-sw.js');
-```
-
-### Styles
-
-To detect whether or not your app is currently being used as a Progressive Web App, you can use CSS media queries:
-
-```css
-@media all and (display-mode: standalone) {
-    /* ... */
-}
-```
-
-**Note:** Make sure to use `fullscreen` instead of `standalone` if that is your PWA display mode.
-
----
-
-## Configuration
-
-You can configure Pwa by passing a block to `configure`. This can be done in `config/initializers/pwa.rb`:
-
-```ruby
-Pwa.configure do |config|
-    config.define_app 'App', ['example.com']
-end
-```
-
-* `define_app` Define apps with a name and URL scopes.
-
----
-
-## To Do
-
-[Here](https://github.com/jonhue/pwa/projects/1) is the full list of current projects.
-
-To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/pwa/issues/new).
-
----
-
-## Contributing
-
-We hope that you will consider contributing to Progressive Web Apps for Rails. Please read this short overview for some information about how to get started:
-
-[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
-
-### Contributors
-
-Give the people some :heart: who are working on this project. See them all at:
-
-https://github.com/jonhue/pwa/graphs/contributors
-
-### Semantic Versioning
-
-Progressive Web Apps for Rails follows Semantic Versioning 2.0 as defined at http://semver.org.
-
-## License
-
-MIT License
-
-Copyright (c) 2018 Jonas Hübotter
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+# Progressive Web Apps for Rails
+
+[![Gem Version](https://badge.fury.io/rb/pwa.svg)](https://badge.fury.io/rb/pwa) <img src="https://travis-ci.org/jonhue/pwa.svg?branch=master" />
+
+This gem only provides a foundation upon which you can build your Progressive Web App. It simplifies adding a service worker and a manifest to your app, so that it can be recognized as an PWA and as such accessed without a network connection.
+
+[Google](https://developers.google.com/web/progressive-web-apps/) defines Progressive Web Apps as:
+
+* **Reliable** - Load instantly and never show the downasaur, even in uncertain network conditions.
+    * This is handled by Progressive Web Apps for Rails.
+* **Fast** - Respond quickly to user interactions with silky smooth animations and no janky scrolling.
+    * There are two technologies helping you with performance: *Turbolinks* & *AMP*. When you are using Turbolinks, use [TurbolinksAnimate](https://github.com/jonhue/turbolinks-animate) to get XHR requests + smooth page transitions that add some delight to using to your app. If you want to use AMP, take a look at [amp-html](https://github.com/jonhue/amp-html), an Accelerated Mobile Pages library for Rails apps.
+* **Engaging** - Feel like a natural app on the device, with an immersive user experience.
+    * When you think about making your app more engaging, you can't get around user-notifications. OneSignal is a powerful (& free) solution. With [OnSignal](https://github.com/jonhue/onsignal) and [notification-pusher-onesignal](https://github.com/jonhue/notifications-rails/tree/master/notification-pusher/notification-pusher-onesignal) adding native notification capabilities to your app becomes dead simple.
+
+---
+
+If a PWA is not enough and you want to bring your Web App into the store - check out [NativeGap](https://github.com/NativeGap/nativegap-rails).
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+    * [Quick start](#quick-start)
+    * [Apps](#apps)
+        * [Manifest](#manifest)
+        * [Offline pages](#offline-pages)
+    * [Themes](#themes)
+    * [Service worker](#service-worker)
+    * [Styles](#styles)
+* [Configuration](#configuration)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+## Installation
+
+Progressive Web Apps for Rails works with Rails 5 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'pwa'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pwa
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'pwa', github: 'jonhue/pwa'
+```
+
+---
+
+## Usage
+
+### Quick start
+
+Run the generators:
+
+    $ rails g mozaic:install
+    $ rails g pwa:install
+    $ rails g pwa:app -n "App"
+
+Now define your app:
+
+```ruby
+Pwa.configure do |config|
+    config.define_app 'App'
+end
+```
+
+Add the following to the `head` tag of your layout file:
+
+```haml
+= component 'pwa/manifest', url: request.base_url
+```
+
+Now add the `pwa-rails` NPM package and initialize it:
+
+```js
+import ProgressiveWebApp from 'pwa-rails';
+document.addEventListener( 'turbolinks:load', () => {
+    const progressiveWebApp = new ProgressiveWebApp();
+})
+```
+
+**Note:** If the name of the service worker is not the default `/pwa-sw.js` you can specify a custom path: `new ProgressiveWebApp('/custom-path.js')`
+
+Lastly, go to your routes file (`config/routes.rb`) and mount the `Pwa::Engine` class:
+
+```ruby
+mount Pwa::Engine, at: ''
+```
+
+**Note:** The path `Pwa::Engine` is being mounted at, is currently required to be `''`.
+
+### Apps
+
+Progressive Web Apps for Rails allows for multiple Progressive Web Apps per Rails app:
+
+```ruby
+Pwa.configure do |config|
+    config.define_app 'Subdomain', ['subdomain.example.com', 'subdomain.lvh.me:3000']
+    config.define_app 'Example', ['example.com', 'localhost:3000', 'lvh.me:3000']
+end
+```
+
+**Note:** You can omit the array of URL scopes if you have just one PWA.
+
+When looking for an app, the first app specified with a matching scope will be used.
+
+#### Manifest
+
+The app generator generates a manifest file located in the `app/views/pwa/apps/manifests` directory. It is accessible through `/manifest.json`. You can customize it to your liking.
+
+#### Offline pages
+
+Progressive Web Apps for Rails automatically stores a copy of the offline page (`app/views/pwa/apps/offline/_app.html.erb`) in the users cache, so your app is accessible at all times, even if requested URLs have not been cached yet.
+
+### Themes
+
+Progressive Web Apps for Rails simplifies adding themes reflected in browsers to your site. Add the following to the `head` tag in your layout file:
+
+```haml
+= component 'pwa/theme', default: '#000000'
+```
+
+**Note:** `default` falls back to `#FFFFFF`.
+
+You can now override the default theme color from your views:
+
+```haml
+- area :pwa_theme, '#FF0000'
+```
+
+### Service worker
+
+The generator also generates a service worker which caches visited pages to the local storage so they can get accessed even if the device has no network connection.
+
+You can customize the page that shows up when a requested page has not been cached by editing the contents of `app/views/pwa/offline/index.html.erb`
+
+**Note:** When using Progressive Web Apps for Rails with a service worker provided by a third party service like OneSignal, remove the NPM package and manually import your apps service worker in the third party script:
+
+```js
+importScripts('https://example.com/pwa-sw.js');
+```
+
+### Styles
+
+To detect whether or not your app is currently being used as a Progressive Web App, you can use CSS media queries:
+
+```css
+@media all and (display-mode: standalone) {
+    /* ... */
+}
+```
+
+**Note:** Make sure to use `fullscreen` instead of `standalone` if that is your PWA display mode.
+
+---
+
+## Configuration
+
+You can configure Pwa by passing a block to `configure`. This can be done in `config/initializers/pwa.rb`:
+
+```ruby
+Pwa.configure do |config|
+    config.define_app 'App', ['example.com']
+end
+```
+
+* `define_app` Define apps with a name and URL scopes.
+
+---
+
+## To Do
+
+[Here](https://github.com/jonhue/pwa/projects/1) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/pwa/issues/new).
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to Progressive Web Apps for Rails. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/jonhue/pwa/graphs/contributors
+
+### Semantic Versioning
+
+Progressive Web Apps for Rails follows Semantic Versioning 2.0 as defined at http://semver.org.
+
+## License
+
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/app/controllers/pwa/apps_controller.rb

@@ -1,19 +1,17 @@
-module Pwa
-    class AppsController < ApplicationController
-
-        before_action :get_app
-
-        def manifest
-        end
-
-        def offline
-        end
-
-        private
-
-        def get_app
-            @app = Pwa::App.find_by_url(request.original_url).first
-        end
-
-    end
-end
+# frozen_string_literal: true
+
+module Pwa
+  class AppsController < ApplicationController
+    before_action :set_app
+
+    def manifest; end
+
+    def offline; end
+
+    private
+
+    def set_app
+      @app = Pwa::App.find_by_url(request.original_url).first
+    end
+  end
+end

data/app/views/mozaic/pwa/_theme.html.erb

@@ -1 +1 @@
-<meta name="theme-color" content="<%= area :pwa_theme, options[:default] %>">
+<meta name="theme-color" content="<%= area :pwa_theme, options[:default] %>">

data/app/views/pwa/apps/manifest.json.erb

@@ -1 +1 @@
-<%= render "pwa/apps/manifests/#{@app.safe_name}" %>
+<%= render "pwa/apps/manifests/#{@app.safe_name}" %>

data/app/views/pwa/apps/offline.html.erb

@@ -1 +1 @@
-<%= render "pwa/apps/offline/#{@app.safe_name}" %>
+<%= render "pwa/apps/offline/#{@app.safe_name}" %>

data/config/routes.rb

@@ -1,6 +1,6 @@
-Pwa::Engine.routes.draw do
-
-    get 'offline', to: 'pwa/apps#offline'
-    get 'manifest', to: 'pwa/apps#manifest', defaults: { format: :json }
-
-end
+# frozen_string_literal: true
+
+Pwa::Engine.routes.draw do
+  get 'offline', to: 'pwa/apps#offline'
+  get 'manifest', to: 'pwa/apps#manifest', defaults: { format: :json }
+end

data/lib/generators/pwa/app_generator.rb

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/migration'
 
 module Pwa
-    class AppGenerator < Rails::Generators::Base
-
-        include Rails::Generators::Migration
-
-        source_root File.join File.dirname(__FILE__), '../templates/app'
-        desc 'Generate a Progressive Web Apps for Rails app'
+  class AppGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
 
-        class_option :name, desc: 'App name', type: :string, default: 'index', aliases: '-n'
+    source_root File.join File.dirname(__FILE__), '../templates/app'
+    desc 'Generate a Progressive Web Apps for Rails app'
 
-        def create_files
-            @name = options[:name].parameterize.underscore
-            template 'manifest.json.erb', "app/views/pwa/apps/manifests/_#{@name}.json"
-            template 'offline.html.erb', "app/views/pwa/apps/offline/_#{@name}.html.erb"
-        end
+    class_option :name, desc: 'App name', type: :string, default: 'index',
+                        aliases: '-n'
 
+    def create_files
+      @name = options[:name].parameterize.underscore
+      template 'manifest.json.erb',
+               "app/views/pwa/apps/manifests/_#{@name}.json"
+      template 'offline.html.erb',
+               "app/views/pwa/apps/offline/_#{@name}.html.erb"
     end
+  end
 end

data/lib/generators/pwa/install_generator.rb

@@ -1,21 +1,21 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/migration'
 
 module Pwa
-    class InstallGenerator < Rails::Generators::Base
-
-        include Rails::Generators::Migration
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
 
-        source_root File.join File.dirname(__FILE__), '../templates/install'
-        desc 'Install Progressive Web Apps for Rails'
+    source_root File.join File.dirname(__FILE__), '../templates/install'
+    desc 'Install Progressive Web Apps for Rails'
 
-        def create_initializer
-            template 'initializer.rb', 'config/initializers/pwa.rb'
-        end
-
-        def create_files
-            template 'service-worker.js', 'public/pwa-sw.js'
-        end
+    def create_initializer
+      template 'initializer.rb', 'config/initializers/pwa.rb'
+    end
 
+    def create_files
+      template 'service-worker.js', 'public/pwa-sw.js'
     end
+  end
 end

data/lib/generators/templates/app/manifest.json.erb

@@ -1,22 +1,22 @@
-{
-    "short_name": "<%= options[:name].titleize %>",
-    "name": "<%= options[:name].titleize %>",
-    "start_url": "/",
-    "scope": "/",
-    "display": "standalone",
-    "background_color": "#FFFFFF",
-    "description": "",
-    "theme_color": "#000000",
-    "orientation": "portrait",
-    "dir": "rtl",
-    "lang": "en-US",
-    "icons": [{
-        "src": "/70x70.png",
-        "sizes": "70x70",
-        "type": "image/png"
-    }, {
-        "src": "/192x192.png",
-        "sizes": "192x192",
-        "type": "image/png"
-    }]
-}
+{
+  "short_name": "<%= options[:name].titleize %>",
+  "name": "<%= options[:name].titleize %>",
+  "start_url": "/",
+  "scope": "/",
+  "display": "standalone",
+  "background_color": "#FFFFFF",
+  "description": "",
+  "theme_color": "#000000",
+  "orientation": "portrait",
+  "dir": "rtl",
+  "lang": "en-US",
+  "icons": [{
+    "src": "/70x70.png",
+    "sizes": "70x70",
+    "type": "image/png"
+  }, {
+    "src": "/192x192.png",
+    "sizes": "192x192",
+    "type": "image/png"
+  }]
+}

data/lib/generators/templates/app/offline.html.erb

@@ -1,4 +1,4 @@
-<h1>You are offline</h1>
-<p>
-    Return later with internet conectivity :)
-</p>
+<h1>You are offline</h1>
+<p>
+  Return later with internet conectivity.
+</p>

data/lib/generators/templates/install/initializer.rb

@@ -1,7 +1,9 @@
-Pwa.configure do |config|
-
-    # Define Progressive Web Apps for Rails apps
-    # config.define_app 'Subdomain', ['subdomain.example.com', 'subdomain.lvh.me:3000']
-    # config.define_app 'Example', ['example.com', 'localhost:3000', 'lvh.me:3000']
-
-end
+# frozen_string_literal: true
+
+Pwa.configure do |config|
+  # Define Progressive Web Apps for Rails apps
+  # config.define_app 'Subdomain', ['subdomain.example.com',
+  #                                 'subdomain.lvh.me:3000']
+  # config.define_app 'Example', ['example.com', 'localhost:3000',
+  #                               'lvh.me:3000']
+end

data/lib/generators/templates/install/service-worker.js

@@ -1,52 +1,49 @@
-self.addEventListener( 'install', function(event) {
-    event.waitUntil(preLoad());
-});
-
-var preLoad = function() {
-    console.log('[PWA] Install Event processing');
-    return caches.open('pwa-offline').then(function(cache) {
-        console.log('[PWA] Cached index and offline page during Install');
-        return cache.addAll(['/offline']);
-    });
-}
-
-self.addEventListener( 'fetch', function(event) {
-    console.log('[PWA] The service worker is serving the asset');
-    event.respondWith(checkResponse(event.request).catch(function() {
-        return returnFromCache(event.request);
-    }));
-    event.waitUntil(addToCache(event.request));
-});
-
-var checkResponse = function(request) {
-    return new Promise(function( fulfill, reject ) {
-        fetch(request).then(function(response) {
-            if( response.status !== 404 ) {
-                fulfill(response);
-            } else {
-                reject();
-            };
-        }, reject)
-    });
-};
-
-var addToCache = function(request) {
-    return caches.open('pwa-offline').then(function(cache) {
-        return fetch(request).then(function(response) {
-            console.log( '[PWA] Add page to cache: ', response.url );
-            return cache.put( request, response );
-        });
-    });
-};
-
-var returnFromCache = function(request) {
-    return caches.open('pwa-offline').then(function(cache) {
-        return cache.match(request).then(function(matching) {
-            if( !matching || matching.status == 404 ) {
-                return cache.match('offline');
-            } else {
-                return matching;
-            };
-        });
-    });
-};
+self.addEventListener('install', function(event) {
+  event.waitUntil(preLoad());
+});
+
+var preLoad = function() {
+  return caches.open('pwa-offline').then(function(cache) {
+    return cache.addAll(['/offline']);
+  });
+};
+
+self.addEventListener('fetch', function(event) {
+  event.respondWith(checkResponse(event.request).catch(function() {
+    return returnFromCache(event.request);
+  }));
+  event.waitUntil(addToCache(event.request));
+});
+
+var checkResponse = function(request) {
+  return new Promise(function(fulfill, reject) {
+    fetch(request).then(function(response) {
+      if (response.status !== 404) {
+        fulfill(response);
+      } else {
+        reject();
+      }
+    }, reject);
+  });
+};
+
+var addToCache = function(request) {
+  return caches.open('pwa-offline').then(function(cache) {
+    return fetch(request).then(function(response) {
+      if (request.url)
+        return cache.put(request, response);
+    });
+  });
+};
+
+var returnFromCache = function(request) {
+  return caches.open('pwa-offline').then(function(cache) {
+    return cache.match(request).then(function(matching) {
+      if (!matching || matching.status == 404) {
+        return cache.match('offline');
+      } else {
+        return matching;
+      }
+    });
+  });
+};

data/lib/pwa.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 require 'pwa/version'
 
 module Pwa
+  require 'pwa/configuration'
 
-    require 'pwa/configuration'
-
-    require 'pwa/app'
-
-    require 'pwa/engine'
-    require 'pwa/railtie'
+  require 'pwa/app'
 
+  require 'pwa/engine'
+  require 'pwa/railtie'
 end

data/lib/pwa/app.rb

@@ -1,25 +1,27 @@
-module Pwa
-    class App
-
-        attr_accessor :name
-        attr_accessor :scopes
-
-        def initialize name, scopes = nil
-            @name = name
-            @scopes = scopes
-        end
-
-        def safe_name
-            self.name.parameterize.underscore
-        end
-
-        def self.find_by_name name
-            Pwa.configuration.apps.select { |app| app.name == name }
-        end
-
-        def self.find_by_url url
-            Pwa.configuration.apps.select { |app| app.scopes.nil? || app.scopes.any? { |scope| url.include?(scope) } }
-        end
-
-    end
-end
+# frozen_string_literal: true
+
+module Pwa
+  class App
+    attr_accessor :name
+    attr_accessor :scopes
+
+    def initialize(name, scopes = nil)
+      @name = name
+      @scopes = scopes
+    end
+
+    def safe_name
+      name.parameterize.underscore
+    end
+
+    def self.find_by_name(name)
+      Pwa.configuration.apps.select { |app| app.name == name }
+    end
+
+    def self.find_by_url(url)
+      Pwa.configuration.apps.select do |app|
+        app.scopes.nil? || app.scopes.any? { |scope| url.include?(scope) }
+      end
+    end
+  end
+end

data/lib/pwa/configuration.rb

@@ -1,26 +1,24 @@
-module Pwa
-
-    class << self
-        attr_accessor :configuration
-    end
-
-    def self.configure
-        self.configuration ||= Configuration.new
-        yield configuration
-    end
-
-    class Configuration
-
-        attr_accessor :apps
-
-        def initialize
-            @apps = []
-        end
-
-        def define_app name, scope = nil
-            self.apps << ::Pwa::App.new(name, scope)
-        end
-
-    end
-
-end
+# frozen_string_literal: true
+
+module Pwa
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :apps
+
+    def initialize
+      @apps = []
+    end
+
+    def define_app(name, scope = nil)
+      @apps << ::Pwa::App.new(name, scope)
+    end
+  end
+end

data/lib/pwa/engine.rb

@@ -1,7 +1,8 @@
-require 'rails/railtie'
-
-module Pwa
-    class Engine < ::Rails::Engine
-        # isolate_namespace Pwa
-    end
-end
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Pwa
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/pwa/railtie.rb

@@ -1,15 +1,15 @@
-require 'rails/railtie'
-require 'mozaic'
-
-module Pwa
-    class Railtie < Rails::Railtie
-
-        initializer 'pwa.mozaic' do
-            Mozaic.configure do |config|
-                config.define_component 'pwa/manifest', url: 'http://localhost:3000'
-                config.define_component 'pwa/theme', default: '#FFFFFF'
-            end
-        end
-
-    end
-end
+# frozen_string_literal: true
+
+require 'rails/railtie'
+require 'mozaic'
+
+module Pwa
+  class Railtie < Rails::Railtie
+    initializer 'pwa.mozaic' do
+      Mozaic.configure do |config|
+        config.define_component 'pwa/manifest', url: 'http://localhost:3000'
+        config.define_component 'pwa/theme', default: '#FFFFFF'
+      end
+    end
+  end
+end

data/lib/pwa/version.rb

@@ -1,5 +1,5 @@
-module Pwa
-
-    VERSION = '4.0.4'
+# frozen_string_literal: true
 
+module Pwa
+  VERSION = '4.0.5'
 end

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: pwa
 version: !ruby/object:Gem::Version
-  version: 4.0.4
+  version: 4.0.5
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: mozaic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: mozaic
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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.52'
+        version: '0'
 description: Add a service worker and a manifest to your app, for it to be recognized
   as a PWA and accessed without a network connection.
 email: me@jonhue.me
@@ -73,7 +87,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE
 - README.md
 - app/controllers/pwa/apps_controller.rb
@@ -94,7 +107,7 @@ files:
 - lib/pwa/engine.rb
 - lib/pwa/railtie.rb
 - lib/pwa/version.rb
-homepage: https://jonhue.me/repos/progressive-web-apps-for-rails
+homepage: https://github.com/jonhue/pwa
 licenses:
 - MIT
 metadata: {}
@@ -114,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Progressive Web Apps for Rails

data/CHANGELOG.md

@@ -1,63 +0,0 @@
-# Changelog
-
-### master
-
-* nothing yet
-
-### 4.0.4 - 2018/03/27
-
-* bugfixes
-    * fixed manifest URL in manifest component
-
-### 4.0.3 - 2018/03/27
-
-* bugfixes
-    * fixed manifest URL in manifest component
-
-### 4.0.2 - 2018/03/27
-
-* bugfixes
-    * fixed manifest URL in manifest component
-
-### 4.0.1 - 2018/03/27
-
-* bugfixes
-    * fixed manifest URL in manifest component
-
-### 4.0.0 - 2018/03/27
-
-* features
-    * NPM package overhaul
-* bugfixes
-    * fixed manifest URL in manifest component
-
-### 3.0.0 - 2018/02/10
-
-* features
-    * add theme support
-* enhancements
-    * use Mozaic for components
-
-### 2.0.1 - 2018/01/26
-
-* bugfixes
-    * fixed `wrong number of arguments` when defining apps without scopes
-
-### 2.0.0 - 2018/01/26
-
-* features
-    * introduced `App` class to support multiple PWAs per Rails app
-
-### 1.2.0 - 2018/01/19
-
-* features
-    * added `pwa_manifest` helper method
-
-### 1.1.0 - 2018/01/17
-
-* features
-    * generate a `manifest.json` file by running the generator
-
-### 1.0.0 - 2018/01/14
-
-* initial release