sinatra-support 1.1.3 → 1.2.0

data/HISTORY.md

@@ -1,3 +1,9 @@
+v1.2.0 - May 27, 2011
+---------------------
+
+### Added:
+  * `Sinatra::CompressedJS` for serving compressed JS files
+
 v1.1.3 - May 27, 2011
 ---------------------
 

data/lib/sinatra/support.rb

@@ -14,6 +14,7 @@ module Sinatra
   autoload :I18nSupport,     File.expand_path('../support/i18nsupport', __FILE__)
   autoload :MultiRender,     File.expand_path('../support/multirender', __FILE__)
   autoload :CompassSupport,  File.expand_path('../support/compasssupport', __FILE__)
+  autoload :CompressedJS,    File.expand_path('../support/compressedjs', __FILE__)
 
   module Support
   end

data/lib/sinatra/support/compressedjs.rb

@@ -0,0 +1,244 @@
+# Serves compressed JS.
+#
+# == Usage example
+#
+# Assuming you have JavaScript files stored in +./app/js+, and you want to serve
+# the compressed JS in +http://yoursite.com/js/compressed.js+:
+#
+#   # CompressedJS is recommended to be used alongside JsSupport to serve
+#   # raw JS files in development mode. This will make your /app/js/*.js
+#   # accessible via http://yoursite.com/js/*.js.
+#
+#   register Sinatra::JsSupport
+#   serve_js '/js', from: './app/js'
+#
+# Then load the {CompressedJS} plugin:
+#
+#   register Sinatra::CompressedJS
+#
+#   serve_compressed_js :app_js,          # The name (used later in your views)
+#     :prefix => '/js',                   # Where the individual files can be accessed at
+#     :root   => './app/js',              # The root of your files
+#     :path   => '/js/compressed.js',     # The URL where the compressed JS will served at
+#     :files  =>                          # List of files
+#       Dir['./app/js/vendor/*.js'] +
+#       Dir['./app/js/app/**.js']
+#
+# Note that +:prefix+ and +:root+ are the same things passed onto {JsSupport#serve_js serve_js}.
+#
+# In your template view, add this before +</body>+:
+#
+#   <%= settings.app_js.to_html %>
+#
+# (The name +app_js+ comes from the first parameter passed to
+# {#serve_compressed_js}.)
+#
+# In development mode, this will probably output:
+#
+#   <script src='/js/vendor/jquery.js?1293847189'></script>
+#   <script src='/js/app/application.js?1293847189'></script>
+#   <!-- This is {:prefix} + {files, stripped of :root} -->
+#
+# But in production mode:
+#
+#   <script src='/js/compressed.js?1293847189'></script>
+#   <!-- This is {:path} given in serve_compressed_js -->
+#
+# == Caveats
+#
+# You will need the JsMin gem.
+#
+#   # Gemfile
+#   gem "jsmin", "~> 1.0.1"
+#
+# CompressedJS supports CoffeeScript. If you do use CoffeeScript, be
+# sure to add the approprate gem to your project.
+#
+#   # Gemfile
+#   gem "coffee-script", require: "coffee_script"
+#
+# == Caching
+#
+# CompressedJS will cache compressed and combined scripts. This means that compression
+# will only happen once in your application's runtime.
+#
+# == Why no support for CSS compression?
+#
+# If you use Sass/SCSS anyway, you can achieve the same thing by changing Sass's
+# :output settings to :compressed. If you also use +@import+ in Sass/SCSS, you can
+# easily consolidate all CSS into one file without any need for a Sinatra plugin.
+#
+# == Extending with another JS compressor
+#
+# This is unsupported, but you may change the JsFiles.compress function to use
+# something else.
+#
+#   # Sample custom compression (probably doesn't work)
+#   def JsFiles.compress(str)
+#     file   = Tempfile.new { |f| f.write str }
+#     output = Tempfile.new
+#
+#     system "closure-compiler #{file.path} #{output.path}"
+#     output.read
+#   end
+#
+module Sinatra::CompressedJS
+  def self.registered(app)
+    app.set :jsfiles_cache_max_age, 86400*30  unless app.respond_to?(:jsfile_cache_max_age)
+  end
+
+  def serve_compressed_js(name, options={})
+    jsfiles = JsFiles.new(options)
+
+    set name.to_sym, jsfiles
+
+    serve_jsfiles options[:path], jsfiles
+  end
+
+protected
+  # Adds a route
+  def serve_jsfiles(path, jsfiles)
+    get path do
+      content_type :js
+      last_modified jsfiles.mtime
+      etag jsfiles.mtime.to_i
+      cache_control :public, :must_revalidate, :max_age => settings.jsfiles_cache_max_age
+
+      jsfiles.compressed
+    end
+  end
+end
+
+# A list of JavaScript files.
+#
+# This is a general-purpose class usually used for minification
+# of JS assets.
+#
+# This is often used with Sinatra, but can work with any other
+# web framework.
+#
+# === Usage example
+#
+#   files  = Dir['public/js/jquery.*.js']
+#   files += Dir['public/js/app.*.js']
+#
+#   js_files = JsFiles.new(:files => files,
+#     :prefix => '/javascript',
+#     :root => './app/js')
+#
+#   js_files.mtime  #=> (Time) 2010-09-02 8:00PM
+#
+# You can use #to_html in views:
+#
+#   <!-- Shows <script> tags -->
+#   <%= js_files.to_html %>
+#
+# Getting the data (for rake tasks perhaps):
+#
+#   File.open('public/scripts.js', 'w') do |f|
+#     f << js_files.combined
+#   end
+#
+#   File.open('public/scripts.min.js', 'w') do |f|
+#     f << js_files.compressed
+#   end
+#
+class JsFiles
+  attr_reader :files
+  attr_reader :app
+  attr_reader :prefix
+  attr_reader :root
+  attr_reader :path
+
+  # Creates a JsFiles object based on the list of given files.
+  #
+  # @param files [Array] A list of string file paths.
+  # @example
+  #
+  #   files  = Dir['public/js/jquery.*.js']
+  #   $js_files = JsFiles.new(files)
+  #
+  def initialize(options={})
+    @app    = options[:app]
+    @files  = options[:files]
+    @prefix = options[:prefix] || '/js/'
+    @path   = options[:path] || @prefix + 'app.js'
+    @root   = options[:root] || '/app/js'
+    @root   = File.expand_path(@root)
+
+    raise "Files must be an array"  unless @files.is_a?(Array)
+  end
+
+  # @group Metadata methods
+  
+  # Returns the the modified time of the entire package.
+  #
+  # @return [Time] The last modified time of the most recent file.
+  #
+  def mtime
+    @files.map { |f| File.mtime(f) }.max
+  end
+
+  # Returns a list of the URLs for the package.
+  #
+  # @example
+  #
+  #   -# This is the same as calling #to_html.
+  #   - Main.js_files.hrefs.each do |href|
+  #     %script{:src => href}
+  #
+  def hrefs
+    @files.map { |f|
+      path = File.expand_path(f)
+      path.gsub! /\.[^\.]*$/, ''
+      path.gsub! /^#{@root}/, ''
+      File.join @prefix, path + ".js?#{File.mtime(f).to_i}"
+    }
+  end
+
+  # Returns the <script> tags for the development version.
+  def to_development_html
+    hrefs.map { |href| "<script type='text/javascript' src='#{href}'></script>" }.join("\n")
+  end
+
+  # Returns the <script> tag for the production version.
+  def to_production_html
+    "<script type='text/javascript' src='%s?%s'></script>" % [path, mtime.to_i]
+  end
+
+  # Returns the <script> tags, using development or production as needed.
+  def to_html
+    production? ? to_production_html : to_development_html
+  end
+
+  # @group Output methods
+
+  # Returns the combined source of all the files.
+  def combined
+    @combined ||= @files.map { |file|
+      contents = File.open(file) { |f| f.read }
+      contents = coffee_compile(contents)  if file =~ /\.coffee$/
+      contents
+    }.join("\n")
+  end
+
+  # Returns a combined, minifed source of all the files.
+  def compressed
+    require 'jsmin'
+    @compressed ||= self.class.compress(combined)
+  end
+
+  def self.compress(str)
+    JSMin.minify(str).strip
+  end
+
+protected
+  def coffee_compile(str)
+    require 'coffee_script'  unless defined?(::CoffeeScript)
+    CoffeeScript.compile(str)
+  end
+
+  def production?
+    app && app.production?
+  end
+end

