snapdragon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 060c173490d27d0726bb3e47791d9aeae29ed196
+  data.tar.gz: 2dd3df4162edd3d0fffb0862651c1cfb8a07c2d9
+SHA512:
+  metadata.gz: 168b20c3b123901008ec0cbbbdd3320f44a63d3ce3eb3b3df2124d8b0eb20b9f22198e8e6fdcedfe756843d83ba3f06f58f3a0a663d24f8d565e299a0b6458fd
+  data.tar.gz: 3d169461aaa8517e85c8a98d8e82c84551aff91529480d0adb02b92d2a3ee6bbb11227c0ebd0d8dc0eb79e60550355e0ddcbfdf97fd439e06f8e15a8fa7c8edc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/jasmine"]
+	path = lib/jasmine
+	url = git://github.com/pivotal/jasmine.git

data/.ruby-gemset

@@ -0,0 +1 @@
+snapdragon

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jasmine-cl-runner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew De Ponte, ReachLocal, Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 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/README.md

@@ -0,0 +1,225 @@
+# Snapdragon
+
+**A command-line [Jasmine](http://pivotal.github.io/jasmine/) (JavaScript) test runner built with developer workflow in mind.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'snapdragon'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snapdragon
+
+## Install PhantomJS
+
+You need at least [PhantomJS](http://phantomjs.org) 1.8.1. There are no other
+external dependencies (you don't need Qt, or a running X server, etc.)
+
+### Mac OS X
+
+I recommend installing [PhantomJS](http://phantomjs.org/) using
+[Homebrew](http://mxcl.github.io/homebrew/) on Mac OS X. Using
+[Homebrew](http://mxcl.github.io/homebrew/) it can be installed as easily as
+running the following command:
+
+    $ brew install phantomjs
+
+## Quick Start Guide
+
+For those of you that like to jump right in and start playing with new tools
+follow the steps below to get started.
+
+1. Install [Snapdragon](http://github.com/reachlocal/snapdragon) and
+   [PhantomJS](http://phantomjs.org/) as outlined above.
+
+2. Create a simple [Jasmine](http://pivotal.github.io/jasmine/) spec file
+   `example/spec/hoopty_spec.js` with the following content. Note: the
+   `// require_relative()` directive at the top of the file. This tells
+   [Snapdragon](http://github.com/reachlocal/snapdragon) what
+   implementation file(s) it needs to run the specs in this file.
+
+    ```javascript
+    // require_relative('../src/hoopty.js')
+
+    describe("Hoopty", function() {
+      describe(".hello", function() {
+        it("says hello there", function() {
+          var f = new Hoopty();
+          expect(f.hello()).toBe("Hello There");
+        });
+      });
+    });
+    ```
+
+3. Create the implementation file for the spec file `example/src/hoopty.js`
+   with the following content.
+
+    ```javascript
+    var Hoopty = function() {
+      this.hello = function() {
+        return "Hello There";
+      }
+    };
+    ```
+
+4. Run your spec file with the following command:
+
+    ```text
+    $ snapdragon example/spec/hoopty_spec.js
+    ```
+
+    You should see output that looks similar to the following.
+
+    ```text
+    Running examples...
+
+    Finished in 0.001 seconds
+    1 example, 0 failures
+    ```
+
+Thats it, you now have [Snapdragon](http://github.com/reachlocal/snapdragon)
+running a [Jasmine](http://pivotal.github.io/jasmine/) spec.
+
+## Usage (snapdragon)
+
+The *snapdragon* command allows you to run your
+[Jasmine](http://pivotal.github.io/jasmine/) specs from the command-line just
+as you would with RSpec and other testing tools. The following are some usage
+examples.
+
+#### Run a specific describe/it block
+
+The following runs the describe or it block that corresponds to line number
+*23* in the *spec/javascript/foo_spec.js* file.
+
+```
+snapdragon spec/javascript/foo_spec.js:23
+```
+
+#### Run an entire spec file(s)
+
+```
+snapdragon spec/javascript/foo_spec.js spec/javascript/bar_spec.js
+```
+
+#### Run an entire directory of spec files
+
+```
+snapdragon spec/javascripts
+```
+
+#### Run combination of files and directories
+
+```
+snapdragon spec/javascript custom_js/tests/foo_spec.js custom_js/test/bar_spec.js
+```
+
+## Usage (snapdragon_server)
+
+The *snapdragon_server* command allows you to run your
+[Jasmine](http://pivotal.github.io/jasmine/) specs in your browser. When this
+command is run it will launch the *snapdragon_server* and open your default
+browser to the proper URL to run your specified test suite. This is especially
+useful if you want to debug some JavaScript as your browser most likely has a
+JavaScript debugger built into it. A few examples of this commands usage
+follow.
+
+#### Run specific spec files
+
+```
+snapdragon_server spec/javascript/foo_spec.js spec/javascript/bar_spec.js
+```
+
+#### Run all the specs in directories
+
+```
+snapdragon_server spec/javascript custom_js/specs
+```
+
+#### Combine files and directories
+
+```
+snapdragon_server spec/javascript custom_js/tests/foo_spec.js custom_js/test/bar_spec.js
+```
+
+## // require_relative() directive
+
+Snapdragon also provides a `// require_relative()` directive that the
+Snapdragon preprocessor looks for to identify the necessary implementation
+files that need to be loaded for the spec files to run. This directive should
+define the relative path to associated implementation files needed for a spec,
+relative to that spec file. The following is an example spec and implemantion
+file.
+
+*example/src/hoopty.js*
+
+```javascript
+var Hoopty = function() {
+  this.hello = function() {
+    return "Hello There";
+  }
+};
+```
+
+*example/spec/hoopty_spec.js*
+
+```javascript
+// require_relative('../src/hoopty.js')
+
+describe("Hoopty", function() {
+  it("exists", function() {
+    var f = new Hoopty();
+    expect(f).not.toBe(undefined);
+  });
+
+  describe(".hello", function() {
+    it("says hello there", function() {
+      var f = new Hoopty();
+      expect(f.hello()).toBe("Hello There");
+    });
+  });
+});
+
+```
+
+## The Back Story
+
+If you have ever used [Jasmine](http://pivotal.github.io/jasmine/) for your
+JavaScript BDD style testing framework I am sure you have run into the
+following issues just as I have.
+
+1. Getting up and running with [Jasmine](http://pivotal.github.io/jasmine/) is
+   quite a pain and the examples of how to setup your SpecRunner.html are
+   sparse.
+2. Having to manually add the dependency files and spec files to the
+   SpecRunner.html is a huge pain in the ass.
+3. Limiting a test run to a specific spec file is near impossible with the
+   only solution being to comment out script tags in your SpecRunner.html.
+4. Limiting a test run to a specific *describe* or *it* block is near
+   impossible because the only way to do it is with the *spec* query param that
+   matches the full description of the *describe* or *it* block including all
+   its parents. This can be very long and very prone to typos if you try to
+   do this.
+5. Oh, and did I mention that you have to do all of this in a browser with the
+   SpecRunner.html loaded which is not where you actually write your code.
+
+The above issues created a horrible development workflow. Especially
+since I came from the world of RSpec where the above issues are non-existent
+and it is easily run from the command line and integrated into most editors.
+
+Snapdragon is my preferred solution to the above listed issues.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write your tests & dev your feature using BDD/TDD with RSpec.
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/build_jspec_filter.rb

@@ -0,0 +1,45 @@
+#!/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
+
+

data/bin/snapdragon

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'snapdragon/cli_application'
+
+app = Snapdragon::CliApplication.new(ARGV)
+exit(app.run)

data/bin/snapdragon_server

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'snapdragon/cli_application'
+
+app = Snapdragon::CliApplication.new(ARGV)
+app.serve

data/example/spec/hoopty_spec.js

@@ -0,0 +1,24 @@
+// require_relative('../src/hoopty.js')
+
+// This is just some example Jasmine spec code to test that everything would
+// work assuming that I can find a way to get the spec code loaded in here
+// like this.
+describe("Hoopty", function() {
+  it("exists", function() {
+    var f = new Hoopty();
+    expect(f).not.toBe(undefined);
+  });
+
+  it("handles pending", function() {
+  });
+
+  it("handles another pending", function() {
+  });
+
+  describe(".hello", function() {
+    it("says hello there", function() {
+      var f = new Hoopty();
+      expect(f.hello()).toBe("Hello There");
+    });
+  });
+});

data/example/src/hoopty.js

@@ -0,0 +1,8 @@
+// This is just some test implementation code to test that everything would
+// work assuming that I can find a way to get the implementation code
+// loaded in here like this.
+var Hoopty = function() {
+  this.hello = function() {
+    return "Hello There";
+  }
+};

data/lib/snapdragon/cli_application.rb

@@ -0,0 +1,73 @@
+require 'capybara'
+require 'capybara/poltergeist'
+require 'launchy'
+
+require_relative './web_application'
+require_relative './suite'
+require_relative './spec_file'
+require_relative './spec_directory'
+
+module Snapdragon
+  class CliApplication
+    def initialize(arguements)
+      @args = arguements
+      @suite = Snapdragon::Suite.new
+    end
+
+    def run
+      parse_arguements(@args)
+      run_suite
+      return 0
+    end
+
+    def serve
+      parse_arguements(@args)
+      server = Capybara::Server.new(Snapdragon::WebApplication.new(nil, @suite), 9292)
+      server.boot
+      Launchy.open('http://localhost:9292/run')
+      trap('SIGINT') { puts "Shutting down..."; exit 0 }
+      sleep
+    end
+
+    private
+
+    def parse_arguements(arguements)
+      arguements.each do |arguement|
+        parse_arguement(arguement)
+      end
+    end
+
+    def parse_arguement(arguement)
+      if is_a_file_path_and_line_number?(arguement)
+        path, line_num_str = arguement.split(':')
+        @suite.add_spec_file(SpecFile.new(path, line_num_str.to_i))
+      elsif is_a_file_path?(arguement)
+        @suite.add_spec_file(SpecFile.new(arguement))
+      elsif is_a_directory?(arguement)
+        spec_dir = Snapdragon::SpecDirectory.new(arguement)
+        @suite.add_spec_files(spec_dir.spec_files)
+      end
+    end
+
+    def is_a_file_path_and_line_number?(arguement)
+      arguement =~ /^[\w\/\-\d]+[s|S]pec\.js:\d+$/
+    end
+
+    def is_a_file_path?(arguement)
+      arguement =~ /^[\w\/\-\d]+[s|S]pec\.js$/
+    end
+
+    def is_a_directory?(arguement)
+      arguement =~ /^[\w\/\-\d]+$/
+    end
+
+    def run_suite
+      session = Capybara::Session.new(:poltergeist, Snapdragon::WebApplication.new(nil, @suite))
+      if @suite.filtered?
+        session.visit("/run?spec=#{@suite.spec_query_param}")
+      else
+        session.visit("/run")
+      end
+    end
+  end
+end

data/lib/snapdragon/resources/ConsoleReporter.js

@@ -0,0 +1,137 @@
+getJasmineRequireObj().ConsoleReporter = function() {
+  function ConsoleReporter(options) {
+    var print = function(msg) { console.log(msg); },
+      showColors = options.showColors || true,
+      onComplete = options.onComplete || function() {},
+      specCount,
+      failureCount,
+      passedCount,
+      failedSpecs = [],
+      pendingSpecs = [],
+      pendingCount,
+      ansi = {
+        green: '\033[32m',
+        red: '\033[31m',
+        yellow: '\033[33m',
+        none: '\033[0m'
+      };
+
+    this.jasmineStarted = function() {
+      specCount = 0;
+      failureCount = 0;
+      passedCount = 0;
+      pendingCount = 0;
+      print("Running examples...");
+      printNewline();
+    };
+
+    this.jasmineDone = function(options) {
+      if (pendingCount > 0) {
+        print("Pending:");
+      }
+
+      for (var i = 0; i < pendingSpecs.length; i++) {
+        specPendingDetails(pendingSpecs[i]);
+      }
+
+      if (failureCount > 0) {
+        print("Failures:");
+        printNewline();
+      }
+
+      for (var i = 0; i < failedSpecs.length; i++) {
+        specFailureDetails(failedSpecs[i], i + 1);
+      }
+
+      var specCounts = specCount + " " + plural("example", specCount) + ", " + failureCount + " " + plural("failure", failureCount);
+
+      if (pendingCount) {
+        specCounts += ", " + pendingCount + " pending";
+      }
+      
+      var seconds = options.executionTime / 1000;
+      print("Finished in " + seconds + " " + plural("second", seconds));
+
+      if (failureCount > 0) { // have any failures
+        print(colored("red", specCounts));
+      } else if (pendingCount > 0) {
+        print(colored("yellow", specCounts));
+      } else {
+        print(colored("green", specCounts));
+      }
+
+      onComplete();
+    };
+
+    this.specDone = function(result) {
+      if (result.status !== "disabled") {
+        specCount++;
+      }
+
+      if (result.status == "pending") {
+        pendingCount++;
+        pendingSpecs.push(result);
+        return;
+      }
+
+      if (result.status == "passed") {
+        passedCount++;
+        return;
+      }
+
+      if (result.status == "failed") {
+        failureCount++;
+        failedSpecs.push(result);
+        return;
+      }
+    };
+
+    return this;
+
+    function printNewline() {
+      print("");
+    }
+
+    function colored(color, str) {
+      return showColors ? (ansi[color] + str + ansi.none) : str;
+    }
+
+    function plural(str, count) {
+      return count == 1 ? str : str + "s";
+    }
+
+    function repeat(thing, times) {
+      var arr = [];
+      for (var i = 0; i < times; i++) {
+        arr.push(thing);
+      }
+      return arr;
+    }
+
+    function indent(str, spaces) {
+      var lines = (str || '').split("\n");
+      var newArr = [];
+      for (var i = 0; i < lines.length; i++) {
+        newArr.push(repeat(" ", spaces).join("") + lines[i]);
+      }
+      return newArr.join("\n");
+    }
+
+    function specFailureDetails(result, failure_number) {
+      print(indent(failure_number + ") " + result.fullName, 2));
+
+      for (var i = 0; i < result.failedExpectations.length; i++) {
+        var failedExpectation = result.failedExpectations[i];
+        print(colored("red", indent(failedExpectation.message, 6)));
+      }
+      printNewline();
+    }
+
+    function specPendingDetails(result) {
+      print(indent(colored("yellow", result.fullName), 2));
+      printNewline();
+    }
+  }
+
+  return ConsoleReporter;
+};

data/lib/snapdragon/spec_directory.rb

@@ -0,0 +1,19 @@
+require_relative './spec_file'
+
+module Snapdragon
+  class SpecDirectory
+    def initialize(path)
+      @path = path
+    end
+
+    def spec_files
+      spec_paths = []
+      Dir.glob("#{@path}/**/*").each do |path|
+        if path =~ /^[\w\/\-\d]+[s|S]pec\.js$/
+          spec_paths << Snapdragon::SpecFile.new(path)
+        end
+      end
+      return spec_paths
+    end
+  end
+end