jslint-johnson 1.0.0

data/bin/jslint-johnson

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require File.expand_path("../lib/jslint-johnson", File.dirname(__FILE__))
+
+if ARGV.empty?
+  puts "usage: #{File.basename(__FILE__)} FILES"
+  exit 1
+end
+
+formatter = JSLintJohnson::Formatter.new(STDOUT)
+
+# get a list of all failed files, printing . or * along the way depending on the result
+lint_result = JSLintJohnson::Runner.new(ARGV).run do |file, errors|
+  formatter.tick(errors)
+end
+
+# put a separator line in between the ticks and any summary
+print "\n"
+
+# print a summary of failed files
+formatter.summary(ARGV, lint_result)
+
+# exit with the status code of the number of errors
+exit(lint_result.values.flatten.length)

data/test/helper.rb

@@ -0,0 +1,18 @@
+require "rubygems"
+require 'test/unit'
+require 'erb'
+
+# require the library code
+require File.expand_path("../lib/jslint-johnson", File.dirname(__FILE__))
+
+def erb_fixture(basename)
+  ::ERB.new(File.read(erb_filename(basename))).result
+end
+
+def erb_filename(basename)
+  File.expand_path("fixtures/#{basename}.txt.erb", File.dirname(__FILE__))
+end
+
+def js_filename(basename)
+  File.expand_path("fixtures/#{basename}.js", File.dirname(__FILE__))
+end

data/test/suite.rb

@@ -0,0 +1,5 @@
+
+# require all test cases
+Dir.glob(File.join(File.dirname(__FILE__), "test_*.rb")).each do |test_file|
+  require test_file
+end

data/test/test_cli.rb

@@ -0,0 +1,44 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+require 'erb'
+
+class TestCli < Test::Unit::TestCase
+  Executable = File.expand_path("../bin/jslint-johnson", File.dirname(__FILE__))
+  
+  def test_executable_exists
+    assert File.exist?(Executable)
+  end
+
+  def test_empty_args
+    result = `#{Executable}`
+
+    assert_equal "usage: jslint-johnson FILES\n", result
+    assert_equal false, $?.success?
+  end
+
+  def test_valid
+    result = %x{#{Executable} "#{js_filename "valid"}"}
+
+    assert $?.success?
+    assert_equal erb_fixture("cli-valid-expected-output"), result
+  end
+
+  def test_invalid
+    result = %x{#{Executable} "#{js_filename "invalid"}"}
+
+    assert_equal false, $?.success?
+    assert_equal erb_fixture("cli-invalid-expected-output"), result
+  end
+
+  def test_suite
+    defined_globals = js_filename("defined-globals")
+    defined_options = js_filename("defined-options")
+    invalid = js_filename("invalid")
+    valid = js_filename("valid")
+
+    result = %x{#{Executable} "#{defined_globals}" "#{defined_options}" "#{invalid}" "#{valid}"}
+
+    assert_equal false, $?.success?
+    assert_equal erb_fixture("cli-suite-expected-output"), result
+  end
+
+end

data/test/test_formatter.rb

@@ -0,0 +1,50 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+require 'erb'
+
+class TestFormatter < Test::Unit::TestCase
+
+  def setup
+    @output = String.new
+    @output_stream = StringIO.new(@output, "w+")
+
+    @formatter = JSLintJohnson::Formatter.new(@output_stream)
+  end
+
+  def test_create
+    assert_equal @output_stream.object_id, @formatter.output_stream.object_id
+  end
+
+  def test_tick
+    assert_equal "", @output
+
+    @formatter.tick([])
+
+    assert_equal ".", @output
+
+    @formatter.tick(["foo"])
+
+    assert_equal ".*", @output
+  end
+
+  def test_summary_with_no_errors
+    @formatter.summary(%w(foo bar), {})
+
+    assert_equal erb_fixture("formatter-summary-noerrors"), @output
+  end
+
+  def test_summary_with_errors
+    error_1 = JSLintJohnson::LintError.new("line" => 42, "character" => 10, "reason" => "because i can")
+    error_2 = JSLintJohnson::LintError.new("line" => 43, "character" => 3, "reason" => "a proof is not a proof")
+    error_3 = JSLintJohnson::LintError.new("line" => 139, "character" => 12, "reason" => "undefined global 'foo'")
+
+    result = {
+      "foo" => [error_1, error_2],
+      "bar" => [error_3]
+    }
+
+    @formatter.summary(%w(foo bar baz one two three), result)
+
+    assert_equal erb_fixture("formatter-summary-errors"), @output
+  end
+
+end

data/test/test_lint_error.rb

@@ -0,0 +1,32 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+
+class TestLintError < Test::Unit::TestCase
+
+  def setup
+    @object = {
+      "line" => 42,
+      "character" => 10,
+      "reason" => "because i can",
+      "evidence" => "I don't know, a proof is a proof. What kind of a proof? It's a proof. A proof is a proof, and when you have a good proof, it's because it's proven."
+    }
+
+    @error = JSLintJohnson::LintError.new(@object)
+  end
+
+  def test_line_number
+    assert_equal @error.line_number, 42
+  end
+
+  def test_character
+    assert_equal @error.character, 10
+  end
+
+  def test_reason
+    assert_equal @error.reason, "because i can"
+  end
+
+  def test_evidence
+    assert_equal @error.evidence, "I don't know, a proof is a proof. What kind of a proof? It's a proof. A proof is a proof, and when you have a good proof, it's because it's proven."
+  end
+
+end

data/test/test_runner.rb

@@ -0,0 +1,141 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+
+class TestRunner < Test::Unit::TestCase
+
+  def setup
+    @runner = JSLintJohnson::Runner.new(%w(foo bar))
+  end
+
+  def test_lint_library_filename
+    assert File.exist? JSLintJohnson::Runner::JSLintLibraryFilename
+  end
+
+  def test_file_list
+    assert_equal @runner.file_list, %w(foo bar)
+  end
+
+  def test_constructor_enumerable_wrapping
+    @runner = JSLintJohnson::Runner.new("foo")
+
+    assert_equal @runner.file_list, %w(foo)
+  end
+
+  def test_file_not_found
+    assert_raise RuntimeError do
+      @runner.run
+    end
+  end
+
+  def test_file_found
+    filename = js_filename "valid"
+
+    assert_nothing_raised do
+      JSLintJohnson::Runner.new(filename).run
+    end
+  end
+
+  def test_runtime
+    assert @runner.runtime.is_a?(Johnson::Runtime)
+  end
+
+  def test_runtime_caching
+    first = @runner.runtime
+    assert_equal @runner.runtime.object_id, first.object_id
+  end
+
+  def test_jslint_function_proxy
+    assert_not_nil @runner.jslint_function
+  end
+
+  def test_jslint_result
+    assert @runner.jslint_result.is_a?(Array)
+  end
+
+  def test_jslint_default_options
+    assert @runner.jslint_options.keys.any?
+  end
+
+  def test_jslint_returns_array_of_errors
+    result = @runner.jslint("if(true) alert('foo');")
+    
+    assert result.is_a?(Array)
+    assert result.length > 0
+    assert result.all? {|error| error.is_a?(JSLintJohnson::LintError) }
+  end
+
+  def test_run
+    filename = js_filename("invalid")
+
+    result = JSLintJohnson::Runner.new(filename).run
+
+    assert result.is_a?(Hash)
+    assert result.keys.include?(filename)
+    assert result[filename].is_a?(Array)
+  end
+
+  def test_valid_run
+    filename = js_filename("valid")
+
+    result = JSLintJohnson::Runner.new(filename).run
+
+    errors = result[filename]
+
+    assert errors.nil?
+  end
+
+  def test_invalid_run
+    filename = js_filename("invalid")
+
+    result = JSLintJohnson::Runner.new(filename).run
+
+    errors = result[filename]
+
+    assert errors.any?
+  end
+
+  def test_defined_globals
+    filename = js_filename("defined-globals")
+
+    result = JSLintJohnson::Runner.new(filename).run
+
+    errors = result[filename]
+
+    assert errors.nil?
+  end
+
+  def test_defined_options
+    filename = js_filename("defined-options")
+
+    result = JSLintJohnson::Runner.new(filename).run
+
+    errors = result[filename]
+
+    assert errors.nil?
+  end
+
+  def test_block
+    filename = js_filename("valid")
+
+    count = 0
+
+    JSLintJohnson::Runner.new(filename).run do |file, errors|
+      count += 1
+
+      if count == 1
+        assert_equal file, filename
+        assert_equal errors, []
+      end
+    end
+
+    assert_equal count, 1
+  end
+
+  def test_rejects_successful
+    valid_file = js_filename("valid")
+    invalid_file = js_filename("invalid")
+
+    result = JSLintJohnson::Runner.new([valid_file, invalid_file]).run
+
+    assert_equal result.keys.length, 1
+  end
+end

data/test/test_task.rb

@@ -0,0 +1,124 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+require 'rake'
+require 'tempfile'
+
+class TestTask < Test::Unit::TestCase
+
+  def setup
+    # completely reset the rake application to ensure everything is clean
+    Rake.application = nil
+  end
+
+  def test_creation
+    initial_length = Rake.application.tasks.length
+
+    JSLintJohnson::RakeTask.new
+
+    # the number of tasks should have increased by 1
+    assert_equal initial_length + 1, Rake.application.tasks.length
+  end
+
+  def test_default_name
+    JSLintJohnson::RakeTask.new
+
+    task = Rake.application.lookup("lint")
+
+    assert_equal "lint", task.name
+  end
+
+  def test_default_description
+    JSLintJohnson::RakeTask.new 
+
+    task = Rake.application.lookup("lint")
+
+    assert_equal "Runs the JSLint Test Suite", task.comment
+  end
+
+  def test_default_include_pattern
+    task = JSLintJohnson::RakeTask.new 
+
+    assert_equal "app/javascripts/**/*.js", task.include_pattern
+  end
+
+  def test_default_exclude_pattern
+    task = JSLintJohnson::RakeTask.new
+
+    assert_equal "", task.exclude_pattern
+  end
+
+  def test_default_output_stream
+    task = JSLintJohnson::RakeTask.new
+
+    assert_equal STDOUT, task.output_stream
+  end
+
+  def test_creation_block
+    tempfile = Tempfile.new("foo")
+
+    task = JSLintJohnson::RakeTask.new do |task|
+      task.name = "foo"
+      task.description = "Points out the bad codezzzz"
+      task.include_pattern = "js/**/*.js"
+      task.exclude_pattern = "js/**/*.txt"
+      task.output_stream = tempfile
+    end
+
+    rake_task = Rake.application.lookup("foo")
+
+    assert_equal "foo", rake_task.name
+    assert_equal "Points out the bad codezzzz", rake_task.comment
+    assert_equal "js/**/*.js", task.include_pattern
+    assert_equal "js/**/*.txt", task.exclude_pattern
+    assert_equal tempfile.object_id, task.output_stream.object_id
+  end
+
+  def test_files_to_run
+    task = JSLintJohnson::RakeTask.new do |task|
+      task.include_pattern = File.expand_path("fixtures/*", File.dirname(__FILE__))
+      task.exclude_pattern = File.expand_path("fixtures/*.erb", File.dirname(__FILE__))
+    end
+
+    expected_files = Dir.glob(File.expand_path("fixtures/*.js", File.dirname(__FILE__))).sort
+
+    assert_equal expected_files, task.files_to_run
+  end
+
+  def test_valid_output
+    result = String.new
+
+    task = JSLintJohnson::RakeTask.new do |task|
+      task.include_pattern = File.expand_path("fixtures/valid.js", File.dirname(__FILE__))
+      task.output_stream = StringIO.new(result, "w+")
+    end
+
+    Rake.application.lookup("lint").invoke
+
+    assert_equal erb_fixture("cli-valid-expected-output"), result
+  end
+
+  def test_invalid_output
+    result = String.new
+
+    task = JSLintJohnson::RakeTask.new do |task|
+      task.include_pattern = File.expand_path("fixtures/invalid.js", File.dirname(__FILE__))
+      task.output_stream = StringIO.new(result, "w+")
+    end
+
+    Rake.application.lookup("lint").invoke
+
+    assert_equal erb_fixture("cli-invalid-expected-output"), result
+  end
+
+  def test_suite_output
+    result = String.new
+
+    task = JSLintJohnson::RakeTask.new do |task|
+      task.include_pattern = File.expand_path("fixtures/*.js", File.dirname(__FILE__))
+      task.output_stream = StringIO.new(result, "w+")
+    end
+
+    Rake.application.lookup("lint").invoke
+
+    assert_equal erb_fixture("cli-suite-expected-output"), result
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: jslint-johnson
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- William Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-28 00:00:00 +02:00
+default_executable: jslint-johnson
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: johnson
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: johnson
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :runtime
+  version_requirements: *id003
+description: "    - Ruby gem wrapper for a JSLint CLI.\n    - Uses the Johnson library for performance.\n    - Targeted for usage in CI environments.\n    - Thoroughly tested.\n"
+email: whoward.tke@gmail.com
+executables: 
+- jslint-johnson
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- test/helper.rb
+- test/suite.rb
+- test/test_cli.rb
+- test/test_formatter.rb
+- test/test_lint_error.rb
+- test/test_runner.rb
+- test/test_task.rb
+- bin/jslint-johnson
+has_rdoc: true
+homepage: http://github.com/whoward/jslint-johnson
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: JSLint CLI and rake tasks via johnson
+test_files: 
+- test/helper.rb
+- test/suite.rb
+- test/test_cli.rb
+- test/test_formatter.rb
+- test/test_lint_error.rb
+- test/test_runner.rb
+- test/test_task.rb