newjs 1.0.0

data/bin/newjs

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby -wKU
+
+require 'rubygems'
+require 'rubigen'
+
+if %w(-v --version).include? ARGV.first
+  require 'newjs/version'
+  puts "#{File.basename($0)} #{Newjs::VERSION::STRING}"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+source = RubiGen::PathSource.new(:application, 
+  File.join(File.dirname(__FILE__), "../app_generators"))
+RubiGen::Base.reset_sources
+RubiGen::Base.append_sources source
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'newjs')

data/config/hoe.rb

@@ -0,0 +1,75 @@
+require 'newjs/version'
+
+AUTHOR = 'Dr Nic Williams'  # can also be an array of Authors
+EMAIL = "drnicwilliams@gmail.com"
+GEM_NAME = 'newjs' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'newjs' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Newjs::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'newjs documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = p.paragraphs_of("README.txt", 0..2).join("\n\n")
+  p.summary = p.paragraphs_of("README.txt", 0..0).join("\n\n")
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [
+    ['hoe', '>=1.5.0'],
+    ['RedCloth','>=3.0.4'],
+    ['syntax','>=1.0.0'],
+    ['activesupport','>=2.0.2'],
+    ['rubigen','>=1.2.0']
+  ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'newjs'

data/javascript_test_generators/javascript_test/USAGE

@@ -0,0 +1,2 @@
+Description:
+  Creates an HTML test file for a JavaScript library.

data/javascript_test_generators/javascript_test/javascript_test_generator.rb

@@ -0,0 +1,54 @@
+class JavascriptTestGenerator < RubiGen::Base
+  
+  attr_reader :name, :library_name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    @library_name = args.shift || name
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'test'
+
+      # Create stubs
+      m.template "test/test.html.erb",  "test/#{name}_test.html"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates an HTML test file for a JavaScript library.
+
+USAGE: #{$0} #{spec.name} name [library_name]"
+
+NOTES:
+* name - creates a file test/name_test.html
+* library_name - is for a file src/library_name.js
+
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/javascript_test_generators/javascript_test/templates/test/test.html.erb

@@ -0,0 +1,58 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>JavaScript unit test file</title>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <script src="assets/prototype.js" type="text/javascript"></script>
+  <script src="assets/unittest.js" type="text/javascript"></script>
+  
+  <script src="../src/<%= library_name %>.js" type="text/javascript"></script>
+  
+  <link rel="stylesheet" href="assets/unittest.css" type="text/css" />
+</head>
+<body>
+
+<div id="content">
+
+  <div id="header">
+    <h1>JavaScript unit test file</h1>
+    <p>
+      This file tests <strong><%= library_name %>.js</strong>.
+    </p>
+  </div>
+
+  <!-- Log output (one per Runner, via {testLog: "testlog"} option)-->
+  <div id="testlog"></div>
+  
+  <!-- Put sample/test html here -->
+  <div id="sample"></div>
+</div>
+
+<script type="text/javascript">
+// <![CDATA[
+
+  new Test.Unit.Runner({
+    // replace this with your real tests
+    setup: function() {
+      
+    },
+    
+    teardown: function() {
+      
+    },
+    
+    testTruth: function() { with(this) {
+      assert(true);
+    }}
+      
+  }, {testLog: "testlog"}); 
+  // For each Test.UnitRunner instance, specify the element id where results will be
+  // published; e.g. <div id="testlog"/> above.
+  // That is, you can have multiple "new Test.Unit.Runner() { ... }" on this page, just
+  // create more <div id="testlog2"></div> etc, and pass the element id to the hash above:
+  // e.g. {testLog: "testlog2"}
+// ]]>
+</script>
+</body>
+</html>

data/lib/newjs.rb

@@ -0,0 +1,7 @@
+$:.unshift File.dirname(__FILE__)
+
+module Newjs
+  
+end
+
+require 'newjs/jstest'

data/lib/newjs/autotest.rb

@@ -0,0 +1,3 @@
+%w[javascript_test_autotest javascript_test_ext].each do |file|
+  require File.dirname(__FILE__) + "/autotest/" + file
+end

data/lib/newjs/autotest/javascript_test_autotest.rb

@@ -0,0 +1,22 @@
+module JavascriptTestAutotest
+  class Browser
+    class << self
+      def browser(browser, path)
+        case(browser.to_sym)
+          when :firefox
+            FirefoxBrowser.new(path)
+          when :safari
+            SafariBrowser.new(path)
+          when :ie
+            IEBrowser.new(path)
+          when :konqueror
+            KonquerorBrowser.new(path)
+          else
+            browser
+        end
+      end
+    end
+  end
+end
+
+require File.dirname(__FILE__) + "/javascript_test_autotest/config"

data/lib/newjs/autotest/javascript_test_autotest/config.rb

@@ -0,0 +1,20 @@
+require 'yaml'
+
+class JavascriptTestAutotest::Config
+  def self.get var, default = nil
+    value = configs[var.to_s]
+    value ||= default
+    value ||= yield if block_given?
+    value
+  end
+
+  private
+    def self.configs
+      unless defined? @@configs
+        file = File.expand_path("#{APP_ROOT}/config/javascript_test_autotest.yml")
+        @@configs = File.exist?(file) ? YAML.load_file(file) : {}
+      end
+      @@configs
+    end
+
+end

data/lib/newjs/autotest/javascript_test_ext.rb

@@ -0,0 +1,29 @@
+class Browser
+  def initialize(path)
+    unless path == :ignore
+      @path = path
+      puts "WARNING: #{self} does not exist at #{@path}" unless File.exists?(@path)
+    end
+  end
+end
+
+if Browser.new(:ignore).macos?
+  class SafariBrowser
+    def setup; end # no need to create new Browser, as open command automates this
+    def visit(file)
+      @path ||= 'Safari.app'
+      `open #{file} -a #{@path} -g`
+    end
+    def teardown; end # no need to destroy Browser
+  end
+
+  class FirefoxBrowser
+    def setup; end # no need to create new Browser, as open command automates this
+    def visit(file)
+      @path ||= 'Safari.app'
+      puts "open #{file} -a #{@path} -g"
+      `open #{file} -a #{@path} -g`
+    end
+    def teardown; end # no need to destroy Browser
+  end
+end

data/lib/newjs/jstest.rb

@@ -0,0 +1,382 @@
+require 'rake/tasklib'
+require 'thread'
+require 'webrick'
+require 'fileutils'
+include FileUtils
+
+class Browser
+  def supported?; true; end
+  def setup ; end
+  def open(url) ; end
+  def teardown ; end
+
+  def host
+    require 'rbconfig'
+    Config::CONFIG['host']
+  end
+  
+  def macos?
+    host.include?('darwin')
+  end
+  
+  def windows?
+    host.include?('mswin')
+  end
+  
+  def linux?
+    host.include?('linux')
+  end
+  
+  def applescript(script)
+    raise "Can't run AppleScript on #{host}" unless macos?
+    system "osascript -e '#{script}' 2>&1 >/dev/null"
+  end
+end
+
+class FirefoxBrowser < Browser
+  def initialize(path=File.join(ENV['ProgramFiles'] || 'c:\Program Files', '\Mozilla Firefox\firefox.exe'))
+    @path = path
+  end
+
+  def visit(url)
+    system("open -a Firefox '#{url}'") if macos?
+    system("#{@path} #{url}") if windows? 
+    system("firefox #{url}") if linux?
+  end
+
+  def to_s
+    "Firefox"
+  end
+end
+
+class SafariBrowser < Browser
+  def supported?
+    macos?
+  end
+  
+  def setup
+    applescript('tell application "Safari" to make new document')
+  end
+  
+  def visit(url)
+    applescript('tell application "Safari" to set URL of front document to "' + url + '"')
+  end
+
+  def teardown
+    #applescript('tell application "Safari" to close front document')
+  end
+
+  def to_s
+    "Safari"
+  end
+end
+
+class IEBrowser < Browser
+  def setup
+    require 'win32ole' if windows?
+  end
+
+  def supported?
+    windows?
+  end
+  
+  def visit(url)
+    if windows?
+      ie = WIN32OLE.new('InternetExplorer.Application')
+      ie.visible = true
+      ie.Navigate(url)
+      while ie.ReadyState != 4 do
+        sleep(1)
+      end
+    end
+  end
+
+  def to_s
+    "Internet Explorer"
+  end
+end
+
+class KonquerorBrowser < Browser
+  @@configDir = File.join((ENV['HOME'] || ''), '.kde', 'share', 'config')
+  @@globalConfig = File.join(@@configDir, 'kdeglobals')
+  @@konquerorConfig = File.join(@@configDir, 'konquerorrc')
+
+  def supported?
+    linux?
+  end
+
+  # Forces KDE's default browser to be Konqueror during the tests, and forces
+  # Konqueror to open external URL requests in new tabs instead of a new
+  # window.
+  def setup
+    cd @@configDir, :verbose => false do
+      copy @@globalConfig, "#{@@globalConfig}.bak", :preserve => true, :verbose => false
+      copy @@konquerorConfig, "#{@@konquerorConfig}.bak", :preserve => true, :verbose => false
+      # Too lazy to write it in Ruby...  Is sed dependency so bad?
+      system "sed -ri /^BrowserApplication=/d  '#{@@globalConfig}'"
+      system "sed -ri /^KonquerorTabforExternalURL=/s:false:true: '#{@@konquerorConfig}'"
+    end
+  end
+
+  def teardown
+    cd @@configDir, :verbose => false do
+      copy "#{@@globalConfig}.bak", @@globalConfig, :preserve => true, :verbose => false
+      copy "#{@@konquerorConfig}.bak", @@konquerorConfig, :preserve => true, :verbose => false
+    end
+  end
+  
+  def visit(url)
+    system("kfmclient openURL #{url}")
+  end
+  
+  def to_s
+    "Konqueror"
+  end
+end
+
+class OperaBrowser < Browser
+  def initialize(path='c:\Program Files\Opera\Opera.exe')
+    @path = path
+  end
+  
+  def setup
+    if windows?
+      puts %{
+        MAJOR ANNOYANCE on Windows.
+        You have to shut down Opera manually after each test
+        for the script to proceed.
+        Any suggestions on fixing this is GREATLY appreciated!
+        Thank you for your understanding.
+      }
+    end
+  end
+  
+  def visit(url)
+    applescript('tell application "Opera" to GetURL "' + url + '"') if macos? 
+    system("#{@path} #{url}") if windows? 
+    system("opera #{url}")  if linux?
+  end
+
+  def to_s
+    "Opera"
+  end
+end
+
+# shut up, webrick :-)
+class ::WEBrick::HTTPServer
+  def access_log(config, req, res)
+    # nop
+  end
+end
+
+class ::WEBrick::BasicLog
+  def log(level, data)
+    # nop
+  end
+end
+
+class WEBrick::HTTPResponse
+  alias send send_response
+  def send_response(socket)
+    send(socket) unless fail_silently?
+  end
+  
+  def fail_silently?
+    @fail_silently
+  end
+  
+  def fail_silently
+    @fail_silently = true
+  end
+end
+
+class WEBrick::HTTPRequest
+  def to_json
+    headers = []
+    each { |k, v| headers.push "#{k.inspect}: #{v.inspect}" }
+    headers = "{" << headers.join(', ') << "}"
+    %({ "headers": #{headers}, "body": #{body.inspect}, "method": #{request_method.inspect} })
+  end
+end
+
+class WEBrick::HTTPServlet::AbstractServlet
+  def prevent_caching(res)
+    res['ETag'] = nil
+    res['Last-Modified'] = Time.now + 100**4
+    res['Cache-Control'] = 'no-store, no-cache, must-revalidate, post-check=0, pre-check=0'
+    res['Pragma'] = 'no-cache'
+    res['Expires'] = Time.now - 100**4
+  end
+end
+
+class BasicServlet < WEBrick::HTTPServlet::AbstractServlet
+  def do_GET(req, res)
+    prevent_caching(res)
+    res['Content-Type'] = "text/plain"
+    
+    req.query.each do |k, v|
+      res[k] = v unless k == 'responseBody'
+    end
+    res.body = req.query["responseBody"]
+    
+    raise WEBrick::HTTPStatus::OK
+  end
+  
+  def do_POST(req, res)
+    do_GET(req, res)
+  end
+end
+
+class SlowServlet < BasicServlet
+  def do_GET(req, res)
+    sleep(2)
+    super
+  end
+end
+
+class DownServlet < BasicServlet
+  def do_GET(req, res)
+    res.fail_silently
+  end
+end
+
+class InspectionServlet < BasicServlet
+  def do_GET(req, res)
+    prevent_caching(res)
+    res['Content-Type'] = "application/json"
+    res.body = req.to_json
+    raise WEBrick::HTTPStatus::OK
+  end
+end
+
+class NonCachingFileHandler < WEBrick::HTTPServlet::FileHandler
+  def do_GET(req, res)
+    super
+    set_default_content_type(res, req.path)
+    prevent_caching(res)
+  end
+  
+  def set_default_content_type(res, path)
+    res['Content-Type'] = case path
+      when /\.js$/   then 'text/javascript'
+      when /\.html$/ then 'text/html'
+      when /\.css$/  then 'text/css'
+      else 'text/plain'
+    end
+  end
+end
+
+class JavaScriptTestTask < ::Rake::TaskLib
+
+  def initialize(name=:test)
+    @name = name
+    @tests = []
+    @browsers = []
+
+    @queue = Queue.new
+
+    @server = WEBrick::HTTPServer.new(:Port => 4711) # TODO: make port configurable
+    @server.mount_proc("/results") do |req, res|
+      @queue.push({
+        :tests => req.query['tests'].to_i,
+        :assertions => req.query['assertions'].to_i,
+        :failures => req.query['failures'].to_i,
+        :errors => req.query['errors'].to_i
+      })
+      res.body = "OK"
+    end
+    @server.mount("/response", BasicServlet)
+    @server.mount("/slow", SlowServlet)
+    @server.mount("/down", DownServlet)
+    @server.mount("/inspect", InspectionServlet)
+    yield self if block_given?
+    define
+  end
+
+  def define
+    task @name do
+      trap("INT") { @server.shutdown }
+      t = Thread.new { @server.start }
+      
+      # run all combinations of browsers and tests
+      @browsers.each do |browser|
+        if browser.supported?
+          t0 = Time.now
+          results = {:tests => 0, :assertions => 0, :failures => 0, :errors => 0}
+          errors = []
+          failures = []
+          browser.setup
+          puts "\nStarted tests in #{browser}"
+          @tests.each do |test|
+            params = "resultsURL=http://localhost:4711/results&t=" + ("%.6f" % Time.now.to_f)
+            if test.is_a?(Hash)
+              params << "&tests=#{test[:testcases]}" if test[:testcases]
+              test = test[:url]
+            end
+            browser.visit("http://localhost:4711#{test}?#{params}")
+ 
+            result = @queue.pop
+            result.each { |k, v| results[k] += v }
+            value = "."
+            
+            if result[:failures] > 0
+              value = "F"
+              failures.push(test)
+            end
+            
+            if result[:errors] > 0
+              value = "E"
+              errors.push(test)
+            end
+            
+            print value
+          end
+          
+          puts "\nFinished in #{(Time.now - t0).round.to_s} seconds."
+          puts "  Failures: #{failures.join(', ')}" unless failures.empty?
+          puts "  Errors:   #{errors.join(', ')}" unless errors.empty?
+          puts "#{results[:tests]} tests, #{results[:assertions]} assertions, #{results[:failures]} failures, #{results[:errors]} errors"
+          browser.teardown
+        else
+          puts "\nSkipping #{browser}, not supported on this OS"
+        end
+      end
+
+      @server.shutdown
+      t.join
+    end
+  end
+
+  def mount(path, dir=nil)
+    dir = Dir.pwd + path unless dir
+
+    # don't cache anything in our tests
+    @server.mount(path, NonCachingFileHandler, dir)
+  end
+
+  # test should be specified as a url or as a hash of the form
+  # {:url => "url", :testcases => "testFoo,testBar"}
+  def run(test)
+    @tests<<test
+  end
+
+  def browser(browser)
+    browser =
+      case(browser)
+        when :firefox
+          FirefoxBrowser.new
+        when :safari
+          SafariBrowser.new
+        when :ie
+          IEBrowser.new
+        when :konqueror
+          KonquerorBrowser.new
+        when :opera
+          OperaBrowser.new
+        else
+          browser
+      end
+
+    @browsers<<browser
+  end
+end