html_validation 0.5.0 → 0.5.5

data/Gemfile

@@ -6,19 +6,20 @@ gemspec
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rspec"
-  gem "bundler"  
+  gem "bundler"
 end
 
 gem 'rdoc'
 gem 'thor'
 gem 'open3'
 
-# Unix Rubies (OSX, Linux)  
+# Unix Rubies (OSX, Linux)
 platform :ruby do
-  
+
 end
 
-# Windows Rubies (RubyInstaller)  
+# Windows Rubies (RubyInstaller)
 platforms :mswin, :mingw do
-  
-end
+
+end
+

data/README.rdoc

@@ -15,16 +15,13 @@ barring that, review and accept any errors and warnings.
 
 The current (as of March 2013) default version of Tidy doesn't support HTML 5.
 To get HTML 5 support, install this fork of tidy:  https://github.com/w3c/tidy-html5
-Download the repo as a zip file and extract somewhere, then follow the instructions
-given on the page (using sudo for make commands if on Linux).
 
 Be sure to get rid of the old tidy first if you have it already.
 
-Redhat/Fedora:    sudo yum erase tidy
-
-Ubuntu:           sudo apt-get remove tidy
+Debian flavors: sudo apt-get remove tidy
 
-OS X:             sudo port uninstall tidy
+Download the repo as a zip file and extract somewhere, then follow the instructions
+given on the page (using sudo for make commands if on Linux).
 
 On linux/OS X machines, confirm the right installation path using:  which tidy
 
@@ -44,12 +41,12 @@ On linux/OS X machines, confirm the right installation path using:  which tidy
     HaveValidHTML.show_html_in_failures = true
 
 
-    # All tidy flags, including using a config file can be passed.
+    All tidy flags, including using a config file can be passed.
 
-    # A shortcut to disable Tidy Warning messages (they are on by default)
-    # has been created for your convenience. However, some things that might be
-    # called "errors" show up as warnings, so the recommended approach is
-    # run, then accept the errors / warnings that are noted.
+    A shortcut to disable Tidy Warning messages (they are on by default)
+    has been created for your convenience. However, some things that might be
+    called "errors" show up as warnings, so the recommended approach is
+    run, then accept the errors / warnings that are noted.
     HTMLValidation.show_warnings = false
 
 

data/bin/validation

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
- 
+
 require 'rubygems'
 require 'thor'
 require 'html_validation'
@@ -8,18 +8,18 @@ require 'html_validation'
 class Validation < Thor
   include PageValidations
   desc "review", "Review and Accept (or fix and rerun) HTML Validation errors"
-  
+
   method_option :data_path, :aliases => "-d", :desc => "Optional custom data path (if not default of /spec/.validate)"
   def review
-    data_path = options[:data_path] || File.join(Dir.getwd, 'spec', '.validation')
+    data_path = options[:data_path] || File.join(Dir.getwd, '.validation')
     $stdout.puts "Reviewing validation results in: #{data_path}"
-  
+
     HTMLValidation.new(data_path).each_exception do |result|
-      $stdout.puts "Validation exceptions for: #{result.resource}:\n#{result.exceptions}" 
+      $stdout.puts "Validation exceptions for: #{result.resource}:\n#{result.exceptions}"
       $stdout.puts "Accept (y)es (n)o or (q)uit"
       sin = $stdin.gets
       if sin[0].downcase == 'y'
-        result.accept! 
+        result.accept!
         $stdout.puts "Accepted!"
       else
         $stdout.puts "Rejected!"

data/lib/html_validation/page_validations.rb

@@ -1,5 +1,22 @@
+require File.expand_path(File.join(File.dirname(__FILE__),  'have_valid_html'))
+
 module PageValidations
-  # Namespace planned for future additional validations
+  # Namespace planned for future additional validations and master wrapper gem
+
+  @@data_path = nil
+
+  def self.included(base)
+    # get path of including file to set a default path to save results
+    @@data_path = File.expand_path(File.dirname(caller[0].partition(":")[0]))
+  end
+
+  def self.data_path
+    @@data_path
+  end
+
+  def self.data_path=(path)
+    @@data_path = path
+  end
 
 
   class HTMLValidation
@@ -80,7 +97,7 @@ module PageValidations
     def default_result_file_path
       posix      = RbConfig::CONFIG['host_os'] =~ /(darwin|linux)/
       rootpath   = Rails.root if defined?(Rails)
-      rootpath ||= HTMLValidationMatcher.data_path if HTMLValidationMatcher.data_path
+      rootpath ||= ::PageValidations.data_path if ::PageValidations.data_path
       rootpath ||= posix ? '/tmp/' : "c:\\tmp\\"
       File.join(rootpath, '.validation')
     end

data/lib/html_validation/version.rb

@@ -1,3 +1,3 @@
 module PageValidations
