amp_helper 0.1.3 → 1.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa11cbafeee50553da50fbd031a4acc8140c4082
-  data.tar.gz: eedd79a377bd27f516637077fa19e1431e3bd316
+  metadata.gz: a1fd42d6d1ead9832928bf7f30ba7312e7369bc9
+  data.tar.gz: c2dc138af979eeb3a2c58ef33e41a45b075c59fb
 SHA512:
-  metadata.gz: 4f53a9fce0fc324ef1d59a483b53f8c05d7f21a34c1399930caf0f95bb9cd2e91ab3c1215ea1a96508ffd8dbef46925f99197f16e100c3ad7dcfa17f6a321a91
-  data.tar.gz: 74e6c8b5d088cead17342736d83a705afeb047afc77b03c485b72004d6d49270f6086b1a6036f78ff31b2d0fa0dad2f5e652a2287ab818f3e08530135e62adc2
+  metadata.gz: d0f31e5602cddba8532909293ca4d9567aef745e73a0cf9caf4b289f8ae717b325386001f2bd4725b3acd636d562d72266b34e19c6a94a47026036ffc3ba3112
+  data.tar.gz: 7fce0a40a5d7a9ace07c7dfc5e66acd4f636fb07fc3a7a0fa322be2837527f7bc50af1b80fc7fef86cca7b5fd124edabcffec935d3bbd05930c2e2930f41c0a3

data/README.md

