w3c_rspec_validators 0.0.1 → 0.1.0

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 *.swp
+*~

data/README.md

@@ -32,3 +32,22 @@ 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.
+
+## 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
+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/
+
+## Licence
+MIT License
+
+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/lib/rails/generators/w3c_rspec_validators/config/config_generator.rb

@@ -0,0 +1,15 @@
+module W3cRspecValidators
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      desc 'Creates a w3c_rspec_validators gem configuration file at config/w3c_rspec_validators.yml'
+
+      def self.source_root
+        @_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def create_config_file
+        template 'w3c_rspec_validators.yml', File.join('config', 'w3c_rspec_validators.yml')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,2 @@
+config:
+  w3c_service_uri: "http://localhost.de/check"

data/lib/w3c_rspec_validators.rb

@@ -1,20 +1,6 @@
-require "w3c_rspec_validators/version"
 require "w3c_validators"
 
-module W3cRspecValidators
-  include W3CValidators
-
-  class HTML5Validator
-    def self.validator_uri
-      @@validator_uri
-    end
-
-    def self.validator_uri= value
-      @@validator_uri = value
-    end
-
-    self.validator_uri = "http://validator.w3.org/check"
-  end  
-end
-
+require "w3c_rspec_validators/version"
+require "w3c_rspec_validators/config"
+require "w3c_rspec_validators/validator"
 require "w3c_rspec_validators/rspec"

data/lib/w3c_rspec_validators/config.rb

@@ -0,0 +1,28 @@
+require "rails"
+
+module W3cRspecValidators
+    
+  class Railtie < Rails::Railtie
+    initializer "initialize config" do
+      config_file = Rails.root.join("config", "w3c_rspec_validators.yml")
+      if config_file.file? &&
+        Config.load!(config_file)
+      end
+    end
+  end
+  
+  class Config
+    @@config = {
+      validator_uri: "" 
+    }
+
+    def self.load! config_file
+      @@config = YAML.load(File.open(config_file))["config"] 
+    end
+
+    def self.get
+      @@config
+    end
+  end
+
+end

data/lib/w3c_rspec_validators/rspec.rb

@@ -1,14 +1,13 @@
 module W3cRspecValidators
   
   RSpec::Matchers.define :be_valid_html do
-    response = nil
+    validator = Validator.new
     match do |body|
-      validator = MarkupValidator.new :validator_uri => HTML5Validator.validator_uri
-      response = validator.validate_text(body)
-      response.errors.length == 0
+      validator.validate_text(body)
+      validator.response.errors.length == 0
     end
     failure_message_for_should do |actual|
-      response.errors.map do |err|
+      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

data/lib/w3c_rspec_validators/validator.rb

@@ -0,0 +1,15 @@
+module W3cRspecValidators
+  class Validator
+    attr_reader :response
+    include W3CValidators
+
+    def initialize
+      @validator = MarkupValidator.new validator_uri: Config.get["w3c_service_uri"]
+    end
+
+    def validate_text text
+      @response = @validator.validate_text(text)
+      raise "Error: Invalid validation response! Tip: check if validator.nu engine is configured correctly" if @response.checked_by.blank?
+    end
+  end
+end

data/lib/w3c_rspec_validators/version.rb

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

data/spec/matchers_spec.rb

@@ -56,7 +56,8 @@ describe "be_valid_html" do
   end
 
   it "should use a custom uri if provided" do
-    W3cRspecValidators::HTML5Validator.validator_uri = "http://blubb.de"
+    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
 

data/spec/validator_spec.rb

@@ -0,0 +1,29 @@
+require "w3c_rspec_validators"
+include W3CValidators
+
+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")
+      MarkupValidator.should_receive(:new).with(validator_uri: "http://blubb.de")
+
+      W3cRspecValidators::Validator.new
+    end
+  end
+
+  describe "validate_text" do
+    it "should raise an exception if validation fails silently" do
+      class Dummy
+        def checked_by
+          ""
+        end
+      end
+      MarkupValidator.any_instance.stub(:validate_text).and_return Dummy.new
+      
+      expect {
+        W3cRspecValidators::Validator.new.validate_text("dummy")
+      }.to raise_exception
+    end
+  end
+end

data/w3c_rspec_validators.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
   s.add_runtime_dependency "w3c_validators"
+  s.add_runtime_dependency "rspec"
+  s.add_runtime_dependency "rails"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: w3c_rspec_validators
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-17 00:00:00.000000000 Z
+date: 2012-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: w3c_validators
-  requirement: &13322940 !ruby/object:Gem::Requirement
+  requirement: &13643700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,29 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13322940
+  version_requirements: *13643700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &13641700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *13641700
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &13639620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *13639620
 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
@@ -35,10 +57,15 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- lib/rails/generators/w3c_rspec_validators/config/config_generator.rb
+- 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/rspec.rb
+- lib/w3c_rspec_validators/validator.rb
 - lib/w3c_rspec_validators/version.rb
 - spec/matchers_spec.rb
+- spec/validator_spec.rb
 - w3c_rspec_validators.gemspec
 homepage: ''
 licenses: []