rails_amp 0.1.4

data/lib/rails_amp/overrider.rb

@@ -0,0 +1,44 @@
+module RailsAmp
+  module Overrider
+    extend ActiveSupport::Concern
+
+    included do
+      before_action do
+        RailsAmp.format = request[:format]
+        if RailsAmp.amp_renderable?(controller_name, action_name)  # default_format is :amp
+          override_actions_with_rails_amp
+        end
+      end
+    end
+
+    private
+
+      def override_actions_with_rails_amp
+        klass = self.class  # klass is controller class
+        return if klass.ancestors.include?(RailsAmp::ActionOverrider)
+        actions = RailsAmp.target_actions(klass)
+
+        klass.class_eval do
+          # override amp target actions
+          RailsAmp::ActionOverrider.module_eval do
+            actions.to_a.each do |action|
+              define_method action.to_sym do
+                super()
+                respond_to do |format|
+                  format.send(RailsAmp.default_format.to_sym) do
+                    # search amp format(default is .amp) .html templates
+                    lookup_context.formats = [RailsAmp.default_format] + RailsAmp.lookup_formats
+                    render layout: 'rails_amp_application.amp'
+                  end
+                end
+              end
+            end
+          end
+          prepend RailsAmp::ActionOverrider
+        end
+      end
+  end
+
+  module ActionOverrider
+  end
+end

data/lib/rails_amp/railtie.rb

@@ -0,0 +1,17 @@
+require 'rails_amp/overrider'
+
+module RailsAmp
+  class Railtie < Rails::Railtie
+    initializer 'rails_amp' do |app|
+      ActiveSupport.on_load :action_controller do
+        include RailsAmp::Overrider
+      end
+
+      ActiveSupport.on_load :action_view do
+        require 'rails_amp/view_helpers/action_view'
+      end
+
+      require 'rails_amp/view_helpers/image_tag_helper'
+    end
+  end
+end

data/lib/rails_amp/version.rb

@@ -0,0 +1,3 @@
+module RailsAmp
+  VERSION = '0.1.4'
+end

data/lib/rails_amp/view_helpers/action_view.rb

@@ -0,0 +1,68 @@
+module RailsAmp
+  module ViewHelpers
+    module ActionView
+
+      # To add header code in default layout like application.html.erb.
+      def rails_amp_amphtml_link_tag
+        return '' unless RailsAmp.target?(controller.controller_name, controller.action_name)
+
+        amp_uri = URI.parse(request.url)
+        if request.path == root_path
+          amp_path = "#{controller.controller_name}/#{controller.action_name}.#{RailsAmp.default_format}"
+        else
+          amp_path = ".#{RailsAmp.default_format}"
+        end
+        amp_uri.path = amp_uri.path + amp_path
+        amp_uri.query = ERB::Util.h(amp_uri.query) if amp_uri.query.present?
+
+        %Q(<link rel="amphtml" href="#{amp_uri.to_s}" />).html_safe
+      end
+
+      def rails_amp_html_header
+        header =<<"EOS"
+<!-- Snipet for amp library. -->
+    <style amp-boilerplate>body{-webkit-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-moz-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-ms-animation:-amp-start 8s steps(1,end) 0s 1 normal both;animation:-amp-start 8s steps(1,end) 0s 1 normal both}@-webkit-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-moz-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-ms-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-o-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}</style><noscript><style amp-boilerplate>body{-webkit-animation:none;-moz-animation:none;-ms-animation:none;animation:none}</style></noscript>
+    <script async src="https://cdn.ampproject.org/v0.js"></script>
+EOS
+        header.html_safe
+      end
+
+      def rails_amp_google_analytics_page_tracking
+        if RailsAmp.analytics.present?
+          analytics_code =<<"EOS"
+<!-- Google Analytics Page Tracking for amp pages. -->
+    <script async custom-element="amp-analytics" src="https://cdn.ampproject.org/v0/amp-analytics-0.1.js"></script>
+    <amp-analytics type="googleanalytics" id="rails_amp_analytics">
+    <script type="application/json">
+    {
+      "vars": {
+        "account": "#{RailsAmp.analytics}"
+      },
+      "triggers": {
+        "trackPageview": {
+          "on": "visible",
+          "request": "pageview"
+        }
+      }
+    }
+    </script>
+    </amp-analytics>
+EOS
+          return analytics_code.html_safe
+        end
+
+        ''
+      end
+
+      def rails_amp_canonical_url
+        request.url.gsub(".#{RailsAmp.default_format.to_s}", '')
+      end
+
+      def amp_renderable?
+        RailsAmp.amp_renderable?(controller.controller_name, controller.action_name)
+      end
+
+      ::ActionView::Base.send :include, self
+    end
+  end
+end

data/lib/rails_amp/view_helpers/image_tag_helper.rb

@@ -0,0 +1,57 @@
+require 'fastimage'
+
+module RailsAmp
+  module ViewHelpers
+    module ImageTagHelper
+      # ref: https://www.ampproject.org/docs/reference/components/amp-img
+      AMP_IMG_PERMITTED_ATTRIBUTES = %w(
+        src srcset alt attribution height width fallback heights layout media noloading on placeholder sizes
+      )
+
+      # ref: https://github.com/rails/rails/blob/master/actionview/lib/action_view/helpers/asset_tag_helper.rb#L228
+      def amp_image_tag(source, options={})
+        options = options.symbolize_keys
+        check_for_image_tag_errors(options) if defined?(check_for_image_tag_errors)
+
+        src = options[:src] = path_to_image(source, skip_pipeline: options.delete(:skip_pipeline))
+
+        unless src.start_with?("cid:") || src.start_with?("data:") || src.blank?
+          options[:alt] = options.fetch(:alt){ image_alt(src) }
+        end
+
+        options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+
+        if options[:width].blank? || options[:height].blank?
+          options[:width], options[:height] = compute_image_size(source)
+        end
+
+        options[:layout] ||= 'fixed'
+        options.select! { |key, _| key.to_s.in?(AMP_IMG_PERMITTED_ATTRIBUTES) }
+        tag('amp-img', options) + '</amp-img>'.html_safe
+      end
+
+      # override image_tag helper in ActionView::Helpers::AssetTagHelper
+      def image_tag(source, options={})
+        if controller && RailsAmp.amp_renderable?(controller.controller_name, controller.action_name)
+          amp_image_tag(source, options)
+        else
+          super
+        end
+      end
+
+      private
+
+        def compute_image_size(source)
+          source_for_fastimage = source
+          unless source =~ ::ActionView::Helpers::AssetUrlHelper::URI_REGEXP
+            # find_asset is a Sprockets method
+            source_for_fastimage = Rails.application.assets.find_asset(source).try(:pathname).to_s.presence ||
+                                      File.join(Rails.public_path, source)
+          end
+          FastImage.size(source_for_fastimage) || [300, 300]
+        end
+
+      ::ActionView::Base.send :prepend, self
+    end
+  end
+end

data/lib/rails_amp.rb

@@ -0,0 +1,95 @@
+require 'rails_amp/version'
+
+if defined?(Rails::Railtie)
+  require 'rails_amp/railtie'
+else
+  raise 'rails_amp is not compatible with Rails 2.* or older'
+end
+
+module RailsAmp
+  autoload :Config, 'rails_amp/config'
+
+  extend(Module.new {
+    # Get RailsAmp configuration object.
+    def config
+      Thread.current[:rails_amp_config] ||= RailsAmp::Config.new
+    end
+
+    # Set RailsAmp configuration object.
+    def config=(value)
+      Thread.current[:rails_amp_config] = value
+    end
+
+    # Write methods which delegates to the configuration object.
+    %w( format config_file load_config default_format targets analytics lookup_formats ).each do |method|
+      module_eval <<-DELEGATORS, __FILE__, __LINE__ + 1
+        def #{method}
+          config.#{method}
+        end
+
+        def #{method}=(value)
+          config.#{method} = (value)
+        end
+      DELEGATORS
+    end
+
+    def reload_config!
+      config.load_config = config.send(:config_load_config)
+      config.default_format = config.send(:config_default_format)
+      config.targets = config.send(:config_targets)
+      config.analytics = config.send(:config_analytics)
+      config.lookup_formats = config.send(:config_lookup_formats)
+      nil
+    end
+
+    def disable_all?
+      targets.blank?
+    end
+
+    def enable_all?
+      targets['application'] == 'all'
+    end
+
+    def controller_all?(key)
+      targets.has_key?(key) && targets[key].blank?
+    end
+
+    def controller_actions?(key)
+      targets.has_key?(key) && targets[key].present?
+    end
+
+    def target_actions(controller)
+      extract_target_actions(controller) - %w(new create edit update destroy)
+    end
+
+    def extract_target_actions(controller)
+      return []                             if disable_all?
+      return controller.action_methods.to_a if enable_all?
+      key = controller_to_key(controller)
+      return controller.action_methods.to_a if controller_all?(key)
+      return targets[key]                   if controller_actions?(key)
+      []
+    end
+
+    def controller_to_key(controller)
+      controller.name.underscore.sub(/_controller\z/, '')
+    end
+
+    def key_to_controller(key)
+      (key.camelcase + 'Controller').constantize
+    end
+
+    def target?(controller_name, action_name)
+      target_actions = target_actions( key_to_controller(controller_name) )
+      action_name.in?(target_actions)
+    end
+
+    def amp_format?
+      format == default_format.to_s
+    end
+
+    def amp_renderable?(controller_name, action_name)
+      amp_format? && target?(controller_name, action_name)
+    end
+  })
+end

