satisfaction-jasmine 0.4.3

data/README.markdown

@@ -0,0 +1,37 @@
+jasmine-ruby
+============
+
+Jasmine Ruby dynamically serves HTML suites for [Jasmine](http://github.com/pivotal/jasmine)
+
+To use:
+
+`(sudo) gem install jasmine`
+
+Post-installation:
+
+For Rails support, use
+
+`script/generate jasmine`
+
+For other projects, use
+
+`jasmine init`
+
+After initializing a project, you may
+
+`rake jasmine`
+
+to set up a server. Opening localhost:8888 in a web browser will now run your jasmine specs.
+
+You may also
+
+`rake jasmine:ci`
+
+which will run your Jasmine suites using selenium and rspec. This task is suitable for running in continuous integration environments.
+
+Simple Configuration:
+
+Customize `spec/javascripts/support/jasmine.yaml` to enumerate the source files, stylesheets, and spec files you would like the Jasmine runner to include.
+You may use dir glob strings.
+
+It is also possible to add overrides into the `spec/javascripts/support/jasmine_config.rb` file directly if you require further customization.

data/bin/jasmine

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'rake'
+
+def cwd
+  File.expand_path(File.join(File.dirname(__FILE__), '..'))
+end
+
+def expand(*paths)
+  File.expand_path(File.join(*paths))
+end
+
+def template_path(filepath)
+  expand(cwd, File.join("generators/jasmine/templates", filepath))
+end
+
+def dest_path(filepath)
+  expand(Dir.pwd, filepath)
+end
+
+def copy_unless_exists(relative_path, dest_path = nil)
+  unless File.exist?(dest_path(relative_path))
+    File.copy(template_path(relative_path), dest_path(dest_path || relative_path))
+  end
+end
+
+if ARGV[0] == 'init'
+  require 'ftools'
+  File.makedirs('spec/javascripts')
+  File.makedirs('spec/javascripts/support')
+
+  copy_unless_exists('spec/javascripts/SpecHelper.js')
+  copy_unless_exists('spec/javascripts/ExampleSpec.js')
+  copy_unless_exists('spec/javascripts/support/jasmine_config.rb')
+  copy_unless_exists('spec/javascripts/support/jasmine_runner.rb')
+
+  rails_tasks_dir = dest_path('lib/tasks')
+  if File.exist?(rails_tasks_dir)
+    copy_unless_exists('lib/tasks/jasmine.rake')
+    copy_unless_exists('spec/javascripts/support/jasmine-rails.yml', 'spec/javascripts/support/jasmine.yml')
+  else
+    copy_unless_exists('spec/javascripts/support/jasmine.yml')
+    write_mode = 'w'
+    if File.exist?(dest_path('Rakefile'))
+      load dest_path('Rakefile')
+      write_mode = 'a'
+    end
+    unless Rake::Task.task_defined?('jasmine')
+      File.open(dest_path('Rakefile'), write_mode) do |f|
+        f.write(File.read(template_path('lib/tasks/jasmine.rake')))
+      end
+    end
+  end
+  File.open(template_path('INSTALL'), 'r').each_line do |line|
+    puts line
+  end
+end
+

data/generators/jasmine/jasmine_generator.rb

@@ -0,0 +1,25 @@
+class JasmineGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+
+      m.directory "spec/javascripts"
+      m.file "spec/javascripts/SpecHelper.js", "spec/javascripts/SpecHelper.js"
+      m.file "spec/javascripts/ExampleSpec.js", "spec/javascripts/ExampleSpec.js"
+
+      m.directory "spec/javascripts/support"
+      m.file "spec/javascripts/support/jasmine_config.rb", "spec/javascripts/support/jasmine_config.rb"
+      m.file "spec/javascripts/support/jasmine_runner.rb", "spec/javascripts/support/jasmine_runner.rb"
+      m.file "spec/javascripts/support/jasmine-rails.yml", "spec/javascripts/support/jasmine.yml"
+
+      m.directory "lib/tasks"
+      m.file "lib/tasks/jasmine.rake", "lib/tasks/jasmine.rake"
+
+      m.readme "INSTALL"
+    end
+  end
+
+  def file_name
+    "create_blog"
+  end
+
+end

data/generators/jasmine/templates/INSTALL

@@ -0,0 +1,9 @@
+Jasmine has been installed with example specs.
+
+To run the server:
+
+rake jasmine
+
+To run the automated CI task with Selenium:
+
+rake jasmine:ci

data/generators/jasmine/templates/lib/tasks/jasmine.rake

@@ -0,0 +1,23 @@
+namespace :jasmine do
+  require 'jasmine'
+
+  desc "Run continuous integration tests"
+  require "spec"
+  require 'spec/rake/spectask'
+  Spec::Rake::SpecTask.new(:ci) do |t|
+    t.spec_opts = ["--color", "--format", "specdoc"]
+    t.verbose = true
+    t.spec_files = ['spec/javascripts/support/jasmine_runner.rb']
+  end
+    task :server do
+      require 'spec/javascripts/support/jasmine_config'
+      
+      puts "your tests are here:"
+      puts "  http://localhost:8888/run.html"
+
+      Jasmine::Config.new.start_server
+    end
+end
+
+desc "Run specs via server"
+task :jasmine => ['jasmine:server']

data/generators/jasmine/templates/spec/javascripts/ExampleSpec.js

@@ -0,0 +1,11 @@
+describe('Example', function () {
+  it('should have a passing test', function() {
+      expect(true).toEqual(true);
+  });
+
+  describe('nested describe', function () {
+     it('should also have a passing test', function () {
+        expect(true).toEqual(true);
+     });
+  });
+});

data/generators/jasmine/templates/spec/javascripts/SpecHelper.js

@@ -0,0 +1 @@
+//You may load required files here, or create test-runner-wide environment settings.

data/generators/jasmine/templates/spec/javascripts/support/jasmine-rails-with-src-base-url.yml

@@ -0,0 +1,23 @@
+#  Return an array of filepaths relative to src_dir to include before jasmine specs.
+src_files:
+  - javascripts/prototype.js
+  - javascripts/effects.js
+  - javascripts/controls.js
+  - javascripts/dragdrop.js
+  - javascripts/application.js
+
+#  Return an array of stylesheet filepaths relative to src_dir to include before jasmine specs.
+stylesheets:
+  - stylesheets/**/*.css
+#  Return an array of filepaths relative to spec_dir to include before jasmine specs.
+spec_files:
+  - **/*.js
+
+# Set a url base instead of a file system base to load src files from.  For example you could use this to load dynamically generated js files.
+src_base_url: 'http://localhost:3000'
+
+#  Source directory path. Your src_files must be returned relative to this path. Will use root if left blank.
+src_dir: public
+
+#  Spec directory path. Your spec_files must be returned relative to this path.
+spec_dir: spec/javascripts

data/generators/jasmine/templates/spec/javascripts/support/jasmine-rails.yml

@@ -0,0 +1,20 @@
+#  Return an array of filepaths relative to src_dir to include before jasmine specs.
+src_files:
+  - javascripts/prototype.js
+  - javascripts/effects.js
+  - javascripts/controls.js
+  - javascripts/dragdrop.js
+  - javascripts/application.js
+
+#  Return an array of stylesheet filepaths relative to src_dir to include before jasmine specs.
+stylesheets:
+  - stylesheets/**/*.css
+#  Return an array of filepaths relative to spec_dir to include before jasmine specs.
+spec_files:
+  - **/*.js
+
+#  Source directory path. Your src_files must be returned relative to this path. Will use root if left blank.
+src_dir: public
+
+#  Spec directory path. Your spec_files must be returned relative to this path.
+spec_dir: spec/javascripts

data/generators/jasmine/templates/spec/javascripts/support/jasmine.yml

@@ -0,0 +1,20 @@
+#  Return an array of filepaths relative to src_dir to include before jasmine specs.
+#src_files:
+#  - lib/source1.js
+#  - lib/source2.js
+#  - dist/**/*.js
+
+#  Return an array of stylesheet filepaths relative to src_dir to include before jasmine specs.
+#stylesheets:
+#  - css/style.css
+#  - stylesheets/*.css
+
+#  Return an array of filepaths relative to spec_dir to include before jasmine specs.
+#spec_files:
+#  - **/*.js
+
+#  Source directory path. Your src_files must be returned relative to this path. Will use root if left blank.
+#src_dir:
+
+#  Spec directory path. Your spec_files must be returned relative to this path.
+#spec_dir: spec/javascripts

data/generators/jasmine/templates/spec/javascripts/support/jasmine_config.rb

@@ -0,0 +1,61 @@
+require 'jasmine'
+
+class Jasmine::Config
+
+# Override these methods if necessary
+
+#  def project_root
+#    Dir.pwd
+#  end
+
+#  Path to your jasmine.yml
+#  def simple_config_file
+#    File.join(project_root, 'spec/javascripts/support/jasmine.yml')
+#  end
+
+#  Source directory path. Your src_files must be returned relative to this path.
+#  def src_dir
+#    if simple_config['src_dir']
+#      File.join(project_root, simple_config['src_dir'])
+#    else
+#      project_root
+#    end
+#  end
+
+#  Spec directory path. Your spec_files must be returned relative to this path.
+#  def spec_dir
+#    if simple_config['spec_dir']
+#      File.join(project_root, simple_config['spec_dir'])
+#    else
+#      File.join(project_root, 'spec/javascripts')
+#    end
+#  end
+
+#  Return an array of filepaths relative to src_dir to include before jasmine specs.
+#  def src_files
+#    files = []
+#    if simple_config['src_files']
+#      files = simple_config['src_files'].collect {|filepath| Dir.glob(filepath)}
+#    end
+#    files
+#  end
+
+#  Return an array of filepaths relative to spec_dir to include before jasmine specs.
+#  def spec_files
+#    files = match_files(spec_dir, "**/*.js")
+#    if simple_config['spec_files']
+#      files = simple_config['spec_files'].collect {|filepath| Dir.glob(filepath)}
+#    end
+#    files
+#  end
+
+#  Return an array of filepaths relative to src_dir to include before jasmine specs.
+#  def stylesheets
+#    files = []
+#    if simple_config['stylesheets']
+#      files = simple_config['stylesheets'].collect {|filepath| Dir.glob(filepath)}
+#    end
+#    files
+#  end
+
+end

data/generators/jasmine/templates/spec/javascripts/support/jasmine_runner.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require File.expand_path(File.join(File.dirname(__FILE__), 'jasmine_config'))
+
+jasmine_config = Jasmine::Config.new
+spec_builder = Jasmine::SpecBuilder.new(jasmine_config)
+
+should_stop = false
+
+Spec::Runner.configure do |config|
+  config.after(:suite) do
+    spec_builder.stop if should_stop
+  end
+end
+
+spec_builder.start
+should_stop = true
+spec_builder.declare_suites

data/jasmine/contrib/ruby/jasmine_runner.rb

@@ -0,0 +1,334 @@
+require 'socket'
+require 'erb'
+require 'json'
+
+module Jasmine
+  def self.root
+    File.expand_path(File.join(File.dirname(__FILE__), '../..'))
+  end
+
+  # this seemingly-over-complex method is necessary to get an open port on at least some of our Macs
+  def self.open_socket_on_unused_port
+    infos = Socket::getaddrinfo("localhost", nil, Socket::AF_UNSPEC, Socket::SOCK_STREAM, 0, Socket::AI_PASSIVE)
+    families = Hash[*infos.collect { |af, *_| af }.uniq.zip([]).flatten]
+
+    return TCPServer.open('0.0.0.0', 0) if families.has_key?('AF_INET')
+    return TCPServer.open('::', 0) if families.has_key?('AF_INET6')
+    return TCPServer.open(0)
+  end
+
+  def self.find_unused_port
+    socket = open_socket_on_unused_port
+    port = socket.addr[1]
+    socket.close
+    port
+  end
+
+  def self.server_is_listening_on(hostname, port)
+    require 'socket'
+    begin
+      socket = TCPSocket.open(hostname, port)
+    rescue Errno::ECONNREFUSED
+      return false
+    end
+    socket.close
+    true
+  end
+
+  def self.wait_for_listener(port, name = "required process", seconds_to_wait = 10)
+    time_out_at = Time.now + seconds_to_wait
+    until server_is_listening_on "localhost", port
+      sleep 0.1
+      puts "Waiting for #{name} on #{port}..."
+      raise "#{name} didn't show up on port #{port} after #{seconds_to_wait} seconds." if Time.now > time_out_at
+    end
+  end
+
+  def self.kill_process_group(process_group_id, signal="TERM")
+    Process.kill signal, -process_group_id # negative pid means kill process group. (see man 2 kill)
+  end
+
+  def self.cachebust(files, root_dir="", replace=nil, replace_with=nil)
+    require 'digest/md5'
+    files.collect do |file_name|
+      real_file_name = replace && replace_with ? file_name.sub(replace, replace_with) : file_name
+      begin
+        digest = Digest::MD5.hexdigest(File.read("#{root_dir}#{real_file_name}"))
+      rescue
+        digest = "MISSING-FILE"
+      end
+      "#{file_name}?cachebust=#{digest}"
+    end
+  end
+
+  class RunAdapter
+    def initialize(spec_files_or_proc, options = {})
+      @spec_files_or_proc = Jasmine.files(spec_files_or_proc) || []
+      @jasmine_files = Jasmine.files(options[:jasmine_files]) || [
+        "/__JASMINE_ROOT__/lib/" + File.basename(Dir.glob("#{Jasmine.root}/lib/jasmine*.js").first),
+        "/__JASMINE_ROOT__/lib/TrivialReporter.js",
+        "/__JASMINE_ROOT__/lib/json2.js",
+        "/__JASMINE_ROOT__/lib/consolex.js",
+      ]
+      @stylesheets = ["/__JASMINE_ROOT__/lib/jasmine.css"] + (Jasmine.files(options[:stylesheets]) || [])
+      @spec_helpers = Jasmine.files(options[:spec_helpers]) || []
+    end
+
+    def call(env)
+      run
+    end
+
+    def run
+      stylesheets = @stylesheets
+      spec_helpers = @spec_helpers
+      spec_files = @spec_files_or_proc
+
+      jasmine_files = @jasmine_files
+      jasmine_files = jasmine_files.call if jasmine_files.respond_to?(:call)
+
+      css_files = @stylesheets
+
+
+      body = ERB.new(File.read(File.join(File.dirname(__FILE__), "run.html"))).result(binding)
+      [
+        200,
+        { 'Content-Type' => 'text/html' },
+        body
+      ]
+    end
+
+
+  end
+
+  class Redirect
+    def initialize(url)
+      @url = url
+    end
+
+    def call(env)
+      [
+        302,
+        { 'Location' => @url },
+        []
+      ]
+    end
+  end
+
+  class JsAlert
+    def call(env)
+      [
+        200,
+        { 'Content-Type' => 'application/javascript' },
+        "document.write('<p>Couldn\\'t load #{env["PATH_INFO"]}!</p>');"
+      ]
+    end
+  end
+
+  class FocusedSuite
+    def initialize(spec_files_or_proc, options)
+      @spec_files_or_proc = Jasmine.files(spec_files_or_proc) || []
+      @options = options
+    end
+
+    def call(env)
+      spec_files = @spec_files_or_proc
+      matching_specs = spec_files.select {|spec_file| spec_file =~ /#{Regexp.escape(env["PATH_INFO"])}/ }.compact
+      if !matching_specs.empty?
+        run_adapter = Jasmine::RunAdapter.new(matching_specs, @options)
+        run_adapter.run
+      else
+        [
+          200,
+          { 'Content-Type' => 'application/javascript' },
+          "document.write('<p>Couldn\\'t find any specs matching #{env["PATH_INFO"]}!</p>');"
+        ]
+      end
+    end
+
+  end
+
+  class SimpleServer
+    def self.start(port, spec_files_or_proc, mappings, options = {})
+      require 'thin'
+      config = {
+        '/__suite__' => Jasmine::FocusedSuite.new(spec_files_or_proc, options),
+        '/run.html' => Jasmine::Redirect.new('/'),
+        '/' => Jasmine::RunAdapter.new(spec_files_or_proc, options)
+      }
+      mappings.each do |from, to|
+        config[from] = Rack::File.new(to)
+      end
+
+      config["/__JASMINE_ROOT__"] = Rack::File.new(Jasmine.root)
+
+      app = Rack::Cascade.new([
+        Rack::URLMap.new(config),
+        JsAlert.new
+      ])
+
+      begin
+        Thin::Server.start('0.0.0.0', port, app)
+      rescue RuntimeError => e
+        raise e unless e.message == 'no acceptor'
+        raise RuntimeError.new("A server is already running on port #{port}")
+      end
+    end
+  end
+
+  class SimpleClient
+    def initialize(selenium_host, selenium_port, selenium_browser_start_command, http_address)
+      require 'selenium/client'
+      @driver = Selenium::Client::Driver.new(
+        selenium_host,
+        selenium_port,
+        selenium_browser_start_command,
+        http_address
+      )
+      @http_address = http_address
+    end
+
+    def tests_have_finished?
+      @driver.get_eval("window.jasmine.getEnv().currentRunner.finished") == "true"
+    end
+
+    def connect
+      @driver.start
+      @driver.open("/")
+    end
+
+    def disconnect
+      @driver.stop
+    end
+
+    def run
+      until tests_have_finished? do
+        sleep 0.1
+      end
+
+      puts @driver.get_eval("window.results()")
+      failed_count = @driver.get_eval("window.jasmine.getEnv().currentRunner.results().failedCount").to_i
+      failed_count == 0
+    end
+
+    def eval_js(script)
+      escaped_script = "'" + script.gsub(/(['\\])/) { '\\' + $1 } + "'"
+
+      result = @driver.get_eval(" try { eval(#{escaped_script}, window); } catch(err) { window.eval(#{escaped_script}); }")
+      JSON.parse("[#{result}]")[0]
+    end
+  end
+
+  class Runner
+    def initialize(selenium_jar_path, spec_files, dir_mappings, options={})
+      @selenium_jar_path = selenium_jar_path
+      @spec_files = spec_files
+      @dir_mappings = dir_mappings
+      @options = options
+
+      @browser = options[:browser] ? options[:browser].delete(:browser) : 'firefox'
+      @selenium_pid = nil
+      @jasmine_server_pid = nil
+      @selenium_host = 'localhost'
+      @jasmine_server_port = Jasmine::find_unused_port
+      @selenium_server_port = Jasmine::find_unused_port
+    end
+
+    def start
+      start_jasmine_server
+      start_selenium_server
+      @client = Jasmine::SimpleClient.new(@selenium_host, @selenium_server_port, "*#{@browser}", "http://localhost:#{@jasmine_server_port}/")
+      @client.connect
+    end
+
+    def stop
+      @client.disconnect
+      stop_selenium_server
+      stop_jasmine_server
+    end
+
+    def start_jasmine_server
+      @jasmine_server_pid = fork do
+        Process.setpgrp
+        Jasmine::SimpleServer.start(@jasmine_server_port, @spec_files, @dir_mappings, @options)
+        exit! 0
+      end
+      puts "jasmine server started.  pid is #{@jasmine_server_pid}"
+      Jasmine::wait_for_listener(@jasmine_server_port, "jasmine server")
+    end
+
+    def start_selenium_server
+      @selenium_pid = fork do
+        Process.setpgrp
+        exec "java -jar #{@selenium_jar_path} -port #{@selenium_server_port} > /dev/null 2>&1"
+      end
+      puts "selenium started.  pid is #{@selenium_pid}"
+      Jasmine::wait_for_listener(@selenium_server_port, "selenium server")
+    end
+
+    def stop_jasmine_server
+      puts "shutting down Jasmine server..."
+      Jasmine::kill_process_group(@jasmine_server_pid) if @jasmine_server_pid
+    end
+
+    def stop_selenium_server
+      puts "shutting down Selenium server..."
+      Jasmine::kill_process_group(@selenium_pid) if @selenium_pid
+    end
+
+    def run
+      begin
+        start
+        puts "servers are listening on their ports -- running the test script..."
+        tests_passed = @client.run
+      ensure
+        stop
+      end
+      return tests_passed
+    end
+
+    def eval_js(script)
+      @client.eval_js(script)
+    end
+  end
+
+  class SauceLabsRunner < Runner
+    def initialize(spec_files, dir_mappings, options={})
+      @spec_files = spec_files
+      @dir_mappings = dir_mappings
+      @options = options
+
+      @browser = options[:browser] ? options[:browser].delete(:browser) : 'firefox'
+      @jasmine_server_pid = nil
+      @jasmine_server_port = Jasmine::find_unused_port
+      @saucelabs_config = SeleniumConfig.new(options[:saucelabs_config], options[:saucelabs_config_file], @jasmine_server_port)
+    end
+
+    def start_selenium_server
+      @sauce_tunnel = SauceTunnel.new(@saucelabs_config)
+    end
+
+    def start
+      start_jasmine_server
+      start_selenium_server
+      @client = Jasmine::SimpleClient.new(@saucelabs_config['selenium_server_address'],
+                  4444,
+                  @saucelabs_config['selenium_browser_key'],
+                  "http://#{@saucelabs_config['application_address']}")
+      @client.connect
+    end
+
+    def stop
+      @client.disconnect
+      @sauce_tunnel.shutdown
+      stop_jasmine_server
+    end
+
+  end
+
+  def self.files(f)
+    result = f
+    result = result.call if result.respond_to?(:call)
+    result
+  end
+
+end