jshint_on_rails 1.0.1

data/Changelog.markdown

@@ -0,0 +1,8 @@
+Version 1.0.1 (04.04.2011)
+
+* naming fix in lint.rb
+
+
+Version 1.0.0 (30.03.2011)
+
+* first gem release

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem 'rspec'
+gem 'fakefs'
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    fakefs (0.2.1)
+    rake (0.8.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakefs
+  rake
+  rspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Bruno Gouveia
+
+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.markdown

@@ -0,0 +1,70 @@
+##JSHint On Rails
+JSHint on rails is a fork project from JSLint_on_rails, adapted to work with jshint.
+
+**Installation Dependencies**
+* Java 5 >
+* Ruby 1.8 >
+* Rails 2 >
+
+## Installation
+
+**Rails 3**
+* add `gem 'jshint_on_rails'` to you're projects Gemfile
+
+The first time you run it, a file in config/jshint.yml will be created. It can be customized to fit your needs (well explained below).
+
+As this project is a fork of psionides jslint_on_rails, the instructions are the same. [Click here](https://github.com/psionides/jslint_on_rails/blob/master/README.markdown) to follow his instructions.
+
+## Configuration
+
+After the installation, observe that you'll probably will need to customize some settings, for example, the files you want to test and the ones you want to ignore (ex.: libraries such as jquery, mootools, underscore, etc).
+
+The default config allows you to:
+* write single line conditional statements
+* ignore whitespaces (to support the option above and still being indented)
+
+## Running
+
+To start checking your stuff run the following:
+
+    [bundle exec] rake jslint
+
+Then you should see:
+
+    Running JSHint:
+    
+    checking public/javascripts/scripts.js... OK
+    checking public/javascripts/models.js... OK
+    checking public/javascripts/presenters.js... OK
+    
+    No JS errors found  =)
+
+If anything is wrong, you will get something like this instead:
+
+    Running JSHint:
+    
+    checking public/javascripts/scripts.js... 2 errors:
+    
+    Lint at line 24 character 15: Use '===' to compare with 'null'.
+    if (a == null && b == null) {
+    
+    Lint at line 72 character 6: Extra comma.
+    },
+    
+    
+    Found 2 errors =(
+    rake aborted!
+    JSHint test failed.
+
+
+If you want to test specific file or files (just once, without modifying the config), you can pass paths to include
+and/or paths to exclude to the rake task:
+
+    rake jslint paths=public/javascripts/models/*.js,public/javascripts/lib/*.js exclude_paths=public/javascripts/lib/jquery.js
+
+
+## Credits
+
+* JSLint on Rails was created by [Jakub Suder](http://psionides.jogger.pl), licensed under MIT License
+* JSHint is a fork of JSLint and is maintained by the [JSHint Community](https://github.com/jshint/jshint)
+* JSLint was created by [Douglas Crockford](http://jslint.com)

data/Rakefile

@@ -0,0 +1,10 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+require 'rspec/core/rake_task'
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--colour', '--format', 'documentation']
+end

data/lib/jshint.rb

@@ -0,0 +1,7 @@
+require 'jshint/errors'
+require 'jshint/utils'
+require 'jshint/lint'
+
+if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'jshint/railtie'
+end

data/lib/jshint/config/jshint.yml

@@ -0,0 +1,91 @@
+# ------------ rake task options ------------
+
+# JS files to check by default, if no parameters are passed to rake jshint
+# (you may want to limit this only to your own scripts and exclude any external scripts and frameworks)
+
+# this can be overridden by adding 'paths' and 'exclude_paths' parameter to rake command:
+#   rake jshint paths=path1,path2,... exclude_paths=library1,library2,...
+
+paths:
+  - public/javascripts/**/*.js
+
+exclude_paths:
+
+
+# ------------ jshint options ------------
+# visit http://jshint.com/ for complete documentation
+
+# "enforce" type options (true means potentially more warnings)
+
+adsafe:   false     # true if ADsafe rules should be enforced. See http://www.ADsafe.org/
+bitwise:  true      # true if bitwise operators should not be allowed
+newcap:   true      # true if Initial Caps must be used with constructor functions
+eqeqeq:   false     # true if === should be required (for ALL equality comparisons)
+immed:    false     # true if immediate function invocations must be wrapped in parens
+nomen:    false     # true if initial or trailing underscore in identifiers should be forbidden
+onevar:   false     # true if only one var statement per function should be allowed
+plusplus: false     # true if ++ and -- should not be allowed
+regexp:   false     # true if . and [^...] should not be allowed in RegExp literals
+safe:     false     # true if the safe subset rules are enforced (used by ADsafe)
+strict:   false     # true if the ES5 "use strict"; pragma is required
+undef:    true      # true if variables must be declared before used
+white:    false     # true if strict whitespace rules apply (see also 'indent' option)
+
+# "allow" type options (false means potentially more warnings)
+
+cap:      false     # true if upper case HTML should be allowed
+css:      false     # true if CSS workarounds should be tolerated
+debug:    false     # true if debugger statements should be allowed (set to false before going into production)
+es5:      false     # true if ECMAScript 5 syntax should be allowed
+evil:     false     # true if eval should be allowed
+forin:    false     # true if unfiltered 'for in' statements should be allowed
+fragment: false     # true if HTML fragments should be allowed
+laxbreak: false     # true if statement breaks should not be checked
+on:       false     # true if HTML event handlers (e.g. onclick="...") should be allowed
+sub:      false     # true if subscript notation may be used for expressions better expressed in dot notation
+
+# other options
+
+maxlen:   160       # Maximum line length
+indent:   2         # Number of spaces that should be used for indentation - used only if 'white' option is set
+maxerr:   50        # The maximum number of warnings reported (per file)
+passfail: false     # true if the scan should stop on first error (per file)
+# following are relevant only if undef = true
+predef:   ''        # Names of predefined global variables - comma-separated string or a YAML array
+browser:  true      # true if the standard browser globals should be predefined
+rhino:    false     # true if the Rhino environment globals should be predefined
+windows:  false     # true if Windows-specific globals should be predefined
+widget:   false     # true if the Yahoo Widgets globals should be predefined
+devel:    false     # true if functions like alert, confirm, console, prompt etc. are predefined
+
+# jshint options
+loopfunc: true      # true if functions should be allowed to be defined within loops
+asi:      true      # true if automatic semicolon insertion should be tolerated
+boss:     true      # true if advanced usage of assignments and == should be allowed
+couch:    true      # true if CouchDB globals should be predefined
+curly:    false     # true if curly braces around blocks should be required (even in if/for/while)
+noarg:    true      # true if arguments.caller and arguments.callee should be disallowed
+node:     true      # true if the Node.js environment globals should be predefined
+noempty:  true      # true if empty blocks should be disallowed
+nonew:    true      # true if using `new` for side-effects should be disallowed
+
+
+# ------------ jshint_on_rails custom lint options (switch to true to disable some annoying warnings) ------------
+
+# ignores "missing semicolon" warning at the end of a function; this lets you write one-liners
+# like: x.map(function(i) { return i + 1 }); without having to put a second semicolon inside the function
+lastsemic: false
+
+# allows you to use the 'new' expression as a statement (without assignment)
+# so you can call e.g. new Ajax.Request(...), new Effect.Highlight(...) without assigning to a dummy variable
+newstat: false
+
+# ignores the "Expected an assignment or function call and instead saw an expression" warning,
+# if the expression contains a proper statement and makes sense; this lets you write things like:
+#    element && element.show();
+#    valid || other || lastChance || alert('OMG!');
+#    selected ? show() : hide();
+# although these will still cause a warning:
+#    element && link;
+#    selected ? 5 : 10;
+statinexp: false

data/lib/jshint/errors.rb

@@ -0,0 +1,9 @@
+module JSHint
+
+  class NoJavaException < StandardError
+  end
+
+  class LintCheckFailure < StandardError
+  end
+
+end

data/lib/jshint/lint.rb

@@ -0,0 +1,80 @@
+require 'jshint/errors'
+require 'jshint/utils'
+
+module JSHint
+
+  PATH = File.dirname(__FILE__)
+
+  TEST_JAR_FILE = File.expand_path("#{PATH}/vendor/test.jar")
+  RHINO_JAR_FILE = File.expand_path("#{PATH}/vendor/rhino.jar")
+  TEST_JAR_CLASS = "Test"
+  RHINO_JAR_CLASS = "org.mozilla.javascript.tools.shell.Main"
+
+  JSHINT_FILE = File.expand_path("#{PATH}/vendor/jshint.js")
+
+  class Lint
+
+    # available options:
+    # :paths => [list of paths...]
+    # :exclude_paths => [list of exluded paths...]
+    # :config_path => path to custom config file (can be set via JSHint.config_path too)
+    def initialize(options = {})
+      default_config = Utils.load_config_file(DEFAULT_CONFIG_FILE)
+      custom_config = Utils.load_config_file(options[:config_path] || JSHint.config_path)
+      @config = default_config.merge(custom_config)
+
+      if @config['predef'].is_a?(Array)
+        @config['predef'] = @config['predef'].join(",")
+      end
+
+      included_files = files_matching_paths(options, :paths)
+      excluded_files = files_matching_paths(options, :exclude_paths)
+      @file_list = Utils.exclude_files(included_files, excluded_files)
+      @file_list.delete_if { |f| File.size(f) == 0 }
+
+      ['paths', 'exclude_paths'].each { |field| @config.delete(field) }
+    end
+
+    def run
+      check_java
+      Utils.xputs "Running JSHint...\n\n"
+      arguments = "#{JSHINT_FILE} #{option_string.inspect.gsub(/\$/, "\\$")} #{@file_list.join(' ')}"
+      success = call_java_with_status(RHINO_JAR_FILE, RHINO_JAR_CLASS, arguments)
+      raise LintCheckFailure, "JSHint test failed." unless success
+    end
+
+    private
+
+    def call_java_with_output(jar, mainClass, arguments = "")
+      %x(java -cp #{jar} #{mainClass} #{arguments})
+    end
+
+    def call_java_with_status(jar, mainClass, arguments = "")
+      system("java -cp #{jar} #{mainClass} #{arguments}")
+    end
+
+    def option_string
+      @config.map { |k, v| "#{k}=#{v.inspect}" }.join('&')
+    end
+
+    def check_java
+      unless @java_ok
+        java_test = call_java_with_output(TEST_JAR_FILE, TEST_JAR_CLASS)
+        if java_test.strip == "OK"
+          @java_ok = true
+        else
+          raise NoJavaException, "Please install Java before running JSHint."
+        end
+      end
+    end
+
+    def files_matching_paths(options, field)
+      path_list = options[field] || @config[field.to_s] || []
+      path_list = [path_list] unless path_list.is_a?(Array)
+      file_list = path_list.map { |p| Dir[p] }.flatten
+      Utils.unique_files(file_list)
+    end
+
+  end
+
+end

data/lib/jshint/rails.rb

@@ -0,0 +1,4 @@
+require 'jshint/utils'
+
+# for Rails, set config file path to config/jshint.yml in Rails root
+JSHint.config_path = File.join(Rails.root, 'config', 'jshint.yml')

data/lib/jshint/railtie.rb

@@ -0,0 +1,21 @@
+module JSHint
+  class Railtie < Rails::Railtie
+
+    rake_tasks do
+      require 'jshint/rails'
+      require 'jshint/tasks'
+      JSHint::Railtie.create_example_config
+    end
+
+    def self.create_example_config
+      unless File.exists?(JSHint.config_path)
+        begin
+          JSHint::Utils.copy_config_file
+        rescue StandardError => error
+          puts "Error: #{error.message}"
+        end
+      end
+    end
+
+  end
+end

data/lib/jshint/tasks.rb

@@ -0,0 +1,27 @@
+require 'jshint/lint'
+require 'jshint/utils'
+
+desc "Run JSHint check on selected Javascript files"
+task :jshint do
+  include_paths = JSHint::Utils.paths_from_command_line('paths')
+  exclude_paths = JSHint::Utils.paths_from_command_line('exclude_paths')
+
+  if include_paths && exclude_paths.nil?
+    # if you pass paths= on command line but not exclude_paths=, and you have exclude_paths
+    # set in the config file, then the old exclude pattern will be used against the new
+    # include pattern, which may be very confusing...
+    exclude_paths = []
+  end
+
+  lint = JSHint::Lint.new :paths => include_paths, :exclude_paths => exclude_paths
+  lint.run
+end
+
+namespace :jshint do
+
+  desc "Create a copy of the default JSHint config file in your config directory"
+  task :copy_config do
+    JSHint::Utils.copy_config_file
+  end
+
+end

data/lib/jshint/utils.rb

@@ -0,0 +1,80 @@
+require 'fileutils'
+require 'yaml'
+
+module JSHint
+
+  VERSION = "1.0.1"
+  DEFAULT_CONFIG_FILE = File.expand_path(File.dirname(__FILE__) + "/config/jshint.yml")
+
+  class << self
+    attr_accessor :config_path
+  end
+
+  module Utils
+    class << self
+
+      def xprint(txt)
+        print txt
+      end
+
+      def xputs(txt)
+        puts txt
+      end
+
+      def load_config_file(file_name)
+        if file_name && File.exists?(file_name) && File.file?(file_name) && File.readable?(file_name)
+          YAML.load_file(file_name)
+        else
+          {}
+        end
+      end
+
+      # workaround for a problem with case-insensitive file systems like HFS on Mac
+      def unique_files(list)
+        files = []
+        list.each do |entry|
+          files << entry unless files.any? { |f| File.identical?(f, entry) }
+        end
+        files
+      end
+
+      # workaround for a problem with case-insensitive file systems like HFS on Mac
+      def exclude_files(list, excluded)
+        list.reject { |entry| excluded.any? { |f| File.identical?(f, entry) }}
+      end
+
+      def paths_from_command_line(field)
+        argument = ENV[field] || ENV[field.upcase]
+        argument && argument.split(/,/)
+      end
+
+      def copy_config_file
+        raise ArgumentError, "Please set JSHint.config_path" if JSHint.config_path.nil?
+        xprint "Creating example JSHint config file in #{File.expand_path(JSHint.config_path)}... "
+        if File.exists?(JSHint.config_path)
+          xputs "\n\nWarning: config file exists, so it won't be overwritten. " +
+                "You can copy it manually from the jshint_on_rails directory if you want to reset it."
+        else
+          FileUtils.copy(JSHint::DEFAULT_CONFIG_FILE, JSHint.config_path)
+          xputs "done."
+        end
+      end
+
+      def remove_config_file
+        raise ArgumentError, "Please set JSHint.config_path" if JSHint.config_path.nil?
+        xprint "Removing config file... "
+        if File.exists?(JSHint.config_path) && File.file?(JSHint.config_path)
+          if File.read(JSHint.config_path) == File.read(JSHint::DEFAULT_CONFIG_FILE)
+            File.delete(JSHint.config_path)
+            xputs "OK."
+          else
+            xputs "File was modified, so it won't be deleted automatically."
+          end
+        else
+          xputs "OK (no config file found)."
+        end
+      end
+
+    end
+  end
+end