DylanFM-pleasevalidate 0.0.2 → 0.0.3

data/History.txt

@@ -8,4 +8,9 @@
 * 1 major enhancement:
 	* Multiple files validated
 * 1 minor enhancement:
-	* Mime type checked to only allow html files to be validated
+	* Mime type checked to only allow html files to be validated
+	
+== 0.0.3 2009-16-09
+
+* 1 major enhancement:
+	* Directories can be passed as arguments and recursively scanned for HTML files for validation

data/Manifest.txt

@@ -8,13 +8,16 @@ bin/pleasevalidate
 cucumber.yml
 features/cli_validation.feature
 features/file_types.feature
+features/request.feature
 features/steps/cli_validation_steps.rb
 features/steps/file_types_steps.rb
 features/steps/helper.rb
+features/steps/request_steps.rb
 features/steps/validate_multiple_files_steps.rb
 features/steps/validate_steps.rb
 features/validate.feature
 features/validate_multiple_files.feature
 lib/please_validate.rb
 lib/please_validate/cli.rb
+lib/please_validate/request.rb
 lib/please_validate/validator.rb

data/README.rdoc

@@ -1,6 +1,7 @@
 = Please Validate
 
-http://github.com/DylanFM/please_validate/tree
+* http://github.com/DylanFM/please_validate/
+* http://rubyforge.org/projects/pleasevalidate/
 
 == DESCRIPTION:
 
@@ -39,6 +40,58 @@ A little markup validator.
     Line 20, Column 7: XML Parsing Error:  Premature end of data in tag body line 12
     Line 20, Column 7: XML Parsing Error:  Premature end of data in tag html line 4
 
+=== A few files: valid, invalid and a non-HTML file
+
+    $pleasevalidate examples/valid.html RakeFile examples/invalid.html
+    Valid: examples/valid.html
+
+    Validation failed: RakeFile must have a content type of text/html
+
+    Invalid: examples/invalid.html
+    11 errors:
+    Line 8, Column 19: end tag for element "itle" which is not open
+    Line 10, Column 6: end tag for "title" omitted, but OMITTAG NO was specified
+    Line 8, Column 1: start tag was here
+    Line 16, Column 5: document type does not allow element "ul" here; missing one of "object", "ins", "del", "map", "button" start-tag
+    Line 20, Column 0: unclosed end-tag requires SHORTTAG YES
+    Line 20, Column 0: end tag for "li" omitted, but OMITTAG NO was specified
+    Line 17, Column 4: start tag was here
+    Line 20, Column 0: end tag for "ul" omitted, but OMITTAG NO was specified
+    Line 16, Column 2: start tag was here
+    Line 20, Column 0: end tag for "p" omitted, but OMITTAG NO was specified
+    Line 15, Column 2: start tag was here
+    Line 8, Column 20: XML Parsing Error:  Opening and ending tag mismatch: title line 8 and itle
+    Line 20, Column 7: XML Parsing Error:  expected '>'
+    Line 20, Column 7: XML Parsing Error:  Premature end of data in tag p line 15
+    Line 20, Column 7: XML Parsing Error:  Premature end of data in tag body line 12
+    Line 20, Column 7: XML Parsing Error:  Premature end of data in tag html line 4
+
+=== A directory
+
+    $pleasevalidate examples
+    Valid: examples/valid.html
+
+    Invalid: examples/invalid.html
+    11 errors:
+    Line 8, Column 19: end tag for element "itle" which is not open
+    Line 10, Column 6: end tag for "title" omitted, but OMITTAG NO was specified
+    Line 8, Column 1: start tag was here
+    Line 16, Column 5: document type does not allow element "ul" here; missing one of "object", "ins", "del", "map", "button" start-tag
+    Line 20, Column 0: unclosed end-tag requires SHORTTAG YES
+    Line 20, Column 0: end tag for "li" omitted, but OMITTAG NO was specified
+    Line 17, Column 4: start tag was here
+    Line 20, Column 0: end tag for "ul" omitted, but OMITTAG NO was specified
+    Line 16, Column 2: start tag was here
+    Line 20, Column 0: end tag for "p" omitted, but OMITTAG NO was specified
+    Line 15, Column 2: start tag was here
+    Line 8, Column 20: XML Parsing Error:  Opening and ending tag mismatch: title line 8 and itle
+    Line 20, Column 7: XML Parsing Error:  expected '>'
+    Line 20, Column 7: XML Parsing Error:  Premature end of data in tag p line 15
+    Line 20, Column 7: XML Parsing Error:  Premature end of data in tag body line 12
+    Line 20, Column 7: XML Parsing Error:  Premature end of data in tag html line 4
+
+    Valid: examples/another/fancy.html
+
 == REQUIREMENTS:
 
 * nokogiri
@@ -47,10 +100,13 @@ A little markup validator.
 
 == INSTALL:
 
+    gem install pleasevalidate
+
+=== Or via Github:
 Run the following if you haven't already:
     gem sources -a http://gems.github.com
 Install the gem:
-    sudo gem install DylanFM-pleasevalidate
+    gem install DylanFM-pleasevalidate
 
 == LICENSE:
 

data/features/cli_validation.feature

@@ -1,7 +1,7 @@
-Feature: Validate a file
-  In order to product valid markup
+Feature: Validate an XHTML file
+  In order to produce valid markup
   As a web developer
-  I want to validate a file
+  I want to validate an XHTML file
   
   Scenario: Validate a file
     Given there is a valid html file examples/valid.html

data/features/request.feature

@@ -0,0 +1,9 @@
+Feature: Validation requests are wrapped in a request object
+  In order to validate all my contents
+  As a request
+  I want my request to be understood
+
+	Scenario: Request contains a directory
+	  Given there is a directory containing 3 files
+	  When the directory is included in a request
+	  Then the request should have those 3 files

data/features/steps/request_steps.rb

@@ -0,0 +1,14 @@
+Given /^there is a directory containing 3 files$/ do
+  @dir = 'examples'
+  File.directory?(@dir).should be_true
+end
+
+When /^the directory is included in a request$/ do
+  @request = PleaseValidate::Request.new(@dir)
+end
+
+Then /^the request should have those 3 files$/ do
+  ['valid','invalid','another/fancy'].each do |file|
+    @request.files.should include "#{@dir}/#{file}.html"
+  end
+end

data/lib/please_validate.rb

@@ -3,10 +3,11 @@ require 'net/http'
 require 'cgi'
 require 'nokogiri'
 require 'mime/types'
+require 'find'
 
 Dir.glob(File.join(File.dirname(__FILE__), "please_validate", "*.rb")).each { |f| require f }
 
 module PleaseValidate
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
   ACCEPTED_MIMES = ['text/html']
 end

data/lib/please_validate/cli.rb

@@ -6,7 +6,7 @@ module PleaseValidate
     class << self
       # Execute the CLI
       def execute(stdout, arguments=[])
-        options = {}
+        options = { :quiet => false }
         mandatory_options = %w(  )
 
         parser = OptionParser.new do |opts|
@@ -22,6 +22,8 @@ module PleaseValidate
           #                   "This is a sample message.",
           #                   "For multiple lines, add more strings.",
           #                   "Default: ~") { |arg| options[:path] = arg }
+          opts.on("-q", "--quiet",
+                  "Hide invalid file notices.") { options[:quiet] = true }
           opts.on("-h", "--help",
                   "Show this help message.") { stdout.puts opts; exit }
           opts.parse!(arguments)
@@ -30,45 +32,57 @@ module PleaseValidate
             stdout.puts opts; exit
           end
         end
-        validation = new(arguments)
+        validation = new(arguments, options)
         stdout.puts validation.msg
       end
     end
     
-    # Takes the requested file, passes it to validate for validation and displays the result with the display method
-    def initialize(arguments)
-      @files = arguments
-      @results = validate
+    # Takes the arguments, passes it to validate for validation and displays the result
+    def initialize(arguments, options)
+      @result, @options = validate(arguments), options
       @msg = display
     end
     
-    # Calls the validator class's file method for the requested file
-    def validate
-      PleaseValidate::Validator.files(@files)
+    # Creates a new request object and returns its result
+    def validate(items)
+      request = PleaseValidate::Request.new(items)
+      request.result
     end
     
-    # Displays the file validation's results
+    # Displays the request's results
     def display
-      @results.inject('') do |msg,result|
-        if result.is_a? Hash
-          msg += "#{result[:status].to_s.capitalize}: #{result[:file]}".send(result[:status] == :valid ? :on_green : :on_red)
-          if result[:status] == :invalid
-            msg += "\n#{result[:error_count]} error#{result[:error_count] == 1 ? nil:'s'}:"
-            result[:errors].each do |error|
-              msg += "\nLine #{error[:line]}, Column #{error[:col]}".red + ": #{error[:message]}"
-            end
-          end
-        elsif result.is_a? String
+      @result.inject('') do |msg,result|
+        if result.is_a? String
+          next msg if options[:quiet] && result =~ /^Validation failed:/
           msg += result
+        elsif result.is_a? Hash
+          msg += message_for result
         end
-        msg += "\n\n"
-        msg
+        "#{msg}\n\n"
       end
     end
     
-    #Displays the message for the command line result
+    # Displays the message for the command line result
     def msg
       @msg
     end
+    
+  protected
+    # Returns a hash of options passed to command line invocation
+    def options
+      @options
+    end
+    
+    # Takes one result from the validation and makes a message suitable for output
+    def message_for(result)
+      msg = "#{result[:status].to_s.capitalize}: #{result[:file]}".send(result[:status] == :valid ? :on_green : :on_red)
+      if result[:status] == :invalid
+        msg += "\n#{result[:error_count]} error#{result[:error_count] == 1 ? nil:'s'}:"
+        result[:errors].each do |error|
+          msg += "\nLine #{error[:line]}, Column #{error[:col]}".red + ": #{error[:message]}"
+        end
+      end
+      msg
+    end
   end
 end

data/lib/please_validate/request.rb

@@ -0,0 +1,39 @@
+module PleaseValidate
+  
+  class Request
+    
+    # Takes an array of requested items and passes them to the validator
+    def initialize(arguments)
+      @files = build_file_list_from_request arguments
+      @result = PleaseValidate::Validator.files(files)
+    end
+    
+    # Returns the validation result
+    def result
+      @result
+    end
+    
+    # Returns all files included in the validation request
+    def files
+      @files
+    end
+    
+    private
+    # Takes the request's arguments and checks if the requested items are directories
+    # The result of this method is an array of all arguments (files) that are within this request
+    # Any directories will be scanned recursively
+    def build_file_list_from_request(arguments)
+      files = []
+      arguments.each do |item|
+        if File.directory? item
+          Find.find(item) { |f| files << f if File.file? f }
+        else  
+          files << item
+        end
+      end
+      files
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: DylanFM-pleasevalidate
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Dylan Fogarty-MacDonald
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-14 00:00:00 -07:00
+date: 2009-03-31 00:00:00 -07:00
 default_executable: pleasevalidate
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,18 +85,21 @@ files:
 - cucumber.yml
 - features/cli_validation.feature
 - features/file_types.feature
+- features/request.feature
 - features/steps/cli_validation_steps.rb
 - features/steps/file_types_steps.rb
 - features/steps/helper.rb
+- features/steps/request_steps.rb
 - features/steps/validate_multiple_files_steps.rb
 - features/steps/validate_steps.rb
 - features/validate.feature
 - features/validate_multiple_files.feature
 - lib/please_validate.rb
 - lib/please_validate/cli.rb
+- lib/please_validate/request.rb
 - lib/please_validate/validator.rb
 has_rdoc: true
-homepage: http://github.com/DylanFM/please_validate/tree
+homepage: http://github.com/DylanFM/please_validate/
 post_install_message: PostInstall.txt
 rdoc_options: 
 - --main