roger_jshint 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 173aefd6d7edd876af67a041bbe007a505f26519
-  data.tar.gz: 87c805c257ed31095a847af6596c9ad6d1a78791
+  metadata.gz: 831b789d136a29882a93611f9b681b2969c1e4b7
+  data.tar.gz: 18a9adf0b8b9f8a202235539116086b76fa7d88f
 SHA512:
-  metadata.gz: 7505cad99b8b2c88085c7d3bb843af5dde840e87d80eea935409050facbf223bd672b67d183494f0ce9ced312b2b9d699bf83001d7b082174ff81ce69b71620f
-  data.tar.gz: 365153eb8ab08abca4e8d5d61295c4854139b7db992bac137e4f32d368abb1d18e522aaf71988818684a9e6bbcf6f58809fa8237293071ea9134e457acecd668
+  metadata.gz: 34f1c96665169c62f181330510cb51c4a28ab758ddde4f6d3aabefe0a5290cdae07330963a2d4cab5905f416f2c1363df1d7a10f6a37f89ecf64d0e5b586ce76
+  data.tar.gz: bdc7d1e2ede0c399d3f41fa495485fffa19e77e09f171889ce6db3c5661b385a8c2443cf9183c9d8628854dec6320baccfba51500efcfca560b105c4c22f58f6

data/.gitignore

@@ -26,7 +26,7 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/.rubocop.yml

@@ -0,0 +1,6 @@
+LineLength:
+  Max: 100
+
+Style/HashSyntax:
+  Enabled:
+    False

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.5
+  - 2.2.0
+before_script:
+  - npm install jshint
+  - cp ./test/jshintrc .jshintrc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -1,5 +1,6 @@
 roger_jshint
 ============
