Skip to content
Browse files

first commit

  • Loading branch information...
0 parents commit 6b4b29b743095c9d79c30611abb9aafa0a2ec4c0 @lucianopanaro committed Oct 15, 2008
Showing with 394 additions and 0 deletions.
  1. +20 −0 MIT-LICENSE
  2. +12 −0 README
  3. +3 −0 example/application.js
  4. +11 −0 example/config.ru
  5. +43 −0 lib/javascript_minifier.rb
  6. +233 −0 lib/jsmin.rb
  7. +72 −0 spec/javascript_minifier_spec.rb
20 MIT-LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2008 Luciano Germán Panaro
+
+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.
12 README
@@ -0,0 +1,12 @@
+Rack Javascript Minifiert
+=========
+
+A simple middleware that will intercept any request for javascript files, minify
+them and return them.
+
+This was developed as an example of implementing a rack middleware. Even though
+tested (check specs) it is not intended for production.
+
+Check example for usage guide. You can run it with thin:
+
+ thin start -R config.ru
3 example/application.js
@@ -0,0 +1,3 @@
+// This is just a sample javascript file
+alert("Hi there!");
+// If you see any comments then the Javascript Minifier is not working
11 example/config.ru
@@ -0,0 +1,11 @@
+require 'rack/request'
+require 'rack/response'
+require '../lib/javascript_minifier.rb'
+
+app = proc do |env|
+ [200, { 'Content-Type' => 'text/html' }, ['Hi there!'] ]
+end
+
+use Rack::ShowExceptions
+use Rack::JavascriptMinifier, "./"
+run app
43 lib/javascript_minifier.rb
@@ -0,0 +1,43 @@
+require 'time'
+require File.join(File.dirname(__FILE__), 'jsmin.rb')
+
+module Rack
+ class JavascriptMinifier
+ F = ::File
+
+ def initialize(app, path)
+ @app = app
+ @root = F.expand_path(path)
+ raise "Provided path #{@root} does not exist" unless F.directory?(@root)
+ end
+
+ def call(env)
+ path = F.join(@root, Utils.unescape(env["PATH_INFO"]))
+
+ unless path.match(/.*\/(\w+\.js)$/) and F.file?(path)
+ return @app.call(env)
+ end
+
+ if env["PATH_INFO"].include?("..") or !F.readable?(path)
+ body = "Forbidden\n"
+ size = body.respond_to?(:bytesize) ? body.bytesize : body.size
+ return [403, {"Content-Type" => "text/plain","Content-Length" => size.to_s}, [body]]
+ end
+
+ last_modified = F.mtime(path)
+ min_path = F.join(@root, "m_#{last_modified.to_i}_#{F.basename(path)}")
+
+ unless F.file?(min_path)
+ F.open(path, "r") { |file|
+ F.open(min_path, "w") { |f| f.puts JSMin.minify(file) }
+ }
+ end
+
+ [200, {
+ "Last-Modified" => F.mtime(min_path).httpdate,
+ "Content-Type" => "text/javascript",
+ "Content-Length" => F.size(min_path).to_s
+ }, F.new(min_path, "r")]
+ end
+ end
+end
233 lib/jsmin.rb
@@ -0,0 +1,233 @@
+#--
+# jsmin.rb - Ruby implementation of Douglas Crockford's JSMin.
+#
+# This is a port of jsmin.c, and is distributed under the same terms, which are
+# as follows:
+#
+# Copyright (c) 2002 Douglas Crockford (www.crockford.com)
+#
+# 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 shall be used for Good, not Evil.
+#
+# 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.
+#++
+
+require 'strscan'
+
+# = JSMin
+#
+# Ruby implementation of Douglas Crockford's JavaScript minifier, JSMin.
+#
+# Author:: Ryan Grove (mailto:ryan@wonko.com)
+# Version:: 1.0.0 (2008-03-22)
+# Copyright:: Copyright (c) 2008 Ryan Grove. All rights reserved.
+# Website:: http://github.com/rgrove/jsmin/
+#
+# == Example
+#
+# require 'rubygems'
+# require 'jsmin'
+#
+# File.open('example.js', 'r') {|file| puts JSMin.minify(file) }
+#
+module JSMin
+ ORD_LF = "\n"[0].freeze
+ ORD_SPACE = ' '[0].freeze
+
+ class << self
+
+ # Reads JavaScript from +input+ (which can be a String or an IO object) and
+ # returns a String containing minified JS.
+ def minify(input)
+ @js = StringScanner.new(input.is_a?(IO) ? input.read : input.to_s)
+
+ @a = "\n"
+ @b = nil
+ @lookahead = nil
+ @output = ''
+
+ action_get
+
+ while !@a.nil? do
+ case @a
+ when ' '
+ if alphanum?(@b)
+ action_output
+ else
+ action_copy
+ end
+
+ when "\n"
+ if @b == ' '
+ action_get
+ elsif @b =~ /[{\[\(+-]/
+ action_output
+ else
+ if alphanum?(@b)
+ action_output
+ else
+ action_copy
+ end
+ end
+
+ else
+ if @b == ' '
+ if alphanum?(@a)
+ action_output
+ else
+ action_get
+ end
+ elsif @b == "\n"
+ if @a =~ /[}\]\)\\"+-]/
+ action_output
+ else
+ if alphanum?(@a)
+ action_output
+ else
+ action_get
+ end
+ end
+ else
+ action_output
+ end
+ end
+ end
+
+ @output
+ end
+
+ private
+
+ # Corresponds to action(1) in jsmin.c.
+ def action_output
+ @output << @a
+ action_copy
+ end
+
+ # Corresponds to action(2) in jsmin.c.
+ def action_copy
+ @a = @b
+
+ if @a == '\'' || @a == '"'
+ loop do
+ @output << @a
+ @a = get
+
+ break if @a == @b
+
+ if @a[0] <= ORD_LF
+ raise "JSMin parse error: unterminated string literal: #{@a}"
+ end
+
+ if @a == '\\'
+ @output << @a
+ @a = get
+
+ if @a[0] <= ORD_LF
+ raise "JSMin parse error: unterminated string literal: #{@a}"
+ end
+ end
+ end
+ end
+
+ action_get
+ end
+
+ # Corresponds to action(3) in jsmin.c.
+ def action_get
+ @b = nextchar
+
+ if @b == '/' && (@a == "\n" || @a =~ /[\(,=:\[!&|?{};]/)
+ @output << @a
+ @output << @b
+
+ loop do
+ @a = get
+
+ if @a == '/'
+ break
+ elsif @a == '\\'
+ @output << @a
+ @a = get
+ elsif @a[0] <= ORD_LF
+ raise "JSMin parse error: unterminated regular expression " +
+ "literal: #{@a}"
+ end
+
+ @output << @a
+ end
+
+ @b = nextchar
+ end
+ end
+
+ # Returns true if +c+ is a letter, digit, underscore, dollar sign,
+ # backslash, or non-ASCII character.
+ def alphanum?(c)
+ c.is_a?(String) && !c.empty? && (c[0] > 126 || c =~ /[0-9a-z_$\\]/i)
+ end
+
+ # Returns the next character from the input. If the character is a control
+ # character, it will be translated to a space or linefeed.
+ def get
+ c = @lookahead.nil? ? @js.getch : @lookahead
+ @lookahead = nil
+
+ return c if c.nil? || c == "\n" || c[0] >= ORD_SPACE
+ return "\n" if c == "\r"
+ return ' '
+ end
+
+ # Gets the next character, excluding comments.
+ def nextchar
+ c = get
+ return c unless c == '/'
+
+ case peek
+ when '/'
+ loop do
+ c = get
+ return c if c[0] <= ORD_LF
+ end
+
+ when '*'
+ get
+ loop do
+ case get
+ when '*'
+ if peek == '/'
+ get
+ return ' '
+ end
+
+ when nil
+ raise 'JSMin parse error: unterminated comment'
+ end
+ end
+
+ else
+ return c
+ end
+ end
+
+ # Gets the next character without getting it.
+ def peek
+ @lookahead = get
+ end
+ end
+end
72 spec/javascript_minifier_spec.rb
@@ -0,0 +1,72 @@
+require 'fileutils'
+require 'rubygems'
+require 'rack/mock'
+require 'spec'
+require 'javascript_minifier'
+
+DIR_PATH = File.expand_path('public', File.dirname(__FILE__))
+JS_FILE_PATH = File.expand_path('test.js', DIR_PATH)
+JS_PARENT_PATH = File.expand_path('test.js', File.dirname(__FILE__))
+
+describe "Rack::JavascriptMinifier" do
+
+ before(:each) do
+ FileUtils.mkdir DIR_PATH
+ File.open(JS_FILE_PATH, "w") {|f| f.puts "//this is some comment\nalert('hello'); //another comment" }
+ File.open(JS_PARENT_PATH, "w") {|f| f.puts "//this is some comment\nalert('hello'); //another comment" }
+
+ @sample_app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ["Hello"]] }
+ end
+
+ after(:each) do
+ FileUtils.rm_r [JS_FILE_PATH, JS_PARENT_PATH, DIR_PATH]
+ end
+
+ it "should pass requests if file is not javascript" do
+ req = Rack::MockRequest.new(Rack::Lint.new(Rack::JavascriptMinifier.new(@sample_app, DIR_PATH)))
+ res = req.get("/cgi/something/")
+ res.should =~ /Hello/
+ end
+
+ it "should pass requests if javascript file does not exist" do
+ req = Rack::MockRequest.new(Rack::Lint.new(Rack::JavascriptMinifier.new(@sample_app, DIR_PATH)))
+ res = req.get("/cgi/test.js")
+ res.should =~ /Hello/
+ end
+
+ it "should not allow directory traversal" do
+ req = Rack::MockRequest.new(Rack::Lint.new(Rack::JavascriptMinifier.new(@sample_app, DIR_PATH)))
+ res = req.get("/../test.js")
+ res.should be_forbidden
+ end
+
+ it "should minify javascript files when requested" do
+ req = Rack::MockRequest.new(Rack::Lint.new(Rack::JavascriptMinifier.new(@sample_app, DIR_PATH)))
+ res = req.get("/test.js")
+ res.should =~ /alert/
+ res.should_not =~ /comment/
+ end
+
+ it "should re-minify if javascript file was updated" do
+ req = Rack::MockRequest.new(Rack::Lint.new(Rack::JavascriptMinifier.new(@sample_app, DIR_PATH)))
+ updated_time = update_javascript_file(JS_FILE_PATH).httpdate
+ res = req.get("/test.js")
+ res["Last-Modified"].should eql(updated_time)
+ res.should =~ /goodbye/
+ end
+
+ it "should return already minified javascript file it wasn't updated" do
+ req = Rack::MockRequest.new(Rack::Lint.new(Rack::JavascriptMinifier.new(@sample_app, DIR_PATH)))
+ res = req.get("/test.js")
+ Dir.glob(File.join(DIR_PATH,"*_test.js")).size.should == 1
+ res = req.get("/test.js")
+ Dir.glob(File.join(DIR_PATH,"*_test.js")).size.should == 1
+ end
+
+ def update_javascript_file(path)
+ sleep(1)
+ File.open(path, "w") { |file| file.puts "// I am updated now :)\nalert('goodbye!');" }
+ File.mtime(path)
+ end
+
+end

0 comments on commit 6b4b29b

Please sign in to comment.
Something went wrong with that request. Please try again.