amp-html 0.7.18 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a8818a848ca98c5f753b7f2f7e4c06d750448caa
-  data.tar.gz: 1c7176ac929d34dbb171cfd69c5b0c03efea617f
+SHA256:
+  metadata.gz: c3d04137dc58a45e0d839c7c8ebda233933742d811eb24f77d28b55540d0ceeb
+  data.tar.gz: b6af3f3e9eb81ad71bdfda150c3192221af46a8fd63b7f74f94926a35341e959
 SHA512:
-  metadata.gz: 41718012a2c3cbc5c783d8e4c47dec2b6fa97b2fa91ddce51f76c3b692858a3e9922983176e26fc5c8cc214b6ca8fcdbb5b406b85c263007b3e4d4858ac0f324
-  data.tar.gz: f29a7640f729eb9c998bc4a503356954bc2fc2c84bb4c672bbc3ee471d24dfbbc75e52fdfd828a773ac79500a4c4c69a7a116fd86b493bc8e31976f61affcdfd
+  metadata.gz: f0e7527572c0322273f426a213f50d3bf7a1fbea30a409645dffc39fd5c680439457427e8a4a6706a24a5a48cd673c52931b88a62c5cde59c3d8abf7774de5e9
+  data.tar.gz: 9746b409662ecdef3b4c291d2b335164ce63ddc3da609cb09d79884b2c9c8a67181431f25ab4e2b8bb4be4a9f5a56188af2b6706edea99e5650eebfa5139f638

data/CHANGELOG.md

@@ -4,90 +4,95 @@
 
 * nothing yet
 
-### 0.7.18 (Pre-release) - 2017-08-24
+### 1.0.0 - 2018/01/14
 
-* minor bugfixes
+* features
+    * use Mozaic for components and SplitView layouts
+
+### 0.7.18 (Pre-release) - 2017/08/24
+
+* bugfixes
 
-### 0.7.17 (Pre-release) - 2017-08-24
+### 0.7.17 (Pre-release) - 2017/08/24
 
-* minor bugfixes
+* bugfixes
 
-### 0.7.16 (Pre-release) - 2017-08-24
+### 0.7.16 (Pre-release) - 2017/08/24
 
-* minor bugfixes
+* bugfixes
 
-### 0.7.15 (Pre-release) - 2017-08-24
+### 0.7.15 (Pre-release) - 2017/08/24
 
-* minor bugfixes
+* bugfixes
 
-### 0.7.14 (Pre-release) - 2017-08-24
+### 0.7.14 (Pre-release) - 2017/08/24
 
-* minor bugfixes
+* bugfixes
 
-### 0.7.13 (Pre-release) - 2017-08-24
+### 0.7.13 (Pre-release) - 2017/08/24
 
-* minor bugfixes
+* bugfixes
 
-### 0.7.12 (Pre-release) - 2017-08-24
+### 0.7.12 (Pre-release) - 2017/08/24
 
-* minor bugfixes
+* bugfixes
 
-### 0.7.11 (Pre-release) - 2017-08-24
+### 0.7.11 (Pre-release) - 2017/08/24
 
-* minor bugfixes
+* bugfixes
 
-### 0.7.10 (Pre-release) - 2017-08-24
+### 0.7.10 (Pre-release) - 2017/08/24
 
-* minor bugfixes
+* bugfixes
 
-### 0.7.9 (Pre-release) - 2017-08-24
+### 0.7.9 (Pre-release) - 2017/08/24
 
-* minor bugfixes
+* bugfixes
 
-### 0.7.8 (Pre-release) - 2017-08-24
+### 0.7.8 (Pre-release) - 2017/08/24
 
-* minor bugfixes
+* bugfixes
 
-### 0.7.7 (Pre-release) - 2017-08-24
+### 0.7.7 (Pre-release) - 2017/08/24
 
 * notes
     * gem renamed from `amphtml` to `amp-html`
 
-### 0.7.6 (Pre-release) - 2017-04-11
+### 0.7.6 (Pre-release) - 2017/04/11
 
 * enhancements
     * improve gemspec
 
-### 0.7.5 (Pre-release) - 2017-03-23
+### 0.7.5 (Pre-release) - 2017/03/23
 
-* bug fixes
+* bugfixes
     * fix assets pipeline
     * fix assets helpers
 
-### 0.7.4 (Pre-release) - 2017-03-22
+### 0.7.4 (Pre-release) - 2017/03/22
 
-* bug fixes
+* bugfixes
     * fix component bundler
 
-### 0.7.3 (Pre-release) - 2017-03-22
+### 0.7.3 (Pre-release) - 2017/03/22
 
 * features
     * introduce lists component
     * introduce Mustache.js component
 
-### 0.7.2 (Pre-release) - 2017-03-22
+### 0.7.2 (Pre-release) - 2017/03/22
 
 * features
     * introduce service worker component
 
-### 0.7.1 (Pre-release) - 2017-03-21
+### 0.7.1 (Pre-release) - 2017/03/21
 
 * enhancements
     * add DeepIntegration to forms component
-* bug fixes
+* bugfixes
     * fix syntax error
 
-### 0.7.0 (Pre-release) - 2017-03-21
+### 0.7.0 (Pre-release) - 2017/03/21
 
 * features
     * introduce build-in forms component
@@ -95,7 +100,7 @@
     * add `amp_css_link` helper
     * add a bunch of new helpers to social component
 
-### 0.6.3 (Pre-release) - 2017-03-21
+### 0.6.3 (Pre-release) - 2017/03/21
 
 * removals
     * `amp_document_link` helper only available with SplitView
@@ -103,7 +108,7 @@
     * configuration: warn if no config file available
     * enhance tests
 
-### 0.6.2 (Pre-release) - 2017-03-20
+### 0.6.2 (Pre-release) - 2017/03/20
 
 * removals
     * deprecate `amp_resources` helper - will be removed in 1.0
@@ -122,10 +127,10 @@
     * update component docs
     * update helper docs
     * change default app name
-* bug fixes
+* bugfixes
     * fix tests
 
-### 0.6.1 (Pre-release) - 2017-03-19
+### 0.6.1 (Pre-release) - 2017/03/19
 
 * removals
     * deprecate `amp_global_css` helper - will be removed in 2.0
@@ -136,21 +141,21 @@
     * improve AMP helpers
     * update component docs
     * update helper docs
-* bug fixes
+* bugfixes
     * fix `noscript_tag` helper
 
-### 0.6.0 (Pre-release) - 2017-03-19
+### 0.6.0 (Pre-release) - 2017/03/19
 
 * features
     * introduce javascript component
 * enhancements
     * add javascript component docs
     * add configuration docs
-* bug fixes
+* bugfixes
     * fix `config/initializers/amphtml.rb`
     * fix helpers
 
-### 0.5.4 (Pre-release) - 2017-03-19
+### 0.5.4 (Pre-release) - 2017/03/19
 
 * features
     * add `amp_auto_ads` helper
@@ -158,45 +163,45 @@
     * `validate`: start server if not already running
     * add analytics component docs
     * add validate docs
-* bug fixes
+* bugfixes
     * fix configuration
     * fix `schema_tag` helper
     * fix `amp_tag` helpers
     * fix `BundleGenerator`
     * fix view templates
 
-### 0.5.3 (Pre-release) - 2017-03-18
+### 0.5.3 (Pre-release) - 2017/03/18
 
 * enhancements
     * add component docs
     * improve add templates
     * improve `config/amphtml.yml` template
-* bug fixes
+* bugfixes
     * fix test class
     * fix test help
     * fix validate help
 
-### 0.5.2 (Pre-release) - 2017-03-18
+### 0.5.2 (Pre-release) - 2017/03/18
 
 * features
     * add `amp_font_link` helper
 * enhancements
     * improve html test