+[![Build Status](https://travis-ci.org/hkrutzer/roger_jshint.svg?branch=master)](https://travis-ci.org/hkrutzer/roger_jshint)
 
 Lint JavaScript files from within Roger. This plugin uses [jshint](https://github.com/jshint/jshint). If present, .jshintrc in your project will be used. If not, jshint will walk the directory tree upwards until a .jshintrc file is found. As a last resort, [jshint's default configuration](https://raw.githubusercontent.com/jshint/jshint/master/examples/.jshintrc) is used.
 
@@ -22,4 +23,4 @@ Execute ```roger test jshint```.
 
 ## License
 
-This project is released under the [MIT license](LICENSE).
+This project is released under the [MIT license](LICENSE).

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+task :default => [:test, :rubocop]
+
+desc 'Run rubocop'
+task :rubocop do
+  RuboCop::RakeTask.new
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/lib/roger_jshint/lint.rb

@@ -1,28 +1,29 @@
+require 'shellwords'
 require 'json'
 require 'roger/test'
 
 module RogerJsHint
   # JS linter plugin for Roger
   class Lint
-    JSHINT = 'jshint'
-    JSHINT_COMMAND = "#{JSHINT} --reporter=" +
-                     File.expand_path('jsonreporter.js', File.dirname(__FILE__)) + ' '
-
     # @param [Hash] options The options
     # @option options [Array] :match Files to match
-    # @option options [Array[Regexp]] :skip An array of file regular expressions to specifiy which files to skip.
+    # @option options [Array[Regexp]] :skip Array of regular expressions to skip files
+    # @option options [Array] :jshint Jshint command
     def initialize(options = {})
       @options = {
         :match => ['html/**/*.js'],
-        :skip => []
+        :skip => [],
+        :jshint => 'jshint'
       }
       @options.update(options) if options
+
+      @jshint_command = "#{@options[:jshint]} --reporter=" +
+                        File.expand_path('jsonreporter.js', File.dirname(__FILE__)) + ' '
     end
 
     def detect_jshint
-      `#{JSHINT} -v`
-      rescue Errno::ENOENT
-        raise 'Could not find jshint. Install jshint using npm.'
+      detect = system(format('%s -v 2>/dev/null', Shellwords.escape(@options[:jshint])))
+      fail 'Could not find jshint. Install jshint using npm.' unless detect
     end
 
     def report(test, file_path, lints)
@@ -31,9 +32,7 @@ module RogerJsHint
         test.log(self, "No erors in #{file_path}")
       else
         lints.each do |lint|
-          test.log(self,
-                   "#{lint[0]}:#{lint[1]} " \
-                   "#{lint[2]}: #{lint[3]}")
+          test.log(self, "#{lint[0]}:#{lint[1]} #{lint[2]}: #{lint[3]}")
         end
         success = false
       end
@@ -42,7 +41,7 @@ module RogerJsHint
 
     # @param [Hash] options The options
     # @option options [Array] :match Files to match
-    # @option options [Array[Regexp]] :skip An array of file regular expressions to specifiy which files to skip.
+    # @option options [Array[Regexp]] :skip Array of regular expressions to skip files
     def call(test, options)
       options = {}.update(@options).update(options)
 
@@ -50,13 +49,10 @@ module RogerJsHint
       test.log(self, 'JS-linting files')
 
       test.get_files(options[:match], options[:skip]).each do |file_path|
-        output = `#{JSHINT_COMMAND} #{file_path}`
-        if output.start_with? 'ERROR'
-          fail "Could not load file #{file_path}"
-        else
-          lint = JSON.parse output
-          report(test, file_path, lint)
-        end
+        execute = @jshint_command + ' ' + Shellwords.escape(file_path)
+        output = `#{execute}`
+        lint = JSON.parse output
+        report(test, file_path, lint)
       end
     end
   end

data/lib/roger_jshint.rb

@@ -1,3 +1,5 @@
-module RogerJsHint; end
+# JS hint plugin
+module RogerJsHint
+end
 
 require File.dirname(__FILE__) + '/roger_jshint/lint'

data/roger_jshint.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.authors = ['Hans Krutzer']
   s.email = ['info@digitpaint.nl', 'hans@digitpaint.nl']
   s.name = 'roger_jshint'
-  s.version = '0.0.2'
+  s.version = '0.1.0'
   s.homepage = 'https://github.com/hkrutzer/roger_scsslinter'
 
   s.summary = 'Lint JavaScript files within Roger'
@@ -20,4 +20,8 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_dependency 'roger', '~> 0.13', '>= 0.13.0'
+
+  s.add_development_dependency 'rubocop', ['>= 0']
+  s.add_development_dependency 'rake', ['>= 0']
+  s.add_development_dependency 'test-unit', ['>= 0']
 end

data/test/jshintrc

@@ -0,0 +1,89 @@
+{
+  /*
+   * ENVIRONMENTS
+   * =================
+   */
+
+  // Define globals exposed by modern browsers.
+  "browser": true,
+
+  // Define globals exposed by jQuery.
+  "jquery": true,
+
+  // Define globals exposed by Node.js.
+  "node": true,
+
+  // Placeholder for your own predefs 
+  "predef": [],
+
+  /*
+   * ENFORCING OPTIONS
+   * =================
+   */
+
+  // Force all variable names to use either camelCase style or UPPER_CASE
+  // with underscores.
+  "camelcase": true,
+
+  // Prohibit use of == and != in favor of === and !==.
+  "eqeqeq": true,
+
+  // Suppress warnings about == null comparisons.
+  "eqnull": true,
+
+  // Enforce tab width of 2 spaces.
+  "indent": 2,
+
+  // Prohibit use of a variable before it is defined.
+  "latedef": true,
+
+  // Require capitalized names for constructor functions.
+  "newcap": true,
+
+  // Enforce use of single quotation marks for strings.
+  "quotmark": "single",
+
+  // Prohibit trailing whitespace.
+  "trailing": true,
+
+  // Prohibit use of explicitly undeclared variables.
+  "undef": true,
+
+  // Warn when variables are defined but never used.
+  "unused": true,
+
+  // Enforce line length to 100 characters
+  "maxlen": 100,
+
+  // Enforce placing 'use strict' at the top function scope
+  "strict": true,
+
+  // Extra options by Digitpaint
+
+  // Always put curly braces around blocks in loops and conditionals
+  "curly": true,
+
+  // Prohibits the use of arguments.caller and arguments.callee
+  "noarg": true,
+
+  // Supress warnings about mixed tabs/spaces when used for alignment.
+  "smarttabs" : true,
+
+  // Prohibit use of constructors for side-effects.
+  "nonew": true,
+
+  // Allow the use of ++ and --
+  "plusplus" : false,
+
+  // Tolerate all forms of subscript notation besides dot notation e.g. `dict['key']` instead of `dict.key`.
+  "subsub": false,
+
+  /*
+   * OPTIONAL OPTIONS
+   * =================
+   */
+
+  // Do not allow bitwise operations
+  "bitwise": true
+}
+

data/test/lint_test.rb

@@ -0,0 +1,38 @@
+require_relative '../lib/roger_jshint/lint.rb'
+require 'test/unit'
+
+# Fake tester to pass into the linter plugin
+class TesterStub
+  attr_reader :messages
+
+  def initialize
+    @messages = []
+  end
+
+  def log(_, message)
+    @messages.push(message)
+  end
+
+  def get_files(_, _)
+    ['test/test.js']
+  end
+end
+
+# Linting plugin unit test
+class LintTest < Test::Unit::TestCase
+  def test_lint
+    faketester = TesterStub.new
+
+    linter = RogerJsHint::Lint.new
+    linter.call(faketester, {})
+
+    messages = faketester.messages
+    messages.shift
+
+    assert_equal(messages,
+                 ["test/test.js:0 0: Bad option: 'subsub'.",
+                  "test/test.js:1 1: 'x' is not defined.",
+                  "test/test.js:2 1: 'alert' is not defined.",
+                  "test/test.js:2 7: 'x' is not defined."])
+  end
+end

data/test/test.js

@@ -0,0 +1,2 @@
+x = 5;
+alert(x);

metadata

@@ -1,35 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: roger_jshint
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Hans Krutzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-30 00:00:00.000000000 Z
+date: 2015-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: test-unit
+  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'
 description: |2
       Lint JavaScript files from within Roger, using jshint.
       Will use .jshintrc.
@@ -40,13 +82,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - lib/roger_jshint.rb
 - lib/roger_jshint/jsonreporter.js
 - lib/roger_jshint/lint.rb
 - roger_jshint.gemspec
+- test/jshintrc
+- test/lint_test.rb
+- test/test.js
 homepage: https://github.com/hkrutzer/roger_scsslinter
 licenses:
 - MIT
@@ -57,17 +106,17 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Lint JavaScript files within Roger