rack-validate 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ed Schmalzle
+
+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

@@ -0,0 +1,18 @@
+= rack-validate
+
+Simple Rack middleware to validate HTML with w3c validator and present response in the page. Used by passing rack-validate=true in the request.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Ed Schmalzle. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-validate"
+    gem.summary = %Q{Rack middleware that validates HTML with w3c validator and displays result in page.}
+    gem.description = %Q{Rack middleware that validates HTML with w3c validator and displays result in page.}
+    gem.email = "Jonas714@gmail.com"
+    gem.homepage = "http://github.com/nerdEd/rack-validate"
+    gem.authors = ["Ed Schmalzle"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-validate #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/rack-validate.rb

@@ -0,0 +1,34 @@
+require 'rack'
+require 'rack-validate/validator'
+
+module Rack
+  
+  # A rack middleware for validating HTML via w3c validator
+  class Validate
+    
+    def initialize( app )
+      @app = app
+    end
+        
+    def call( env )
+      status, headers, response = @app.call( env )
+      
+      request = Rack::Request.new( env )
+      if !request.params['rack-validate'].blank?
+        if headers['Content-Type'] =~ /text\/html|application\/xhtml\+xml/
+          body = response.body
+        
+          issues = Validator.validate( body )
+        
+          body.insert( 0, Validator.generate_report( issues ) )
+        
+          headers["Content-Length"] = body.length.to_s
+          response = [body]
+        end
+      end
+      
+      [status, headers, response]
+    end
+          
+  end
+end

data/lib/rack-validate/validator.rb

@@ -0,0 +1,131 @@
+require 'rack'
+require 'w3c_validators'
+
+module Rack
+  class Validate
+    class Validator
+      include W3CValidators
+      
+      def self.validate( response )
+        validator = MarkupValidator.new    
+        validator.validate_text( response )        
+      end
+      
+      def self.generate_report( issues )        
+        report = ""
+        report << STYLES
+        report << SCRIPT
+        
+        report << "<div id='message_toolbar'>"
+          report << '<div id="controls">'        
+            summary = "<span>There were " + issues.errors.size.to_s + " errors and " + issues.warnings.size.to_s + " warnings</span><br/><br/>"
+      		  report << summary  		  
+      		  report << LINKS  		  
+    		  report << '</div>'
+        
+          if !issues.errors.empty?
+            report << "<table id='errors_table' style='display:none;'>"
+            report << "<tr><td colspan='2' class='header_column'>Errors</td></tr>"
+            issues.errors.each do |item|
+              report << "<tr><td class='line_number_column'>Line #{item.line}</td><td class='message_column'>#{html_escape( item.message )}</td></tr>"
+            end
+            report << "</table>"
+          end
+        
+          if !issues.warnings.empty?
+            report << "<table id='warnings_table' style='display:none;'>"
+            report << "<tr><td colspan='2' class='header_column'>Warnings</td></tr>"
+            issues.warnings.each do |item|
+              report << "<tr><td class='line_number_column'>--</td><td class='message_column'>#{html_escape( item.message )}</td></tr>"
+            end
+            report << "</table>"
+          end
+        report << "</div>"
+      end
+      
+      private 
+      
+        # Stealing HTML escape method from rails
+        def self.html_escape( string )
+          string.to_s.gsub(/[&"><]/) { |special| HTML_ESCAPE[special] }
+        end
+      
+        # Stealing HTML escape constant from rails
+        HTML_ESCAPE	=	{ '&' => '&amp;', '>' => '&gt;', '<' => '&lt;', '"' => '&quot;' }
+        
+        LINKS = <<-HERE
+  		    <a href="#" onclick="$( '#errors_table' ).toggle();updateText( this, 'Show Errors', 'Hide Errors' );">Show Errors</a>
+  		    <a href="#" onclick="$( '#warnings_table' ).toggle();updateText( this, 'Show Warnings', 'Hide Warnings' );">Show Warnings</a>
+  		    <a href="#" onclick="$( '#message_toolbar' ).toggle();">Close Toolbar</a>
+  		  HERE
+        
+        SCRIPT = <<-HERE
+          <script src="http://www.google.com/jsapi"></script>
+          <script type="text/javascript">
+            google.load("jquery", "1.3.2");
+            google.load("jqueryui", "1.7.2");
+
+            function updateText( element, textOne, textTwo ) {
+              if( element.innerHTML == textOne ) {
+                element.innerHTML = textTwo;
+              }
+              else { 
+                element.innerHTML = textOne;
+              }
+            }
+          </script>        
+        HERE
+                        
+        STYLES = <<-HERE
+    		<style type='text/css'>
+          #message_toolbar {
+            width: 100%; 
+            min-height: 50px;
+            background: black;
+            position: absolute;			  
+            top:0;
+            left:0;
+            -moz-opacity:.80; 
+            filter:alpha(opacity=80); 
+            opacity:.80;
+            font-size: smaller;
+            font-family: "Courier New";
+            color: white;
+            text-align: center;
+          }			
+          #message_toolbar a{
+            color: white;
+            font-weight: bold;
+          }
+          .line_number_column {
+            text-align: left;
+            width: 100px;
+          }			
+          .error_message_column {
+            text-align: left;
+          }		
+          #errors_table,
+          #warnings_table {
+            width: 75%;
+            margin: 0 auto;
+            border: none;
+            color: white;
+            margin-top: 10px;
+          }
+          #errors_table .header_column,
+          #warnings_table .header_column {
+            text-align: center;
+            border-bottom: 2px dashed;
+          }
+          #errors_table .header_column {
+            border-color: red;
+          }
+          #warnings_table .header_column {
+            border-color: yellow;
+          }
+    		</style>
+
+        HERE
+    end
+  end  
+end

data/rack-validate.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-validate}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ed Schmalzle"]
+  s.date = %q{2009-11-16}
+  s.description = %q{Rack middleware that validates HTML with w3c validator and displays result in page.}
+  s.email = %q{Jonas714@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rack-validate.rb",
+     "lib/rack-validate/validator.rb",
+     "rack-validate.gemspec",
+     "test/rack-validate_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/nerdEd/rack-validate}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rack middleware that validates HTML with w3c validator and displays result in page.}
+  s.test_files = [
+    "test/rack-validate_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      # s.add_development_dependency(%q<w3c_validator>, [">= 0.9.3]"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      # s.add_dependency(%q<w3c_validator>, [">= 0.9.3]"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    # s.add_dependency(%q<w3c_validator>, [">= 0.9.3]"])
+  end
+end
+

data/test/rack-validate_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class RackValidateTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack-validate'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: rack-validate
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ed Schmalzle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Rack middleware that validates HTML with w3c validator and displays result in page.
+email: Jonas714@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack-validate.rb
+- lib/rack-validate/validator.rb
+- rack-validate.gemspec
+- test/rack-validate_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/nerdEd/rack-validate
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Rack middleware that validates HTML with w3c validator and displays result in page.
+test_files: 
+- test/rack-validate_test.rb
+- test/test_helper.rb