-* bug fixes
+* bugfixes
     * fix `config/mime_types.rb` template
     * fix helper templates
     * fix `BundleGenerator`
 
-### 0.5.1 (Pre-release) - 2017-03-18
+### 0.5.1 (Pre-release) - 2017/03/18
 
 * enhancements
     * improve `config/amphtml.yml` template
-* bug fixes
+* bugfixes
     * fix `-amp-` in CSS test
     * fix `HelpersGenerator`
     * fix `ViewsGenerator`
 
-### 0.5.0 (Pre-release) - 2017-03-18
+### 0.5.0 (Pre-release) - 2017/03/18
 
 * features
     * add `amp_embed` helper
@@ -209,33 +214,33 @@
 * enhancements
     * improve `config/amphtml.yml` template
     * improve `app/views/layouts/application.html.erb` template
-* bug fixes
+* bugfixes
     * fix AMP issue in `amp_head` helper
 
-### 0.4.5 (Pre-release) - 2017-03-17
+### 0.4.5 (Pre-release) - 2017/03/17
 
 * removals
     * `meta_tag` renamed to `amp_head`
-* bug fixes
+* bugfixes
     * fix `ViewsGenerator`
     * fix `config/amphtml.yml` template
 
-### 0.4.4 (Pre-release) - 2017-03-17
+### 0.4.4 (Pre-release) - 2017/03/17
 
 * features
     * add `schema_tag` helper
     * add `meta_tag` helper
 * enhancements
     * dynamically assign format for generators
