epic 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,10 @@
+== 0.0.4 2010-01-30
+  * major enhancements
+    * compression and validation performed by instances rather the class
+  * minor enhancements
+    * don't growl and raise errors on validation, just display errors
+    * internal refactoring
+
 == 0.0.3 2010-01-25
   * major enhancements
     * added YUI compressor to compress JavaScript and CSS

data/Rakefile

@@ -30,6 +30,7 @@ end
 Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov_opts = ['--exclude', '.gem,Library,spec', '--sort', 'coverage']
   spec.rcov = true
 end
 
@@ -52,3 +53,8 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = "--format pretty"
+end

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/epic.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{epic}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   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.date = %q{2010-01-30}
   s.default_executable = %q{epic}
   s.description = %q{Epic validator, wraps validation for HTML, JavaScript and CSS.}
   s.email = %q{progressions@gmail.com}
@@ -29,15 +29,36 @@ Gem::Specification.new do |s|
      "VERSION",
      "bin/epic",
      "epic.gemspec",
+     "features/compressor.feature",
+     "features/data/html/invalid.html",
+     "features/data/html/valid.html",
+     "features/data/javascripts/invalid.js",
+     "features/data/javascripts/invalid_uncompressed.js",
+     "features/data/javascripts/pre_compressed.js",
+     "features/data/javascripts/pre_compressed.js.min",
+     "features/data/javascripts/valid.js",
+     "features/data/javascripts/valid_uncompressed.js",
+     "features/data/stylesheets/valid.css",
+     "features/step_definitions/compressor_steps.rb",
+     "features/step_definitions/file_steps.rb",
+     "features/step_definitions/validator_steps.rb",
+     "features/support/env.rb",
+     "features/validator.feature",
      "lib/epic.rb",
      "lib/epic/base.rb",
      "lib/epic/compressor.rb",
+     "lib/epic/errors.rb",
      "lib/epic/validator.rb",
+     "lib/epic/validator/base.rb",
+     "lib/epic/validator/html.rb",
+     "lib/epic/validator/javascript.rb",
+     "lib/epic/validator/json.rb",
+     "lib/epic/validator/stylesheet.rb",
      "spec/compressor_spec.rb",
-     "spec/epic_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/stubs.rb",
+     "spec/validator_spec.rb",
      "vendor/ext/js.jar",
      "vendor/ext/jslint.js",
      "vendor/ext/yuicompressor-2.4.2.jar"
@@ -49,9 +70,9 @@ Gem::Specification.new do |s|
   s.summary = %q{Epic validation of HTML, JavaScript and CSS}
   s.test_files = [
     "spec/compressor_spec.rb",
-     "spec/epic_spec.rb",
      "spec/spec_helper.rb",
-     "spec/stubs.rb"
+     "spec/stubs.rb",
+     "spec/validator_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/features/compressor.feature

@@ -0,0 +1,29 @@
+
+Feature: Compress JavaScript and Stylesheet files
+
+  Background:
+    Given I configure Epic::Base
+    
+  Scenario: Compress a valid JavaScript file
+    Given I compress the file "javascripts/valid_uncompressed.js"
+    And I open the file "javascripts/valid_uncompressed.js.min"
+    Then I should see "var hello\=function\(a\)"
+    And no exceptions should have been raised
+    And I remove the file "javascripts/valid_uncompressed.js.min"
+    
+  Scenario: Compress an invalid JavaScript file
+    Given I compress the file "javascripts/invalid_uncompressed.js"
+    Then an exception should have been raised with the message "JavaScript errors"
+    
+  Scenario: Don't re-compress if compressed file exists
+    Given I compress the file "javascripts/pre_compressed.js"
+    And I open the file "javascripts/pre_compressed.js.min"
+    Then I should see "function alreadyCompressed\(b\)"
+    
+  Scenario: Raise an error if the original file doesn't exist
+    Given I compress the file "javascripts/nonexistent.js"
+    Then an exception should have been raised with the message "No such file or directory"
+    
+    
+    
+    

data/features/data/html/invalid.html

@@ -0,0 +1,12 @@
+<html>
+  <head>
+    <title>Title of valid HTML file</title>
+  </head>
+  
+  <body>
+    <p>Hello</p>
+    <span>
+      <div>This div is inside a span</div>
+    </span>
+  </body>
+</html>

data/features/data/html/valid.html

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <title>Title of valid HTML file</title>
+  </head>
+  
+  <body>
+    <p>Hello</p>
+  </body>
+</html>

data/features/data/javascripts/invalid.js

@@ -0,0 +1 @@
+alert("hello")

data/features/data/javascripts/invalid_uncompressed.js

@@ -0,0 +1,3 @@
+var hello = function() {
+  alert("My name is" name)
+};

data/features/data/javascripts/pre_compressed.js

@@ -0,0 +1,3 @@
+function preCompressed(name) {
+  alert("I'm precompressed " + name);
+};

data/features/data/javascripts/pre_compressed.js.min

@@ -0,0 +1 @@
+function alreadyCompressed(b){alert("I'm precompressed "+a);}

data/features/data/javascripts/valid.js

@@ -0,0 +1 @@
+alert("hello");

data/features/data/javascripts/valid_uncompressed.js

@@ -0,0 +1,3 @@
+var hello = function(name) {
+  alert("My name is" + name);
+};

data/features/data/stylesheets/valid.css

@@ -0,0 +1,3 @@
+p {
+  color: red;
+}

data/features/step_definitions/compressor_steps.rb

@@ -0,0 +1,9 @@
+Given %r{I compress the file "([^\"]*)"} do |filename|
+  path = "#{BASE_PATH}/#{filename}"
+  
+  begin
+    Epic::Compressor.new(path).compress
+  rescue StandardError => e
+    @exceptions << e.message
+  end
+end

data/features/step_definitions/file_steps.rb

@@ -0,0 +1,25 @@
+Given %r{the file "([^\"]*)" exists with "([^\"]*)"} do |filename, content|
+  content.gsub!("\\n", "\n")
+  File.open("#{BASE_PATH}/#{filename}", "w") do |f|
+    content.split("\n").each do |line|
+      f.puts line
+    end
+  end
+  @files << "#{BASE_PATH}/#{filename}"
+end
+
+And %r{I remove the file "([^\"]*)"} do |filename|
+  system "rm #{BASE_PATH}/#{filename}"
+end
+
+When %r{I open the file "([^\"]*)"} do |filename|
+  @current_file = File.read("#{BASE_PATH}/#{filename}")
+end
+
+Then %r{I should see "([^\"]*)"} do |content|
+  @current_file.should match(Regexp.new(content))
+end
+
+Then %r{I should not see "([^\"]*)"} do |content|
+  @current_file.should_not match(Regexp.new(content))
+end

data/features/step_definitions/validator_steps.rb

@@ -0,0 +1,38 @@
+Given %r{I configure Epic::Base} do
+  Epic::Base.configure do |config|
+    config.base_path = "#{BASE_PATH}"
+  end
+end
+
+Given %r{the file "([^\"]*)" should be valid} do |filename|
+  if filename =~ /\.html$/
+    @validator = Epic::Validator::HTML.new
+  elsif filename =~ /\.js$/
+    @validator = Epic::Validator::JavaScript.new
+  end
+  @validator.validate("#{BASE_PATH}/#{filename}").should be_true
+end
+
+Given %r{the file "([^\"]*)" should not be valid} do |filename|
+  if filename =~ /\.html$/
+    @validator = Epic::Validator::HTML.new
+    @validator.validate("#{BASE_PATH}/#{filename}").should be_false
+  elsif filename =~ /\.js$/
+    @validator = Epic::Validator::JavaScript.new
+    @validator.validate("#{BASE_PATH}/#{filename}").should be_false
+  end
+end
+
+Then /^an exception should have been raised with the message "([^\"]*)"$/ do |message|
+  found_exception = false
+  puts @exceptions.inspect
+  @exceptions.each do |exception|
+    found_exception ||= exception =~ Regexp.new(message)
+  end
+  found_exception.should be_true
+end
+
+Then %r{no exceptions should have been raised} do
+  @exceptions.should be_empty
+end
+

data/features/support/env.rb

@@ -0,0 +1,31 @@
+require 'vendor/gems/environment'
+Bundler.require_env :cucumber
+
+require 'spec/expectations'
+require 'spec/mocks'
+
+require 'lib/epic'
+
+require 'spec/stubs'
+
+Before do
+  unless defined?(BASE_PATH)
+    BASE_PATH = File.expand_path("./features/data")
+  end
+
+  @exceptions = []
+  @files = []
+
+  $rspec_mocks ||= Spec::Mocks::Space.new  
+  
+  stub_growl
+end
+
+After do
+  @files.each do |file|
+    system "rm #{file}"
+  end
+  
+  system "rm -rf #{BASE_PATH}/tmp"
+  system "mkdir #{BASE_PATH}/tmp"
+end

data/features/validator.feature

@@ -0,0 +1,17 @@
+Feature: Test the validator
+
+  Background:
+    Given I configure Epic::Base
+    
+  Scenario: Validate a valid HTML file
+    Given the file "html/valid.html" should be valid
+  
+  Scenario: Validate an invalid HTML file
+    Given the file "html/invalid.html" should not be valid
+    
+  Scenario: Validate a valid JavaScript file
+    Given the file "javascripts/valid.js" should be valid
+    
+  Scenario: Validate an invalid JavaScript file
+    Given the file "javascripts/invalid.js" should not be valid
+    

data/lib/epic.rb

@@ -1,5 +1,6 @@
 dir = File.dirname(__FILE__)
 $LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'epic'))
 
 require 'rubygems'
 require 'f'
@@ -8,5 +9,6 @@ require 'active_support'
 require 'w3c_validators'
 
 require 'epic/base'
+require 'epic/errors'
 require 'epic/validator'
-require 'epic/compressor'
+require 'compressor'

data/lib/epic/base.rb

@@ -6,36 +6,25 @@ module Epic #:nodoc
   class Base
     class << self
       def configuration
-        @@configuration ||= Epic::Configuration.new
+        @configuration ||= Epic::Configuration.new
       end
     
       def configure
         yield 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
     end
 
     def configuration
-      self.class.configuration
+      Epic::Base.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, "")
+    def display_path(filename=nil)
+      filename ||= path
+      display_path = File.expand_path(filename)
+      display_path.gsub(base_path.to_s, "")
     end
     
     def base_path      
@@ -43,7 +32,7 @@ module Epic #:nodoc
     end
     
     def tmp_path
-      configuration.tmp_path || ""
+      configuration.tmp_path || "#{base_path}/tmp" || ""
     end
   end
 end

data/lib/epic/compressor.rb

@@ -1,126 +1,139 @@
 module Epic #:nodoc:
-  module Compressor #:nodoc:
-    # Compresses a file using the specified compressor/minifier (currently YUI Compressor 2.4.2).
-    #
-    # === Usage
-    #
-    #   Epic::Compressor::Base.compress("filename.js", "type" => "js")
-    #
-    #   Epic::Compressor::Base.compress("filename.css", "type" => "css")
-    #
-    # Outputs the compressed file to <tt>_path_.min.</tt>
-    #
-    # === Options
-    # 
-    #   "type"::              "js" or "css". Identifies the file type.
-    #
-    #   "obfuscate"::         true or false. Change internal variable names within the code.
-    #                         
-    #   "verbose"::           true or false. Output warnings about code quality.
-    #
-    #   "preserve_semi"::     true or false. Preserve unnecessary semicolons.
-    #
-    # TODO: Make it support multiple compressors.
-    #
-    # TODO: Convert it to an object, so you instantiate the Compressor class and then call it
-    # on a file or a string.
-    #
-    # TODO: Get some stringify_keys! action going so you can send in symbols or strings.
+  # Compresses a file using the specified compressor/minifier (currently YUI Compressor 2.4.2).
+  #
+  # === Usage
+  #
+  #   Epic::Compressor.compress("filename.js")
+  #
+  #   Epic::Compressor.compress("filename.css")
+  #
+  # Outputs the compressed file to <tt>_path_.min.</tt>
+  #
+  # === Options
+  # 
+  #   "type"                "js" or "css". Identifies the file type. Only needed if the file does
+  #                         not have a standard extension.
+  #
+  #   "obfuscate"           true or false. Change internal variable names within the code.
+  #                         
+  #   "verbose"             true or false. Output warnings about code quality.
+  #
+  #   "preserve_semi"       true or false. Preserve unnecessary semicolons.
+  #
+  # TODO: Make it support multiple compressors.
+  #
+  class Compressor < Epic::Base
+    include Epic::Errors
+    
+    # The path of the original file being compressed.
+    #      
+    attr_accessor :path
+    
+    # The type of file, whether :js or :css.
     #
-    class Base < Epic::Base
-      def self.compress(path, options={})
-        options.stringify_keys!
-        compressed_display_path = display_path(path)
-        compressed_path = "#{path}.min"
+    attr_accessor :type
+    
+    def initialize(path)
+      @path = path
+      if path =~ /\.js$/
+        @type = :js
+      elsif path =~ /\.css$/
+        @type = :css
+      end
+      @errors = []
+    end
+    
+    def compress(params={})
+      # if the compressed_file exists, don't create it again
+      #
+      compress_path(params) unless File.exists?(compressed_path)
       
-        options["type"] ||= "js"
-        options["type"] = options["type"].to_s
-        
-        # if the compressed_file exists, don't create it again
-        #
-        unless File.exists?(compressed_path)
-          $stdout.print "   #{compressed_display_path}  compressing . . . "
-          compressed = ''
-        
-          # set options and defaults
-          #
-          if options.delete("obfuscate")
-            options["nomunge"] = ""
-          end
-          if options.delete("verbose")
-            options["verbose"] = ""
-          end
-          options["charset"] = "utf-8"
-        
-          if options["type"].to_s == "js" && !options["preserve_semi"]
-            options["preserve-semi"] = ""
-          end
-        
-          # join the options together for appending to the command line
-          #
-          options_string = options.map {|k,v| "--#{k} #{v}"}.join(" ")
+      File.read(compressed_path)
+    end
+    
+    def compressed_path
+      @compressed_path ||= "#{path}.min"
+    end
+    
+    def compressed_display_path
+      @compressed_display_path ||= display_path(path)
+    end
+    
+    def compress_path(params)
+      params.stringify_keys!
       
-          # call the compressor
-          #
-          compressor_path = File.expand_path("#{File.dirname(__FILE__)}/../../vendor/ext/yuicompressor-2.4.2.jar")
-          raise "#{compressor_path} does not exist" unless File.exists?(compressor_path)
-          
-          command = "java -jar #{compressor_path} #{options_string} #{path} -o #{compressed_path} 2>&1"
-          result = F.execute(command, :return => true)
-        
-          result.split("\n").each do |line|
-            if line =~ /\[ERROR\] (\d+):(\d+):(.*)/
-              line_number = $1.to_i
-              error = "Error at #{compressed_display_path} line #{line_number} character #{$2}: #{$3}"
-              error += F.get_line_from_file(path, line_number)
-        
-              $stdout.puts error
-              g(error)
-            end
-          end
-          
-          if result =~ /ERROR/
-            raise "JavaScript errors in #{compressed_display_path}"
-          else
-            $stdout.puts "OK"
-          end
-        end
-
-        # The compressed file should exist now. If it does, use it. If not, raise an error.
-        #
-        if File.exists?(compressed_path)
-          compressed = File.read(compressed_path)
-        else
-          raise "File does not exist: #{compressed_display_path}"
-        end
+      $stdout.print "   #{compressed_display_path}  compressing . . . "
+      compressed = ''
       
-        compressed      
-      end
+      options_string = convert_params_to_string(params)
+
+      result = execute_compressor(options_string)
+
+      parse_errors(result)
+  
+      if valid?
+        $stdout.puts "OK"
+      else
+        display_errors
+        raise "JavaScript errors in #{compressed_display_path}"
+      end          
     end
     
-    # Compresses a CSS file using the specified compressor/minifier (currently YUI Compressor 2.4.2).
-    #
-    # === Usage
+    # call the compressor
     #
-    #   Epic::Compressor::Stylesheet.compress("filename.css")
-    #
-    class Stylesheet < Base
-      def self.compress(path)
-        super(path, "type" => "css")
-      end
+    def execute_compressor(options_string)
+      command = "java -jar #{compressor_path} #{options_string} #{path} -o #{compressed_path} 2>&1"
+      result = F.execute(command, :return => true)          
     end
     
-    # Compresses a JavaScript file using the specified compressor/minifier (currently YUI Compressor 2.4.2).
-    #
-    # === Usage
+    def parse_errors(result="")
+      result.to_s.split("\n").each do |line|
+        if line =~ /\[ERROR\] (\d+):(\d+):(.*)/
+          line_number = $1.to_i
+          error = "Error at #{compressed_display_path} line #{line_number} character #{$2}: #{$3}"
+          error += F.get_line_from_file(path, line_number)
+
+          errors << error
+        end
+      end          
+    end
+
+    # join the options together for appending to the command line
     #
-    #   Epic::Compressor::JavaScript.compress("filename.js")
+    def convert_params_to_string(params)
+      options = parse_options(params)
+      options.map {|k,v| "--#{k} #{v}"}.join(" ")
+    end
+
+    # set options and defaults
     #
-    class JavaScript < Base
-      # TODO: Add options hash   
-      def self.compress(filename)
-        super(filename, "type" => "js")
+    def parse_options(options)
+      options["type"] ||= type
+      options["type"] = options["type"].to_s
+      
+      if options.delete("obfuscate")
+        options["nomunge"] = ""
+      end
+      if options.delete("verbose")
+        options["verbose"] = ""
       end
+      options["charset"] = "utf-8"
+
+      if options["type"].to_s == "js" && !options["preserve_semi"]
+        options["preserve-semi"] = ""
+      end 
+      
+      options         
+    end
+  
+    def compressor_path
+      compressor_path = File.expand_path("#{vendor_path}/ext/yuicompressor-2.4.2.jar")
+      raise "#{compressor_path} does not exist" unless File.exists?(compressor_path)
+      compressor_path
+    end
+
+    def vendor_path
+      File.join(File.dirname(__FILE__), "..", "..", "vendor")
     end
   end
 end

data/lib/epic/errors.rb

@@ -0,0 +1,18 @@
+module Epic #:nodoc:
+  module Errors #:nodoc: 
+    def errors
+      @errors ||= []
+    end
+    
+    def valid?
+      errors.empty?
+    end
+
+    def display_errors
+      errors.each do |err|
+        $stdout.puts
+        $stdout.puts err.to_s
+      end        
+    end
+  end
+end

data/lib/epic/validator.rb

@@ -1,118 +1,5 @@
-require 'epic/base'
-
-module Epic
-  module Validator
-    class HTML < Epic::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
+require 'validator/base'
+require 'validator/html'
+require 'validator/javascript'
+require 'validator/json'
+require 'validator/stylesheet'

data/lib/epic/validator/base.rb

@@ -0,0 +1,14 @@
+module Epic #:nodoc:
+  module Validator #:nodoc:
+    class Base < Epic::Base
+      include Epic::Errors
+      
+      attr_accessor :path, :errors
+      
+      def initialize(path=nil)
+        @path = path
+        @errors = []
+      end
+    end
+  end
+end

data/lib/epic/validator/html.rb

@@ -0,0 +1,33 @@
+module Epic #:nodoc:
+  module Validator #:nodoc:  
+    class HTML < Epic::Validator::Base
+      def validator
+        @validator ||= W3CValidators::MarkupValidator.new
+      end
+      
+      def doctype
+        configuration.doctype || "HTML 4.01 Transitional"
+      end
+      
+      def validate(filename=nil)
+        @path = filename || path
+        $stdout.print "   #{display_path}  validating . . . "
+        
+        validator.set_doctype!(doctype)
+
+        results = validator.validate_file(path)
+        
+        @errors = results.errors
+        
+        if valid?
+          $stdout.puts "OK"
+        else
+          $stdout.puts "validation errors"
+          display_errors
+        end
+        
+        valid?
+      end
+    end
+  end
+end

data/lib/epic/validator/javascript.rb

@@ -0,0 +1,82 @@
+module Epic #:nodoc:
+  module Validator #:nodoc
+    class JavaScript < Epic::Validator::Base
+      def jslint_settings
+        configuration.jslint_settings.to_s
+      end
+      
+      def jslint_settings_count
+        jslint_settings.split("\n").size
+      end
+      
+      def pre_process(content)
+        jslint_settings + content
+      end
+      
+      def js_fragment_path
+        File.expand_path("#{tmp_path}/#{File.basename(path)}_fragment")
+      end
+
+      def jslint_path
+        jslint_path = File.expand_path("#{vendor_path}/ext/jslint.js")
+        raise "#{jslint_path} does not exist" unless File.exists?(jslint_path)
+        jslint_path
+      end
+      
+      def rhino_path
+        rhino_path = File.expand_path("#{vendor_path}/ext/js.jar")
+        raise "#{rhino_path} does not exist" unless File.exists?(rhino_path)
+        rhino_path
+      end
+      
+      def vendor_path
+        File.join(File.dirname(__FILE__), "..", "..", "..", "vendor")
+      end
+      
+      def valid_results?(results)
+        fragment_display_path = display_path(js_fragment_path)
+        unless results =~ /jslint: No problems 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)
+        
+              errors << error
+            end
+          end
+        end
+        errors.length <= 0
+      end
+      
+      def validate_path
+        raw_output = File.read(path)        
+        output = pre_process(raw_output)
+        
+        FileUtils.mkdir_p(tmp_path)
+        
+        File.open(js_fragment_path,'w') do |f|
+          f.puts output
+        end
+
+        F.execute("java -jar #{rhino_path} #{jslint_path} #{js_fragment_path}", :return => true)
+      end
+      
+      def validate(filename=nil)
+        @path = filename || path
+        $stdout.print "   #{display_path}  validating . . . "
+        
+        results = validate_path
+        
+        if valid_results?(results)
+          $stdout.puts "OK"
+        else
+          $stdout.puts "errors found!"
+          display_errors
+        end
+        
+        errors.length <= 0
+      end
+    end
+  end
+end

data/lib/epic/validator/json.rb

@@ -0,0 +1,13 @@
+module Epic #:nodoc:
+  module Validator #:nodoc    
+    class JSON < JavaScript
+      def pre_process(output)
+        output
+      end
+      
+      def jslint_settings
+        ""
+      end
+    end
+  end
+end

data/lib/epic/validator/stylesheet.rb

@@ -0,0 +1,9 @@
+module Epic #:nodoc:
+  module Validator #:nodoc
+    class Stylesheet < Base
+      def validate(path=nil)
+        true
+      end
+    end
+  end
+end

data/spec/compressor_spec.rb

@@ -11,7 +11,7 @@ describe "Compressor" do
       File.stub!(:exists?).with(/file.js/).and_return(true)
       @file = "compressed file"
       File.stub(:read).and_return(@file)
-      Epic::Compressor::Base.compress("file.js", "type" => "js").should == @file
+      Epic::Compressor.new("file.js").compress.should == @file
     end
     
     describe "generate a compressed file if one doesn't exist" do
@@ -22,47 +22,47 @@ describe "Compressor" do
       
       it "should log what it's doing" do
         $stdout.should_receive(:print).with(/file.js  compressing . . ./)
-        Epic::Compressor::Base.compress("file.js", "type" => "js")
+        Epic::Compressor.new("file.js").compress
       end
       
       it "should run the compressor" do
         F.should_receive(:execute).with(/yuicompressor/, :return => true).and_return("")
-        Epic::Compressor::Base.compress("file.js", "type" => "js")
+        Epic::Compressor.new("file.js").compress
       end
       
       describe "options" do
         it "should set nomunge" do
           F.should_receive(:execute).with(/nomunge/, :return => true).and_return("")
-          Epic::Compressor::Base.compress("file.js", "type" => "js", "obfuscate" => true)
+          Epic::Compressor.new("file.js").compress("obfuscate" => true)
         end
       
         it "should not set nomunge" do
           F.stub!(:execute).with(/yuicompressor/, :return => true).and_return("")
           F.should_not_receive(:execute).with(/nomunge/, :return => true).and_return("")
-          Epic::Compressor::Base.compress("file.js", "type" => "js", "obfuscate" => false)
+          Epic::Compressor.new("file.js").compress("obfuscate" => false)
         end
       
         it "should set verbose" do
           F.should_receive(:execute).with(/verbose/, :return => true).and_return("")
-          Epic::Compressor::Base.compress("file.js", "type" => "js", "verbose" => true)
+          Epic::Compressor.new("file.js").compress("verbose" => true)
         end
       
         it "should not set verbose" do
           F.stub!(:execute).with(/yuicompressor/, :return => true).and_return("")
           F.should_not_receive(:execute).with(/verbose/, :return => true).and_return("")
