bbc_mobile_standards 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in bbc_mobile_standards.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bbc_mobile_standards.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bbc_mobile_standards/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bbc_mobile_standards"
+  s.version     = BBCMobileStandards::VERSION
+  s.authors     = ["Matthew Crouch"]
+  s.email       = ["matthew.crouch@bbc.co.uk"]
+  s.homepage    = "http://www.bbc.co.uk/"
+  s.summary     = %q{BBC Mobile Standards validator}
+  s.description = %q{Validates HTML and accessibility. Follows FM&T Standards: http://www.bbc.co.uk/guidelines/futuremedia/technical/semantic_markup.shtml}
+
+  s.rubyforge_project = "bbc_mobile_standards"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "raakt", "~> 0.5.6"
+  s.add_dependency "nokogiri"
+  s.add_dependency "w3c_validators"
+  s.add_dependency "rest-client"
+  
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "fakeweb"
+  
+end

data/lib/bbc_mobile_standards/accessibility_validator.rb

@@ -0,0 +1,32 @@
+module BBCMobileStandards
+  class AccessibilityValidator
+    
+    attr_reader :errors
+    
+    def initialize(html_string)
+      @html_string = html_string
+      @page = Nokogiri::HTML(@html_string)
+      @errors = []
+      validate_page
+    end
+    
+    def valid?
+      true unless @errors.size > 0
+    end
+    
+    protected
+    
+    def validate_page
+      rakkt_test = Raakt::Test.new(@html_string)
+      rakkt_test.check_images.map { |e| @errors << e.text }
+      @errors << "Document heading structure is wrong" unless rakkt_test.check_document_structure.size == 0
+      @page.xpath('//img[not(@width) or not(@height)]').map { |img| @errors << "No width or height attribute for #{img.to_s}" }
+      @errors << "Page is using <br> for whitespace" if @page =~ /<br\/>\s*<br\/>/
+      @errors << "Page doesn't have 1 <h1> tag" unless @page.xpath('//h1').size == 1
+      %w(b i big blink marquee s strike tt u center nobr font).each do |tag|
+        @errors << "Page is using <#{tag}>" if @page.xpath("//#{tag}").any?
+      end
+      @page.xpath("//form[not(@type)]").map { |form| @errors << "There is a form without a type tag" }
+    end
+  end
+end

data/lib/bbc_mobile_standards/html_validator.rb

@@ -0,0 +1,39 @@
+require "w3c_validators"
+module BBCMobileStandards
+  class HTMLValidator
+    
+    attr_reader :valid, :errors
+    
+    include W3CValidators
+    
+    def initialize(html)
+      @html = html
+      @errors = []
+      w3c_validate_html
+    end
+    
+    def valid?
+      self.valid
+    end
+    
+    protected
+    
+    def w3c_validate_html
+      results = validator.validate_text(@html)
+      unless results.errors.empty?
+        @errors = results.errors
+        @valid = false
+      else
+        @valid = true
+      end
+    end
+    
+    def validator
+      if BBCMobileStandards::Proxy.set?
+        MarkupValidator.new(:proxy_host => BBCMobileStandards::Proxy.host)
+      else
+        MarkupValidator.new
+      end
+    end
+  end
+end

data/lib/bbc_mobile_standards/proxy.rb

@@ -0,0 +1,31 @@
+module BBCMobileStandards
+  class Proxy
+    
+    @port = 80
+    @host = nil
+    
+    def self.port
+      @port
+    end
+    
+    def self.port=(number)
+      @port = number
+    end
+    
+    def self.host
+      @host
+    end
+    
+    def self.host=(host)
+      @host = host
+    end
+    
+    def self.set?
+      unless @host.nil?
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/bbc_mobile_standards/version.rb

@@ -0,0 +1,3 @@
+module BBCMobileStandards
+  VERSION = "0.0.1"
+end

data/lib/bbc_mobile_standards.rb

@@ -0,0 +1,65 @@
+require "bbc_mobile_standards/version"
+require "bbc_mobile_standards/proxy"
+require "bbc_mobile_standards/html_validator"
+require "bbc_mobile_standards/accessibility_validator"
+require "rest-client"
+require "raakt"
+
+module BBCMobileStandards
+  class << self
+    
+    attr_reader :html_errors, :accessibility_errors
+    
+    def new(url)
+      @html_errors = []
+      @accessibility_errors = []
+      @valid = true
+      @url = url
+      load_html
+      validate
+      self
+    end
+    
+    def valid?
+      @valid
+    end
+    
+    def generate_report(file_name)
+      
+    end
+    
+    protected
+    
+    def load_html
+      set_proxies
+      @html = RestClient.get(@url)
+    end
+    
+    def set_proxies
+      if BBCMobileStandards::Proxy.set?
+        RestClient.proxy = BBCMobileStandards::Proxy.host
+      end
+    end
+    
+    def validate
+      validate_html
+      validate_accessibility
+    end
+    
+    def validate_html
+      validator = BBCMobileStandards::HTMLValidator.new(@html)
+      unless validator.valid?
+        @valid = false
+        @html_errors << validator.errors
+      end
+    end
+    
+    def validate_accessibility
+      validator = BBCMobileStandards::HTMLValidator.new(@html)
+      unless validator.valid?
+        @valid = false
+        @accessibility_errors << validator.errors
+      end
+    end
+  end
+end

data/spec/bbc_mobile_standards/accessibility_validator_spec.rb

@@ -0,0 +1,178 @@
+require "spec_helper"
+
+describe BBCMobileStandards::AccessibilityValidator do
+  describe "validating invalid image tags" do
+    before(:each) do
+      @test_html = <<-EOF
+      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml">
+        <head>
+          <title>hello world</title>
+        </head>
+        <body>
+          <h1>My h1</h1>
+          <h2>My h2</h2>
+          <p>
+            <img src="width_and_height.jpg" width="14" height="14" alt="Image has width and height attributes" />
+            <img src="width.jpg" width="14" alt="Image ONLY has width attribute" />
+            <img src="height.jpg" height="14" alt="Image ONLY has height attribute" />
+          </p>
+        </body>
+      </html>
+      EOF
+      @validator = BBCMobileStandards::AccessibilityValidator.new(@test_html)
+    end
+
+    it "should add 2 errors" do
+      @validator.errors.size.should equal(2)
+    end
+  end
+  
+  describe "validating document structure" do
+    before(:each) do
+      @test_html = <<-EOF
+      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml">
+        <head>
+          <title>hello world</title>
+        </head>
+        <body>
+          <h2>My h2</h2>
+          <h1>My h1</h1>
+        </body>
+      </html>
+      EOF
+      @validator = BBCMobileStandards::AccessibilityValidator.new(@test_html)
+    end
+
+    it "should add 1 errors" do
+      @validator.errors.size.should equal(1)
+    end
+  end
+  
+  describe "validating page has 1 <h1> tag" do
+    before(:each) do
+      @test_html = <<-EOF
+      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml">
+        <head>
+          <title>hello world</title>
+        </head>
+        <body>
+        </body>
+      </html>
+      EOF
+      @validator = BBCMobileStandards::AccessibilityValidator.new(@test_html)
+    end
+
+    it "should add 1 errors" do
+      @validator.errors.size.should equal(1)
+    end
+  end
+  
+  describe "validating page no banned tags are used" do
+    before(:each) do
+      @test_html = <<-EOF
+      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml">
+        <head>
+          <title>hello world</title>
+        </head>
+        <body>
+          <h1>Horrid HTML</h1>
+          <p>
+            <big><b>Note:</b></big> <i>These tags should never ever be used</i>
+          </p>
+          <marquee>
+            <blink>
+              <s>I said never</s>
+              <tt><u>Never!</u></tt>
+            </blink>
+          </marquee>
+          <p>
+            <center><strike>Line through text</strike></center>
+          </p>
+          <p>
+            <font color="red">Or using Font tags</font>
+          </p>
+          <p>
+            <nobr>Also, don't break text</nobr>
+          </p>
+        </body>
+      </html>
+      EOF
+      @validator = BBCMobileStandards::AccessibilityValidator.new(@test_html)
+    end
+
+    it "should add 12 errors" do
+      @validator.errors.size.should equal(12)
+    end
+  end
+  
+  describe "validating forms, should use type" do
+    before(:each) do
+      @test_html = <<-EOF
+      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml">
+        <head>
+          <title>Form Test</title>
+        </head>
+        <body>
+          <h1>Form Test</h1>
+          <form action="">
+            <input type="text" name="some_input" id="some_input" title="Some Input"/>
+          </form>
+        </body>
+      </html>
+      EOF
+      @validator = BBCMobileStandards::AccessibilityValidator.new(@test_html)
+    end
+
+    it "should add 1 errors" do
+      @validator.errors.size.should equal(1)
+    end
+  end
+  
+  describe "#valid?" do
+    context "failed accessibility tests" do
+      before(:each) do
+        @test_html = <<-EOF
+        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+        <html xmlns="http://www.w3.org/1999/xhtml">
+          <head>
+            <title>hello world</title>
+          </head>
+          <body>
+          </body>
+        </html>
+        EOF
+        @validator = BBCMobileStandards::AccessibilityValidator.new(@test_html)
+      end
+
+      it "should add return false" do
+        @validator.valid?.should be_false
+      end
+    end
+  end
+  
+  context "passed accessibility tests" do
+    before(:each) do
+      @test_html = <<-EOF
+      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml">
+        <head>
+          <title>Test Page</title>
+        </head>
+        <body>
+          <h1>Test Page</h1>
+        </body>
+      </html>
+      EOF
+      @validator = BBCMobileStandards::AccessibilityValidator.new(@test_html)
+    end
+
+    it "should add return true" do
+      @validator.valid?.should be_true
+    end
+  end
+end

data/spec/bbc_mobile_standards/html_validator_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe BBCMobileStandards::HTMLValidator do
+  context "invalid HTML" do
+    before(:each) do
+      @test_html = <<-EOF
+        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+        <html xmlns="http://www.w3.org/1999/xhtml">
+          <head>
+            <title>Testing</title>
+          </head>
+          <body>
+            <p>
+              <p>
+                Hello
+              </p>
+            </p>
+          </body>
+        </html>
+      EOF
+    end
+    
+    it "should return false HTML is invalid" do
+      validation = BBCMobileStandards::HTMLValidator.new(@test_html)
+      validation.valid?.should be_false
+    end
+
+    it "should allow access to the html errors when invalid" do
+      validation = BBCMobileStandards::HTMLValidator.new(@test_html)
+      validation.errors.size.should == 1
+    end
+    
+  end
+  
+  context "valid HTML" do
+    before(:each) do
+      @test_html = <<-EOF
+        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+        <html xmlns="http://www.w3.org/1999/xhtml">
+          <head>
+            <title>Testing</title>
+          </head>
+          <body>
+            <p>
+              Hello
+            </p>
+          </body>
+        </html>
+      EOF
+    end
+    
+    it "should return true when HTML is valid" do
+      validation = BBCMobileStandards::HTMLValidator.new(@test_html)
+      validation.valid?.should be_true
+    end
+  end
+end

data/spec/bbc_mobile_standards/proxy_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe BBCMobileStandards::Proxy do
+  
+  before(:each) do
+    # Reset values to defaults
+    BBCMobileStandards::Proxy.port = 80
+    BBCMobileStandards::Proxy.host = nil
+  end
+  
+  describe "setting ports" do
+    it "should return 80 if no port is set" do
+      BBCMobileStandards::Proxy.port.should == 80
+    end
+
+    it "should return 443 if port is set to 443" do
+      BBCMobileStandards::Proxy.port = 443
+      BBCMobileStandards::Proxy.port.should == 443
+    end
+  end
+  
+  describe "setting host" do
+    it "should return nil if no host is set" do
+      BBCMobileStandards::Proxy.host.should == nil
+    end
+
+    it "should return 443 if port is set to 443" do
+      BBCMobileStandards::Proxy.host = "www.google.com"
+      BBCMobileStandards::Proxy.host.should == "www.google.com"
+    end
+  end
+  
+  describe "#set?" do
+    
+    it "should return false if host is nil" do
+      BBCMobileStandards::Proxy.set?.should be_false
+    end
+    
+    it "should return true if host is set" do
+      BBCMobileStandards::Proxy.host = "www.google.co.uk"
+      BBCMobileStandards::Proxy.set?.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift "#{dir}/../lib"
+ 
+require 'rubygems'
+require 'rspec'
+require 'fakeweb'
+require 'bbc_mobile_standards'

data/spec/validator_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+
+describe BBCMobileStandards do
+  
+  let(:set_proxy) { BBCMobileStandards::Proxy.host = "www-cache.reith.bbc.co.uk" }
+  
+  describe "invalid html" do
+    
+    before(:each) do
+      set_proxy
+      @test_html = <<-EOF
+        <html xmlns="http://www.w3.org/1999/xhtml">
+          <head>
+          </head>
+          <body>
+            <p>
+              <p>
+                Hello
+              </p>
+            </p>
+          </body>
+        </html>
+      EOF
+      FakeWeb.register_uri(:get, "http://www.bbc.co.uk/news/mobile/", :body => @test_html)
+    end
+    
+    it "should return errors if html is not valid" do
+      results = BBCMobileStandards.new("http://www.bbc.co.uk/news/mobile/")
+      results.valid?.should be_false
+      results.html_errors.size.should equal(1)
+    end
+  end
+  
+  describe "valid html" do  
+    
+    before(:each) do
+      set_proxy
+      @test_html = <<-EOF
+        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+        <html xmlns="http://www.w3.org/1999/xhtml">
+          <head>
+            <title>Testing</title>
+          </head>
+          <body>
+            <p>
+              Hello
+            </p>
+          </body>
+        </html>
+      EOF
+      FakeWeb.register_uri(:get, "http://www.bbc.co.uk/news/mobile/", :body => @test_html)
+    end
+    
+    it "should return true" do
+      results = BBCMobileStandards.new("http://www.bbc.co.uk/news/mobile/")
+      results.valid?.should be_true
+    end
+  end
+  
+  describe "return accessibility errors" do
+    before(:each) do
+      set_proxy
+      @test_html = <<-EOF
+        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+        <html xmlns="http://www.w3.org/1999/xhtml">
+          <head>
+          </head>
+          <body>
+            <h1>Testing</h1>
+            <p>Hello</p>
+          </body>
+        </html>
+      EOF
+      FakeWeb.register_uri(:get, "http://www.bbc.co.uk/news/mobile/", :body => @test_html)
+    end
+    
+    it "should return true" do
+      results = BBCMobileStandards.new("http://www.bbc.co.uk/news/mobile/")
+      results.accessibility_errors.size.should equal(1)
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: bbc_mobile_standards
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Crouch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: raakt
+  requirement: &2151815580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151815580
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2151814920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151814920
+- !ruby/object:Gem::Dependency
+  name: w3c_validators
+  requirement: &2151813800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151813800
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &2151813100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151813100
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2151812260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151812260
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2151811300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151811300
+description: ! 'Validates HTML and accessibility. Follows FM&T Standards: http://www.bbc.co.uk/guidelines/futuremedia/technical/semantic_markup.shtml'
+email:
+- matthew.crouch@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- bbc_mobile_standards.gemspec
+- lib/bbc_mobile_standards.rb
+- lib/bbc_mobile_standards/accessibility_validator.rb
+- lib/bbc_mobile_standards/html_validator.rb
+- lib/bbc_mobile_standards/proxy.rb
+- lib/bbc_mobile_standards/version.rb
+- spec/bbc_mobile_standards/accessibility_validator_spec.rb
+- spec/bbc_mobile_standards/html_validator_spec.rb
+- spec/bbc_mobile_standards/proxy_spec.rb
+- spec/spec_helper.rb
+- spec/validator_spec.rb
+homepage: http://www.bbc.co.uk/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: bbc_mobile_standards
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: BBC Mobile Standards validator
+test_files:
+- spec/bbc_mobile_standards/accessibility_validator_spec.rb
+- spec/bbc_mobile_standards/html_validator_spec.rb
+- spec/bbc_mobile_standards/proxy_spec.rb
+- spec/spec_helper.rb
+- spec/validator_spec.rb