qunited 0.4.1 → 0.4.2

data/README.md

@@ -46,6 +46,18 @@ Source and test files can be configured either as an array of file names or a gl
 
 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.
 
+
+If you have some extra test helper libraries you would like to include (stubs, mocks) or files with other custom test setup, you can specify them as ```helper_files```.
+
+```ruby
+QUnited::RakeTask.new do |t|
+  t.source_files = ['lib/js/jquery.js', 'lib/js/my_app_1.js', 'lib/js/my_app_2.js']
+  t.helper_files = ['test/helpers/sinon-1.6.0.js']
+  t.test_files = 'test/js/**/*.js'
+end
+```
+These will be loaded after source files and before running tests. Separating helpers this way is merely for convenience and has the same effect as just including them last with your source files.
+
 ### 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.

data/lib/qunited/driver/base.rb

@@ -1,3 +1,5 @@
+require 'tempfile'
+
 module QUnited
   module Driver
     class Base
@@ -8,6 +10,8 @@ module QUnited
       TEST_RESULT_END_TOKEN   = 'QUNITED_TEST_RESULT_END_TOKEN'
       TEST_RESULT_REGEX       = /#{TEST_RESULT_START_TOKEN}(.*?)#{TEST_RESULT_END_TOKEN}/m
 
+      COFFEESCRIPT_EXTENSIONS = ['coffee', 'cs']
+
       attr_reader :results, :source_files, :test_files
       attr_accessor :formatter
 
@@ -24,19 +28,11 @@ module QUnited
         return nil
       end
 
-      # Array of file names? Glob pattern?
+      # Initialize the driver with source and test files. The files can be described either with
+      # glob patterns or arrays of file names.
       def initialize(source_files, test_files)
-        @source_files = if source_files.is_a? String
-          Dir.glob(source_files)
-        elsif source_files.is_a? Array
-          source_files
-        end
-
-        @test_files = if test_files.is_a? String
-          Dir.glob(test_files)
-        elsif test_files.is_a? Array
-          test_files
-        end
+        @source_files = normalize_files source_files
+        @test_files = normalize_files test_files
       end
 
       def run
@@ -60,6 +56,52 @@ module QUnited
       def send_to_formatter(method, *args)
         formatter.send(method, *args) if formatter
       end
+
+      # Hash that maps CoffeeScript file paths to temporary compiled JavaScript files. This is
+      # used partially because we need to keep around references to the temporary files or else
+      # they could be deleted.
+      def compiled_coffeescript_files
+        @compiled_coffeescript_files ||= {}
+      end
+
+      private
+
+      # Produces an array of JavaScript filenames from either a glob pattern or an array of
+      # JavaScript or CoffeeScript filenames. Files with CoffeeScript extensions will be
+      # compiled and replaced in the produced array with temp files of compiled JavaScript.
+      def normalize_files(files)
+        files = Dir.glob(files) if files.is_a? String
+
+        files.map do |file|
+          if COFFEESCRIPT_EXTENSIONS.include? File.extname(file).sub(/^\./, '')
+            compile_coffeescript file
+          else
+            file
+          end
+        end
+      end
+
+      # Compile the CoffeeScript file with the given filename to JavaScript. Returns the full
+      # path of the compiled JavaScript file. The file is created in a temporary directory.
+      def compile_coffeescript(file)
+        begin
+          require 'coffee-script'
+        rescue LoadError
+          msg = <<-ERROR_MSG
+You must install an additional gem to use CoffeeScript source or test files.
+Run the following command (with sudo if necessary): gem install coffee-script
+          ERROR_MSG
+          raise UsageError, msg
+        end
+
+        compiled_js_file = Tempfile.new(["compiled_#{File.basename(file).gsub('.', '_')}", '.js'])
+        compiled_js_file.write CoffeeScript.compile(File.read(file))
+        compiled_js_file.close
+
+        compiled_coffeescript_files[file] = compiled_js_file
+
+        compiled_js_file.path
+      end
     end
   end
 end

data/lib/qunited/version.rb

@@ -1,3 +1,3 @@
 module QUnited
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

data/test/fixtures/coffee_project/app/assets/javascripts/application.coffee

@@ -0,0 +1,6 @@
+
+APP = {}
+
+APP.one = () -> 1
+
+this.APP = APP

data/test/fixtures/coffee_project/app/assets/javascripts/application.js

@@ -0,0 +1,6 @@
+
+var APP = {};
+
+APP.one = function() {
+	return 1;
+};

data/test/fixtures/coffee_project/test/javascripts/test_basics.coffee

@@ -0,0 +1,4 @@
+
+test 'The source code was loaded', () ->
+  expect 1
+  equal APP.one(), 1, 'We have loaded it'

data/test/fixtures/coffee_project/test/javascripts/test_basics.js

@@ -0,0 +1,6 @@
+// Leave in default module
+
+test("The source code was loaded", function() {
+	expect(1);
+	equal(APP.one(), 1, "We have loaded it");
+});

data/test/fixtures/coffee_project/test/javascripts/test_math.coffee

@@ -0,0 +1,10 @@
+module 'Math'
+
+test 'Addition works', () ->
+  expect 2
+  equal 1 + 1, 2, 'One plus one does equal two'
+  equal 2 + 2, 4, 'Two plus two does equal four'
+
+test 'Subtraction works', () ->
+  expect 1
+  equal 2 - 1, 1, 'Two minus one equals one'

data/test/fixtures/coffee_project/test/javascripts/test_math.js

@@ -0,0 +1,12 @@
+module("Math");
+
+test("Addition works", function() {
+	expect(2);
+	equal(1 + 1, 2, "One plus one does equal two");
+	equal(2 + 2, 4, "Two plus two does equal four");
+});
+
+test("Subtraction works", function() {
+	expect(1);
+	equal(2 - 1, 1, "Two minus one equals one");
+});

data/test/unit/driver_common_tests.rb

@@ -73,6 +73,32 @@ module QUnited::DriverCommonTests
     run_tests_for_project 'basic_project', :formatter => mock_formatter
   end
 
+  def test_can_test_coffeescript
+    @results = run_tests_for_project 'coffee_project', :source_files => 'app/assets/javascripts/*.coffee'
+    assert_equal 3, total_tests, 'Correct number of tests run'
+    assert_equal 4, total_assertions, 'Correct number of assertions executed'
+    assert_equal 0, total_failed_tests, 'Correct number of failures given'
+  end
+
+  def test_can_run_coffeescript_tests
+    @results = run_tests_for_project 'coffee_project', :test_files => 'test/javascripts/*.coffee'
+    assert_equal 3, total_tests, 'Correct number of tests run'
+    assert_equal 4, total_assertions, 'Correct number of assertions executed'
+    if total_failed_tests == 1
+      STDOUT.puts @results.first.inspect
+      STDOUT.puts File.read(@results.first.data[:file])
+    end
+    assert_equal 0, total_failed_tests, 'Correct number of failures given'
+  end
+
+  def test_can_test_coffeescript_with_coffeescript_tests
+    @results = run_tests_for_project 'coffee_project',
+      :source_files => 'app/assets/javascripts/*.coffee', :test_files => 'test/javascripts/*.coffee'
+    assert_equal 3, total_tests, 'Correct number of tests run'
+    assert_equal 4, total_assertions, 'Correct number of assertions executed'
+    assert_equal 0, total_failed_tests, 'Correct number of failures given'
+  end
+
   protected
 
   def driver_class
@@ -86,7 +112,10 @@ module QUnited::DriverCommonTests
 
   def driver_for_project(project_name, opts={})
     Dir.chdir File.join(FIXTURES_DIR, project_name)
-    driver = driver_class.new("app/assets/javascripts/*.js", "test/javascripts/*.js")
+    driver = driver_class.new(
+      opts[:source_files] || 'app/assets/javascripts/*.js',
+      opts[:test_files] || 'test/javascripts/*.js'
+    )
     driver.formatter = opts[:formatter] if opts[:formatter]
     driver
   end

metadata

@@ -1,33 +1,24 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: qunited
-version: !ruby/object:Gem::Version 
-  hash: 13
+version: !ruby/object:Gem::Version
+  version: 0.4.2
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
 platform: ruby
-authors: 
+authors:
 - Aaron Royer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-23 00:00:00 Z
+date: 2013-04-12 00:00:00.000000000 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
@@ -63,6 +54,12 @@ 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
+- test/fixtures/coffee_project/app/assets/javascripts/application.coffee
+- test/fixtures/coffee_project/app/assets/javascripts/application.js
+- test/fixtures/coffee_project/test/javascripts/test_basics.coffee
+- test/fixtures/coffee_project/test/javascripts/test_basics.js
+- test/fixtures/coffee_project/test/javascripts/test_math.coffee
+- test/fixtures/coffee_project/test/javascripts/test_math.js
 - test/fixtures/dom_project/app/assets/javascripts/application.js
 - test/fixtures/dom_project/test/javascripts/test_misc.js
 - test/fixtures/errors_project/app/assets/javascripts/no_error.js
@@ -84,41 +81,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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: qunited
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 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
+- test/fixtures/coffee_project/app/assets/javascripts/application.coffee
+- test/fixtures/coffee_project/app/assets/javascripts/application.js
+- test/fixtures/coffee_project/test/javascripts/test_basics.coffee
+- test/fixtures/coffee_project/test/javascripts/test_basics.js
+- test/fixtures/coffee_project/test/javascripts/test_math.coffee
+- test/fixtures/coffee_project/test/javascripts/test_math.js
 - test/fixtures/dom_project/app/assets/javascripts/application.js
 - test/fixtures/dom_project/test/javascripts/test_misc.js
 - test/fixtures/errors_project/app/assets/javascripts/no_error.js