jshint 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTFkMWQzYWVjZmExNDEzMDRjYzMwZmI1OTI5OTdiYTUyNWIwZjI2NA==
+  data.tar.gz: !binary |-
+    YTc2MDljNzAwOTZiYjY5NTIyODEyNWEzNWM0ODk2MDY1ZTRkYjIyOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDI0ZDIxYzA0NmY2OGVlMzgxYzMwZTFjMTBiZjUxMTE5NGQ3NjI3OGRjODQy
+    MGQ2YzBkMzdjMGI1NDIxZGMyMjRlOTRhMjM3YzJmNTk2MWNhYWVjMGE5OGFm
+    MjllZGQxNzBkMTdiYTNkNTUzYTI5YjllMTM4YmU3NDUyNDA5OTY=
+  data.tar.gz: !binary |-
+    MjlhZDE4NWM3M2Q5OTc2YmUzMzliMWZmNjBkM2RkMGZiMWQ2MDlkM2IzMzE2
+    YTg5ODY2NTU3Yjg1NzFlMDc2N2M3M2IxYTJlN2YyZjVlY2MzMDVjMzQ2MDc1
+    NWM2YTNmYTdkNGJjNGRiZGJjMWVmMzIzZjcyNjIyOGYwOWE1ODk=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jshint.gemspec
+gemspec
+
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Damian Nicholson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Jshint
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jshint'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jshint
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config/jshint.yml

@@ -0,0 +1,20 @@
+files: ["**/*.js"] # No need to put app/assets/ or vendor/assets here
+options:
+  boss:       true
+  browser:    true
+  curly:      true
+  eqeqeq:     true
+  eqnull:     true
+  expr:       true
+  immed:      true
+  indent:     2
+  latedef:    true
+  newcap:     true
+  noarg:      true
+  sub:        true
+  trailing:   true
+  undef:      true
+  unused:     true
+  globals:
+    jQuery:   true
+    "$":      true

data/jshint.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jshint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jshint"
+  spec.version       = Jshint::VERSION
+  spec.authors       = ["Damian Nicholson"]
+  spec.email         = ["damian.nicholson21@gmail.com"]
+  spec.description   = %q{It achieves this by linting your code through a library called JSHint which catches most code smells, and ensures code consistency}
+  spec.summary       = %q{Ensures your JavaScript code adheres to best practices}
+  spec.homepage      = "http://damiannicholson.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "therubyracer", "~> 0.10.2"
+  spec.add_dependency "execjs", "~> 1.4.0"
+  spec.add_dependency "railties", ">= 3.2.0"
+  spec.add_dependency 'multi_json', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+end

data/lib/jshint.rb

@@ -0,0 +1,11 @@
+require "jshint/version"
+require "jshint/railtie" if defined?(Rails)
+
+module Jshint
+  autoload :Lint, 'jshint/lint'
+  autoload :Configuration, 'jshint/configuration'
+
+  def self.root
+    File.expand_path('../..', __FILE__)
+  end
+end

data/lib/jshint/configuration.rb

@@ -0,0 +1,76 @@
+require 'yaml'
+
+module Jshint
+  class Configuration
+    attr_reader :options
+
+    # @param path [String] The path to the config file
+    def initialize(path = nil)
+      @path = path || default_config_path
+      @options = parse_yaml_config
+    end
+
+    # Returns the value of the options Hash if one exists
+    #
+    # @param key [Symbol]
+    # @return The value of the of the options Hash at the passed in key
+    def [](key)
+      options[key.to_s]
+    end
+
+    # Returns a Hash of global variables if one exists
+    #
+    # @example
+    #   {
+    #     "$" => true,
+    #     jQuery => true,
+    #     angular => true
+    #   }
+    #
+    # @return [Hash, nil] The key value pairs or nil
+    def global_variables
+      options["options"]["globals"]
+    end
+
+    # Returns a Hash of options to be used by JSHint
+    #
+    # See http://jshint.com/docs/options/ for more config options
+    #
+    # @example
+    #   {
+    #     "eqeqeq" => true,
+    #     "indent" => 2
+    #   }
+    # @return [Hash, nil] The key value pairs of options or nil
+    def lint_options
+      options["options"].slice!("globals")
+    end
+
+    # Returns the list of files that JSHint should lint over relatives to the Application root
+    #
+    # @example
+    #   [
+    #     'angular/controllers/*.js',
+    #     'angular/services/*.js'
+    #   ]
+    #
+    # @return [Array<String>] An Array of String files paths
+    def files
+      options["files"]
+    end
+
+    private
+
+    def read_config_file
+      @read_config_file ||= File.open(@path, 'r:UTF-8').read
+    end
+
+    def parse_yaml_config
+      YAML.load(read_config_file)
+    end
+
+    def default_config_path
+      File.join(Rails.root, 'config', 'jshint.yml')
+    end
+  end
+end

data/lib/jshint/lint.rb

