DylanFM-pleasevalidate 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-03-09
+
+* 1 major enhancement:
+  * Initial release

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Dylan Fogarty-MacDonald
+
+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 PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL 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/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+LICENSE
+Manifest.txt
+README.rdoc
+RakeFile
+bin/pleasevalidate
+cucumber.yml
+features/cli_validation.feature
+features/steps/cli_validation_steps.rb
+features/steps/helper.rb
+features/steps/validate_steps.rb
+features/validate.feature
+lib/please_validate.rb
+lib/please_validate/cli.rb
+lib/please_validate/validator.rb

data/README.rdoc

@@ -0,0 +1,74 @@
+= Please Validate
+
+http://github.com/DylanFM/please_validate/tree
+
+== DESCRIPTION:
+
+A little markup validator.
+
+== FEATURES/PROBLEMS:
+
+* Validate (X)HTML files.
+
+== SYNOPSIS:
+
+=== Valid file
+  
+    $ pleasevalidate examples/valid.html
+    Valid: examples/valid.html
+
+=== Invalid file
+
+    $ pleasevalidate examples/invalid.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
+
+== REQUIREMENTS:
+
+* nokogiri
+* colored
+
+== INSTALL:
+
+    rake install_gem
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Dylan Fogarty-MacDonald
+
+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 PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL 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/RakeFile

@@ -0,0 +1,31 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/please_validate'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('pleasevalidate', PleaseValidate::VERSION) do |p|
+  p.developer('Dylan Fogarty-MacDonald', 'dylan.fm@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt'
+  p.rubyforge_name       = p.name
+  p.extra_deps         = [
+    ['nokogiri'],
+    ['colored']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new
+ 

data/bin/pleasevalidate

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2009-3-9.
+#  Copyright (c) 2009. All rights reserved.
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/please_validate")
+
+PleaseValidate::CLI.execute(STDOUT, ARGV)

data/cucumber.yml

@@ -0,0 +1 @@
+default: features

data/features/cli_validation.feature

@@ -0,0 +1,9 @@
+Feature: Validate a file
+  In order to product valid markup
+  As a web developer
+  I want to validate a file
+  
+  Scenario: Validate a file
+    Given there is a valid html file examples/valid.html
+    When the file is validated and the output is captured
+    Then the result should be displayed saying it's valid

data/features/steps/cli_validation_steps.rb

@@ -0,0 +1,14 @@
+Given /^there is a valid html file ([~\w\/.]+)$/ do |file|
+  @file = file
+  File.exist?(@file).should be_true
+end
+
+When /^the file is validated and the output is captured$/ do
+  PleaseValidate::CLI.execute(@stdout_io = StringIO.new, [@file])
+  @stdout_io.rewind
+  @stdout = @stdout_io.read
+end
+
+Then /^the result should be displayed saying it's valid$/ do
+  @stdout.should =~ /Valid: #{@file}/
+end

data/features/steps/helper.rb

@@ -0,0 +1,3 @@
+require 'spec'
+require 'stringio'
+require File.dirname(__FILE__) + '/../../lib/please_validate'

data/features/steps/validate_steps.rb

@@ -0,0 +1,37 @@
+Given /^there is a valid XHTML file$/ do
+  @file = 'examples/valid.html'
+  File.exist?(@file).should be_true
+end
+
+When /^the file is validated$/ do
+  @result = PleaseValidate::Validator.file(@file)
+end
+
+Then /^the response should not show errors$/ do
+  @result[:error_count].should == 0
+  @result[:errors].length.should == 0
+end
+
+Then /^the file should be valid$/ do
+  @result[:status].should == :valid
+end
+
+Given /^there is an invalid XHTML file$/ do
+  @file = 'examples/invalid.html'
+  File.exist?(@file).should be_true
+end
+
+Then /^the file should be invalid$/ do
+  @result[:status].should == :invalid
+end
+
+Then /^the response should show errors$/ do
+  @result[:error_count].should > 0
+  @result[:errors].length.should > 0
+  @result[:errors].each do |error|
+    error[:message].should_not be_empty
+    error[:line].should be_an_instance_of(Fixnum)
+    error[:col].should be_an_instance_of(Fixnum)
+  end
+end
+

data/features/validate.feature

@@ -0,0 +1,17 @@
+Feature: Validate markup
+  In order to be standards compliant
+  As a web developer
+  I want to validate my markup
+  
+  Scenario: Validate valid markup
+    Given there is a valid XHTML file
+    When the file is validated
+    Then the response should not show errors
+    And the file should be valid
+  
+  Scenario: Validate invalid markup
+    Given there is an invalid XHTML file
+    When the file is validated
+    Then the file should be invalid
+    And the response should show errors
+  

data/lib/please_validate/cli.rb

@@ -0,0 +1,71 @@
+require 'optparse'
+require 'colored'
+
+module PleaseValidate
+  class CLI
+    class << self
+      # Execute the CLI
+      def execute(stdout, arguments=[])
+        options = {}
+        mandatory_options = %w(  )
+
+        parser = OptionParser.new do |opts|
+          opts.banner = <<-BANNER.gsub(/^          /,'')
+            Please Validate does some lovely markup validation of your (X)HTML files.
+
+            Usage: #{File.basename($0)} /path/to/file [options]
+
+            Options are:
+          BANNER
+          opts.separator ""
+          # opts.on("-p", "--path=PATH", String,
+          #                   "This is a sample message.",
+          #                   "For multiple lines, add more strings.",
+          #                   "Default: ~") { |arg| options[:path] = arg }
+          opts.on("-h", "--help",
+                  "Show this help message.") { stdout.puts opts; exit }
+          opts.parse!(arguments)
+
+          if mandatory_options && mandatory_options.find { |option| options[option.to_sym].nil? }
+            stdout.puts opts; exit
+          end
+        end
+        validation = new(arguments)
+        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)
+      begin
+        @file = arguments[0]
+        @result = validate
+        @msg = display
+      rescue Exception => e
+        @msg = "Validation failed"
+      end
+    end
+    
+    # Calls the validator class's file method for the requested file
+    def validate
+      PleaseValidate::Validator.file(@file)
+    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]}"
+        end
+      end
+      msg
+    end
+    
+    #Displays the message for the command line result
+    def msg
+      @msg
+    end
+  end
+end

data/lib/please_validate/validator.rb

@@ -0,0 +1,55 @@
+module PleaseValidate
+  
+  class Validator
+
+    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)
+        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|
+            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
+        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)
+        # Use Nokogiri to parse the xml
+        response_data = Nokogiri::XML.parse(response.body)
+        # Begin building the return hash
+        result = { 
+          :status => response['x-w3c-validator-status'].downcase.to_sym,
+          :error_count => response['x-w3c-validator-errors'].to_i,
+          :errors => Array.new
+        }
+        # Get meta elements like encoding and doctype
+        response_data.css('result > meta *').each do |meta|
+          next unless %w{encoding doctype}.include? meta.name
+          result[meta.name.to_sym] = meta.content
+        end
+        # Get errors
+        response_data.css('result messages msg').each do |error|
+          result[:errors] << {
+            :message => error.content,
+            :line => error['line'].to_i,
+            :col => error['col'].to_i
+          }
+        end
+        result
+      end
+    end
+
+  end
+  
+end

data/lib/please_validate.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'net/http'
+require 'cgi'
+require 'nokogiri'
+
+Dir.glob(File.join(File.dirname(__FILE__), "please_validate", "*.rb")).each { |f| require f }
+
+module PleaseValidate
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: DylanFM-pleasevalidate
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dylan Fogarty-MacDonald
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-10 00:00:00 -07:00
+default_executable: pleasevalidate
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: colored
+  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
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: A little markup validator.
+email: 
+- dylan.fm@gmail.com
+executables: 
+- pleasevalidate
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.rdoc
+- RakeFile
+- bin/pleasevalidate
+- cucumber.yml
+- features/cli_validation.feature
+- features/steps/cli_validation_steps.rb
+- features/steps/helper.rb
+- features/steps/validate_steps.rb
+- features/validate.feature
+- lib/please_validate.rb
+- lib/please_validate/cli.rb
+- lib/please_validate/validator.rb
+has_rdoc: true
+homepage: http://github.com/DylanFM/please_validate/tree
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: pleasevalidate
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A little markup validator.
+test_files: []
+