rsutphin-shenandoah 0.1.0

data/lib/shenandoah/javascript/console/runner.js

@@ -0,0 +1,43 @@
+if(arguments.length == 0) {
+  print("Usage: test_runner.js /path/to/shenandoah /path/to/mainfiles /path/to/specfiles file_spec.js");
+  quit(1);
+}
+
+var SHENANDOAH = arguments[0]
+var MAIN_PATH = arguments[1]
+var SPEC_PATH = arguments[2]
+var SPEC_FILE = arguments[3]
+
+function require_main(file) { 
+  require_absolute(MAIN_PATH + '/' + file)
+}
+
+function require_spec(file) { 
+  require_absolute(SPEC_PATH + '/' + file)
+}
+
+function require_absolute(file) {
+  load(file)
+}
+
+var fixture = SPEC_FILE.replace(/^(.*?)_spec\.js$/, "$1.html");
+print("Running " + SPEC_FILE + " with fixture '" + fixture + "'");
+
+load(SHENANDOAH + "/lib/shenandoah/javascript/console/env.rhino.js");
+window.location = fixture;
+
+load(SHENANDOAH + "/lib/shenandoah/javascript/common/jquery-1.3.2.js");
+load(SHENANDOAH + "/lib/shenandoah/javascript/common/jquery.fn.js");
+load(SHENANDOAH + "/lib/shenandoah/javascript/common/jquery.print.js");
+load(SHENANDOAH + "/lib/shenandoah/javascript/common/screw.builder.js");
+load(SHENANDOAH + "/lib/shenandoah/javascript/common/screw.matchers.js");
+load(SHENANDOAH + "/lib/shenandoah/javascript/common/screw.events.js");
+load(SHENANDOAH + "/lib/shenandoah/javascript/common/screw.behaviors.js");
+load(SHENANDOAH + "/lib/shenandoah/javascript/common/smoke.core.js");
+load(SHENANDOAH + "/lib/shenandoah/javascript/common/smoke.mock.js");
+load(SHENANDOAH + "/lib/shenandoah/javascript/common/smoke.stub.js");
+load(SHENANDOAH + "/lib/shenandoah/javascript/common/screw.mocking.js");
+load(SHENANDOAH + "/lib/shenandoah/javascript/console/consoleReportForRake.js");
+
+load(SPEC_PATH + '/' + SPEC_FILE);
+jQuery(window).trigger("load");

data/lib/shenandoah/javascript/console/shell.js.erb

@@ -0,0 +1,23 @@
+(function(){
+  var _old_quit = this.quit;
+  this.__defineGetter__("exit", function(){ _old_quit() });
+  this.__defineGetter__("quit", function(){ _old_quit() });
+  
+  print("=================================================");
+  print(" Rhino JavaScript Shell");
+  print(" To exit type 'exit', 'quit', or 'quit()'.");
+  print("=================================================");
+
+  load("<%= shenandoah_root %>/lib/shenandoah/javascript/console/env.rhino.js");
+  print(" - loaded env.js");
+
+  window.location = "<%= shell_html_path %>";
+  print(" - sample DOM loaded");
+
+  load("<%= shenandoah_root %>/lib/shenandoah/javascript/common/jquery-1.3.2.js");
+  print (" jQuery-1.3.2 loaded");
+  // load(PLUGIN_PREFIX + "lib/jquery-1.2.6.js");
+  // print(" - jQuery-1.2.6 loaded");
+
+  print("=================================================");
+})();

data/lib/shenandoah/locator.rb

@@ -0,0 +1,17 @@
+require 'rake'
+
+module Shenandoah
+  class DefaultLocator
+    attr_accessor :main_path, :spec_path, :tmp_path
+
+    def initialize(options = {})
+      @main_path = options[:main_path] || "lib"
+      @spec_path = options[:spec_path] || "spec"
+      @tmp_path = options[:tmp_path] || ENV['TMPDIR'] || "tmp"
+    end
+
+    def spec_files
+      FileList["#{spec_path}/**/*_spec.js"]
+    end
+  end
+end

data/lib/shenandoah/rails/locator.rb

@@ -0,0 +1,27 @@
+require 'shenandoah/locator'
+
+module Shenandoah
+  module Rails
+    class Locator < Shenandoah::DefaultLocator
+      def initialize(options={})
+        super(
+          :main_path => File.join(RAILS_ROOT, options[:main_path] || "public/javascripts"),
+          :spec_path => File.join(RAILS_ROOT, options[:spec_path] || select_spec_subpath),
+          :tmp_path =>  File.join(RAILS_ROOT, "tmp/shenandoah")
+        )
+      end
+
+      private
+
+      def select_spec_subpath
+        %w(spec examples).each do |candidate|
+          if File.directory?(File.join(RAILS_ROOT, candidate))
+            return "#{candidate}/javascript"
+          end
+        end
+        
+        "test/javascript" # default
+      end
+    end
+  end
+end

data/lib/shenandoah/rails/tasks.rb

@@ -0,0 +1,16 @@
+# This class is just sugar for initing Shenandoah::Tasks with a rails locator
+
+require 'shenandoah/tasks'
+require 'shenandoah/rails/locator'
+
+module Shenandoah
+  module Rails
+    class Tasks < Shenandoah::Tasks
+      protected
+      
+      def default_locator_type
+        Locator
+      end
+    end
+  end
+end

data/lib/shenandoah/runner.rb

@@ -0,0 +1,69 @@
+require 'fileutils'
+require 'erb'
+
+module Shenandoah
+  class Runner
+    def initialize(locator, options = {})
+      @locator = locator
+      @quiet = options[:quiet]
+    end
+
+    # Runs the specified specs.  Returns an array of the specs that passed.
+    def run_console(specs)
+      FileUtils.cd @locator.spec_path do
+        runner_cmd = rhino_command(shen_path_to('lib/shenandoah/javascript/console/runner.js'))
+        args = [
+          shen_path_to,
+          @locator.main_path,
+          @locator.spec_path
+        ]
+
+        return specs.select { |spec|
+          system("#{runner_cmd} '#{args.join("' '")}' '#{spec.sub(%r{^#{@locator.spec_path}/}, '')}' #{@quiet ? '> /dev/null' : ''}")
+        }
+      end
+    end
+
+    def run_shell
+      create_shell_html
+      create_shell_js
+
+      rlwrap = `which rlwrap`.chomp
+      cmd = "#{rlwrap} #{rhino_command('-f', shell_js_path, '-f', '-')}"
+      $stderr.puts "Starting shell with #{cmd}"
+      system(cmd)
+    end
+
+    private
+
+    def shen_path_to(file=nil)
+      File.expand_path(File.dirname(__FILE__) + "/../../#{file}")
+    end
+    alias :shenandoah_root :shen_path_to
+
+    def rhino_command(*args)
+      "java -jar '#{shen_path_to 'lib/shenandoah/javascript/console/js.jar'}' -w -debug '#{args.join("' '")}'"
+    end
+
+    def shell_html_path
+      "#{@locator.tmp_path}/shell.html"
+    end
+
+    def shell_js_path
+      "#{@locator.tmp_path}/shell.js"
+    end
+
+    def create_shell_html
+      FileUtils.mkdir_p File.dirname(shell_html_path)
+      File.open(shell_html_path, 'w') do |f|
+        f.write "<html><body></body></html>"
+      end
+    end
+
+    def create_shell_js
+      js = ERB.new(File.read(shen_path_to('lib/shenandoah/javascript/console/shell.js.erb'))).result(binding)
+      FileUtils.mkdir_p File.dirname(shell_js_path)
+      File.open(shell_js_path, 'w') { |f| f.write js }
+    end
+  end
+end

data/lib/shenandoah/server.rb

