RubyGems - CodeMonkeySteve-assert_valid_content - Versions diffs - 0.1 - Mend

CodeMonkeySteve-assert_valid_content 0.1

Files changed (8) hide show

data/MIT-LICENSE +21 -0
data/README.rdoc +74 -0
data/lib/assert_valid_content.rb +28 -0
data/lib/assert_valid_content/assertions.rb +64 -0
data/lib/assert_valid_content/libxml.rb +38 -0
data/lib/assert_valid_content/validator.rb +56 -0
data/lib/assert_valid_content/w3c-net.rb +73 -0
metadata +71 -0

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+Copyright (c) 2006-2009 Steve Sloan
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc ADDED Viewed

@@ -0,0 +1,74 @@
+= assert_valid_content
+assert_valid_content is a RubyGem which validates a variety content types (e.g. (X)HTML, CSS, XML) as part of your unit or functional tests.
+It is inspired by assert_valid_markup[http://github.com/wr0ngway/assert_valid_markup] and
+assert_valid_assert[http://www.realityforge.org/articles/2006/03/15/rails-plugin-to-validate-x-html-and-css] with the following goals:
+* Allow for offline use (i.e. not reliant on web services)
+* Validate a wide variety of content types: HTML, JS, JPEG, PDF, MP3, ad infinitum
+* Packaged as a RubyGem, instead of a Rails plugin
+* Provide for specification of more-stringent validation checks (e.g. image properties)
+== Validation Modules
+=== Currently supported:
+[(X)HTML, XML] LibXML via libxml-ruby[http://libxml.rubyforge.org/]
+[CSS]  W3C CSS Validator Service[http://jigsaw.w3.org/css-validator]
+=== Planned support:
+[CSS]  W3C CSS Validator (local execution)
+[JPEG, PNG, et al.]  ImageMagick via rmagick[http://rmagick.rubyforge.org]
+[MP3, OGG, et al.]  ruby-mp3info[http://ruby-mp3info.rubyforge.org/]
+[PDF, MPEG, etc.]  ?
+== Usage
+Validation is performed primary through dynamic assertion functions, defined in AssertValidContent::Assertions
+(and automatically included into Test::Unit::TestCase, if it exists).  The assertions are of the form:
+  assert_valid_TYPE( content )
+where +TYPE+ is a MIME type name (e.g. "html", "css", etc.), and +content+ is a +String+, +Pathname+, or +IO+ object,
+or any combination in an +Array+.  If no +content+ is specified, and the caller is a Rails functional test, the
+response body is used.
+There are also a set of basic assertions:
+  assert_valid_content( type, content )
+  valid_content?( type, content ) # yields validator on invalid content
+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
+    # simple test
+    def test_html
+      html = "<html>...</html>"
+      # these are all equivalent
+      assert_valid_html html
+      assert_valid_html StringIO.new(html)
+      assert_valid_content Mime::HTML, html
+      assert valid_content?(Mime::HTML, html)
+    end
+    # Rails controller test
+    def test_index
+      get :index
+      assert_response :success
+      assert_valid_html
+    end
+    # static content test
+    assert_valid_css Dir.glob("#{RAILS_ROOT}/public/stylesheets/*.css")
+  end
+Author::    Steve Sloan (mailto:steve@finagle.org)
+Website::   http://github.com/CodeMonkeySteve/assert_valid_content
+Copyright:: Copyright (c) 2009 Steve Sloan
+License::   MIT

data/lib/assert_valid_content.rb ADDED Viewed

@@ -0,0 +1,28 @@
+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
+require 'assert_valid_content/w3c-net.rb'
+if AssertValidContent::W3C::Installed
+  AssertValidContent::W3C::CSS.validates Mime::CSS
+end
+require 'assert_valid_content/assertions.rb'
+if defined? Test::Unit::TestCase
+  module Test  # :nodoc:all
+    class Test::Unit::TestCase ; include AssertValidContent::Assertions ; end
+  end
+end

data/lib/assert_valid_content/assertions.rb ADDED Viewed

@@ -0,0 +1,64 @@
+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

data/lib/assert_valid_content/libxml.rb ADDED Viewed

@@ -0,0 +1,38 @@
+require 'assert_valid_content/validator'
+# 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
+# Validates HTML and XHTML
+class AssertValidContent::LibXML::HTML < 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
+  end
+protected
+  def parser( content )  #:nodoc:
+    ::LibXML::XML::HTMLParser.string content
+  end
+end
+# Validates XML
+class AssertValidContent::LibXML::XML < HTML
+protected
+  def parser( content )  #:nodoc:
+    ::LibXML::XML::Parser.string content
+  end
+end
+end

data/lib/assert_valid_content/validator.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require 'action_controller'   # for Mime::Type
+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 = []
+  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")
+  end
+protected
+  # Register a derived class as a validator for content of type +type+
+  def self.validates( type )
+    AssertValidContent.validators[type] << self
+  end
+end
+end

data/lib/assert_valid_content/w3c-net.rb ADDED Viewed

@@ -0,0 +1,73 @@
+require 'assert_valid_content/validator'
+require 'md5'
+require 'fileutils'
+require 'cgi'
+require 'net/http'
+# Validates using W3C Web Service(s)
+module AssertValidContent::W3C
+# +false+ if +NONET+ environment variable is defined (and non-zero).
+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
+  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:
+    FileUtils.mkdir_p TempDir
+    md5 = MD5.md5( content ).to_s
+    resp_path = File.join TempDir, md5
+    begin
+      resp = File.read resp_path
+    rescue
+      params = [
+        file_to_multipart( 'file', 'file.css', 'text/css', content ),
+        text_to_multipart( 'warning', '1' ),
+        text_to_multipart( 'profile', 'css2' ),
+        text_to_multipart( 'usermedium', 'all' ),
+      ]
+      boundary = '-----------------------------24464570528145'
+      query = params.collect { |p| "--#{boundary}\r\n#{p}" }.join + "--#{boundary}--\r\n"
+      type = "multipart/form-data; boundary=#{boundary}"
+      resp = http.start(SrvHost).post2( SrvPath, query, 'Content-type' => type ).body
+      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
+    end
+  end
+  def text_to_multipart(key,value)  #:nodoc:
+    "Content-Disposition: form-data; name=\"#{CGI::escape(key)}\"\r\n\r\n#{value}\r\n"
+  end
+  def file_to_multipart(key,filename,mime_type,content)  #:nodoc:
+    "Content-Disposition: form-data; name=\"#{CGI::escape(key)}\"; filename=\"#{filename}\"\r\n" +
+      "Content-Transfer-Encoding: binary\r\nContent-Type: #{mime_type}\r\n\r\n#{content}\r\n"
+  end
+  def http  #:nodoc:
+    if Module.constants.include?('ApplicationConfig') and ApplicationConfig.respond_to?(:proxy_config)
+      Net::HTTP::Proxy ApplicationConfig.proxy_config['host'], ApplicationConfig.proxy_config['port']
+    else
+      Net::HTTP
+    end
+  end
+end
+end

metadata ADDED Viewed

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: CodeMonkeySteve-assert_valid_content
+version: !ruby/object:Gem::Version
+  version: "0.1"
+platform: ruby
+authors:
+- Steve Sloan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-05-01 00:00:00 -07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- 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
+homepage: http://github.com/CodeMonkeySteve/assert_valid_content
+post_install_message:
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 2
+summary: Content validation test suite
+test_files: []