DylanFM-pleasevalidate 0.0.1 → 0.0.2

data/History.txt

@@ -2,3 +2,10 @@
 
 * 1 major enhancement:
   * Initial release
+
+== 0.0.2 2009-14-09
+
+* 1 major enhancement:
+	* Multiple files validated
+* 1 minor enhancement:
+	* Mime type checked to only allow html files to be validated

data/Manifest.txt

@@ -1,15 +1,20 @@
 History.txt
 LICENSE
 Manifest.txt
+PostInstall.txt
 README.rdoc
 RakeFile
 bin/pleasevalidate
 cucumber.yml
 features/cli_validation.feature
+features/file_types.feature
 features/steps/cli_validation_steps.rb
+features/steps/file_types_steps.rb
 features/steps/helper.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/validator.rb

data/PostInstall.txt

@@ -0,0 +1,2 @@
+
+See http://github.com/DylanFM/please_validate for a brief how-to.

data/README.rdoc

@@ -43,10 +43,14 @@ A little markup validator.
 
 * nokogiri
 * colored
+* mime/types
 
 == INSTALL:
 
-    rake install_gem
+Run the following if you haven't already:
+    gem sources -a http://gems.github.com
+Install the gem:
+    sudo gem install DylanFM-pleasevalidate
 
 == LICENSE:
 

data/RakeFile

@@ -10,7 +10,8 @@ $hoe = Hoe.new('pleasevalidate', PleaseValidate::VERSION) do |p|
   p.rubyforge_name       = p.name
   p.extra_deps         = [
     ['nokogiri'],
-    ['colored']
+    ['colored'],
+    ['mime-types']
   ]
   p.extra_dev_deps = [
     ['newgem', ">= #{::Newgem::VERSION}"]

data/features/file_types.feature

@@ -0,0 +1,16 @@
+Feature: only HTML files are valid
+  In order to validate HTML files
+  As a developer
+  I want to make sure only HTML files are validated
+  
+  Scenario: HTML file requessted
+    Given there is an HTML file
+    When the HTML file is validated
+    Then there should be no errors
+    
+  Scenario: Bad file requested
+    Given there is a non-HTML file
+    When the non-HTML file is requested
+    Then there should be an error
+  
+  

data/features/steps/file_types_steps.rb

@@ -0,0 +1,24 @@
+Given /^there is an HTML file$/ do
+  Given "there is a valid XHTML file"
+end
+
+When /^the HTML file is validated$/ do
+  When "the file is validated"
+end
+
+Then /^there should be no errors$/ do
+  @result.should be_an_instance_of(Hash)
+end
+
+Given /^there is a non\-HTML file$/ do
+  @file = 'cucumber.yml'
+  File.exist?(@file).should be_true
+end
+
+When /^the non\-HTML file is requested$/ do
+  #Nothing to go here?
+end
+
+Then /^there should be an error$/ do
+  lambda { PleaseValidate::Validator.file(@file) }.should raise_error
+end

data/features/steps/validate_multiple_files_steps.rb

@@ -0,0 +1,29 @@
+Given /^there are 2 files for validation$/ do
+  @files = ['examples/valid.html','examples/invalid.html']
+  @files.each do |file|
+    File.exist?(file).should be_true
+  end
+end
+
+When /^they are both requested for validation$/ do
+  @results = PleaseValidate::Validator.files(@files)
+end
+
+Then /^the result should address both files$/ do
+  @results.should be_a_kind_of Array
+  @results.should have(2).things
+  @files.each do |file|
+    @results.any? { |r| r[:file] == file }.should be_true
+  end
+end
+
+When /^they are both requested for validation via cli$/ do
+  PleaseValidate::CLI.execute(@stdout_io = StringIO.new, @files)
+  @stdout_io.rewind
+  @stdout = @stdout_io.read
+end
+
+Then /^the result should mention both files$/ do
+  @stdout.should =~ /Valid: #{@file}/
+  @stdout.should =~ /Invalid: #{@file}/
+end

data/features/validate_multiple_files.feature

@@ -0,0 +1,15 @@
+Feature: Validates multiple files
+  In order to develop efficiently
+  As a developer
+  I want to validate multiple files at once
+
+	Scenario: validate 2 files
+	  Given there are 2 files for validation
+	  When they are both requested for validation
+	  Then the result should address both files
+	
+	Scenario: validate 2 files through cli
+	  Given there are 2 files for validation
+	  When they are both requested for validation via cli
+	  Then the result should mention both files
+	

data/lib/please_validate.rb

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

data/lib/please_validate/cli.rb

@@ -37,30 +37,33 @@ module PleaseValidate
     
     # Takes the requested file, passes it to validate for validation and displays the result with the display method
     def initialize(arguments)
-      begin
-        @file = arguments[0]
-        @result = validate
-        @msg = display
-      rescue Exception => e
-        @msg = "Validation failed"
-      end
+      @files = arguments
+      @results = validate
+      @msg = display
     end
     
     # Calls the validator class's file method for the requested file
     def validate
-      PleaseValidate::Validator.file(@file)
+      PleaseValidate::Validator.files(@files)
     end
     
     # Displays the file validation's results
     def display
-      msg = "#{@result[:status].to_s.capitalize}: #{@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]}"
+      @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
+          msg += result
         end
+        msg += "\n\n"
+        msg
       end
-      msg
     end
     
     #Displays the message for the command line result

data/lib/please_validate/validator.rb

@@ -4,31 +4,40 @@ module PleaseValidate
 
     class << self
       # Read requested file's contents and send to the w3c validator api then call the parse_response method to sort the response out.
-      def file(file_path)
+      def file(file)
         begin
-          raise "Please specify a file to validate" unless file_path
-          raise "The specified file doesn't exist" unless File.exist?(file_path)
-          response = File.open(file_path, 'r') do |f|
+          raise "please specify a file to validate" unless file
+          raise "#{file} doesn't exist" unless File.exist? file
+          raise "#{file} must have a content type of text/html" unless file_valid? file
+          response = File.open(file, 'r') do |f|
             Net::HTTP.start('validator.w3.org').post(
               '/check',
               "fragment=#{CGI.escape(f.read)}&output=xml",
               {'Content-Type' => 'application/x-www-form-urlencoded'}
             )
           end
-          parse_response response
-        rescue Exception => e
-          puts e
-          raise
+          parse_response file, response
+        end
+      end
+      
+      # Takes an array of files and validates them all
+      def files(files)
+        files.uniq.collect do |file|
+          begin
+            self.file(file)
+          rescue Exception => e
+            "Validation failed: #{e}"
+          end
         end
-        
       end
 
       # Takes an XML response from the file method's call to the w3c and parses it into a nice little hash
-      def parse_response(response)
+      def parse_response(filename, response)
         # Use Nokogiri to parse the xml
         response_data = Nokogiri::XML.parse(response.body)
         # Begin building the return hash
         result = { 
+          :file => filename,
           :status => response['x-w3c-validator-status'].downcase.to_sym,
           :error_count => response['x-w3c-validator-errors'].to_i,
           :errors => Array.new
@@ -48,6 +57,12 @@ module PleaseValidate
         end
         result
       end
+      
+      # Takes a file path and checks to see if it's mime type is OK. Currently using the first mime type returned by the mime-types gem.
+      def file_valid?(file)
+        mime = MIME::Types.type_for(file).first
+        !mime.nil? && ACCEPTED_MIMES.include?(mime.content_type)
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: DylanFM-pleasevalidate
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Dylan Fogarty-MacDonald
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-10 00:00:00 -07:00
+date: 2009-03-14 00:00:00 -07:00
 default_executable: pleasevalidate
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: newgem
   type: :development
@@ -62,20 +72,26 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
+- PostInstall.txt
 - README.rdoc
 files: 
 - History.txt
 - LICENSE
 - Manifest.txt
+- PostInstall.txt
 - README.rdoc
 - RakeFile
 - bin/pleasevalidate
 - cucumber.yml
 - features/cli_validation.feature
+- features/file_types.feature
 - features/steps/cli_validation_steps.rb
+- features/steps/file_types_steps.rb
 - features/steps/helper.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/validator.rb