-* bug fixes
+* bugfixes
     * [#21](https://github.com/jonhue/amphtml/issues/21) - File open issues
 
-### 0.4.3 (Pre-release) - 2017-03-17
+### 0.4.3 (Pre-release) - 2017/03/17
 
-* bug fixes
+* bugfixes
     * fix `--format` option in generators
 
-### 0.4.2 (Pre-release) - 2017-03-17
+### 0.4.2 (Pre-release) - 2017/03/17
 
 * features
     * add analytics component DeepIntegration
@@ -243,33 +248,33 @@
     * add social component DeepIntegration
 * enhancements
     * improve generators
-* bug fixes
+* bugfixes
     * fix `amphtml bundle`
     * fix `BundleGenerator`
 
-### 0.4.1 (Pre-release) - 2017-03-16
+### 0.4.1 (Pre-release) - 2017/03/16
 
 * features
     * add `ComponentsGenerator`
 * enhancements
     * improve `CLI`
     * add docs for components and helpers
-* bug fixes
+* bugfixes
     * fix `amphtml validate`
 
-### 0.4.0 (Pre-release) - 2017-03-16
+### 0.4.0 (Pre-release) - 2017/03/16
 
 * features
     * add command line executables
-* bug fixes
+* bugfixes
     * fix generators
 
-### 0.3.1 (Pre-release) - 2017-03-16
+### 0.3.1 (Pre-release) - 2017/03/16
 
-* bug fixes
+* bugfixes
     * fix Rails dependency
 
-### 0.3.0 (Pre-release) - 2017-03-15
+### 0.3.0 (Pre-release) - 2017/03/15
 
 * features
     * add SplitView
@@ -282,12 +287,12 @@
     * improve `Amphtml::Test` class
     * drop Rails dependency to 4.0
 
-### 0.2.1 (Pre-release) - 2017-03-14
+### 0.2.1 (Pre-release) - 2017/03/14
 
-* bug fixes
+* bugfixes
     * fix `Amphtml::Test` class
 
-### 0.2.0 (Pre-release) - 2017-03-14
+### 0.2.0 (Pre-release) - 2017/03/14
 
 * removals
     * AMP related tag helpers changed from `name_tag` to `amp_name`
@@ -306,10 +311,10 @@
     * improve `HelpersGenerator`
     * re-structure `application.html.erb`
     * put amp-stuff into `_amp.html`
-* bug fixes
+* bugfixes
     * improve `TagHelper`'s
 
-### 0.1.5 (Pre-release) - 2017-03-13
+### 0.1.5 (Pre-release) - 2017/03/13
 
 * features
     * introduce `--split` option for `InstallGenerator`
@@ -320,27 +325,27 @@
     * custom installation message
     * add `Amphtml.validate` method fallback
     * improve file reading
-* bug fixes
+* bugfixes
     * Improve `AssetTagHelper`'s
 
-### 0.1.4 (Pre-release) - 2017-03-13
+### 0.1.4 (Pre-release) - 2017/03/13
 
 * features
     * introduce `--split` option for `ViewsGenerator`
     * add `validate` method to `Amphtml`
 
-### 0.1.3 (Pre-release) - 2017-03-12
+### 0.1.3 (Pre-release) - 2017/03/12
 
-* bug fixes
+* bugfixes
     * [#1](https://github.com/jonhue/amphtml/issues/1) - `Couldn't find AssetTagHelper, expected it to be defined in helpers/asset_tag_helper.rb`
     * [#2](https://github.com/jonhue/amphtml/issues/2) - `initializers/amphtml.rb - NameError`
 
-### 0.1.2 (Pre-release) - 2017-03-12
+### 0.1.2 (Pre-release) - 2017/03/12
 
-* bug fixes
+* bugfixes
     * `Amphtml is not a module`
     * not all files included
 
-### 0.1.0 (Pre-release) - 2017-03-12
+### 0.1.0 (Pre-release) - 2017/03/12
 
 Initial release

data/README.md

@@ -1,12 +1,14 @@
-# [BETA] AMP-HTML - Reliable high-:zap: apps with AMP & Rails
+# amp-html
 
-<img src="https://travis-ci.org/slooob/amp-html.svg?branch=master" /> [![Gem Version](https://badge.fury.io/rb/amp-html.svg)](https://badge.fury.io/rb/amp-html)
+[![Gem Version](https://badge.fury.io/rb/amp-html.svg)](https://badge.fury.io/rb/amp-html) <img src="https://travis-ci.org/jonhue/amp-html.svg?branch=master" />
 
-AmpHtml is a universal solution to integrate the AMP Project (Accelerated Mobile Pages Project) into your Rails app with ease. It enables you to quickly spin-up, build and test your app with AMP, while fulfilling the app's unique requirements. It comes with a bunch of superpowers like user authentication, notifications, blogs, animations and support for assets in AMP.
+Reliable high-:zap: apps with AMP & Rails.
+
+amp-html is a universal solution to integrate the [AMP Project](https://www.ampproject.org/) into your Rails app with ease. It enables you to quickly spin-up, build and test your app with AMP, while fulfilling the app's unique requirements. It comes with a bunch of superpowers like user authentication, notifications, blogs, animations and support for assets in AMP.
 
 Use the powerful features of AMP to make your Rails app consistently fast, beautiful and high-performing across devices and distribution platforms.
 
-[**Follow the Getting Started Guide**](https://github.com/slooob/amp-html/wiki/Getting-started)
+[**Follow the Getting Started Guide**](https://github.com/jonhue/amp-html/wiki/Getting-started)
 
 ---
 
@@ -14,23 +16,22 @@ Use the powerful features of AMP to make your Rails app consistently fast, beaut
 
 * [Information](#information)
     * [Quick info (Latest release, Dependencies)](#quick-info)
-    * [The AMP-HTML wiki](#the-amp-html-wiki)
+    * [The amp-html wiki](#the-amp-html-wiki)
     * [Bug reports](#bug-reports)
     * [Example applications](#example-applications)
     * [Contributing](#contributing)
     * [Versioning](#versioning)
-* [Concept](#concept)
-* [Features](#features)
+    * [Deprecations](#deprecations)
 * [Installation](#installation)
     * [Generators](#generators)
     * [Test and validate AMP](#test-and-validate-amp)
 * [Usage](#usage)
-    * [Helpers](#helpers)
     * [SplitView](#splitview)
 * [Guides](#guides)
 * [Components](#components)
+* [Configuration](#configuration)
+* [To Do](#to-do)
 * [Contributors](#contributors)
-* [References](#references)
 * [License](#license)
 
 ---
@@ -39,54 +40,52 @@ Use the powerful features of AMP to make your Rails app consistently fast, beaut
 
 ### Quick info
 
-#### Latest release: 0.7.18 (Pre-release)
+#### Latest release: 1.0.0
 
-[**Changelog**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md), [Grab it from Rubygems](https://rubygems.org/gems/amp-html)
+[**Changelog**](CHANGELOG.md), [Grab it from Rubygems](https://rubygems.org/gems/amp-html)
 
 #### Supported versions
 
-    Rails >= 4.0.0
-    Ruby >= 2.0
+    Rails >= 5.0
+    Ruby >= 2.3
 
-### The AMP-HTML wiki & documentation
+### The amp-html wiki & documentation
 
-The AMP-HTML Wiki has lots of additional information about AMP-HTML including many "how-to" articles and answers to the most frequently asked questions. Please browse the Wiki after finishing this README:
+The amp-html Wiki has lots of additional information about amp-html including many "how-to" articles and answers to the most frequently asked questions. Please browse the Wiki after finishing this README:
 
-[https://github.com/slooob/amp-html/wiki](https://github.com/slooob/amp-html/wiki)
+https://github.com/jonhue/amp-html/wiki
 
 ### Bug reports
 
-If you discover a problem with AMP-HTML, we would like to know about it. However, we ask that you please review these guidelines before submitting a bug report:
-
-[https://github.com/slooob/amp-html/wiki/Bug-reports](https://github.com/slooob/amp-html/wiki/Bug-reports)
+If you discover a problem with amp-html, we would like to know about it. However, we ask that you please review these guidelines before submitting a bug report:
 
-If you have discovered a security related bug, please do *NOT* use the GitHub issue tracker. Send an email to [developer@slooob.com](mailto:developer@slooob.com).
+https://github.com/jonhue/amp-html/wiki/Bug-reports
 
 ### Example applications
 
-There are a few example applications available on GitHub that demonstrate various features of AMP-HTML. You can view them here:
+There are a few example applications available on GitHub that demonstrate various features of amp-html. You can view them here:
 
-[https://github.com/slooob/amp-html/wiki/Example-Applications](https://github.com/slooob/amp-html/wiki/Example-Applications)
+https://github.com/jonhue/amp-html/wiki/Example-Applications
 
 ### Contributing
 
-We hope that you will consider contributing to AMP-HTML. Please read this short overview for some information about how to get started:
+We hope that you will consider contributing to amp-html. Please read this short overview for some information about how to get started:
 
-[Contributing](https://github.com/slooob/amp-html/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/slooob/amp-html/blob/master/CODE_OF_CONDUCT.md)
+[Contributing](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
 
 ### Versioning
 
-AmpHtml follows Semantic Versioning 2.0 as defined at http://semver.org.
+amp-html follows Semantic Versioning 2.0 as defined at http://semver.org.
 
-## Concept
+### Deprecations
 
-## Features
+Deprecations are combined with new major releases of amp-html. You can see a full list of past and future deprecations [here](DEPRECATIONS.md).
 
 ## Installation
 
-You can also follow the [**Getting Started Guide**](https://github.com/slooob/amp-html/wiki/Getting-started).
+You can also follow the [**Getting Started Guide**](https://github.com/jonhue/amp-html/wiki/Getting-started).
 
-AMP-HTML works with Rails 4.0 onwards. You can add it to your `Gemfile` with:
+amp-html works with Rails 5 onwards. You can add it to your `Gemfile` with:
 
 ```ruby
 gem 'amp-html'
@@ -103,79 +102,66 @@ Or install it yourself as:
 If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
 
 ```ruby
-gem 'amp-html', github: 'https://github.com/slooob/amp-html.git'
+gem 'amp-html', github: 'jonhue/amp-html'
 ```
 
-### Generators
-
-AmpHtml comes with three different generators. If you want to bundle them execute:
-
-    $ rails g amp_html:bundle
-
-That will generate all the files you need to create a universal AMP app (recommended).
-
-If you want to use [SplitView](https://github.com/slooob/amp-html/wiki/Docs:-SplitView) to create views with and without AMP simultaneously, execute instead:
-
-    $ rails g amp_html:bundle --split
+Now generate the files necessary:
 
-To add components ([List of components](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/README.md)) to the generator simply include the component as an option:
+    $ rails g mozaic:install
+    $ rails g amp_html
 
-    $ rails g amp_html:bundle --analytics --notifications
+Replace the contents of your `app/views/layouts/application.html.erb` file with:
 
-You can also run the three generators independently:
-
-    $ rails g amp_html:install
-    $ rails g amp_html:helpers
-    $ rails g amp_html:views
-
-*Each* of them supports the `--split || -s` option to use **both** regular views and AMP views.
-To add components, you need to pass them as option to each generator.
+```haml
+= amp_mozaic do
+    = yield
+```
 
-### Test and validate AMP
+Lastly, make sure to remove Turbolinks from your apps asset pipeline (`app/assets/javascripts/application.js`) as it does not work well with AMP.
 
-AmpHtml allows you to test and validate your views out of the box:
+## Usage
 
-    $ amp-html test all
+### SplitView
 
-Pass `--split` as an option if you are using SplitView:
+---
 
-    $ amp-html test all --split
+## Guides
 
-`test all` runs multiple tests to check if your code is valid. You can also run each test specifically.
+---
 
-To get a list of all tests and learn how to run them, go to [how to test and validate](https://github.com/slooob/amp-html/wiki/Guides:-Test-and-validate)
+## Components
 
-To all tests (even `test all`) you can pass the option `--fix || -f` and AmpHtml will suggest changes you could make. You can accept or reject them.
-If you want to automatically fix the code, pass `--autofix || -af` as option. Be careful, you will not be asked to approve changes to the documents!
+---
 
-AMP has a validator built in. To validate:
+## Configuration
 
-    $ amp-html validate root # validates "http://localhost:3000"
-    $ amp-html validate https://slooob.com # validates "https://slooob.com"
+You can configure amp-html by passing a block to `configure`. This can be done in `config/initializers/amp-html.rb`:
 
-**Note:** `root` is only available as a parameter in development environment..
+```ruby
+AmpHtml.configure do |config|
+    config.inherit_stylesheets = false
+end
+```
 
-## Usage
+* `inherit_stylesheets` Use your regular stylesheets bundled with `app/assets/stylesheets/application.css` in your AMP views. Takes a boolean. Defaults to `false`.
+* `split_view` Enable SplitView to allow for AMP enabled and AMP disabled versions of your views. Takes a boolean. Defaults to `false`.
+* `split_view_default` The default view version if no `amp` param is present in the request. Must be either `'amp'` or `'html'`. Defaults to `'amp'`.
 
-### Helpers
+---
 
-### SplitView
+## To Do
 
-## Guides
+[Here](https://github.com/jonhue/amp-html/projects/1) is the full list of current projects.
 
-## Components
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/amp-html/issues/new).
 
 ---
 
 ## Contributors
 
-Give the people some :heart: who are working on this project. Check them all at:
-
-[https://github.com/slooob/amp-html/graphs/contributors](https://github.com/slooob/amp-html/graphs/contributors)
-
-## References
+Give the people some :heart: who are working on this project. See them all at:
 
-[Accelerated Mobile Pages](https://www.ampproject.org/)
+https://github.com/jonhue/amp-html/graphs/contributors
 
 ## License