octopress-ink 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d332939b1e99df733a2015114dc931a31321a69c
-  data.tar.gz: 005708978626fc44397a64f46b459141ff87e6cc
+  metadata.gz: e180ab69ca97fb343d48d3a0665e16ad6c5e6963
+  data.tar.gz: 5e700849429a751dd528724d2be1f504ff500871
 SHA512:
-  metadata.gz: ad20725197851910e57d4f1d3f929a947c8d122345969dffa50bb2559ad51e1fe6070d01a3cd98efc98e09e13c9ce581679f1c94cd2821bf7222c2710c6413e5
-  data.tar.gz: 0240e3c434ca6101c9b8ea35ebd6d85368ed188fcd40afb556d0c53abd34b41a4709377cd88adaf4f96eedc196d06a57643dd1f877a89615c0aa16433b1ae109
+  metadata.gz: 31e72d34e77edd8bee81c158b22e89f93cd9acd81d5e8c59a8f3bc5d47579cbd3f9825ed3170b1b38a5ce77317819acb4ec5798df999e8d5b0c0db717c709542
+  data.tar.gz: 4deec11c178c1331b3276ce878713128aac70a4afd9003ec91e67f2a1063388e38e70e58ebed2a0b75e8019fbf11f85f2fb4ca4c6cdfb44654ffdee981d5ea5b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 1.1.0 (2015-05-03)
+- New: Added support for asynchronous stylesheet loading. [#56](https://github.com/octopress/ink/pull/56)
+- New: Now loading combined javascripts asynchronously by default.
+
 ## 1.0.0 - 2015-05-02
 - Minor: Improved styling for Octopress Ink list command output.
 - Minor: Fixed issue where changelog couldn't be processed by Octopress Docs.

data/assets/js/loadCSS.js

@@ -0,0 +1,52 @@
+/*!
+loadCSS: load a CSS file asynchronously.
+[c]2014 @scottjehl, Filament Group, Inc.
+Licensed MIT
+*/
+
+/* exported loadCSS */
+function loadCSS( href, before, media, callback ){
+	"use strict";
+	// Arguments explained:
+	// `href` is the URL for your CSS file.
+	// `before` optionally defines the element we'll use as a reference for injecting our <link>
+	// By default, `before` uses the first <script> element in the page.
+	// However, since the order in which stylesheets are referenced matters, you might need a more specific location in your document.
+	// If so, pass a different reference element to the `before` argument and it'll insert before that instead
+	// note: `insertBefore` is used instead of `appendChild`, for safety re: http://www.paulirish.com/2011/surefire-dom-element-insertion/
+	var ss = window.document.createElement( "link" );
+	var ref = before || window.document.getElementsByTagName( "script" )[ 0 ];
+	var sheets = window.document.styleSheets;
+	ss.rel = "stylesheet";
+	ss.href = href;
+	// temporarily, set media to something non-matching to ensure it'll fetch without blocking render
+	ss.media = "only x";
+	// DEPRECATED
+	if( callback ) {
+		ss.onload = callback;
+	}
+
+	// inject link
+	ref.parentNode.insertBefore( ss, ref );
+	// This function sets the link's media back to `all` so that the stylesheet applies once it loads
+	// It is designed to poll until document.styleSheets includes the new sheet.
+	ss.onloadcssdefined = function( cb ){
+		var defined;
+		for( var i = 0; i < sheets.length; i++ ){
+			if( sheets[ i ].href && sheets[ i ].href.indexOf( href ) > -1 ){
+				defined = true;
+			}
+		}
+		if( defined ){
+			cb();
+		} else {
+			setTimeout(function() {
+				ss.onloadcssdefined( cb );
+			});
+		}
+	};
+	ss.onloadcssdefined(function() {
+		ss.media = media || "all";
+	});
+	return ss;
+}

data/lib/octopress-ink.rb

@@ -54,7 +54,7 @@ module Octopress
         'plugins'   => config['plugins'],
         'theme'     => config['theme'],
         'octopress' => {
-          'version' => version
+          'version' => version,
         }
       }
 

data/lib/octopress-ink/assets/coffeescript.rb

@@ -2,8 +2,9 @@ module Octopress
   module Ink
     module Assets
       class Coffeescript < Javascript
-        def tag
-          %{<script src="#{Filters.expand_url(File.join(dir, File.basename(file, '.*') << '.js'))}"></script>}
+
+        def tag_path
+          Filters.expand_url(File.join(dir, File.basename(file, '.*') << '.js'))
         end
 
         def add

data/lib/octopress-ink/assets/javascript.rb

@@ -3,7 +3,11 @@ module Octopress
     module Assets
       class Javascript < Asset
         def tag
-          %Q{<script src="#{Filters.expand_url(File.join(dir, file))}"></script>}
+          %Q{<script src="#{tag_path}"></script>}
+        end
+
+        def tag_path
+          Filters.expand_url(File.join(dir, file))
         end
 
         def add

data/lib/octopress-ink/assets/stylesheet.rb

@@ -27,7 +27,11 @@ module Octopress
         end
 
         def tag
-          %Q{<link href="#{Filters.expand_url(File.join(dir, output_file_name))}" media="#{media}" rel="stylesheet" type="text/css">}
+          %Q{<link href="#{tag_path}" media="#{media}" rel="stylesheet" type="text/css">}
+        end
+
+        def tag_path
+          Filters.expand_url(File.join(dir, output_file_name))
         end
 
         def add

