hype_assets 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b00ade57237e52fa9d1e5d825d26764fb2db8608
-  data.tar.gz: d1a88def8bf8b20ae2f3701daebf9337037b342d
+  metadata.gz: 5e73d28dec85b95e5a21604c67afbbee50165cf0
+  data.tar.gz: 2641f8ae58b6e025a6d8c7f7aff0fa43a7639da5
 SHA512:
-  metadata.gz: f44868b120e819bf472f0eec3c08c47511b68fc55c0beffbaa5c011ff6c84c49874543300b17b2eb040c9453177574dc5a9a5963b75f8b06617f114e1d4dc502
-  data.tar.gz: b3cf8254661f932d77f0d4abe4b645159627463f2595202a0f53079c27568966d215492d253729ebd759abd66a53be9cbeb776243b7248a17e60dad7f8326e7e
+  metadata.gz: 776362fdb6abc047284f35f4cce7ea2bfe7e9c45dd9ea0f5870b30bc0fd27f7f103cd3367ebd5b89035fe3c5189476070dd1efe965b5b3419ca448f1c01ea64f
+  data.tar.gz: 58f724f9b1c2008e1f36dd211e409c7b2e5bf83a86aba9aa3e2415b73a76168706f8d00d1868b242b60c287e485c1e6309d485fbef8b310cea3016e072d90efa

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 0.2.0  2016-04-03
+* Issue #3: Support HYPE-5xx scripts.  i.e. Avoid relying on specific
+  variable names in the hype_generated_script
+* Issue #1: Support embedded fonts
+
+
 ## 0.1.3  2016-03-28
 * Issue #4: Don't hardcode `assets`.  Get it dynamically from the config.
   OK, we're using Sprockets directly now (not Rails).  The docs

data/README.md

@@ -1,6 +1,6 @@
 # HypeAssets
 
-HypeAssets provides Rails Asset Pipeline integration for Tumult Hype animations.
+HypeAssets provides Rails Asset Pipeline integration for Tumult Hype 3 animations.
 
 [Tumult Hype](http://tumult.com/hype/) is a tool for producing animations and
 interactive content implemented as HTML5 javascripts and images.  Integrating these
@@ -19,6 +19,12 @@ 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.
 
 
+## Requirements
+HypeAssets is designed to work with animations built with Tumult Hype version 3, using HYPE-4xx or HYPE-5xx runtime scripts. (It has been tested with HYPE-456, HYPE-466, and HYPE-526.)
+
+It also requires Sprockets 3.x, as they redesigned their asset processor API.
+
+
 ## Installation
 
 Add this line to your application‘s Gemfile:
@@ -60,6 +66,8 @@ And then execute:
 
 Bug reports, pull requests, and general feedback are welcome on GitHub at https://github.com/nmagedman/hype_assets/issues.
 
+If your hype animation works when run from a static page but fails when run via HypeAssets, please send me a zip of the `foo.hyperesources` folder and a `foo.html` container page.  Attach it to the github issue or email it to `nmagedman+hype@gmail.com`.
+
 
 ## License
 

data/hype_assets.gemspec

@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
 	spec.require_paths = ["lib"]
 
-	spec.add_development_dependency "bundler", "~> 1.11"
-	spec.add_development_dependency "rake", "~> 10.0"
-	spec.add_development_dependency "rspec", "~> 3.0"
+	spec.add_development_dependency "bundler", ">= 1.11"
+	spec.add_development_dependency "rake", ">= 10.0"
+	spec.add_development_dependency "rspec", ">= 3.0"
 
-	spec.add_runtime_dependency 'sprockets', '~> 3.0'
+	spec.add_runtime_dependency 'sprockets', '~> 3.0' # 2.x used the Tilt interface
 	spec.add_runtime_dependency 'rails', '~> 4.0'
 end

data/lib/hype_assets/hype_template.rb

@@ -24,7 +24,8 @@ class HypeAssets::HypeTemplate
 		hype_script  = input[:data]
 		sprockets    = input[:environment]
 		dependencies = Set.new(input[:metadata][:dependencies])  # may be nil
-		folder       = nil
+		folder       = nil  # => animation_name.hyperesources
+		base_url     = nil  # => https://my.cdn.com/assets/animation_name.hyperesources
 
 		sprockets.logger.info "HypeAssets: Processing #{input[:name]} @ #{Time.now}"
 
@@ -32,45 +33,82 @@ class HypeAssets::HypeTemplate
 		## THE BASE URL:
 		## Replace: var f="animation_name.hyperesources"
 		## With:    var f="https://my.cdn.com/assets/animation_name.hyperesources"
-		hype_script.sub!(/var f="([^"]+)"/) {
+		## NOTE: In HYPE-4xx this variable was called f.   In HYPE-5xx it's called h.
+		## We should be varname agnostic.  In any case, it is the first (and only?)
+		## instance of a string ending in `.hyperesources`.
+		## We can assume that it will continue to  be a variable assignment.
+		hype_script.sub!(/="([^"]+\.hyperesources)"/) {
 			folder     = $1
+
 			asset_host = sprockets.context_class.config.asset_host  # shouldn't end in /
 			prefix     = sprockets.context_class.assets_prefix      # begins with /
-
-			url = "#{asset_host}#{prefix}/#{folder}"
-			%Q[var f="#{url}"]
+			base_url   = "#{asset_host}#{prefix}/#{folder}"
+			%Q[="#{base_url}"]
 		}
 
 
 		## The HYPE Library:
