amp-html 0.7.7

data/lib/generators/amphtml/views_generator.rb

@@ -0,0 +1,62 @@
+require 'rails/generators/base'
+require 'thor'
+
+module AmpHtml
+    module Generators
+
+        class ViewsGenerator < Rails::Generators::Base
+
+            source_root File.expand_path '../../templates/views', __FILE__
+            desc 'Updates views to ensure compatibility with AMP. Run with --split to keep a version without AMP.'
+
+            class_option :only_resources, desc: 'Only generate resources', type: :boolean, default: false
+
+
+            class_option :split, desc: 'Keep an application layout without AMP', type: :boolean, default: false, aliases: '-s'
+            class_option :format, desc: 'Set the views format. Defaults to `html`', type: :string, aliases: '-f'
+
+
+            # DEEP INTEGRATION COMPONENTS
+            class_option :all, desc: 'Install all AMP-HTML components', type: :boolean, default: false, aliases: '-a'
+
+            class_option :analytics, desc: 'Install the AMP-HTML Analytics Component', type: :boolean, default: false
+            class_option :javascript, desc: 'Install the AMP-HTML Javascript Component', type: :boolean, default: false
+
+
+
+
+            def create_views
+                template 'application/_resources.html.erb', "app/views/application/amp/_resources.#{pick_format}.erb"
+                template 'application/_head.html.erb', "app/views/application/amp/_head.#{pick_format}.erb" unless options[:only_resources]
+                template 'application/_schema.html.erb', "app/views/application/amp/_schema.#{pick_format}.erb" unless options[:only_resources]
+                template 'application.html.erb', "app/views/layouts/application.#{pick_format}.erb" unless options[:only_resources]
+            end
+
+            def create_mime_types
+                template 'config/mime_types.rb', 'config/initializers/mime_types.rb' unless options[:only_resources]
+            end
+
+            def show_readme
+                readme 'README.md'
+            end
+
+
+            private
+
+
+            def pick_format
+                if options[:format]
+                    options[:format]
+                else
+                    if options[:split]
+                        'amp'
+                    else
+                        'html'
+                    end
+                end
+            end
+
+        end
+
+    end
+end

data/lib/generators/templates/assets/stylesheets/application.scss

@@ -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, 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/lib/generators/templates/components/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// 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, 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 rails-ujs
+//= require turbolinks
+//= require_tree .

data/lib/generators/templates/components/helpers/ad_tag_helper.rb

@@ -0,0 +1,83 @@
+module ApplicationHelper
+    module Amp::Components::AdTagHelper
+
+        def amp_ad network = AmpHtml.ad_default_network, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:type] = network
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-ad tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+            content_tag('amp-ad', options)
+
+            if block_given?
+                content_tag 'amp-ad', capture(&block), options
+            else
+                if options[:sticky] == true
+                    options.delete :sticky
+                    sticky = {}
+                    sticky[:layout] = 'nodisplay'
+                    content_tag('amp-sticky-ad', sticky) do
+                        content_tag 'amp-ad', options
+                    end
+                elsif options[:placeholder]
+                    placeholder = options[:placeholder]
+                    options.delete :placeholder
+                    content_tag('amp-ad', options) do
+                        placeholder = options[:src] = path_to_image source, skip_pipeline: options.delete(:skip_pipeline)
+                        amp_placeholder 'amp-img', options
+                    end
+                elsif options[:fallback]
+                    fallback = options[:fallback]
+                    options.delete :fallback
+                    content_tag('amp-ad', options) do
+                        fallback = options[:src] = path_to_image source, skip_pipeline: options.delete(:skip_pipeline)
+                        amp_fallback 'amp-img', options
+                    end
+                else
+                    content_tag 'amp-ad', nil, options
+                end
+            end
+        end
+
+        def amp_embed network = AmpHtml.ad_default_network, options = {}, &block
+            amp_ad network, options, capture(&block)
+        end
+
+        def amp_auto_ads network = AmpHtml.auto_ads_default_network, options = {}
+            options = options.symbolize_keys
+
+            options[:type] = network
+            content_tag 'amp-auto-ads', options
+        end
+
+        # ## Removed because it depends on Iframe Component
+        # ## Propably moving into Iframe Component
+        # def amp_video_ad(source, poster, options = {})
+        #     options = options.symbolize_keys
+        #
+        #     options[:poster] = poster
+        #     amp_iframe(source, options)
+        # end
+
+        def amp_custom_ad name
+            options = {}
+            options[:name] = name
+            options[:content] = request.original_url + '/remote.html'
+            tag 'meta', options
+        end
+
+        private
+
+        def extract_dimensions size
+            size = size.to_s
+            if /\A\d+x\d+\z/.match? size
+                size.split("x")
+            elsif /\A\d+\z/.match? size
+                [size, size]
+            end
+        end
+
+    end
+end

data/lib/generators/templates/components/helpers/analytics_tag_helper.rb

@@ -0,0 +1,30 @@
+module ApplicationHelper
+    module Amp::Components::AnalyticsTagHelper
+
+        def amp_analytics vendor = AmpHtml.analytics_default_vendor, options = {}, &block
+            options = options.symbolize_keys
+            options[:type] = vendor if vendor
+            if block_given?
+                content_tag 'amp-analytics', capture(&block), options
+            else
+                content_tag 'amp-analytics', nil, options
+            end
+        end
+        def amp_google_analytics options = {}
+            options = options.symbolize_keys
+
+            options[:type] = 'googleanalytics'
+            triggers = options[:triggers]
+            content_tag('amp-analytics', options) do
+                render 'application/amp/components/google_analytics', triggers: triggers
+            end
+        end
+
+        def amp_pixel src
+            options = {}
+            options[:src] = src
+            content_tag 'amp-pixel', options
+        end
+
+    end
+end

data/lib/generators/templates/components/helpers/anim_tag_helper.rb

@@ -0,0 +1,42 @@
+module ApplicationHelper
+    module Amp::Components::AnimTagHelper
+
+        def amp_anim(source, options = {}, &block)
+            options = options.symbolize_keys
+
+            source = options[:src] = path_to_image(source, skip_pipeline: options.delete(:skip_pipeline))
+
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn "WARNING (AMP): specify width and height of amp-anim tags." unless options[:width] && options[:height]
+
+            options[:layout] = "responsive" unless options[:layout] != "responsive"
+
+            if block_given?
+                content_tag("amp-anim", capture(&block), options)
+            else
+                if options[:placeholder]
+                    placeholder = options[:placeholder]
+                    options.delete(:placeholder)
+                    content_tag("amp-anim", options) do
+                        placeholder = options[:src] = path_to_image(source, skip_pipeline: options.delete(:skip_pipeline))
+                        amp_placeholder("amp-img", options)
+                    end
+                else
+                    content_tag("amp-anim", options)
+                end
+            end
+        end
+
+        private
+
+        def extract_dimensions(size)
+            size = size.to_s
+            if /\A\d+x\d+\z/.match?(size)
+                size.split("x")
+            elsif /\A\d+\z/.match?(size)
+                [size, size]
+            end
+        end
+
+    end
+end

data/lib/generators/templates/components/helpers/iframe_tag_helper.rb

@@ -0,0 +1,27 @@
+module ApplicationHelper
+    module Amp::Components::IframeTagHelper
+
+        def amp_iframe(source, options = {})
+            options = options.symbolize_keys
+
+            options[:src] = source
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn "WARNING (AMP): specify width and height of amp-iframe tags." unless options[:width] && options[:height]
+
+            options[:layout] = "responsive" unless options[:layout] != "responsive"
+            content_tag("amp-iframe", options)
+        end
+
+        private
+
+        def extract_dimensions(size)
+            size = size.to_s
+            if /\A\d+x\d+\z/.match?(size)
+                size.split("x")
+            elsif /\A\d+\z/.match?(size)
+                [size, size]
+            end
+        end
+
+    end
+end

data/lib/generators/templates/components/helpers/javascript_tag_helper.rb

@@ -0,0 +1,12 @@
+module ApplicationHelper
+    module Amp::Components::JavascriptTagHelper
+
+        def amp_js(source = asset_url("amp/application.js"))
+            options = {}
+            options[:src] = src
+            options[:sandbox] = "allow-scripts allow-same-origin"
+            content_tag("amp-iframe", options)
+        end
+
+    end
+end

data/lib/generators/templates/components/helpers/lists_tag_helper.rb

@@ -0,0 +1,82 @@
+module ApplicationHelper
+    module Amp::Components::ListsTagHelper
+
+        def amp_list(source, options = {}, &block)
+            options = options.symbolize_keys
+
+            options[:src] = source
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn "WARNING (AMP): specify width and height of amp-list tags." unless options[:width] && options[:height]
+
+            options[:layout] = "responsive" unless options[:layout] != "responsive"
+            if block_given?
+                content_tag("amp-list", capture(&block), options)
+            else
+                content_tag("amp-list", options)
+            end
+        end
+
+        def amp_live_list(id, max_items_per_page = "20", interval = "15000", options = {}, &block)
+            options = options.symbolize_keys
+
+            options[:id] = id
+            options[:"data-poll-interval"] = interval
+            options[:"data-max-items-per-page"] = max_items_per_page
+
+            if block_given?
+                content_tag("amp-live-list", capture(&block), options)
+            else
+                content_tag("amp-live-list", options)
+            end
+        end
+
+        def amp_live_list_update(name = "div", list_id = nil, options = {}, &block)
+            options = options.symbolize_keys
+
+            options[:update] = ""
+
+            options[:on] = "tap:" + list_id + ".update" if list_id
+            if block_given?
+                content_tag(name, capture(&block), options)
+            else
+                content_tag(name, options)
+            end
+        end
+
+        def amp_live_list_items(options = {}, &block)
+            options = options.symbolize_keys
+
+            options[:items] = ""
+
+            if block_given?
+                content_tag("div", capture(&block), options)
+            else
+                content_tag("div", options)
+            end
+        end
+
+        def amp_live_list_pagination(options = {}, &block)
+            options = options.symbolize_keys
+
+            options[:pagination] = ""
+
+            if block_given?
+                content_tag("div", capture(&block), options)
+            else
+                content_tag("div", options)
+            end
+        end
+
+        private
+
+        def extract_dimensions(size)
+            size = size.to_s
+            if /\A\d+x\d+\z/.match?(size)
+                size.split("x")
+            elsif /\A\d+\z/.match?(size)
+                [size, size]
+            end
+        end
+
+    end
+end

data/lib/generators/templates/components/helpers/notification_tag_helper.rb

@@ -0,0 +1,16 @@
+module ApplicationHelper
+    module Amp::Components::NotificationTagHelper
+
+        def amp_user_notification(id)
+            options[:id] = id
+            options[:layout] = "nodisplay"
+            content_tag("amp-user-notification", options)
+        end
+
+        def amp_close_user_notification_button(id)
+            options[:on] = "tap:" + id + ".dismiss"
+            content_tag("button", options)
+        end
+
+    end
+end

data/lib/generators/templates/components/helpers/serviceworker_tag_helper.rb

@@ -0,0 +1,15 @@
+module ApplicationHelper
+    module Amp::Components::ServiceworkerTagHelper
+
+        def amp_serviceworker(register_url, install_url, options = {})
+            options = options.symbolize_keys
+
+            options[:src] = register_url
+            options[:"data-iframe-src"] = install_url
+            options[:layout] = "nodisplay"
+
+            content_tag("amp-install-serviceworker", options)
+        end
+
+    end
+end

data/lib/generators/templates/components/helpers/social_tag_helper.rb

@@ -0,0 +1,228 @@
+module ApplicationHelper
+    module Amp::Components::SocialTagHelper
+
+        def amp_twitter tweet_id, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:"data-tweetid"] = tweet_id
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-twitter tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-twitter', capture(&block), options
+            else
+                content_tag 'amp-twitter', nil, options
+            end
+        end
+
+        def amp_instagram shortcode, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:"data-shortcode"] = shortcode
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-instagram tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-instagram', capture(&block), options
+            else
+                content_tag 'amp-instagram', nil, options
+            end
+        end
+
+        def amp_facebook href, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:"data-href"] = href
+
+            if options[:type]
+                options[:"data-embed-as"] = options[:type]
+                options.delete :type
+            end
+
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-facebook tags.' unless options[:width] && options[:height]
+
+            if options[:video]
+                options[:"data-embed-as"] = 'video'
+                options.delete :video
+            end
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-facebook', capture(&block), options
+            else
+                content_tag 'amp-facebook', nil, options
+            end
+        end
+
+        def amp_youtube video_id, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:"data-videoid"] = video_id
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-youtube tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-youtube', capture(&block), options
+            else
+                content_tag 'amp-youtube', nil, options
+            end
+        end
+
+        def amp_reddit src, type, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:"data-embedtype"] = type
+            options[:"data-src"] = src
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-reddit tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-reddit', capture(&block), options
+            else
+                content_tag 'amp-reddit', nil, options
+            end
+        end
+
+        def amp_social_share type = AmpHtml.social_share_default_provider, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:type] = type if type
+            options[:"data-share-endpoint"] = AmpHtml.default_data_share_endpoint if AmpHtml.default_data_share_endpoint
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-social-share tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-social-share', capture(&block), options
+            else
+                content_tag 'amp-social-share', nil, options
+            end
+        end
+
+        def amp_soundcloud track_id, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:"data-trackid"] = track_id
+
+            if options[:type].downcase == 'visual'
+                options[:"data-visual"] = true
+            end
+            options.delete :type
+
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-soundcloud tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-soundcloud', capture(&block), options
+            else
+                content_tag 'amp-soundcloud', nil, options
+            end
+        end
+
+        def amp_vine vine_id, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:"data-vineid"] = vine_id
+
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-vine tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-vine', capture(&block), options
+            else
+                content_tag 'amp-vine', nil, options
+            end
+        end
+
+        def amp_gfycat gfy_id, autoplay, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:"data-gfyid"] = gfy_id
+            options[:noautoplay] = true if autoplay == false
+
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-gfycat tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-gfycat', capture(&block), options
+            else
+                content_tag 'amp-gfycat', nil, options
+            end
+        end
+
+        def amp_pin_it url, media, description, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:"data-do"] = 'buttonPin'
+            options[:"data-url"] = url
+            options[:"data-media"] = media
+            options[:"data-description"] = description
+
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-pinterest tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-pinterest', capture(&block), options
+            else
+                content_tag 'amp-pinterest', nil, options
+            end
+        end
+
+        def amp_pin_widget url, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:"data-do"] = 'embedPin'
+            options[:"data-url"] = url
+
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-pinterest tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-pinterest', capture(&block), options
+            else
+                content_tag 'amp-pinterest', nil, options
+            end
+        end
+
+        def amp_pinterest_follow label, href, options = {}, &block
+            options = options.symbolize_keys
+
+            options[:"data-do"] = 'buttonFollow'
+            options[:"data-label"] = label
+            options[:"data-href"] = href
+
+            options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+            warn 'WARNING (AMP): specify width and height of amp-pinterest tags.' unless options[:width] && options[:height]
+
+            options[:layout] = 'responsive' unless options[:layout] != 'responsive'
+
+            if block_given?
+                content_tag 'amp-pinterest', capture(&block), options
+            else
+                content_tag 'amp-pinterest', nil, options
+            end
+        end
+
+    end
+end