tidy-ext 0.1.12 → 0.1.13

data/README.md

@@ -0,0 +1,79 @@
+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](http://tidy.sourceforge.net)
+
+You can read more about Tidy at
+[http://www.w3.org/People/Raggett/tidy/](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](http://github.com/relevance/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>
+
+

data/Rakefile

@@ -5,10 +5,11 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "tidy-ext"
-    gem.summary = "W3C HTML Tidy library implemented as a Ruby extension."
+    gem.summary = "W3C HTML Tidy library implemented as a Ruby native extension."
     gem.description = "Tidy up web pages."
     gem.email = "carl.douglas@gmail.com"
     gem.homepage = "http://github.com/carld/tidy"
+    gem.rubyforge_project = "tidy-ext"
     gem.authors = ["A. Carl Douglas"]
     gem.extensions = FileList["ext/**/extconf.rb"]
   end
@@ -42,7 +43,7 @@ rescue LoadError
   puts "RSpec (or a dependency) not available. Install it with: gem install rspec"
 end
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
@@ -79,7 +80,7 @@ namespace :gcov do
   end
 
   desc "Clean, compile with gcc coverage and run specs"
-  task :all, :needs => ["clean", :compile, :spec]  do |t|
+  task :all => ["clean", :compile, :spec]  do |t|
   end
 
 end

data/VERSION

@@ -1 +1 @@
-0.1.12
+0.1.13

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tidy-ext
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 1
-  - 12
-  version: 0.1.12
+  - 13
+  version: 0.1.13
 platform: ruby
 authors: 
 - A. Carl Douglas
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-31 00:00:00 +11:00
+date: 2012-10-21 00:00:00 +13:00
 default_executable: 
 dependencies: []
 
@@ -27,9 +27,10 @@ extensions:
 - ext/tidy/extconf.rb
 extra_rdoc_files: 
 - LICENSE
+- README.md
 files: 
-- .gitignore
 - LICENSE
+- README.md
 - Rakefile
 - VERSION
 - ext/tidy/access.c
@@ -97,8 +98,8 @@ homepage: http://github.com/carld/tidy
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -121,10 +122,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: tidy-ext
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: W3C HTML Tidy library implemented as a Ruby extension.
+summary: W3C HTML Tidy library implemented as a Ruby native extension.
 test_files: []
 

data/.gitignore

@@ -1,7 +0,0 @@
-.DS_Store
-ext/*.o
-ext/*.bundle
-ext/Makefile
-lib/
-pkg/
-*.gemspec