be_valid_asset 1.1.1

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Unboxed Consulting
+
+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 PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL 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.markdown

@@ -0,0 +1,158 @@
+be\_valid\_asset
+==============
+
+Provides `be_valid_xhtml`, `be_valid_css` and `be_valid_feed` matchers for rspec controller and view tests.
+
+Installation
+------------
+
+To use be\_valid\_asset in your project, install the gem:
+
+    gem install unboxed-be_valid_asset -s http://gems.github.com
+
+or as a plugin
+
+    ./script/plugin install git://github.com/unboxed/be_valid_asset.git
+
+Add the following to the `spec/support/be_valid_asset.rb`:
+(for older version of RSpec you'll need to require it from `spec_helper.rb`)
+
+    include BeValidAsset
+    
+    # BeValidAsset::Configuration.display_invalid_content = true
+    BeValidAsset::Configuration.enable_caching = true
+    BeValidAsset::Configuration.cache_path = File.join(RAILS_ROOT, %w(tmp be_valid_asset_cache))
+
+See below for details of the configuration options available
+
+Usage
+-----
+
+### (X)HTML validation
+
+It can be used to test either an ActionController Response object as follows:
+
+    describe FooController do
+      integrate_views
+
+      describe "GET 'index'" do
+        it "should have valid markup" do
+          get 'index'
+          response.should be_valid_xhtml
+        end
+      end
+    end
+
+or
+
+    describe "/index.html" do
+      it "should be valid XHTML" do
+        render 'home/index', :layout => true
+        response.should be_valid_xhtml
+      end
+    end
+
+or to test a string:
+
+    it "should be valid xhtml" do
+      html = File.read(File.join(RAILS_ROOT, %w(public index.html)))
+      html.should be_valid_xhtml
+    end
+
+It is also possible to validate an xhtml fragment.  This assumes xhtml-1.0 strict.
+
+    it "should be valid xhtml" do
+      string = "<p>This is an html fragment</p>"
+      string.should be_valid_xhtml_fragment
+    end
+
+### CSS validation
+
+CSS files can be validated as follows:
+
+    it "should be valid CSS" do
+      css = File.read(File.join(RAILS_ROOT, %w(public stylesheets main.css)))
+      css.should be_valid_css
+    end
+
+be\_valid\_css takes an optional parameter specifying the css profile to test against. It defaults to testing against CSS 2.1. It can be set to any of the profiles supported by the CSS validator (e.g. css1, css2, css21, css3). There are also the following shortcut methods:
+
+ * `be_valid_css1` => CSS 1.0
+ * `be_valid_css2` => CSS 2.1
+ * `be_valid_css3` => CSS 3.0
+
+### Feed validation
+
+RSS and Atom feeds can be validated from a response, or a string, in the same way as for xhtml or CSS.  e.g.
+
+    describe FooController do
+      integrate_views
+
+      describe "GET 'index.rss'" do
+        it "should be valid" do
+          get 'index.rss'
+          response.should be_valid_feed
+        end
+      end
+    end
+
+There are also aliased methods `be_valid_rss` and `be_valid_atom` that do the same thing.
+
+Environment Variables
+---------------------
+
+### Disabling network tests
+
+If the environment variable `NONET` is set to true, then all tests with no cached response available will be marked as pending.
+
+### http_proxy
+
+If you need to use a proxy server to access the validator service, set the environment variable http_proxy.
+
+Configuration
+-------------
+
+The following can be set in `spec/support/be_valid_asset.rb`:
+
+### Display Full source for failures:
+
+    BeValidAsset::Configuration.display_invalid_content = false (default)
+
+### Display surrounding source for failures:
+
+This will cause it to output the failing line, and n surrounding lines (defaults to 5)
+
+    BeValidAsset::Configuration.display_invalid_lines = false (default)
+    BeValidAsset::Configuration.display_invalid_lines_count = 5 (default)
+
+### Change validator host/path:
+
+    BeValidAsset::Configuration.markup_validator_host = 'validator.w3.org'
+    BeValidAsset::Configuration.markup_validator_path = '/check'
+    BeValidAsset::Configuration.css_validator_host = 'jigsaw.w3.org'
+    BeValidAsset::Configuration.css_validator_path = '/css-validator/validator'
+    BeValidAsset::Configuration.feed_validator_host = 'validator.w3.org'
+    BeValidAsset::Configuration.feed_validator_path = '/feed/check.cgi'
+
+If you are doing more than the occasional check, you should probably run your own copy of the validator, and use that.
+Instructions here: [http://validator.w3.org/docs/install.html](http://validator.w3.org/docs/install.html),  [http://jigsaw.w3.org/css-validator/DOWNLOAD.html](http://jigsaw.w3.org/css-validator/DOWNLOAD.html) or [http://validator.w3.org/feed/about.html#where](http://validator.w3.org/feed/about.html#where)
+
+### Caching
+
+be\_valid\_asset can cache the responses from the validator to save look-ups for documents that haven't changed.
+To use this feature, it must be enabled, and a cache path must be set:
+
+    BeValidAsset::Configuration.enable_caching = true
+    BeValidAsset::Configuration.cache_path = File.join(RAILS_ROOT, %w(tmp be_valid_asset_cache))
+
+Issues / Feature Requests
+-------------------------
+
+Please use the [github issue tracker](http://github.com/unboxed/be_valid_asset/issues) to track any bugs/feature requests.
+
+Licensing etc.
+--------------
+
+This was originally based on a blog post here: [http://www.anodyne.ca/2007/09/28/rspec-custom-matchers-and-be\_valid\_xhtml/](http://www.anodyne.ca/2007/09/28/rspec-custom-matchers-and-be_valid_xhtml/)
+
+This is distributed under the MIT Licence, see `MIT-LICENSE.txt` for the details.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake'
+# require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+task :default => :spec
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', File.join(File.dirname(__FILE__), %w(spec spec.opts))]
+end
+
+# desc 'Generate documentation for the be_valid_asset plugin.'
+# Rake::RDocTask.new(:rdoc) do |rdoc|
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title    = 'BeValidAsset'
+#   rdoc.options << '--line-numbers' << '--inline-source'
+#   rdoc.rdoc_files.include('README')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/lib/be_valid_asset.rb

@@ -0,0 +1,33 @@
+module BeValidAsset
+  class Configuration
+    @@config = {
+      :display_invalid_content      => false,
+      :enable_caching               => false,
+      :display_invalid_lines        => false,
+      :display_invalid_lines_count  => 5
+    }
+
+    def self.method_missing(name, *args)
+      if name.to_s =~ /^(.*)=$/
+        @@config[$1.to_sym] = args[0]
+      elsif @@config.has_key?(name)
+        return @@config[name]
+      else
+        super
+      end
+    end
+
+    def self.cache_path=(path)
+      @@config[:cache_path] = path
+      unless File.directory? path
+        FileUtils.mkdir_p path
+      end
+
+    end
+  end
+end
+
+require 'be_valid_asset/be_valid_base'
+require 'be_valid_asset/be_valid_xhtml'
+require 'be_valid_asset/be_valid_css'
+require 'be_valid_asset/be_valid_feed'

data/lib/be_valid_asset/be_valid_base.rb

@@ -0,0 +1,98 @@
+
+module BeValidAsset
+
+  # Abstract base class for other matchers
+  class BeValidBase
+
+    private
+
+      def check_net_enabled
+        if ENV["NONET"] == 'true'
+          raise Spec::Example::ExamplePendingError.new('Network tests disabled')
+        end
+      end
+
+      def validate(query_params)
+        query_params.merge!( {:output => 'soap12' } )
+        response = get_validator_response(query_params)
+
+        markup_is_valid = response_indicates_valid?(response)
+        @message = ''
+        unless markup_is_valid
+          process_errors(query_params, response)
+        end
+        return markup_is_valid
+      end
+
+      def response_indicates_valid?(response)
+        response['x-w3c-validator-status'] == 'Valid'
+      end
+
+      def process_errors(query_params, response)
+        fragment = query_params[:fragment] || query_params[:text]
+        if Configuration.display_invalid_content || Configuration.display_invalid_lines
+          lines = fragment.split($/)
+        end
+        lines.each_with_index{|line, index| @message << "#{'%04i' % (index+1)} : #{line}#{$/}"} if Configuration.display_invalid_content
+        REXML::Document.new(response.body).root.each_element('//m:error') do |e|
+          @message << "#{error_line_prefix}: line #{e.elements['m:line'].text}: #{e.elements['m:message'].get_text.value.strip}\n"
+          if Configuration.display_invalid_lines
+            line_no = e.elements['m:line'].text.to_i
+            start_line = [line_no - (Configuration.display_invalid_lines_count / 2), 1].max
+            end_line = [line_no + (Configuration.display_invalid_lines_count / 2), lines.length].min
+            for i in start_line..end_line
+              @message << "#{'%04i' % i}#{ i == line_no ? '>>' : '  ' }: #{ lines[i - 1] }#{ $/ }"
+            end
+            @message << "------\n"
+          end
+        end
+      end
+
+      def get_validator_response(query_params = {})
+        if Configuration.enable_caching
+          digest = Digest::MD5.hexdigest(query_params.to_a.sort {|a,b| a[0].to_s<=>b[0].to_s}.join)
+          cache_filename = File.join(Configuration.cache_path, digest)
+          if File.exist? cache_filename
+            response = File.open(cache_filename) {|f| Marshal.load(f) }
+          else
+            response = call_validator( query_params )
+            File.open(cache_filename, 'w') {|f| Marshal.dump(response, f) } if response.is_a? Net::HTTPSuccess
+          end
+        else
+          response = call_validator( query_params )
+        end
+        raise "HTTP error: #{response.code}" unless response.is_a? Net::HTTPSuccess
+        return response
+      end
+
+      def call_validator(query_params)
+        check_net_enabled
+        boundary = Digest::MD5.hexdigest(Time.now.to_s)
+        data = encode_multipart_params(boundary, query_params)
+        return http_start(validator_host).post2(validator_path, data, "Content-type" => "multipart/form-data; boundary=#{boundary}" )
+      end
+
+      def encode_multipart_params(boundary, params = {})
+        ret = ''
+        params.each do |k,v|
+          unless v.empty?
+            ret << "\r\n--#{boundary}\r\n"
+            ret << "Content-Disposition: form-data; name=\"#{k.to_s}\"\r\n\r\n"
+            ret << v
+          end
+        end
+        ret << "\r\n--#{boundary}--\r\n"
+        ret
+      end
+      
+      def http_start(host)
+        if ENV['http_proxy']
+          uri = URI.parse(ENV['http_proxy'])
+          proxy_user, proxy_pass = uri.userinfo.split(/:/) if uri.userinfo
+          Net::HTTP.start(host, nil, uri.host, uri.port, proxy_user, proxy_pass)
+        else
+          Net::HTTP.start(host)
+        end
+      end
+  end
+end

data/lib/be_valid_asset/be_valid_css.rb

@@ -0,0 +1,70 @@
+require 'net/http'
+
+module BeValidAsset
+
+  Configuration.css_validator_host = 'jigsaw.w3.org'
+  Configuration.css_validator_path = '/css-validator/validator'
+
+  class BeValidCss < BeValidBase
+  
+    def initialize(profile)
+      @profile = profile
+    end
+  
+    def matches?(fragment)
+
+      if fragment.respond_to? :body
+        fragment = fragment.body.to_s
+      end
+
+      # The validator return a 500 Error if it's sent empty string
+      fragment = ' ' if fragment.empty?
+
+      query_params = { :text => fragment, :profile => @profile }
+      return validate(query_params)
+    end
+  
+    def description
+      "be valid css"
+    end
+  
+    def failure_message
+     " expected css to be valid, but validation produced these errors:\n#{@message}"
+    end
+  
+    def negative_failure_message
+      " expected to not be valid, but was (missing validation?)"
+    end
+  
+    private
+
+      def validator_host
+        Configuration.css_validator_host
+      end
+
+      def validator_path
+        Configuration.css_validator_path
+      end
+
+      def error_line_prefix
+        'Invalid css'
+      end
+
+  end
+  
+  def be_valid_css(profile = 'css21')
+    BeValidCss.new(profile)
+  end
+
+  def be_valid_css1
+    be_valid_css 'css1'
+  end
+
+  def be_valid_css2
+    be_valid_css 'css21'
+  end
+
+  def be_valid_css3
+    be_valid_css 'css3'
+  end
+end

data/lib/be_valid_asset/be_valid_feed.rb

@@ -0,0 +1,77 @@
+require 'net/http'
+
+module BeValidAsset
+
+  Configuration.feed_validator_host = 'validator.w3.org'
+  Configuration.feed_validator_path = '/feed/check.cgi'
+
+  class BeValidFeed < BeValidBase
+
+    def initialize()
+    end
+
+    def matches?(fragment)
+
+      if fragment.respond_to? :body
+        fragment = fragment.body.to_s
+      end
+
+      query_params = { :rawdata => fragment, :manual => '1' }
+      return validate(query_params)
+    end
+
+    def description
+      "be valid feed (RSS / Atom)"
+    end
+
+    def failure_message
+     " expected feed to be valid, but validation produced these errors:\n#{@message}"
+    end
+
+    def negative_failure_message
+      " expected to not be valid, but was (missing validation?)"
+    end
+
+    private
+
+    # The feed service takes params differently.
+    def call_validator(query_params)
+      check_net_enabled
+      params = "rawdata=#{CGI.escape(query_params[:rawdata])}&manual=1&output=soap12"
+      return http_start(validator_host).post(validator_path, params, {} )
+    end
+
+    # The feed validator uses a different response type, so we have to override these here.
+    def response_indicates_valid?(response)
+      REXML::Document.new(response.body).root.get_elements('//m:validity').first.text == 'true'
+    end
+
+    def process_errors(query_params, response)
+      fragment = query_params[:rawdata]
+      fragment.split($/).each_with_index{|line, index| @message << "#{'%04i' % (index+1)} : #{line}#{$/}"} if Configuration.display_invalid_content
+      REXML::Document.new(response.body).root.each_element('//error') do |e|
+        @message << "#{error_line_prefix}: line #{e.elements['line'].text}: #{e.elements['text'].text}\n"
+      end
+    end
+
+    def validator_host
+      Configuration.feed_validator_host
+    end
+
+    def validator_path
+      Configuration.feed_validator_path
+    end
+
+    def error_line_prefix
+      'Invalid feed'
+    end
+
+  end
+
+  def be_valid_feed()
+    BeValidFeed.new()
+  end
+  alias :be_valid_rss  :be_valid_feed
+  alias :be_valid_atom :be_valid_feed
+
+end