-		## 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}", dependencies, sprockets
-			thin = digested_asset_filename "#{folder}/#{$2}", dependencies, sprockets
-			%Q["#{full}":"#{thin}"]
+		## 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 $1, folder, dependencies, sprockets
+			thin = digested_asset_filename $2, folder, dependencies, sprockets
+			%Q[?"#{full}":"#{thin}"]
 		}
 
 
 		## INDIVIDUAL FILENAMES:
 		## Replace: n:"my_image.png"
 		## With:    n:"my_image-1234567890abcdef.png"
-		## TODO: A big difficulty here is choosing which instances of `n:""` to modify:
-		##   n is used both for filenames and for free-form, scene names.
-		##   Currently, I assume the filenames have a dot (reasonable, because they have extensions)
-		##   and that scene names do not (not so reasonable, since a human types them in).
-		##   With tighter pattern matching, we may be able to support scene-names containing dots.
-		##   For example, all the filenames are grouped together in a hash which is the third
-		##   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}", dependencies, sprockets
-			%Q[n:"#{n}"]
+		##
+		## We should be varname agnostic, as Tumult might rename the hash keys.
+		## That means we will be checking every hash value string to see if it's
+		## a file.   Only consider strings that _look_ like filenames.
+		## And tolerate failed lookups gracefully -- treat them as non-file strings.
+		hype_script.gsub!(/(^|[,{])(\w+):"([\w\-%]++\.[\w\-%.]++)"/) {
+			preamble = $1  # a hashkey will only follow a curly brace, comma, or newline
+			hashkey  = $2
+			filename = $3  # Hype URL-encodes pretty agressively.  Must have 1+ dots.
+
+			daf = digested_asset_filename filename, folder, dependencies, sprockets
+			if daf
+				%Q[#{preamble}#{hashkey}:"#{daf}"]
+			else
+				$&  # if anything goes wrong, just leave everything untouched.
+			end
 		}
 
-		hype_script = "// Pre-Processed with HypeAssets v#{::HypeAssets::VERSION} @ #{Time.now}\n #{hype_script}"
+		## CSS FONT-FACE DATA:
+		## Replace: url('animation_name.hyperesources/custom_font.svg#fontname')
+		## With:    url('https://my.cdn.com/assets/animation_name.hyperesources/custom_font-12345.svg#fontname')
+		## The CSS `<style>` tag and its content are inserted into the page dynamically.
+		## The code is apparently typed into the Hype editor manually
+		## (although I couldn't find it).
+		## So realize that the syntax will be more inconsistent than the rest of the file.
+		## e.g. url() strings may be single-quoted, double-quoted, or not quoted at all.
+		## Nonetheless, the entire injected content is stored as a double-quoted string,
+		## so "whitespace" (other than spaces) will appear as \t, \n, or \r.
+		##
+		## For now, the only URL path we will support is `foo.hyperesources/filename`
+		hype_script.gsub!(
+			/(\b|\\[tnr])url\(('|\\")?#{Regexp.quote folder}\/([\w\-%.]++)([?#].*?)?\2\)/
+		) {
+			preamble   = $1  # leading whitespace
+			quote      = $2  # single, double, or nothing
+			filename   = $3  # URL-encoded?
+			extra_junk = $4  # svg fonts need a #fontname fragment.  And IE needs a hack, of course.
+
+			daf = digested_asset_filename filename, folder, dependencies, sprockets
+			if daf
+				%Q[#{preamble}url(#{quote}#{base_url}/#{daf}#{extra_junk}#{quote})]
+			else
+				$&  # if anything goes wrong, just leave everything untouched.
+			end
+		}
 
 
+		hype_script = "// Pre-Processed with HypeAssets v#{::HypeAssets::VERSION} @ #{Time.now}\n#{hype_script}"
+
 		{
 			data:  hype_script,
 			dependencies: dependencies,
@@ -78,7 +116,7 @@ class HypeAssets::HypeTemplate
 	end
 
 
-	def self.digested_asset_filename (resource, dependencies, sprockets)
+	def self.digested_asset_filename (filename, folder, 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
@@ -90,8 +128,10 @@ class HypeAssets::HypeTemplate
 		### 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.
 
-		decoded_resource = URI.decode    resource
-		digested_path    = digest_path   decoded_resource
+
+		decoded_filename = URI.decode    filename
+		resource         = "#{folder}/#{decoded_filename}"
+		digested_path    = digest_path   resource
 		basename         = File.basename digested_path
 		re_encoded_name  = URI.encode    basename
 
@@ -104,17 +144,20 @@ class HypeAssets::HypeTemplate
 		##    "foo.hyperesources/file"
 		##    "file-digest:///foo.hyperesources/file"
 		##    "/absolute/path/to/foo.hyperesources/file"
-		absolute_path   = sprockets.resolve(decoded_resource)
+		absolute_path   = sprockets.resolve(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
+	rescue NoMethodError => e
+		puts "HypeAssets: Unable to locate/process asset: #{resource}"
 	end
 
 
 	def self.asset_url (resource)
+	### UNUSED.  I'm generating the base URL via the context_class now.
 	### Wrapper function around the Sprockets helper,
 	### since it's not clear how best to invoke it.
 		ApplicationController.helpers.asset_url resource

data/lib/hype_assets/version.rb

@@ -1,3 +1,3 @@
 module HypeAssets
-	VERSION = "0.1.3"
+	VERSION = "0.2.0"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: hype_assets
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Noach Magedman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency