epic 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,28 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+
+tmp
+vendor/bin/*
+vendor/gems/*
+!vendor/gems/cache/
+features/data/servers
+features/data/tmp

data/Gemfile

@@ -0,0 +1,5 @@
+gem "w3c_validators"
+gem "activesupport", :require_as => "active_support"
+gem "progressions-g", :require_as => "g"
+
+bin_path "vendor/bin"

data/History.txt

@@ -0,0 +1,3 @@
+== 0.0.1 2010-01-25
+  * validates JavaScript and HTML (CSS coming soon)
+  

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Capital Thought
+
+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/README.rdoc

@@ -0,0 +1,17 @@
+= epic
+
+Epic validator which can validate HTML, JavaScript and CSS.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Capital Thought. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "epic"
+    gem.summary = %Q{Epic validation of HTML, JavaScript and CSS}
+    gem.description = %Q{Epic validator, wraps validation for HTML, JavaScript and CSS.}
+    gem.email = "progressions@gmail.com"
+    gem.homepage = "http://github.com/progressions/epic"
+    gem.authors = ["Jeff Coleman"]
+    gem.add_development_dependency "rspec", ">= 1.2.6"
+    gem.add_runtime_dependency "w3c_validators"
+    gem.add_runtime_dependency "progressions-g"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['-c']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :bundle do
+  require 'vendor/gems/environment'
+  Bundler.require_env
+end
+
+task :spec => [:bundle, :check_dependencies]
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "epic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/epic

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(dir) unless $LOAD_PATH.include?(dir)
+
+require 'epic'
+
+file = ARGV[0]
+
+Epic::Validator::Base.configure do |config|
+  config.base_path = "./"
+  config.tmp_path = "./tmp"
+end
+
+if file =~ /.js$/
+  Epic::Validator::JavaScript.new.validate(file)
+end
+
+system "rm -rf ./tmp"

data/epic.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{epic}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeff Coleman"]
+  s.date = %q{2010-01-25}
+  s.default_executable = %q{epic}
+  s.description = %q{Epic validator, wraps validation for HTML, JavaScript and CSS.}
+  s.email = %q{progressions@gmail.com}
+  s.executables = ["epic"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "History.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/epic",
+     "epic.gemspec",
+     "lib/epic.rb",
+     "lib/file.rb",
+     "spec/epic_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/stubs.rb",
+     "vendor/ext/js.jar",
+     "vendor/ext/jslint.js"
+  ]
+  s.homepage = %q{http://github.com/progressions/epic}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Epic validation of HTML, JavaScript and CSS}
+  s.test_files = [
+    "spec/epic_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/stubs.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.6"])
+      s.add_runtime_dependency(%q<w3c_validators>, [">= 0"])
+      s.add_runtime_dependency(%q<progressions-g>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.6"])
+      s.add_dependency(%q<w3c_validators>, [">= 0"])
+      s.add_dependency(%q<progressions-g>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.6"])
+    s.add_dependency(%q<w3c_validators>, [">= 0"])
+    s.add_dependency(%q<progressions-g>, [">= 0"])
+  end
+end
+

data/lib/epic.rb

@@ -0,0 +1,158 @@
+require 'rubygems'
+require 'lib/file'
+require 'g'
+require 'active_support'
+require 'w3c_validators'
+
+module Epic
+  module Validator
+    class Configuration
+      attr_accessor :base_path, :tmp_path, :doctype, :jslint_settings
+    end
+    
+    class Base
+      class << self
+        def configuration
+          @@configuration ||= Epic::Validator::Configuration.new
+        end
+      
+        def configure
+          yield configuration
+        end
+      end
+
+      def configuration
+        self.class.configuration
+      end
+
+      # Parses out the <tt>base_path</tt> setting from a path to display it in a
+      # less verbose way.
+      #
+      def display_path(path)
+        path = File.expand_path(path)
+        path.gsub(base_path.to_s, "")
+      end
+      
+      def base_path      
+        configuration.base_path || ""
+      end
+      
+      def tmp_path
+        configuration.tmp_path || ""
+      end
+    end
+    
+    class HTML < Base
+      def validator
+        @validator ||= W3CValidators::MarkupValidator.new
+      end
+      
+      def validate(path)
+        $stdout.print "   #{path}  validating . . . "
+        
+        doctype = configuration.doctype || "HTML 4.01 Transitional"
+        validator.set_doctype!(doctype)
+
+        results = validator.validate_file(path)
+        
+        valid = results.errors.length <= 0
+        
+        if valid
+          $stdout.puts "OK"
+        else
+          $stdout.puts "validation errors"
+          results.errors.each do |err|
+            $stdout.puts
+            $stdout.puts err.to_s
+          end
+        end
+        
+        valid
+      end
+    end
+    
+    class JavaScript < Base
+      def use_jslint_settings?
+        !jslint_settings.blank?
+      end
+      
+      def jslint_settings
+        configuration.jslint_settings
+      end
+      
+      def jslint_settings_count
+        jslint_settings.to_s.split("\n").size
+      end
+      
+      def pre_process(content)
+        content
+      end
+    
+      def validate(path)
+        display = display_path(path)
+        $stdout.print "   #{display}  validating . . . "
+        output = ""
+      
+        File.open(path) do |f|
+          output = f.read
+        end
+        
+        output = pre_process(output)
+        
+        FileUtils.mkdir_p(tmp_path)
+        
+        js_fragment_path = File.expand_path("#{tmp_path}/#{File.basename(path)}_fragment")
+        fragment_display_path = display_path(js_fragment_path)
+    
+        if File.exists?(js_fragment_path)
+          puts "That already exists?"
+        else
+          File.open(js_fragment_path,'w') do |f|
+            f.puts jslint_settings if use_jslint_settings?
+            f.puts output
+          end
+
+          jslint_path = File.expand_path("#{File.dirname(__FILE__)}/../vendor/ext/jslint.js")
+          raise "#{jslint_path} does not exist" unless File.exists?(jslint_path)
+          rhino_path = File.expand_path("#{File.dirname(__FILE__)}/../vendor/ext/js.jar")
+          raise "#{rhino_path} does not exist" unless File.exists?(rhino_path)
+          
+          results = F.execute("java -jar #{rhino_path} #{jslint_path} #{js_fragment_path}", :return => true)
+
+          if results =~ /jslint: No problems found/
+            $stdout.puts "OK"
+          else
+            $stdout.puts "errors found!"
+            results.split("\n").each do |result|
+              if result =~ /line (\d+) character (\d+): (.*)/
+                line_number = $1.to_i
+                error = "Error at #{fragment_display_path} line #{line_number-jslint_settings_count} character #{$2}: #{$3}"
+                error += F.get_line_from_file(js_fragment_path, line_number)
+          
+                $stdout.puts error
+              end
+            end
+            message = "JavaScript Errors embedded in #{display}"
+            g(message)
+            raise message
+          end
+        end
+      end
+    end
+    
+    class JSON < JavaScript
+      def pre_process(output)
+        output
+      end
+      
+      def jslint_settings
+      end
+    end
+    
+    class Stylesheet < Base
+      def validate(filename)
+        true
+      end
+    end
+  end
+end

data/lib/file.rb

@@ -0,0 +1,63 @@
+# Provides a wrapper around common calls that interact with the file system.
+#
+module F
+
+  module_function
+
+  # Concatenates together the contents of all the files in the <tt>source_path</tt> 
+  # into the <tt>destination_path</tt>.
+  #
+  def concat_files(source_path, destination_path)
+    File.open(destination_path, "a") do |output|
+      Dir[source_path].each do |path|
+        output.puts File.read(path)
+      end
+    end
+  end
+
+  # Saves the <tt>output</tt> string to the <tt>destination_path</tt> given.
+  #
+  # Returns <tt>true</tt> if the destination file was newly created, <tt>false</tt> if
+  # it already existed.
+  #
+  def save_to_file(output, destination_path)
+    if File.exists?(destination_path)      
+      false
+    else
+      File.open(destination_path, "w") do |w|
+        w.write(output)
+      end
+      true
+    end
+  end
+
+  # Given a <tt>path</tt> and <tt>line_number</tt>, returns the line and two lines previous
+  #
+  # Used for displaying validation errors.
+  #
+  def get_line_from_file(path, line_number)
+    line_number = line_number.to_i
+    output = "\n"
+    lines = File.readlines(path)
+
+    3.times do |i|
+      line = lines[line_number-(3-i)]
+      output += line if line
+    end
+
+    output += "\n"
+    output
+  end
+
+  # Execute a system command. If the parameter <tt>:return</tt> is true, execute the command
+  # with the backtick (`) command and return the results.  Otherwise, just execute the command
+  # and let the output go to the screen.
+  #
+  def execute(command, params={})
+    if params[:return]
+      `#{command}`
+    else
+      Kernel.system command
+    end
+  end
+end