pwa 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7b6a1ba7a840009d8ff9cfd2d05199587fc08c0641bd3187c2ff4d9a6a74f47
+  data.tar.gz: 245d7d74734b5c6b80c1c2388de4224b283b7a2f7dcaf34f60991a2d2daf60d8
+SHA512:
+  metadata.gz: 95367870f106bcd063e895b8791b38c9750593841c8981094c5e0c0f70813d7f6ad68ff671f624648237c85ba032aa82836018c318df87481996513e000edbcd
+  data.tar.gz: 70625d53a80f4290f2591ed9cfddeb197590888576178fdec71348b4ef76a1aff64ba5286ee10674c4bccca5c3f0cb8c832235e318974078aebab5e6ed5da6d6

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0 - 2018/01/14
+
+* initial release

data/LICENSE

@@ -0,0 +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.

data/README.md

@@ -0,0 +1,128 @@
+# 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 [devise-onseignal](https://github.com/jonhue/devise-onesignal) 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 [Native](https://github.com/NativeGap/native-rails).
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [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'
+```
+
+Now run the generator:
+
+    $ rails g pwa
+
+Make sure to add the required javascript in `app/assets/javascripts/application.js`:
+
+```js
+//= require pwa
+```
+
+Lastly, go to your routes file (`config/routes.rb`) and mount the `Pwa::Engine` class:
+
+```ruby
+mount Pwa::Engine, at: '/pwa'
+```
+
+**Note:** The path `Pwa::Engine` gets mounted at, is currently required to be `pwa`.
+
+---
+
+## Usage
+
+...
+
+---
+
+## 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/offline_controller.rb

@@ -0,0 +1,8 @@
+module Pwa
+    class OfflineController < ApplicationController
+
+        def index
+        end
+
+    end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Pwa::Engine.routes.draw do
+
+    get 'offline', to: 'pwa/offline#index'
+
+end

data/lib/generators/pwa_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class PwaGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.join File.dirname(__FILE__), 'templates'
+    desc 'Install Progressive Web Apps for Rails'
+
+    def create_view
+        template 'view.html.erb', 'app/views/pwa/offline/index.html.erb'
+    end
+
+    def create_service_worker
+        template 'service_worker.js', 'public/pwa-sw.js'
+    end
+
+end

data/lib/generators/templates/service_worker.js

@@ -0,0 +1,52 @@
+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(['/pwa/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('pwa/offline');
+            } else {
+                return matching;
+            };
+        });
+    });
+};

data/lib/generators/templates/view.html.erb

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

data/lib/pwa.rb

@@ -0,0 +1,7 @@
+require 'pwa/version'
+
+module Pwa
+
+    require 'pwa/engine'
+
+end

data/lib/pwa/engine.rb

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

data/lib/pwa/version.rb

@@ -0,0 +1,5 @@
+module Pwa
+
+    VERSION = '1.0.0'
+
+end

data/vendor/assets/javascripts/pwa.js

@@ -0,0 +1,9 @@
+if (navigator.serviceWorker.controller) {
+    console.log('[PWA] Active service worker found')
+} else {
+    navigator.serviceWorker.register( '/pwa-sw.js', { scope: './' }).then(function(reg) {
+        console.log( '[PWA] ServiceWorker registration successful with scope: ', reg.scope );
+    }, function(err) {
+        console.log( '[PWA] ServiceWorker registration failed: ', err );
+    });
+}

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: pwa
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: Progressive Web Apps for Rails.
+email: me@jonhue.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- app/controllers/pwa/offline_controller.rb
+- config/routes.rb
+- lib/generators/pwa_generator.rb
+- lib/generators/templates/service_worker.js
+- lib/generators/templates/view.html.erb
+- lib/pwa.rb
+- lib/pwa/engine.rb
+- lib/pwa/version.rb
+- vendor/assets/javascripts/pwa.js
+homepage: https://github.com/jonhue/pwa
+licenses:
+- MIT
+metadata: {}
+post_install_message: |
+  **Thank you for installing Progressive Web Apps for Rails!**
+
+
+  There are two more steps to take:
+
+  1) Run `rails g pwa`
+  2) Mount engine in `config/routes.rb`:
+
+      mount Pwa::Engine, at: '/pwa'
+
+
+  Learn more at https://github.com/jonhue/pwa
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Progressive Web Apps for Rails
+test_files: []