w3clove 0.3.0 → 0.3.1

data/README.rdoc

@@ -12,9 +12,9 @@ w3clove is a Ruby gem that can be installed on the usual way
 
 = Usage:
 
-Pass it the url of an XML sitemap to be checked, like:
+Pass it the url of an XML sitemap to be checked, and the filename where you want your report to be generated, like:
 
-  w3clove https://github.com/jaimeiniesta/w3clove/raw/master/spec/samples/sitemap.xml
+  w3clove https://github.com/jaimeiniesta/w3clove/raw/master/spec/samples/sitemap.xml report.html
 
 This will validate all the URLs of your sitemap.xml (so be sure to pass it a short one or you'll wait for ages), and generate an HTML file with the full report.
 

data/bin/w3clove

@@ -4,8 +4,11 @@
 require_relative '../lib/w3clove'
 
 begin
-  W3Clove::Validator.check(ARGV[0])
+  if ARGV.length == 2
+    W3Clove::Validator.check(ARGV[0], ARGV[1])
+  else
+    puts "USAGE: w3clove url_of_xml_sitemap output_file.html"
+  end
 rescue
   puts "There was an error processing your request"
-  puts "USAGE: w3clove url_of_xml_sitemap"
 end

data/lib/w3clove/message.rb

@@ -4,12 +4,7 @@ module W3Clove
   ##
   # A message holds a message_id, a line, a text and a type
   #
-  # message_id... corresponds to the W3C messages list from
-  #               http://validator.w3.org/docs/errors.html
-  # line......... line number where the error was detected
-  #               on the page that created it
-  # text......... generic but descriptive text about the error
-  # type......... can be :error or :warning
-  #
+  # See the W3C message explanation list on
+  # http://validator.w3.org/docs/errors.html
   Message = Struct.new(:message_id, :line, :text, :type)
 end

data/lib/w3clove/page.rb

@@ -31,11 +31,9 @@ module W3Clove
     # If it has no validation errors, it will be an empty array.
     # It an exception occurs, it will be nil.
     def errors
-      @errors ||= validations.errors.map {|e|
-                                          W3Clove::Message.new(e.message_id,
-                                                               e.line,
-                                                               e.message,
-                                                               :error)}
+      @errors ||= validations.errors.map do |e|
+        W3Clove::Message.new(e.message_id, e.line, e.message, :error)
+      end
     rescue Exception => e
       @exception = e.to_s
       nil
@@ -46,11 +44,9 @@ module W3Clove
     # If it has no validation warnings, it will be an empty array.
     # It an exception occurs, it will be nil.
     def warnings
-      @warnings ||= validations.warnings.map {|w|
-                                              W3Clove::Message.new(w.message_id,
-                                                                   w.line,
-                                                                   w.message,
-                                                                   :warning)}
+      @warnings ||= validations.warnings.map do |w|
+        W3Clove::Message.new(w.message_id, w.line, w.message, :warning)
+      end
     rescue Exception => e
       @exception = e.to_s
       nil

data/lib/w3clove/reporter.rb

@@ -8,14 +8,14 @@ module W3Clove
 
     ##
     # Create the html report for the sitemap
-    def generate_html(sitemap)
+    def generate_html(sitemap, filename)
       template = ERB.new(open(File.dirname(__FILE__)+'/templates/w3clove.html.erb').read)
 
-      File.open('w3clove.html', 'w') do |f|
-                                       f.write(template.result(sitemap.get_binding))
-                                     end
+      File.open(filename, 'w') do |f|
+        f.write(template.result(sitemap.get_binding))
+      end
     rescue Exception => e
       puts "ERROR generating report: #{e}"
     end
   end
-end
+end

data/lib/w3clove/validator.rb

@@ -14,8 +14,8 @@ module W3Clove
     # Parses a remote xml sitemap and checks markup validation for each url
     # Shows progress on dot-style (...F...FFE..). A dot is a valid page,
     # an F is a page with errors, and an E is an exception
-    # After the checking is done, a detailed summary is generated
-    def check(url)
+    # After the checking is done, a detailed summary is written to filename
+    def check(url, filename)
       sitemap = W3Clove::Sitemap.new(url)
       say "Validating #{sitemap.pages.length} pages"
 
@@ -23,8 +23,8 @@ module W3Clove
         say_inline page.valid? ? "." : (page.errors.nil? ? 'E' : 'F')
       end
 
-      W3Clove::Reporter.generate_html(sitemap)
-      say "\nValidation finished, see the report at w3clove.html"
+      W3Clove::Reporter.generate_html(sitemap, filename)
+      say "\nValidation finished, see the report at #{filename}"
     end
 
     private

data/lib/w3clove/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module W3Clove
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/w3clove.rb

@@ -1,9 +1,7 @@
 # -*- encoding: utf-8 -*-
 
-module W3Clove
-  require_relative './w3clove/validator'
-  require_relative './w3clove/sitemap'
-  require_relative './w3clove/page'
-  require_relative './w3clove/message'
-  require_relative './w3clove/reporter'
-end
+require_relative 'w3clove/validator'
+require_relative 'w3clove/sitemap'
+require_relative 'w3clove/page'
+require_relative 'w3clove/message'
+require_relative 'w3clove/reporter'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Jaime Iniesta
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-23 00:00:00 +01:00
+date: 2011-03-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency