jslint_on_rails 1.0.7 → 1.1

data/Changelog.markdown

@@ -1,3 +1,9 @@
+Version 1.1 (09.04.2012)
+
+* removed support for installing as a Rails plugin
+* doesn't auto-generate jslint.yml if it doesn't exist (create one explicitly using the rake task if you want)
+* no need to set JSLint.config_path (if you aren't using the Railtie) if the file is in the default location
+
 Version 1.0.7 (12.09.2011)
 
 * fixed problem with local options from one file being applied to all subsequent files

data/Gemfile

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

data/Gemfile.lock

@@ -1,22 +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.3)
+    fakefs (0.3.2)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.1.0)
+    rspec-mocks (2.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  fakefs
+  fakefs (= 0.3.2)
   rake
   rspec

data/README.markdown

@@ -1,34 +1,27 @@
 # JSLint on Rails
 
+[![Build Status](https://secure.travis-ci.org/psionides/jslint_on_rails.png)](http://travis-ci.org/psionides/jslint_on_rails)
+
 **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).
+the [JSLint JavaScript code checker](https://github.com/douglascrockford/JSLint) on your Javascript code easily.
 
-Note: to run JSLint on Rails, you need to have **Java** available on your machine - it's required because JSLint is
+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
 Java). Any decent version of Java will do (and by decent I mean 5.0 or later).
 
 
 ## Compatibility
 
-Latest version should be compatible with Ruby 1.9 and Rails 3 (and also with Ruby 1.8 and Rails 2, of course).
-
+Latest version should be compatible with Ruby 1.8.7 and 1.9.2+ (check [Travis build status](http://travis-ci.org/#!/psionides/jslint_on_rails)), and also with Rails 2.x and 3.x.
 
-## Installation (as gem)
 
-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.
+## Installation
 
-To use JSLint as a gem in Rails 3, you just need to do one thing:
+To use JSLint in Rails 3 you just need to do one thing:
 
 * add `gem 'jslint_on_rails'` to bundler's Gemfile
 
-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.
-
-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:
+In Rails 2 and other frameworks JSLint on Rails can't be loaded automatically using a Railtie, so you have to load it explicitly. The procedure in this case is:
 
 * install the gem in your application using whatever technique is recommended for your framework (e.g. using bundler,
 or by installing the gem manually with `gem install jslint_on_rails` and loading it with `require 'jslint'`)
@@ -36,51 +29,23 @@ or by installing the gem manually with `gem install jslint_on_rails` and loading
 
         require 'jslint/tasks'
 
-* below that line, set JSLint's config_path variable to point it to a place where you want your JSLint configuration
-file to be kept - for example:
-
-        JSLint.config_path = "config/jslint.yml"
-    
-* run a rake task which will generate a sample config file for you:
-
-        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.
-
+## Configuration
 
-## Installation (custom)
+It's strongly recommended that you create your own copy of the JSLint config file provided by the gem and tweak it to suit your preferences. To create a new config file from the template in your config directory, call this rake task:
 
-If you wish to write your own rake task to run JSLint, you can create and execute the JSLint object manually:
+    [bundle exec] rake jslint:copy_config
 
-    require 'jslint'
-    
-    lint = JSLint::Lint.new(
-      :paths => ['public/javascripts/**/*.js'],
-      :exclude_paths => ['public/javascripts/vendor/**/*.js'],
-      :config_path => 'config/jslint.yml'
-    )
-    
-    lint.run
+This will create a config file at `config/jslint.yml` listing all available options. If for some reason you'd like to put the config file at a different location, set the `config_path` variable somewhere in your Rakefile:
 
+    JSLint.config_path = "config/lint.yml"
 
-## Configuration
-
-Whatever method you use for installation, a YAML config file should be created for you. In this file, you can:
+There are two things you can change in the config file:
 
 * define which Javascript files are checked by default; you'll almost certainly want to change that, because the default
 is `public/javascripts/**/*.js` which means all Javascript files, and you probably don't want JSLint to check entire
 jQuery, Prototype or whatever other libraries you use - so change this so that only your scripts are checked (you can
 put multiple entries under "paths:" and "exclude_paths:")
-* tweak JSLint options to enable or disable specific checks - I've set the defaults to what I believe is reasonable,
+* enable or disable specific checks - I've set the defaults to what I believe is reasonable,
 but what's reasonable for me may not be reasonable for you
 
 
@@ -128,10 +93,31 @@ 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
 
-For the best effect, you should include JSLint check in your Continuous Integration build - that way, you'll get
+For the best effect, you should include JSLint check in your Continuous Integration build - that way you'll get
 immediate notification when you've committed JS code with errors.
 
 
+## Running automatically with Guard
+
+If you want to run JSLint on Rails automatically everytime you save a JS file, check out the
+[guard-jslint-on-rails](https://github.com/wireframe/guard-jslint-on-rails) gem by Ryan Sonnek.
+
+
+## Running from your code
+
+If you would prefer to write your own rake task to run JSLint, you can create and execute the JSLint object manually:
+
+    require 'jslint'
+    
+    lint = JSLint::Lint.new(
+      :paths => ['public/javascripts/**/*.js'],
+      :exclude_paths => ['public/javascripts/vendor/**/*.js'],
+      :config_path => 'config/jslint.yml'
+    )
+    
+    lint.run
+
+
 ## Additional options
 
 I've added some additional options to JSLint to get rid of some warnings which I thought didn't make sense. They're all
@@ -181,6 +167,15 @@ So I've tweaked the code that creates this warning so that it doesn't print it i
 * expressions with ?: are accepted if both alternatives (before and after the colon) are statements
 
 
+## Version 2.0 and JSHint
+
+Some people have asked about [JSHint](http://jshint.com) support (some have even made forks replacing JSLint with JSHint). I like the idea of a less strict lint giving the user more control; the reason I haven't integrated JSHint yet is because I want the gem to provide both JSLint and JSHint and let you choose which engine you want to use. The thing is, I can't do that easily because their option sets have diverged - a few options have been changed in JSLint since JSHint was forked off from it, and JSHint has changed or added some other options. There was even [a plan](https://github.com/jshint/jshint/issues/166) to completely redesign the option system in JSHint. So I've decided to hold off the integration until I can be sure that the option sets won't be completely changed again. I'm hoping this might happen as a part of the [JSHint Next](https://github.com/jshint/jshint-next) project, but I don't know what the timeline is.
+
+I haven't been updating JSLint for the same reason - some options have changed there and I'd rather wait until I can update everything together at the same time. If you're impatient, check out some of the [forks that use JSHint](https://github.com/psionides/jslint_on_rails/network); some of them have even been released as gems (e.g. see [jshint\_on\_rails](https://rubygems.org/gems/jshint_on_rails)) - although as far as I know, none of them have adapted the config file template to match JSHint's option set.
+
+Another thing that's planned for 2.0, whenever that happens, is a redesign of the Javascript runner code to make it possible to use other ways of running Javascript - probably using [execjs](https://github.com/sstephenson/execjs).
+
+
 ## Credits
 
 * JSLint on Rails was created by [Jakub Suder](http://psionides.jogger.pl), licensed under MIT License

data/lib/jslint/railtie.rb

@@ -1,21 +1,7 @@
 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

@@ -3,13 +3,19 @@ require 'yaml'
 
 module JSLint
 
-  VERSION = "1.0.7"
+  VERSION = "1.1"
   DEFAULT_CONFIG_FILE = File.expand_path(File.dirname(__FILE__) + "/config/jslint.yml")
 
   class << self
     attr_accessor :config_path
   end
 
+  self.config_path = if defined?(Rails)
+    File.join(Rails.root, 'config', 'jslint.yml')
+  else
+    'config/jslint.yml'
+  end
+
   module Utils
     class << self
 
@@ -59,22 +65,6 @@ module JSLint
           xputs "done."
         end
       end
-
-      def remove_config_file
-        raise ArgumentError, "Please set JSLint.config_path" if JSLint.config_path.nil?
-        xprint "Removing config file... "
-        if File.exists?(JSLint.config_path) && File.file?(JSLint.config_path)
-          if File.read(JSLint.config_path) == File.read(JSLint::DEFAULT_CONFIG_FILE)
-            File.delete(JSLint.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

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'jslint'
+require 'pp' # fix for fakefs/pp incompatibility in Ruby 1.9.3
 require 'fakefs'
 
 module JSLint::Utils

data/spec/utils_spec.rb

@@ -108,41 +108,4 @@ describe JSLint::Utils do
       JSLint::Utils.copy_config_file
     end
   end
-
-  describe "remove_config_file" do
-    it "throw an error if config path isn't set" do
-      JSLint.config_path = nil
-      lambda { JSLint::Utils.remove_config_file }.should raise_error(ArgumentError)
-    end
-
-    it "should remove the file if it's identical to default one" do
-      JSLint.config_path = "newfile3.yml"
-      create_file 'newfile3.yml', 'default config file'
-      File.exists?("newfile3.yml").should be_true
-      JSLint::Utils.remove_config_file
-      File.exists?("newfile3.yml").should be_false
-    end
-
-    it "should not remove the file if it's not identical to default one" do
-      JSLint.config_path = "newfile4.yml"
-      create_file 'newfile4.yml', "something's changed"
-      File.exists?("newfile4.yml").should be_true
-      JSLint::Utils.remove_config_file
-      File.exists?("newfile4.yml").should be_true
-    end
-
-    it "should not remove the file if it doesn't exist" do
-      JSLint.config_path = "this_doesnt_exist.yml"
-      lambda { JSLint::Utils.remove_config_file }.should_not raise_error
-    end
-
-    it "should not remove the file if it's not a file" do
-      Dir.mkdir("public")
-      JSLint.config_path = "public"
-      lambda { JSLint::Utils.remove_config_file }.should_not raise_error
-      File.exist?("public").should be_true
-      File.directory?("public").should be_true
-    end
-  end
-
 end

metadata

@@ -1,33 +1,22 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jslint_on_rails
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 7
-  version: 1.0.7
+version: !ruby/object:Gem::Version
+  version: '1.1'
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jakub Suder
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-12 00:00:00 +02:00
-default_executable: 
+date: 2012-04-09 00:00:00.000000000Z
 dependencies: []
-
 description: 
 email: jakub.suder@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - MIT-LICENSE
 - README.markdown
 - Changelog.markdown
@@ -37,7 +26,6 @@ files:
 - lib/jslint/config/jslint.yml
 - lib/jslint/errors.rb
 - lib/jslint/lint.rb
-- lib/jslint/rails.rb
 - lib/jslint/railtie.rb
 - lib/jslint/tasks.rb
 - lib/jslint/utils.rb
@@ -48,42 +36,31 @@ files:
 - lib/jslint_on_rails.rb
 - spec/jslint_spec.rb
 - spec/lint_spec.rb
-- spec/railtie_spec.rb
 - spec/spec_helper.rb
 - spec/utils_spec.rb
-has_rdoc: true
 homepage: http://github.com/psionides/jslint_on_rails
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-requirements: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
 - Java JRE (5.0 or later)
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: JSLint JavaScript checker wrapped in a Ruby gem for easier use
 test_files: []
-

data/lib/jslint/rails.rb

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

data/spec/railtie_spec.rb

@@ -1,31 +0,0 @@
-require 'spec_helper'
-require 'jslint/railtie'
-
-describe JSLint::Railtie do
-  before :all do
-    create_config 'example config'
-    JSLint.config_path = "custom_config.yml"
-  end
-
-  before :each do
-    File.delete(JSLint.config_path) if File.exist?(JSLint.config_path)
-  end
-
-  describe "create_example_config" do
-    it "should create a config file if it doesn't exist" do
-      JSLint::Railtie.create_example_config
-
-      File.exist?(JSLint.config_path).should be_true
-      File.read(JSLint.config_path).should == 'example config'
-    end
-
-    it "should not do anything if config already exists" do
-      create_file(JSLint.config_path, "bar")
-
-      JSLint::Railtie.create_example_config
-
-      File.exist?(JSLint.config_path).should be_true
-      File.read(JSLint.config_path).should == "bar"
-    end
-  end
-end