bbc_standards 0.1.0

data/README

@@ -0,0 +1,16 @@
+= bbc_standards
+
+* http://github.com/metade/bbc_standards
+
+== DESCRIPTION:
+
+BBCStandards provides rspec helpers for checking whether documents conform to the BBC FM&T Guidelines and Standards.
+
+See http://www.bbc.co.uk/guidelines/futuremedia/technical/ for more details.
+
+== SYNOPSIS:
+
+== REQUIREMENTS:
+
+* depends on markup_validity and raakt
+

data/lib/bbc_standards.rb

@@ -0,0 +1,9 @@
+require 'markup_validity'
+require 'raakt'
+
+require 'bbc_standards/validator'
+require 'bbc_standards/rspec'
+
+module BBCStandards
+  VERSION = '0.1.0'
+end

data/lib/bbc_standards/rspec.rb

@@ -0,0 +1,17 @@
+module Spec
+  module Matchers
+    def obey_bbc_standards
+      Matcher.new :obey_bbc_standards do
+        validator = nil
+        match do |xhtml|
+          validator = BBCStandards::Validator.new xhtml
+          validator.valid?
+        end
+
+        failure_message_for_should do |actual|
+          validator.inspect
+        end
+      end
+    end
+  end
+end

data/lib/bbc_standards/validator.rb

@@ -0,0 +1,75 @@
+module BBCStandards
+  class Validator
+    include Spec::Matchers
+    
+    attr_reader :errors
+    
+    def initialize(xml)
+      @xml = xml
+      @doc = Nokogiri::HTML(xml)
+      @errors = []
+      validate
+    end
+    
+    def valid?
+      @errors.empty?
+    end
+    
+    def inspect
+      lines = @xml.split("\n")
+      strings = []
+      errors.each do |error|
+        if error.line
+          start = error.line - [2, error.line].min
+          error_line = error.line == 0 ? 1 : error.line
+          strings << "Error on line: #{error_line}:"
+          strings << error.message.gsub(/\{[^\}]*\}/, '')
+          Range.new(start, error.line + 2).each { |number|
+            strings << "#{number + 1}: #{lines[number]}"
+          }
+          strings << ""
+        else
+          strings << error.message
+        end
+      end
+      strings.join("\n")
+    end
+    
+    protected
+    
+    def validate
+      test_validation
+      test_accessibility
+      test_bbc_standards
+    end
+
+    def test_validation
+      validator = MarkupValidity::Validator.new(@xml, MarkupValidity::Validator::XHTML1_STRICT)
+      @errors += validator.errors
+    end
+    
+    def test_accessibility
+      rt = Raakt::Test.new(@xml)
+      @errors += rt.all.map { |e| Error.new(e.text) }
+    end
+    
+    def test_bbc_standards
+      @errors << Error.new("Title is not valid") unless @xml =~ /<title>\w+( - )?([^<-]+)?( - )?([^<-]+)?<\/title>/
+      @errors << Error.new("Page doesn't have 1 <h1> tag") unless @doc.xpath('//h1').size == 1
+      @errors << Error.new("Page doesn't have any <h2> tags") unless @doc.xpath('//h2').size > 0
+      @errors << Error.new("Page is using <br> for whitespace") if @xml =~ /<br\/>\s*<br\/>/
+      %w(b i font marquee).each do |tag|
+        @errors << Error.new("Page is using <#{tag}>") if @doc.xpath("//#{tag}").any?
+      end
+    end
+  end
+  
+  class Error
+    attr_accessor :message, :line
+    
+    def initialize(message, line=nil)
+      @message = message
+      @line = line
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: bbc_standards
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Patrick Sinclair
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-23 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: metade@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- lib/bbc_standards/rspec.rb
+- lib/bbc_standards/validator.rb
+- lib/bbc_standards.rb
+has_rdoc: true
+homepage: http://github.com/metade/bbc_standards
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: What this thing does
+test_files: []
+