jshintrb 0.0.1 → 0.1.0

data/README.md

@@ -1,7 +1,7 @@
 # jshintrb
 [![Build Status](https://secure.travis-ci.org/stereobooster/jshintrb.png?branch=master)](http://travis-ci.org/stereobooster/jshintrb)
 
-Ruby wrapper for [JSHint](https://github.com/jshint/jshint/). The main difference from [jshint](https://github.com/liquid/jshint_on_rails) it does not depend on Java. Instead, it uses [ExecJS](https://github.com/sstephenson/execjs).
+Ruby wrapper for [JSHint](https://github.com/jshint/jshint/). The main difference from [jshint](https://github.com/liquid/jshint_on_rails) it does not depend on Java. Instead it uses [ExecJS](https://github.com/sstephenson/execjs).
 
 ## Installation
 
@@ -13,45 +13,61 @@ Ensure that your environment has a JavaScript interpreter supported by [ExecJS](
 
 ## Usage
 
-    require 'jshintrb'
-
-    Jshintrb.lint(File.read("source.js"))
-    # => array of warnings
-
-    Jshintrb.report(File.read("source.js"))
-    # => string
-
-When initializing jshintrb, you can pass options
-
-    Uglifier.new(:undef => true).compile(source)
-
-    # Or
-    Uglifier.compile(source, :undef => true)
-
-Available options and their defaults are
-
-    {
-      :bitwise => true,
-      :curly => true,
-      :eqeqeq => true,
-      :forin => true,
-      :immed => true,
-      :latedef => true,
-      :newcap => true,
-      :noarg => true,
-      :noempty => true,
-      :nonew => true,
-      :plusplus => true,
-      :regexp => true,
-      :undef => true,
-      :strict => true,
-      :trailing => true,
-      :browser => true
-    }
+```ruby
+require 'jshintrb'
+
+Jshintrb.lint(File.read("source.js"))
+# => array of warnings
+
+Jshintrb.report(File.read("source.js"))
+# => string
+```
+
+Or you can use it with rake
+
+```ruby
+require "jshintrb/jshinttask"
+Jshintrb::JshintTask.new :jshint do |t|
+  t.pattern = 'javascript/**/*.js'
+  t.options = :defaults
+end
+```
+
+When initializing `Jshintrb`, you can pass options
+
+```ruby
+Jshintrb.new(:undef => true).compile(source)
+# Or
+Jshintrb.compile(source, :undef => true)
+```
+
+[List of all available options](http://www.jshint.com/options/)
+
+If you pass `:defaults` as option, it is the same as if you pass following
+
+```
+{
+  :bitwise => true,
+  :curly => true,
+  :eqeqeq => true,
+  :forin => true,
+  :immed => true,
+  :latedef => true,
+  :newcap => true,
+  :noarg => true,
+  :noempty => true,
+  :nonew => true,
+  :plusplus => true,
+  :regexp => true,
+  :undef => true,
+  :strict => true,
+  :trailing => true,
+  :browser => true
+}
+```
 
 ## TODO
 
- - add rake task which will accept pattern for files
- - add color reporter
  - add more tests
-
+ - add color reporter
+ - add cli

data/Rakefile

@@ -11,8 +11,6 @@ task :git do
 end
 
 require "rspec/core/rake_task"
-
-desc "Run specs"
 RSpec::Core::RakeTask.new
 
 task :default => :spec
@@ -22,3 +20,9 @@ task :default => :spec
   # t.rcov = true
   # t.rcov_opts = ["--exclude", "spec"]
 # end
+
+require "./lib/jshintrb/jshinttask"
+Jshintrb::JshintTask.new :jshint do |t|
+  t.pattern = 'vendor/jshint/tests/unit/fixtures/*.js'
+  t.options = :defaults
+end

data/jshintrb.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["stereobooster@gmail.com"]
   s.homepage    = "https://github.com/stereobooster/jshintrb"
   s.summary     = %q{Ruby wrapper for JSHint}
-  s.description = %q{Ruby wrapper for JSHint. The main difference from jshint it does not depend on Java. Instead, it uses ExecJS}
+  s.description = %q{Ruby wrapper for JSHint. The main difference from jshint gem it does not depend on Java. Instead, it uses ExecJS}
 
   s.rubyforge_project = "jshintrb"
 

data/lib/jshintrb/jshinttask.rb

@@ -0,0 +1,76 @@
+# Define a task library for running JSHint contexts.
+
+require 'rake'
+require 'rake/tasklib'
+
+require 'jshintrb'
+
+module Jshintrb
+
+  class JshintTask < ::Rake::TaskLib
+    # Name of JSHint task. (default is :jshint)
+    attr_accessor :name
+
+    # Glob pattern to match JavaScript files. (default is './**/*.js')
+    attr_accessor :pattern
+
+    # options
+    attr_accessor :options
+
+    # Whether or not to fail Rake when an error occurs (typically when Jshint check fail).
+    # Defaults to true.
+    attr_accessor :fail_on_error
+
+    # Explicitly define the list of JavaScript files to be linted.
+    # +js_files+ is expected to be an array of file names (a
+    # FileList is acceptable).  If both +pattern+ and +js_files+ are
+    # used, then the list of JavaScritp files is the union of the two.
+    attr_accessor :js_files
+
+    # Defines a new task, using the name +name+.
+    def initialize(name=:jshint)
+      @name = name
+      @pattern = nil
+      @js_files = nil
+      @options = nil
+      @fail_on_error = true
+
+      yield self if block_given?
+      @pattern = './**/*.js' if pattern.nil? && js_files.nil?
+      define
+    end
+
+    def define # :nodoc:
+
+      actual_name = Hash === name ? name.keys.first : name
+      unless ::Rake.application.last_comment
+        desc "Run JShint"
+      end
+      task name do
+        unless js_file_list.empty?
+          result = Jshintrb::report(js_file_list, @options, STDERR)
+          if result.size > 0
+            abort("JSHint check failed") if fail_on_error
+          end
+        end
+      end
+
+      self
+    end
+
+    def evaluate(o) # :nodoc:
+      case o
+        when Proc then o.call
+        else o
+      end
+    end
+
+    def js_file_list # :nodoc:
+        result = []
+        result += js_files.to_a if js_files
+        result += FileList[ pattern ].to_a if pattern
+        FileList[result]
+    end
+  end
+
+end

data/lib/jshintrb/lint.rb

@@ -32,13 +32,15 @@ module Jshintrb
 
     def initialize(options = nil)
 
-      if options.nil? then
+      if options == :defaults then
         @options = DEFAULTS.dup
       elsif options.instance_of? Hash then
         @options = options.dup
         # @options = DEFAULTS.merge(options)
+      elsif options.nil?
+        @options = nil
       else
-        raise ArgumentError
+        raise 'Unsupported option for Jshintrb: ' + options.to_s
       end
 
       @context = ExecJS.compile(File.open(SourcePath, "r:UTF-8").read)
@@ -48,7 +50,11 @@ module Jshintrb
       source = source.respond_to?(:read) ? source.read : source.to_s
 
       js = []
-      js << "JSHINT(#{MultiJson.encode(source)}, #{MultiJson.encode(@options)});"
+      if @options.nil? then
+        js << "JSHINT(#{MultiJson.encode(source)});"
+      else
+        js << "JSHINT(#{MultiJson.encode(source)}, #{MultiJson.encode(@options)});"
+      end
       js << "return JSHINT.errors;"
 
       @context.exec js.join("\n")

data/lib/jshintrb/reporter/default.rb

@@ -2,12 +2,26 @@ module Jshintrb
   module Reporter
     class Default
 
-      def format errors
+      def format errors, file
         result = ''
-        errors.each do | error |
-          result += 'line ' + error["line"].to_s + ', col ' +
-            error["character"].to_s + ', ' + error["reason"].to_s + '\n'
+        indent = ''
+        if file then
+          indent = '  '
         end
+
+        errors.each do |error|
+          if error.nil? then
+            result += indent + 'fatal error'
+          else
+            result += indent + 'line ' + error["line"].to_s + ', col ' +
+              error["character"].to_s + ', ' + error["reason"].to_s + "\n"
+          end
+        end
+
+        if file && result.size > 0 then
+          result = 'file: ' + file + "\n" + result
+        end
+
         result
       end
 

data/lib/jshintrb/version.rb

@@ -1,3 +1,3 @@
 module Jshintrb
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/jshintrb.rb

@@ -10,10 +10,31 @@ module Jshintrb
     Lint.new(options).lint(source)
   end
 
-  def self.report(source, options = nil)
-    reporter = Reporter::Default
-    errors = Lint.new(options).lint(source)
-    reporter.new.format errors
+  def self.report(source, options = nil, out = nil)
+    reporter = Reporter::Default.new
+    linter = Lint.new(options)
+    report = ''
+    if source.is_a?(Array) then
+      source.each do |src|
+        if !src.is_a?(String) then
+          p src.to_s
+          raise ('Expected array of strings. Instead get ' + src.class.to_s)
+        end
+        errors = linter.lint(File.read(src))
+        rep = reporter.format errors, src
+        if out && rep.size > 0 then
+          out.puts rep
+        end
+        report += rep
+      end
+    else
+      errors = linter.lint(source)
+      report = reporter.format errors
+      if out then
+        out.puts report
+      end
+    end
+    report
   end
 
 end

data/spec/jshintrb_spec.rb

@@ -1,6 +1,10 @@
 # encoding: UTF-8
 require "jshintrb"
 
+def gen_file source, option, value
+  "/*jshint " + option.to_s + ": " + value.to_s + "*/\n" + source
+end
+
 describe "Jshintrb" do
   
   it "support options" do
@@ -28,6 +32,10 @@ describe "Jshintrb" do
       Jshintrb.lint(source, option => true).length.should eq 1
     end
 
+    options.each do |option, source|
+      Jshintrb.lint(gen_file(source, option, false)).length.should eq 0
+      Jshintrb.lint(gen_file(source, option, true)).length.should eq 1
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jshintrb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &21167640 !ruby/object:Gem::Requirement
+  requirement: &21721428 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21167640
+  version_requirements: *21721428
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21167352 !ruby/object:Gem::Requirement
+  requirement: &21721056 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21167352
+  version_requirements: *21721056
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &21167100 !ruby/object:Gem::Requirement
+  requirement: &21720636 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21167100
+  version_requirements: *21720636
 - !ruby/object:Gem::Dependency
   name: execjs
-  requirement: &21166800 !ruby/object:Gem::Requirement
+  requirement: &21720024 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,9 +54,9 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21166800
-description: Ruby wrapper for JSHint. The main difference from jshint it does not
-  depend on Java. Instead, it uses ExecJS
+  version_requirements: *21720024
+description: Ruby wrapper for JSHint. The main difference from jshint gem it does
+  not depend on Java. Instead, it uses ExecJS
 email:
 - stereobooster@gmail.com
 executables: []
@@ -72,6 +72,7 @@ files:
 - jshintrb.gemspec
 - lib/js/jshint.js
 - lib/jshintrb.rb
+- lib/jshintrb/jshinttask.rb
 - lib/jshintrb/lint.rb
 - lib/jshintrb/reporter/default.rb
 - lib/jshintrb/version.rb