qunited 0.2.0 → 0.2.1

data/README.md

@@ -10,43 +10,79 @@ Tests are run with PhantomJS if available, otherwise Rhino (Java) is used. Give
 $ gem install qunited
 ```
 
-## Running Tests
+## Configuration
 
-Add the QUnited Rake task to your Rakefile.
+Add the QUnited Rake task to your Rakefile. Specify your source and test JavaScript files.
 
 ```ruby
 require 'qunited/rake_task'
 
 QUnited::RakeTask.new do |t|
-  t.source_files_pattern = 'lib/js/**/*.js'
+  t.source_files = ['lib/js/jquery.js', 'lib/js/my_app_1.js', 'lib/js/my_app_2.js']
   t.test_files_pattern = 'test/js/**/*.js'
 end
 ```
 
-Source and test files can also be configured as an array of file names. This may be desirable for source files since the order of their execution is often important. A glob pattern may not order the files correctly but configuring the task with an array can guarantee they are executed in the correct order.
+Source and test files can be configured either as an array of file names or a glob pattern (using the ```_pattern``` version). Using an array is usually desirable for source files since the order of their execution is often important. Note that all JavaScript dependencies will have to be loaded with source files, in the correct order, to match your production environment.
 
-Note that all JavaScript dependencies will have to be loaded with source files. They will often need to be loaded before your own code so using an array to configure source files may be appropriate.
+You can also use an array to configure the test files but a glob pattern might be more convenient since test files usually do not need to be loaded in a particular order.
 
-```ruby
-require 'qunited/rake_task'
+### Specifying a driver
+
+QUnited uses various drivers to set up the environment the tests run in (see below for more details). By default it tries to Just Work and find an available driver to use. You may want to lock down the driver (recommended) so your tests are consistent. To do this add a bit more configuration to the Rake task.
 
+```ruby
 QUnited::RakeTask.new do |t|
-  t.source_files = ['lib/js/jquery.js', 'lib/js/my_utils.js', 'lib/js/my_app.js']
-  t.test_files = ['test/js/test_my_utils.js', 'test/js/test_my_app.js']
+  t.source_files = ['lib/js/jquery.js', 'lib/js/my_app']
+  t.test_files_pattern = 'test/js/**/*.js'
+  t.driver = :phantomjs # Always use PhantomJS to run tests. Fail if it's not available.
 end
 ```
 
-Note that you can also use an array to configure the test files but a glob pattern is usually more convenient since test files usually do not need to be loaded in a particular order.
+Available drivers are ```:phantomjs``` and ```:rhino```. If no driver is specified QUnited will run tests with the best available driver, looking for them in that order.
+
+## Running tests
+
+Once the Rake task is configured as described above, run tests like this:
+
+```
+$ rake qunited
+```
+
+You should get output similar to minitest or Test::Unit
+
+```
+$ rake qunited
+qunited --driver phantomjs lib/js/jquery-1.4.2.js lib/js/helper.js test/js/app.js -- test/js/test_app.js
+
+# Running JavaScript tests with PhantomJS:
+
+.............
+
+Finished in 0.009 seconds, 1444.44 tests/s, 7777.78 assertions/s.
+
+13 tests, 70 assertions, 0 failures, 0 errors, 0 skips
+```
+
+## Drivers
+
+A JavaScript interpreter with browser APIs is necessary to run tests. Various drivers are provided to interface with programs to set up this environment.
+
+### PhantomJS
+
+PhantomJS is a headless WebKit. It is fast and provides an accurate browser environment (since it _is_ a browser).
+
+Find out how to install it [here](http://phantomjs.org/) or just ```brew install phantomjs``` if you have Homebrew.
 
-## Dependencies
+This driver is considered available if the ```phantomjs``` executable is on your $PATH.
 
-- PhantomJS
+### Rhino + Envjs
 
-OR
+Rhino is a JavaScript interpreter that runs on the JVM. Envjs provides a simulated browser environment in Rhino. Rhino+Envjs should be considered a fallback since it is slower and has some minor incompatibility with most browsers. However, most tests will run fine.
 
-- Java (version 1.1 minimum)
+Install Java 1.1 or greater to make this work.
 
-PhantomJS is preferred since it uses real WebKit and is faster. Running Rhino on Java should be considered a fallback.
+This driver is considered available if you have Java 1.1 or greater and the ```java``` executable is on your $PATH.
 
 ## Credits
 

data/lib/qunited/driver/base.rb

@@ -1,6 +1,9 @@
 module QUnited
   module Driver
     class Base
+      # Path of the common (to all drivers) supporting files directory
+      SUPPORT_DIR = File.expand_path('../support', __FILE__)
+
       attr_reader :results, :source_files, :test_files
 
       # Finds an executable on the PATH. Returns the absolute path of the
@@ -16,11 +19,6 @@ module QUnited
         return nil
       end
 
-      # Get the path of the common (to all drivers) supporting files directory
-      def self.support_dir
-        @@support_dir = File.expand_path('../support', __FILE__)
-      end
-
       # Array of file names? Glob pattern?
       def initialize(source_files, test_files)
         @source_files = if source_files.is_a? String
@@ -41,7 +39,7 @@ module QUnited
       end
 
       def support_file_path(filename)
-        File.join(self.class.support_dir, filename)
+        File.join(SUPPORT_DIR, filename)
       end
 
       def support_file_contents(filename)

data/lib/qunited/driver/phantomjs/phantomjs.rb

@@ -7,6 +7,7 @@ require 'open3'
 module QUnited
   module Driver
     class PhantomJs < Base
+      SUPPORT_DIR = File.expand_path('../support', __FILE__)
 
       # Determines whether this driver available to use.
       # Checks whether phantomjs is on the PATH.
@@ -26,7 +27,7 @@ module QUnited
         results_file = Tempfile.new('qunited_results')
         results_file.close
 
-        cmd = %{phantomjs "#{File.expand_path('../support/runner.js', __FILE__)}" }
+        cmd = %{phantomjs "#{File.join(SUPPORT_DIR, 'runner.js')}" }
         cmd << %{#{tests_file.path} #{results_file.path}}
 
         Open3.popen3(cmd) do |stdin, stdout, stderr|
@@ -36,7 +37,7 @@ module QUnited
           end
         end
 
-        @results = ::QUnited::Results.from_javascript_produced_json(IO.read(results_file))
+        @results = ::QUnited::Results.from_javascript_produced_json(IO.read(results_file.path))
       end
 
       private
@@ -44,11 +45,11 @@ module QUnited
       attr_accessor :tests_file
 
       def tests_page_content
-        ERB.new(IO.read(File.expand_path('../support/tests_page.html.erb', __FILE__))).result(binding)
+        ERB.new(IO.read(File.join(SUPPORT_DIR, 'tests_page.html.erb'))).result(binding)
       end
 
       def script_tag(file)
-        js_file_path, tests_file_path = Pathname.new(file).realpath, Pathname.new(tests_file)
+        js_file_path, tests_file_path = Pathname.new(file).realpath, Pathname.new(tests_file.path)
         begin
           rel_path = js_file_path.relative_path_from(tests_file_path)
           # Attempt to convert paths to relative URLs if Windows... should really test this

data/lib/qunited/driver/rhino/rhino.rb

@@ -5,6 +5,7 @@ require 'open3'
 module QUnited
   module Driver
     class Rhino < Base
+      SUPPORT_DIR = File.expand_path('../support', __FILE__)
 
       # Determines whether this driver available to use. Checks whether java
       # is on the PATH and whether Java is version 1.1 or greater.
@@ -22,8 +23,7 @@ module QUnited
       end
 
       def run
-        support_dir = File.expand_path('../support', __FILE__)
-        js_jar, runner = File.join(support_dir, 'js.jar'), File.join(support_dir, 'runner.js')
+        js_jar, runner = File.join(SUPPORT_DIR, 'js.jar'), File.join(SUPPORT_DIR, 'runner.js')
 
         source_files_args = @source_files.map { |sf| %{"#{sf}"} }.join(' ')
         test_files_args = @test_files.map { |tf| %{"#{tf}"} }.join(' ')
@@ -32,7 +32,7 @@ module QUnited
         results_file.close
 
         cmd = %{java -jar "#{js_jar}" -opt -1 "#{runner}" }
-        cmd << %{"#{QUnited::Driver::Base.support_dir}" "#{support_dir}" "#{results_file.path}"}
+        cmd << %{"#{QUnited::Driver::Base::SUPPORT_DIR}" "#{SUPPORT_DIR}" "#{results_file.path}"}
         cmd << " #{source_files_args} -- #{test_files_args}"
 
         # Swallow stdout but allow stderr to get blasted out to console - if there are uncaught
@@ -44,7 +44,7 @@ module QUnited
           unless (err = stderr.read).strip.empty? then $stderr.puts(err) end
         end
 
-        @results = ::QUnited::Results.from_javascript_produced_json(IO.read(results_file))
+        @results = ::QUnited::Results.from_javascript_produced_json(IO.read(results_file.path))
       end
     end
   end

data/lib/qunited/driver/support/qunited.js

@@ -62,7 +62,10 @@ QUnited.collectedTestResults = function() {
 
 /* Module results as a JSON string */
 QUnited.collectedTestResultsAsJson = function() {
-	return JSON.stringify(QUnited.collectedTestResults());
+	// The 3rd argument here adds spaces to the generated JSON string. This is necessary
+	// for YAML parsers that are not compliant with YAML 1.2 (the version where YAML became
+	// a true superset of JSON).
+	return JSON.stringify(QUnited.collectedTestResults(), null, 1);
 };
 
 })();

data/lib/qunited/results.rb

@@ -122,8 +122,11 @@ module QUnited
     end
 
     def times_line
-      "Finished in #{"%.6g" % total_time} seconds, #{"%.6g" % (total_tests/total_time)} tests/s, " +
-      "#{"%.6g" % (total_assertions/total_time)} assertions/s."
+      tests_per = (total_time > 0) ? (total_tests / total_time) : total_tests
+      assertions_per = (total_time > 0) ? (total_assertions / total_time) : total_assertions
+
+      "Finished in #{"%.6g" % total_time} seconds, #{"%.6g" % tests_per} tests/s, " +
+      "#{"%.6g" % assertions_per} assertions/s."
     end
 
     def failures_output

data/lib/qunited/runner.rb

@@ -43,8 +43,8 @@ module QUnited
     end
 
     def get_driver(klass)
-      if ::QUnited::Driver.constants.reject { |d| d == :Base }.include?(klass)
-        ::QUnited::Driver.const_get(klass)
+      if ::QUnited::Driver.constants.reject { |d| d == :Base }.include?(klass.to_s)
+        ::QUnited::Driver.const_get(klass.to_s)
       end
     end
 

data/lib/qunited/version.rb

@@ -1,3 +1,3 @@
 module QUnited
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'minitest/autorun'
 
 require File.join(File.dirname(__FILE__), *%w[.. lib qunited])

data/test/unit/test_runner.rb

@@ -10,14 +10,14 @@ end
 
 class TestRunner < MiniTest::Unit::TestCase
   def test_raises_exception_with_nonexistent_driver
-    runner = QUnited::Runner.new(['source.js'], ['test.js'], { driver: :doesNotExist })
+    runner = QUnited::Runner.new(['source.js'], ['test.js'], { :driver => :doesNotExist })
     assert_raises(QUnited::UsageError) do
       runner.resolve_driver_class
     end
   end
 
   def test_specified_driver_can_be_used_if_available
-    runner = QUnited::Runner.new(['source.js'], ['test.js'], { driver: :AvailableDriver })
+    runner = QUnited::Runner.new(['source.js'], ['test.js'], { :driver => :AvailableDriver })
 
     def runner.get_driver(klass)
       if klass == :AvailableDriver
@@ -30,7 +30,7 @@ class TestRunner < MiniTest::Unit::TestCase
   end
 
   def test_raises_exception_when_not_available_driver_is_specified
-    runner = QUnited::Runner.new(['source.js'], ['test.js'], { driver: :NotAvailableDriver })
+    runner = QUnited::Runner.new(['source.js'], ['test.js'], { :driver => :NotAvailableDriver })
 
     def runner.get_driver(klass)
       if klass == :NotAvailableDriver

metadata

@@ -1,24 +1,33 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: qunited
-version: !ruby/object:Gem::Version
-  version: 0.2.0
+version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
 platform: ruby
-authors:
+authors: 
 - Aaron Royer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-08 00:00:00.000000000 Z
+
+date: 2012-12-16 00:00:00 Z
 dependencies: []
+
 description: QUnited runs headless QUnit tests as part of your normal build
-email:
+email: 
 - aaronroyer@gmail.com
-executables:
+executables: 
 - qunited
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - MIT-LICENSE
@@ -66,29 +75,38 @@ files:
 - test/unit/test_runner.rb
 homepage: https://github.com/aaronroyer/qunited
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: qunited
-rubygems_version: 1.8.11
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: QUnit tests in your build
-test_files:
+test_files: 
 - test/fixtures/basic_project/app/assets/javascripts/application.js
 - test/fixtures/basic_project/test/javascripts/test_basics.js
 - test/fixtures/basic_project/test/javascripts/test_math.js