rails_amp 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41090d7cbfa0a001a9e1648ae23cd8597f10f571
+  data.tar.gz: 93b900a423f87244c74ac738b4cff363638858c8
+SHA512:
+  metadata.gz: 42eeb0062a86bb316413c3fd9ab6ecef11ca34ba6d7f21fe4b47bfe6932f4db24dfa13ecfd3726f732ec4b3d05270ca4314675aede6fb529dc758037d2afeced
+  data.tar.gz: c08fe3e59be882193b4e9f6ba6b3be994aeb54607e34173dff1248294ca5a7f0e390348a0750c57e3813160b0a58d8cb1d2cced47a9318c4ac833e84949c0c3c

data/.gitignore

@@ -0,0 +1,14 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+/vendor/bundle/
+.DS_Store
+*.gem
+*.rbc
+Gemfile.lock
+gemfiles/*.lock
+coverage

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in rails_amp.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Takafumi Yamano
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,370 @@
+# RailsAmp
+
+RailsAmp is a Ruby on Rails plugin that makes it easy to build views for AMP(Accelerated Mobile Pages).
+
+## Supported Versions
+
+Rails 4.1, 4.2, 5.0
+
+## Installation
+
+In your Gemfile:
+
+```ruby
+gem 'rails_amp'
+```
+
+And install:
+
+```bash
+$ bundle install
+```
+
+And then, generate codes and files:
+
+```bash
+$ rails generate rails_amp:install
+```
+
+This step generates the followings.
+
+```bash
+insert  config/initializers/mime_types.rb
+create  config/rails_amp.yml
+create  app/views/layouts/rails_amp_application.amp.erb
+```
+
+In config/initializers/mime_types.rb:
+
+```ruby
+Mime::Type.register_alias 'text/html', RailsAmp.default_format
+```
+
+This line must be added to make rails to recognize the amp format. The default format is :amp. You can change the value in config/rails_amp.yml
+
+## Configurations
+
+You can change RailsAmp configurations in your `config/rails_amp.yml`. Write configs with yaml.
+
+In config/rails_amp.yml:
+
+```yaml
+# ### Here are some config samples to use rails_amp.
+
+# --------------------------------------------------
+# To enable amp on specific controllers and actions.
+# --------------------------------------------------
+# ### Enable amp on users all actions.
+# targets:
+#   users:
+#
+# ### Enable amp on users#index, users#show, posts#index, posts#show.
+# ### controller: action1 action2 action3 ...
+# targets:
+#   users: index show
+#   posts: index show
+#
+# ### Enable amp on all controllers and actions.
+# targets:
+#   application: all
+#
+# ### Disable amp completely.
+# targets:
+#
+targets:
+  users: index show
+
+# --------------------------------------------------
+# To set initial configurations.
+# --------------------------------------------------
+# ### Enable Google Analytics page tracking. Set your Google Analytics Account.
+# analytics: UA-*****-*
+#
+# ### Change default amp format. The default value is amp.
+# ### If you want to use 'mobile' as amp format, set 'mobile' to default_format.
+# ### And you can access the amp page like /users/index.mobile
+# default_format: mobile
+#
+# ### Set formats that used as amp. The default is html.
+# ### These formats are used in the order, when the amp specialized view like 'users/index.amp.erb' is not found.
+# lookup_formats: html xhtml
+```
+
+### Examples
+
+Set the controllers and actions that you want to enable amp.
+
+Enable amp on users all actions except for new, create, edit, update, destroy actions.
+
+```yaml
+targets:
+  users:
+```
+
+Note that RailsAmp automatically excludes the post-method related actions `new, create, edit, update, destroy` that originally provided by Rails from the amp targets.
+
+Enable amp on some specific controllers and actions. e.g.) users#index, users#show, posts#show.
+
+```yaml
+targets:
+  users: index show
+  posts: show
+```
+
+Enable amp on all controllers and actions. (It's a bit dangerous, so I don't recommend.)
+
+```yaml
+targets:
+  application: all
+```
+
+Disable amp completely.
+
+```yaml
+targets:
+```
+
+Other configurations.
+
+Enable Google Analytics page tracking. Set your Google Analytics Account.
+
+```yaml
+analytics: UA-*****-*
+```
+
+Change the amp default format. The default value is 'amp'. If you want to use 'mobile' as the default format, set 'mobile' to default_format. And you can access the amp page like `http://example.com/users.mobile`.
+
+```yaml
+default_format: mobile
+```
+
+Change formats that used as amp. The default is html. These formats are used in the order, when the amp specialized view like `app/views/users/index.amp.erb` is not found.
+
+```yaml
+lookup_formats: html xhtml
+```
+
+Note that you need to restart a server to reload the configurations after changing config/rails_amp.yml.
+
+## Setup
+
+Add the following code in your default layout head like `application.html.erb`.
+
+In app/views/layouts/application.html.erb:
+
+```html
+<%= rails_amp_amphtml_link_tag %>
+```
+
+This code will put out the html header to inform where the amp url is.
+
+```html
+<link rel="amphtml" href="http://example.com/users.amp" />
+```
+
+### AMP link for root_url(root_path)
+
+When you enable amp on the controller and action for root_url, the helper `rails_amp_amphtml_link_tag` will put out the following amphtml link in the root url.
+
+In your config/routes.rb:
+
+```ruby
+root 'home#index'
+```
+
+And, in config/rails_amp.yml:
+
+```yaml
+targets:
+  home: index
+```
+
+The helper `rails_amp_amphtml_link_tag` will put out the following in the root url.
+
+In `http://example.com/`:
+
+```html
+<link rel="amphtml" href="http://example.com/home/index.amp" />
+```
+
+So, you need to add a routing for this amp url.
+
+In your config/routes.rb:
+
+```ruby
+get '/home/index', to: 'home#index'
+```
+
+
+## Customize AMP layout
+
+In app/views/layouts/rails_amp_application.amp.erb:
+
+```html
+<!doctype html>
+<html amp>
+  <head>
+    <meta charset="utf-8">
+    <title>Rails AMP</title>
+    <link rel="canonical" href="<%= rails_amp_canonical_url %>" />
+    <meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1">
+
+    <!-- Set page data type by JSON-LD and schema.org. -->
+    <!-- If you don't use page data type, remove this block. -->
+    <script type="application/ld+json">
+      {
+        "@context": "http://schema.org",
+        "@type": "*****",
+        "mainEntityOfPage": "*****",
+        "datePublished": "*****"
+      }
+    </script>
+
+    <!-- Write custom css sytle for amp html here. -->
+    <style amp-custom>
+      body {
+      }
+      amp-img {
+      }
+    </style>
+
+    <%= rails_amp_google_analytics_page_tracking %>
+    <%= rails_amp_html_header %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>
+```
+
+Customize the page data type by JSON-LD and schema.org, and write custom css styles in the `<style amp-custom>` block. You can customize any other parts of this amp layout file as you like, but you need to follow the amp restrictions.
+
+### Canonical link for root_url(root_path)
+
+When you enable amp on the controller and action for root_url, the helper `rails_amp_canonical_url` will put out the following canonical link tag in the amp url for root_url.
+
+In `http://example.com/home/index.amp`:
+
+```html
+<link rel="canonical" href="http://example.com/home/index" />
+```
+
+If you want to use the root_url as the canonical url, you should customize the codes.
+
+```html
+<% if controller_name == 'home' && action_name == 'index'  %>
+  <link rel="canonical" href="<%= root_url %>" />
+<% else %>
+  <link rel="canonical" href="<%= rails_amp_canonical_url %>" />
+<% end %>
+```
+
+## Usage
+
+To access amp pages, add the amp default format at the end of the url before queries like the followings.
+
+```
+http://example.com/users.amp
+http://example.com/users.amp?sort=name
+```
+
+If you change the amp default format, you have to use it as the format.
+
+In your config/rails_amp.yml
+
+```yaml
+default_format: mobile
+```
+
+Access the amp pages.
+
+```
+http://example.com/users.mobile
+http://example.com/users.mobile?sort=name
+```
+
+### When not creating another view for amp. (When the template for amp not found)
+
+If you don't create another view for amp (When the template for amp not found), RailsAmp tries to find amp-available formats accoding to the config `lookup_formats`, and uses the existing html view for the amp page as is.
+
+e.g.) When you enable amp on `users#index` in config and don't create another amp view like `app/views/users/index.amp.erb`, RailsAmp uses the existing html view like `app/views/users/index.html.erb` for the amp page.
+
+Then, you can access the amp page as `http://example.com/users.amp` by adding the amp default format at the end of the url before queries.
+
+### When creating another view for amp.
+
+If you want to use specialized views for amp pages, you can create another view for amp like `app/views/users/index.amp.erb`. When accessing `http://example.com/users.amp`, the amp specialized view will be used.
+
+If you change the amp default format, create the view template with the format.
+
+In config/rails_amp.yml:
+
+```yaml
+default_format: mobile
+```
+
+Create the view template as `app/views/users/index.mobile.erb`, and access the amp page as `http://example.com/users.mobile`.
+
+### View Helpers
+
+You can use a helper `amp_renderable?` in views. Use `amp_renderable?` in your existing html views to switch some codes. Here is a sample to switch codes for Twitter tweet display.
+
+```html
+<% if amp_renderable? %>
+  <!-- For amp -->
+  <amp-twitter width=486 height=657
+    layout="responsive"
+    data-tweetid="*****"
+    data-cards="hidden">
+    <blockquote placeholder class="twitter-tweet" data-lang="en">*****</blockquote>
+  </amp-twitter>
+<% else %>
+  <!-- For normal html -->
+  <blockquote class="twitter-tweet" data-lang="ja">*****</blockquote>
+  <script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>
+<% end %>
+```
+
+## Supported AMP tags
+
+RailsAmp supports a tag `<amp-img>` so far.
+
+### amp-img
+
+You have to use the `<amp-img>` tag to render images in amp pages, instead of a normal html tag `<img>`. When you use a rails built-in helper `image_tag` in view templates, RailsAmp automatically renders images with the `<amp-img>` tag in amp format pages. Also, the helper `image_tag` renders images with the `<img>` tag in normal html format pages.
+
+The `<amp-img>` tag requires `width` and `height` attributes. When the `image_tag` helper is used with a `size` or `width`, `height` option, the `<amp-img>` tag uses the option's value as its `width` and `height` attributes.
+
+If the `image_tag` helper doesn't have a `size` or `width` or `height` option, RailsAmp computes the image size using FastImage. FastImage is a great gem to fetch the size and other information of an image quickly. If FastImage even cannot fetch the image size, the `<amp-img>` tag's width and height attributes are set to `300` and `300`.
+
+So, for amp format pages, I recommend that you use the `image_tag` helper with a `size` or `width`, `height` option as much as possible.
+
+## Check AMP validation
+
+In Google Chrome browser:
+
+1. Start the Developer Tools.
+1. Select the Console tab.
+1. Access the amp page with `#development=1` like `http://localhost:3000/users.amp#development=1`
+
+If `AMP validation successful` shows, the amp page is valid. If some errors are detected, fix your existing html view using the `amp_renderable?` helper or create another amp specialized view.
+
+## References
+
+[Accelerated Mobile Pages Project](https://www.ampproject.org/)
+
+## Contributing
+
+1. Fork it ( https://github.com/takafumir/rails_amp/fork )
+1. Create your feature branch (git checkout -b my-new-feature)
+1. Commit your changes (git commit -am 'Add some feature')
+1. Push to the branch (git push origin my-new-feature)
+1. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://github.com/takafumir/rails_amp/blob/master/MIT-LICENSE).
+
+## Author
+
+[Takafumi Yamano](https://github.com/takafumir)

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsAmp'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+

data/gemfiles/Gemfile-rails.4.1.x

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem 'rails', '~> 4.1.0'
+gemspec path: '../'

data/gemfiles/Gemfile-rails.4.2.x

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem 'rails', '~> 4.2.0'
+gemspec path: '../'

data/lib/generators/rails_amp/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+
+module RailsAmp
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def inject_amp_mime_type_into_file
+      inject_into_file 'config/initializers/mime_types.rb',
+                            after: %Q(# Mime::Type.register "text/richtext", :rtf\n) do <<-'RUBY'
+Mime::Type.register_alias 'text/html', RailsAmp.default_format
+RUBY
+      end
+    end
+
+    def create_config_file
+      copy_file 'rails_amp.yml', 'config/rails_amp.yml'
+    end
+
+    def create_application_layout
+      copy_file 'rails_amp_application.amp.erb', 'app/views/layouts/rails_amp_application.amp.erb'
+    end
+  end
+end

data/lib/generators/rails_amp/templates/rails_amp.yml

@@ -0,0 +1,39 @@
+# ### Here are some config samples to use rails_amp.
+
+# --------------------------------------------------
+# To enable amp on specific controllers and actions.
+# --------------------------------------------------
+# ### Enable amp on users all actions.
+# targets:
+#   users:
+#
+# ### Enable amp on users#index, users#show, posts#index, posts#show.
+# ### controller: action1 action2 action3 ...
+# targets:
+#   users: index show
+#   posts: index show
+#
+# ### Enable amp on all controllers and actions.
+# targets:
+#   application: all
+#
+# ### Disable amp completely.
+# targets:
+#
+targets:
+  users: index show
+
+# --------------------------------------------------
+# To set initial configurations.
+# --------------------------------------------------
+# ### Enable Google Analytics page tracking. Set your Google Analytics Account.
+# analytics: UA-*****-*
+#
+# ### Change default amp format. The default value is amp.
+# ### If you want to use 'mobile' as amp format, set 'mobile' to default_format.
+# ### And you can access the amp page like /users/index.mobile
+# default_format: mobile
+#
+# ### Set formats that used as amp. The default is html.
+# ### These formats are used in the order, when the amp specialized view like 'users/index.amp.erb' is not found.
+# lookup_formats: html xhtml

data/lib/generators/rails_amp/templates/rails_amp_application.amp.erb

@@ -0,0 +1,34 @@
+<!doctype html>
+<html amp>
+  <head>
+    <meta charset="utf-8">
+    <title>Rails AMP</title>
+    <link rel="canonical" href="<%= rails_amp_canonical_url %>" />
+    <meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1">
+
+    <!-- Set page data type by JSON-LD and schema.org. -->
+    <!-- If you don't use page data type, remove this block. -->
+    <script type="application/ld+json">
+      {
+        "@context": "http://schema.org",
+        "@type": "*****",
+        "mainEntityOfPage": "*****",
+        "datePublished": "*****"
+      }
+    </script>
+
+    <!-- Write custom css sytle for amp html here. -->
+    <style amp-custom>
+      body {
+      }
+      amp-img {
+      }
+    </style>
+
+    <%= rails_amp_google_analytics_page_tracking %>
+    <%= rails_amp_html_header %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/rails_amp/config.rb

@@ -0,0 +1,106 @@
+module RailsAmp
+  class Config
+    # Return the current format, default is ''. The only configuration value that is not global.
+    def format
+      @format ||= ''
+    end
+
+    # Set the current format pseudo-globally, i.e. in the Thread.current hash.
+    def format=(format)
+      @format = format.to_s
+    end
+
+    # Return the config file path, default is "#{Rails.root}/config/rails_amp.yml".
+    def config_file
+      @@config_file ||= "#{Rails.root}/config/rails_amp.yml"
+    end
+
+    # Set the config file path.
+    def config_file=(config_file)
+      @@config_file = config_file
+    end
+
+    # Return the yaml loaded config, default is YAML.load_file(config_file).
+    def load_config
+      @@load_config ||= config_load_config
+    end
+
+    # Set the config by loading yaml.
+    def load_config=(load_config)
+      @@load_config = load_config
+    end
+
+    # Return the default amp format, default is :amp
+    def default_format
+      @@default_format ||= config_default_format
+    end
+
+    # Set the default amp format.
+    def default_format=(default_format)
+      @@default_format = default_format.to_sym
+    end
+
+    # Return the amp enabled controller actions.
+    def targets
+      @@targets ||= config_targets
+    end
+
+    # Set the amp enabled controller actions.
+    def targets=(targets)
+      @@targets = targets
+    end
+
+    # Return the analytics account, default is ''.
+    def analytics
+      @@analytics ||= config_analytics
+    end
+
+    # Set the analytics account.
+    def analytics=(analytics)
+      @@analytics = analytics
+    end
+
+    # Return the lookup_context formats for amp, default is [:html].
+    def lookup_formats
+      @@lookup_formats ||= config_lookup_formats
+    end
+
+    # Set the lookup_context formats for amp.
+    def lookup_formats=(lookup_formats)
+      @@lookup_formats = lookup_formats
+    end
+
+    private
+
+      def config_load_config
+        YAML.load_file(config_file)
+      end
+
+      def config_default_format
+        load_config['default_format'].try(:to_sym) || :amp
+      end
+
+      def config_targets
+        targets = load_config['targets']
+        return {} if targets.blank?
+
+        if targets.is_a?(Hash) && targets.has_key?('application')
+          return targets
+        end
+
+        if targets.is_a?(Hash)
+          return targets.map{ |k, v| [k, v.to_s.split(/\s+/)] }.to_h
+        end
+
+        {}
+      end
+
+      def config_analytics
+        load_config['analytics'] || ''
+      end
+
+      def config_lookup_formats
+        load_config['lookup_formats'].to_s.split(/\s+/).map(&:to_sym).presence || [:html]
+      end
+  end
+end