data/lib/sinatra/support/version.rb

@@ -1,6 +1,6 @@
 module Sinatra
   module Support
-    VERSION = "1.1.3"
+    VERSION = "1.2.0"
 
     def self.version
       VERSION

data/test/fixtures/compressed_js/js/hello.js

@@ -0,0 +1 @@
+alert("hello");

data/test/fixtures/compressed_js/js/hi.js

@@ -0,0 +1 @@
+alert("hi");

data/test/fixtures/compressed_js/js/yo.coffee

@@ -0,0 +1 @@
+alert 2

data/test/helper.rb

@@ -19,11 +19,26 @@ class Test::Unit::TestCase
   end
 
   def self.fixture_path(*a)
-    root = File.expand_path('../fixtures', __FILE__)
-    File.join root, a
+    fx *a
   end
 
   def fixture_path(*a)
-    self.class.fixture_path *a
+    fx *a
   end
+
+  def save_and_open_page
+    f = Tempfile.new(['', '.html'])
+    path = f.path
+    f.close!
+    f.unlink
+
+    File.open(path, 'w') { |f| f.write last_response.body }
+
+    system "open \"#{path}\""
+  end
+end
+
+def fx(*a)
+  root = File.expand_path('../fixtures', __FILE__)
+  File.join root, a
 end

data/test/test_compressed_js_app.rb

@@ -0,0 +1,82 @@
+require File.expand_path('../helper', __FILE__)
+
+Encoding.default_external = 'utf-8'
+
+class CompressedJSApp < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  class App < Sinatra::Base
+    register Sinatra::CompressedJS
+    register Sinatra::JsSupport
+
+    serve_js '/js', from: fx('compressed_js/js')
+
+    serve_compressed_js :app_js,
+      :path   => '/js/app.js',
+      :prefix => '/js',
+      :root   => fx('compressed_js/js'),
+      :files  =>
+        Dir[fx('compressed_js/js/*.{js,coffee}')].sort
+
+    get('/to_development_html') { settings.app_js.to_development_html }
+    get('/to_production_html')  { settings.app_js.to_production_html }
+  end
+
+  def app
+    App.new
+  end
+
+  COMPRESSED = "alert(\"hello\");alert(\"hi\");(function(){alert(2);}).call(this);"
+
+  test "JsFiles#files" do
+    assert_equal \
+      Dir[fx('compressed_js/js/*.{js,coffee}')].sort,
+      App.app_js.files
+  end
+
+  test "JsFiles#compressed" do
+    assert_equal COMPRESSED, App.app_js.compressed
+  end
+
+  test "JsFiles#mtime" do
+    assert App.app_js.mtime.to_i > 0
+  end
+
+  test "go" do
+    get '/js/hi.js'
+    control = 'alert("hi");'
+
+    assert_equal control, last_response.body.strip
+  end
+
+  test "coffeescript support" do
+    get '/js/yo.js'
+    control = 'alert(2);';
+
+    assert_equal control, last_response.body.strip
+  end
+
+  test "compressed" do
+    get '/js/app.js'
+    control = COMPRESSED
+
+    assert_equal control, last_response.body.strip
+  end
+
+  test "#to_development_html" do
+    get '/to_development_html'
+
+    control = /<script type='text\/javascript' src='\/js\/hello\.js\?[0-9]+'>/
+    assert_match control, last_response.body
+
+    control = /<script type='text\/javascript' src='\/js\/hi\.js\?[0-9]+'>/
+    assert_match control, last_response.body
+  end
+
+  test "#to_production_html" do
+    get '/to_production_html'
+
+    control = /<script type='text\/javascript' src='\/js\/app\.js\?[0-9]+'>/
+    assert_match control, last_response.body
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: sinatra-support
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors: 
 - Cyril David
@@ -91,6 +91,28 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: coffee-script
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.1
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: jsmin
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+  type: :development
+  version_requirements: *id009
 description: Sinatra-support includes many helpers for forms, errors and many amazing things.
 email: 
 - cyx.ucron@gmail.com
@@ -104,6 +126,7 @@ extra_rdoc_files: []
 files: 
 - lib/sinatra/support/compasssupport.rb
 - lib/sinatra/support/compat-1.8.6.rb
+- lib/sinatra/support/compressedjs.rb
 - lib/sinatra/support/country.rb
 - lib/sinatra/support/countryhelpers.rb
 - lib/sinatra/support/csssupport.rb
@@ -119,6 +142,9 @@ files:
 - lib/sinatra/support/useragenthelpers.rb
 - lib/sinatra/support/version.rb
 - lib/sinatra/support.rb
+- test/fixtures/compressed_js/js/hello.js
+- test/fixtures/compressed_js/js/hi.js
+- test/fixtures/compressed_js/js/yo.coffee
 - test/fixtures/css/style-less.less
 - test/fixtures/css/style-sass.sass
 - test/fixtures/css/style-scss.scss
@@ -131,6 +157,7 @@ files:
 - test/fixtures/multirender/views_2/home.haml
 - test/helper.rb
 - test/test_compass_app.rb
+- test/test_compressed_js_app.rb
 - test/test_country.rb
 - test/test_css.rb
 - test/test_date.rb