amp-jekyll 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 689eb915e450435f5e5d471dfe38d57f5253d67a
+  data.tar.gz: 3755eb727d3645a0e3d61214ac18c2a50e6a908a
+SHA512:
+  metadata.gz: b486fba67bf0fca3e5ff677af813f822650ff66f9bd1189e1a6482bb8c8d84f4d5140c7bbac420e3651ce62f71548f8c02489f5768c5f3ca66ee244fd58c6122
+  data.tar.gz: fdaf1a1c8f04dddb9f5d5426ba8f1ed8c2f1143c0300c4fa12b5e132244c38a248eaddf711f52a5038c58c0ec8ddfa211fba647c9ba13e5892e2e9c250b8adf4

data/lib/amp-jekyll.rb

@@ -0,0 +1,2 @@
+require 'amp_generate'
+require 'amp_filter'

data/lib/amp_filter.rb

@@ -0,0 +1,89 @@
+require 'nokogiri'
+require 'fastimage'
+
+module Jekyll
+  module AmpFilter
+    # Filter for HTML 'img' elements.
+    # Converts elements to 'amp-img' and adds additional attributes
+    # Parameters:
+    #   input       - the content of the post
+    #   responsive  - boolean, whether to add layout=responsive, true by default
+    def amp_images(input, responsive = true, wi = nil, he = nil)
+      doc = Nokogiri::HTML.fragment(input);
+      # Add width and height to img elements lacking them
+      doc.css('img:not([width])').each do |image|
+        if wi && he
+          image['width']  = wi
+          image['height'] = he
+        else
+          if image['src'].start_with?('http://', 'https://')
+            src = image['src']
+          else
+            # FastImage doesn't seem to handle local paths when used with Jekyll
+            # so let's just force the path
+            src = File.join(Dir.pwd, '_site', image['src'])
+          end
+          # Jekyll generates static assets after the build process.
+          # This causes problems when trying to determine the dimensions of a locally stored image.
+          # For now, the only solution is to skip the build and generate the AMP files after the site has beem successfully built.
+          # TODO: find a better solution.
+          begin
+            size = FastImage.size(src)
+            image['width']  = size[0]
+            image['height'] = size[1]
+          rescue Exception => e
+            puts 'Unable to get image dimensions for "' + src + '". For local files, build the site with \'--skip-initial-build\' for better results. [Error: ' + e.to_s + ']'
+          end
+        end
+      end
+      # Change 'img' elements to 'amp-img', add responsive attribute when needed
+      doc.css('img').each do |image|
+        image.name = "amp-img"
+
+        image['layout'] = "responsive" if responsive
+      end
+
+      # Picture elements are not accepted in amp pages, convert them to amp-img
+      #<picture>
+      #   <source srcset="mdn-logo-wide.webp" type="image/webp">
+      #   <source srcset="mdn-logo-wide.png" media="(min-width: 600px)">
+      #   <img src="mdn-logo-narrow.png" alt="MDN">
+      #</picture>
+      # Move amp-img elements inside picture elements outside of it and remove picture elements
+      doc.css('picture').each do |picture|
+        # Get img element from picture
+        amp_img = picture.css('amp-img')
+        picture.add_next_sibling(amp_img) unless amp_img.empty?
+
+        # Remove picture element
+        picture.remove
+      end
+
+      # Added <img /> tag wrapped with <noscript /> in case js is not enabled
+      # but image will still show up. The element would look like this:
+      # <amp-img ...>
+      #    <noscript>
+      #        <img ... />
+      #    </noscript>
+      # </ampimg ...>
+      # Duplicate amp-img, remove layout attribut, wrap it with noscript, and add
+      # it as amp-img child
+      doc.css('amp-img').each do |amp_img|
+        noscript = Nokogiri::XML::Node.new "noscript", doc
+
+        noscript_img = amp_img.dup
+        noscript_img.remove_attribute('layout')
+        noscript_img.name = 'img'
+
+        noscript.add_child(noscript_img)
+
+        amp_img.add_child(noscript)
+      end
+
+      # Return the html as plaintext string
+      doc.to_s
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::AmpFilter)

data/lib/amp_generate.rb

@@ -0,0 +1,35 @@
+module Jekyll
+  # Defines the base class of AMP posts
+  class AmpPost < Page
+    def initialize(site, base, dir, post)
+      @site = site
+      @base = base
+      @dir = dir
+      @name = 'index.html'
+      self.process(@name)
+      self.read_yaml(File.join(base, '_layouts'), 'amp.html')
+      self.content               = post.content
+      self.data['body']          = (Liquid::Template.parse post.content).render site.site_payload
+
+      # Merge all data from post so that keys from self.data have higher priority
+      self.data = post.data.merge(self.data)
+
+      # Remove non needed keys from data
+      # Excerpt will cause an error if kept
+      self.data.delete('excerpt')
+
+      self.data['canonical_url'] = post.url
+    end
+  end
+  # Generates a new AMP post for each existing post
+  class AmpGenerator < Generator
+    priority :low
+    def generate(site)
+      dir = site.config['ampdir'] || 'amp'
+      site.posts.docs.each do |post|
+        next if post.data['skip_amp'] == true
+        site.pages << AmpPost.new(site, site.source, File.join(dir, post.id), post)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: amp-jekyll
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juuso Mikkonen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: fastimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: A Jekyll plugin to generate Accelerated Mobile Pages.
+email:
+- hello@juusomikkonen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/amp-jekyll.rb
+- lib/amp_filter.rb
+- lib/amp_generate.rb
+homepage: https://github.com/juusaw/amp-jekyll
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin to generate Accelerated Mobile Pages.
+test_files: []