@@ -8,7 +8,7 @@ To know AmpHelper ability, just look Usage section.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'amp_helper'
+gem 'amp_helper', '~> 1.0.0.pre'
 ```
 
 And then execute:
@@ -18,30 +18,33 @@ And then execute:
 
 ## Helpers usage
 
-### amp_image_tag(source, options = {})
+### image_tag(source, options = {})
+
+image_tag method creates a `<amp-img>` tag if it's passed `amp` option as true.  
+Learn more about [amp-img tag](https://ampbyexample.com/components/amp-img/)
 
 #### String Source
 
-      $ amp_image_tag('http://placehold.it/350x150', width: 20, height: 20)
+      $ image_tag('http://placehold.it/350x150', width: 20, height: 20, amp: true)
       #=> '<amp-img alt="350x150" height="20" src="http://placehold.it/350x150" width="20" /></amp-img>'
 
-      $ amp_image_tag('http://placehold.it/350x150', size: '20x20')
+      $ image_tag('http://placehold.it/350x150', size: '20x20', amp: true)
       #=> '<amp-img alt="350x150" height="20" src="http://placehold.it/350x150" width="20" /></amp-img>'
 
-      $ amp_image_tag('http://placehold.it/350x150')
+      $ image_tag('http://placehold.it/350x150', amp: true)
       #=> '<amp-img alt="350x150" height="150" src="http://placehold.it/350x150" width="350" /></amp-img>'
 
 #### Carrierwave Source
 
-      $ amp_image_tag(ThumbUploader.new.square)
+      $ image_tag(ThumbUploader.new.square, amp: true)
       #=> '<amp-img alt="Square 350x150" height="20" src="http://placehold.it/square_350x150" width="20" /></amp-img>'
 
 #### Retina
 
-      $ amp_image_tag('http://placehold.it/350x150', srcset: 'http://placehold.it/700x300 2x', size: '20x20')
+      $ image_tag('http://placehold.it/350x150', srcset: 'http://placehold.it/700x300 2x', size: '20x20', amp: true)
       #=> '<amp-img alt="350x150" height="20" src="http://placehold.it/350x150" srcset="http://placehold.it/700x300 2x" width="20" /></amp-img>'
 
-      $ amp_image_tag(ThumbUploader.new.square, format_2x: '%s_2x')
+      $ image_tag(ThumbUploader.new.square, format_2x: '%s_2x', amp: true)
       #=> '<amp-img alt="Square 350x150" height="20" src="http://placehold.it/square_350x150" srcset="http://placehold.it/square_2x_350x150 2x" width="20" /></amp-img>'
 
 
@@ -60,6 +63,32 @@ And then execute:
       end
     end
 
+### link_to(name = nil, options = nil, html_options = nil, &block)
+
+link_to method creates a `<a>` tag links to AMP cache if it's passed `amp` option as true.  
+Learn more about [using AMP cache](https://ampbyexample.com/advanced/using_the_google_amp_cache/).
+
+#### If indexed AMP cache is found
+
+      $ link_to(@title, @path, amp: true)
+      #=> "<a data-vars-link-url=\"https://ampbyexample.com/components/amp-form/preview/\" href=\"https://ampbyexample-com.cdn.ampproject.org/c/s/ampbyexample.com/components/amp-form/preview/\">link title</a>"
+
+      $ link_to(@path, amp: true) { @title }
+      #=> "<a data-vars-link-url=\"https://ampbyexample.com/components/amp-form/preview/\" href=\"https://ampbyexample-com.cdn.ampproject.org/c/s/ampbyexample.com/components/amp-form/preview/\">link title</a>"
+
+
+#### If indexed AMP cache is **NOT** found
+
+      $ link_to(@title, @path, amp: true)
+      #=> "<a data-vars-link-url=\"https://ampbyexample.com/components/amp-form/preview/noamp\" href=\"https://ampbyexample.com/components/amp-form/preview/noamp\">link title</a>"
+
+## amp-analytics conbination
+
+As you can see, AmpHelper puts the `data-vars-link-url` option on `<a>` tags.
+It's gonna help to tracking count of link clicking.
+
+Learn more about [Variables as data attribute](https://github.com/ampproject/amphtml/blob/master/extensions/amp-analytics/analytics-vars.md#variables-as-data-attribute) for amp-analytics.
+
 ## Configure
 
 ### Configure ratina version name format For CarrierWave::Uploader
@@ -67,8 +96,17 @@ And then execute:
 config/initializers/amp_helper.rb
 
     AmpHelper.configure do |config|
+      # Enable amp image.
+      # Default: true
+      # config.enable_amp_image = true
+      #
       # Configure ratina version name format For CarrierWave::Uploader
+      # Default: nil
       # config.format_2x = '%s_2x'
+
+      # Enable amp cache link.
+      # Default: true
+      # config.enable_amp_link = Rails.env.production?
     end
 
 ## Development
@@ -83,4 +121,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/amp_helper/amp_image_tag_helper.rb

@@ -1,14 +1,22 @@
 module AmpImageTagHelper
+  def self.included(base)
+    base.module_eval do
+      alias_method :original_image_tag, :image_tag
+      alias_method :image_tag, :amp_image_tag
+    end
+  end
+
   def amp_image_tag(source, opts = {})
+    return original_image_tag(source, opts) unless opts.delete(:amp) && AmpHelper.configuration.enable_amp_image
     has_dimensions = (opts[:width] && opts[:height]) || opts[:size]
-    set_dimensions(source, opts) if !has_dimensions
+    set_dimensions(source, opts) unless has_dimensions
     set_scrset(source, opts)
-    image_tag_to_amp(image_tag(source, opts))
+    img_to_amp_img(original_image_tag(source, opts))
   end
 
   private
 
-  def image_tag_to_amp(img_tag)
+  def img_to_amp_img(img_tag)
     img_tag.gsub(/^<img/, '<amp-img').gsub(/>$/, '></amp-img>').html_safe
   end
 

data/lib/amp_helper/amp_link_to_helper.rb

@@ -0,0 +1,39 @@
+module AmpLinkToHelper
+  def self.included(base)
+    base.module_eval do
+      alias_method :original_link_to, :link_to
+      alias_method :link_to, :amp_link_to
+    end
+  end
+
+  def amp_link_to(name = nil, options = nil, html_options = nil, &block)
+    html_options, options, name = options, name, block if block_given?
+    html_options ||= {}
+    set_analytics_vars(options, html_options)
+    options = cdn_url(options) if html_options.delete(:amp) && AmpHelper.configuration.enable_amp_link
+    options, name, block = html_options, options, name if block_given?
+    original_link_to(name, options, html_options, &block)
+  end
+
+  private
+
+  # Pass url to amp-analytics as 'linkUrl' variable.
+  def set_analytics_vars(options, html_options)
+    html_options['data-vars-link-url'] = url_for(options)
+  end
+
+  # If AMP cache exists, return cdn url.
+  def cdn_url(options)
+    uri = URI(url_for(options))
+    identify = ''
+    identify += 's/' if request.scheme == 'https'
+    identify += "#{request.host}#{uri.path}#{uri.query}"
+    escaped_host = request.host.gsub('-', '--').gsub('.', '-')
+    cache_url = "https://#{escaped_host}.cdn.ampproject.org/c/#{identify}"
+    response_200?(cache_url) ? cache_url : uri.to_s
+  end
+
+  def response_200?(url)
+    Net::HTTP.get_response(URI(url)).code == '200'
+  end
+end

data/lib/amp_helper/configuration.rb

@@ -9,10 +9,12 @@ module AmpHelper
   end
 
   class Configuration
-    attr_accessor :format_2x
+    attr_accessor :enable_amp_image, :format_2x, :enable_amp_link
 
     def initialize
+      @enable_amp_image = true
       @format_2x = nil
+      @enable_amp_link = true
     end
   end
 end

data/lib/amp_helper/generator.rb

@@ -5,8 +5,17 @@ module AmpHelper
       initializer 'amp_helper.rb' do
         <<-FILE.strip_heredoc
           AmpHelper.configure do |config|
+            # Enable amp image.
+            # Default: true
+            # config.enable_amp_image = true
+
             # Configure ratina version name format For CarrierWave::Uploader
+            # Default: nil
             # config.format_2x = '%s_2x'
+
+            # Enable amp cache link.
+            # Default: true
+            # config.enable_amp_link = Rails.env.production?
           end
         FILE
       end

data/lib/amp_helper/railtie.rb

@@ -2,11 +2,13 @@ require 'carrierwave'
 require 'fastimage'
 require 'amp_helper/configuration'
 require 'amp_helper/amp_image_tag_helper'
+require 'amp_helper/amp_link_to_helper'
 
 module AmpHelper
   class Railtie < Rails::Railtie
-    initializer 'image_tag.helper' do |app|
+    initializer 'amp_helper' do |app|
       ActionView::Base.send :include, AmpImageTagHelper
+      ActionView::Base.send :include, AmpLinkToHelper
     end
 
     generators do

data/lib/amp_helper/version.rb

@@ -1,3 +1,3 @@
 module AmpHelper
-  VERSION = '0.1.3'
+  VERSION = '1.0.0.pre.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amp_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0.pre.1
 platform: ruby
 authors:
 - Awjecc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-24 00:00:00.000000000 Z
+date: 2017-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,7 @@ files:
 - bin/setup
 - lib/amp_helper.rb
 - lib/amp_helper/amp_image_tag_helper.rb
+- lib/amp_helper/amp_link_to_helper.rb
 - lib/amp_helper/configuration.rb
 - lib/amp_helper/generator.rb
 - lib/amp_helper/railtie.rb
@@ -147,9 +148,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2