snapdragon 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbdd1c01780d6cf840d1c324b4b410b3c624064b
-  data.tar.gz: 469c7ba58f97d16cd7962a59553c83a8341067c8
+  metadata.gz: f3a7b0cc75a3e31b11e8b5e1ff8c9dedf268e281
+  data.tar.gz: dd8fac388619a5529c7947f0bfcdf4f25ca972d9
 SHA512:
-  metadata.gz: c439d1a2fac54d154883624364f85e6cd39f283841ab0b4f9c1a090741b7ee1e3acff83b723d21f1fcf29b89d97fbb26fd35f2a03aad053e431f96fb40e94508
-  data.tar.gz: 16403dfa69ed351d35ddf21f633f2fa854e9084d56689d70c2af3fc41993ebed8a8bdbf3186ff36c985dcceaa5016aee6ce5cdc864ed83c71308dc74591dca41
+  metadata.gz: 6c04bd17f44c3241ebf9f75e0306fd7afef3387f288655ef329b11e92e9af1a1abdf6d05658ee6929dd6923aa2b0d68a5a1844718c08e875d73802382671e318
+  data.tar.gz: 2162787b797a49f53c8f1de29172c973c1c68710efc92b9b21d153fc1ea334ccbe4c175a6e0f109d8912e608d9e31d0dc194721e99c2fd90335152c763e5e8b2

data/ChangeLog.markdown

@@ -6,6 +6,12 @@ versions as well as provide a rough history.
 
 #### Next Release
 
+#### v0.1.10
+
+* added --format junit switch to make it output JUnit format for CI servers
+* added -v and --version switches to notify users of the version
+* added -h and --help switches to notify users of the proper usage
+
 #### v0.1.9
 
 * fixed bug preventing require\_relatives with no tailing whitespace from being

data/README.markdown

@@ -42,8 +42,7 @@ $ brew install phantomjs
 
 If you are a visual learner Brian Miller and I have put together a Free
 [Snapdragon](http://github.com/reachlocal/snapdragon) Screencast at [The Code
-Breakdown](http://codebreakdown.com) ([direct
-download](http://codebreakdown.com/screencasts/7/download)).
+Breakdown](http://codebreakdown.com).
 
 [![It in Action](http://media.codebreakdown.com/thumbnails/tcb-0007-thumbnail-400x225.png)](http://codebreakdown.com)
 

data/bin/snapdragon

@@ -3,7 +3,9 @@
 $LOAD_PATH.unshift ::File.expand_path(::File.dirname(__FILE__) + '/../lib')
 
 require 'rubygems'
+require 'snapdragon/command_line_parser'
 require 'snapdragon/cli_application'
 
-app = Snapdragon::CliApplication.new(ARGV)
+opts = Snapdragon::CommandLineParser.parse(ARGV)
+app = Snapdragon::CliApplication.new(opts, ARGV)
 exit(app.run)

data/bin/snapdragon_server

@@ -3,7 +3,9 @@
 $LOAD_PATH.unshift ::File.expand_path(::File.dirname(__FILE__) + '/../lib')
 
 require 'rubygems'
+require 'snapdragon/command_line_parser'
 require 'snapdragon/cli_application'
 
-app = Snapdragon::CliApplication.new(ARGV)
+opts = Snapdragon::CommandLineParser.parse(ARGV)
+app = Snapdragon::CliApplication.new(opts, ARGV)
 app.serve

data/example/src/jack.js

@@ -0,0 +1,2 @@
+// This is here so that the spec_helper.js file can do a require_relative()
+// directive and we can test that it is working properly.

data/lib/snapdragon/cli_application.rb

@@ -13,9 +13,8 @@ Capybara.default_wait_time = 120 # 2 mins
 
 module Snapdragon
   class CliApplication
-    def initialize(arguements)
-      @args = arguements
-      @suite = Snapdragon::Suite.new(arguements)
+    def initialize(options, paths)
+      @suite = Snapdragon::Suite.new(options, paths)
     end
 
     def run

data/lib/snapdragon/command_line_parser.rb

@@ -0,0 +1,30 @@
+require 'optparse'
+require 'ostruct'
+require_relative './version'
+
+module Snapdragon
+  class CommandLineParser
+    def self.parse(args)
+      options = OpenStruct.new
+      options.format = "console" 
+
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: snapdragon [options] [files or directories]"
+        opts.on('-v', '--version', "Show the current version of this gem") do
+          puts "#{Snapdragon::VERSION}"; exit
+        end
+        opts.on('-h', '--help', "show usage") do
+          puts opts; exit
+        end
+        opts.on('-f', '--format [FORMAT]', "set output format") do |format|
+          options.format = format
+        end
+        if args.empty?
+          puts opts; exit
+        end
+      end
+      opts.parse!(args)
+      options
+    end
+  end
+end

data/lib/snapdragon/resources/SnapdragonJUnitReporter.js

@@ -0,0 +1,171 @@
+/*
+ * This is the junit reporter provided in the jasmine-reporters project
+ * available at https://github.com/larrymyers/jasmine-reporters
+ */
+(function() {
+
+  if (typeof jasmine == 'undefined') {
+    throw new Error("jasmine library does not exist in global namespace!");
+  }
+
+  function elapsed(startTime, endTime) {
+    return (endTime - startTime)/1000;
+  }
+
+  function ISODateString(d) {
+    function pad(n) { return n < 10 ? '0'+n : n; }
+
+    return d.getFullYear() + '-' +
+      pad(d.getMonth()+1) + '-' +
+      pad(d.getDate()) + 'T' +
+      pad(d.getHours()) + ':' +
+      pad(d.getMinutes()) + ':' +
+      pad(d.getSeconds());
+  }
+
+  function trim(str) {
+    return str.replace(/^\s+/, "" ).replace(/\s+$/, "" );
+  }
+
+  function escapeInvalidXmlChars(str) {
+    return str.replace(/\&/g, "&amp;")
+      .replace(/</g, "&lt;")
+      .replace(/\>/g, "&gt;")
+      .replace(/\"/g, "&quot;")
+      .replace(/\'/g, "&apos;");
+  }
+
+  var JUnitXmlReporter = function() {
+    this.useDotNotation = true;
+  };
+
+  JUnitXmlReporter.prototype = {
+    reportSpecStarting: function(spec) {
+      spec.startTime = new Date();
+
+      if (!spec.suite.startTime) {
+        spec.suite.startTime = spec.startTime;
+      }
+    },
+
+    reportSpecResults: function(spec) {
+      var results = spec.results();
+      spec.didFail = !results.passed();
+      spec.duration = elapsed(spec.startTime, new Date());
+      spec.output = '<testcase classname="' + this.getFullName(spec.suite) +
+        '" name="' + escapeInvalidXmlChars(spec.description) + '" time="' + spec.duration + '">';
+      if(results.skipped) {
+        spec.output = spec.output + "<skipped />";
+      }
+
+      var failure = "";
+      var failures = 0;
+      var resultItems = results.getItems();
+      for (var i = 0; i < resultItems.length; i++) {
+        var result = resultItems[i];
+
+        if (result.type == 'expect' && result.passed && !result.passed()) {
+          failures += 1;
+          failure += '<failure type="' + result.type + '" message="' + trim(escapeInvalidXmlChars(result.message)) + '">';
+          failure += escapeInvalidXmlChars(result.trace.stack || result.message);
+          failure += "</failure>";
+        }
+      }
+      if (failure) {
+        spec.output += failure;
+      }
+      spec.output += "</testcase>";
+    },
+
+    reportSuiteResults: function(suite) {
+      var results = suite.results();
+      var specs = suite.specs();
+      var specOutput = "";
+      // for JUnit results, let's only include directly failed tests (not nested suites')
+      var failedCount = 0;
+
+      suite.status = results.passed() ? 'Passed.' : 'Failed.';
+      if (results.totalCount === 0) { // todo: change this to check results.skipped
+        suite.status = 'Skipped.';
+      }
+
+      // if a suite has no (active?) specs, reportSpecStarting is never called
+      // and thus the suite has no startTime -- account for that here
+      suite.startTime = suite.startTime || new Date();
+      suite.duration = elapsed(suite.startTime, new Date());
+
+      for (var i = 0; i < specs.length; i++) {
+        failedCount += specs[i].didFail ? 1 : 0;
+        specOutput += "\n  " + specs[i].output;
+      }
+      suite.output = '\n<testsuite name="' + this.getFullName(suite) +
+        '" errors="0" tests="' + specs.length + '" failures="' + failedCount +
+        '" time="' + suite.duration + '" timestamp="' + ISODateString(suite.startTime) + '">';
+      suite.output += specOutput;
+      suite.output += "\n</testsuite>";
+    },
+
+    reportRunnerResults: function(runner) {
+      var suites = runner.suites();
+      for (var i = 0; i < suites.length; i++) {
+        var suite = suites[i];
+        var output = '<?xml version="1.0" encoding="UTF-8" ?>';
+        // if we are consolidating, only write out top-level suites
+        if (suite.parentSuite) {
+          continue;
+        }
+        else {
+          output += "\n<testsuites>";
+          output += this.getNestedOutput(suite);
+          output += "\n</testsuites>";
+          this.print(output);
+        }
+      }
+      this.signalCapybaraTestsFinishedRunning();
+    },
+
+    signalCapybaraTestsFinishedRunning:  function() {
+      var div = document.createElement('div');
+      div.id = 'testscomplete';
+      document.body.appendChild(div);
+    },
+
+    getNestedOutput: function(suite) {
+      var output = suite.output;
+      for (var i = 0; i < suite.suites().length; i++) {
+        output += this.getNestedOutput(suite.suites()[i]);
+      }
+      return output;
+    },
+
+    getFullName: function(suite, isFilename) {
+      var fullName;
+      if (this.useDotNotation) {
+        fullName = suite.description;
+        for (var parentSuite = suite.parentSuite; parentSuite; parentSuite = parentSuite.parentSuite) {
+          fullName = parentSuite.description + '.' + fullName;
+        }
+      }
+      else {
+        fullName = suite.getFullName();
+      }
+
+      // Either remove or escape invalid XML characters
+      if (isFilename) {
+        return fullName.replace(/[^\w]/g, "");
+      }
+      return escapeInvalidXmlChars(fullName);
+    },
+
+    print: function(str) {
+      var console = jasmine.getGlobal().console;
+
+      if (console && console.log) {
+        console.log(str);
+      }
+    }
+  };
+
+  // export public
+  jasmine.SnapdragonJUnitReporter = JUnitXmlReporter;
+})();

data/lib/snapdragon/suite.rb

@@ -2,10 +2,15 @@ require_relative './path'
 
 module Snapdragon
   class Suite
-    def initialize(paths)
+    def initialize(options, paths)
+      @options = options
       @paths = paths
     end
 
+    def formatter
+      @options.format
+    end
+
     def spec_files
       spec_file_objs = []
 

data/lib/snapdragon/version.rb

@@ -1,3 +1,3 @@
 module Snapdragon
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

data/lib/snapdragon/views/run.erb

@@ -2,7 +2,11 @@
 <script type="text/javascript" src="/jasmine-core/jasmine.js"></script>
 <script type="text/javascript" src="/jasmine-core/jasmine-html.js"></script>
 
+<% if @suite.formatter == "junit" %>
+<script type="text/javascript" src="/resources/SnapdragonJUnitReporter.js"></script>
+<% else %>
 <script type="text/javascript" src="/resources/SnapdragonConsoleReporter.js"></script>
+<% end %>
 
 <!-- The implementation code the spec files being tested need -->
 <% @suite.require_file_relative_url_paths.each do |path| %>
@@ -20,16 +24,20 @@
     jasmineEnv.updateInterval = 1000;
 
     var htmlReporter = new jasmine.HtmlReporter();
-
     jasmineEnv.addReporter(htmlReporter);
 
-    var snapdragonConsoleReporter = new jasmine.SnapdragonConsoleReporter({});
-    jasmineEnv.addReporter(snapdragonConsoleReporter);
-
     jasmineEnv.specFilter = function(spec) {
       return htmlReporter.specFilter(spec);
     };
 
+    <% if @suite.formatter == "junit" %>
+      var snapdragonJUnitReporter = new jasmine.SnapdragonJUnitReporter();
+      jasmineEnv.addReporter(snapdragonJUnitReporter);
+    <% else %>
+      var snapdragonConsoleReporter = new jasmine.SnapdragonConsoleReporter({});
+      jasmineEnv.addReporter(snapdragonConsoleReporter);
+    <% end %>
+
     var currentWindowOnload = window.onload;
 
     window.onload = function() {

data/spec/lib/snapdragon/cli_application_spec.rb

@@ -2,28 +2,23 @@ require_relative '../../../lib/snapdragon/cli_application'
 
 describe Snapdragon::CliApplication do
   describe "#initialize" do
-    it "stores a copy of the given command line arguments" do
-      cmd_line_args = stub('command_line_args')
-      cli_app = Snapdragon::CliApplication.new(cmd_line_args)
-      cli_app.instance_variable_get(:@args).should eq(cmd_line_args)
-    end
-
     it "creates an empty Suite" do
       Snapdragon::Suite.should_receive(:new)
-      Snapdragon::CliApplication.new(stub)
+      Snapdragon::CliApplication.new(stub, stub)
     end
 
     it "assigns the new Suite to an instance variable" do
       suite = stub('suite')
       Snapdragon::Suite.stub(:new).and_return(suite)
-      app = Snapdragon::CliApplication.new(stub)
+      app = Snapdragon::CliApplication.new(stub, stub)
       app.instance_variable_get(:@suite).should eq(suite)
     end
   end
 
   describe "#run" do
-    let(:arguements) { stub('arguments') }
-    subject { Snapdragon::CliApplication.new(arguements) }
+    let(:paths) { stub('paths') }
+    let(:options) { stub('options') }
+    subject { Snapdragon::CliApplication.new(options, paths) }
 
     it "creates a capybara session" do
       suite = stub(filtered?: false)

data/spec/lib/snapdragon/command_line_parser_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require_relative '../../../lib/snapdragon/command_line_parser'
+
+describe Snapdragon::CommandLineParser do
+  describe "#parse" do
+    subject { Snapdragon::CommandLineParser }
+    
+    it "display version information" do
+      output = capture_stdout { subject.parse(["-v"]) }
+      output.should match(/\d+\.\d+\.\d+/)
+    end
+    
+    it "exit once version information is displayed" do
+      lambda { hide_stdout { subject.parse(["-v"]) } }.should raise_error(SystemExit)
+    end
+    
+    it "display usage information" do
+      output = capture_stdout { subject.parse(["-h"]) }
+      output.should match(/Usage/)
+    end
+    
+    it "exit once usage information is displayed" do
+      lambda { hide_stdout { subject.parse(["-h"]) } }.should raise_error(SystemExit)
+    end
+    
+    context "no args supplied" do
+      it "exit" do
+        lambda { hide_stdout { subject.parse([]) } }.should raise_error(SystemExit)
+      end
+    end
+    
+    context "args supplied" do
+      it "continue execution" do
+        lambda { subject.parse(["spec/hello_spec.rb"]) }.should_not raise_error(SystemExit)
+      end
+    end
+
+    context "when format is provided" do
+      it "sets the format value" do
+        subject.parse(["--format", "junit", "spec/hello_spec.rb"]).format.should eq "junit"
+      end
+    end
+
+    context "when format is not provided" do
+      it "defaults to console" do
+        subject.parse(["spec/hello_spec.rb"]).format.should eq "console"
+      end
+    end
+  end
+end

data/spec/lib/snapdragon/suite_spec.rb

@@ -3,29 +3,49 @@ require_relative '../../../lib/snapdragon/suite'
 describe Snapdragon::Suite do
   describe "#initialize" do
     it "constucts an instance of a Suite given an array of paths" do
+      options = stub
       paths = [stub, stub, stub]
-      Snapdragon::Suite.new(paths)
+      Snapdragon::Suite.new(options, paths)
     end
 
     it "stores the paths in an instance variable" do
+      options = stub
       paths = [stub, stub, stub]
-      suite = Snapdragon::Suite.new(paths)
+      suite = Snapdragon::Suite.new(options, paths)
       suite.instance_variable_get(:@paths).should eq(paths)
     end
+
+    it 'stores the options in an instance variable' do
+      options = stub
+      paths = [stub, stub, stub]
+      suite = Snapdragon::Suite.new(options, paths)
+      suite.instance_variable_get(:@options).should eq(options)
+    end
+  end
+
+  describe "#formatter" do
+    it "returns the configured formatter to use" do
+      formatter = stub
+      options = stub(format: formatter)
+      suite = Snapdragon::Suite.new(options, stub)
+      suite.formatter.should eq (formatter)
+    end
   end
 
   describe "#spec_files" do
     it "creates a path object to represent the path" do
+      options = stub
       paths = ['path_a_str', 'path_b_str']
-      suite = Snapdragon::Suite.new(paths)
+      suite = Snapdragon::Suite.new(options, paths)
       Snapdragon::Path.should_receive(:new).with('path_a_str').and_return(stub(spec_files: []))
       Snapdragon::Path.should_receive(:new).with('path_b_str').and_return(stub(spec_files: []))
       suite.spec_files
     end
 
     it "returns the collection of the spec files of all of the paths" do
+      options = stub
       paths = ['path_a_str', 'path_b_str']
-      suite = Snapdragon::Suite.new(paths)
+      suite = Snapdragon::Suite.new(options, paths)
       spec_file_a = stub('spec_file_a'), spec_file_b = stub('spec_file_b')
       Snapdragon::Path.stub(:new).with('path_a_str').and_return(stub(spec_files: [spec_file_a]))
       Snapdragon::Path.stub(:new).with('path_b_str').and_return(stub(spec_files: [spec_file_b]))

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# Capturing the stdout
+# Need to rescue SystemExit
+# https://github.com/cldwalker/hirb/blob/master/test/test_helper.rb
+def capture_stdout(&block)
+  original_stdout = $stdout
+  fake_stdout = StringIO.new
+  $stdout = fake_stdout
+  begin
+    yield
+  rescue SystemExit
+  ensure
+    $stdout = original_stdout
+  end
+  return fake_stdout.string
+end
+
+# for hiding the stdout from tests
+def hide_stdout(&block)
+  original_stdout = $stdout
+  fake_stdout = StringIO.new
+  $stdout = fake_stdout
+  begin
+    yield
+  ensure
+    $stdout = original_stdout
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapdragon
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Andrew De Ponte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
+date: 2013-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -113,7 +113,6 @@ description: A Jasmine JavaScript test runner that lets you run tests on the com
 email:
 - cyphactor@gmail.com
 executables:
-- build_jspec_filter.rb
 - snapdragon
 - snapdragon_server
 extensions: []
@@ -128,7 +127,6 @@ files:
 - LICENSE.txt
 - README.markdown
 - Rakefile
-- bin/build_jspec_filter.rb
 - bin/snapdragon
 - bin/snapdragon_server
 - example/spec/bar_spec.js
@@ -138,10 +136,12 @@ files:
 - example/src/jack.js
 - lib/snapdragon.rb
 - lib/snapdragon/cli_application.rb
+- lib/snapdragon/command_line_parser.rb
 - lib/snapdragon/file_base.rb
 - lib/snapdragon/path.rb
 - lib/snapdragon/resources/.gitkeep
 - lib/snapdragon/resources/SnapdragonConsoleReporter.js
+- lib/snapdragon/resources/SnapdragonJUnitReporter.js
 - lib/snapdragon/spec_directory.rb
 - lib/snapdragon/spec_file.rb
 - lib/snapdragon/suite.rb
@@ -151,6 +151,7 @@ files:
 - lib/snapdragon/web_application.rb
 - snapdragon.gemspec
 - spec/lib/snapdragon/cli_application_spec.rb
+- spec/lib/snapdragon/command_line_parser_spec.rb
 - spec/lib/snapdragon/path_spec.rb
 - spec/lib/snapdragon/spec_directory_spec.rb
 - spec/lib/snapdragon/spec_file_spec.rb
@@ -192,6 +193,7 @@ specification_version: 4
 summary: A command-line Jasmine JavaScript test runner.
 test_files:
 - spec/lib/snapdragon/cli_application_spec.rb
+- spec/lib/snapdragon/command_line_parser_spec.rb
 - spec/lib/snapdragon/path_spec.rb
 - spec/lib/snapdragon/spec_directory_spec.rb
 - spec/lib/snapdragon/spec_file_spec.rb

data/bin/build_jspec_filter.rb

@@ -1,45 +0,0 @@
-#!/usr/bin/env ruby
-
-if ARGV[0].nil?
-  exit(1)
-end
-
-jspec_file_path, initial_line_number = ARGV[0].split(':')
-if initial_line_number.nil?
-  # Run the file without spec query param set
-else
-  # Work our way from the line number up to build the spec query param
-  # description
-  initial_line_number = initial_line_number.to_i
-
-  initial_line_index = initial_line_number - 1
-
-  f = open(jspec_file_path, 'r')
-  lines = f.readlines
-  f.close
-
-  desc_components = []
-
-  already_been_inside_an_it = false
-  already_been_inside_a_describe = false
-  last_describe_indent_spaces = 1232131312
-
-  cur_line_index = initial_line_index
-  while cur_line_index >= 0 
-    if lines[cur_line_index] =~ /it\s*\(\s*"(.+)"\s*,/ && !already_been_inside_an_it && !already_been_inside_a_describe # line matches it statement
-      desc_components.push($1)
-      already_been_inside_an_it = true
-    elsif lines[cur_line_index] =~ /(\s*)describe\s*\(\s*"(.+)"\s*,/ # line matches a describe block
-      if $1.length < last_describe_indent_spaces # use indent depth to identify parent
-        desc_components.push($2)
-        last_describe_indent_spaces = $1.length
-      end
-      already_been_inside_a_describe = true
-    end
-    cur_line_index -= 1
-  end
-
-  puts desc_components.reverse.join(" ")
-end
-
-