data/lib/octopress-ink/configuration.rb

@@ -9,6 +9,8 @@ module Octopress
         'combine_js' => true,
         'compress_js' => true,
         'uglifier' => {},
+        'async_css' => false,
+        'async_js' => true
       },
 
       'date_format' => 'ordinal',

data/lib/octopress-ink/plugin_asset_pipeline.rb

@@ -10,9 +10,9 @@ module Octopress
         @javascripts = nil
         @uglify_settings = nil
         @combined_js = ''
-        @combined_stylesheets = nil
         @stylesheet_fingerprint = {}
         @javascript_fingerprint = nil
+        @uglify_settings ||= Jekyll::Utils.symbolize_hash_keys(Ink.configuration['asset_pipeline']['uglifier'])
       end
 
       # Compile CSS to take advantage of Sass's compression settings
@@ -55,20 +55,60 @@ module Octopress
 
       # Return a link tag, for all plugins' stylesheets
       #
+      def stylesheet_tag
+        if Ink.configuration['asset_pipeline']['async_css']
+          async_stylesheet_tag
+        else
+          combined_stylesheet_tag
+        end
+      end
+
       def combined_stylesheet_tag
         tags = ''
-        combine_stylesheets.keys.each do |media|
-          tags.concat "<link href='#{Filters.expand_url(combined_stylesheet_path(media))}' media='#{media}' rel='stylesheet' type='text/css'>"
+        combined_stylesheet_urls.each do |media, url|
+          tags.concat "<link href='#{url}' media='#{media}' rel='stylesheet' type='text/css'>"
         end
         tags
       end
 
-      def combined_javascript_tag
+      def async_stylesheet_tag
+        js = uglify(File.read(Ink.gem_dir('assets','js','loadCSS.js')))
+        %Q{<script>#{js}\n#{load_css}\n</script>\n<noscript>#{combined_stylesheet_tag}</noscript>}
+      end
+
+      def load_css
+        script = ''
+        combined_stylesheet_urls.each do |media, url|
+          script << %Q{loadCSS("#{url}", null, "#{media}")\n}
+        end
+        script
+      end
+
+      def combined_stylesheet_urls
+        urls = {}
+        combine_stylesheets.keys.each do |media|
+          urls[media] = combined_stylesheet_url(media)
+        end
+        urls
+      end
+
+      def combined_stylesheet_url(media)
+        Filters.expand_url(combined_stylesheet_path(media))
+      end
+
+      def javascript_tag
         unless @combined_js == ''
-          "<script src='#{Filters.expand_url(combined_javascript_path)}'></script>"
+          if Ink.configuration['asset_pipeline']['async_js']
+            "<script async src='#{combined_javascript_url}'></script>"
+          else
+            "<script src='#{combined_javascript_url}'></script>"
+          end
         end
       end
 
+      def combined_javascript_url
+        Filters.expand_url(combined_javascript_path)
+      end
 
       # Combine stylesheets from each plugin
       #
@@ -80,6 +120,7 @@ module Octopress
         @combined_stylesheets ||= begin
           combined = {}
 
+
           stylesheets.clone.each do |media,files|
             files.each do |file|
               header = "/* #{file.plugin.type.capitalize}: #{file.plugin.name} */"
@@ -148,12 +189,10 @@ module Octopress
           javascripts.each do |file|
 
             js = if compress_js?(file)
-              @uglify_settings ||= Jekyll::Utils.symbolize_hash_keys(Ink.configuration['asset_pipeline']['uglifier'])
-
               if cached = Cache.read_cache(file, @uglify_settings)
                 cached
               else
-                js = Uglifier.new(@uglify_settings).compile(file.content)
+                js = uglify(file.content)
                 Cache.write_to_cache(file, js, @uglify_settings)
               end
             else
@@ -172,6 +211,10 @@ module Octopress
         end
       end
 
+      def uglify(js)
+        Uglifier.new(@uglify_settings).compile(js)
+      end
+
       def compress_js?(file)
         Ink.configuration['asset_pipeline']['compress_js'] && !file.path.end_with?('.min.js')
       end

data/lib/octopress-ink/plugins.rb

@@ -1,7 +1,7 @@
 module Octopress
   module Ink
     module Plugins
-      attr_reader :registered
+      attr_reader :registered, :css_asset_paths, :js_asset_paths
       extend self
 
       @registered = false
@@ -150,7 +150,7 @@ module Octopress
 
       def css_tags
         if Ink.configuration['asset_pipeline']['combine_css']
-          PluginAssetPipeline.combined_stylesheet_tag
+          PluginAssetPipeline.stylesheet_tag
         else
           @css_tags.join('')
         end
@@ -158,7 +158,7 @@ module Octopress
 
       def js_tags
         if Ink.configuration['asset_pipeline']['combine_js']
-          PluginAssetPipeline.combined_javascript_tag
+          PluginAssetPipeline.javascript_tag
         else
           @js_tags.join('')
         end

data/lib/octopress-ink/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Ink
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-ink
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-02 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -222,6 +222,7 @@ files:
 - assets/docs/index.markdown
 - assets/docs/plugin-reference.markdown
 - assets/docs/working-with-plugins.markdown
+- assets/js/loadCSS.js
 - lib/octopress-ink.rb
 - lib/octopress-ink/assets.rb
 - lib/octopress-ink/assets/asset.rb