jasmine-headless-webkit 0.0.2 → 0.0.3

data/README.md

@@ -1,27 +1,26 @@
 # Jasmine Headless WebKit runner
 
+Run your specs at sonic boom speed! No pesky reload button or page rendering slowdowns!
+
 ## Introduction
 
-This gem works with projects that have used the [Jasmine gem](https://github.com/pivotal/jasmine-gem) to 
+This gem works with projects that have used the [Jasmine gem](https://github.com/pivotal/jasmine-gem) to
 create a `jasmine.yml` file that defines what to test. The runner loads that
-`jasmine.yml` file and executes the
-tests in a Qt WebKit widget, displaying the results to the console and setting the exit code to one
-of the following:
+`jasmine.yml` file and executes the tests defined within in a Qt WebKit widget, displaying the results
+to the console and setting the exit code to one of the following:
 
 * 0 for success
 * 1 for spec run failure
 * 2 for spec run success, but `console.log` was called during the run
 
-`console.log` works, too, so you can run your specs side-by-side in a browser if you're so inclined.
+`console.log` works, too, so you can run your specs side-by-side in a browser if you're so inclined. It
+serializes whatever you're passing in as as JSON string, so objects that are cyclical in nature will not
+serialize. If anyone has a good solution for this, please suggest and/or fork'n'fix.
 
 ## Installation
 
 `gem install jasmine-headless-webkit` or use Bundler.
 
-## Usage
-
-    jasmine-headless-webkit [path to jasmine.yml, defaults to spec/javascripts/support/jasmine.yml]
-
 Installation requires Qt 4.7. See [senchalabs/examples](https://github.com/senchalabs/examples) and [my fork
 of examples](https://github.com/johnbintz/examples) for more information on the QtWebKit runner.
 
@@ -30,6 +29,54 @@ Tested in the following environments:
 * Mac OS X 10.6, with MacPorts Qt and Nokia Qt.mpkg
 * Kubuntu 10.10
 
+Let me know via a message or in the Issues section if it works on your setup and it's not listed!
+
+## Usage
+
+    jasmine-headless-webkit [options] [path to jasmine.yml, defaults to spec/javascripts/support/jasmine.yml]
+
+Current supported options:
+
+* `-c`/`--colors` enables color output
+* `--no-colors` disables color output
+
+These options can also be placed into a `.jasmine-headless-webkit` file in your project root.
+
+### JavaScript Dialogs
+
+You can call `alert()` and `confirm()` in your code. `alert()` will print the message to the console, and
+`confirm()` will always return true. There's no way right now to respond to `confirm()`, so it's best to
+mock that call:
+
+    spyOn(window, 'confirm').andReturn(false);
+
+### Autotest Integration
+
+`jasmine-headless-webkit` can integrate with Autotest. Your `jasmine.yml` file needs to be in the default
+path, and you have to be ready to use a very alpha implementation of the feature. If used with RSpec 2,
+Jasmine tests run after RSpec tests.
+
+You need to create a `.jasmine-headless-webkit` file in your project root for this integration
+to work.
+
+`jasmine-headless-webkit` provides two new hooks: `:run_jasmine` and `:ran_jasmine` for before and after the
+Jasmine specs have run. This is a good place to do things like re-package all your assets using 
+[Jammit](http://documentcloud.github.com/jammit/):
+
+    Autotest.add_hook(:run_jasmine) do |at|
+      system %{jammit}
+    end
+
+### Server Interaction
+
+`jasmine-headless-webkit` works the same as if you create an HTML file, manually load the Jasmine library and
+your code & tests into the page, and open that page in a browser. Because of this, there's no way to handle
+server interaction with your application or with a Jasmine server. If you need to test server interaction,
+do one of the following:
+
+* Stub your server responses using [Sinon.JS](http://sinonjs.org/)
+* Use [PhantomJS](http://www.phantomjs.org/) against a running copy of a Jasmine server, instead of this project
+
 ## License
 
 * Copyright (c) 2011 John Bintz
@@ -54,4 +101,3 @@ 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.
 
-

data/bin/jasmine-headless-webkit

@@ -2,10 +2,41 @@
 
 require 'yaml'
 require 'fileutils'
+require 'getoptlong'
 
-data = YAML.load_file(ARGV[0] || 'spec/javascripts/support/jasmine.yml')
+opts = GetoptLong.new(
+  [ '--colors', '-c', GetoptLong::NO_ARGUMENT ],
+  [ '--no-colors', GetoptLong::NO_ARGUMENT ]
+)
+
+options = { :colors => false }
+
+process_options = lambda { |*args|
+  opt = args.shift
+  case opt
+  when '--colors', '-c'
+    options[:colors] = true
+  when '--no-colors', '-nc'
+    options[:colors] = false
+  end
+}
+
+if File.file?('.jasmine-headless-webkit')
+  File.readlines('.jasmine-headless-webkit').collect { |line| line.strip.split(' ', 2) }.flatten(1).each(&process_options)
+end
+
+opts.each(&process_options)
+
+data = YAML.load_file(ARGV.shift || 'spec/javascripts/support/jasmine.yml')
 gem_dir = File.expand_path('../..', __FILE__)
 
+if !File.file?(File.join(gem_dir, 'ext/jasmine-webkit-specrunner/jasmine-webkit-specrunner'))
+  puts "The Qt WebKit widget is not compiled! Try re-installing this gem."
+  exit 1
+end
+
+puts "Running Jasmine specs..."
+
 files = [
   'file://' + File.join(gem_dir, 'jasmine/lib/jasmine.js'),
   'file://' + File.join(gem_dir, 'jasmine/lib/jasmine-html.js'),
@@ -63,7 +94,7 @@ window.console = { log: function(data) { debug.log(JSON.stringify(data)); } };
 HTML
 
 File.open(target = "specrunner.#{$$}.html", 'w') { |fh| fh.print output }
-system %{#{File.join(gem_dir, 'ext/jasmine-webkit-specrunner/jasmine-webkit-specrunner')} #{target}}
+system %{#{File.join(gem_dir, 'ext/jasmine-webkit-specrunner/jasmine-webkit-specrunner')} #{options[:colors] ? '-c' : ''} #{target}}
 status = $?.exitstatus
 FileUtils.rm_f target
 

data/ext/jasmine-webkit-specrunner/specrunner.cpp

@@ -34,8 +34,11 @@ class HeadlessSpecRunnerPage: public QWebPage
   Q_OBJECT
 signals:
   void consoleLog(const QString &msg, int lineNumber, const QString &sourceID);
+  void internalLog(const QString &note, const QString &msg);
 protected:
   void javaScriptConsoleMessage(const QString & message, int lineNumber, const QString & sourceID);
+  bool javaScriptConfirm(QWebFrame *frame, const QString &msg);
+  void javaScriptAlert(QWebFrame *frame, const QString &msg);
 };
 
 void HeadlessSpecRunnerPage::javaScriptConsoleMessage(const QString &message, int lineNumber, const QString &sourceID)
@@ -43,18 +46,31 @@ void HeadlessSpecRunnerPage::javaScriptConsoleMessage(const QString &message, in
   emit consoleLog(message, lineNumber, sourceID);
 }
 
+bool HeadlessSpecRunnerPage::javaScriptConfirm(QWebFrame *frame, const QString &msg)
+{
+  emit internalLog("TODO", "jasmine-headless-webkit can't handle confirm() yet! You should mock window.confirm for now. Returning true."); 
+  return true;
+}
+
+void HeadlessSpecRunnerPage::javaScriptAlert(QWebFrame *frame, const QString &msg)
+{
+  emit internalLog("alert", msg);
+}
+
 class HeadlessSpecRunner: public QObject
 {
     Q_OBJECT
 public:
     HeadlessSpecRunner();
     void load(const QString &spec);
+    void setColors(bool colors);
 public slots:
     void log(const QString &msg);
     void specLog(int indent, const QString &msg, const QString &clazz);
 private slots:
     void watch(bool ok);
     void errorLog(const QString &msg, int lineNumber, const QString &sourceID);
+    void internalLog(const QString &note, const QString &msg);
 protected:
     bool hasElement(const char *select);
     void timerEvent(QTimerEvent *event);
@@ -64,6 +80,12 @@ private:
     int m_runs;
     bool hasErrors;
     bool usedConsole;
+    bool showColors;
+    
+    void red();
+    void green();
+    void yellow();
+    void clear();
 };
 
 HeadlessSpecRunner::HeadlessSpecRunner()
@@ -71,10 +93,12 @@ HeadlessSpecRunner::HeadlessSpecRunner()
     , m_runs(0)
     , hasErrors(false)
     , usedConsole(false)
+    , showColors(false)
 {
     m_page.settings()->enablePersistentStorage();
     connect(&m_page, SIGNAL(loadFinished(bool)), this, SLOT(watch(bool)));
     connect(&m_page, SIGNAL(consoleLog(QString, int, QString)), this, SLOT(errorLog(QString, int, QString)));
+    connect(&m_page, SIGNAL(internalLog(QString, QString)), this, SLOT(internalLog(QString, QString)));
 }
 
 void HeadlessSpecRunner::load(const QString &spec)
@@ -101,9 +125,36 @@ bool HeadlessSpecRunner::hasElement(const char *select)
     return !m_page.mainFrame()->findFirstElement(select).isNull();
 }
 
+void HeadlessSpecRunner::setColors(bool colors)
+{
+    showColors = colors;
+}
+
+void HeadlessSpecRunner::red()
+{
+  if (showColors) std::cout << "\033[0;31m";
+}
+
+void HeadlessSpecRunner::green()
+{
+  if (showColors) std::cout << "\033[0;32m";
+}
+
+void HeadlessSpecRunner::yellow()
+{
+  if (showColors) std::cout << "\033[0;33m";
+}
+
+void HeadlessSpecRunner::clear()
+{
+  if (showColors) std::cout << "\033[m";
+}
+
 void HeadlessSpecRunner::errorLog(const QString &msg, int lineNumber, const QString &sourceID)
 {
-  std::cout << "\033[0;31m" << "[error] " << "\033[m;";
+  red();
+  std::cout << "[error] ";
+  clear();
   std::cout << qPrintable(sourceID) << ":" << lineNumber << " : " << qPrintable(msg);
   std::cout << std::endl;
 
@@ -112,10 +163,20 @@ void HeadlessSpecRunner::errorLog(const QString &msg, int lineNumber, const QStr
   m_ticker.start(200, this);
 }
 
+void HeadlessSpecRunner::internalLog(const QString &note, const QString &msg) {
+  red();
+  std::cout << "[" << qPrintable(note) << "] ";
+  clear();
+  std::cout << qPrintable(msg);
+  std::cout << std::endl;
+}
+
 void HeadlessSpecRunner::log(const QString &msg)
 {
   usedConsole = true;
-  std::cout << "\033[0;32m" << "[console] " << "\033[m";
+  green();
+  std::cout << "[console] ";
+  clear();
   std::cout << qPrintable(msg);
   std::cout << std::endl;
 }
@@ -125,10 +186,12 @@ void HeadlessSpecRunner::specLog(int indent, const QString &msg, const QString &
     for (int i = 0; i < indent; ++i)
         std::cout << "  ";
     if ( clazz.endsWith("fail") ) {
-        std::cout << "\033[0;31m" << qPrintable(msg) << "\033[m";
+        red();
     } else {
-        std::cout << "\033[0;33m" << qPrintable(msg) << "\033[m";
+        yellow();
     }
+    std::cout << qPrintable(msg);
+    clear();
     std::cout << std::endl;
 }
 
@@ -162,16 +225,21 @@ void HeadlessSpecRunner::timerEvent(QTimerEvent *event)
 
       if (hasElement(".runner.passed")) {
           QWebElement desc = m_page.mainFrame()->findFirstElement(".description");
-          std::cout << "\033[0;32m" << "PASS: " << qPrintable(desc.toPlainText()) << "\033[m" << std::endl;
+          green();
+          std::cout << "PASS: " << qPrintable(desc.toPlainText());
+          clear();
+          std::cout << std::endl;
           QApplication::instance()->exit(usedConsole ? 2 : 0);
           return;
       }
 
       if (hasElement(".runner.failed")) {
           QWebElement desc = m_page.mainFrame()->findFirstElement(".description");
-          std::cout << "\033[0;31m" << "FAIL: " << qPrintable(desc.toPlainText()) << "\033[m" << std::endl;
+          red();
+          std::cout << "FAIL: " << qPrintable(desc.toPlainText());
+          clear();
+          std::cout << std::endl;
           m_page.mainFrame()->evaluateJavaScript(DUMP_MSG);
-  //QDesktopServices::openUrl(m_page.mainFrame()->url());
           QApplication::instance()->exit(1);
           return;
       }
@@ -187,16 +255,37 @@ void HeadlessSpecRunner::timerEvent(QTimerEvent *event)
 
 int main(int argc, char** argv)
 {
-    if (argc != 2) {
+    bool showColors = false;
+    char *filename = NULL;
+
+    int c, index;
+
+    while ((c = getopt(argc, argv, "c")) != -1) {
+      switch(c) {
+        case 'c':
+          showColors = true;
+          break;
+      }
+    }
+
+    bool filenameFound = false;
+
+    for (index = optind; index < argc; index++) {
+      filename = argv[index];
+      filenameFound = true;
+    }
+
+    if (!filenameFound) {
         std::cerr << "Run Jasmine's SpecRunner headlessly" << std::endl << std::endl;
-        std::cerr << "  specrunner SpecRunner.html" << std::endl;
+        std::cerr << "  specrunner [-c] SpecRunner.html" << std::endl;
         return 1;
     }
 
     QApplication app(argc, argv);
 
     HeadlessSpecRunner runner;
-    runner.load(QString::fromLocal8Bit(argv[1]));
+    runner.setColors(showColors);
+    runner.load(QString::fromLocal8Bit(filename));
     return app.exec();
 }
 

data/lib/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { 'jasmine' if File.file?('./.jasmine-headless-webkit') }

data/lib/autotest/jasmine.rb

@@ -0,0 +1,7 @@
+require 'autotest'
+require 'autotest/jasmine_mixin'
+
+class Autotest::Jasmine < Autotest
+  include JasmineMixin
+end
+

data/lib/autotest/jasmine_mixin.rb

@@ -0,0 +1,92 @@
+module JasmineMixin
+  JASMINE_PROGRAM = File.expand_path('../../../bin/jasmine-headless-webkit', __FILE__)
+
+  JAVASCRIPT_EXTENSIONS = %w{js}
+
+  def self.included(klass)
+    klass::ALL_HOOKS << [ :run_jasmine, :ran_jasmine ]
+  end
+
+  attr_accessor :is_jasmine_running, :jasmine_to_run
+
+  def initialize
+    super()
+    setup_jasmine_project_mappings
+  end
+
+  def get_to_green
+    begin
+      reset_jasmine(:no)
+      super if find_files_to_test
+
+      reset_jasmine(:yes)
+      run_jasmine if find_files_to_test
+
+      self.is_jasmine_running = :all
+      wait_for_changes unless all_jasmine_good
+    end until all_jasmine_good
+
+    reset_jasmine(:all)
+  end
+
+  def reset_jasmine(method)
+    self.files_to_test = new_hash_of_arrays
+    self.is_jasmine_running = method
+  end
+
+  def run_jasmine
+    hook :run_jasmine
+
+    self.jasmine_to_run = :all
+
+    if mtime = find_files_to_test
+      self.last_mtime = mtime
+    end
+
+    begin
+      system make_jasmine_cmd
+
+      self.jasmine_to_run = ($?.exitstatus == 0) ? :none : :all
+    end
+
+    hook :ran_jasmine
+  end
+
+  def all_jasmine_good
+    self.jasmine_to_run == :none
+    self.files_to_test = new_hash_of_arrays
+  end
+
+  def find_files
+    Hash[super.find_all { |file, mtime|
+      is_js = (file[%r{\.(#{JAVASCRIPT_EXTENSIONS.join('|')})$}] != nil)
+
+      case self.is_jasmine_running
+      when :all
+        true
+      when :no
+        !is_js
+      when :yes
+        is_js
+      end
+    }]
+  end
+
+  def make_jasmine_cmd
+    "#{JASMINE_PROGRAM}"
+  end
+
+  def setup_jasmine_project_mappings
+    add_mapping(%r{spec/javascripts/.*_spec\.js}) { |filename, _|
+      filename
+    }
+
+    add_mapping(%r{public/javascripts/(.*)\.js}) { |_, m|
+      [ "spec/javascripts/#{m[1]}_spec.js" ]
+    }
+  end
+
+  def add_javascript_extensions(*extensions)
+    self.class::JAVASCRIPT_EXTENSIONS << extensions
+  end
+end

data/lib/autotest/jasmine_rspec2.rb

@@ -0,0 +1,7 @@
+require 'autotest/rspec2'
+require 'autotest/jasmine_mixin'
+
+class Autotest::JasmineRspec2 < Autotest::Rspec2
+  include JasmineMixin
+end
+

data/lib/jasmine-headless-webkit/version.rb

@@ -1,7 +1,7 @@
 module Jasmine
   module Headless
     module Webkit
-      VERSION = "0.0.2"
+      VERSION = "0.0.3"
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: jasmine-headless-webkit
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - John Bintz
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-13 00:00:00 -04:00
+date: 2011-05-04 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,13 +43,16 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- autotest/discover.rb
 - bin/jasmine-headless-webkit
 - ext/jasmine-webkit-specrunner/Info.plist
 - ext/jasmine-webkit-specrunner/extconf.rb
 - ext/jasmine-webkit-specrunner/specrunner.cpp
 - ext/jasmine-webkit-specrunner/specrunner.pro
 - jasmine-headless-webkit.gemspec
+- lib/autotest/discover.rb
+- lib/autotest/jasmine.rb
+- lib/autotest/jasmine_mixin.rb
+- lib/autotest/jasmine_rspec2.rb
 - lib/jasmine-headless-webkit.rb
 - lib/jasmine-headless-webkit/version.rb
 - spec/bin/jasmine-headless-webkit_spec.rb

data/autotest/discover.rb

@@ -1 +0,0 @@
-Autotest.add_discovery { 'rspec2' }