steam 0.0.3 → 0.0.4

data/README.textile

@@ -28,7 +28,7 @@ ENV['CLASSPATH'] = Dir["path/to/your/htmlunit/*.jar"].join(':')
 # after steam has been added to the load path, e.g. in features/support/env.rb
 Steam.config[:html_unit][:java_path] = 'path/to/your/htmlunit'</pre>
 
-If you're on Mac OS X then you also need to export the JAVA_HOME variable for RJB. See here for two solutions: "Installing RJB on Mac OS X":http://www.elctech.com/articles/sudo-java_home-and-mac-os-x. The visudo way worked for us. Don't forget to add yourself to the sudoers file, though.
+If you are on Mac OS X and/or get an error saying that "JAVA_HOME is not set" then you need to export the JAVA_HOME variable for RJB. See here for two solutions: "Installing RJB on Mac OS X":http://www.elctech.com/articles/sudo-java_home-and-mac-os-x. The visudo way worked for us. Don't forget to add yourself to the sudoers file, though.
 
 
 <a name="configuration"></a>
@@ -41,15 +41,25 @@ E.g. in order to tweak the Java load params you can
 
 pre. Steam.config[:java_load_params] = "-Xmx2048M"
 
+If you want to test your application through Cucumber features then you need to setup your Cucumber environment and steps accordingly. You can find an example for a Cucumber setup here: "env.rb":http://github.com/svenfuchs/steam/blob/master/example/cucumber/env.rb.
+
+Steam is widely compatible with Webrat - many actions are implemented and take the same or very similar parameters as their Webrat equivalent. As a starting point you might want to copy the file "webrat_compatible_steps.rb":http://github.com/svenfuchs/steam/blob/master/example/cucumber/webrat_compatible_steps.rb over to your @features/step_definitions@ directory.
 
 <a name="usage"></a>
 
 h2. Usage
 
-You can use Steam by itself as well as with Cucumber. You can find an example for a Cucumber setup in examples/cucumber/env.rb.
+To test your application it needs to be available through http, so usually you want to start a test server:
+
+<pre>script/server -e test # Rails < 3.0.0
+rails server  -e test # Rails >= 3.0.0
+rackup        -E test # etc.</pre>
 
-Steam is widely compatible with Webrat - many actions are implemented and take the same or very similar parameters as their Webrat equivalent. You even might be able to use the default webrat_steps.rb that ships with Cucumber, *but his file is meant as an example and might be out of date.*
+If you have Cucumber set up you should now be able to run your features through Steam in a separate terminal (unless you've detached your server):
 
+<pre>cucumber features/*.feature</pre>
+
+Be sure to restart the server if you make changes to your application. During development it might be useful to enable class reloading on the test server. You also might want to consider having separate environments for development with Cucumber/Steam and running the full test suite, e.g. on CI (where you keep class reloading disabled for faster test runs).
 
 <a name="demo"></a>
 
@@ -62,10 +72,18 @@ You can find a demo application here: "http://github.com/clemens/steam-demo":htt
 
 h2. Comparsion to others
 
+Steam's advantages over plain Webrat:
+
+* Steam can test your Javascript and CSS, 'nuff said
+
+Plain Webrat's advantages over Steam:
+
+* It's still a little bit easier to set up. All full-stack integration testing tools still require you to manage more than one process (i.e. you have to start a server for the application). Webrat can run your tests, the "browser" (session) and application all in the same process, just like classic Rails integration tests.
+
 Steam's advantages over Culerity/Celerity:
 
 * runs in Ruby MRI and does not require an entire JRuby environment.
-* Steam can have the HtmlUnit browser running in the same stack as your tests, thus making the whole thing less complex and hard to debug
+* Steam can have the HtmlUnit browser running in the same process as your tests, thus making the whole thing less complex and hard to debug
 * Steam does not build on Celerity which is a quite heavy-weight Ruby wrapper around HtmlUnit adding a lot of unnecessary code
 * Steam uses "Locator":http://github.com/svenfuchs/locator
 

data/Rakefile

@@ -16,7 +16,7 @@ begin
     s.files =  FileList['[A-Z]*', 'lib/steam.rb', 'lib/{core_ext,steam}/**/*']
 
     s.add_dependency 'rjb', '>= 1.2.0'
-    s.add_dependency 'locator', '>= 0.0.4'
+    s.add_dependency 'locator', '>= 0.0.6'
   end
 rescue LoadError
   puts 'Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com'

data/TODO

@@ -5,3 +5,9 @@ HtmlUnit appears to be leaking memory; what's the deal?
 Make sure (a) that you are using the latest version of HtmlUnit, and (b) that you are calling WebClient.closeAllWindows() when you are finished with your WebClient instance.
 
 
+check out for step tests: http://github.com/mattwynne/cucumber-step_definitions/blob/master/spec/spec_helper.rb
+
+add note to readme:
+
+Steam: can't create Java VM (RuntimeError).
+JAVA_HOME was incorrectly set to /Library/Java/Home

data/lib/steam/version.rb

@@ -1,3 +1,3 @@
 module Steam
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: steam
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Sven Fuchs
@@ -10,29 +15,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-28 00:00:00 +01:00
+date: 2010-04-02 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rjb
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 0
         version: 1.2.0
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: locator
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.4
-    version: 
+        segments: 
+        - 0
+        - 0
+        - 6
+        version: 0.0.6
+  type: :runtime
+  version_requirements: *id002
 description: Steam is a headless integration testing tool driving HtmlUnit to enable testing JavaScript-driven web sites.
 email: svenfuchs@artweb-design.de
 executables: []
@@ -89,18 +102,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: "Headless integration testing w/ HtmlUnit: enables testing JavaScript-driven web sites"