-          Epic::Compressor::Base.compress("file.js", "type" => "js", "verbose" => false)
+          Epic::Compressor.new("file.js").compress("verbose" => false)
         end
       
         it "should set preserve-semi on javascript" do
           F.should_receive(:execute).with(/preserve-semi/, :return => true).and_return("")
-          Epic::Compressor::Base.compress("file.js", "type" => "js")
+          Epic::Compressor.new("file.js").compress
         end
       
         it "should not set preserve-semi on css" do
           File.stub!(:exists?).with(/file.css/).and_return(true)
           F.stub!(:execute).with(/yuicompressor/, :return => true).and_return("")
           F.should_not_receive(:execute).with(/preserve-semi/, :return => true).and_return("")
-          Epic::Compressor::Base.compress("file.css", "type" => "css")
+          Epic::Compressor.new("file.css").compress
         end
       end
       
@@ -73,55 +73,22 @@ describe "Compressor" do
         
         it "should raise an exception" do
           lambda {
-            Epic::Compressor::Base.compress("file.js", "type" => "js")
-          }.should raise_error(/JavaScript errors/)
-        end
-        
-        it "should growl" do
-          @g.should_receive(:notify)
-          lambda {
-            Epic::Compressor::Base.compress("file.js", "type" => "js")
+            Epic::Compressor.new("file.js").compress
           }.should raise_error(/JavaScript errors/)
         end
         
         it "should show the source code" do
           F.should_receive(:get_line_from_file).with("file.js", 12).and_return("")
           lambda {
-            Epic::Compressor::Base.compress("file.js", "type" => "js")
+            Epic::Compressor.new("file.js").compress
           }.should raise_error(/JavaScript errors/)
         end
       end
       
       it "should report OK" do
         $stdout.should_receive(:puts).with("OK")
-        Epic::Compressor::Base.compress("file.js", "type" => "js")
+        Epic::Compressor.new("file.js").compress
       end
-      
-      it "should raise an error if the compressed file doesn't exist" do
-        # File.stub!(:exists?).with(/file.js/).and_return(true)
-        # File.stub!(:exists?).with(/file.js.min/).and_return(false)
-        # lambda {
-          Epic::Compressor::Base.compress("file.js", "type" => "js")
-        # }.should raise_error(/File does not exist/)
-      end
-    end
-  end
-  
-  describe "JavaScript" do
-    it "should call Base with type js" do
-      File.stub(:exists?).with(/file.js/).and_return(true)
-      @file = "compressed file"
-      File.stub(:read).and_return(@file)
-      Epic::Compressor::JavaScript.compress("file.js").should == @file
-    end
-  end
-  
-  describe "Stylesheet" do
-    it "should call Base with type css" do
-      File.stub(:exists?).with(/file.css/).and_return(true)
-      @file = "compressed file"
-      File.stub(:read).and_return(@file)
-      Epic::Compressor::Stylesheet.compress("file.css").should == @file
     end
   end
 end

data/spec/{epic_spec.rb → validator_spec.rb}

@@ -40,6 +40,18 @@ describe "Validator" do
       Epic::Validator::HTML.new.validate("path")
     end
     
+    describe "new syntax" do
+      it "should call validator" do
+        W3CValidators::MarkupValidator.should_receive(:new).and_return(@validator)
+        Epic::Validator::HTML.new("path").validate
+      end
+    
+      it "should print OK" do
+        $stdout.should_receive(:puts).with(/OK/)
+        Epic::Validator::HTML.new("path").validate
+      end
+    end
+    
     describe "errors" do
       before(:each) do
         class ResultsMock
@@ -70,6 +82,17 @@ describe "Validator" do
         $stdout.should_receive(:puts).with("validation errors")
         Epic::Validator::HTML.new.validate("path")
       end
+      
+      describe "new syntax" do
+        it "should be false" do
+          Epic::Validator::HTML.new("path").validate.should be_false
+        end
+      
+        it "should output a message" do
+          $stdout.should_receive(:puts).with("validation errors")
+          Epic::Validator::HTML.new("path").validate
+        end
+      end
     end
   end
   
@@ -91,6 +114,20 @@ describe "Validator" do
         @file.should_receive(:puts).with(@jslint_settings)
         Epic::Validator::JavaScript.new.validate("path")
       end
+      
+      describe "new syntax" do
+        it "should set jslint settings" do
+          Epic::Base.configure do |config|
+            config.jslint_settings = @jslint_settings
+          end
+          Epic::Validator::JavaScript.new("path").jslint_settings.should == @jslint_settings
+        end
+      
+        it "should put jslint settings in the file" do
+          @file.should_receive(:puts).with(@jslint_settings)
+          Epic::Validator::JavaScript.new("path").validate
+        end
+      end
     end
     
     describe "valid" do
@@ -115,25 +152,14 @@ describe "Validator" do
         F.stub!(:get_line_from_file).with(anything, 5)
       end
       
-      it "should growl" do
-        @g.should_receive(:notify).with(anything, anything, /JavaScript Errors/, anything, anything)
-        lambda {
-          Epic::Validator::JavaScript.new.validate("path")
-        }.should raise_error
-      end
-      
       it "should output errors" do
         $stdout.should_receive(:puts).with(/Unnecessary semicolon/)
         $stdout.should_receive(:puts).with(/Unknown thingamajig/)
-        lambda {
-          Epic::Validator::JavaScript.new.validate("path")
-        }.should raise_error
+        Epic::Validator::JavaScript.new.validate("path").should be_false
       end
       
-      it "should raise error" do
-        lambda {
-          Epic::Validator::JavaScript.new.validate("path")
-        }.should raise_error(/JavaScript Errors/)
+      it "should be false" do
+        Epic::Validator::JavaScript.new.validate("path").should be_false
       end
     end
   end
@@ -161,25 +187,14 @@ describe "Validator" do
         F.stub!(:get_line_from_file).with(anything, 5)
       end
       
-      it "should growl" do
-        @g.should_receive(:notify).with(anything, anything, /JavaScript Errors/, anything, anything)
-        lambda {
-          Epic::Validator::JSON.new.validate("path")
-        }.should raise_error
-      end
-      
       it "should output errors" do
         $stdout.should_receive(:puts).with(/Unnecessary semicolon/)
         $stdout.should_receive(:puts).with(/Unknown thingamajig/)
-        lambda {
-          Epic::Validator::JSON.new.validate("path")
-        }.should raise_error
+        Epic::Validator::JSON.new.validate("path").should be_false
       end
       
-      it "should raise error" do
-        lambda {
-          Epic::Validator::JSON.new.validate("path")
-        }.should raise_error(/JavaScript Errors/)
+      it "should return false" do
+        Epic::Validator::JSON.new.validate("path").should be_false
       end
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: epic
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jeff Coleman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-25 00:00:00 -06:00
+date: 2010-01-30 00:00:00 -06:00
 default_executable: epic
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,15 +62,36 @@ files:
 - VERSION
 - bin/epic
 - epic.gemspec
+- features/compressor.feature
+- features/data/html/invalid.html
+- features/data/html/valid.html
+- features/data/javascripts/invalid.js
+- features/data/javascripts/invalid_uncompressed.js
+- features/data/javascripts/pre_compressed.js
+- features/data/javascripts/pre_compressed.js.min
+- features/data/javascripts/valid.js
+- features/data/javascripts/valid_uncompressed.js
+- features/data/stylesheets/valid.css
+- features/step_definitions/compressor_steps.rb
+- features/step_definitions/file_steps.rb
+- features/step_definitions/validator_steps.rb
+- features/support/env.rb
+- features/validator.feature
 - lib/epic.rb
 - lib/epic/base.rb
 - lib/epic/compressor.rb
+- lib/epic/errors.rb
 - lib/epic/validator.rb
+- lib/epic/validator/base.rb
+- lib/epic/validator/html.rb
+- lib/epic/validator/javascript.rb
+- lib/epic/validator/json.rb
+- lib/epic/validator/stylesheet.rb
 - spec/compressor_spec.rb
-- spec/epic_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/stubs.rb
+- spec/validator_spec.rb
 - vendor/ext/js.jar
 - vendor/ext/jslint.js
 - vendor/ext/yuicompressor-2.4.2.jar
@@ -104,6 +125,6 @@ specification_version: 3
 summary: Epic validation of HTML, JavaScript and CSS
 test_files: 
 - spec/compressor_spec.rb
-- spec/epic_spec.rb
 - spec/spec_helper.rb
 - spec/stubs.rb
+- spec/validator_spec.rb