amp-html 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3fe2287cdfe4c4e9affc65691e2cd219a08680b27e8aa437119ec78b011a44e
-  data.tar.gz: d3953a2516a7a75a89045629535644e35e150913d3344bae5dde63168b8556fb
+  metadata.gz: 545c3ea0572405fdb0d68675d7eeabc50ec1b7dcf39142f60781f7e6a7f18f04
+  data.tar.gz: 2674f97ab93a296c165c861f48edad638b5ad172ac2029ccaf77045faa7bd47e
 SHA512:
-  metadata.gz: 5036faefbf235d67e07aa407f6a0f27d38c7e5b86a9afe0cb5426ce3ccedc42c3bbe985ef88988d3572ef098107870f659c7dbd70679d7ba30d3087a309020d7
-  data.tar.gz: 62d92bf61441f2ebb85f3bc7428b4c4a55dbc91f6c90878b884531d6388702066b9961a5e4da0857c3d998c1fffa80fcd9b9fd59242ec2c449e3603711c51528
+  metadata.gz: 179936be1a66a8449d283f8e9ee5644a2d903e16d0dae2bd752e619d2bedfb3a73347d852688f3f88eb4de245c083a659d150c91e94773ba827e8af8f079c1ae
+  data.tar.gz: 8d86222cce4f0d7189dc0ca3dade379a3fee5ed73c9e19a4946d7ad02de1430ce396fd3747315ab94b1ee6e6c92946dcfe51cf4df1eb5f46ddfb51213c3ce12e

data/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 * nothing yet
 
+### 1.1.0 - 2018/01/17
+
+* features
+    * new controller methods (`amp=`, `amp_path`)
+
 ### 1.0.1 - 2018/01/14
 
 * enhancements

data/README.md

@@ -8,14 +8,14 @@ amp-html is a universal solution to integrate the [AMP Project](https://www.ampp
 
 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/jonhue/amp-html/wiki/Getting-started)
