hype_assets 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7acb9c7f81fbd8a18575cbb371437c47c7c4fb4
-  data.tar.gz: a804499a07bb63c5617beb2d7389018c55a01cc1
+  metadata.gz: b84085bc71de2a6048ecdce56fc05deb45fec949
+  data.tar.gz: d84ef8991f6d3129826658ecb64721f0036b1628
 SHA512:
-  metadata.gz: f6ce05ab03ad7e33140f2f35c9796552263231adc7e6bfecc52d0e2a4a53a197610e7ab7c9cc6dce2bc037cae566659d425c21588af1767d4ddac5c1e20eea7e
-  data.tar.gz: 3846db8d4ca2b883c868609174bc6fa7de36fafa6c54c5c5df47441544b0b4c32dd29722cf9133ed5c98fe60aa835dc3121a4dd7225db0cef9aa66f91a5bf89f
+  metadata.gz: adbbf4b2865c718822c4d98e34333cf0dcae39f8392cbbe9bd9252cac40c00d7997c78202e9ae30798a693743cfc60e4c9bac18b3379c1785f7a46a3e71fa881
+  data.tar.gz: ad2cfcd14d1364111790e33c17468f6b0558b2142b65a081d3c36e5323029e83a3b42f59f3ad011ffb2360a47fe276721eae28e349351cc1e49b9d6f1b4ed199

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG
 
 
+## 0.1.1  2016-03-28
+* Issue #5: Force a recompile of the `*.hype` file whenever a dependency changes,
+  including an external image file and the gem itself.
+
+
 ## 0.1.0  2016-03-20
 * Milestone: The basic idea is implemented!
   You can now add your .hyperesource folders into the assets folder,

data/README.md

@@ -2,15 +2,26 @@
 
 HypeAssets provides Rails Asset Pipeline integration for Tumult Hype animations.
 
-[Tumult Hype] (http://tumult.com/hype/) is a tool for producing animations and interactive content implemented as HTML5 javascripts and images.  Integrating these into the Rails Asset Pipeline (aka Sprockets) would enable serving these resources from a CDN and versioning them with Digest Fingerprinting.  That integration is, unfortunately, difficult to do.  Rails expects that all file references be encapsulated with asset_path() calls within ERB tags, while Tumult Hype produces a minified javascript file containing image filenames that are concatenated onto a base URL.
+[Tumult Hype](http://tumult.com/hype/) is a tool for producing animations and
+interactive content implemented as HTML5 javascripts and images.  Integrating these
+into the
+[Rails Asset Pipeline](http://guides.rubyonrails.org/asset_pipeline.html)
+would enable serving these resources from a
+[CDN](http://guides.rubyonrails.org/asset_pipeline.html#cdns)
+and versioning them with
+[Digest Fingerprinting](http://guides.rubyonrails.org/asset_pipeline.html#what-is-fingerprinting-and-why-should-i-care-questionmark).
+That integration is, unfortunately, difficult to do.
+Rails expects that all file references be encapsulated with `asset_path()` calls within
+[ERB](http://guides.rubyonrails.org/asset_pipeline.html#javascript-coffeescript-and-erb)
+tags, while Tumult Hype produces a minified javascript file containing image filenames
+that are each concatenated client-side onto a single base URL.
 
 HypeAssets makes Rails Asset Pipeline integration easy by automatically modifying the foo_hype_generated_script.js file with the correct file references.
 
 
-
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application‘s Gemfile:
 
 ```ruby
 gem 'hype_assets'
@@ -18,7 +29,8 @@ gem 'hype_assets'
 
 And then execute:
 
-    $ bundle
+	$ bundle
+
 
 
 
@@ -30,15 +42,18 @@ And then execute:
 
 3. Append a `.hype` extension to your hype scripts:
 
+	```
 	$ cd app/assets/hype/foo.hyperesources
 	$ mv foo_hype_generated_script.js foo_hype_generated_script.js.hype
+	```
 
-   NOTE: Do NOT rename your other javascript files, e.g. HYPE-123.full.min.js.
+	NOTE: Do NOT rename your other javascript files, e.g. HYPE-123.full.min.js.
 
 4. In your HTML, reference your hype animation script with
 
+	```
 	<%= javascript_include_tag "foo.hyperesources/foo_hype_generated_script.js" %>
-
+	```
 
 
 ## Contributing

data/lib/hype_assets/hype_template.rb

@@ -1,14 +1,33 @@
 class HypeAssets::HypeTemplate
 
+
+	def self.cache_key
+	### Sprockets stores our processor's cache key along with the compiled asset.
+	### If we change the key, the compiled asset is invalidated and recompiled.
+	### Grep for @cache_key within the sprockets gem for examples of its definition.
+	### Things we might include here:
+	###   * gem or class name
+	###   * gem version
+	###   * version of any external libraries used
+	###   * configuration options, as `DigestUtils.digest(options)`
+		@cache_key ||= "#{name}:#{::HypeAssets::VERSION}"
+	end
+
+
 	def self.call (input)
 	### Massage the raw foo.hyperesources/foo_hype_generated_script.js.hype file
-	### to use digested filenames, stored potentially on a CDN.
-	### @input [Hash] See http://www.rubydoc.info/gems/sprockets/3.5.2#Processor_Interface
+	###   to use digested filenames, stored potentially on a CDN.
+	### @param input [Hash] See http://www.rubydoc.info/gems/sprockets/3.5.2#Processor_Interface
 	###   for a description of input's fields.
-	### @returns [String or Hash] see sprockets README
-puts "HypeAssets: Processing #{input[:name]} @ #{Time.now}"
-		hype_script = input[:data]
-		folder = nil
+	### @return [Hash] :data is the post-processed content.   All other fields are merged into the :metadata hash.  See lib/sprockets/processor_utils.rb#call_processors()
+
+		hype_script  = input[:data]
+		sprockets    = input[:environment]
+		dependencies = Set.new(input[:metadata][:dependencies])  # may be nil
+		folder       = nil
+
+		sprockets.logger.info "HypeAssets: Processing #{input[:name]} @ #{Time.now}"
+
 
 		## THE BASE URL:
 		## Replace: var f="animation_name.hyperesources"
@@ -25,8 +44,8 @@ puts "HypeAssets: Processing #{input[:name]} @ #{Time.now}"
 		## Replace: "HYPE-466.full.min.js":"HYPE-466.thin.min.js"
 		## With:    "HYPE-466.full.min-1234567890abcdef.js":"HYPE-466.thin.min-1234567890abcdef.js"
 		hype_script.sub!(/"(HYPE-\d+.full.min.js)":"(HYPE-\d+.thin.min.js)"/) {
-			full = digested_asset_filename "#{folder}/#{$1}"
-			thin = digested_asset_filename "#{folder}/#{$2}"
+			full = digested_asset_filename "#{folder}/#{$1}", dependencies, sprockets
+			thin = digested_asset_filename "#{folder}/#{$2}", dependencies, sprockets
 			%Q["#{full}":"#{thin}"]
 		}
 
@@ -43,19 +62,28 @@ puts "HypeAssets: Processing #{input[:name]} @ #{Time.now}"
 		##   argument to `new HYPE_466()`.   Of course, that could change from version to version
 		##   of Hype!
 		hype_script.gsub!(/\bn:"([^"]+\.[^"]+)"/) {
-			n = digested_asset_filename "#{folder}/#{$1}"
+			n = digested_asset_filename "#{folder}/#{$1}", dependencies, sprockets
 			%Q[n:"#{n}"]
 		}
 
-		"// Pre-Processed with HypeAssets v#{::HypeAssets::VERSION} @ #{Time.now}\n#{hype_script}"
+		hype_script = "// Pre-Processed with HypeAssets v#{::HypeAssets::VERSION} @ #{Time.now}\n #{hype_script}"
+
+
+		{
+			data:  hype_script,
+			dependencies: dependencies,
+		}
 	end
 
 
-	def self.digested_asset_filename (resource)
-	### @returns the digested version of an asset's filename.
-	### It returns *just* the filename itself (i.e. the basename),
-	### since Hype's script internally concatenates the filename
-	### onto a base URL.
+	def self.digested_asset_filename (resource, dependencies, sprockets)
+	### @param resource [String] uri-encoded asset, e.g. "folder/file%402x.jpg"
+	### @param dependencies [Set] (mutated) resource is added to the set
+	### @param sprockets [Sprockets::Environment] needed for its helper functions
+	### @return digested version of the asset's filename.
+	###         Returns *just* the filename itself (i.e. the basename),
+	###         since Hype's script internally concatenates the filename
+	###         onto a base URL.
 		### NOTE: The Hype *_hype_generated_script.js percent-encodes the filename.
 		### Incidentally, it encodes `@`, even though this is a safe character, AFAICT.
 		### URI.encode does *not* re-encode the `@`, but that doesn't seem to break things.
@@ -64,6 +92,23 @@ puts "HypeAssets: Processing #{input[:name]} @ #{Time.now}"
 		digested_path    = digest_path   decoded_resource
 		basename         = File.basename digested_path
 		re_encoded_name  = URI.encode    basename
+
+
+		## Ensure our .hype file will be recompiled if any of our images change.
+		## The Sprockets documentation is sorely lacking in explaining how to do this.
+		## From experimentation, we need an absolute file-digest:// URI:
+		##    "file-digest:///absolute/path/to/foo.hyperesources/file"
+		## Anything less will be silently ignored, including:
+		##    "foo.hyperesources/file"
+		##    "file-digest:///foo.hyperesources/file"
+		##    "/absolute/path/to/foo.hyperesources/file"
+		absolute_path = sprockets.resolve(decoded_resource)
+		file_digest_uri = sprockets.build_file_digest_uri(absolute_path)
+			## NOTE: build_file_digest_uri just tacks on a file-digest:// prefix.
+			## It does //not// generate a digest hashcode.
+		dependencies << file_digest_uri
+
+		re_encoded_name
 	end
 
 

data/lib/hype_assets/version.rb

@@ -1,6 +1,3 @@
 module HypeAssets
-	VERSION = "0.1.0"
+	VERSION = "0.1.1"
 end
-
-
-## TODO: Find a way to force a recompile of the *.hype files whenever HypeAssets::VERSION is bumped

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hype_assets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Noach Magedman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-21 00:00:00.000000000 Z
+date: 2016-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler