jshint 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.3
+script: rspec spec

data/Gemfile

@@ -4,3 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'pry'
+
+group :test, :development do
+  gem 'coveralls', require: false
+end

data/README.md

@@ -1,24 +1,66 @@
-# Jshint
+# JSHint
 
-TODO: Write a gem description
+[![travis-ci](https://api.travis-ci.org/damian/jshint.png)](http://travis-ci.org/#!/damian/jshint)
+[![Code Climate](https://codeclimate.com/github/damian/jshint.png)](https://codeclimate.com/github/damian/jshint)
+[![Coverage Status](https://coveralls.io/repos/damian/jshint/badge.png?branch=master)](https://coveralls.io/r/damian/jshint?branch=master)
+
+Making it easy to lint your JavaScript assets in any Rails 3.1+ application.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'jshint'
+```ruby
+group :development, :test do
+  gem 'jshint'
+end
+```
 
 And then execute:
 
-    $ bundle
+```ruby
+$ bundle
+```
 
-Or install it yourself as:
+Run the generator:
 
-    $ gem install jshint
+```ruby
+bundle exec rake jshint:install_config
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+To start using JSHint simply run the Rake task:
+
+```ruby
+bundle exec rake jshint
+```
+
+This Rake task runs JSHint across all the JavaScript assets within the following three folders to ensure that they're lint free. Using that data it builds a report which is shown in STDOUT.
+
+```bash
+your-rails-project/app/assets/javascripts
+your-rails-project/vendor/assets/javascripts
+your-rails-project/lib/assets/javascripts
+```
+
+## Configuration
+
+JSHint has some configuration options. You can read the default configuration created by JSHint in your applications config folder.
+
+```yaml
+# your-rails-project/config/jshint.yml
+files: ['**/*.js']
+options:
+  boss: true
+  browser: true
+  ...
+  globals:
+    jQuery: true
+    $: true
+```
+
+For more configuration options see the [JSHint documentation](http://jshint.com/docs/options/).
 
 ## Contributing
 

data/jshint.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "therubyracer", "~> 0.10.2"
+  spec.add_dependency "therubyracer", "~> 0.12.1"
   spec.add_dependency "execjs", "~> 1.4.0"
   spec.add_dependency "railties", ">= 3.2.0"
   spec.add_dependency 'multi_json', '~> 1.0'

data/lib/jshint.rb

@@ -1,10 +1,14 @@
 require "jshint/version"
 require "jshint/railtie" if defined?(Rails)
 
+# Our gems top level namespace
 module Jshint
   autoload :Lint, 'jshint/lint'
   autoload :Configuration, 'jshint/configuration'
 
+  # The absolute path to this gems root
+  #
+  # @return [String] The absolute path
   def self.root
     File.expand_path('../..', __FILE__)
   end

data/lib/jshint/configuration.rb

@@ -1,9 +1,14 @@
 require 'yaml'
 
 module Jshint
+  # Configuration object containing JSHint lint settings
   class Configuration
+
+    # @return [Hash] the configration options
     attr_reader :options
 
+    # Initializes our configuration object
+    #
     # @param path [String] The path to the config file
     def initialize(path = nil)
       @path = path || default_config_path
@@ -15,7 +20,7 @@ module Jshint
     # @param key [Symbol]
     # @return The value of the of the options Hash at the passed in key
     def [](key)
-      options[key.to_s]
+      options["options"][key.to_s]
     end
 
     # Returns a Hash of global variables if one exists
@@ -43,7 +48,7 @@ module Jshint
     #   }
     # @return [Hash, nil] The key value pairs of options or nil
     def lint_options
-      options["options"].slice!("globals")
+      @lint_options ||= options["options"].reject { |key| key == "globals" }
     end
 
     # Returns the list of files that JSHint should lint over relatives to the Application root

data/lib/jshint/lint.rb

@@ -3,20 +3,34 @@ require "multi_json"
 require "jshint/configuration"
 
 module Jshint
+  # Performs the linting of the files declared in our Configuration object
   class Lint
-    attr_reader :errors, :config
 
+    # @return [Hash] A Hash of errors
+    attr_reader :errors
+
+    # @return [Jshint::Configuration] The configuration object
+    attr_reader :config
+
+    # @return [Array] The standard location for JavaScript assets in a Rails project
     RAILS_JS_ASSET_PATHS = [
       'app/assets/javascripts',
       'vendor/assets/javascripts',
       'lib/assets/javascripts'
     ]
 
+    # Sets up our Linting behaviour
+    #
+    # @param config_path [String] The absolute path to a configuration YAML file
+    # @return [void]
     def initialize(config_path = nil)
       @config = Configuration.new(config_path)
       @errors = {}
     end
 
+    # Runs JSHint over each file in our search path
+    #
+    # @return [void]
     def lint
       javascript_files.each do |file|
         file_content = get_file_content_as_json(file)
@@ -28,6 +42,10 @@ module Jshint
       end
     end
 
+    # Converts a Hash in to properly escaped JSON
+    #
+    # @param hash [Hash]
+    # @return [String] The JSON outout
     def get_json(hash)
       MultiJson.dump(hash)
     end
@@ -90,6 +108,5 @@ module Jshint
 
       js_asset_files
     end
-
   end
 end

data/lib/jshint/railtie.rb

@@ -2,6 +2,8 @@ require 'jshint'
 require 'rails'
 
 module Jshint
+
+  # A way to hook in to Rails to load our custom lint Rake task
   class Railtie < Rails::Railtie
     rake_tasks do
       load "jshint/tasks/jshint.rake"

data/lib/jshint/reporters.rb

@@ -1,3 +1,4 @@
+# Top level namespace capable of containing different lint reporting classes
 module Jshint::Reporters
   autoload :Default, 'jshint/reporters/default'
 end

data/lib/jshint/reporters/default.rb

@@ -1,5 +1,8 @@
 module Jshint::Reporters
+  # Outputs a basic lint report suitable for STDOUT
   class Default
+
+    # @return [String] the report output
     attr_reader :output
 
     # Sets up the output string for the final report

data/lib/jshint/version.rb

@@ -1,3 +1,4 @@
 module Jshint
-  VERSION = "0.0.1"
+  # Our gem version
+  VERSION = "0.0.2"
 end

data/spec/fixtures/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/spec/lib/configuration_spec.rb

@@ -2,30 +2,33 @@ require 'spec_helper'
 require 'jshint/configuration'
 
 describe Jshint::Configuration do
-  let(:file) { { "include" => [ 'foo/bar/**/*', 'baz.js' ], "curly" => true } }
-  let(:yaml) { file.to_yaml }
+  let(:config) { File.join(Jshint.root, 'spec', 'fixtures', 'jshint.yml') }
 
-  before do
-    described_class.any_instance.stub(:default_config_path).and_return('/foo/bar.yml')
-    described_class.any_instance.stub(:read_config_file).and_return(yaml)
-    described_class.any_instance.stub(:parse_yaml_config).and_return(YAML.load(yaml))
-  end
+  describe "core behaviour" do
+    before do
+      described_class.any_instance.stub(:default_config_path).and_return('/foo/bar.yml')
+      described_class.any_instance.stub(:parse_yaml_config).and_return(YAML.load_file(config))
+    end
 
-  it "should fall back to the default JSHint config file when one is provided" do
-    described_class.any_instance.should_receive(:default_config_path)
-    config = described_class.new
-    config.options.should == file
-  end
+    it "should allow the developer to index in to config options" do
+      config = described_class.new
+      config[:boss].should be_true
+      config[:browser].should be_true
+    end
 
-  it "should return a hash of options when reading the contents of the passed in config file" do
-    described_class.any_instance.should_not_receive(:default_config_path)
-    config = described_class.new('/bar/baz.yml')
-    config.options.should == file
-  end
+    it "should return a Hash of the global variables declared" do
+      config = described_class.new
+      config.global_variables.should == { "jQuery" => true, "$" => true }
+    end
+
+    it "should return a Hash of the lint options declared" do
+      config = described_class.new
+      config.lint_options.should == config.options["options"].reject { |key| key == "globals" }
+    end
 
-  it "should allow the developer to index in to config options" do
-    config = described_class.new
-    config[:include].should == file["include"]
-    config[:curly].should == file["curly"]
+    it "should return an array of files" do
+      config = described_class.new
+      config.files.should == ["**/*.js"]
+    end
   end
 end

data/spec/lib/lint_spec.rb

@@ -46,6 +46,7 @@ describe Jshint::Lint do
         ))
         subject.lint
       end
+
       it "should add two error messages to the errors Hash" do
         subject.errors[file].length.should == 2
       end
@@ -66,6 +67,11 @@ describe Jshint::Lint do
         subject.lint
       end
 
+      it "should retrieve the files content" do
+        subject.should_receive(:get_file_content_as_json).with(file)
+        subject.lint
+      end
+
       it "should add two error messages to the errors Hash" do
         subject.errors[file].length.should == 0
       end

data/spec/lib/reporters/default_spec.rb

@@ -88,4 +88,25 @@ describe Jshint::Reporters::Default do
       subject.output.should include "'app' is not defined"
     end
   end
+
+  describe :report do
+    it "should call print errors for file 1 time" do
+      subject.should_receive(:print_errors_for_file)
+      subject.report
+    end
+
+    it "should print the report footer" do
+      subject.should_receive(:print_footer).with(3)
+      subject.report
+    end
+
+    it "should return a thorough report" do
+      subject.report.length.should >= 10
+    end
+
+    it "should return 0 errors when it has no results" do
+      subject.instance_variable_set(:@results, {})
+      subject.report.should include "0 errors"
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,6 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'coveralls'
+Coveralls.wear!
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

metadata

@@ -1,32 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: jshint
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Damian Nicholson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: therubyracer
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: 0.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: 0.12.1
 - !ruby/object:Gem::Dependency
   name: execjs
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -83,6 +94,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -90,6 +102,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -97,6 +110,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -104,6 +118,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -111,6 +126,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,6 +134,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -132,6 +149,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -146,6 +164,7 @@ files:
 - lib/jshint/reporters/default.rb
 - lib/jshint/tasks/jshint.rake
 - lib/jshint/version.rb
+- spec/fixtures/jshint.yml
 - spec/jshint_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/lint_spec.rb
@@ -155,28 +174,36 @@ files:
 homepage: http://damiannicholson.com
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 463206555677395138
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 463206555677395138
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Ensures your JavaScript code adheres to best practices
 test_files:
+- spec/fixtures/jshint.yml
 - spec/jshint_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/lint_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!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=