js-test-driver-rails 0.1.0 → 0.2.0

data/Gemfile

@@ -3,4 +3,5 @@ source "http://rubygems.org"
 gem "bundler", "~> 0.9.26"
 gem "jeweler"
 gem "mocha"
-gem "rake"
+gem "rake"
+gem "json"

data/README

@@ -4,6 +4,8 @@ To take advantage of it, you should create a js_test_driver.rb file in your RAIL
 
 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
 
@@ -14,6 +16,44 @@ 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 3 rake tasks:
 
 # start the js test driver server

data/Rakefile

@@ -25,6 +25,7 @@ Jeweler::Tasks.new do |gem|
   gem.add_development_dependency "mocha"
   gem.add_development_dependency "jeweler"
   gem.add_dependency "rake"
+  gem.add_dependency "json"
   gem.files = FileList["[A-Z]*", "{bin,generators,lib,test,vendor}/**/*"]
 end
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/js_test_driver.rb

@@ -1,2 +1,6 @@
+require 'json'
+require 'fileutils'
+
 require File.expand_path(File.join(File.dirname(__FILE__), 'js_test_driver', 'config'))
-require File.expand_path(File.join(File.dirname(__FILE__), 'js_test_driver', 'runner'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'js_test_driver', 'runner'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'js_test_driver', 'html_fixture'))

data/lib/js_test_driver/config.rb

@@ -13,22 +13,21 @@ module JsTestDriver
       self.attributes = attributes
     end
 
-    # Adds a file to be loaded, the path *must* be relative to the yml config file (which is placed in the RAILS_ROOT
-    # by default)
+    # Adds a file to be loaded, the path *must* be relative to the root_dir (which is the current dir by default)
     #
     # JsTestDriver supports globbing
     def includes(*paths)
       paths.each do |path|
-        self.included_files << path
+        self.included_files << File.expand_path(path)
       end
     end
 
     # Files specified here will not be loaded, it's useful when combined with globbing in includes 
     #
-    # paths should be relative to RAILS_ROOT
+    # paths should be relative to root_dir
     def excludes(*paths)
       paths.each do |path|
-        self.excluded_files << path
+        self.excluded_files << File.expand_path(path)
       end
     end
 
@@ -42,6 +41,34 @@ module JsTestDriver
       end
     end
 
+    # Defines a HTML fixture directory
+    #
+    # the first argument is the directory to scan for html fixtures
+    # you can pass also :name and :namespace arguments to define the name and the namespace of the fixture
+    #
+    # the fixtures will be accessible through:
+    # namespace.name["file_name_without the html extension"]
+    #
+    # by default the namespace is called htmlFixtures
+    # and the fixture name is called all     
+    def fixtures(directory, opts = {})
+      fixture = JsTestDriver::HtmlFixture.new(directory, opts[:name], opts[:namespace])
+      if html_fixtures.detect{|f| f.name == fixture.name && f.namespace == fixture.namespace}
+        raise ArgumentError.new("Fixture #{fixture.namespace}.#{fixture.name} already defined!")
+      end  
+      html_fixtures << fixture
+    end
+
+    # Includes the bundled with the gem jasmine js file and an adapter for jasmine
+    #
+    # There's no hacks or modifications here, so this method is just for the users convenience
+    def enable_jasmine
+      this_directory = File.dirname(__FILE__)
+      vendor_directory = File.expand_path(File.join('..', '..', 'vendor'), this_directory)
+      includes File.join(vendor_directory, "jasmine", "lib", "jasmine.js")
+      includes File.join(vendor_directory, "jasmine-jstd-adapter", "src", "*.js")
+    end
+
     # config variable which has a regular setter,
     # but also can be set by calling the "getter" with an argument
     # and if called without an argument the getter will return the passed block
@@ -85,6 +112,10 @@ module JsTestDriver
       @excludes ||= []
     end
 
+    def html_fixtures
+      @html_fixtures ||= []
+    end
+
     attr_writer :browsers
 
     def browsers
@@ -93,8 +124,8 @@ module JsTestDriver
 
     def to_s
       hash = {'server' => server}
-      hash['load'] = included_files unless included_files.empty?
-      hash['exclude'] = excluded_files unless excluded_files.empty?
+      hash['load'] = loaded_files unless loaded_files.empty?
+      hash['exclude'] = map_paths(excluded_files) unless excluded_files.empty?
       return hash.to_yaml
     end
 
@@ -104,8 +135,54 @@ module JsTestDriver
       return config
     end
 
+    attr_writer :config_dir
+
+    # this is where the config files are saved (ex. RAILS_ROOT/.js_test_driver)
+    def config_dir
+      @config_dir ||= File.expand_path(".")
+    end
+
+    def save_fixtures
+      html_fixtures.each do |fixture|
+        path = fixture_file_name(fixture)
+        FileUtils.mkdir_p(File.dirname(path))
+        puts File.dirname(path)
+        File.open(path, "w+") do |f|
+          f.puts fixture.to_s
+        end
+      end
+    end
+
     private
 
+    def fixture_file_name(fixture)
+      File.expand_path(File.join(config_dir, "fixtures", fixture.namespace, "#{fixture.name}.js"))
+    end
+
+    def loaded_files
+      files = included_files + html_fixtures.collect { |fixture| fixture_file_name(fixture) }
+
+      map_paths(files)
+    end
+
+    def path_relative_to_config_dir(path)
+      source = File.expand_path(path).split(File::SEPARATOR)
+      config = File.expand_path(config_dir).split(File::SEPARATOR)
+
+      while source.first == config.first && !source.empty? && !config.empty?
+        source.shift
+        config.shift
+      end
+
+      parts = (['..'] * config.size) + source
+
+      return File.join(*parts)
+    end
+
+    def map_paths(files)
+      files.map{|file| path_relative_to_config_dir(file)}
+    end
+
     def attributes=(values)
       values.each do |attr, value|
         self.send("#{attr}=", value)

data/lib/js_test_driver/html_fixture.rb

@@ -0,0 +1,40 @@
+module JsTestDriver
+  # This is a class that given a directory name, puts all its *.html children
+  # into a javascript file, so that they can later be used in the tests
+  class HtmlFixture
+
+    attr_reader :name, :namespace
+
+    def initialize(directory_name, name = nil, namespace = nil)
+      @name = name || "all"
+      @namespace = namespace || "htmlFixtures"
+      @data = {}
+
+      load_data(directory_name)
+    end
+
+    def to_h
+      @data
+    end
+
+    def to_s
+      <<JS
+if (!#{namespace}) { #{namespace} = {}; }
+#{namespace}.#{name} = #{self.to_h.to_json};
+JS
+    end
+
+    private
+
+    def load_data(directory_name)
+      full_path = File.expand_path(directory_name)
+      files = Dir["#{full_path}/**/*.html"]
+
+      files.each do |file|
+        name = file.gsub(/^#{full_path}\//, '').gsub(/\.html$/, '')
+        @data[name] = File.read(file)
+      end
+    end
+
+  end
+end

data/lib/js_test_driver/runner.rb

@@ -13,6 +13,15 @@ module JsTestDriver
       @config ||= parse_config
     end
 
+    attr_writer :generated_files_dir
+
+    # this is where the generated files will be saved, by default this is `pwd`/.js_test_driver
+    #
+    # the generated files are the config yml file and the fixture files
+    def generated_files_dir
+      @generated_files_dir || default_generated_files_dir
+    end
+
     # this is the path of the config file, by default its `pwd`/config/js_test_driver.rb
     attr_writer :config_path
 
@@ -27,7 +36,8 @@ module JsTestDriver
       @jar_path ||= default_jar_path
     end
 
-    # this is where the config yml file will be saved, by default its /tmp/js_test_driver.(contents MD5).yml
+    # this is where the config yml file will be saved, by default its saved in the generated files
+    # directory under the name jsTestDriver.conf
     attr_writer :tmp_path
 
     def config_yml_path
@@ -88,7 +98,9 @@ module JsTestDriver
       else
         warn("Could not find JS Test Driver config: '#{config_path}', assuming empty config file!")
       end
-      JsTestDriver::Config.parse(source)
+      config = JsTestDriver::Config.parse(source)
+      config.config_dir = generated_files_dir
+      return config
     end
 
     def default_config_path
@@ -103,13 +115,19 @@ module JsTestDriver
     end
 
     def default_config_yml_path
-      return File.expand_path("jsTestDriver.conf")
+      return File.expand_path("jsTestDriver.conf", generated_files_dir)
+    end
+
+    def default_generated_files_dir
+      return File.expand_path(".js_test_driver")
     end
 
     private
 
     def save_config_file(path)
+      Dir.mkdir(generated_files_dir) unless File.exists?(generated_files_dir)
       File.open(path, "w+") { |f| f.puts config.to_s }
+      config.save_fixtures
     end
 
     def attributes=(values)

data/test/fixtures/a.html

@@ -0,0 +1 @@
+<p>This is the file <b>a.html</b></p>

data/test/fixtures/b.html

@@ -0,0 +1 @@
+<p>This is the file <b>b.html</b></p>

data/test/fixtures/baz/a.html

@@ -0,0 +1 @@
+<p>This is the file <b>baz/a.html</b></p>

data/test/fixtures/c.html

@@ -0,0 +1 @@
+<p>This is the file <b>c.html</b></p>

data/test/fixtures/foo/a.html

@@ -0,0 +1 @@
+<p>This is the file <b>foo/a.html</b></p>

data/test/fixtures/foo/bar/a.html

@@ -0,0 +1 @@
+<p>This is the file <b>foo/bar/a.html</b></p>

data/test/fixtures/hello.txt

@@ -0,0 +1 @@
+This file is not a HTML file, so it will not be used as a fixture.

data/test/test_helper.rb

@@ -7,3 +7,22 @@ require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'js_test
 
 require 'test/unit'
 require 'mocha'
+
+class Test::Unit::TestCase
+
+  def setup
+    clean_up_saved_config_files
+  end
+
+  def fixture_dir
+    File.expand_path('fixtures', File.dirname(__FILE__))
+  end
+
+  def clean_up_saved_config_files
+    root_dir = File.expand_path('..', File.dirname(__FILE__))
+    Dir["#{root_dir}/**/.js_test_driver"].each do |file|
+      FileUtils.rm_rf(file)
+    end
+  end
+
+end

data/test/unit/config_test.rb

@@ -145,10 +145,83 @@ module JsTestDriver
       config = JsTestDriver::Config.parse(str)
 
       # then
-      assert_equal ['a', 'b', 'c'], config.included_files
-      assert_equal ['d'], config.excluded_files
+      assert_equal ['a', 'b', 'c'].map{|p| File.expand_path(p)}, config.included_files
+      assert_equal [File.expand_path('d')], config.excluded_files
       assert_equal 'http://example.com:666', config.server
     end
 
+    def test_given_a_config_path_should_expand_the_includes
+      # given
+      config = given_an_empty_config
+      config.config_dir = "/foo/bbb/ccc"
+      pwd = File.expand_path('.')
+      config.includes "a/a", "/b/b", "../c"
+
+      # then
+      assert_config_includes config, 'load' => ["../../..#{pwd}/a/a", '../../../b/b', "../../..#{File.expand_path('../c')}"]
+    end
+
+    def test_config_with_html_fixtures
+      # given
+      config = given_an_empty_config
+      config.config_dir = File.expand_path("configs")
+
+      # when
+      config.fixtures "fixture/directory", :name => "fixture_name", :namespace => "fixture_namespace"      
+
+      # then
+      assert_config_includes config, 'load' => ["fixtures/fixture_namespace/fixture_name.js"]
+    end
+
+    def test_should_save_fixtures
+      # given
+      config = given_an_empty_config
+      config.config_dir = "tmp/stuff"
+      config.fixtures fixture_dir, :name => "fixture_name", :namespace => "fixture_namespace"
+
+      # when
+      config.save_fixtures
+
+      # then
+      name = "tmp/stuff/fixtures/fixture_namespace/fixture_name.js"
+      assert File.exists?(name)
+      assert_equal File.read(name), config.html_fixtures.first.to_s
+    ensure
+      FileUtils.rm_rf("tmp/stuff")
+    end
+
+    def test_should_raise_argument_error_if_the_same_fixture_defined_twice
+      # given
+      config = given_an_empty_config
+      config.fixtures "fixture/directory"
+
+      assert_raises(ArgumentError) do
+        config.fixtures "fixture/some_other_directory"
+      end
+    end
+
+    def test_should_not_raise_argument_error_for_two_fixtures_with_different_names
+      # given
+      config = given_an_empty_config
+      config.fixtures "fixture/directory"
+
+      assert_nothing_raised do
+        config.fixtures "fixture/some_other_directory", :name => "some_other_name"
+      end
+    end
+
+    def test_enable_jasmine_adds_jasmine_and_jasmine_adapter
+      # given
+      config = given_an_empty_config
+
+      # when
+      config.enable_jasmine
+
+      # then
+      assert_equal 2, config.included_files.size
+      assert File.exists?(config.included_files[0])
+      assert Dir[config.included_files[1]].size > 0
+    end
+
   end
 end