1. Carl D
  2. tidy

Overview

Description

This is the HTML Tidy library built as a Ruby extension.

The original C source for Tidy can be found at http://tidy.sourceforge.net

You can read more about Tidy at http://www.w3.org/People/Raggett/tidy/

This version of Ruby Tidy is compatible enough with the Ruby wrapper around the standalone tidy to be called by Tarantula.

Usage

<pre> require 'tidy'

tidy = Tidy.open({:show_warnings => true}) do |tidy| xml = tidy.clean("&lt;html&gt;&lt;body&gt;String&lt;/body&gt;&lt;/html&gt;") end </pre>

When using cucumber to write tests, it might be useful to copy features/step_definitions/tidy_steps.rb into your project's step definitions.

<pre> require 'tidy'

Given /^(.+) is tidy$/ do |page_name|

visit path_to(page_name)
tidy = Tidy.open({:show_warnings => true}) do |tidy|
  out = tidy.clean(response.body)
end

tidy.errors.scan(/(\d+) warnings?, (\d+) errors? were found!/) do |w,e|
  warnings = w.to_i
  errors   = e.to_i
  unless warnings == 0 && errors == 0
    raise tidy.errors
  end
end

end </pre>

This allows you to write a cucumber feature like

<pre> Scenario: visit the login page

Given the login page is tidy

And I am on the login page
And I fill in "email" with "blah"
And I fill in "password" with "blah"
And I press "Log in"

</pre>

If you want to run Tarantula on your Rails application, you may want to create a rake task lib/tasks/tarantula.rake that looks like:

<pre> ENV["RAILS_ENV"] = "test" # so that rake tarantula:test always runs in your test env ENV["TIDY_PATH"] = "tidy" # Tarantula will not load Tidy if this is not set

load File.join(RAILS_ROOT, Dir["vendor/gems/tarantula-/tasks/.rake"]) </pre>

Installing

Using http://rubygems.org:

<pre> $ [sudo] gem install tidy-ext </pre>