amp-html 0.7.7

data/lib/amp_html/helpers/docs/amp_facebook.md

@@ -0,0 +1,70 @@
+
+# [Helpers](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#amp-html-helpers) / `amp_facebook`
+
+
+## Information
+
+`amp_facebook` allows to easily embed ads with AMP, not hurting performance.
+
+---
+
+### Quick info
+
+#### Latest update: 0.6.2 (Pre-release) - 2017-03-20
+
+[**Changelog for version 0.6.2**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#062-pre-release---2017-03-20)
+
+#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#deepintegration-helpers): Disabled
+
+#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#availability-of-helpers): Installable with the [Social Component](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs/social.md)
+
+#### [Takes a block?](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#takes-a-block): Yes
+
+---
+
+## General
+
+### Reference
+
+[**AMP Reference**](https://www.ampproject.org/docs/reference/components/social/amp-facebook)
+
+#### Required Parameters
+
+* `href`
+* `size` (or `width` & `height`)
+
+#### Structure
+
+    <%= amp_facebook(href, options) %>
+    # <amp-facebook data-href=href layout="responsive"></amp-facebook>
+
+**Note:** `layout` defaults to `responsive` if not explicitly permitted.
+
+
+## Examples
+
+Setting width & height:
+
+    <%= amp_facebook("https://www.facebook.com/zuck/posts/10102593740125791", width: 486, height: 657) %>
+    <%= amp_facebook("https://www.facebook.com/zuck/posts/10102593740125791", size: "486x657") %>
+    # <amp-facebook data-href="https://www.facebook.com/zuck/posts/1010259374012579"1 layout="responsive" width=486 height=657></amp-facebook>
+
+Embedding a post:
+
+    <%= amp_facebook("https://www.facebook.com/zuck/posts/10102593740125791", width: 486, height: 657) %>
+    # <amp-facebook data-href="https://www.facebook.com/zuck/posts/10102593740125791" layout="responsive" width=400 height=300></amp-facebook>
+
+Embedding a video:
+
+    <%= amp_facebook("https://www.facebook.com/zuck/posts/10102593740125791", type: "video", width: 486, height: 657 ) %>
+    # <amp-facebook data-href="https://www.facebook.com/zuck/posts/10102593740125791" data-embed-as="video" layout="responsive" width=400 height=300></amp-facebook>
+
+`amp_facebook` also takes a block:
+
+    <%= amp_facebook("https://www.facebook.com/zuck/posts/10102593740125791", width: 486, height: 657) do %>
+        <%= amp_placeholder("blockquote", class: "facebook-post") do %>
+            <p>The story how I became what some people would call a frontend engineer and an exploration into what that even means</p>
+        <% end %>
+    <% end %>
+
+**References:** [`amp_placeholder`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_placeholder.md)

data/lib/amp_html/helpers/docs/amp_fallback.md

@@ -0,0 +1,47 @@
+
+# [Helpers](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#amp-html-helpers) / `amp_fallback`
+
+
+## Information
+
+`amp_fallback` allows to create AMP-HTML fallbacks for any HTML or AMP tag.
+
+---
+
+### Quick info
+
+#### Latest update: 0.5.0 (Pre-release) - 2017-03-18
+
+[**Changelog for version 0.5.0**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#050-pre-release---2017-03-18)
+
+#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#deepintegration-helpers): Disabled
+
+#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#availability-of-helpers): Build-in
+
+#### [Takes a block?](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#takes-a-block): Yes
+
+---
+
+## General
+
+### Reference
+
+<!-- [**AMP Reference**](https://www.ampproject.org/docs/reference/components/ads/amp-ad) -->
+
+#### Required Parameters
+
+* `name`
+
+#### Structure
+
+    <%= amp_fallback(name, options) %>
+    # <name fallback></name>
+
+
+## Examples
+
+`amp_fallback` also takes a block:
+
+    <%= amp_fallback("div", layout: "nodisplay") do %>
+        <p>Hello AMP</p>
+    <% end %>

data/lib/amp_html/helpers/help.rb

@@ -0,0 +1,23 @@
+module AmpHtml
+    module Helpers
+        class Help
+
+            def self.all
+                puts IO.read File.join AmpHtml.root, 'amp_html', 'helpers', 'docs', 'README.md'
+            end
+
+            def self.helper name
+                begin
+                    if name == 'amp?'
+                        puts IO.read File.join AmpHtml.root, 'amp_html', 'helpers', 'docs', 'amp.md'
+                    else
+                        puts IO.read File.join AmpHtml.root, 'amp_html', 'helpers', 'docs', "#{name}.md"
+                    end
+                rescue Exception
+                    warn 'Helper is not available'
+                end
+            end
+
+        end
+    end
+end

data/lib/amp_html/root.rb

@@ -0,0 +1,7 @@
+module AmpHtml
+
+    def self.root
+        File.dirname __dir__
+    end
+
+end

data/lib/amp_html/test.rb

@@ -0,0 +1,169 @@
+module AmpHtml
+    class Test
+
+        def self.all
+            markup
+            html
+            css
+        end
+
+        def self.markup
+            strings = ['<!doctype', '<html', 'amp_html_doctype', '<head', '<body', 'canonical_document_link', 'amp_document_link', 'amp_head', '<meta name="viewport" content="width=device-width,minimum-scale=1']
+
+            results = search_files_in_dir_for File.join('app', 'views'), strings
+            test1 = markup_test results
+
+            if test1
+                puts 'AMP-HTML TEST: MARKUP tests executed without exceptions'
+            else
+                puts 'AMP-HTML TEST: MARKUP tests have failed. Learn more about the required markup of AMP pages: https://github.com/ampproject/amphtml/blob/master/spec/amp-html-format.md#required-markup'
+            end
+        end
+
+        def self.html
+            strings = ['javascript_include_tag', 'stylesheet_link_tag', '<base', '<img', '<video', '<audio', '<iframe', '<frame', '<frameset', '<object', '<param', '<applet', '<embed', "<input type='image'", "<input type='button'", "<input type='password'", "<input type='file'", 'http-equiv', 'onclick', 'onmouseover']
+
+            results = search_files_in_dir_for File.join('app', 'views'), strings
+            test1 = html_test results
+
+            if test1
+                puts 'AMP-HTML TEST: HTML tests executed without exceptions'
+            else
+                puts 'AMP-HTML TEST: HTML tests have failed. Learn more about AMP format restrictions in HTML: https://github.com/ampproject/amphtml/blob/master/spec/amp-html-format.md#html-tags'
+            end
+        end
+
+        def self.css
+            strings = ['@import', '!important', '-amp-', 'i-amp-', 'behavior', '-moz-binding', 'filter', 'overflow: auto', 'overflow: scroll', 'overflow-x: auto', 'overflow-x: scroll', 'overflow-y: auto', 'overflow-y: scroll']
+
+            results = search_files_in_dir_for File.join('app', 'views'), strings
+            test1 = css_test results
+
+            results = search_files_in_dir_for File.join('app', 'assets', 'stylesheets', 'amp'), strings
+            test2 = css_test results
+
+            if test1 && test2
+                puts 'AMP-HTML TEST: CSS tests executed without exceptions'
+            else
+                puts 'AMP-HTML TEST: CSS tests have failed. Learn more about AMP format restrictions in CSS: https://github.com/ampproject/amphtml/blob/master/spec/amp-html-format.md#stylesheets'
+            end
+        end
+
+        private
+
+        def self.search_files_in_dir_for dir, strings
+
+            # ## OLD SOLUTION
+            #
+            # @results = {}
+            # Dir.foreach(dir) do |file|
+            #     complete_path = File.join(dir, file)
+            #     next if file == '.' or file == '..'
+            #     if File.file?(complete_path)
+            #         # puts "AMP-HTML TEST: Testing '#{complete_path}'"
+            #         line_number = 0
+            #         IO.foreach(complete_path) do |line|
+            #             line_number = line_number + 1
+            #             if strings.any? { |string| line.include?(string) }
+            #                 string = strings.detect { |string| line.include?(string) }
+            #                 source = "=> " + complete_path + ":" + line_number.to_s
+            #                 @results[source] = string
+            #             end
+            #         end
+            #     else
+            #         # Search child directories
+            #         search_files_in_dir_for(complete_path, strings)
+            #     end
+            # end
+
+            require 'pathname'
+            @results = {}
+
+            files, dirs = Pathname.glob(File.join(dir, '**/*')).partition &:file?
+
+            files.each do |file|
+                # puts "AMP-HTML TEST: Testing '#{file}'"
+                line_number = 0
+                IO.foreach(file) do |line|
+                    line_number = line_number + 1
+                    if strings.any? { |string| line.include?(string) }
+                        string = strings.detect { |string| line.include?(string) }
+                        source = '=> ' + [file, line_number].join(':')
+                        @results[source] = string
+                    end
+                end
+            end
+
+            if @results.present?
+                return @results
+            else
+                return nil
+            end
+
+        end
+
+
+        def self.markup_test results
+            if results.present?
+                puts check1 = IO.read(File.join AmpHtml.root, 'amp_html', 'test', 'templates', 'markup', 'meta_viewport.md') unless results.has_value? '<meta name="viewport" content="width=device-width,minimum-scale=1'
+                puts check2 = IO.read(File.join AmpHtml.root, 'amp_html', 'test', 'templates', 'markup', 'head_body.md') unless results.has_value?('<head') || results.has_value? '<body'
+                puts check3 = IO.read(File.join AmpHtml.root, 'amp_html', 'test', 'templates', 'markup', 'amp_html_doctype.md') unless results.has_value? 'amp_html_doctype'
+                puts check4 = IO.read(File.join AmpHtml.root, 'amp_html', 'test', 'templates', 'markup', 'canonical_document_link.md') unless results.has_value? 'canonical_document_link'
+                puts check5 = IO.read(File.join AmpHtml.root, 'amp_html', 'test', 'templates', 'markup', 'amp_head.md') unless results.has_value? 'amp_head'
+                puts check6 = IO.read(File.join AmpHtml.root, 'amp_html', 'test', 'templates', 'markup', 'canonical_document_link.md') if AmpHtml.split_view && results.has_value?('amp_document_link') == false
+            end
+            unless check1 && check2 && check3 && check4 && check5 && check6
+                return true
+            end
+
+            return nil
+        end
+
+
+        def self.html_test results
+            if results.present?
+                results.each do |source, string|
+                    case string
+                    when "<input type='image'" || "<input type='button'" || "<input type='password'" || "<input type='file'"
+                        puts IO.read File.join AmpHtml.root, 'amp_html', 'test', 'templates', 'html', 'input.md'
+                        puts source
+                    else
+                        puts IO.read(File.join AmpHtml.root, 'amp_html', 'test', 'templates', 'html', "#{string.gsub('<', '')}.md")
+                        puts source
+                    end
+                end
+            else
+                return true
+            end
+
+            return nil
+        end
+
+
+        def self.css_test results
+            if results.present?
+                results.each do |source, string|
+                    case string
+                    when 'overflow: auto' || 'overflow: scroll' || 'overflow-x: auto' || 'overflow-x: scroll' || 'overflow-y: auto' || 'overflow-y: scroll'
+                        puts IO.read File.join AmpHtml.root, 'amp_html', 'test', 'templates', 'css', 'overflow.md'
+                        puts source
+                    when '-amp-'
+                        unless source.include? 'application/amp/_resources.html'
+                            puts IO.read File.join AmpHtml.root, 'amp_html', 'test', "templates', 'css', "#{string}.md"
+                            puts source
+                        end
+                    else
+                        puts IO.read File.join AmpHtml.root, 'amp_html', 'test', 'templates', 'css', "#{string}.md"
+                        puts source
+                    end
+                end
+                return true if results.keys.size == 1 && results[results.keys.first] == '-amp-' && results.keys.first.include? 'application/amp/_resources.html'
+            else
+                return true
+            end
+
+            return nil
+        end
+
+    end
+end

data/lib/amp_html/test/help.rb

@@ -0,0 +1,11 @@
+module AmpHtml
+    class Test
+        class Help
+
+            def self.all
+                puts IO.read File.join AmpHtml.root, 'amp_html', 'test', 'templates', 'README.md'
+            end
+
+        end
+    end
+end

data/lib/amp_html/test/templates/README.md

@@ -0,0 +1,43 @@
+
+# AMP-HTML Tests
+
+Test the integration of AMP in your application.
+
+
+## Usage
+
+    amp-html test NAME
+
+
+## Options
+
+`--split` or `-s`: Run tests with `split` if you are using SplitView.
+
+`--help` or `-h`: Run tests with `help` to get additional information on AMP-HTML tests.
+
+---
+
+## Arguments
+
+### all
+Running all tests available.
+
+    amp-html test all
+
+
+### markup
+Testing the markup requirements of AMP.
+
+    amp-html test markup
+
+
+### html
+Testing the format specifications of HTML tags in AMP.
+
+    amp-html test html
+
+
+### css
+Testing the AMP format specifications on CSS stylesheets.
+
+    amp-html test css