pwa 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fe07b15c94d9ce07eeeb9d04c77bf04a73a5d70923d176da438b5a096b27e70
-  data.tar.gz: 2945a4cc6a2326e3386acd27e486530a71a33824820e896e6145b7127d5a115d
+  metadata.gz: e4b16d74767980ee9dee6f68fe6028b9f155e160cca22043e1a2d3772c6158cd
+  data.tar.gz: b336abd47c05fb18c8bbae000d0704b8faa932034073c4726a04c4d5b17073fa
 SHA512:
-  metadata.gz: 72aeb998d4323c29359152efb66b8481ebb815b34f5a121d41e5fea916f4897a5c4a43e578b94d145011c7c7bc2cf2131107323f3ecb7300b813dbf668671841
-  data.tar.gz: 0ca785f4e2cba1ac96b79f1145aba452772b9efa7a146a13ac80c7b76d25baaa0c6ad2dd3d564e2c41b2e23eefc183f691940a1304aa4327f2f8a13ac01c2865
+  metadata.gz: b56b33826665907804b226bb31aa4ae442b41eaa6145ac9304044550ea46fda5ec5a50ed93238db27cbf817818cda540559717cf1c1c4e4467d778bee78d39b1
+  data.tar.gz: c25377415c2bdff4f98e315b98f1f126eb3101606233bc4e610b9f7bdbd3d32842612a1190053bf87e3ca8ca608b390ffa8a16142ae0ac62333c182a717baa63

data/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 * nothing yet
 
+### 2.0.0 - 2018/01/26
+
+* features
+    * introduced `App` class to support multiple PWAs per Rails app
+
 ### 1.2.0 - 2018/01/19
 
 * features

data/README.md

@@ -23,9 +23,13 @@ If a PWA is not enough and you want to bring your Web App into the store - check
 
 * [Installation](#installation)
 * [Usage](#usage)
-    * [Manifest](#manifest)
+    * [Quick start](#quick-start)
+    * [Apps](#apps)
+        * [Manifest](#manifest)
+        * [Offline pages](#offline-pages)
     * [Service worker](#service-worker)
     * [Views](#views)
+* [Configuration](#configuration)
 * [To Do](#to-do)
 * [Contributing](#contributing)
     * [Contributors](#contributors)
@@ -56,9 +60,24 @@ If you always want to be up to date fetch the latest from GitHub in your `Gemfil
 gem 'pwa', github: 'jonhue/pwa'
 ```
 
-Now run the generator:
+---
+
+## Usage
+
+### Quick start
 
-    $ rails g pwa
+Run the generators:
+
+    $ rails g pwa:install
+    $ rails g pwa:app -n "App"
+
+Noew define your app:
+
+```ruby
+Pwa.configure do |config|
+    config.define_app 'App'
+end
+```
 
 Add the following to the `head` tag of your layout file:
 
@@ -75,18 +94,31 @@ Make sure to add the required javascript in `app/assets/javascripts/application.
 Lastly, go to your routes file (`config/routes.rb`) and mount the `Pwa::Engine` class:
 
 ```ruby
-mount Pwa::Engine, at: '/pwa'
+mount Pwa::Engine, at: ''
 ```
 
-**Note:** The path `Pwa::Engine` gets mounted at, is currently required to be `pwa`.
+**Note:** The path `Pwa::Engine` is being mounted at, is currently required to be `''`.
 
----
+### Apps
 
-## Usage
+Progressive Web Apps for Rails allows for multiple Progressive Web Apps per Rails app:
 
-### Manifest
+```ruby
+Pwa.configure do |config|
+    config.define_app 'Example', ['example.com', 'localhost:3000', 'lvh.me:3000']
+    config.define_app 'Subdomain', ['subdomain.example.com', 'subdomain.lvh.me:3000']
+end
+```
 
-The generator generates a `manifest.json` file located in the `public` directory. You can customize it to your liking.
+**Note:** You can omit the array of URL scopes if you have just one PWA.
+
+#### 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.
 
 ### Service worker
 
@@ -114,6 +146,20 @@ To detect whether or not your app is currently being used as a Progressive Web A
 
 ---
 
+## 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.

data/app/controllers/pwa/apps_controller.rb

@@ -0,0 +1,19 @@
+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)[0]
+        end
+
+    end
+end

data/app/helpers/pwa_helper.rb

@@ -1,7 +1,7 @@
 module PwaHelper
 
     def pwa_manifest
-        '<link rel="manifest" href="/manifest.json" />'.html_safe
+        "<link rel='manifest' href='manifest.json' />".html_safe
     end
 
 end

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

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

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

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

data/config/routes.rb

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

data/lib/generators/pwa/app_generator.rb

@@ -0,0 +1,21 @@
+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_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

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Pwa
+    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'
+
+        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/{manifest.json → app/manifest.json.erb}

@@ -1,6 +1,6 @@
 {
-    "short_name": "",
-    "name": "",
+    "short_name": "<%= options[:name].titleize %>",
+    "name": "<%= options[:name].titleize %>",
     "start_url": "/",
     "scope": "/",
     "display": "standalone",

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

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

data/lib/generators/templates/{service_worker.js → install/service-worker.js}

@@ -6,7 +6,7 @@ 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']);
+        return cache.addAll(['/offline']);
     });
 }
 
@@ -43,7 +43,7 @@ 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');
+                return cache.match('offline');
             } else {
                 return matching;
             };

data/lib/pwa.rb

@@ -2,6 +2,10 @@ require 'pwa/version'
 
 module Pwa
 
+    require 'pwa/configuration'
+
+    require 'pwa/app'
+
     require 'pwa/engine'
 
 end

data/lib/pwa/app.rb

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

data/lib/pwa/configuration.rb

@@ -0,0 +1,26 @@
+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
+            self.apps << ::Pwa::App.new(name, scope)
+        end
+
+    end
+
+end

data/lib/pwa/version.rb

@@ -1,5 +1,5 @@
 module Pwa
 
-    VERSION = '1.2.0'
+    VERSION = '2.0.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwa
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -61,14 +61,20 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
-- app/controllers/pwa/offline_controller.rb
+- app/controllers/pwa/apps_controller.rb
 - app/helpers/pwa_helper.rb
+- app/views/pwa/apps/manifest.json.erb
+- app/views/pwa/apps/offline.html.erb
 - config/routes.rb
-- lib/generators/pwa_generator.rb
-- lib/generators/templates/manifest.json
-- lib/generators/templates/service_worker.js
-- lib/generators/templates/view.html.erb
+- lib/generators/pwa/app_generator.rb
+- lib/generators/pwa/install_generator.rb
+- lib/generators/templates/app/manifest.json.erb
+- lib/generators/templates/app/offline.html.erb
+- lib/generators/templates/install/initializer.rb
+- lib/generators/templates/install/service-worker.js
 - lib/pwa.rb
+- lib/pwa/app.rb
+- lib/pwa/configuration.rb
 - lib/pwa/engine.rb
 - lib/pwa/version.rb
 - vendor/assets/javascripts/pwa.js
@@ -82,10 +88,10 @@ post_install_message: |
 
   There are two more steps to take:
 
-  1) Run `rails g pwa`
+  1) Run `rails g pwa:install` and `rails g pwa:install -n "Application Name"`
   2) Mount engine in `config/routes.rb`:
 
-      mount Pwa::Engine, at: '/pwa'
+      mount Pwa::Engine, at: ''
 
 
   Learn more at https://github.com/jonhue/pwa

data/app/controllers/pwa/offline_controller.rb

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

data/lib/generators/pwa_generator.rb

@@ -1,23 +0,0 @@
-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_manifest
-        template 'manifest.json', 'public/manifest.json'
-    end
-
-    def create_service_worker
-        template 'service_worker.js', 'public/pwa-sw.js'
-    end
-
-end