pre-commit 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b62fa135fe8f60b7a5eafd7ef58ef2aa9eff6f7
-  data.tar.gz: 0906b075207d03a6958dcbc576c3b4a5f6225990
+  metadata.gz: c7355c40a01a77e3e1a80b3aa54e0fad68f14384
+  data.tar.gz: 523aafecb538cb6ee6212a8aec9b3bb272475c53
 SHA512:
-  metadata.gz: df2e83881c50460571ce4fc36bcff0f4e5127d94b6d3ad3e177d8369fdb642e8b990622a38bc2b0105e766921f765028785a9129f894f763006829b2714e5215
-  data.tar.gz: 41b5486ceaf50650db83d3560ce6cab407d69449ddee3d175d6ea11af2d216d6e96a9eb58e3f86972bcecc7ee4b68e21bd9329f78bda65ffd15a5c09f8954352
+  metadata.gz: 442f543f6a1c50f4346bbb7ff94e0340c255ba81baff3f7a24ed9159f183173302ada1b5dfe92186c86fa587c2501c8318b6483dfbf94f65d032612ed9546f1c
+  data.tar.gz: 066024f84516424170d618568f1177d8ce34c3293131f348772af247143787033e0082341a9979aa6621470cb6b29b8aae88736e9068f60b0068efff0ec733ab

data/README.md

@@ -1,7 +1,11 @@
 A better pre-commit hook for git.
 
-[![Current version](https://badge.fury.io/rb/pre-commit.png)][1] 
-[![Build status](https://secure.travis-ci.org/jish/pre-commit.png?branch=master)][2]
+[![Current version](https://badge.fury.io/rb/pre-commit.png)](https://rubygems.org/gems/pre-commit)
+[![Code Climate](https://codeclimate.com/github/jish/pre-commit.png)](https://codeclimate.com/github/jish/pre-commit)
+[![Coverage Status](https://coveralls.io/repos/jish/pre-commit/badge.png?branch=master)](https://coveralls.io/r/jish/pre-commit?branch=master)
+[![Build status](https://secure.travis-ci.org/jish/pre-commit.png?branch=master)](https://travis-ci.org/jish/pre-commit)
+[![Dependency Status](https://gemnasium.com/jish/pre-commit.png)](https://gemnasium.com/jish/pre-commit)
+[![Documentation](http://b.repl.ca/v1/yard-docs-blue.png)](http://rubydoc.info/gems/pre-commit/frames)
 
 ## Installation
 
@@ -36,6 +40,8 @@ These are the available checks:
 * migrations (Will make sure you check in the proper files after creating a Rails migration)
 * ci (Will run the `pre_commit:ci` rake task and pass or fail accordingly)
 * rubocop (Check ruby code style using the rubocop gem. Rubocop must be installed)
+* before_all (Check your RSpec tests for the use of `before(:all)`)
+* coffeelint (Check your coffeescript files using the [coffeelint gem.](https://github.com/clutchski/coffeelint))
 
 To configure which checks you would like to run, simply set the `pre-commit.checks` git configuration setting.
 
@@ -53,10 +59,13 @@ Note: If no checks are configured, a default set of checks is run:
 
     white_space, console_log, debugger, pry, tabs, jshint, migrations, merge_conflict, local
 
+You may also enable checks that will produce warnings if detected but NOT stop the commit:
+
+    # From your git repo
+    $ git config "pre-commit.warnings" "jshint, ruby_symbol_hashrockets"
+
+
 For the rubocop check, you can tell it what config file to use by setting a path relative to the repo:
 
     # From your git repo
     $ git config "pre-commit.rubocop.config" "config/rubocop.yml"
-
-[1]: https://rubygems.org/gems/pre-commit
-[2]: https://travis-ci.org/jish/pre-commit

data/bin/pre-commit

@@ -3,16 +3,18 @@
 require 'pre-commit/cli'
 
 if ARGV[0] != "install"
-  puts "Usage: pre-commit install"
-  exit(1)
+  abort "Usage: pre-commit install"
 end
 
 if !File.exists?(".git")
-  puts "No .git directory found."
-  exit(1)
+  abort "No .git directory found."
 end
 
-PreCommit::Cli.new.install
+begin
+  PreCommit::Cli.new.install(ARGV[1])
+rescue PreCommit::TemplateNotFound => e
+  abort e.message
+end
 
 puts "Installed hook: #{PreCommit::Cli::PRE_COMMIT_HOOK_PATH}"
 puts

data/lib/plugins/pre_commit/checks/before_all.rb

@@ -0,0 +1,13 @@
+module PreCommit
+  module Checks
+    class BeforeAll
+      def self.call(staged_files)
+        staged_files.reject! { |f| File.extname(f) != ".rb" }
+        return if staged_files.empty?
+        errors = `#{PreCommit::Utils.grep} -e "before.*:all" #{staged_files.join(" ")} | grep -v \/\/`.strip
+        return unless $?.success?
+        "before(:all) found:\n#{errors}"
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/ci.rb

@@ -0,0 +1,12 @@
+module PreCommit
+  module Checks
+    class Ci
+      CI_TASK_NAME = 'pre_commit:ci'
+
+      def self.call(_)
+        return if system("rake #{CI_TASK_NAME} --silent")
+        "your test suite has failed, for the full output run `#{CI_TASK_NAME}`"
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/closure.rb

@@ -0,0 +1,19 @@
+module PreCommit
+  module Checks
+    class Closure
+      #TODO: add pluginator assets support
+      CLOSURE_PATH = File.expand_path("../../../../pre-commit/support/closure/compiler.jar", __FILE__)
+
+      def self.supports(name)
+        name == :closure_syntax_check
+      end
+      def self.call(staged_files)
+        return if staged_files.empty?
+        js_args = staged_files.map {|arg| "--js #{arg}"}.join(' ')
+        errors = `java -jar #{CLOSURE_PATH} #{js_args} --js_output_file /tmp/jammit.js 2>&1`.strip
+        return if errors.empty?
+        errors
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/coffeelint.rb

@@ -0,0 +1,19 @@
+require 'pre-commit/utils'
+require 'stringio'
+require 'open3'
+
+module PreCommit
+  module Checks
+    class Coffeelint
+      def self.call(staged_files)
+        staged_files = staged_files.grep(/\.coffee$/)
+        return if staged_files.empty?
+
+        args = staged_files.join(' ')
+
+        stdout, stderr, result = Open3.capture3("coffeelint #{args}")
+        stdout + stderr unless result.success?
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/console_log.rb

@@ -0,0 +1,13 @@
+module PreCommit
+  module Checks
+    class ConsoleLog
+      def self.call(staged_files)
+        staged_files.reject! { |f| File.extname(f) != ".js" }
+        return if staged_files.empty?
+        errors = `#{PreCommit::Utils.grep} -e "console\\.log" #{staged_files.join(" ")} | grep -v \/\/`.strip
+        return unless $?.success?
+        "console.log found:\n#{errors}"
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/debugger.rb

@@ -0,0 +1,21 @@
+require 'pre-commit/utils'
+
+module PreCommit
+  module Checks
+    class Debugger
+      def self.call(staged_files)
+        files = files_to_check(staged_files)
+        return if files.empty?
+
+        errors = `#{PreCommit::Utils.grep} debugger #{files.join(" ")}`.strip
+        return unless $?.success?
+
+        "debugger statement(s) found:\n#{errors}"
+      end
+
+      def self.files_to_check(files)
+        files.reject { |file| File.basename(file) =~ /^Gemfile/ }
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/gemfile_path.rb

@@ -0,0 +1,14 @@
+require 'pre-commit/utils'
+
+module PreCommit
+  module Checks
+    class GemfilePath
+      def self.call(staged_files)
+        return unless staged_files.include?("Gemfile")
+        errors = `#{PreCommit::Utils.grep} 'path:|:path\\s*=>' Gemfile`.strip
+        return unless $?.success?
+        "local path found in Gemfile:\n#{errors}"
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/js.rb

@@ -0,0 +1,36 @@
+require 'pre-commit/utils'
+
+module PreCommit
+  module Checks
+    class Js
+      def self.call(staged_files)
+        require 'execjs'
+      rescue RuntimeError, LoadError => e
+        $stderr.puts "Could not load execjs: #{e}"
+      else
+        staged_files = staged_files.select { |f| File.extname(f) == ".js" }
+        return if staged_files.empty?
+
+        errors = []
+        staged_files.each do |file|
+          error_list = Array(run_check(file))
+          error_list.each { |error_object| errors << display_error(error_object, file) }
+        end
+
+        return if errors.empty?
+        errors.join("\n")
+      end
+
+      def self.linter_src
+        raise "Must be defined by subclass"
+      end
+
+      def self.display_error(error_object, file)
+        return "" unless error_object
+
+        line = error_object['line'].to_i + 1
+        "#{error_object['reason']}\n#{file}:#{line} #{error_object['evidence']}"
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/jshint.rb

@@ -0,0 +1,24 @@
+require 'plugins/pre_commit/checks/js'
+
+module PreCommit
+  module Checks
+    class Jshint < Js
+      def self.config
+        if config_file = [ENV['JSHINT_CONFIG'], ".jshintrc"].compact.detect { |f| File.exist?(f) }
+          ExecJS.exec("return (#{File.read(config_file)});")
+        else
+          {}
+        end
+      end
+
+      def self.run_check(file)
+        context = ExecJS.compile(File.read(linter_src))
+        context.call("JSHINT", File.read(file), config, config["globals"])
+      end
+
+      def self.linter_src
+        File.expand_path("../../../../pre-commit/support/jshint/jshint.js", __FILE__)
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/jslint.rb

@@ -0,0 +1,24 @@
+require 'plugins/pre_commit/checks/js'
+
+module PreCommit
+  module Checks
+    class Jslint < Js
+      def self.supports(name)
+        [ :js_lint, :js_lint_all, :js_lint_new ].include?(name)
+      end
+
+      def self.run_check(file)
+        context = ExecJS.compile(File.read(linter_src))
+        if !(context.call('JSLINT', File.read(file)))
+          context.exec('return JSLINT.errors;')
+        else
+          []
+        end
+      end
+
+      def self.linter_src
+        File.expand_path("../../../../pre-commit/support/jslint/lint.js", __FILE__)
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/local.rb

@@ -0,0 +1,13 @@
+module PreCommit
+  module Checks
+    class Local
+      DEFAULT_LOCATION = "config/pre-commit.rb"
+
+      def self.call(staged_files, script=DEFAULT_LOCATION)
+        return unless File.exist?(script)
+        output = `ruby #{script} #{staged_files.join(" ")} 2>&1`
+        "#{script} failed:\n#{output}" unless $?.success?
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/merge_conflict.rb

@@ -0,0 +1,12 @@
+module PreCommit
+  module Checks
+    class MergeConflict
+      def self.call(staged_files)
+        return if staged_files.empty?
+        errors = `#{PreCommit::Utils.grep} '<<<<<<<' #{staged_files.join(" ")}`.strip
+        return unless $?.success?
+        "detected a merge conflict\n#{errors}"
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/migration.rb

@@ -0,0 +1,38 @@
+module PreCommit
+  module Checks
+    class Migration
+      def self.supports(name)
+        name == :migrations
+      end
+      class << self
+        def call(staged_files)
+          migration_files = migration_files(staged_files)
+          schema_files = schema_files(staged_files)
+
+          if migration_files.any? && schema_files.none?
+            "It looks like you're adding a migration, but did not update the schema file"
+          elsif migration_files.none? && schema_files.any?
+            "You're trying to change the schema without adding a migration file"
+          elsif migration_files.any? && schema_files.any?
+            versions = migration_files.map { |f| f[/\d+/] }
+            schema = schema_files.map { |f| File.read(f) }.join
+            missing_versions = versions.select { |version| !schema.include?(version) }
+            if missing_versions.any?
+              "You did not add the schema versions for #{versions.join(', ')} to #{schema_files.join(' or ')}"
+            end
+          end
+        end
+
+        private
+
+        def migration_files(staged_files)
+          staged_files.grep(/db\/migrate\/.*\.rb/)
+        end
+
+        def schema_files(staged_files)
+          staged_files.select { |f| File.basename(f) =~ /schema\.rb|structure.*\.sql/ }
+        end
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/nb_space.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module PreCommit
+  module Checks
+    class NbSpace
+      def self.call(staged_files)
+        nb_space = " "
+        raise "you messed that up" unless nb_space.bytes.to_a == [194, 160]
+
+        staged_files.reject! { |f| f =~ /^vendor\// || !File.read(f, encoding: 'utf-8').include?(nb_space) }
+
+        bad = staged_files.map do |file|
+          content = File.read(file).lines.to_a
+          line_no = content.index { |l| l.include?(nb_space) }
+          char_no = content[line_no].index(nb_space)
+          [file, line_no, char_no]
+        end
+
+        return if bad.empty?
+        "Detected non-breaking space in #{bad.map { |f,l,c| "#{f}:#{l+1} character:#{c+1}" }.join(" and")}, remove it!"
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/php.rb

@@ -0,0 +1,27 @@
+require 'pre-commit/utils'
+
+module PreCommit
+  module Checks
+    class Php
+      def self.call(staged_files)
+        staged_files = staged_files.grep /\.(php|engine|theme|install|inc|module|test)$/
+        return if staged_files.empty?
+
+        errors = staged_files.map { |file| run_check(file) }.compact
+        return if errors.empty?
+
+        errors.join("\n")
+      end
+
+      def self.run_check(file)
+        # We force PHP to display errors otherwise they will likely end up in the
+        # error_log and not in stdout.
+        result = `php -d display_errors=1 -l #{file} 2>&1`
+        # Filter out the obvious note from PHP.
+        result = result.split($/).find_all {|line| line !~ /Errors/}.join($/)
+        # If PHP exited non-zero then there was a parse error.
+        result.strip unless $? == 0
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/pry.rb

@@ -0,0 +1,12 @@
+module PreCommit
+  module Checks
+    class Pry
+      def self.call(staged_files)
+        return if staged_files.empty?
+        result = `#{PreCommit::Utils.grep} binding.pry #{staged_files.join(" ")}`.strip
+        return unless $?.success?
+        "binding.pry found:\n#{result}"
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/rspec_focus.rb

@@ -0,0 +1,13 @@
+module PreCommit
+  module Checks
+    class RspecFocus
+      def self.call(staged_files)
+        staged_files = staged_files.grep(/_spec\.rb$/)
+        return if staged_files.empty?
+        result = `#{PreCommit::Utils.grep} ':focus' #{staged_files.join(" ")}`.strip
+        return unless $?.success?
+        ":focus found in specs:\n#{result}"
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/rubocop.rb

@@ -0,0 +1,46 @@
+require 'pre-commit/utils'
+require 'stringio'
+
+module PreCommit
+  module Checks
+    class Rubocop
+      def self.supports(name)
+        [ :rubocop_all, :rubocop_new ].include?(name)
+      end
+      def self.call(staged_files)
+        require 'rubocop'
+      rescue LoadError => e
+        $stderr.puts "Could not find rubocop: #{e}"
+      else
+        staged_files = staged_files.grep(/\.rb$/)
+        return if staged_files.empty?
+        config_file = `git config pre-commit.rubocop.config`.chomp
+
+        args = staged_files
+        if !config_file.empty?
+          if !File.exist? config_file
+            $stderr.puts "Warning: rubocop config file '" + config_file + "' does not exist"
+            $stderr.puts "Set the path to the config file using:"
+            $stderr.puts "\tgit config pre-commit.rubocop.config 'path/relative/to/git/dir/rubocop.yml'"
+            $stderr.puts "rubocop will use its default configuration or look for a .rubocop.yml file\n\n"
+          else
+            args = ['-c', config_file] + args
+          end
+        end
+
+        success, captured = capture { Rubocop::CLI.new.run(args) == 0 }
+        captured unless success
+      end
+
+      def self.capture
+        $stdout, stdout = StringIO.new, $stdout
+        $stderr, stderr = StringIO.new, $stderr
+        result = yield
+        [result, $stdout.string + $stderr.string]
+      ensure
+        $stdout = stdout
+        $stderr = stderr
+      end
+    end
+  end
+end