@@ -0,0 +1,95 @@
+require "execjs"
+require "multi_json"
+require "jshint/configuration"
+
+module Jshint
+  class Lint
+    attr_reader :errors, :config
+
+    RAILS_JS_ASSET_PATHS = [
+      'app/assets/javascripts',
+      'vendor/assets/javascripts',
+      'lib/assets/javascripts'
+    ]
+
+    def initialize(config_path = nil)
+      @config = Configuration.new(config_path)
+      @errors = {}
+    end
+
+    def lint
+      javascript_files.each do |file|
+        file_content = get_file_content_as_json(file)
+        code = %(
+          JSHINT(#{file_content}, #{jshint_options}, #{jshint_globals});
+          return JSHINT.errors;
+        )
+        errors[file] = context.exec(code)
+      end
+    end
+
+    def get_json(hash)
+      MultiJson.dump(hash)
+    end
+
+    private
+
+    def get_file_content(path)
+      File.open(path, "r:UTF-8").read
+    end
+
+    def get_file_content_as_json(path)
+      content = get_file_content(path)
+      get_json(content)
+    end
+
+    def search_paths
+      paths = RAILS_JS_ASSET_PATHS.dup
+      if files.is_a? Array
+        files.each do |file|
+          paths = paths.map { |path| File.join(path, file) }
+        end
+      else
+        paths = paths.map { |path| File.join(path, files) }
+      end
+
+      paths
+    end
+
+    def files
+      @files ||= config.files
+    end
+
+    def jshint_globals
+      @jshint_globals ||= get_json(config.global_variables)
+    end
+
+    def jshint_options
+      @jshint_options ||= get_json(config.lint_options)
+    end
+
+    def jshint_path
+      File.join(Jshint.root, 'vendor', 'assets', 'javascripts', 'jshint.js')
+    end
+
+    def jshint
+      @jshint ||= get_file_content(jshint_path)
+    end
+
+    def context
+      @context ||= ExecJS.compile("var window = {};\n" + jshint)
+    end
+
+    def javascript_files
+      js_asset_files = []
+      search_paths.each do |path|
+        Dir.glob(path) do |file|
+          js_asset_files << file
+        end
+      end
+
+      js_asset_files
+    end
+
+  end
+end

data/lib/jshint/railtie.rb

@@ -0,0 +1,10 @@
+require 'jshint'
+require 'rails'
+
+module Jshint
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "jshint/tasks/jshint.rake"
+    end
+  end
+end

data/lib/jshint/reporters.rb

@@ -0,0 +1,3 @@
+module Jshint::Reporters
+  autoload :Default, 'jshint/reporters/default'
+end

data/lib/jshint/reporters/default.rb

@@ -0,0 +1,61 @@
+module Jshint::Reporters
+  class Default
+    attr_reader :output
+
+    # Sets up the output string for the final report
+    #
+    # @param results [Hash] Key value pairs containing the filename and associated errors
+    def initialize(results = {})
+      @results = results
+      @output = ''
+    end
+
+    # Loops through all the errors and generates the report
+    #
+    # @example
+    #   foo/bar/baz.js: line 4, col 46, Bad operand.
+    #   foo/bar/baz.js: line 39, col 7, Missing semicolon.
+    #
+    #   2 errors
+    #
+    # @return [String] The default report
+    def report
+      len = 0
+      @results.each do |file, errors|
+        len += errors.length
+        print_errors_for_file(file, errors)
+      end
+      if output
+        print_footer(len)
+        output
+      end
+    end
+
+    # Appends new error strings to the Report output
+    #
+    # @example
+    #   foo/bar/baz.js: line 4, col 46, Bad operand.
+    #   foo/bar/baz.js: line 39, col 7, Missing semicolon.
+    #
+    # @param file [String] The filename containing the errors
+    # @param errors [Array] The errors for the file
+    # @return [void]
+    def print_errors_for_file(file, errors)
+      errors.map do |error|
+        output << "#{file}: line #{error['line']}, col #{error['character']}, #{error['reason']}\n" unless error.nil?
+      end
+    end
+
+    # Appends a footer summary to the Report output
+    #
+    # @example
+    #   1 error
+    #   3 errors
+    #
+    # @param len [Fixnum] The number of errors in this Report
+    # @return [void]
+    def print_footer(len)
+      output << "\n#{len} error#{len === 1 ? nil : 's'}"
+    end
+  end
+end

data/lib/jshint/tasks/jshint.rake

@@ -0,0 +1,23 @@
+require 'jshint'
+require 'jshint/reporters'
+
+namespace :jshint do
+  desc "Runs JSHint, the JavaScript lint tool over this projects JavaScript assets"
+  task :lint => :environment do
+    linter = Jshint::Lint.new
+    linter.lint
+    reporter = Jshint::Reporters::Default.new(linter.errors)
+    puts reporter.report
+  end
+
+  desc "Copies the default JSHint options to your Rails application"
+  task :install_config => :environment do
+    source_file = File.join(Jshint.root, 'config', 'jshint.yml')
+    source_dest = File.join(Rails.root, 'config', '')
+    FileUtils.cp(source_file, source_dest)
+  end
+  task :all => [:lint]
+end
+
+desc "Runs JSHint, the JavaScript lint tool over this projects JavaScript assets"
+task :jshint => ["jshint:all"]