jslint-johnson 1.0.0 → 1.0.1

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem "johnson", "~> 1.2.0"
+gem "rake", "~> 0.8.7"
+gem "jeweler", "~> 1.5.0"

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    johnson (1.2.0)
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.5.0)
+  johnson (~> 1.2.0)
+  rake (~> 0.8.7)

data/lib/jslint-johnson.rb

@@ -0,0 +1,6 @@
+module JSLintJohnson end
+
+require File.expand_path("jslint-johnson/runner", File.dirname(__FILE__))
+require File.expand_path("jslint-johnson/lint_error", File.dirname(__FILE__))
+require File.expand_path("jslint-johnson/rake_task", File.dirname(__FILE__))
+require File.expand_path("jslint-johnson/formatter", File.dirname(__FILE__))

data/lib/jslint-johnson/formatter.rb

@@ -0,0 +1,46 @@
+
+module JSLintJohnson
+  class Formatter
+    attr_reader :output_stream
+
+    def initialize(stream)
+      @output_stream = stream
+    end
+
+    def tick(errors)
+      output_stream.print(errors.any?? "*" : ".")
+    end
+
+    def summary(tested_files, lint_result)
+      if lint_result.keys.any?
+        print_error_summary(lint_result)
+        output_stream.print "\n"
+      end
+      
+      print_count_summary(tested_files, lint_result)
+    end
+
+  private
+    def print_error_summary(result) 
+      out = output_stream
+
+      out.print "\nFailures:\n\n"
+
+      result.each do |file, errors|
+        out.print "#{file}:\n"
+        errors.each do |error|
+          out.print "   line #{error.line_number} character #{error.character} #{error.reason}\n"
+        end
+      end
+    end
+
+    def print_count_summary(tested_files, lint_result)
+      file_count = tested_files.length
+      failure_count = lint_result.keys.length
+      error_count = lint_result.values.flatten.length
+
+      output_stream.print "#{file_count} files, #{failure_count} failures, #{error_count} errors\n"
+    end
+
+  end
+end

data/lib/jslint-johnson/lint_error.rb

@@ -0,0 +1,14 @@
+
+module JSLintJohnson
+  class LintError
+    attr_reader :line_number, :character, :reason, :evidence
+  
+    def initialize(jsobject)
+      @line_number = jsobject["line"]
+      @character = jsobject["character"]
+      @reason = jsobject["reason"]
+      @evidence = jsobject["evidence"]
+    end
+
+  end
+end

data/lib/jslint-johnson/rake_task.rb

@@ -0,0 +1,76 @@
+require 'rake'
+require 'rake/tasklib'
+
+module JSLintJohnson
+  class RakeTask < ::Rake::TaskLib
+    # name of the rake task
+    attr_accessor :name
+
+    # description for the task
+    attr_accessor :description
+
+    # inclusion glob pattern for files
+    attr_accessor :include_pattern
+
+    # exclusion glob pattern for files
+    attr_accessor :exclude_pattern
+
+    # output stream for this task
+    attr_accessor :output_stream
+
+    def initialize
+      # a default name
+      @name = "lint"
+      
+      # a default description
+      @description = "Runs the JSLint Test Suite"
+
+      # by default a glob pattern that will include javascript files found in rails
+      @include_pattern = "app/javascripts/**/*.js"
+
+      # by default a glob pattern which will match no files
+      @exclude_pattern = ""
+
+      # by default use standard output for writing information
+      @output_stream = STDOUT
+
+      # if a block was given allow the block to call elements on this object
+      yield self if block_given?
+
+      # create the rake task
+      new_task = task(name) do
+        formatter = JSLintJohnson::Formatter.new(output_stream)
+
+        lint_result = runner.run do |file, errors|
+          formatter.tick(errors)
+        end
+
+        # put a separator line in between the ticks and any summary
+        output_stream.print "\n"
+
+        # print a summary of failed files
+        formatter.summary(files_to_run, lint_result)
+      end
+      
+      # assign the description to the rake task
+      new_task.comment = description
+    end
+
+    #
+    # Returns a list of all files to run, sorted
+    #
+    def files_to_run
+      included_files = Dir.glob(include_pattern)
+      excluded_files = Dir.glob(exclude_pattern)
+
+      (included_files - excluded_files).sort
+    end
+
+  private
+    
+    def runner
+      JSLintJohnson::Runner.new(files_to_run)
+    end
+
+  end
+end

data/lib/jslint-johnson/runner.rb

@@ -0,0 +1,83 @@
+require 'johnson'
+
+module JSLintJohnson
+  class Runner
+    JSLintLibraryFilename = File.expand_path("js/jslint.js", File.dirname(__FILE__))
+
+    attr_reader :file_list
+
+    def initialize(files)
+      if(files.is_a?(Array))
+        @file_list = files
+      else
+        @file_list = [files]
+      end
+
+    end
+
+    def run
+      # make sure all files exit
+      file_list.each do |file|
+        raise "file not found: #{file}" unless File.exist?(file)
+      end
+
+      result = {}
+
+      file_list.each do |file|
+        errors = jslint(File.read(file))
+
+        yield(file, errors) if block_given?
+
+        next if errors.empty?
+
+        result[file] = errors
+      end
+
+      result
+    end
+
+    def runtime
+      @runtime ||= lambda do
+        runtime = Johnson::Runtime.new
+
+        # load the jslint library into the runtime
+        runtime.evaluate("eval(Ruby.File.read('#{JSLintLibraryFilename}'));")
+
+        # return the runtime
+        runtime
+      end.call
+    end
+
+    def jslint(source_code)
+      jslint_function.call(source_code, jslint_options)
+      jslint_result
+    end
+
+    def jslint_function
+      runtime["JSLINT"];
+    end
+
+    def jslint_result
+      runtime["JSLINT"]["errors"].to_a.map do |error_object|
+        JSLintJohnson::LintError.new(error_object)
+      end
+    end
+
+    def jslint_options
+      {
+        "bitwise" => true,
+        "eqeqeq" => true,
+        "immed" => true,
+        "newcap" => true,
+        "nomen" => true,
+        "onevar" => true,
+        "plusplus" => true,
+        "regexp" => true,
+        "rhino" => true,
+        "undef" => true,
+        "white" => true
+      }
+    end
+
+  end
+end

data/lib/jslint-johnson/version.rb

@@ -0,0 +1,11 @@
+
+module JSLintJohnson
+  module Version
+     MAJOR = 1
+     MINOR = 0
+     PATCH = 1
+     BUILD = nil
+    
+     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jslint-johnson
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - William Howard
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-28 00:00:00 +02:00
+date: 2011-06-29 00:00:00 +02:00
 default_executable: jslint-johnson
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,9 +51,25 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: johnson
+  name: jeweler
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: johnson
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,7 +81,7 @@ dependencies:
         - 0
         version: 1.2.0
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 description: "    - Ruby gem wrapper for a JSLint CLI.\n    - Uses the Johnson library for performance.\n    - Targeted for usage in CI environments.\n    - Thoroughly tested.\n"
 email: whoward.tke@gmail.com
 executables: 
@@ -75,6 +91,15 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- Gemfile
+- Gemfile.lock
+- bin/jslint-johnson
+- lib/jslint-johnson.rb
+- lib/jslint-johnson/formatter.rb
+- lib/jslint-johnson/lint_error.rb
+- lib/jslint-johnson/rake_task.rb
+- lib/jslint-johnson/runner.rb
+- lib/jslint-johnson/version.rb
 - test/helper.rb
 - test/suite.rb
 - test/test_cli.rb
@@ -82,7 +107,6 @@ files:
 - test/test_lint_error.rb
 - test/test_runner.rb
 - test/test_task.rb
-- bin/jslint-johnson
 has_rdoc: true
 homepage: http://github.com/whoward/jslint-johnson
 licenses: []