pwa 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09ab18d992e870df70b196d5551d63d88890e836c670e728239978e994113090'
-  data.tar.gz: 9a318f36720d851b99ae7ad9c48bfd459af34db12b3c74ac4be59af51c52a059
+  metadata.gz: e69136de72eed2e30d89504da58d8e4d2472cd3ab7fcb63cdd015cfc4e03922d
+  data.tar.gz: ca30c0c3a157154d23d058454b3b64046cbf20fe7440a3b32be26f42631d6df4
 SHA512:
-  metadata.gz: 9ab3512bf4761eced518c142db41bb4e2d607abdf377a8f53625cdeca09e9d8b86787e28901ffe1604b9e8c4ba0cab604ef7e32da813e168fbd33206ae0edae3
-  data.tar.gz: 72e1a304f0dea7c0bb82f3f35d1311f4a9cf628be5ad4ebff7025662f19881025c92faa25090af7bb10f18e3bbb4cfa26bee274784a0f32e67a0f93a9540a8b5
+  metadata.gz: 578ff53f36b826aa4e638ccba011020869a14be7cbbdf5e4b5625ddbc75cf75b66d3df939360bf083e85839218ac9e1b913886dd71695cb91b96cd44c433be69
+  data.tar.gz: 5d2c5de041cc0415540a99a530ef7ff07b8e0d950da74eec6a3108848a69d2209079c33db681d3cf43fe261582ca7748dc0e3e625e9f1290b7dcb679cb8a4bd2

data/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 * nothing yet
 
+### 3.0.0 - 2018/02/10
+
+* features
+    * add theme support
+* enhancements
+    * use Mozaic for components
+
 ### 2.0.1 - 2018/01/26
 
 * bugfixes

data/README.md

@@ -27,6 +27,7 @@ If a PWA is not enough and you want to bring your Web App into the store - check
     * [Apps](#apps)
         * [Manifest](#manifest)
         * [Offline pages](#offline-pages)
+    * [Themes](#themes)
     * [Service worker](#service-worker)
     * [Views](#views)
 * [Configuration](#configuration)
@@ -71,7 +72,7 @@ Run the generators:
     $ rails g pwa:install
     $ rails g pwa:app -n "App"
 
-Noew define your app:
+Now define your app:
 
 ```ruby
 Pwa.configure do |config|
@@ -82,7 +83,7 @@ end
 Add the following to the `head` tag of your layout file:
 
 ```haml
-= pwa_manifest
+= component 'pwa/manifest'
 ```
 
 Make sure to add the required javascript in `app/assets/javascripts/application.js`:
@@ -91,6 +92,8 @@ Make sure to add the required javascript in `app/assets/javascripts/application.
 //= require pwa
 ```
 
+**Note:** If you are using Webpack instead of Sprockets, add and import the `pwa-rails` NPM package.
+
 Lastly, go to your routes file (`config/routes.rb`) and mount the `Pwa::Engine` class:
 
 ```ruby
@@ -122,6 +125,22 @@ The app generator generates a manifest file located in the `app/views/pwa/apps/m
 
 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.

data/app/views/mozaic/pwa/_manifest.html

@@ -0,0 +1 @@
+<link rel='manifest' href='manifest.json' />

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

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

data/lib/pwa.rb

@@ -7,5 +7,6 @@ module Pwa
     require 'pwa/app'
 
     require 'pwa/engine'
+    require 'pwa/railtie'
 
 end

data/lib/pwa/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails/railtie'
+
+module Pwa
+    class Railtie < Rails::Railtie
+
+        initializer 'pwa.mozaic' do
+            Mozaic.configure do |config|
+                config.define_component 'pwa/manifest'
+                config.define_component 'pwa/theme', default: '#FFFFFF'
+            end
+        end
+
+    end
+end

data/lib/pwa/version.rb

@@ -1,5 +1,5 @@
 module Pwa
 
-    VERSION = '2.0.1'
+    VERSION = '3.0.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwa
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2018-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mozaic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -62,7 +76,8 @@ files:
 - LICENSE
 - README.md
 - app/controllers/pwa/apps_controller.rb
-- app/helpers/pwa_helper.rb
+- app/views/mozaic/pwa/_manifest.html
+- app/views/mozaic/pwa/_theme.html.erb
 - app/views/pwa/apps/manifest.json.erb
 - app/views/pwa/apps/offline.html.erb
 - config/routes.rb
@@ -76,6 +91,7 @@ files:
 - lib/pwa/app.rb
 - lib/pwa/configuration.rb
 - lib/pwa/engine.rb
+- lib/pwa/railtie.rb
 - lib/pwa/version.rb
 - vendor/assets/javascripts/pwa.js
 homepage: https://github.com/jonhue/pwa
@@ -86,10 +102,14 @@ post_install_message: |
   **Thank you for installing Progressive Web Apps for Rails!**
 
 
-  There are two more steps to take:
+  There are three more steps to take:
 
   1) Run `rails g pwa:install` and `rails g pwa:install -n "Application Name"`
-  2) Mount engine in `config/routes.rb`:
+  2) Include the manifest component in your head tag:
+
+      <%= component 'pwa/manfest' %>
+
+  3) Mount engine in `config/routes.rb`:
 
       mount Pwa::Engine, at: ''
 

data/app/helpers/pwa_helper.rb

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