hype_assets 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62ec5f515f9341a1f3e50f24dda60caf22b6de88
-  data.tar.gz: b0163cd6546514e59de9bd6870ba663691aa8c3e
+  metadata.gz: c7acb9c7f81fbd8a18575cbb371437c47c7c4fb4
+  data.tar.gz: a804499a07bb63c5617beb2d7389018c55a01cc1
 SHA512:
-  metadata.gz: 940d55c356cac5484ecb04b13ffcf272a35510a3803b29ba320eb3ca59619097d17fe29f13ee6f8261f2036369d85520d7e838e77dca6851904763b32eaeb6a7
-  data.tar.gz: e16e279278724026325a28e9d956a2da2875c0351462954e8ccba98bd23806b47eab9e51d4e354a514bc40c8587bb4a53c64a07bc185195d1d7c24b950a7f6f0
+  metadata.gz: f6ce05ab03ad7e33140f2f35c9796552263231adc7e6bfecc52d0e2a4a53a197610e7ab7c9cc6dce2bc037cae566659d425c21588af1767d4ddac5c1e20eea7e
+  data.tar.gz: 3846db8d4ca2b883c868609174bc6fa7de36fafa6c54c5c5df47441544b0b4c32dd29722cf9133ed5c98fe60aa835dc3121a4dd7225db0cef9aa66f91a5bf89f

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# CHANGELOG
+
+
+## 0.1.0  2016-03-20
+* Milestone: The basic idea is implemented!
+  You can now add your .hyperesource folders into the assets folder,
+  renaming the hype_generated_script.js to hype_generated_script.js.hype,
+  and we handle the rest: precompiling, registering the handler, and
+  Rails pipelining the hype_generated_script.js image references.
+
+
+## 0.0.3  2016-03-20
+* Add the Hype scripts to the the Rails assets precompile array.
+  This unfortunately binds us to Rails.   I was hoping to be
+  Framework-agnostic, being generically Sprockets, but Sprockets
+  alone doesn't seem to have a pre-compile concept, AFAICT.
+
+
+## 0.0.2  2016-03-17
+* Ensure we have the digested version of the filename, by calling find_asset()
+
+
+## 0.0.1  2016-03-16
+* Switch from Sprockets 2.x-style Tilt interface to 3.x-style Rack interface
+* Record the version/timestamp in the .js output and the logs
+
+
+## 0.0.0  2016-03-15
+* initial implementation of preprocessor
+* registers .hype files with Sprockets

data/LICENSE.txt

@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) 2016 Noach Magedman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+Text copied from http://choosealicense.com/licenses/mit/
+See also https://opensource.org/licenses/MIT

data/README.md

@@ -1,8 +1,12 @@
 # HypeAssets
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hype_assets`. To experiment with that code, run `bin/console` for an interactive prompt.
+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.
+
+HypeAssets makes Rails Asset Pipeline integration easy by automatically modifying the foo_hype_generated_script.js file with the correct file references.
+
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -16,21 +20,32 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
 
-    $ gem install hype_assets
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Create a folder for your hype animations.   I recommend `app/assets/hype`, but any folder in your assets search path will do.
+
+2. Copy your `foo.hyperesources` folders into that folder.
+
+3. Append a `.hype` extension to your hype scripts:
 
-## Development
+	$ 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.
+
+4. In your HTML, reference your hype animation script with
+
+	<%= javascript_include_tag "foo.hyperesources/foo_hype_generated_script.js" %>
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hype_assets.
+Bug reports, pull requests, and general feedback are welcome on GitHub at https://github.com/nmagedman/hype_assets/issues.
+
+
+## License
 
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/hype_assets.gemspec

@@ -9,9 +9,10 @@ Gem::Specification.new do |spec|
 	spec.authors       = ["Noach Magedman"]
 	spec.email         = ["nmagedman@gmail.com"]
 
-	spec.summary       = %q{Integrate Tumult Hype animation files into the Asset Pipeline}
+	spec.summary       = %q{Integrate Tumult Hype animation files into the Rails Asset Pipeline}
 	spec.description   = %q{Append `.hype` to your hype_generated_script.js and we take care of the rest!}
 	spec.homepage      = "https://github.com/nmagedman/hype_assets"
+	spec.license       = "MIT"
 
 	spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
 	spec.bindir        = "exe"
@@ -22,8 +23,6 @@ Gem::Specification.new do |spec|
 	spec.add_development_dependency "rake", "~> 10.0"
 	spec.add_development_dependency "rspec", "~> 3.0"
 
-	### Tilt has been DEPRECATED.  NOW they tell me.....
-	spec.add_runtime_dependency 'tilt', '~> 2.0'  # baseclass for Sprockets preprocessors
-
 	spec.add_runtime_dependency 'sprockets', '~> 3.0'
+	spec.add_runtime_dependency 'rails', '~> 4.0'
 end

data/lib/hype_assets/hype_template.rb

@@ -1,32 +1,19 @@
-require 'tilt'
-
-class HypeAssets::HypeTemplate < ::Tilt::Template
-
-	def asset_url (resource)
-	### Wrapper function around the Sprockets helper,
-	### since it's not clear how best to invoke it.
-		ApplicationController.helpers.asset_url resource
-	end
-
-
-	def prepare
-		## Apparently this *must* be defined explicitly.
-		## There is no default no-op implementation.
-	end
-
-
-	def evaluate (scope, locals)
-		## The original *_hype_generated_script.js.hype file is
-		## slurped into `data`, defined by ::Tilt::Template.
-		## Massage it to include the digested/CDN'd filenames,
-		## and return it.
-
+class HypeAssets::HypeTemplate
+
+	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
+	###   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
 
 		## THE BASE URL:
 		## Replace: var f="animation_name.hyperesources"
 		## With:    var f="https://my.cdn.com/assets/animation_name.hyperesources"
-		data.sub!(/var f="([^"]+)"/) {
+		hype_script.sub!(/var f="([^"]+)"/) {
 			folder = $1
 			## TODO: Don't hardcode `assets`.  Get it dynamically from the config.
 			path = asset_url "assets/#{folder}"
@@ -37,7 +24,7 @@ class HypeAssets::HypeTemplate < ::Tilt::Template
 		## 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"
-		data.sub!(/"(HYPE-\d+.full.min.js)":"(HYPE-\d+.thin.min.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}"
 			%Q["#{full}":"#{thin}"]
@@ -55,16 +42,16 @@ class HypeAssets::HypeTemplate < ::Tilt::Template
 		##   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!
-		data.gsub!(/\bn:"([^"]+\.[^"]+)"/) {
+		hype_script.gsub!(/\bn:"([^"]+\.[^"]+)"/) {
 			n = digested_asset_filename "#{folder}/#{$1}"
 			%Q[n:"#{n}"]
 		}
 
-		"// Pre-Processed with HypeAssets::HypeTemplate\n" + data
+		"// Pre-Processed with HypeAssets v#{::HypeAssets::VERSION} @ #{Time.now}\n#{hype_script}"
 	end
 
 
-	def digested_asset_filename (resource)
+	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
@@ -73,18 +60,25 @@ class HypeAssets::HypeTemplate < ::Tilt::Template
 		### 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.
 
-		## Not sure which code arrangement is easiest to read:
+		decoded_resource = URI.decode    resource
+		digested_path    = digest_path   decoded_resource
+		basename         = File.basename digested_path
+		re_encoded_name  = URI.encode    basename
+	end
 
-		## Individual steps:
-		# decoded_resource = URI.decode resource
-		# path             = ApplicationHelper.asset_path decoded_resource
-		# basename         = File.basename path
-		# re_encoded_name  = URI.encode basename
 
-		## Chained:
-		# URI.encode(File.basename(asset_url(URI.decode(resource))))
+	def self.asset_url (resource)
+	### Wrapper function around the Sprockets helper,
+	### since it's not clear how best to invoke it.
+		ApplicationController.helpers.asset_url resource
+	end
+
 
-		## Chained without parens:
-		URI.encode File.basename asset_url URI.decode resource
+	def self.digest_path (resource)
+	### Wrapper function around the Sprockets helper,
+	### since it's not clear how best to invoke it.
+		## To ensure we have the digested version of the filename,
+		## we have to load the Sprockets::Asset into memory.
+		Rails.application.assets.find_asset(resource).digest_path
 	end
 end

data/lib/hype_assets/version.rb

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

data/lib/hype_assets.rb

@@ -1,6 +1,14 @@
 require "hype_assets/version"
 require "hype_assets/hype_template"
 require "sprockets"
+require "rails"
 
-Sprockets::Engines #force autoloading.   Necessary?
+
+## Register *_hype_generated_script.js.hype files to be processed by us
 Sprockets.register_engine '.hype', ::HypeAssets::HypeTemplate
+
+## Add hype files (`*.hyperesources/*.js`) to assets precompile array
+Rails::Application.initializer "hype_assets" do
+	Rails.logger.info "HypeAssets: Adding hype files (`*.hyperesources/*.js`) to assets precompile array"
+	Rails.application.config.assets.precompile += %w[ *.hyperesources/*.js ]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hype_assets
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Noach Magedman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2016-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: tilt
+  name: sprockets
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: sprockets
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 description: Append `.hype` to your hype_generated_script.js and we take care of the
   rest!
 email:
@@ -91,7 +91,9 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -101,7 +103,8 @@ files:
 - lib/hype_assets/hype_template.rb
 - lib/hype_assets/version.rb
 homepage: https://github.com/nmagedman/hype_assets
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -122,5 +125,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Integrate Tumult Hype animation files into the Asset Pipeline
+summary: Integrate Tumult Hype animation files into the Rails Asset Pipeline
 test_files: []