js-test-driver-rails 0.3.1 → 0.3.2

data/.gitignore

@@ -3,3 +3,4 @@
 .bundle
 jsTestDriver.conf
 pkg/*
+tags

data/README.markdown

@@ -0,0 +1,103 @@
+JS Test Driver Rails
+====================
+
+js-test-driver-rails is a thin wrapper for the JsTestDriver library: http://code.google.com/p/js-test-driver/
+
+Configuration
+------------
+
+To take advantage of js-test-driver-rails, you should create a js_test_driver.rb file in your RAILS_ROOT/config/ directory.
+
+The file may contain following directives:
+
+    # the paths are relative to the current directory, but you can use absolute paths too
+    # this is different from the JsTestDriver which does not allow you to use absolute paths in the config file 
+
+    # files to be included
+    # you can use Ruby globbing syntax (spec/js/**/*_spec.js), which will be automatically expanded
+    includes 'foo', 'bar', 'public/javascripts/*.js'
+
+    # files to be excluded, useful with globbing
+    excludes 'public/javascripts/fail.js'
+
+    # the host to which the test runner will connect, by default 'localhost'
+    host 'my-laptop'
+
+    # the port to which test runner will connect, and on which the test server will start, by default 4224
+    port 6666
+
+    # you can specify the default browsers which will be captured
+    browser 'firefox'
+
+Note, that this is a ruby file, so the file/browser list can be generated dynamically - it's completely up to you.
+
+For example in our project we examine a list of known browsers to determine the ones installed on the developer's system, and define only those that were found.
+
+Similarly we get the list of .js files to include from our asset packaging solution.
+
+HTML Fixtures
+-------------
+
+js-test-driver-rails also allows you to define HTML fixtures easily.
+
+Imagine you have a directory structure like this:
+
+    RAILS_ROOT:
+      test/
+        js/
+          fixtures/
+            foo/
+              a.html
+            a.html
+
+Then by defining the fixtures directory in your config file:
+
+    fixtures "test/js/fixtures"
+
+At runtime, your tests will have access to the contents of the fixture files:
+
+    htmlFixtures.all["a"] // contents of the test/js/fixtures/a.html
+    htmlFixtures.all["foo/a"] // contents of the test/js/fixtures/foo/a.html
+
+You can customize the namespace and fixture container name:
+
+    # the fixtures will be accessible through myApp.html["<fixture name goes here>"]
+    fixtures "test/js/fixtures", :name => "html", :namespace => "myApp"
+
+Using Jasmine
+-------------
+
+By default JsTestDriver comes with a pretty simple Test::Unit like testing framework.
+However it supports a couple of other frameworks, including Jasmine (http://pivotal.github.com/jasmine/), which is an RSpec-like BDD framework.
+
+If you want to user Jasmine, simply add:
+
+    enable_jasmine
+
+in your config file, somewhere before including your test files and you are golden:)
+
+Rake tasks
+----------
+
+This gem comes with some rake tasks, which you should require in your Rake file:
+
+    require "js_test_driver/tasks"
+
+To start the js test driver server:
+
+    rake js_test_driver:start_server
+
+To capture the default (or specified) browsers
+
+    rake js_test_driver:capture_browsers [BROWSERS=foo,bar,baz]
+
+To run the tests (all or the specified ones)
+
+    rake js_test_driver:run_tests [TESTS=TestCase[.testMethod]]
+
+To run the server, capture the browsers and run tests all in one command
+
+    rake js_test_driver:run [TESTS=TestCase[.testMethod]] [BROWSERS=foo,bar,baz] [OUTPUT_XML=1 | OUTPUT_PATH=/some/dir] [CAPTURE_CONSOLE=1]
+
+This last task is mostly useful on CI, because it's much faster to run the server and capture the browsers once and then run the tests again and again in development mode.
+

data/lib/js_test_driver/config.rb

@@ -17,18 +17,14 @@ module JsTestDriver
     #
     # JsTestDriver supports globbing
     def includes(*paths)
-      paths.each do |path|
-        self.included_files << File.expand_path(path)
-      end
+      self.included_files.concat(expand_globs(paths))
     end
 
     # Files specified here will not be loaded, it's useful when combined with globbing in includes
     #
     # paths should be relative to root_dir
     def excludes(*paths)
-      paths.each do |path|
-        self.excluded_files << File.expand_path(path)
-      end
+      self.excluded_files.concat(expand_globs(paths))
     end
 
     # Defines a browser to be captured by default
@@ -154,6 +150,11 @@ module JsTestDriver
 
     private
 
+    def expand_globs(paths)
+      with_expanded_paths = paths.map{|path| File.expand_path(path)}
+      return with_expanded_paths.map{|path| path.include?('*') ? Dir[path] : path}.flatten
+    end
+
     def fixture_file_name(fixture)
       File.expand_path(File.join(config_dir, "fixtures", fixture.namespace, "#{fixture.name}.js"))
     end

data/lib/js_test_driver/version.rb

@@ -1,3 +1,3 @@
 module JsTestDriver
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/test/unit/config_test.rb

@@ -13,7 +13,7 @@ module JsTestDriver
     end
 
     def given_an_empty_config
-      JsTestDriver::Config.new  
+      JsTestDriver::Config.new
     end
 
     def test_empty_config
@@ -75,10 +75,21 @@ module JsTestDriver
       config = given_an_empty_config
 
       # when
-      config.includes('src/*.js')
+      config.includes('src/foo.js')
 
       # then
-      assert_config_includes config, 'load' => ['src/*.js']
+      assert_config_includes config, 'load' => ['src/foo.js']
+    end
+
+    def test_config_with_includes_with_globbing
+      # given
+      config = given_an_empty_config
+
+      # when
+      config.includes('test/fixtures/foo/**/*.html')
+
+      # then
+      assert_config_includes config, 'load' => ['test/fixtures/foo/bar/a.html', 'test/fixtures/foo/a.html']
     end
 
     def test_config_with_browsers
@@ -111,10 +122,21 @@ module JsTestDriver
       config = given_an_empty_config
 
       # when
-      config.excludes('src/*.js')
+      config.excludes('test/fixtures/foo/**/*.html')
+
+      # then
+      assert_config_includes config, 'exclude' => ['test/fixtures/foo/bar/a.html', 'test/fixtures/foo/a.html']
+    end
+
+    def test_config_with_excludes_with_globbing
+      # given
+      config = given_an_empty_config
+
+      # when
+      config.excludes('src/foo.js')
 
       # then
-      assert_config_includes config, 'exclude' => ['src/*.js']
+      assert_config_includes config, 'exclude' => ['src/foo.js']
     end
 
     def test_empty_config_file
@@ -167,7 +189,7 @@ module JsTestDriver
       config.config_dir = File.expand_path("configs")
 
       # when
-      config.fixtures "fixture/directory", :name => "fixture_name", :namespace => "fixture_namespace"      
+      config.fixtures "fixture/directory", :name => "fixture_name", :namespace => "fixture_namespace"
 
       # then
       assert_config_includes config, 'load' => ["fixtures/fixture_namespace/fixture_name.js"]
@@ -224,4 +246,4 @@ module JsTestDriver
     end
 
   end
-end
+end

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: js-test-driver-rails
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.3.1
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Adam Pohorecki
@@ -10,7 +14,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-19 00:00:00 Z
+date: 2011-04-20 00:00:00 +02:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -20,6 +25,8 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -31,6 +38,8 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -42,6 +51,8 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id003
@@ -60,7 +71,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README
+- README.markdown
 - Rakefile
 - js-test-driver-rails.gemspec
 - lib/js_test_driver.rb
@@ -82,6 +93,7 @@ files:
 - test/unit/runner_test.rb
 - vendor/VERSIONS
 - vendor/js_test_driver.jar
+has_rdoc: true
 homepage: http://github.com/psyho/js-test-driver-rails
 licenses: []
 
@@ -95,17 +107,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: js-test-driver-rails
-rubygems_version: 1.7.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A wrapper for JsTestDriver for use with ruby/rails projects

data/README

@@ -1,73 +0,0 @@
-js-test-driver-rails is a thin wrapper for the JsTestDriver library: http://code.google.com/p/js-test-driver/
-
-To take advantage of it, you should create a js_test_driver.rb file in your RAILS_ROOT/config/ directory.
-
-The file may contain following directives:
-
-# the paths are relative to the current directory, but you can use absolute paths too
-# this is different from the JsTestDriver which does not allow you to use absolute paths in the config file 
-includes 'foo', 'bar', 'public/javascripts/*.js' # files to be included
-excludes 'public/javascripts/fail.js' # files to be excluded, useful with globbing
-
-host 'my-laptop' # the host to which the test runner will connect, by default 'localhost'
-port 6666 # the port to which test runner will connect, and on which the test server will start, by default 4224
-
-browser 'firefox' # you can specify the default browsers which will be captured
-
-Note, that this is a ruby file, so the file/browser list can be generated dynamically - it's completely up to you.
-
-For example in our project we examine a list of known browsers to determine the ones installed on the developer's system,
-and define only those that were found.
-
-Similarly we get the list of .js files to include from our asset packaging solution.
-
-js-test-driver-rails also allows you to define HTML fixtures easily.
-
-Imagine you have a directory structure like this:
-
-RAILS_ROOT:
-  test/
-    js/
-      fixtures/
-        foo/
-          a.html
-        a.html
-
-Then by defining the fixtures directory in your config file:
-fixtures "test/js/fixtures"
-
-At runtime, your tests will have access to the contents of the fixture files:
-htmlFixtures.all["a"] // contents of the test/js/fixtures/a.html
-htmlFixtures.all["foo/a"] // contents of the test/js/fixtures/foo/a.html
-
-You can customize the namespace and fixture container name:
-fixtures "test/js/fixtures", :name => "html", :namespace => "myApp"
-
-By default JsTestDriver comes with a pretty simple Test::Unit like testing framework.
-However it supports a couple of other frameworks, including Jasmine (http://pivotal.github.com/jasmine/), which
-is an RSpec-like BDD framework.
-
-If you want to user Jasmine, simply add:
-enable_jasmine
-
-in your config file, somewhere before including your test files and you are golden:)
-
-# the fixtures will be accessible through myApp.html["<fixture name goes here>"]
-
-This gem comes with some rake tasks:
-
-# start the js test driver server
-rake js_test_driver:start_server
-
-# capture the default (or specified) browsers
-rake js_test_driver:capture_browsers [BROWSERS=foo,bar,baz]
-
-# run the tests (all or the specified ones)
-rake js_test_driver:run_tests [TESTS=TestCase[.testMethod]]
-
-# will run the server, capture the browsers and run tests all in one command
-# this is mostly useful on CI, because it's much faster to run the server and capture the browsers once
-# and then run the tests again and again
-rake js_test_driver:run [TESTS=TestCase[.testMethod]] [BROWSERS=foo,bar,baz] [OUTPUT_XML=1 | OUTPUT_PATH=/some/dir] [CAPTURE_CONSOLE=1]
-
-You can add these tasks by requiring "js_test_driver/tasks"