-  HTML_VALIDATOR_VERSION = "0.5.0"
+  HTML_VALIDATOR_VERSION = "0.5.5"
 end

data/lib/html_validation.rb

@@ -1,4 +1,3 @@
 require 'rbconfig'
 require File.expand_path(File.join(File.dirname(__FILE__),  'html_validation/page_validations'))
-require File.expand_path(File.join(File.dirname(__FILE__),  'html_validation/html_validation_result'))
-require File.expand_path(File.join(File.dirname(__FILE__),  'html_validation/html_validation_matcher'))
+require File.expand_path(File.join(File.dirname(__FILE__),  'html_validation/html_validation_result'))

data/spec/helpers/html_validation_helpers.rb

@@ -20,4 +20,4 @@ module HTMLValidationHelpers
     html_5_doctype + '<html><title proprietary="1">h</title></head><body><p>a para</p></body></html>'
   end
 
-end
+end

data/spec/html_validation_spec.rb

@@ -73,20 +73,20 @@ describe "HTMLValidation" do
   end
 
   it "should work without a data path being manually set" do
-     h = HTMLValidation.new()
-     result = h.validation(good_html, "http://mybestsite.com")
-     result.exceptions.should be_empty
+    h = HTMLValidation.new()
+    result = h.validation(good_html, "http://mybestsite.com")
+    result.exceptions.should be_empty
   end
 
   it "should not show (should ignore) warnings when they are turned off" do
-     HTMLValidation.show_warnings = false
-     h = HTMLValidation.new()
-     result = h.validation(warning_html, "http://mywarningsite.com")
-     result.exceptions.should be_empty
-     HTMLValidation.show_warnings = true
-     h = HTMLValidation.new()
-     result = h.validation(warning_html, "http://myotherwarningsite.com")
-     result.exceptions.should_not be_empty
+    HTMLValidation.show_warnings = false
+    h = HTMLValidation.new()
+    result = h.validation(warning_html, "http://mywarningsite.com")
+    result.exceptions.should be_empty
+    HTMLValidation.show_warnings = true
+    h = HTMLValidation.new()
+    result = h.validation(warning_html, "http://myotherwarningsite.com")
+    result.exceptions.should_not be_empty
   end
 
 
@@ -111,10 +111,10 @@ describe "HTMLValidation" do
       had_exceptions = false
       @h.each_exception do |e|
         had_exceptions = true
-          e.is_a?(HTMLValidationResult).should be_true
-          (e.resource.length > 0).should be_true
-          (e.html.length > 0).should be_true
-        end
+        e.is_a?(HTMLValidationResult).should be_true
+        (e.resource.length > 0).should be_true
+        (e.html.length > 0).should be_true
+      end
       had_exceptions.should be_true
     end
 
@@ -135,4 +135,4 @@ describe "HTMLValidation" do
     Dir.glob('*').each {|f| FileUtils.rm f }
   end
 
-end
+end

data/spec/spec_helper.rb

@@ -3,34 +3,14 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'html_validation'
 
-include PageValidations
-
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/helpers/**/*.rb"].each {|f| require f }
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f }
-
-RSpec.configure do |config|
-
 
-end
-
-  def bad_html
-    '<html><title>the title<title></head><body><p>blah blah</body></html>'
-  end
-
-  def good_html
-    html_5_doctype + '<html><title>the title</title></head><body><p>a paragraph</p></body></html>'
-  end
+include PageValidations
+include HTMLValidationHelpers
 
-  def dtd
-    '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
-  end
+RSpec.configure do |config|
 
-  def html_5_doctype
-    '<!DOCTYPE html>'
-  end
 
-  def warning_html
-    html_5_doctype + '<html><title proprietary="1">h</title></head><body><p>a para</p></body></html>'
-  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html_validation
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.5
   prerelease: 
 platform: ruby
 authors:
@@ -32,7 +32,6 @@ files:
 - html_validation.gemspec
 - lib/html_validation.rb
 - lib/html_validation/have_valid_html.rb
-- lib/html_validation/html_validation_matcher.rb
 - lib/html_validation/html_validation_result.rb
 - lib/html_validation/page_validations.rb
 - lib/html_validation/version.rb

data/lib/html_validation/html_validation_matcher.rb

@@ -1,21 +0,0 @@
-# the item to include to get the RSPec matcher(s)
-
-require File.expand_path(File.join(File.dirname(__FILE__),  'have_valid_html'))
-
-module HTMLValidationMatcher
-  @@data_path = nil  
-  
-  def self.included(base)
-    # get path of including file, which should be in the /spec folder
-    @@data_path, = File.expand_path(File.dirname(caller[0].partition(":")[0]))      
-  end
-
-  def self.data_path
-    @@data_path
-  end    
-  
-  def self.data_path=(path)
-    @@data_path = path
-  end
-  
-end