jshint4r 0.1.0

data/.document

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

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/jshint"]
+	path = vendor/jshint
+	url = https://github.com/jshint/jshint.git

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'execjs'
+gem 'rake'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec"
+  gem "bundler"
+  gem "jeweler"
+  gem "rcov"
+  gem 'rdoc'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 wtnabe
+
+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,19 @@
+= jshint4r
+
+Description goes here.
+
+== Contributing to jshint4r
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 wtnabe. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+Dir.glob( File.dirname(__FILE__) + '/lib/tasks/*.rake' ) { |f|
+  load f
+}
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "jshint4r"
+  gem.homepage = "http://github.com/wtnabe/jshint4r"
+  gem.license = "MIT"
+  gem.summary = %Q{jshint4r}
+  gem.description = %Q{jshint runner for ruby}
+  gem.email = "wtnabe@gmail.com"
+  gem.authors = ["wtnabe"]
+  gem.files.include Dir.glob('vendor/jshint/*')
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jshint4r #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/jshint4r

@@ -0,0 +1,8 @@
+#! /usr/bin/env ruby
+
+unless ( ENV['PATH'].split( File::PATH_SEPARATOR ).include?( File.dirname( __FILE__ ) ) )
+  $LOAD_PATH << File.expand_path( "../lib", File.dirname( __FILE__ ) )
+end
+
+require 'jshint4r'
+JSHint4r::CLI.run

data/lib/jshint4r/cli.rb

@@ -0,0 +1,78 @@
+require 'optparse'
+
+module JSHint4r
+  class CLI
+    def self.run
+      self.new.run
+    end
+
+    def run
+      paths = args.permute( ARGV )
+      l     = Linter.new( Source.context, config.opts )
+      r     = JSHint4r.reporter( config.reporter )
+      targets( paths ).each { |f|
+        s = r.report( f, l.lint( f ), config.verbose )
+        puts s if s
+      }
+    end
+
+    #
+    # [param]  String path
+    # [return] JSHint4r::Config
+    #
+    def config( path = nil )
+      if ( !@config )
+        @config = Config.new( path )
+      end
+
+      @config
+    end
+
+    #
+    # [param]  Array path
+    # [return] JSHint4r::Target
+    #
+    def targets( paths )
+      Target.new( config.targets + paths || [], config.excludes.uniq )
+    end
+
+    #
+    # [return] OptionParser
+    #
+    def args
+      opts = OptionParser.new { |opt|
+        opt.banner = 'Usage: jshint4r [options] path1 path2 ...'
+        opt.on( '-c', '--config PATH' ) { |path|
+          if File.exist?( path )
+            config( path )
+          end
+        }
+        opt.on( '-e', '--exclude PATH' ) { |path|
+          config.excludes = path
+        }
+        opt.on( '-o', '--options KEY=VALUE' ) { |opt|
+          o = opt.split('=', 2)
+          if o.size == 2
+            config.opts = { o[0] => o[1] }
+          end
+        }
+        opt.on( '-r', '--reporter REPORTER' ) { |reporter|
+          config.reporter = reporter
+        }
+        opt.on( '-V', '--verbose' ) {
+          config.verbose = true
+        }
+        opt.on( '-s', '--silent' ) {
+          config.verbose = false
+        }
+      }
+
+      if ARGV.size == 0
+        puts opts.help
+        exit
+      else
+        opts
+      end
+    end
+  end
+end

data/lib/jshint4r/config.rb

@@ -0,0 +1,67 @@
+module JSHint4r
+  class Config
+    def initialize( path = nil )
+      @excludes = []
+      @opts     = {}
+      @path     = nil
+      @reporter = :text
+      @targets  = []
+      @verbose  = false
+
+      if path and read_config_file( path )
+        @path = path
+      end
+    end
+    attr_reader   :excludes, :opts, :targets, :path
+    attr_accessor :reporter, :verbose
+
+    #
+    # [param]  String  path
+    # [return] Boolean
+    #
+    def read_config_file( path )
+      r = false
+
+      if File.exist?( path )
+        conf = YAML.load_file( path )
+        if ( conf.is_a? Hash )
+          self.excludes = conf['excludes'] if conf.has_key? 'excludes'
+          self.opts     = conf['options']  if conf.has_key? 'options'
+          self.reporter = conf['reporter'] if conf.has_key? 'reporter'
+          self.targets  = conf['src']      if conf.has_key? 'src'
+          self.verbose  = conf['verbose']  if conf.has_key? 'verbose'
+
+          r = true
+        end
+      end
+
+      return r
+    end
+
+    #
+    # [param]  Objecte ex
+    # [return] Array
+    #
+    def excludes=( ex )
+      ex = [ex] unless ex.is_a? Array
+      @excludes += ex
+    end
+
+    #
+    # [param]  Hash opts
+    # [return] Hash
+    #
+    def opts=( opts )
+      @opts.merge!( opts )
+    end
+
+    #
+    # [param]  Object t
+    # [return] Array
+    #
+    def targets=( t )
+      t = [t] unless t.is_a? Array
+      @targets += t
+    end
+  end
+end

data/lib/jshint4r/jshint_runner.js

@@ -0,0 +1,5 @@
+JSHINT.run = function( src, options ) {
+  if ( !JSHINT( src, options ) ) {
+    return JSHINT.errors;
+  }
+};

data/lib/jshint4r/linter.rb

@@ -0,0 +1,21 @@
+module JSHint4r
+  class Linter
+    #
+    # [param] ExecJS::*::Context context
+    # [param] Hash opts
+    #
+    def initialize( context, opts = nil )
+      @context = context
+      @opts    = opts || {}
+    end
+    attr_reader :context, :opts
+
+    #
+    # [param]  File
+    # [return] Array or nil
+    #
+    def lint( target )
+      context.call('JSHINT.run', File.read(target), opts )
+    end
+  end
+end

data/lib/jshint4r/reporter/compilation.rb

@@ -0,0 +1,25 @@
+module JSHint4r
+  module Reporter
+    class Compilation
+      include Reporter
+
+      #
+      # [param]  String target
+      # [param]  Array  errors
+      # [return] String or nil
+      #
+      def report( target, errors, verbose = false )
+        if errors and errors.size > 0
+          errors.map { |error|
+            e = key_symbolize( error )
+            sprintf( "%s:%s:%s: %s\n%s",
+                     target,
+                     e[:line], e[:character], e[:reason], e[:evidence] )
+          }.join("\n") << "\n"
+        elsif verbose
+          sprintf( "%s ... ok\n", target )
+        end
+      end
+    end
+  end
+end

data/lib/jshint4r/reporter/text.rb

@@ -0,0 +1,31 @@
+module JSHint4r
+  module Reporter
+    #
+    # like output of npm's jshint
+    #
+    class Text
+      include Reporter
+
+      #
+      # [param]  String target
+      # [param]  Array  errors
+      # [return] String
+      #
+      def report( target, errors, verbose = false )
+        if errors
+          errors.map { |error|
+            e = key_symbolize( error )
+            sprintf( "%s: line %s, col %s, %s",
+              target, e[:line], e[:character], e[:reason] )
+          }.join("\n") + <<EOD
+
+
+#{errors.size} errors
+EOD
+        elsif verbose
+          sprintf( "%s ... ok\n", target )
+        end
+      end
+    end
+  end
+end

data/lib/jshint4r/reporter.rb

@@ -0,0 +1,19 @@
+module JSHint4r
+  class << self
+    def reporter( reporter = :text )
+      JSHint4r::Reporter.const_get( reporter.to_s.capitalize ).new
+    end
+  end
+
+  module Reporter
+    #
+    # [param]  Hash error
+    # [return] Hash
+    #
+    def key_symbolize( error )
+      Hash[*error.map { |k, v|
+        [k.to_sym, v]
+      }.flatten]
+    end
+  end
+end

data/lib/jshint4r/result.rb

@@ -0,0 +1,18 @@
+module JSHint4r
+  class Result
+    def initialize( target, errors )
+      @target = target
+      @errors = parse( errors )
+    end
+    attr_reader :target, :errors
+
+    #
+    # [param]  String errors
+    # [return] Object
+    #
+    def parse( errors )
+      errors = errors || ''
+      ExecJS.eval( errors )
+    end
+  end
+end

data/lib/jshint4r/source.rb

@@ -0,0 +1,26 @@
+module JSHint4r
+  class Source
+    JSHINT = File.dirname(__FILE__) + '/../../vendor/jshint/jshint.js'
+    RUNNER = File.dirname(__FILE__) + '/jshint_runner.js'
+
+    class << self
+      #
+      # [return] String
+      #
+      def src
+        [JSHINT, RUNNER].map { |f| File.read(f) }.join
+      end
+
+      #
+      # [return] ExecJS::*::Context
+      #
+      def context
+        if ( !@context )
+          @context = ExecJS.compile( src )
+        end
+
+        @context
+      end
+    end
+  end
+end

data/lib/jshint4r/target.rb

@@ -0,0 +1,60 @@
+require 'rake'
+
+module JSHint4r
+  class Target
+    def initialize( targets, excludes = nil )
+      @targets  = targets  || []
+      @excludes = excludes || []
+    end
+    attr_reader :targets, :excludes
+
+    def each( &block )
+      real_targets.each { |f|
+        block.call( f )
+      }
+    end
+
+    #
+    # [return] Rake::FileList
+    #
+    def real_targets
+      if ( !@real_targets )
+        @real_targets = target_files
+      end
+
+      @real_targets
+    end
+
+    protected
+    #
+    # [return] Rake::FileList
+    #
+    def target_files
+      t = clean( FileList[targets] )
+
+      t = FileList[t.select { |e|
+                     e if File.exist?( e )
+                   }.map { |e|
+                     if File.directory?( e )
+                       Dir.glob( File.join( e, '**/*.js' ) )
+                     else
+                       e
+                     end
+                   }.flatten.uniq]
+
+      clean( t )
+    end
+
+    #
+    # [param]  Rake::FileList targets
+    # [return] Rake::FileList
+    #
+    def clean( targets )
+      excludes.each { |ex|
+        targets.exclude( ex )
+      }
+
+      targets
+    end
+  end
+end

data/lib/jshint4r.rb

@@ -0,0 +1,8 @@
+require 'execjs'
+
+module JSHint4r
+end
+
+Dir.glob( File.dirname(__FILE__) + '/jshint4r/**/*.rb' ) { |f|
+  require f
+}

data/lib/tasks/git-untracked.rake

@@ -0,0 +1,6 @@
+namespace :git do
+  desc "list git-untracked files"
+  task :untracked do
+    sh 'git ls-files -o --exclude-from=.gitignore'
+  end
+end

data/spec/fixtures/config.yml

@@ -0,0 +1,9 @@
+src:
+  - spec/fixtures/
+excludes:
+  - '**/no_errors.js'
+verbose: true
+reporter: :compilation
+options: 
+  undef: false
+  asi:   true

data/spec/fixtures/missing_semicolon.js

@@ -0,0 +1 @@
+a = 1

data/spec/fixtures/no_errors.js

@@ -0,0 +1 @@
+a = 1;

data/spec/jshint4r/config_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe JSHint4r::Config do
+  before(:all) {
+    @config = JSHint4r::Config.new( fixture( 'config.yml' ) )
+  }
+
+  describe 'initialize' do
+    context 'with filename' do
+      subject {
+        JSHint4r::Config.new( fixture( 'config.yml' ) ).path
+      }
+      it {
+        should_not be_nil
+      }
+    end
+  end
+
+  describe 'excludes' do
+    subject {
+      @config.excludes
+    }
+    it {
+      should eq(['**/no_errors.js'])
+    }
+  end
+
+  describe 'excludes =' do
+    subject {
+      @config.excludes = 'foobar'
+      @config.excludes
+    }
+    it {
+      should eq( %w( **/no_errors.js foobar ) )
+    }
+  end
+
+  describe 'opts' do
+    subject {
+      @config.opts
+    }
+    it {
+      should eq( 'undef' => false,
+                 'asi'   => true  )
+    }
+  end
+
+  describe 'opts =' do
+    subject {
+      @config.opts = {'laxbreak' => true}
+      @config.opts
+    }
+    it {
+      should eq( 'undef'    => false,
+                 'asi'      => true,
+                 'laxbreak' => true )
+    }
+  end
+
+  describe 'reporter' do
+    subject {
+      @config.reporter
+    }
+    it {
+      should eq(:compilation)
+    }
+  end
+
+  describe 'reporter =' do
+    subject {
+      @config.reporter = :xml
+      @config.reporter
+    }
+    it {
+      should eq(:xml)
+    }
+  end
+
+  describe 'targets' do
+    subject {
+      @config.targets
+    }
+    it {
+      should eq( ['spec/fixtures/'] )
+    }
+  end
+
+  describe 'targets =' do
+    subject {
+      @config.targets = 'vendor/jshint'
+      @config.targets
+    }
+    it {
+      should eq( %w( spec/fixtures/ vendor/jshint ) )
+    }
+  end
+
+  describe 'verbose' do
+    subject {
+      @config.verbose
+    }
+    it {
+      should be_true
+    }
+  end
+
+  describe 'verbose =' do
+    subject {
+      @config.verbose = false
+    }
+    it {
+      should be_false
+    }
+  end
+end

data/spec/jshint4r/linter_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe JSHint4r::Linter do
+  before(:all) {
+    @linter = JSHint4r::Linter.new( JSHint4r::Source.context,
+                                    {'undef' => false,
+                                     'asi'   => false} )
+  }
+
+  describe 'lint' do
+    context 'no errors' do
+      subject {
+        @linter.lint( fixture( 'no_errors.js' ) )
+      }
+      it {
+        should be_nil
+      }
+    end
+    describe 'missing smicolon' do
+      subject {
+        @linter.lint( fixture( 'missing_semicolon.js' ) )
+      }
+      describe 'class Array' do
+        it {
+          subject.class.should eq(Array)
+        }
+      end
+      describe 'Array of one Hash' do
+        it {
+          subject.first.class.should eq(Hash)
+        }
+      end
+    end
+  end
+end
+