nakajima-screw-driver 0.0.2

data/README.textile

@@ -0,0 +1,58 @@
+h1. Screw.Driver
+
+Another way to run your Screw.Unit tests.
+
+h3. INSTALL
+
+To build the gem, run this:
+
+  gemify -I
+
+"View the CI build":http://ci.patnakajima.com/screw-driver
+
+h3. ABOUT
+
+Still really early. To try it, run this:
+
+  ./bin/screwdriver spec/fixtures/suite.html
+
+You can specify a browser like so:
+
+  screwdriver spec/fixtures/suite.html --browser Safari
+
+By default, Screw.Driver uses Firefox.
+
+If you don't want the server to automatically quit after
+your suite runs, you can use the "--server" option:
+
+  screwdriver spec/fixtures/suite.html --server
+  
+Screw.Driver will generate urls for each of the external
+scripts and CSS links you include in your suite.html file,
+and will serve them from the directory that contains the
+suite.html file.
+
+To specify additional load paths for your JavaScripts, you can
+use the "--load-paths" option:
+
+  screwdriver spec/fixtures/suite.html --load-paths src/
+
+h3. Using with Rails
+
+If you're using Rails, run screwdriver from the root directory
+of your app, and specify the "--rails" option. This will cause
+the Screw.Driver server to serve the JavaScript files in your
+public/javascripts directory. Example:
+
+  screwdriver spec/fixtures/suite.html --rails
+
+REQUIREMENTS
+- sinatra
+- hpricot
+- gemify (to build)
+
+TODO
+- Inject base tag into DOM at Hpricot parsing stage
+- Convert script src attributes to absolute paths at Hpricot parsing stage
+- Don't kill all Firefox tabs when complete
+- Use #load_paths for Rails functionality

data/Rakefile

@@ -0,0 +1,13 @@
+require 'spec/rake/spectask'
+
+task :default => [:spec]
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+end
+
+task :run do
+  dir = File.dirname(__FILE__)
+  system "#{dir}/bin/screwdriver #{dir}/spec/fixtures/suite.html"
+end

data/bin/screwdriver

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+ARGS = ARGV.dup unless defined?(ARGS)
+ARGV.clear
+
+load 'server.rb'

data/js/jquery.ajax_queue.js

@@ -0,0 +1,59 @@
+// AjaxQueue - by Pat Nakajima
+(function($) {
+  var startNextRequest = function() {
+    if ($.ajaxQueue.currentRequest) { return; }
+    if (request = $.ajaxQueue.queue.shift()) {
+      $.ajaxQueue.currentRequest = request;
+      request.perform();
+    }
+  }
+  
+  var Request = function(url, type, options) {
+    this.opts = options || { };
+    this.opts.url = url;
+    this.opts.type = type;
+    var oldComplete = this.opts.complete || function() { }
+    this.opts.complete = function(response) {
+      oldComplete(response);
+      $.ajaxQueue.currentRequest = null;
+      startNextRequest();
+    };
+  }
+  
+  Request.prototype.perform = function() {
+    $.ajax(this.opts);
+  }
+  
+  var addRequest = function(url, type, options) {
+    var request = new Request(url, type, options);
+    $.ajaxQueue.queue.push(request);
+    startNextRequest();
+  }
+  
+  $.ajaxQueue = {
+    queue: [],
+    
+    currentRequest: null,
+    
+    reset: function() {
+      $.ajaxQueue.queue = [];
+      $.ajaxQueue.currentRequest = null;
+    },
+    
+    post: function(url, options) {
+      addRequest(url, 'POST', options);
+    },
+    
+    get: function(url, options) {
+      addRequest(url, 'GET', options);
+    },
+    
+    put: function(url, options) {
+      addRequest(url, 'PUT', options);
+    },
+    
+    "delete": function(url, options) {
+      addRequest(url, 'DELETE', options);
+    }
+  }
+})(jQuery)

data/js/screw.driver.js

@@ -0,0 +1,32 @@
+(function($) {
+  $(Screw).bind('before', function() {
+    $.ajaxQueue.post('/before');
+  });
+  
+  $(Screw).bind('after', function() {
+    $.ajaxQueue.post('/after');
+    $.ajaxQueue.post('/exit');
+  });
+  
+  $(Screw).bind('loaded', function() {
+    $('.it').bind('passed', function(e) {
+      $.ajaxQueue.post('/passed');
+    });
+    
+    $('.it').bind('failed', function(e, reason) {
+      var specName = $(this).find('h2').text();
+      
+      // ERROR
+      if (reason.fileName || reason.lineNumber || reason.line) {
+        return $.ajaxQueue.post('/errored', {
+          data: { name: specName, reason: reason }
+        });
+      }
+      
+      // FAILURE
+      $.ajaxQueue.post('/failed', {
+        data: { name: specName, reason: reason }
+      });
+    });
+  });
+})(jQuery);

data/lib/browser.rb

@@ -0,0 +1,6 @@
+module Screw
+  module Driver
+    module Browser
+    end
+  end
+end

data/lib/browsers/firefox.rb

@@ -0,0 +1,21 @@
+module Screw
+  module Driver
+    module Browser
+      class Firefox
+        def start
+          Thread.new do
+            sleep 1
+            system "open -a Firefox 'http://localhost:4567/?body%20%3E%20.describe'"
+          end
+        end
+        
+        def kill
+          puts "   killing Firefox... "
+          browser_pid = `ps aux | grep -v grep | grep Firefox.app`.scan(/\d+/).first
+          system("kill -s SIGTERM #{browser_pid}")
+          puts '   done.'
+        end
+      end
+    end
+  end
+end

data/lib/browsers/safari.rb

@@ -0,0 +1,19 @@
+module Screw
+  module Driver
+    module Browser
+      class Safari
+        def start
+          Thread.new { sleep 1; system "open -n -a Safari 'http://localhost:4567/?body%20%3E%20.describe'" }
+          # t.join
+        end
+        
+        def kill
+          puts "   killing Safari... "
+          browser_pid = `ps aux | grep -v grep | grep Safari.app`.scan(/\d+/).first
+          system("kill -s SIGTERM #{browser_pid}")
+          puts '   done.'
+        end
+      end
+    end
+  end
+end

data/lib/ext/hpricot.rb

@@ -0,0 +1,7 @@
+module Hpricot
+  module Traverse
+    def insert_js(position, name)
+      send(position, %(<script src="/#{name}"> </script>))
+    end
+  end
+end

data/lib/ext/string.rb

@@ -0,0 +1,13 @@
+class String
+  def green
+    "\e[32m#{self}\e[0m"
+  end
+  
+  def red
+    "\e[31m#{self}\e[0m"
+  end
+  
+  def magenta
+    "\e[35m#{self}\e[0m"
+  end
+end

data/lib/helpers.rb

@@ -0,0 +1,42 @@
+helpers do
+  def padded(spaces=1)
+    spaces.times { puts "" }
+    yield
+    spaces.times { puts "" }
+    :ok
+  end
+  
+  def report(str, params=nil)
+    params ? SUITE.failed!(params) : SUITE.passed!
+    SUITE.write_dot!(str)
+    sleep 0.1
+    :ok
+  end
+  
+  def before_suite
+    SUITE.reset!
+    padded do
+      puts "Staring to run test suite..."
+    end
+  end
+  
+  def after_suite
+    padded do
+      SUITE.failures.each do |failure|
+        padded do
+          puts "Failure:".red
+          puts "- #{failure[:name]}: #{failure[:reason]}"
+        end
+      end
+      print "Finished. #{SUITE.test_count} tests. "
+      print "#{SUITE.failures.length} failures." unless SUITE.failures.empty?
+    end
+  end
+  
+  def exit_suite
+    padded do
+      puts "== Spec Server Exiting..."
+      SUITE.exit
+    end
+  end
+end

data/lib/rails.rb

@@ -0,0 +1,25 @@
+module Screw
+  module Driver
+    module Rails
+      def rails?
+        @rails
+      end
+
+      def rails_urls
+        @rails_urls ||= Dir[File.join(public_path, "**", "*.js")]
+      end
+
+      def generate_rails_urls
+        rails_urls.each do |url|
+          generate "/javascripts/#{File.basename(url)}", 'text/javascript', public_path
+        end
+      end
+
+    private
+
+      def public_path
+        @public_path ||= File.join(Dir.pwd, 'public', 'javascripts')
+      end
+    end
+  end
+end

data/lib/server.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'sinatra'
+require 'ext/string.rb'
+require 'ext/hpricot.rb'
+require 'browser.rb'
+require 'browsers/firefox.rb'
+require 'browsers/safari.rb'
+require 'rails.rb'
+require 'suite.rb'
+require 'helpers.rb'
+
+configure do
+  Rack::CommonLogger.class_eval { def <<(str) end } # Inhibit logging retardase
+  SUITE = Screw::Driver::Suite.new(self, ARGS)
+  SUITE.browser.start
+end
+
+SUITE.generate_urls
+
+get('/') { SUITE.to_s }
+post('/passed')  { report '.'.green }
+post('/failed')  { report 'F'.red, params }
+post('/errored') { report 'E'.magenta, params }
+post('/before')  { before_suite }
+post('/after')   { after_suite }
+post('/exit')    { exit_suite unless SUITE.server? }

data/lib/suite.rb

@@ -0,0 +1,182 @@
+require 'hpricot'
+require 'optparse'
+require 'ostruct'
+
+module Screw
+  module Driver
+    class Suite
+      include Rails
+
+      attr_reader :failures, :test_count, :path, :load_paths, :context
+
+      def initialize(context, args)
+        @context = context
+        parse_args(args)
+        reset!
+      end
+
+      def passed!
+        @test_count += 1
+      end
+
+      def failed!(result)
+        @test_count += 1
+        @failures << result
+      end
+
+      def reset!
+        @test_count = 0
+        @failures = []
+      end
+      
+      def working_directory
+        File.dirname(@path)
+      end
+
+      def generate_urls
+        generate_js_urls
+        generate_css_urls
+        generate_rails_urls if rails?
+        generate_fixture_urls if fixtures?
+      end
+
+      def script_urls
+        doc.search('script').map { |script| script['src'] }.compact
+      end
+
+      def link_urls
+        doc.search('link').map { |script| script['href'] }.compact
+      end
+
+      def to_s
+        doc.to_html
+      end
+
+      def browser
+        @browser
+      end
+
+      def server?
+        @server
+      end
+      
+      def fixtures?
+        File.exists?(File.join(working_directory, 'fixtures'))
+      end
+
+      def exit
+        browser.kill
+        exit! failures.empty? ? 0 : 1
+      end
+      
+      def write_dot!(str)
+        $stdout.print(str)
+        $stdout.flush
+      end
+
+    private
+    
+      def generate_fixture_urls
+        Dir[File.join(working_directory, "fixtures", "*.html")].each do |fixture|
+          generate(File.join("fixtures", File.basename(fixture)), "text/html")
+        end
+      end
+
+      def generate_js_urls
+        script_urls.each do |url|
+          generate(url, "text/javascript")
+        end
+      end
+
+      def generate_css_urls
+        link_urls.each do |url|
+          generate(url, "text/css")
+        end
+      end
+      
+      # i know. this is hideous.
+      def absolutize_url(url)
+        # file_path = File.expand_path(File.join(working_directory, url))
+        # full_path = File.expand_path(File.join(path, url))
+        # full_path.gsub(File.expand_path(path), '')
+        ('/' + url.split('./').last).gsub(%r(/+), '/')
+      end
+      
+      def generate(url, content_type, default_path=working_directory)
+        prefix = load_paths.detect { |load_path| File.exists?(File.join(load_path, url)) } || default_path
+        path = File.join(prefix, url)
+        @context.send(:get, absolutize_url(url)) do
+          headers 'Content-Type' => content_type
+          File.read(path)
+        end
+      end
+
+      def parse_args(args)
+        options = OpenStruct.new
+        options.browser = "Firefox"
+        options.rails   = false
+        options.server  = false
+        options.paths   = []
+
+        opts = OptionParser.new do |opts|
+          opts.banner = "Usage: screwdriver [options] suite"
+
+          opts.on("-b", "--browser BROWSER", "Specify the browser to use (default: Firefox)") do |browser|
+            options.browser = browser
+          end
+          
+          opts.on("-p", "--load-paths src,dist,etc", Array, "Adds additional load paths from which files can be served.") do |paths|
+            options.paths = paths
+          end
+
+          opts.on("--rails", "Enable Rails integration (serves files from the RAILS_ROOT/public/javascripts directory)") do
+            options.rails = true
+          end
+          
+          opts.on("-s", "--server", "Keeps the server running after completion") do
+            options.server = true
+          end
+
+          opts.on_tail("-h", "--help", "Show this message") do
+            puts opts
+            exit!
+          end
+        end
+
+        opts.parse!(args)
+
+        if args.empty?
+          puts opts
+          exit!
+        else
+          @browser  = eval("Screw::Driver::Browser::#{options.browser}.new")
+          @rails    = options.rails
+          @server   = options.server
+          @path     = File.join(Dir.pwd, args.shift)
+          setup_load_paths options.paths
+        end
+      end
+      
+      def setup_load_paths(paths=[])
+        @load_paths = paths.map { |path| File.join(Dir.pwd, path) }
+        @load_paths << File.join(File.dirname(__FILE__), '..', 'js')
+        @load_paths << File.dirname(@path)
+      end
+
+      def doc
+        @doc ||= extended_doc(File.open(@path))
+      end
+      
+      def extended_doc(file)
+        hpricot_doc = Hpricot(file)
+        hpricot_doc.search('script').last.after(%(<base href="http://localhost:4567">))
+        hpricot_doc.search('script').each do |node|
+          case File.basename(node['src'])
+          when "screw.behaviors.js" then node.insert_js(:before, 'jquery.ajax_queue.js')
+          when "screw.events.js" then node.insert_js(:after, 'screw.driver.js')
+          end
+        end and hpricot_doc
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: nakajima-screw-driver
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Pat Nakajima
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-23 00:00:00 -07:00
+default_executable: screwdriver
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: patnakajima@gmail.com
+executables: 
+- screwdriver
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.textile
+- Rakefile
+- bin/screwdriver
+- lib/browser.rb
+- lib/browsers/firefox.rb
+- lib/browsers/safari.rb
+- lib/ext/string.rb
+- lib/ext/hpricot.rb
+- lib/helpers.rb
+- lib/rails.rb
+- lib/suite.rb
+- lib/server.rb
+- js/jquery.ajax_queue.js
+- js/screw.driver.js
+has_rdoc: false
+homepage: http://github.com/nakajima/screw-driver
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Run your Screw.Unit specs from the command line.
+test_files: []
+