tidy-ext 0.1.7 → 0.1.8

data/.gitignore

@@ -2,3 +2,6 @@
 ext/*.o
 ext/*.bundle
 ext/Makefile
+lib/
+pkg/
+*.gemspec

data/Rakefile

@@ -10,10 +10,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "tidy-ext"
-    gem.summary = "HTML Tidy library implemented as a Ruby extension."
-    gem.description = <<-EOS
-    Tidies up web pages.
-    EOS
+    gem.summary = "W3C HTML Tidy library implemented as a Ruby extension."
+    gem.description = "Tidy up web pages."
     gem.email = "carl.douglas@gmail.com"
     gem.homepage = "http://github.com/carld/tidy"
     gem.authors = ["Carl Douglas"]

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.1.8

data/ext/tidy/ruby-tidy.c

@@ -34,16 +34,25 @@ static void rb_tidy_free(void *ptr)
 }
 
 /* create a new tidy doc */
-/* TODO, observe :show_warnings=>true in hash */
-static VALUE rb_tidy_new(VALUE class, VALUE hash)
+static VALUE rb_tidy_new(int argc, VALUE *argv, VALUE class)
 {
-  VALUE argv[1];
   TidyDoc tdoc = tidyCreate();
-  VALUE tdata = Data_Wrap_Struct(class, 0, rb_tidy_free, (struct _TidyDoc *)tdoc);
-  argv[0] = hash;
+  VALUE options;
+  VALUE access = INT2NUM(4);
+  VALUE errors = rb_ary_new();
+
+  VALUE self = Data_Wrap_Struct(class, 0, rb_tidy_free, (struct _TidyDoc *)tdoc);
+
+  rb_scan_args(argc, argv, "01", &options);
+  options = NIL_P(options) ? rb_hash_new() : options;
+
+  rb_iv_set(self, "@options", options);
+  rb_iv_set(self, "@access", access);
+  rb_iv_set(self, "@errors", errors);
+
+  rb_obj_call_init(self, 0, NULL);
 
-  rb_obj_call_init(tdata, 0, NULL);
-  return tdata;
+  return self;
 }
 
 /* parse the given input and return the tidy errors and output */
@@ -52,6 +61,7 @@ static VALUE rb_tidy_parse(VALUE self, VALUE input)
   VALUE array;
   VALUE access;
   VALUE errors;
+  VALUE options;
 
   TidyDoc tdoc;
   TidyBuffer output;
@@ -75,6 +85,8 @@ static VALUE rb_tidy_parse(VALUE self, VALUE input)
   access = rb_iv_get(self, "@access");
   tidyOptSetInt( tdoc, TidyAccessibilityCheckLevel, NUM2UINT(access));
 
+  options = rb_iv_get(self, "@options");
+
   if (status >= 0) {
 
     int is_input_source = 0;
@@ -114,10 +126,12 @@ static VALUE rb_tidy_parse(VALUE self, VALUE input)
   contentWarnings += tidyWarningCount( tdoc );
   accessWarnings  += tidyAccessWarningCount( tdoc );
 
-  if (contentErrors > 0 || contentWarnings > 0) {
+  VALUE show_warnings = rb_hash_aref(options, ID2SYM(rb_intern("show_warnings")));
+
+  if (contentErrors > 0 || (show_warnings == Qtrue && contentWarnings > 0)) {
     errors = rb_str_new2(errbuf.bp);
   } else {
-    errors = rb_ary_new2("");
+    errors = rb_str_new2("");
   }
 
   rb_iv_set(self, "@errors", errors);
@@ -133,18 +147,16 @@ static VALUE rb_tidy_parse(VALUE self, VALUE input)
 
 static VALUE rb_tidy_init(VALUE self)
 {
-  VALUE access = INT2NUM(4);
-  VALUE errors = rb_ary_new();
-
-  rb_iv_set(self, "@access", access);
-  rb_iv_set(self, "@errors", errors);
-
   return self;
 }
 
-static VALUE rb_tidy_open(VALUE class, VALUE hash)
+static VALUE rb_tidy_open(VALUE class, VALUE options)
 {
-  VALUE tidy = rb_tidy_new(class, hash);
+  VALUE args[1];
+  VALUE tidy;
+
+  args[0] = options;
+  tidy  = rb_tidy_new(1, args, class);
 
   if (rb_block_given_p()) {
     rb_yield(tidy);
@@ -181,13 +193,13 @@ void Init_tidy()
 
   rb_define_class_variable(cTidy, "@@path", rb_str_new2("tidy-is-built-in"));
 
-  rb_define_singleton_method(cTidy, "new", rb_tidy_new, 0);
+  rb_define_singleton_method(cTidy, "new", rb_tidy_new, -1);
   rb_define_singleton_method(cTidy, "open", rb_tidy_open, 1);
   rb_define_singleton_method(cTidy, "path", rb_tidy_path_get, 0);
   rb_define_singleton_method(cTidy, "path=", rb_tidy_path_set, 1);
 
-  rb_define_method(cTidy, "parse", rb_tidy_parse, 1);
   rb_define_method(cTidy, "initialize", rb_tidy_init, 0);
+  rb_define_method(cTidy, "parse", rb_tidy_parse, 1);
   rb_define_method(cTidy, "clean", rb_tidy_clean, 1);
 
   rb_define_attr(cTidy, "access", 1, 1);

data/spec/tidy/compat_spec.rb

@@ -28,17 +28,38 @@ describe "tidy compatibility methods" do
 
   it "should parse a string" do
     tidy = Tidy.open({}) do |tidy|
-      xml = tidy.clean("<html><body>String</body></html>")
-      xml.should_not be_empty
+      html = tidy.clean("<html><body>String</body></html>")
+      html.should_not be_empty
     end
   end
 
   it "should be able to parse more than one string consecutively" do
     tidy = Tidy.open({}) do |tidy|
-    errors1, html1 = tidy.clean("<html><body>String</body></html>")
-    errors2, html2 = tidy.clean("<html><head><title>hello</title></head><body>String</body></html>")
-    errors1.should_not == errors2
+      html1 = tidy.clean("<html><body>String</body></html>")
+      errors1 = tidy.errors
+      html2 = tidy.clean("<html><body>String</body></html>")
+      errors2 = tidy.errors
+
+      errors1.should == errors2
     end
   end
 
+  it "should observe the show_warnings entry in the option hash" do
+    errors1 = nil
+    errors2 = nil
+
+    tidy = Tidy.open({:show_warnings => false}) do |tidy|
+      html = tidy.clean("<html><body>String</body></html>")
+      errors1 = tidy.errors
+      puts errors1
+    end
+
+    tidy = Tidy.open({:show_warnings => true}) do |tidy|
+      html = tidy.clean("<html><body>String</body></html>")
+      errors2 = tidy.errors
+      puts errors2
+    end
+
+    errors1.should_not == errors2
+  end
 end

data/spec/tidy/tidy_spec.rb

@@ -28,7 +28,6 @@ describe "tidy class methods" do
   it "should be able to parse more than one string consecutively" do
     errors1, html1 = subject.parse("<html><body>String</body></html>")
     errors2, html2 = subject.parse("<html><head><title>hello</title></head><body>String</body></html>")
-    errors1.should_not == errors2
   end
 
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tidy-ext
 version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Carl Douglas
@@ -14,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-10 00:00:00 +10:00
+date: 2010-06-11 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
-description: "    Tidies up web pages.\n"
+description: Tidy up web pages.
 email: carl.douglas@gmail.com
 executables: []
 
@@ -29,7 +30,6 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - LICENSE
-- README
 - Rakefile
 - VERSION
 - ext/tidy/access.c
@@ -101,25 +101,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: HTML Tidy library implemented as a Ruby extension.
+summary: W3C HTML Tidy library implemented as a Ruby extension.
 test_files: []
 

data/README

@@ -1,12 +0,0 @@
-A native Ruby extension for the tidy application.
-
-Example usage:
-
-require 'tidy'
-require 'open-uri'
-
-tidy = Tidy.new
-errors, tidy_output = tidy.parse('http://www.github.com')
-
-puts errors, tidy_output
-