jekyll-simple-assets 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95843e3923fd2624c717ab799fe08f4497bd7c7d55febc86b5dd3bbf7ec9d6e7
-  data.tar.gz: 0e93ea72b7a5b06521ec61a7a8264120d1221c0e98a5a86ed426340c188f431f
+  metadata.gz: bbe1fbd068c7784ca4ed4d4ea3777ef10c45a6ed3b960d9fcfdcb843bdff8a1d
+  data.tar.gz: 44b828531c73f697e539740ee38389626d8aa7560316c2fdff63c663b3a26592
 SHA512:
-  metadata.gz: 4307d2592ab2f9885305b2fe23b8fdcdfe86f9e2d2edc41212ba7f1de32b756b054d7fc20273666b64120aac11bdc9256abba9d0d0372a32fa10966d0d798182
-  data.tar.gz: ebcd8ed79fb7d17969a669928fa2e90c957c7f83dbccd6942676d952cb33e00596f483a37cef191e9c1624170511af235ad1888d3a53afb2ce8b3ff64e1794ea
+  metadata.gz: 7749e0e9835f7891e154438f8dddff62be167d2d1ac1102a6c1c999485f653a1b4b7ef057b7983bd630605306d75245c66e9f0b7667b19be178d09079c353c29
+  data.tar.gz: 447cfa3bb7e120ae5c9626e25124202932c6e7c66e8fbeb948d2ab749225850391a346aeb25919e69fd702fbc250f1c06548fc2292e2937f28d3170bd6aadcac

data/README.md

@@ -12,11 +12,11 @@ webpack.
 
 #### contenthash
 
-Returns an (md5) hash based on the contents of the path given.
+Returns a base64 encoded md5 hash based on the contents of the path given.
 
 ```liquid
 {% contenthash assets/js/app.js %}
-// 329CF90732DF0C89EF8FB0B7E9416FE3
+// Mpz5BzLfDInvj7C36UFv4w==
 ```
 
 #### asset
@@ -26,7 +26,7 @@ the file as a query string.
 
 ```liquid
 {% asset assets/js/app.js %}
-// /assets/js/app.js?v=329CF90732DF0C89EF8FB0B7E9416FE3
+// /assets/js/app.js?v=Mpz5BzLfDInvj7C36UFv4w==
 ```
 
 #### bundle
@@ -64,3 +64,23 @@ How the content hashes work is by generating a placeholder string that is
 passed to the template. Once all of the sites files and pages have been
 processed and copied over, the content hashes are worked out, and the
 placeholder string in the pages output is replaced with the hash.
+
+Because of this you need to be careful with using capture tags around or trying
+to manipulate the output of the contenthash or asset tags.
+
+By default the generation of content hashes is only enabled for production
+builds (if JEKYLL_ENV is set to 'production').
+
+## Configuration
+
+```
+simple_assets:
+  # If set to true generation of content hashes will be enabled, even in a non
+  # production build.
+  # default: false
+  hashing_enabled: true
+
+  # The length of the content hashes generated.
+  # default: 16
+  hash_length: 8
+```

data/lib/jekyll-simple-assets.rb

@@ -5,6 +5,22 @@ require 'pathname'
 
 module Jekyll
 	module SimpleAssets
+		def self.site (site)
+			@@site ||= site
+		end
+
+		def self.config
+			@@config ||= @@site.config['simple_assets']
+		end
+
+		def self.hash_length
+			config['hash_length'] || 16
+		end
+
+		def self.hashing_enabled?
+			config['hashing_enabled'] || ENV['JEKYLL_ENV'] == 'production'
+		end
+
 		module SimpleAssetsFilters
 			def md5 (input)
 				Digest::MD5.hexdigest(input)
@@ -13,13 +29,13 @@ module Jekyll
 
 		class BundleTag < Jekyll::Tags::IncludeTag
 			def tag_includes_dirs(context)
-				[ "_js", "_assets" ].freeze
+				[ "_js", "_javascript", "_assets" ].freeze
 			end
 		end
 
 		class BundleRawTag < Jekyll::Tags::IncludeTag
 			def tag_includes_dirs(context)
-				[ "_js", "_assets" ].freeze
+				[ "_js", "_javascript", "_assets" ].freeze
 			end
 
 			def render(context)
@@ -35,9 +51,7 @@ module Jekyll
 
 				return unless File.file? path
 
-				begin
-					content = File.read path
-				end
+				content = File.read path
 
 				content
 			end
@@ -56,11 +70,11 @@ module Jekyll
 		end
 
 		def self.get_placeholder (asset_path)
-			asset_placeholder_map[asset_path] ||= Digest::MD5.hexdigest(asset_path)
+			asset_placeholder_map[asset_path] ||= Digest::MD5.base64digest(asset_path)
 		end
 
-		def self.relative_url (site, path)
-			"#{ site.config['baseurl'] }/#{ path }".gsub(%r{/{2,}}, '/')
+		def self.relative_url (path)
+			"#{ @@site.config['baseurl'] || '' }/#{ path }".gsub(%r{/{2,}}, '/')
 		end
 
 		class AssetTag < Liquid::Tag
@@ -91,7 +105,8 @@ module Jekyll
 			end
 
 			def render (context)
-				site = context.registers[:site]
+				site = SimpleAssets::site(context.registers[:site])
+
 				page = context.environments.first['page']
 
 				args = Shellwords.split(@text)
@@ -100,18 +115,24 @@ module Jekyll
 
 				asset_path = get_value(context, args[0]).sub(/^\//, '')
 
-				if ENV['JEKYLL_ENV'] == 'production'
+				if SimpleAssets::hashing_enabled?
 					SimpleAssets::page_assets_map[page_path] ||= {}
 					SimpleAssets::page_assets_map[page_path][asset_path] ||= {}
 					SimpleAssets::page_assets_map[page_path][asset_path][@type] ||= []
 
 					placeholder = SimpleAssets::get_placeholder(asset_path)
 
-					SimpleAssets::page_assets_map[page_path][asset_path][@type] << placeholder
+					unless SimpleAssets::page_assets_map[page_path][asset_path][@type].include? placeholder
+						SimpleAssets::page_assets_map[page_path][asset_path][@type] << placeholder
+					end
 
 					"#{ @type }::#{ placeholder }"
 				else
-					SimpleAssets::relative_url(site, asset_path)
+					if @type == 'path'
+						SimpleAssets::relative_url(asset_path)
+					else
+						placeholder[0, SimpleAssets::hash_length]
+					end
 				end
 			end
 		end
@@ -161,7 +182,11 @@ module Jekyll
 				Jekyll.logger.warn "SimpleAssets", "#{ asset_path } has no content"
 			end
 
-			SimpleAssets::asset_contenthash_map[asset_path] = Digest::MD5.hexdigest(content)
+			base64hash = Digest::MD5.base64digest(content)
+
+			hash = base64hash[0, SimpleAssets::hash_length]
+
+			SimpleAssets::asset_contenthash_map[asset_path] = hash
 		end
 
 		def self.replace_placeholders_for_asset (doc, site)
@@ -181,16 +206,12 @@ module Jekyll
 						if type == 'path'
 							replacement = "#{ asset_path }?v=#{ replacement }"
 
-							replacement = SimpleAssets::relative_url(site, replacement)
+							replacement = SimpleAssets::relative_url(replacement)
 						end
 
 						placeholder = "#{ type }::#{ SimpleAssets::asset_placeholder_map[asset_path] }"
 
-						if placeholders.size > 1
-							doc.output = doc.output.gsub(placeholder, replacement)
-						else
-							doc.output = doc.output.sub(placeholder, replacement)
-						end
+						doc.output = doc.output.gsub(placeholder, replacement)
 					end
 				end
 			end
@@ -205,27 +226,29 @@ Liquid::Template.register_tag('bundle_raw', Jekyll::SimpleAssets::BundleRawTag)
 
 Liquid::Template.register_filter(Jekyll::SimpleAssets::SimpleAssetsFilters)
 
-if ENV['JEKYLL_ENV'] == 'production'
-	Jekyll::Hooks.register :site, :post_render do |site, payload|
-		potential_assets = []
+Jekyll::Hooks.register :site, :post_render do |site, payload|
+	Jekyll::SimpleAssets::site(site)
 
-		potential_assets += site.pages
-		potential_assets += site.static_files
+	return unless Jekyll::SimpleAssets::hashing_enabled?
 
-		potential_assets.each do |asset|
-			Jekyll::SimpleAssets::resolve_asset_content_hashes(asset, site)
-		end
+	potential_assets = []
 
-		docs = []
+	potential_assets += site.pages
+	potential_assets += site.static_files
 
-		site.pages.each do |doc|
-			Jekyll::SimpleAssets::replace_placeholders_for_asset(doc, site)
-		end
+	potential_assets.each do |asset|
+		Jekyll::SimpleAssets::resolve_asset_content_hashes(asset, site)
+	end
 
-		site.collections.each do |collection_name, collection|
-			collection.docs.each do |doc|
-				Jekyll::SimpleAssets::replace_placeholders_for_asset(doc, site)
-			end
+	docs = []
+
+	site.pages.each do |doc|
+		Jekyll::SimpleAssets::replace_placeholders_for_asset(doc, site)
+	end
+
+	site.collections.each do |collection_name, collection|
+		collection.docs.each do |doc|
+			Jekyll::SimpleAssets::replace_placeholders_for_asset(doc, site)
 		end
 	end
 end

data/lib/jekyll-simple-assets/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
 	module SimpleAssets
-		VERSION = "0.1.0"
+		VERSION = "0.2.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-simple-assets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sophie Askew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll