jslint_on_rails 1.0.3 → 1.0.4

data/Changelog.markdown

@@ -0,0 +1,24 @@
+Version 1.0.4 (05.12.2010)
+
+* bundler should be able to load the gem without :require
+* added a Railtie to make things simpler in Rails 3
+* don't print any warnings if tested JS file is empty
+* lastsemic option will now not work if the missing semicolon is on a different line than the end bracket (so it only
+  makes sense for inline one-liner functions)
+* updated JSLint to version from 2010-11-27 (adds some new warnings about comparing variables with empty string using
+  "==")
+
+Version 1.0.3 (11.06.2010)
+
+* Ruby 1.9 compatibility fixes
+* 'es5' option is disabled by default
+
+Version 1.0.2 (10.04.2010)
+
+* Rails 3 compatibility fixes
+* updated JSLint to version from 2010-04-06
+* refactoring, added specs
+
+Version 1.0.0 (18.12.2009)
+
+* first gem release

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/README.markdown

@@ -1,9 +1,8 @@
 # JSLint on Rails
 
-**JSLint on Rails** is a Ruby gem and Rails plugin which lets you run
-the [JSLint JavaScript code checker](http://jslint.com) on your Javascript code easily.
-
-It can be installed either as a Rails plugin (the recommended method for Rails), or as a gem (for other frameworks).
+**JSLint on Rails** is a Ruby library which lets you run
+the [JSLint JavaScript code checker](https://github.com/douglascrockford/JSLint) on your Javascript code easily. It can
+be installed either as a gem (the recommended method), or as a Rails plugin (legacy method).
 
 Note: to run JSLint on Rails, you need to have **Java** available on your machine - it's required because JSLint is
 itself written in JavaScript, and is run using the [Rhino](http://www.mozilla.org/rhino) JavaScript engine (written in
@@ -15,25 +14,24 @@ Java). Any decent version of Java will do (and by decent I mean 5.0 or later).
 Latest version should be compatible with Ruby 1.9 and Rails 3 (and also with Ruby 1.8 and Rails 2, of course).
 
 
-## Installation (Rails)
-
-If you use Rails, you can install the library as a plugin - it's less work to set it up this way.
-To install the plugin, use this command:
-
-    ./script/plugin install git://github.com/psionides/jslint_on_rails.git
+## Installation (as gem)
 
-This will create for you a sample `jslint.yml` config file in your config directory.
+The recommended installation method (for Rails and for other frameworks) is to install JSLint on Rails as a gem. The
+advantage is that it's easier to update the library to newer versions later, and you keep its code separate from your
+own code.
 
+To use JSLint as a gem in Rails 3, you just need to do one thing:
 
-## Installation (other frameworks)
+* add `gem 'jslint_on_rails'` to bundler's Gemfile
 
-If you use Merb or some other framework, you need to install JSLint as a Ruby gem (you can do that in Rails too - the
-advantage of this method is that it may be easier to update to newer versions later).
+And that's it. On first run, JSLint on Rails will create an example config file for you in config/jslint.yml, which
+you can then tweak to suit your app.
 
-To use JSLint as a gem, follow these steps:
+In Rails 2 and in other frameworks JSLint on Rails can't be loaded automatically using a Railtie, so you have to do a
+bit more work. The procedure in this case is:
 
-* install the gem in your application using whatever technique is recommended for your framework (e.g. using gem
-bundler, or just plain old `gem install jslint_on_rails`)
+* install the gem in your application using whatever technique is recommended for your framework (e.g. using bundler,
+or just plain old `gem install jslint_on_rails`)
 * in your Rakefile, add a line to load the JSLint tasks:
 
         require 'jslint/tasks'
@@ -48,6 +46,17 @@ file to be kept - for example:
         rake jslint:copy_config
 
 
+## Installation (as Rails plugin)
+
+Installing libraries as Rails plugins was popular before Rails 3, but now gems with Railties can do everything that
+plugins could do, so plugins are getting less and less popular. But if you want to install JSLint on Rails as a plugin
+anyway, here's how you do it:
+
+    ./script/plugin install git://github.com/psionides/jslint_on_rails.git
+
+This will also create a sample `jslint.yml` config file for you in your config directory.
+
+
 ## Installation (custom)
 
 If you wish to write your own rake task to run JSLint, you can create and execute the JSLint object manually:
@@ -79,7 +88,7 @@ but what's reasonable for me may not be reasonable for you
 
 To start the check, run the rake task:
 
-    rake jslint
+    [bundle exec] rake jslint
 
 You will get a result like this (if everything goes well):
 
@@ -134,11 +143,15 @@ Here's a documentation for all the extra options:
 ### lastsemic
 
 If set to true, this will ignore warnings about missing semicolon after a statement, if the statement is the last one in
-a block or function. I've added this because I like to omit the semicolon in one-liner anonymous functions, in
-situations like this:
+a block or function, and the whole block is on the same line. I've added this because I like to omit the semicolon in
+one-liner anonymous functions, in situations like this:
 
     var ids = $$('.entry').map(function(e) { return e.id });
 
+Note: in versions up to 1.0.3, this option also disabled the warning in blocks that span multiple lines, but I've
+changed that in 1.0.4, because removing a last semicolon in a multi-line block doesn't really affect the readability
+(while removing the only semicolon in a one-liner like above does, IMHO).
+
 
 ### newstat
 

data/Rakefile

@@ -2,10 +2,9 @@ require "rubygems"
 require "bundler"
 Bundler.setup
 
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
 
 desc 'Run the specs'
-Spec::Rake::SpecTask.new do |t|
-  t.libs << 'lib'
-  t.spec_opts = ['--colour', '--format', 'specdoc']
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--colour', '--format', 'documentation']
 end

data/lib/jslint/lint.rb

@@ -26,6 +26,7 @@ module JSLint
       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

data/lib/jslint/railtie.rb

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

data/lib/jslint/utils.rb

@@ -2,7 +2,7 @@ require 'fileutils'
 
 module JSLint
 
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
   DEFAULT_CONFIG_FILE = File.expand_path(File.dirname(__FILE__) + "/config/jslint.yml")
 
   class << self
@@ -49,13 +49,13 @@ module JSLint
 
       def copy_config_file
         raise ArgumentError, "Please set JSLint.config_path" if JSLint.config_path.nil?
-        xprint "Copying default config file to #{File.expand_path(JSLint.config_path)}... "
+        xprint "Creating example JSLint config file in #{File.expand_path(JSLint.config_path)}... "
         if File.exists?(JSLint.config_path)
           xputs "\n\nWarning: config file exists, so it won't be overwritten. " +
                 "You can copy it manually from the jslint_on_rails directory if you want to reset it."
         else
           FileUtils.copy(JSLint::DEFAULT_CONFIG_FILE, JSLint.config_path)
-          xputs "OK."
+          xputs "done."
         end
       end