akephalos2 2.0.9 → 2.1.0

data/README.md

@@ -1,28 +1,30 @@
 # Important Notice
 
-This repo has rewritten its history and as such is not compatible with the main Akephalos repo. 
- 
+This repo has rewritten its history and as such is not compatible with the main Akephalos repo.
+
 You can get the unaltered – before history rewrite – pristine copy at: [https://github.com/Nerian/akephalos](https://github.com/Nerian/akephalos)
 
 Further development will be done here:
 [https://github.com/Nerian/akephalos2](https://github.com/Nerian/akephalos2)
 
-The reason why its history was rewrote was to remove .jar vendor files that were making its size huge.
+Its history was rewritten in order to remove .jar vendor files that were making its size huge.
 
 
-# Akephalos        
+# Akephalos
 
 Akephalos is a full-stack headless browser for integration testing with
 [Capybara](https://github.com/jnicklas/capybara). It is built on top of [HtmlUnit](http://htmlunit.sourceforge.net),
 a GUI-less browser for the Java platform, but can be run on both JRuby and
 MRI with no need for JRuby to be installed on the system.
 
+The name Akephalos /ā-sĕf'ə-ləs/ comes from the Greek ἀκέφαλος akephalos, which literally means "headless".
+
 
 ## Installation
-     
+
 ``` ruby
 gem install akephalos2
-```     
+```
 
 Or
 
@@ -30,18 +32,26 @@ Or
 gem 'akephalos2', :require => 'akephalos'
 ```
 
-Or (for the current master branch)  
+Or (for the current master branch)
 
 ``` ruby
-gem 'akephalos', :git => 'git://github.com/Nerian/akephalos2.git', :submodules => true
+gem 'akephalos2', :git => 'git://github.com/Nerian/akephalos2.git'
 ```
 
+Akephalos creates a `.akephalos` folder where it stores HTMLUnit binaries. You should set Git to ignore that folder.
+
+```
+git ignore .akephalos
+```
+
+
 # Questions, bugs, etc:
 
 We use GitHub issues:
 
 [https://github.com/Nerian/akephalos2/issues](https://github.com/Nerian/akephalos2/issues)
 
+
 # Development
 
 <a href='http://travis-ci.org/#!/Nerian/akephalos2'>
@@ -49,17 +59,16 @@ We use GitHub issues:
 </a>
 
 ``` bash
-git clone --recursive https://github.com/Nerian/akephalos2 
+git clone https://github.com/Nerian/akephalos2
 ```
 
-The HTMLUnit files are located at [https://github.com/Nerian/html-unit-vendor](https://github.com/Nerian/html-unit-vendor) and are automatically downloaded as a submodule.
-
 Also, we have a .rvmrc file already cooked:
 
 ``` bash
 cp .rvmrc.example .rvmrc
 ```
-  
+
+
 ## Setup
 
 Configuring akephalos is as simple as requiring it and setting Capybara's
@@ -70,6 +79,7 @@ require 'akephalos'
 Capybara.javascript_driver = :akephalos
 ```
 
+
 ## Basic Usage
 
 Akephalos provides a driver for Capybara, so using Akephalos is no
@@ -79,28 +89,29 @@ makes no assumptions about the testing framework being used, and works with
 RSpec, Cucumber, and Test::Unit.
 
 Here's some sample RSpec code:
-    
+
 ``` ruby
 # encoding: utf-8
 
 describe "Home Page" do
   before { visit "/" }
-  
+
   context "searching" do
-  
+
     before do
-      fill_in "Search", :with => "akephalos" 
+      fill_in "Search", :with => "akephalos"
       click_button "Go"
     end
-    
+
     it "returns results" { page.should have_css("#results") }
-    
+
     it "includes the search term" { page.should have_content("akephalos") }
   end
-  
-end 
+
+end
 ```
 
+
 ### Encoding
 
 Akephalos uses UTF-8 encoding by default. You may need to add `# encoding: utf-8` at the first line of your test. This behavior is the default using JRuby in 1.9 mode, but you can use JRuby in 1.8 mode by setting the environment variable `ENV['JRUBY_1_8']=true`. Note that Akephalos works with MRI. I refer here to the JRuby that is used internally by Akephalos.
@@ -138,25 +149,39 @@ end
 ## Configuration
 
 There are now a few configuration options available through Capybara's new
-`register_driver` API.    
+`register_driver` API.
+
 
-### Configuring the max memory that Java Virtual Machine can use
+### Configure the max memory that Java Virtual Machine can use
 
 The max memory that the JVM is going to use can be set using an environment variable in your spec_helper or .bashrc file.
 
-``` ruby                                                                            
+``` ruby
 ENV['akephalos_jvm_max_memory']
-```                              
-  
+```
+
 
 The default value is 128 MB.
 
-If you use akephalos's bin the parameter `-m [memory]` sets the max memory for the JVM.
+If you use Akephalos's bin the parameter `-m [memory]` sets the max memory for the JVM.
 
 ``` bash
 $ akephalos -m 670
-``` 
+```
+
+
+### Configure the version of HTMLUnit
+
+The Htmlunit version is configured with a environmental variable named `htmlunit_version`. The possible versions are listed at [here](http://sourceforge.net/projects/htmlunit/files/htmlunit/)
+
+```
+ENV["htmlunit_version"] = "2.10"  # Development Snapshots
+ENV["htmlunit_version"] = "2.9"
+ENV["htmlunit_version"] = "2.8"
+ENV["htmlunit_version"] = "2.7"
+```
 
+It defaults to HtmlUnit 2.9. You can manually download or copy your own version to .akephalos/:version and use it with `ENV["htmlunit_version"] = "version"`
 
 ### Using a different browser
 
@@ -169,16 +194,16 @@ Capybara.register_driver :akephalos do |app|
   #  available options:
   #  :ie6, :ie7, :ie8, :firefox_3_6
   Capybara::Driver::Akephalos.new(app, :browser => :ie8)
-end     
-```   
+end
+```
 
 
 ### Using a Proxy Server
-       
-``` ruby         
+
+``` ruby
 Capybara.register_driver :akephalos do |app|
   Capybara::Driver::Akephalos.new(app, :http_proxy => 'myproxy.com', :http_proxy_port => 8080)
-end 
+end
 ```
 
 
@@ -190,40 +215,40 @@ that certain libraries aren't supported by HtmlUnit. If possible, it's
 best to keep the default behaviour, and use Filters (see below) to mock
 offending libraries. If needed, however, you can configure Akephalos to
 ignore javascript errors.
-           
+
 ``` ruby
 Capybara.register_driver :akephalos do |app|
   Capybara::Driver::Akephalos.new(app, :validate_scripts => false)
-end 
-```  
-       
+end
+```
+
 
 ### Setting the HtmlUnit log level
 
 By default it uses the 'fatal' level. You can change that like this:
-        
+
 ``` ruby
-Capybara.register_driver :akephalos do |app|  
-  # available options 
+Capybara.register_driver :akephalos do |app|
+  # available options
   # "trace", "debug", "info", "warn", "error", or "fatal"
   Capybara::Driver::Akephalos.new(app, :htmlunit_log_level => 'fatal')
-end 
+end
 ```
-       
+
 
 ### Running Akephalos with Spork
-         
+
 ``` ruby
 Spork.prefork do
   ...
-  Akephalos::RemoteClient.manager                                 
+  Akephalos::RemoteClient.manager
 end
 
-Spork.each_run do 
+Spork.each_run do
   ...
   Thread.current['DRb'] = { 'server' => DRb::DRbServer.new }
 end
-```       
+```
 
 
 More info at : [sporking-with-akephalos](http://spacevatican.org/2011/7/3/sporking-with-akephalos)
@@ -232,28 +257,28 @@ More info at : [sporking-with-akephalos](http://spacevatican.org/2011/7/3/sporki
 
 Akephalos allows you to filter requests originating from the browser and return mock responses. This will let you easily filter requests for external resources when running your tests, such as Facebook's API and Google Analytics.
 
-Configuring filters in Akephalos should be familiar to anyone who has used FakeWeb or a similar library. The simplest filter requires only an HTTP method (:get, :post, :put, :delete, :any) and a string or regex to match against.       
-         
+Configuring filters in Akephalos should be familiar to anyone who has used FakeWeb or a similar library. The simplest filter requires only an HTTP method (:get, :post, :put, :delete, :any) and a string or regex to match against.
+
 ``` ruby
 Akephalos.filter(:get, "http://www.google.com")
 Akephalos.filter(:any, %r{^http://(api\.)?twitter\.com/.*$})
 ```
-	      
-	
+
+
 By default, all filtered requests will return an empty body with a 200 status code. You can change this by passing additional options to your filter call.
-   
+
 ``` ruby
-Akephalos.filter(:get, "http://google.com/missing", 
+Akephalos.filter(:get, "http://google.com/missing",
   :status => 404, :body => "... <h1>Not Found</h1> ...")
 
 Akephalos.filter(:post, "http://my-api.com/resource.xml",
   :status => 201, :headers => {
     "Content-Type" => "application/xml",
     "Location" => "http://my-api.com/resources/1.xml" },
-    :body => {:id => 100}.to_xml)	
-```    
+    :body => {:id => 100}.to_xml)
+```
+
 
-                                         
 And that's really all there is to it! It should be fairly trivial to set up filters for the external resources you need to fake. For reference, however, here's what we ended up using for our external sources.
 
 #### Example: Google Maps
@@ -262,8 +287,8 @@ Google Analytics code is passively applied based on HTML comments, so simply ret
 
 ``` ruby
 Akephalos.filter(:get, "http://www.google-analytics.com/ga.js",
-  :headers => {"Content-Type" => "application/javascript"})    
-```       
+  :headers => {"Content-Type" => "application/javascript"})
+```
 
 
 Google Maps requires the most extensive amount of API definitions of the three, but these few lines cover everything we've encountered so far.
@@ -278,50 +303,51 @@ Akephalos.filter(:get, "http://maps.google.com/maps/api/js?sensor=false",
       Marker: function(){},
       MapTypeId: {ROADMAP:1}
     }
-   };") 
-```  
+   };")
+```
+
 
-		
 #### Example: Facebook Connect
 
 Facebook Connect
 
-When you enable Facebook Connect on your page, the FeatureLoader is requested, and then additional resources are loaded when you call FB_RequireFeatures. We can therefore return an empty function from our filter to disable all Facebook Connect code.		                 
+When you enable Facebook Connect on your page, the FeatureLoader is requested, and then additional resources are loaded when you call FB_RequireFeatures. We can therefore return an empty function from our filter to disable all Facebook Connect code.
 
 ``` ruby
-Akephalos.filter(:get, 
+Akephalos.filter(:get,
   "http://static.ak.connect.facebook.com/js/api_lib/v0.4/FeatureLoader.js.php",
   :headers => {"Content-Type" => "application/javascript"},
-  :body => "window.FB_RequireFeatures = function() {};")    
-```        
+  :body => "window.FB_RequireFeatures = function() {};")
+```
+
 
-		
 ### Akephalos' Interactive mode
 
 #### bin/akephalos
 
 The bundled akephalos binary provides a command line interface to a few useful features.
 
+
 #### akephalos --interactive
 
 Running Akephalos in interactive mode gives you an IRB context for interacting with your site just as you would in your tests:
-         
+
 ``` ruby
 $ akephalos --interactive
   ->  Capybara.app_host # => "http://localhost:3000"
   ->  page.visit "/"
   ->  page.fill_in "Search", :with => "akephalos"
   ->  page.click_button "Go"
-  ->  page.has_css?("#search_results") # => true  
+  ->  page.has_css?("#search_results") # => true
 ```
-	     
-	
+
+
 #### akephalos --use-htmlunit-snapshot
-	
+
 This will instruct Akephalos to use the latest development snapshot of HtmlUnit as found on it's Cruise Control server. HtmlUnit and its dependencies will be unpacked into vendor/htmlunit in the current working directory.
 
 This is what the output looks like:
-      
+
 ``` ruby
 $ akephalos --use-htmlunit-snapshot
 
@@ -329,9 +355,9 @@ Downloading latest snapshot... done
 Extracting dependencies... done
 ========================================
 The latest HtmlUnit snapshot has been extracted to vendor/htmlunit!
-Once HtmlUnit has been extracted, Akephalos will automatically detect 
+Once HtmlUnit has been extracted, Akephalos will automatically detect
 the vendored version and use it instead of the bundled version.
-```          
+```
 
 
 #### akephalos --server <socket_file>

data/bin/akephalos

@@ -4,8 +4,9 @@
 require "pathname"
 require "optparse"
 require 'rubygems'
+require "akephalos/htmlunit_downloader"
 
-options = { :interactive => false, :default_jvm_max_memory => '128' }
+options = { :interactive => false, :default_jvm_max_memory => '128'}
 
 parser = OptionParser.new do |opts|
   opts.banner = "Usage: akephalos [--interactive, --use-htmlunit-snapshot, --memory [number]] | [--server] <port>"
@@ -13,19 +14,20 @@ parser = OptionParser.new do |opts|
   opts.on("-i", "--interactive", "Run in interactive mode") { options[:interactive] = true }
   opts.on("--use-htmlunit-snapshot", "Use the snapshot of htmlunit") { options[:use_htmlunit_snapshot] = true }
   opts.on("-m", "--memory [number]", "Max memory for the Java Virtual Machine, defaults to #{options[:default_jvm_max_memory]}
-  or env variable $akephalos_jvm_max_memory") do |memory| 
+  or env variable $akephalos_jvm_max_memory") do |memory|
     options[:akephalos_jvm_max_memory] = memory.to_s
-  end       
-  
+  end
+
   if options[:akephalos_jvm_max_memory].nil?
-    if ENV['akephalos_jvm_max_memory'].nil?     
+    if ENV['akephalos_jvm_max_memory'].nil?
       options[:akephalos_jvm_max_memory] = options[:default_jvm_max_memory]
     else
       options[:akephalos_jvm_max_memory] = ENV['akephalos_jvm_max_memory']
     end
-  end  
-  
-  puts "Using #{options[:akephalos_jvm_max_memory]} MB for the JVM"                           
+  end
+  puts "Using #{options[:akephalos_jvm_max_memory]} MB for the JVM"
+
+  HtmlUnit.download_htmlunit(ENV["htmlunit_version"])
 
   opts.on_tail("-h", "--help", "Show this message") { puts opts; exit }
 end
@@ -74,10 +76,10 @@ else
     require 'akephalos/server'
     Akephalos::Server.start!(port)
   else
-    require 'jruby-jars'              
+    require 'jruby-jars'
 
     jruby = JRubyJars.core_jar_path
-    jruby_stdlib = JRubyJars.stdlib_jar_path          
+    jruby_stdlib = JRubyJars.stdlib_jar_path
 
     java_args = [
      "-Xmx#{options[:akephalos_jvm_max_memory]}M",
@@ -85,7 +87,7 @@ else
       "org.jruby.Main",
       "-X+O"
     ]
-    ruby_args = [ 
+    ruby_args = [
       "-Ku",
       "-I", ["vendor", lib, src].join(File::PATH_SEPARATOR),
       "-r", "akephalos/server",
@@ -101,6 +103,6 @@ else
     else
       ENV["RUBYOPT"] = "--1.9"
     end
-    exec("java", *(java_args + ruby_args))  
+    exec("java", *(java_args + ruby_args))
   end
 end

data/lib/akephalos/client.rb

@@ -3,7 +3,7 @@ require 'akephalos/configuration'
 if RUBY_PLATFORM != "java"
   require 'akephalos/remote_client'
   Akephalos::Client = Akephalos::RemoteClient
-else
+else  
   require 'akephalos/htmlunit'
   require 'akephalos/htmlunit/ext/http_method'
   require 'akephalos/htmlunit/ext/confirm_handler'
@@ -12,7 +12,7 @@ else
   require 'akephalos/node'
 
   require 'akephalos/client/cookies'
-  require 'akephalos/client/filter'
+  require 'akephalos/client/filter'  
 
   module Akephalos
 
@@ -150,7 +150,7 @@ else
       # validate scripts, and htmlunit log level.
       #
       # @param [Hash] options the options to process
-      def process_options!(options)
+      def process_options!(options)        
         options = DEFAULT_OPTIONS.merge(options)
 
         @browser_version  = BROWSER_VERSIONS.fetch(options.delete(:browser))
@@ -158,7 +158,7 @@ else
         @use_insecure_ssl = options.delete(:use_insecure_ssl)
         @htmlunit_log_level = options.delete(:htmlunit_log_level)
         @http_proxy = options.delete(:http_proxy)
-        @http_proxy_port = options.delete(:http_proxy_port)
+        @http_proxy_port = options.delete(:http_proxy_port)        
 
         java.lang.System.setProperty("org.apache.commons.logging.simplelog.defaultlog", @htmlunit_log_level)
       end

data/lib/akephalos/htmlunit.rb

@@ -1,7 +1,7 @@
 require "pathname"
 require "java"
 
-Dir[File.dirname(__FILE__) + "/../.." + "/vendor/html-unit/*.jar"].each {|file| require file }
+Dir[File.dirname(__FILE__) + "/../.." + "/.akephalos/#{ENV['htmlunit_version']}/*.jar"].each {|file| require file }
 
 java.lang.System.setProperty("org.apache.commons.logging.Log", "org.apache.commons.logging.impl.SimpleLog")
 java.lang.System.setProperty("org.apache.commons.logging.simplelog.defaultlog", "fatal")

data/lib/akephalos/htmlunit_downloader.rb

@@ -0,0 +1,38 @@
+module HtmlUnit
+  def self.download_htmlunit(version)
+    if not version_exist?(version)
+      puts "Installing HTMLUnit #{version} at .akephalos/#{version}/"
+      Dir.mkdir(".akephalos") unless File.exists?(".akephalos")
+      Dir.mkdir(".akephalos/#{version}") unless File.exists?(".akephalos/#{version}")
+      download(version)
+      unzip(version)
+      remove_cache(version)
+    else
+      puts "Using HTMLUnit #{version}"
+    end
+  end
+
+  def self.version_exist?(version)
+    File.exist?(".akephalos/#{version}/htmlunit-#{version}.jar")
+  end
+
+  def self.unzip(version)
+    `tar xzf htmlunit-#{version}.zip`
+    `mv -f htmlunit-2.10-SNAPSHOT htmlunit-2.10 > /dev/null 2>&1`
+    `cp -r htmlunit-#{version}/lib/ .akephalos/#{version}/`
+  end
+
+  def self.download(version)
+    if version == "2.10"
+      %x[curl -L -o htmlunit-2.10.zip  http://build.canoo.com/htmlunit/artifacts/htmlunit-2.10-SNAPSHOT-with-dependencies.zip]
+    elsif version[2] < '9'
+      %x[curl -L -O http://sourceforge.net/projects/htmlunit/files/htmlunit/#{version}/htmlunit-#{version}.zip]
+    else
+      %x[curl -L -o htmlunit-#{version}.zip  http://sourceforge.net/projects/htmlunit/files/htmlunit/#{version}/htmlunit-#{version}-bin.zip]
+    end
+  end
+
+  def self.remove_cache(version)
+    `rm -rf htmlunit-#{version} htmlunit-#{version}.zip`
+  end
+end

data/lib/akephalos/version.rb

@@ -1,3 +1,3 @@
 module Akephalos #:nodoc
-  VERSION = "2.0.9"
+  VERSION = "2.1.0"
 end

data/lib/akephalos.rb

@@ -8,6 +8,7 @@ require 'pathname'
 
 module Akephalos
   BIN_DIR = Pathname(__FILE__).expand_path.dirname.parent + 'bin'
+  ENV['htmlunit_version'] ||= "2.9" 
 end
 
 require 'akephalos/client'

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: akephalos2
 version: !ruby/object:Gem::Version
-  version: 2.0.9
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
 - Bernerd Schaefer
+- Gonzalo Rodríguez-Baltanás Díaz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-19 00:00:00.000000000 Z
+date: 2011-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70303145391620 !ruby/object:Gem::Requirement
+  requirement: &70217250384880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70303145391620
+  version_requirements: *70217250384880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70303145390600 !ruby/object:Gem::Requirement
+  requirement: &70217250384020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70303145390600
+  version_requirements: *70217250384020
 - !ruby/object:Gem::Dependency
   name: jruby-jars
-  requirement: &70303145388080 !ruby/object:Gem::Requirement
+  requirement: &70217250382940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70303145388080
+  version_requirements: *70217250382940
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70303145401440 !ruby/object:Gem::Requirement
+  requirement: &70217250411940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70303145401440
+  version_requirements: *70217250411940
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70303145398760 !ruby/object:Gem::Requirement
+  requirement: &70217250411440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,9 +66,11 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70303145398760
+  version_requirements: *70217250411440
 description: Headless Browser for Integration Testing with Capybara
-email: bj.schaefer@gmail.com
+email:
+- bj.schaefer@gmail.com
+- siotopo@gmail.com
 executables:
 - akephalos
 extensions: []
@@ -83,6 +86,7 @@ files:
 - lib/akephalos/htmlunit/ext/confirm_handler.rb
 - lib/akephalos/htmlunit/ext/http_method.rb
 - lib/akephalos/htmlunit.rb
+- lib/akephalos/htmlunit_downloader.rb
 - lib/akephalos/node.rb
 - lib/akephalos/page.rb
 - lib/akephalos/remote_client.rb
@@ -93,10 +97,13 @@ files:
 - vendor/html-unit/commons-codec-1.4.jar
 - vendor/html-unit/commons-collections-3.2.1.jar
 - vendor/html-unit/commons-io-2.0.1.jar
+- vendor/html-unit/commons-lang-2.6.jar
 - vendor/html-unit/commons-lang3-3.0.1.jar
 - vendor/html-unit/commons-logging-1.1.1.jar
+- vendor/html-unit/cssparser-0.9.5.jar
 - vendor/html-unit/cssparser-0.9.6-20110829.205617-3.jar
 - vendor/html-unit/htmlunit-2.10-SNAPSHOT.jar
+- vendor/html-unit/htmlunit-2.9.jar
 - vendor/html-unit/htmlunit-core-js-2.9.jar
 - vendor/html-unit/httpclient-4.1.2.jar
 - vendor/html-unit/httpcore-4.1.2.jar
@@ -130,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: akephalos
+rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3