+[**Follow the Getting Started Guide**](https://github.com/jonhue/amp-html/wiki/Getting-started), [Demo](https://hello-amp.herokuapp.com)
 
 ---
 
 ## Navigation
 
 * [Information](#information)
-    * [Quick info (Latest release, Dependencies)](#quick-info)
+    * [Quick info](#quick-info)
     * [The amp-html wiki](#the-amp-html-wiki)
     * [Bug reports](#bug-reports)
     * [Example applications](#example-applications)
@@ -26,8 +26,15 @@ Use the powerful features of AMP to make your Rails app consistently fast, beaut
     * [Generators](#generators)
     * [Test and validate AMP](#test-and-validate-amp)
 * [Usage](#usage)
+    * [Views](#views)
+    * [Controllers](#controllers)
     * [SplitView](#splitview)
 * [Guides](#guides)
+    * [Getting started](#getting-started)
+    * [Utilizing features](#utilizing-features)
+        * [Essentials](#essentials)
+        * [Powerful features](#powerful-features)
+    * [Testing](#testing)
 * [Components](#components)
 * [Configuration](#configuration)
 * [To Do](#to-do)
@@ -40,7 +47,7 @@ Use the powerful features of AMP to make your Rails app consistently fast, beaut
 
 ### Quick info
 
-#### Latest release: 1.0.0
+#### Latest release: 1.0.1
 
 [**Changelog**](CHANGELOG.md), [Grab it from Rubygems](https://rubygems.org/gems/amp-html)
 
@@ -121,16 +128,77 @@ Lastly, make sure to remove Turbolinks from your apps asset pipeline (`app/asset
 
 ## Usage
 
+### Views
+
+You can check whether your document is using AMP or not by using the `amp?` method:
+
+```haml
+- if amp?
+    = component 'amp/mustache' do
+        -# ...
+```
+
+**Note:** This method is also available at controller level.
+
+When you are using [SplitView](#splitview) along with media/form/etc. elements, you don't have to use `amp?` to render the appropriate element. amp-html automatically overrides the default Rails helpers if your document is using AMP.
+
+### Controllers
+
+If you are using [SplitView](#splitview), you are able to override the default format (`html`/`amp`) by passing the `amp` parameter. However in a lot of cases you want to specify the format from within the path of the URL:
+
+```ruby
+class PostsController < ApplicationController
+
+    def index
+        amp_path # to use `'amp'` as path
+        amp_path 'custom-path' # to use `'custom-path'` as path
+    end
+
+end
+```
+
+You are also able to manually enable or disable AMP for a specific controller action:
+
+```ruby
+class PostsController < ApplicationController
+
+    def index
+        amp # to enable AMP
+        amp = false # to disable AMP
+    end
+
+end
+```
+
 ### SplitView
 
+SplitView allows you to serve `html` and `amp` versions of your views. To get started, enable and configure SplitView:
+
+```ruby
+AmpHtml.configure do |config|
+    config.split_view = true
+    config.split_view_default = 'amp'
+end
+```
+
+Now you can use amp-html's [view](#views) and [controller](#controllers) methods to determine whether a document uses `html` or `amp` as format.
+
 ---
 
 ## Guides
 
+Whether you are just getting started or you are looking to implement some of the powerful features of amp-html, the guides in the amp-html wiki are here to your rescue.
+
+https://github.com/jonhue/amp-html/wiki/Guides
+
 ---
 
 ## Components
 
+amp-html is component based. You can learn more about components and find the full reference in the amp-html wiki.
+
+https://github.com/jonhue/amp-html/wiki/Docs
+
 ---
 
 ## Configuration

data/app/helpers/amp_html/base_helper.rb

@@ -21,5 +21,13 @@ module AmpHtml
             return File.binread(File.join(Rails.application.assets_manifest.dir, asset))
         end
 
+        def amp= value = true
+            params[:amp] = value
+        end
+
+        def amp_path scope = 'amp'
+            params[:amp] = true if request.fullpath.include?("/#{scope}")
+        end
+
     end
 end

data/app/views/mozaic/amp/_components.html.erb

@@ -1,6 +1,6 @@
-<% if options[:components]&.include? :form %><script async custom-element="amp-form" src="https://cdn.ampproject.org/v0/amp-form-0.1.js"></script>
+<% if options[:components]&.include? :audio %><script async custom-element="amp-audio" src="https://cdn.ampproject.org/v0/amp-audio-0.1.js"></script>
+<% elsif options[:components]&.include? :font %><script async custom-element="amp-font" src="https://cdn.ampproject.org/v0/amp-font-0.1.js"></script>
+<% elsif options[:components]&.include? :form %><script async custom-element="amp-form" src="https://cdn.ampproject.org/v0/amp-form-0.1.js"></script>
 <% elsif options[:components]&.include? :mustache %><script async custom-template="amp-mustache" src="https://cdn.ampproject.org/v0/amp-mustache-0.1.js"></script>
 <% elsif options[:components]&.include? :selector %><script async custom-element="amp-selector" src="https://cdn.ampproject.org/v0/amp-selector-0.1.js"></script>
-<% elsif options[:components]&.include? :audio %><script async custom-element="amp-audio" src="https://cdn.ampproject.org/v0/amp-audio-0.1.js"></script>
-<% elsif options[:components]&.include? :video %><script async custom-element="amp-video" src="https://cdn.ampproject.org/v0/amp-video-0.1.js"></script>
-<% elsif options[:components]&.include? :font %><script async custom-element="amp-font" src="https://cdn.ampproject.org/v0/amp-font-0.1.js"></script><% end %>
+<% elsif options[:components]&.include? :video %><script async custom-element="amp-video" src="https://cdn.ampproject.org/v0/amp-video-0.1.js"></script><% end %>

data/app/views/mozaic/amp/_font.html.erb

@@ -1,2 +1 @@
-<%= content_tag 'amp-font', options do %>
-<% end %>
+<%= content_tag 'amp-font', options %>

data/app/views/mozaic/amp/_img.html.erb

@@ -1 +1 @@
-<%= tag 'amp-img', options %>
+<%= content_tag 'amp-img', options %>

data/lib/amp-html/railtie.rb

@@ -12,16 +12,20 @@ module AmpHtml
                 config.define_component 'amp/doctype'
                 config.define_component 'amp/amp-link', rel: 'amphtml' do |options|
                     return false unless AmpHtml.configuration.split_view
-                    options[:href] = options[:href].split('?').first
+                    href = options[:href].split('?').first
                     unless AmpHtml.configuration.split_view_default == 'amp'
-                        options[:href] = "#{options[:href]}?#{{ amp: true }.to_query}"
+                        options[:href] ||= "#{href}?#{{ amp: true }.to_query}"
+                    else
+                        options[:href] ||= href
                     end
                 end
                 config.define_component 'amp/canonical-link', rel: 'canonical' do |options|
                     return false unless AmpHtml.configuration.split_view
-                    options[:href] = options[:href].split('?').first
+                    href = options[:href].split('?').first
                     if AmpHtml.configuration.split_view_default == 'amp'
-                        options[:href] = "#{options[:href]}?#{{ amp: false }.to_query}"
+                        options[:href] ||= "#{href}?#{{ amp: false }.to_query}"
+                    else
+                        options[:href] ||= href
                     end
                 end
                 config.define_component 'amp/head'

data/lib/amp-html/version.rb

@@ -1,5 +1,5 @@
 module AmpHtml
 
-    VERSION = '1.0.1'
+    VERSION = '1.1.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amp-html
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-14 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties