CodeMonkeySteve-assert_valid_content 0.1 → 0.2

data/README.rdoc

@@ -41,7 +41,6 @@ where +type+ is a MIME type constant (e.g. "Mime::HTML").
 
 == Examples
   require 'rubygems'
-  require 'test/unit'
   require 'assert_valid_content'
 
   class ContentTest < Test::Unit::TestCase

data/lib/assert_valid_content.rb

@@ -1,28 +1,28 @@
-require 'tmpdir'
+require 'assert_valid_content/validator'
 
+require 'tmpdir'
 module AssertValidContent
   TempDir = if defined? RAILS_ROOT
     File.join RAILS_ROOT, 'tmp/validate'
   else
     File.join Dir.tmpdir, 'assert_valid_content'
   end
-end
 
-require 'assert_valid_content/libxml.rb'
-if AssertValidContent::LibXML::Installed
-  AssertValidContent::LibXML::HTML.validates Mime::HTML
-  AssertValidContent::LibXML::XML. validates Mime::XML
-end
+  module Assertions
+    require 'assert_valid_content/libxml.rb'
+    include AssertValidContent::LibXML::Assertions  if AssertValidContent::LibXML::Installed
 
-require 'assert_valid_content/w3c-net.rb'
-if AssertValidContent::W3C::Installed
-  AssertValidContent::W3C::CSS.validates Mime::CSS
+    require 'assert_valid_content/w3c-net.rb'
+    include AssertValidContent::W3C::Assertions  if AssertValidContent::W3C::Installed
+  end
 end
 
-require 'assert_valid_content/assertions.rb'
+require 'test/unit'
 if defined? Test::Unit::TestCase
-  module Test  # :nodoc:all
-    class Test::Unit::TestCase ; include AssertValidContent::Assertions ; end
+  module Test::Unit  # :nodoc:all
+    class TestCase
+      include AssertValidContent::Assertions
+    end
   end
 end
 

data/lib/assert_valid_content/libxml.rb

@@ -1,24 +1,18 @@
-require 'assert_valid_content/validator'
+require 'libxml'
 
-# Validates using LibXML via the libxml-ruby[http://libxml.rubyforge.org/] gem.
+  # Validates using LibXML via the libxml-ruby[http://libxml.rubyforge.org/] gem.
 module AssertValidContent::LibXML
 
-# +true+ if required dependencies are installed
-Installed = begin
-  gem( 'libxml-ruby', '~> 1.1' )
-  require 'libxml'
-  true
-rescue Gem::LoadError
-  false
-end
+Installed = true
 
 # Validates HTML and XHTML
-class AssertValidContent::LibXML::HTML < AssertValidContent::Validator
-  def validate( content )  #:nodoc:
+class HTMLValidator < AssertValidContent::Validator
+  def validate!( content )  #:nodoc:
     ::LibXML::XML::Error.set_handler { |err|  @errors << err  }
     begin
       doc = self.parser( content ).parse
     rescue ::LibXML::XML::Error ; end
+    @errors.empty?
   end
 
 protected
@@ -27,12 +21,24 @@ protected
   end
 end
 
+module Assertions
+  def assert_valid_html( *srcs, &blk )
+    assert_valid_content ::AssertValidContent::LibXML::HTMLValidator, *srcs, &blk
+  end
+end
+
 # Validates XML
-class AssertValidContent::LibXML::XML < HTML
+class XMLValidator < HTMLValidator
 protected
   def parser( content )  #:nodoc:
     ::LibXML::XML::Parser.string content
   end
 end
 
+module Assertions
+  def assert_valid_xml( *srcs, &blk )
+    assert_valid_content ::AssertValidContent::LibXML::XMLValidator, *srcs, &blk
+  end
+end
+
 end

data/lib/assert_valid_content/validator.rb

@@ -3,53 +3,53 @@ require 'pathname'
 
 module AssertValidContent  # :nodoc
 
-# Hash of +type+ to sets of Validator objects for that type.
-def self.validators ; @@validators ; end
-@@validators = Hash.new { |h, k|  h[k] = Set.new }
-
-# Returns +true+ if the content from +src+ is valid for type +type+.  Yields on failure.
-# +src+ is one of +String+, +Pathname+, or +IO+ object
-def self.valid_content?( type, src )  # :yields: validator
-  validators = AssertValidContent.validators[type]
-  raise "No validators for type: #{type}"  if validators.empty?
-
-  content = case src
-    when String    then src
-    when Pathname  then IO.read src
-    when IO        then src.read
-    else           raise "Unknown content src type: #{src.class}"
-  end
-
-  val = nil
-  valid = validators.all? do |cl|
-    val = cl.new
-    val.validate content
-    val.errors.empty?
-  end
-
-  yield(val)  if block_given? and not valid
-  valid
-end
-
 # Base class for all content validators
 class Validator
   # Validation errors
   attr_reader :errors
 
-  def initialize  #:nodoc:
-    @errors = []
+  def initialize( opts = {} )  #:nodoc:
+    @src, @errors = nil, []
   end
 
   # Returns an error message listing validation errors (or +nil+ if there were none).
   def to_s
     return nil  unless @errors
-    "#{self.class.name} validation failed:\n" + @errors.map { |e|  "  #{e.to_s}" }.join("\n")
+    "#{self.class.name} validation failed:\n" +
+      @errors.map { |e|  "  #{e.to_s}" }.join("\n")
+  end
+
+  def validate( src, &blk )
+    @src = src
+    content = case src
+      when Pathname  then IO.read src
+      when IO        then src.read
+      else           src
+    end
+    validate! content, &blk
   end
 
 protected
-  # Register a derived class as a validator for content of type +type+
-  def self.validates( type )
-    AssertValidContent.validators[type] << self
+  def validate!( content, &blk )
+    raise NotImplementedError
+  end
+end
+
+module Assertions
+  def assert_valid_content ( vclass, *args, &blk )
+    opts = (Hash === args.last) ? args.pop : {}
+    if args.empty?
+      if defined? RAILS_ROOT
+        args = [ @controller.response.body ]
+      else
+        raise ArgumentError, 'wrong number of arguments (0 for 1 or more)'
+      end
+    end
+
+    validator = vclass.new opts
+    args.each do |src|
+      assert validator.validate( *args, &blk )
+    end
   end
 end
 

data/lib/assert_valid_content/w3c-net.rb

@@ -1,8 +1,8 @@
-require 'assert_valid_content/validator'
 require 'md5'
 require 'fileutils'
 require 'cgi'
 require 'net/http'
+require 'libxml'
 
 # Validates using W3C Web Service(s)
 module AssertValidContent::W3C
@@ -12,13 +12,12 @@ Installed = ENV['NONET'].to_i.zero?
 
 # Validates via the W3C CSS validator service[http://jigsaw.w3.org/css-validator/]
 # (taken from assert-valid-asset[http://github.com/CodeMonkeySteve/assert-valid-asset]).
-class CSS < AssertValidContent::Validator
-
+class CSSValidator < AssertValidContent::Validator
   SrvHost = ENV['CSS_VALIDATOR_HOST'] || 'jigsaw.w3.org'
   SrvPath = ENV['CSS_VALIDATOR_PATH'] || '/css-validator/validator'
   TempDir = File.join AssertValidContent::TempDir, 'w3c-net'
 
-  def validate( content )  #:nodoc:
+  def validate!( content )  #:nodoc:
     FileUtils.mkdir_p TempDir
 
     md5 = MD5.md5( content ).to_s
@@ -42,13 +41,13 @@ class CSS < AssertValidContent::Validator
       File.open( resp_path, 'w+' ) { |f|  f.write resp }
     end
 
-    begin
-      root = REXML::Document.new( resp ).root
-      REXML::XPath.each( root, "//x:tr[@class='error']", { "x"=>"http://www.w3.org/1999/xhtml" } )  do |el|
-        @errors << "Invalid CSS: line" + el.to_s.gsub(/<[^>]+>/,' ').gsub(/\n/,' ').gsub(/\s+/, ' ')
-      end
-    rescue REXML::ParseException
+    doc = LibXML::XML::HTMLParser.string(resp).parse
+    doc.find("//tr[@class='error']").each do |err|
+      lineno = err.find_first("td[@class='linenumber']/text()").content.to_i
+      msg = err.find_first("td[@class='parse-error']/text()").content.strip
+      @errors << "Invalid CSS (#{@src.inspect} line #{lineno}: #{msg}"
     end
+    @errors.empty?
   end
 
   def text_to_multipart(key,value)  #:nodoc:
@@ -67,7 +66,12 @@ class CSS < AssertValidContent::Validator
       Net::HTTP
     end
   end
+end
 
+module Assertions
+  def assert_valid_css( *srcs, &blk )
+    assert_valid_content ::AssertValidContent::W3C::CSSValidator, *srcs, &blk
+  end
 end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: CodeMonkeySteve-assert_valid_content
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - Steve Sloan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-01 00:00:00 -07:00
+date: 2009-06-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-libxml
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Provides test assertions for the validity of various content types (i.e. HTML, XML CSS, etc).
 email: steve@finagle.org
 executables: []
@@ -35,7 +45,6 @@ files:
 - MIT-LICENSE
 - lib/assert_valid_content.rb
 - lib/assert_valid_content/validator.rb
-- lib/assert_valid_content/assertions.rb
 - lib/assert_valid_content/libxml.rb
 - lib/assert_valid_content/w3c-net.rb
 has_rdoc: true

data/lib/assert_valid_content/assertions.rb

@@ -1,64 +0,0 @@
-require 'assert_valid_content/validator'
-
-module AssertValidContent
-
-# Test case assertions
-module Assertions
-
-  # Asserts that the content (from one ore more +srcs+) is valid for type +type+.
-  # Each of +srcs+ is one of +String+, +Pathname+, or +IO+ object.
-  def assert_valid_content( type, *srcs )
-    msg = nil
-    for src in srcs
-      res = AssertValidContent.valid_content?(type, src) { |val|  msg = val.to_s }
-      assert_block( msg ) { res }
-    end
-  end
-
-  alias_method :orig_method_missing, :method_missing  #:nodoc:
-
-  # Implements the +assert_valid_TYPE+(*+srcs+) dynamic assertions, where +TYPE+ is a MIME type name
-  # (e.g. +html+, +css+, etc.) and each of +srcs+ one of +String+, +Pathname+, or +IO+ object.
-  def method_missing( name, *args )
-    n = name.to_s
-    return orig_method_missing( name, *args ) unless
-      (n[0..12] == 'assert_valid_') and (type = Mime::Type.lookup_by_extension n[13..-1])
-
-    if args.empty? and self.respond_to?(:response) and self.response.respond_to(:body)
-      args = [ self.response.body ]
-    end
-
-    assert_valid_content type, *args
-  end
-
-  module ClassMethods
-    alias_method :orig_method_missing, :method_missing  #:nodoc:
-
-    # Implements the class-level +assert_valid_TYPE+(*+srcs+) dynamic assertions.  See Assertions.method_missing.
-    def method_missing( name, *args )
-      n = name.to_s
-      return orig_method_missing( name, *args ) unless
-        (n[0..12] == 'assert_valid_') and (type = Mime::Type.lookup_by_extension n[13..-1])
-
-      self.assert_valid_static_content << [ type, *args ]
-    end
-
-    def assert_valid_static_content  #:nodoc:
-      @assert_valid_static_content ||= []
-    end
-  end
-
-  def self.included( base )  #:nodoc:
-    base.extend Assertions::ClassMethods
-  end
-
-  # Executes class-level assertions (i.e. static content).
-  def test__assert_valid_static_content  #:nodoc:
-    for args in self.class.assert_valid_static_content
-      assert_valid_content *args
-    end
-  end
-
-end
-
-end