data/rails_amp.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'rails_amp/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rails_amp'
+  s.version     = RailsAmp::VERSION
+  s.authors     = ['Takafumi Yamano']
+  s.email       = ['takafumiyamano@gmail.com']
+  s.homepage    = 'https://github.com/takafumir/rails_amp'
+  s.summary     = 'AMP(Accelerated Mobile Pages) plugin for Ruby on Rails.'
+  s.description = 'RailsAmp is a Ruby on Rails plugin that makes it easy to build views for AMP(Accelerated Mobile Pages).'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files`.split("\n").grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'rails', '>= 4.1.0'
+  s.add_dependency 'fastimage'
+
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'rspec-rails'
+end

data/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,142 @@
+require 'rails_helper'
+
+describe ApplicationController do
+  # just for test
+  describe 'hello world' do
+    specify { expect('hello world').to eq 'hello world' }
+  end
+end
+
+# Specs for ActionView helpers: rails_amp_amphtml_link_tag, rails_amp_canonical_url, amp_renderable?.
+# And specs for ImageTagHelper: amp_image_tag, image_tag
+# These helpers use controller or request object.
+describe UsersController do
+  render_views
+
+  context '#index GET' do
+    # Users#index is available for amp.
+    it 'has correct amphtml link tag' do
+      get 'index'
+      expect(rails_amp_amphtml_link_tag).to eq(
+        %Q(<link rel="amphtml" href="#{request.base_url}/users.#{RailsAmp.default_format.to_s}" />)
+      )
+      expect(response.body).to include(
+        %Q(<link rel="amphtml" href="#{request.base_url}/users.#{RailsAmp.default_format.to_s}" />)
+      )
+    end
+
+    it 'has correct amphtml link tag with params' do
+      get 'index', params: {sort: 'name'}
+      expect(rails_amp_amphtml_link_tag).to eq(
+        %Q(<link rel="amphtml" href="#{request.base_url}/users.#{RailsAmp.default_format.to_s}?sort=name" />)
+      )
+      expect(response.body).to include(
+        %Q(<link rel="amphtml" href="#{request.base_url}/users.#{RailsAmp.default_format.to_s}?sort=name" />)
+      )
+    end
+
+    it 'has correct canonical url' do
+      get 'index', format: RailsAmp.default_format.to_s
+      expect(request.url).to eq("#{request.base_url}/users.#{RailsAmp.default_format.to_s}")
+      expect(rails_amp_canonical_url).to eq("#{request.base_url}/users")
+      expect(response.body).to include(
+        %Q(<link rel="canonical" href="#{request.base_url}/users" />)
+      )
+    end
+
+    it 'has correct canonical url with params' do
+      get 'index', format: RailsAmp.default_format.to_s, params: {sort: 'name'}
+      expect(request.url).to eq("#{request.base_url}/users.#{RailsAmp.default_format.to_s}?sort=name")
+      expect(rails_amp_canonical_url).to eq("#{request.base_url}/users?sort=name")
+      expect(response.body).to include(
+        %Q(<link rel="canonical" href="#{request.base_url}/users?sort=name" />)
+      )
+    end
+
+    context 'with html format' do
+      it 'is not renderable by amp' do
+        get 'index'
+        expect(amp_renderable?).to eq false
+      end
+
+      it 'has normal image tag' do
+        get 'index'
+        expect(image_tag('rails.png', {size: '30x20', border: '0'})).to match(
+          %r(<img border="0" src="/(images|assets)/rails-?\w*?.jpg" alt="Rails" width="30" height="20" />)
+        )
+        expect(image_tag('rails.png')).to match(
+          %r(<img src="/(images|assets)/rails-?\w*?.jpg" alt="Rails" />)
+        )
+        # According to dummy app default view `home/_amp_info`
+        expect(response.body).to match(
+          %r(<img border="0" src="/(images|assets)/rails-?\w*?.jpg" alt="Rails" width="30" height="20" />)
+        )
+      end
+    end
+
+    context 'with amp format' do
+      it 'is renderable by amp' do
+        get 'index', format: RailsAmp.default_format.to_s
+        expect(amp_renderable?).to eq true
+      end
+
+      it 'has amp-img tag' do
+        get 'index', format: RailsAmp.default_format.to_s
+        expect(image_tag('rails.png', {size: '30x20', border: '0'})).to match(
+          %r(<amp-img src="/(images|assets)/rails-?\w*?.jpg" alt="Rails" layout="fixed" width="30" height="20" /></amp-img>)
+        )
+        # `width="400" height="400"` is removed because request.base_url returns dummy url for test.
+        expect(image_tag('rails.png')).to match(
+          %r(<amp-img src="/(images|assets)/rails-?\w*?.jpg" alt="Rails" layout="fixed" /></amp-img>)
+        )
+        # According to dummy app default view `home/_amp_info`
+        expect(response.body).to match(
+          %r(<amp-img src="/(images|assets)/rails-?\w*?.jpg" alt="Rails" layout="fixed" width="30" height="20" /></amp-img>)
+        )
+      end
+    end
+  end
+
+  context '#show GET' do
+    let(:user) { User.create(name: 'Taro', email: 'taro@example.com') }
+
+    context 'with html format' do
+      it 'is not renderable by amp' do
+        get 'show', params: {id: user.id}
+        expect(amp_renderable?).to eq false
+      end
+    end
+
+    context 'with amp format' do
+      it 'is renderable by amp' do
+        get 'show', format: RailsAmp.default_format.to_s, params: {id: user.id}
+        expect(amp_renderable?).to eq true
+      end
+    end
+  end
+end
+
+describe HomeController do
+  context '#help GET' do
+    # Home#help is not available for amp.
+    it 'does not return amphtml link tag' do
+      get 'help'
+      expect(rails_amp_amphtml_link_tag).to eq ''
+    end
+
+    context 'with html format' do
+      it 'is not renderable by amp' do
+        get 'help'
+        expect(amp_renderable?).to eq false
+      end
+    end
+
+    context 'with amp format' do
+      it 'is not renderable by amp' do
+        expect do
+          get 'help', format: RailsAmp.default_format.to_s
+        end.to raise_error(ActionController::UnknownFormat)
+      end
+    end
+  end
+end

data/spec/dummy/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,17 @@
+# Just for test.
+class HomeController < ApplicationController
+  def index
+  end
+
+  def help
+  end
+
+  def about
+    respond_to do |format|
+      format.html  # about.html.erb
+      format.json { render json:
+        { object_id: RailsAmp.config.object_id, format: RailsAmp.config.format }
+      }
+    end
+  end
+end

data/spec/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,25 @@
+# Just for test.
+class UsersController < ApplicationController
+  def index
+    @users = User.all
+  end
+
+  def show
+    @user = User.find(params[:id])
+  end
+
+  def new
+  end
+
+  def create
+  end
+
+  def edit
+  end
+
+  def update
+  end
+
+  def destroy
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ApplicationRecord
+end

data/spec/dummy/app/views/home/_amp_info.html.erb

@@ -0,0 +1,19 @@
+<%# Just for test. %>
+<h2>RailsAmp Information</h2>
+<p>Rails Version:            <%= Rails.version %></p>
+<p>RailsAmp Object ID:       <%= RailsAmp.object_id %></p>
+<p>RailsAmp format:          <%= RailsAmp.format.inspect %></p>
+<p>RailsAmp default_format:  <%= RailsAmp.default_format.inspect %></p>
+<p>RailsAmp targets:         <%= RailsAmp.targets.inspect %></p>
+<p>RailsAmp analytics:       <%= RailsAmp.analytics.inspect %></p>
+<p>RailsAmp analytics class: <%= RailsAmp.analytics.class %></p>
+<p>RailsAmp MimeTypes:       <%= Mime::EXTENSION_LOOKUP %></p>
+<p>RailsAmp Ancestors:       <%= controller.class.ancestors %></p>
+<p><%= image_tag('rails.png', size: '30x20', border: '0') %></p>
+<p><%= image_tag('rails.png') %></p>
+
+<% if amp_renderable? %>
+  <p>This is an amp page.</p>
+<% else %>
+  <p>This is a html page.</p>
+<% end %>

data/spec/dummy/app/views/home/about.html.erb

@@ -0,0 +1,2 @@
+<%# Just for test. %>
+<%= render 'home/amp_info' %>

data/spec/dummy/app/views/home/help.html.erb

@@ -0,0 +1,2 @@
+<%# Just for test. %>
+<%= render 'home/amp_info' %>

data/spec/dummy/app/views/home/index.html.erb

@@ -0,0 +1,2 @@
+<%# Just for test. %>
+<%= render 'home/amp_info' %>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+    <%= rails_amp_amphtml_link_tag %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>