loris 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,12 +1,114 @@
-== Autotest for Javascript ==
+== Loris
 
-Run your javascript unit tests any time a file in your project changes.
+Loris will monitor your project and run Javascript Lint (http://www.javascriptlint.com/) and JS Test Driver (http://code.google.com/p/js-test-driver/) whenever a file changes, it will report the results to the command line and using Growl (http://growl.info/). If required, Loris will automatically start the JS Test Driver server and register your default browser with it.
 
-Runs Javascript Lint (if jsl.conf is found)
-Runs JSpec (if spec/spec.rhino.js is found)
-Runs JS Test Driver (if jsTestDriver.conf is found)
+=== Installing
 
-Also runs RSpec (if any file ending in _spec.rb is found in the spec directory)
+Loris is hosted on Gemcutter (http://gemcutter.org/), so you need to install their gem if you haven't already.
 
-- Requires java (to run JS Test Driver)
-- Requires .NET Framework 2.0+ (for Growl for Windows)
+	sudo gem update --system
+	sudo gem install gemcutter
+	gem tumble
+
+Then to install Loris, just run the following:
+
+	sudo gem install loris
+	
+On Windows you will also need to install the win32-process gem
+
+	gem install win32-process
+
+Loris has no command line options, and no configuration file (at the moment). It looks for configurations files to decide which tasks to run.
+
+=== Configuring Javascript Lint
+
+To enable Javascript Lint, create a `jsl.conf` file in the folder where you run Loris. This should be a standard Javascript Lint config file. If you need here is an example Javascript Lint config file (http://mike.kruckenberg.com/archives/2009/03/configuration-options-for-javascript-lint.html)
+
+You just need to specify which files Javascipt Lint should process. For example:
+
+	### Files
+	# Specify which files to lint
+	# Use "+recurse" to enable recursion (disabled by default).
+	# To add a set of files, use "+process FileName", "+process Folder\Path\*.js",
+	# or "+process Folder\Path\*.htm".
+	#
+	+process src/js/*.js
+	+process tests/js/*.js
+
+If no `jsl.conf` file is found, the Javascript Lint task is silently skipped.
+
+
+=== Configuring JS Test Driver
+
+To enable JS Test Driver, create a `jsTestDriver.conf` file in the folder where you run Loris. This should be a standard JS Test Driver config file (http://code.google.com/p/js-test-driver/wiki/ConfigurationFile).
+
+This should specify which files JS Test Driver should process, and how it connects to the JS Test Driver server. For example:
+
+	server: http://localhost:9876
+
+	load:
+	  - tests/qunit/equiv.js
+	  - tests/qunit/QUnitAdapter.js
+
+	  - src/js/*.js
+	  - tests/js/*.js
+
+If no `jsTestDriver.conf` file is found, the JS Test Driver task is silently skipped.
+
+To make it really simple to run JS Test Driver tests, if the server is set to run on `localhost`, and Loris doesn't detect one running, it will automatically start one, and register your default browser with it.
+
+This makes it a one step process to get automated tests up and running.
+
+=== Running
+
+To run, open a command line window, navigate to the root folder of your project, and run:
+
+	loris
+
+Loris will run Javascript Lint, and JS Test Driver tasks (if it finds their configuration files), and will output the results on the command line.
+
+#### Example output
+	Javascript Lint
+	success
+	All files are clean
+
+	0 error(s), 0 warning(s)
+	JS Test Driver
+	success
+	All tests pass
+	[PASSED] GreeterTest.testGreet
+	  [LOG] JsTestDriver Hello World!
+	[PASSED] GreeterTest.testGoodbye
+	[PASSED] GreeterTest.testSetName
+	[PASSED] GreeterTest.testSetNameAndNameParamter
+	[PASSED] Asserts.test OK true succeeds
+	[PASSED] Asserts.test Equals succeeds
+	  [LOG] about to call assertEquals
+	[PASSED] Asserts.test Same assert succeeds
+	[PASSED] Lifecycle.test Setup and Teardown are run, and can contain assertions
+	Total 8 tests (Passed: 8; Fails: 0; Errors: 0) (3.00 ms)
+	  Firefox 1.9.1.4 MacIntel: Run 8 tests (Passed: 8; Fails: 0; Errors 0) (3.00 ms)
+
+Every time you make a change to a Javascript file, or a configuration file, Loris will automatically re-run Javascript Lint and JS Test Driver. So you can instant feedback on your changes.
+
+Loris will clear the command line when re-running tasks. So the latest run is always at the top of you command line.
+
+Loris will also report a summary of each task using Growl (http://growl.info/) (if it is installed). This allows you to get quick feedback without needing to refer back to the command line on every change.
+
+=== Requirements
+
+JS Test Driver is written in Java, so you will need to have Java installed to run it. 
+
+To get Growl notifications, you will need to install either Growl for OSX (http://growl.info/) or Growl for Windows (http://www.growlforwindows.com/). Growl for Windows requires the .NET Framework 2.0+ (http://www.microsoft.com/downloads/details.aspx?FamilyID=0856EACB-4362-4B0D-8EDD-AAB15C5E04F5&displaylang=en).
+
+=== Caveat
+
+Loris is pretty limited at the moment, I just wired up the basics to get it running for a work project. 
+
+It doesn't have any configuration options at the moment, so you have to follow it's assumptions for now. I'm happy to add configuration options for any element as required.
+
+Loris only comes with a few tasks (Javascript Lint, JS Test Driver, JSpec, and RSpec), but I hope to allow it have new tasks added via new gems (kind of similar to Autotest).
+
+It comes packaged with a version of Javascript Lint, and JS Test Driver, and will use it's own versions. It only includes the OSX and Windows versions of Javascript Lint.
+
+If you want to modify the code, just fork the Loris github project (http://github.com/karl/loris)

data/Rakefile

@@ -17,7 +17,6 @@ begin
     gem.add_dependency('visionmedia-bind', [">= 0.2.6"])
     gem.add_dependency('karl-growl', [">= 1.0.6"])
     gem.add_dependency('extensions', [">= 0.6.0"])
-    gem.add_dependency('win32-process', [">= 0.6.1"])
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/tasks/js_test_driver/js_test_driver_runner.rb

@@ -14,7 +14,7 @@ class JsTestDriverRunner
   
   def execute
     @server.start_if_required
-    return `java -jar "#{@jar}" --config "#{@config}" --tests all --verbose 2>&1`
+    return `java -jar "#{@jar}" --config "#{@config}" --reset˝˝ --tests all 2>&1`
   end
   
   def is_configured?(all_files)

data/lib/windows_process.rb

@@ -1,4 +1,9 @@
-require 'win32/process'
+begin
+  require 'win32/process'
+rescue LoadError
+  warn "You must 'gem install win32-process to run Loris on Windows"
+  exit 1
+end
 
 class WindowsProcess
 

data/loris.gemspec

@@ -1,21 +1,22 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{loris}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Karl O'Keeffe"]
-  s.date = %q{2009-11-06}
+  s.date = %q{2010-03-26}
   s.default_executable = %q{loris}
   s.description = %q{Automatically run javascript unit tests}
   s.email = %q{loris@monket.net}
   s.executables = ["loris"]
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "README.rdoc",
+     "TODO"
   ]
   s.files = [
     ".gitignore",
@@ -92,7 +93,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/karl/loris}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Automatically run javascript unit tests}
   s.test_files = [
     "spec/file_actioner_spec.rb",
@@ -119,17 +120,15 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<visionmedia-bind>, [">= 0.2.6"])
       s.add_runtime_dependency(%q<karl-growl>, [">= 1.0.6"])
       s.add_runtime_dependency(%q<extensions>, [">= 0.6.0"])
-      s.add_runtime_dependency(%q<win32-process>, [">= 0.6.1"])
     else
       s.add_dependency(%q<visionmedia-bind>, [">= 0.2.6"])
       s.add_dependency(%q<karl-growl>, [">= 1.0.6"])
       s.add_dependency(%q<extensions>, [">= 0.6.0"])
-      s.add_dependency(%q<win32-process>, [">= 0.6.1"])
     end
   else
     s.add_dependency(%q<visionmedia-bind>, [">= 0.2.6"])
     s.add_dependency(%q<karl-growl>, [">= 1.0.6"])
     s.add_dependency(%q<extensions>, [">= 0.6.0"])
-    s.add_dependency(%q<win32-process>, [">= 0.6.1"])
   end
 end
+

data/loris.tmproj

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>currentDocument</key>
-	<string>lib/tasks/js_test_driver/js_test_driver_parser.rb</string>
+	<string>lib/file_actioner.rb</string>
 	<key>documents</key>
 	<array>
 		<dict>
@@ -91,44 +91,28 @@
 			<key>firstVisibleLine</key>
 			<integer>0</integer>
 		</dict>
-		<key>lib/loris.rb</key>
+		<key>lib/outputs/growl_output.rb</key>
 		<dict>
 			<key>caret</key>
 			<dict>
 				<key>column</key>
-				<integer>9</integer>
+				<integer>15</integer>
 				<key>line</key>
-				<integer>7</integer>
+				<integer>6</integer>
 			</dict>
-			<key>columnSelection</key>
-			<false/>
 			<key>firstVisibleColumn</key>
 			<integer>0</integer>
 			<key>firstVisibleLine</key>
 			<integer>0</integer>
-			<key>selectFrom</key>
-			<dict>
-				<key>column</key>
-				<integer>9</integer>
-				<key>line</key>
-				<integer>7</integer>
-			</dict>
-			<key>selectTo</key>
-			<dict>
-				<key>column</key>
-				<integer>14</integer>
-				<key>line</key>
-				<integer>7</integer>
-			</dict>
 		</dict>
-		<key>lib/poller.rb</key>
+		<key>lib/outputs/output_collection.rb</key>
 		<dict>
 			<key>caret</key>
 			<dict>
 				<key>column</key>
-				<integer>0</integer>
+				<integer>22</integer>
 				<key>line</key>
-				<integer>2</integer>
+				<integer>8</integer>
 			</dict>
 			<key>firstVisibleColumn</key>
 			<integer>0</integer>
@@ -221,49 +205,33 @@
 			<key>firstVisibleLine</key>
 			<integer>0</integer>
 		</dict>
-		<key>lib/tasks/list_task.rb</key>
+		<key>lib/tasks/js_test_driver/js_test_driver_runner.rb</key>
 		<dict>
 			<key>caret</key>
 			<dict>
 				<key>column</key>
 				<integer>61</integer>
 				<key>line</key>
-				<integer>13</integer>
+				<integer>16</integer>
 			</dict>
 			<key>firstVisibleColumn</key>
 			<integer>0</integer>
 			<key>firstVisibleLine</key>
 			<integer>0</integer>
 		</dict>
-		<key>spec/file_actioner_spec.rb</key>
+		<key>lib/tasks/list_task.rb</key>
 		<dict>
 			<key>caret</key>
 			<dict>
 				<key>column</key>
-				<integer>7</integer>
+				<integer>61</integer>
 				<key>line</key>
-				<integer>36</integer>
+				<integer>13</integer>
 			</dict>
-			<key>columnSelection</key>
-			<false/>
 			<key>firstVisibleColumn</key>
 			<integer>0</integer>
 			<key>firstVisibleLine</key>
 			<integer>0</integer>
-			<key>selectFrom</key>
-			<dict>
-				<key>column</key>
-				<integer>0</integer>
-				<key>line</key>
-				<integer>4</integer>
-			</dict>
-			<key>selectTo</key>
-			<dict>
-				<key>column</key>
-				<integer>7</integer>
-				<key>line</key>
-				<integer>36</integer>
-			</dict>
 		</dict>
 		<key>spec/filters/ends_with_filter_spec.rb</key>
 		<dict>
@@ -285,15 +253,15 @@
 		<string>TODO</string>
 		<string>lib/tasks/javascript_lint/javascript_lint_parser.rb</string>
 		<string>lib/tasks/js_test_driver/js_test_driver_parser.rb</string>
+		<string>lib/tasks/js_test_driver/js_test_driver_runner.rb</string>
+		<string>lib/outputs/growl_output.rb</string>
+		<string>lib/outputs/output_collection.rb</string>
 		<string>lib/filters/ends_with_filter.rb</string>
 		<string>lib/tasks/javascript_lint/javascript_lint_runner.rb</string>
 		<string>Rakefile</string>
 		<string>lib/task_manager.rb</string>
 		<string>lib/file_finder.rb</string>
 		<string>lib/file_actioner.rb</string>
-		<string>spec/file_actioner_spec.rb</string>
-		<string>lib/poller.rb</string>
-		<string>lib/loris.rb</string>
 		<string>lib/tasks/list_task.rb</string>
 		<string>lib/tasks/command_line_task.rb</string>
 	</array>

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: loris
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Karl O'Keeffe
@@ -9,49 +14,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-06 00:00:00 +00:00
+date: 2010-03-26 00:00:00 +00:00
 default_executable: loris
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: visionmedia-bind
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 6
         version: 0.2.6
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: karl-growl
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 6
         version: 1.0.6
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: extensions
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
         version: 0.6.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: win32-process
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.6.1
-    version: 
+  version_requirements: *id003
 description: Automatically run javascript unit tests
 email: loris@monket.net
 executables: 
@@ -60,6 +67,7 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
+- TODO
 files: 
 - .gitignore
 - README.rdoc
@@ -144,18 +152,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Automatically run javascript unit tests