jshint-rb 1.1.1

data/lib/jshint_on_rails.rb

@@ -0,0 +1 @@
+require 'jshint'

data/spec/jslint_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe 'jslint.js' do
+  before :all do
+    File.open(JSHint::DEFAULT_CONFIG_FILE, "w") { |f| f.write "color: red\nsize: 5\nshape: circle\n" }
+    File.open("custom_config.yml", "w") { |f| f.write "color: blue\nsize: 7\nborder: 2\n" }
+    File.open("other_config.yml", "w") { |f| f.write "color: green\nborder: 0\nshape: square" }
+    JSHint.config_path = "custom_config.yml"
+  end
+
+  describe "options in comments" do
+    before do
+      FakeFS.deactivate!
+      create_file 'spec-config.yml', 'evil: false'
+      create_file 'first.js', "
+        /*jslint evil: true*/
+        eval('alert(\"muahahahaha\")');
+      "
+      create_file 'second.js', "
+        // I shouldn't be able to do that
+        eval('alert(\"muahahahaha\")');
+      "
+    end
+
+    it "should not apply local options from one file to all subsequent files" do
+      lint = JSHint::Lint.new(:paths => ["first.js", "second.js"], :config => 'spec-config.yml')
+
+      # silence stdout from jslint
+      lint.instance_eval do
+        def system(command)
+          `#{command}`
+          $? == 0
+        end
+      end
+
+      expect { lint.run }.to raise_error(JSHint::LintCheckFailure)
+    end
+
+    after do
+      File.delete('first.js')
+      File.delete('second.js')
+      File.delete('spec-config.yml')
+      FakeFS.activate!
+    end
+  end
+end

data/spec/lint_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+describe JSHint::Lint do
+
+  JSHint::Lint.class_eval do
+    attr_reader :config, :file_list
+  end
+
+  before :all do
+    create_config 'color' => 'red', 'size' => 5, 'shape' => 'circle'
+    create_file 'custom_config.yml', 'color' => 'blue', 'size' => 7, 'border' => 2
+    create_file 'other_config.yml', 'color' => 'green', 'border' => 0, 'shape' => 'square'
+    JSHint.config_path = "custom_config.yml"
+  end
+
+  it "should merge default config with custom config from JSHint.config_path" do
+    lint = JSHint::Lint.new
+    lint.config.should == { 'color' => 'blue', 'size' => 7, 'border' => 2, 'shape' => 'circle' }
+  end
+
+  it "should merge default config with custom config given in argument, if available" do
+    lint = JSHint::Lint.new :config_path => 'other_config.yml'
+    lint.config.should == { 'color' => 'green', 'border' => 0, 'shape' => 'square', 'size' => 5 }
+  end
+
+  it "should convert predef to string if it's an array" do
+    create_file 'predef.yml', 'predef' => ['a', 'b', 'c']
+
+    lint = JSHint::Lint.new :config_path => 'predef.yml'
+    lint.config['predef'].should == ['a', 'b', 'c']
+  end
+
+  it "should accept predef as string" do
+    create_file 'predef.yml', 'predef' => 'd,e,f'
+
+    lint = JSHint::Lint.new :config_path => 'predef.yml'
+    lint.config['predef'].should == ['d', 'e', 'f']
+  end
+
+  it "should not pass paths and exclude_paths options to real JSHint" do
+    create_file 'test.yml', 'paths' => ['a', 'b'], 'exclude_paths' => ['c'], 'debug' => 'true'
+
+    lint = JSHint::Lint.new :config_path => 'test.yml'
+    lint.config['debug'].should == 'true'
+    lint.config['paths'].should be_nil
+    lint.config['exclude_paths'].should be_nil
+  end
+
+  it "should fail if JSHint check fails" do
+    lint = JSHint::Lint.new
+    lint.instance_variable_set("@file_list", ['app.js'])
+    lint.should_receive(:process_file).and_return([{'line'=>0,'character'=>0,'reason'=>'failure'}])
+    lambda { lint.run }.should raise_error(JSHint::LintCheckFailure)
+  end
+
+  it "should not fail if JSHint check passes" do
+    lint = JSHint::Lint.new
+    lint.instance_variable_set("@file_list", ['app.js'])
+    lint.should_receive(:process_file).and_return([])
+    lambda { lint.run }.should_not raise_error
+  end
+
+  it "should run JSHint once for each file" do
+    lint = JSHint::Lint.new
+    lint.instance_variable_set("@file_list", ['app.js', 'jquery.js'])
+    lint.should_receive(:process_file).twice.and_return([])
+    lint.run
+  end
+
+  describe "file lists" do
+    before :each do
+      JSHint::Utils.stub!(:exclude_files).and_return { |inc, exc| inc - exc }
+      JSHint::Utils.stub!(:unique_files).and_return { |files| files.uniq }
+    end
+
+    before :all do
+      @files = ['test/app.js', 'test/lib.js', 'test/utils.js', 'test/vendor/jquery.js', 'test/vendor/proto.js']
+      @files.each { |fn| create_file(fn, "alert()") }
+      @files = @files.map { |fn| File.expand_path(fn) }
+    end
+
+    it "should calculate a list of files to test" do
+      lint = JSHint::Lint.new :paths => ['test/**/*.js']
+      lint.file_list.should == @files
+
+      lint = JSHint::Lint.new :paths => ['test/a*.js', 'test/**/*r*.js']
+      lint.file_list.should == [@files[0], @files[3], @files[4]]
+
+      lint = JSHint::Lint.new :paths => ['test/a*.js', 'test/**/*r*.js'], :exclude_paths => ['**/*q*.js']
+      lint.file_list.should == [@files[0], @files[4]]
+
+      lint = JSHint::Lint.new :paths => ['test/**/*.js'], :exclude_paths => ['**/*.js']
+      lint.file_list.should == []
+
+      lint = JSHint::Lint.new :paths => ['test/**/*.js', 'test/**/a*.js', 'test/**/p*.js']
+      lint.file_list.should == @files
+
+      create_file 'new.yml', 'paths' => ['test/vendor/*.js']
+
+      lint = JSHint::Lint.new :config_path => 'new.yml', :exclude_paths => ['**/proto.js']
+      lint.file_list.should == [@files[3]]
+
+      lint = JSHint::Lint.new :config_path => 'new.yml', :paths => ['test/l*.js']
+      lint.file_list.should == [@files[1]]
+    end
+
+    it "should accept :paths and :exclude_paths as string instead of one-element array" do
+      lambda do
+        lint = JSHint::Lint.new :paths => 'test/*.js', :exclude_paths => 'test/lib.js'
+        lint.file_list.should == [@files[0], @files[2]]
+      end.should_not raise_error
+    end
+
+    it "should ignore empty files" do
+      create_file 'test/empty.js', ''
+      create_file 'test/full.js', 'qqq'
+
+      lint = JSHint::Lint.new :paths => ['test/*.js']
+      lint.file_list.should_not include(File.expand_path("test/empty.js"))
+      lint.file_list.should include(File.expand_path("test/full.js"))
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'jshint'
+require 'pp' # fix for fakefs/pp incompatibility in Ruby 1.9.3
+require 'fakefs'
+
+module Rails
+end
+
+module FakeFS
+  class File
+    def self.identical?(file1, file2)
+      File.expand_path(file1) == File.expand_path(file2)
+    end
+  end
+end
+
+module SpecHelper
+  def create_file(filename, contents)
+    contents = YAML.dump(contents) + "\n" unless contents.is_a?(String)
+    File.open(filename, "w") { |f| f.print(contents) }
+  end
+
+  def create_config(data)
+    create_file(JSHint::DEFAULT_CONFIG_FILE, data)
+  end
+end
+
+RSpec.configure do |config|
+  config.include SpecHelper
+
+  config.before do
+    # disable logging to stdout
+    JSHint::Utils.stub(:display)
+    JSHint::Utils.stub(:log)
+  end
+end

data/spec/utils_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+
+describe JSHint::Utils do
+
+  JSU = JSHint::Utils
+
+  before :all do
+    create_config "default config file"
+  end
+
+  describe ".config_path" do
+    context "if config path is set explicitly" do
+      let(:path) { 'some/path' }
+
+      before { JSHint.config_path = path }
+
+      it "should return the path that was set" do
+        JSHint.config_path.should == path
+      end
+    end
+
+    context "if config path is not set" do
+      before { JSHint.config_path = nil }
+
+      context "if JSHint is run within Rails" do
+        before do
+          JSHint::Utils.stub(:in_rails? => true)
+          Rails.stub(:root => '/dir')
+        end
+
+        it "should return config/jslint.yml in Rails project directory" do
+          JSHint.config_path.should == '/dir/config/jslint.yml'
+        end
+      end
+
+      context "if JSHint is not run within Rails" do
+        before do
+          JSHint::Utils.stub(:in_rails? => false)
+        end
+
+        it "should return config/jslint.yml in current directory" do
+          JSHint.config_path.should == 'config/jslint.yml'
+        end
+      end
+    end
+  end
+
+  describe "path_from_command_line" do
+    it "should extract a path from the command line argument" do
+      ENV['test_arg'] = 'file.js'
+      JSU.path_from_command_line('test_arg').should == 'file.js'
+    end
+
+    it "should work if the argument name is given in uppercase" do
+      ENV['TEST_ARG'] = 'file.js'
+      JSU.path_from_command_line('test_arg').should == 'file.js'
+    end
+
+    it "should return nil if the argument isn't set" do
+      JSU.path_from_command_line('crash').should be_nil
+    end
+
+    after :each do
+      ENV['test_arg'] = nil
+      ENV['TEST_ARG'] = nil
+    end
+  end
+
+  describe "paths_from_command_line" do
+    it "should extract an array of paths from command line argument" do
+      ENV['test_arg'] = 'one,two,three'
+      JSU.paths_from_command_line('test_arg').should == ['one', 'two', 'three']
+    end
+
+    it "should also work if the argument name is given in uppercase" do
+      ENV['TEST_ARG'] = 'ruby,python,js'
+      JSU.paths_from_command_line('test_arg').should == ['ruby', 'python', 'js']
+    end
+
+    it "should return nil if the argument isn't set" do
+      JSU.paths_from_command_line('crash').should be_nil
+    end
+
+    after :each do
+      ENV['test_arg'] = nil
+      ENV['TEST_ARG'] = nil
+    end
+  end
+
+  describe "load_config_file" do
+
+    before :all do
+      create_file 'sample.yml', 'framework: rails'
+      Dir.mkdir("tmp")
+    end
+
+    it "should load a YAML file if it can be read" do
+      JSU.load_config_file("sample.yml").should == { 'framework' => 'rails' }
+    end
+
+    it "should return an empty hash if file name is nil" do
+      JSU.load_config_file(nil).should == {}
+    end
+
+    it "should return an empty hash if file doesn't exist" do
+      JSU.load_config_file("crack.exe").should == {}
+    end
+
+    it "should return an empty hash if file is not a file" do
+      JSU.load_config_file("tmp").should == {}
+    end
+
+    it "should return an empty hash if file is not readable" do
+      File.should_receive(:readable?).once.with("sample.yml").and_return(false)
+      JSU.load_config_file("sample.yml").should == {}
+    end
+  end
+
+  describe "unique and exclude" do
+    def set_identical(file1, file2, value)
+      File.should_receive(:identical?).with(file1, file2).once.and_return(value)
+    end
+
+    it "should remove duplicate files from a list" do
+      set_identical('config.yml',  'lib/../config.yml', true)
+      set_identical('config.yml',  'Rakefile',          false)
+      set_identical('config.yml',  'Config.yml',        true)
+      unique = JSU.unique_files(['config.yml', 'lib/../config.yml', 'Rakefile', 'Config.yml'])
+      unique.should == ['config.yml', 'Rakefile']
+    end
+
+    it "should subtract files on the second list from the first list" do
+      set_identical('RaKeFiLe',    'config.yml', false)
+      set_identical('wtf',         'config.yml', false)
+      set_identical('Config.yml',  'config.yml', true)
+      set_identical('RaKeFiLe',    'Rakefile',   true)
+      set_identical('RaKeFiLe',    'Gemfile',    false)
+      set_identical('wtf',         'Gemfile',    false)
+      set_identical('Config.yml',  'Gemfile',    false)
+      included = JSU.exclude_files(['config.yml', 'Rakefile', 'Gemfile'], ['RaKeFiLe', 'wtf', 'Config.yml'])
+      included.should == ['Gemfile']
+    end
+  end
+
+  describe "copy_config_file" do
+    it "should copy default config to config_path" do
+      JSHint.config_path = "newfile.yml"
+      FileUtils.should_receive(:copy).with(JSHint::DEFAULT_CONFIG_FILE, "newfile.yml")
+      JSHint::Utils.copy_config_file
+    end
+
+    it "should not overwrite the file if it exists" do
+      JSHint.config_path = "newfile2.yml"
+      create_file 'newfile2.yml', 'qwe'
+      FileUtils.should_not_receive(:copy)
+      JSHint::Utils.copy_config_file
+    end
+  end
+
+  describe "remove_config_file" do
+    it "should remove the file if it's identical to default one" do
+      JSHint.config_path = "newfile3.yml"
+      File.open("newfile3.yml", "w") { |f| f.print("default config file") }
+      File.exists?("newfile3.yml").should be_true
+      JSHint::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
+      JSHint.config_path = "newfile4.yml"
+      File.open("newfile4.yml", "w") { |f| f.puts("something's changed") }
+      File.exists?("newfile4.yml").should be_true
+      JSHint::Utils.remove_config_file
+      File.exists?("newfile4.yml").should be_true
+    end
+
+    it "should not remove the file if it doesn't exist" do
+      JSHint.config_path = "this_doesnt_exist.yml"
+      lambda { JSHint::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")
+      JSHint.config_path = "public"
+      lambda { JSHint::Utils.remove_config_file }.should_not raise_error
+      File.exist?("public").should be_true
+      File.directory?("public").should be_true
+    end
+  end
+
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: jshint-rb
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Bruno Gouveia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+description: JSHint wrapped in a Ruby gem for easier use
+email: brunogouveia@buzungo.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Changelog.markdown
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- lib/jshint.rb
+- lib/jshint/config/jshint.yml
+- lib/jshint/errors.rb
+- lib/jshint/lint.rb
+- lib/jshint/rails.rb
+- lib/jshint/railtie.rb
+- lib/jshint/tasks.rb
+- lib/jshint/utils.rb
+- lib/jshint/vendor/jshint.js
+- lib/jshint_on_rails.rb
+- spec/jslint_spec.rb
+- spec/lint_spec.rb
+- spec/spec_helper.rb
+- spec/utils_spec.rb
+homepage: http://github.com/josephholsten/jshint.rb
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- JS engine compatible with execjs
+- JSON engine compatible with multi_json
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: JSHint is a little more flexible JavaScript checker, wrapped in a Ruby gem
+  for easier use
+test_files: []