@@ -0,0 +1,88 @@
+require 'sinatra'
+require 'haml'
+
+module Shenandoah
+  # The server which enables in-browser execution of Screw.Unit specs in
+  # Shenandoah.
+  #
+  # It exposes a list of all the specs at the root of the server, 
+  # organized by subdirectory, with links to individual test fixtures.
+  # The contents of the +main_path+ and +spec_path+ in the configured locator
+  # are exposed under <tt>/main</tt> and <tt>/spec</tt> respectively.
+  class Server < Sinatra::Base
+    set :root, File.dirname(__FILE__) + "/server"
+    set :port, 4410
+    enable :logging
+
+    get '/' do
+      section_map = options.locator.spec_files.
+        collect { |t| t.sub(%r{^#{options.locator.spec_path}/?}, '') }.
+        collect { |t| [File.dirname(t), File.basename(t).sub(/_spec.js$/, '.html')] }.
+        inject({}) { |h, (dir, file)| h[dir] ||= []; h[dir] << file; h }
+      @sections = section_map.collect { |dir, files| [dir, files.sort] }.sort
+      
+      haml :index
+    end
+    
+    get '/main/*' do
+      map_file(options.locator.main_path, params[:splat].first, "Main")
+    end
+
+    get '/spec/*' do
+      map_file(options.locator.spec_path, params[:splat].first, "Spec")
+    end
+
+    get '/screw.css' do
+      screw_css = File.join(options.locator.spec_path, 'screw.css')
+      unless File.exist?(screw_css)
+        screw_css = File.join(File.dirname(__FILE__), 'css/screw.css')
+      end
+      send_file screw_css
+    end
+
+    get '/shenandoah/browser-runner.js' do
+      content_type 'text/javascript'
+
+      last_modified runner_files.collect { |filename|
+        File.stat("#{File.dirname(__FILE__)}/#{filename}").mtime
+      }.max
+
+      runner_files.collect { |filename|
+        [
+          "\n//////\n////// #{filename}\n//////\n",
+          File.read("#{File.dirname(__FILE__)}/#{filename}")
+        ]
+      }.flatten
+    end
+
+    protected
+
+    def map_file(path, name, desc) # :nodoc:
+      file = File.join(path, name)
+      if File.exist?(file)
+        headers['Cache-Control'] = 'no-cache'
+        send_file file
+      else
+        halt 404, "#{desc} file not found: #{file}"
+      end
+    end
+
+    def runner_files # :nodoc:
+      # Can't just use Dir[] because order is important
+      [
+        "javascript/common/jquery-1.3.2.js",
+        "javascript/common/jquery.fn.js",
+        "javascript/common/jquery.print.js",
+        "javascript/common/screw.builder.js",
+        "javascript/common/screw.matchers.js",
+        "javascript/common/screw.events.js",
+        "javascript/common/screw.behaviors.js",
+        "javascript/common/smoke.core.js",
+        "javascript/common/smoke.mock.js",
+        "javascript/common/smoke.stub.js",
+        "javascript/common/screw.mocking.js",
+        "javascript/browser/runner.js"
+      ]
+    end
+  end
+end

data/lib/shenandoah/server/views/index.haml

@@ -0,0 +1,12 @@
+%html
+  %head
+    %link{ :rel => "stylesheet", :href => "/screw.css", :type => "text/css", :charset => "utf-8" }
+  %body
+    - if options.respond_to?(:project_name) && options.project_name
+      %h1= "Specs for #{options.project_name}"
+    - @sections.each do |section, tests|
+      %h2= section == '.' ? '[root]' : section
+      %ul
+        - tests.each do |test|
+          %li
+            %a{ :href => ["spec", section, test].reject { |s| s == '.' }.join('/') }= test.sub(/.html$/, '')

data/lib/shenandoah/tasks.rb

@@ -0,0 +1,62 @@
+require 'rake'
+require 'shenandoah/runner'
+require 'shenandoah/server'
+
+module Shenandoah
+  class Tasks
+    attr_accessor :locator, :options, :runner
+    
+    def initialize(options = {})
+      @options = options
+      @locator =
+        if options[:locator]
+          options[:locator]
+        else
+          default_locator_type.new(options)
+        end
+      @runner = Shenandoah::Runner.new(@locator)
+      create_serve_task
+      create_shell_task
+      create_run_task
+    end
+    
+    def run_specs
+      files = @locator.spec_files
+      if ENV['SHEN_SPEC']
+        files = files.select { |f| f =~ /#{ENV['SHEN_SPEC']}/ }
+      end
+      successes = @runner.run_console(files)
+      if (successes.size != files.size)
+        raise "Shenandoah specs failed!"
+      end
+    end
+    
+    protected
+    
+    def default_locator_type
+      DefaultLocator
+    end
+    
+    def create_serve_task
+      task('shen:serve') do |t|
+        Shenandoah::Server.set :locator, @locator
+        if @options[:project_name]
+          Shenandoah::Server.set :project_name, @options[:project_name]
+        end
+        Shenandoah::Server.run!
+      end
+    end
+    
+    def create_shell_task
+      task('shen:shell') do |t|
+        @runner.run_shell
+      end
+    end
+    
+    def create_run_task
+      task('shen:spec') do |t|
+        run_specs
+      end
+    end
+  end
+end

data/rails_generators/shen_spec/shen_spec_generator.rb

@@ -0,0 +1,27 @@
+require 'rails_generator'
+require 'shenandoah/rails/locator'
+
+module Shenandoah
+  module Generators
+    class ShenSpecGenerator < ::Rails::Generator::NamedBase
+      def manifest
+        spec_path = Shenandoah::Rails::Locator.new.spec_path.sub %r{^#{RAILS_ROOT}/}, ''
+        record do |m|
+          m.directory "#{spec_path}/#{File.dirname(file_path)}"
+          m.template 'javascript_spec.js.erb', "#{spec_path}/#{file_path}_spec.js"
+          m.template 'fixture.html.erb', "#{spec_path}/#{file_path}.html"
+        end
+      end
+
+      def file_path
+        super.sub /_spec$/, ''
+      end
+
+      def javascript_class_name
+        klass, *mods_rev = class_name.sub(/Spec$/, '').split('::').reverse
+        mod_spec = mods_rev.reverse.collect { |m| m.downcase }.join('.')
+        [mod_spec, klass].reject { |p| p == "" }.join '.'
+      end
+    end
+  end
+end

data/rails_generators/shen_spec/templates/fixture.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+
+<head>
+  <title><%= file_name %>.js | JavaScript Testing Results</title>
+  <link rel="stylesheet" href="/screw.css" type="text/css" charset="utf-8" />
+  <script type="text/javascript" src="/shenandoah/browser-runner.js"></script>
+</head>
+
+<body>
+  <!-- Put any HTML fixture elements here. -->
+</body>
+</html>

data/rails_generators/shen_spec/templates/javascript_spec.js.erb

@@ -0,0 +1,8 @@
+require_spec('spec_helper.js');
+require_main('<%= file_path %>.js');
+
+describe('<%= javascript_class_name %>', function () {
+  it("needs tests", function () {
+    expect("you").to(include, "some tests");
+  });
+});

data/rails_generators/shenandoah/shenandoah_generator.rb

@@ -0,0 +1,21 @@
+require 'rails_generator'
+require 'shenandoah/rails/locator'
+
+module Shenandoah
+  module Generators
+    class ShenandoahGenerator < ::Rails::Generator::Base
+      def manifest
+        spec_path = Shenandoah::Rails::Locator.new.spec_path.sub %r{^#{RAILS_ROOT}/}, ''
+        record do |m|
+          m.directory "lib/tasks"
+          m.file "shenandoah.rake", "lib/tasks/shenandoah.rake"
+          
+          m.directory spec_path
+          m.file "spec_helper.js", "#{spec_path}/spec_helper.js"
+          m.file "application_spec.js", "#{spec_path}/application_spec.js"
+          m.file "application.html", "#{spec_path}/application.html"
+        end
+      end
+    end
+  end
+end