w3c_rspec_validators 0.1.0 → 0.2.0

data/Gemfile

@@ -2,6 +2,10 @@ source "http://rubygems.org"
 
 gem "w3c_validators"
 gem "rspec"
+gem "linecache19", git: "git://github.com/mark-moseley/linecache", require: "ruby-debug"
+gem "ruby-debug-base19x", "~> 0.11.30.pre4"
+gem "ruby-debug19"
+
 
 # Specify your gem's dependencies in w3c_rspec_validators.gemspec
 gemspec

data/README.md

@@ -10,7 +10,9 @@ You need rspec for this gem to work. In addition add this to your gemfile:
 
 ## Usage
 
-Here is an example for using it in an acceptance test:
+Here are examples for using it in acceptance tests:
+
+### HTML Validation
 
 ```ruby
 scenario "visit landing page" do
@@ -33,6 +35,20 @@ end
 If you want to check html code, that has been modified by javascript, use "page.body.should be_valid_html".
 Note that a browser may correct wrongly nested tags on its own.
 
+### CSS Validation
+
+W3cRspecValidators::CssFiles.compiled will run rake assets:precompile and returns
+the applications css as string.
+
+WARNING: This also deletes the folder public/assets so that the compiled assets are removed after the tests.
+
+```ruby
+it "should be valid css" do
+  W3cRspecValidators::CssFiles.compiled.should be_valid_css
+end
+```
+
+
 ## Running faster offline validation
 
 If you do not want to use the online W3C Validation service, which is default, you can set the validator url to a locally runnig version
@@ -41,7 +57,9 @@ of the W3C Validator service by creating a config file:
     rails g w3c_rspec_validators:config
 
 Check this url to see how to install your local version of the W3C validation service: http://validator.w3.org/docs/install.html
-For local HTML5 validation to work you'll need validator.nu running locally too: http://about.validator.nu/
+For local HTML5 validation to work you'll need validator.nu running locally too: http://about.validator.nu
+
+For local CSS validation to work you'll need http://jigsaw.w3.org/css-validator/DOWNLOAD.html
 
 ## Licence
 MIT License

data/lib/rails/generators/w3c_rspec_validators/config/templates/w3c_rspec_validators.yml

@@ -1,2 +1,6 @@
+# you cann comment out the service uris that you don't need. The default online
+# validator will be used then.
+
 config:
   w3c_service_uri: "http://localhost.de/check"
+  w3c_css_service_uri: "http://css.localhost.de/validator"

data/lib/w3c_rspec_validators/config.rb

@@ -8,6 +8,8 @@ module W3cRspecValidators
       if config_file.file? &&
         Config.load!(config_file)
       end
+
+     # puts ActionDispatch::Routing::UrlFor::url_for("/")
     end
   end
   

data/lib/w3c_rspec_validators/css_files.rb

@@ -0,0 +1,15 @@
+module W3cRspecValidators
+  class CssFiles
+    def self.compiled paths=["#{Rails.root}/public/assets/*.css"]
+      system "rake -q assets:precompile"
+      files = Dir.glob(paths.join(","))
+      css = ""
+      files.each do |f|
+        css += File.read f
+      end
+      FileUtils.rm_rf "#{Rails.root}/public/assets/"
+
+      css
+    end
+  end
+end

data/lib/w3c_rspec_validators/error_parser.rb

@@ -0,0 +1,43 @@
+module W3cRspecValidators
+  class ErrorParser
+    def self.parse_html_error err, actual
+      seperator = "######\n"
+      error = /line \d.*/.match err.to_s
+      line_number = /line (\d*)/.match(err.to_s)[1].to_i
+
+      sbody = actual.split("\n")
+      context = sbody[[line_number-3,0].max...line_number-1].join("\n")
+      context += "\n>>" + sbody[line_number-1] + "\n"
+      context += sbody[line_number..line_number+2].join("\n")
+
+      seperator + error.to_s + "\n\n" + context + "\n"
+    end
+
+    def self.parse_css_error err, actual
+      seperator = "######\n"
+      error = /line \d*:(.*)/m.match(err.to_s)[1]
+      line_number = /line (\d*)/.match(err.to_s)[1].to_i
+
+      stext = actual.split("\n")
+
+      i = line_number
+      file = ""
+      while true do
+        if i == 0 || match = /\/\* line \d*,(.*)\*\//.match(stext[i])
+          unless match.nil?
+            file = match[1].strip
+          end
+          break
+        end
+        i -= 1
+      end
+      real_line_number = line_number - i - 1
+
+      context = stext[[line_number-3,0].max...line_number-1].join("\n")
+      context += "\n>>" + stext[line_number-1] + "\n"
+      context += stext[line_number..line_number+2].join("\n")
+
+      seperator + error.to_s.gsub(/\n/,"").gsub("  ", "") + "\nReal code location(guessed) in File " + file + " on line #{real_line_number}\n\nCode context:\n" + context + "\n"
+    end
+  end
+end

data/lib/w3c_rspec_validators/rspec.rb

@@ -3,23 +3,27 @@ module W3cRspecValidators
   RSpec::Matchers.define :be_valid_html do
     validator = Validator.new
     match do |body|
-      validator.validate_text(body)
+      validator.validate_html(body)
       validator.response.errors.length == 0
     end
     failure_message_for_should do |actual|
       validator.response.errors.map do |err|
-        seperator = "######\n"
-        error = /line \d.*/.match err.to_s
-        line_number = /line (\d*)/.match(err.to_s)[1].to_i
-
-        sbody = actual.split("\n")
-        context = sbody[[line_number-3,0].max...line_number-1].join("\n")
-        context += "\n>>" + sbody[line_number-1] + "\n"
-        context += sbody[line_number..line_number+2].join("\n")
-
-        seperator + error.to_s + "\n\n" + context + "\n"
+        ErrorParser.parse_html_error(err, actual)
       end.join("\n")
     end
   end
+  
+  RSpec::Matchers.define :be_valid_css do
+    validator = Validator.new
+    match do |css|
+      validator.validate_css css
+      validator.response.errors.length == 0
+    end
 
+    failure_message_for_should do |actual|
+      validator.response.errors.map do |err|
+        ErrorParser.parse_css_error(err, actual)
+      end.join("\n")
+    end
+  end
 end

data/lib/w3c_rspec_validators/validator.rb

@@ -4,12 +4,21 @@ module W3cRspecValidators
     include W3CValidators
 
     def initialize
-      @validator = MarkupValidator.new validator_uri: Config.get["w3c_service_uri"]
+      @html_validator = MarkupValidator.new validator_uri: Config.get["w3c_service_uri"]
+      @css_validator = CSSValidator.new validator_uri: Config.get["w3c_css_service_uri"]
     end
 
-    def validate_text text
-      @response = @validator.validate_text(text)
+    def validate_html text
+      @response = @html_validator.validate_text(text)
       raise "Error: Invalid validation response! Tip: check if validator.nu engine is configured correctly" if @response.checked_by.blank?
+      @response
+    end
+
+    def validate_css text
+      @response = @css_validator.validate_text(text)
+      raise "Error: Invalid validation response! Tip: check if validator.nu engine is configured correctly" if @response.checked_by.blank?
+      @response
     end
   end
+
 end

data/lib/w3c_rspec_validators/version.rb

@@ -1,3 +1,3 @@
 module W3cRspecValidators
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/w3c_rspec_validators.rb

@@ -3,4 +3,6 @@ require "w3c_validators"
 require "w3c_rspec_validators/version"
 require "w3c_rspec_validators/config"
 require "w3c_rspec_validators/validator"
+require "w3c_rspec_validators/css_files"
+require "w3c_rspec_validators/error_parser"
 require "w3c_rspec_validators/rspec"

data/spec/css_files_spec.rb

@@ -0,0 +1,18 @@
+require "w3c_rspec_validators"
+
+describe "css_files" do
+  describe "self.compiled" do
+  
+    before(:each) do
+      Object.should_receive(:system).with "rake -q assets:precompile"
+      Rails.stub(:root).and_return "railsroot"
+      FileUtils.should_receive(:rm_rf).with "railsroot/public/assets/"
+    end
+
+    it "should read css files from a directory" do
+      directory = File.dirname(__FILE__)
+      W3cRspecValidators::CssFiles.compiled(["#{directory}/fixtures/*.css"])
+        .should == "#home {}\nbody {\n}\n"
+    end
+  end
+end

data/spec/error_parser_spec.rb

@@ -0,0 +1,60 @@
+require "w3c_rspec_validators"
+
+describe "error_parser" do
+
+  describe "self.parse_css" do
+    before(:each) do
+      @css_error_message = "ERROR; URI: file://localhost/TextArea; line 7: 
+        
+                                Property foo doesn't exist :"
+      @css = "
+body {
+  blubb: 1 px;
+}
+/* line 5, ../../app/assets/stylesheets/home.css.scss */
+#home {
+  foo: 2px;
+}"
+    end
+
+    it "should properly format css errors" do
+      W3cRspecValidators::ErrorParser.parse_css_error(@css_error_message, @css)
+        .should == "######
+ Property foo doesn't exist :
+Real code location(guessed) in File ../../app/assets/stylesheets/home.css.scss on line 2
+
+Code context:
+/* line 5, ../../app/assets/stylesheets/home.css.scss */
+#home {
+>>  foo: 2px;
+}\n"
+    end
+  end
+
+  describe "self.parse_html" do
+    before(:each) do
+      @html_error_message = "ERROR; URI: upload://Form Submission; line 7: An img element must have an alt attribute, except under certain conditions. For details, consult guidance on providing text alternatives for images."
+      @html = "<!DOCTYPE HTML SYSTEM>
+        <html>
+          <head>
+            <title>dd</title>
+          </head>
+          <body>
+            <img />
+          </body>
+        </html>"
+    end
+
+    it "should properly format a html error message" do
+      W3cRspecValidators::ErrorParser.parse_html_error(@html_error_message, @html)
+        .should == "######
+line 7: An img element must have an alt attribute, except under certain conditions. For details, consult guidance on providing text alternatives for images.
+
+          </head>
+          <body>
+>>            <img />
+          </body>
+        </html>\n"
+    end
+  end
+end

data/spec/fixtures/file.css

@@ -0,0 +1,2 @@
+body {
+}

data/spec/fixtures/file2.css

@@ -0,0 +1 @@
+#home {}

data/spec/matchers_spec.rb

@@ -17,50 +17,69 @@ module RSpec
   end
 end
 
+describe "rspec matchers" do
 
+  describe "be_valid_html" do
+    it "should be valid" do
+      "<!DOCTYPE HTML SYSTEM>
+        <html>
+          <head>
+            <title>dd</title>
+          </head>
+          <body>
+          </body>
+        </html>".should be_valid_html
+    end
 
-describe "be_valid_html" do
-  it "should be valid" do
-    "<!DOCTYPE HTML SYSTEM>
-      <html>
-        <head>
-          <title>dd</title>
-        </head>
-        <body>
-        </body>
-      </html>".should be_valid_html
-  end
+    it "should not be valid" do
+      "<!DOCTYPE HTML SYSTEM>
+        <html>
+          <head>
+            <titled>dd</title>
+          </head>
+          <body></body>
+        </html>".should_not be_valid_html
+    end
 
-  it "should not be valid" do
-    "<!DOCTYPE HTML SYSTEM>
-      <html>
-        <head>
-          <titled>dd</title>
-        </head>
-        <body></body>
-      </html>".should_not be_valid_html
-  end
+    it "should complain about an missing src attribute" do
+      lambda {
+        "<!DOCTYPE HTML SYSTEM>
+        <html>
+          <head>
+            <title>dd</title>
+          </head>
+          <body>
+            <img />
+          </body>
+        </html>".should be_valid_html
+      }.should fail_matching(/line 7: required attribute "SRC" not specified.*<img \/>/m)
+    end
 
-  it "should complain about an missing src attribute" do
-    lambda {
-      "<!DOCTYPE HTML SYSTEM>
-      <html>
-        <head>
-          <title>dd</title>
-        </head>
-        <body>
-          <img />
-        </body>
-      </html>".should be_valid_html
-    }.should fail_matching(/line 7: required attribute "SRC" not specified.*<img \/>/m)
+    it "should use a custom uri if provided" do
+      W3cRspecValidators::Config.stub(:get).and_return("w3c_service_uri" => "http://blubb.de")
+      
+      validator = MarkupValidator.new
+      MarkupValidator.should_receive(:new).with(:validator_uri => "http://blubb.de").and_return validator
+
+      "dummy".should_not be_valid_html
+    end
   end
 
-  it "should use a custom uri if provided" do
-    W3cRspecValidators::Config.stub(:get).and_return("w3c_service_uri" => "http://blubb.de")
-    
-    validator = MarkupValidator.new
-    MarkupValidator.should_receive(:new).with(:validator_uri => "http://blubb.de").and_return validator
+  describe "be_valid_css" do
+    it "should be valid" do
+      "body {}".should be_valid_css
+    end
+
+    it "should not be valid" do
+      "body { foo: 12px; }".should_not be_valid_css
+    end
+
+    it "should not be valid" do
+      lambda {
+        "body { foo: 12px; }".should be_valid_css
+      }.should fail_matching(/Property foo doesn't exist/)
+    end
 
-    "dummy".should_not be_valid_html
   end
+
 end

data/spec/validator_spec.rb

@@ -5,8 +5,9 @@ describe W3cRspecValidators::Validator do
 
   describe "initialize" do
     it "should initialize MarkupValidator with config value" do
-      W3cRspecValidators::Config.stub(:get).and_return("w3c_service_uri" => "http://blubb.de")
+      W3cRspecValidators::Config.stub(:get).and_return("w3c_service_uri" => "http://blubb.de", "w3c_css_service_uri" => "http://test.de")
       MarkupValidator.should_receive(:new).with(validator_uri: "http://blubb.de")
+      CSSValidator.should_receive(:new).with(validator_uri: "http://test.de")
 
       W3cRspecValidators::Validator.new
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: w3c_rspec_validators
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-18 00:00:00.000000000 Z
+date: 2012-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: w3c_validators
-  requirement: &13643700 !ruby/object:Gem::Requirement
+  requirement: &19268480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13643700
+  version_requirements: *19268480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &13641700 !ruby/object:Gem::Requirement
+  requirement: &19267980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13641700
+  version_requirements: *19267980
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &13639620 !ruby/object:Gem::Requirement
+  requirement: &19267560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13639620
+  version_requirements: *19267560
 description: At this time it allows for validation of html (including html5) produced
   by rspec acceptance tests. In addition you can configure the gem to use a locally
   installed validation service instead of the online w3c servers
@@ -61,9 +61,15 @@ files:
 - lib/rails/generators/w3c_rspec_validators/config/templates/w3c_rspec_validators.yml
 - lib/w3c_rspec_validators.rb
 - lib/w3c_rspec_validators/config.rb
+- lib/w3c_rspec_validators/css_files.rb
+- lib/w3c_rspec_validators/error_parser.rb
 - lib/w3c_rspec_validators/rspec.rb
 - lib/w3c_rspec_validators/validator.rb
 - lib/w3c_rspec_validators/version.rb
+- spec/css_files_spec.rb
+- spec/error_parser_spec.rb
+- spec/fixtures/file.css
+- spec/fixtures/file2.css
 - spec/matchers_spec.rb
 - spec/validator_spec.rb
 - w3c_rspec_validators.gemspec
@@ -92,3 +98,4 @@ signing_key:
 specification_version: 3
 summary: This gem adds w3c validation in form of rspec matchers
 test_files: []
+has_rdoc: