pre-commit 0.11.0 → 0.12.0

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

@@ -0,0 +1,16 @@
+require 'pre-commit/utils'
+
+module PreCommit
+  module Checks
+    class RubySymbolHashrockets
+      HASHROCKET_PATTERN = '[^:](:{1}(?:\$|@|@@|[_A-Za-z])?\w*[=!?]?\s*=>\s*)'
+
+      def self.call(staged_files)
+        return if staged_files.empty?
+        lines = `#{PreCommit::Utils.grep} '#{HASHROCKET_PATTERN}' #{staged_files.join(" ")}`.strip
+        return unless $?.success?
+        "detected :symbol => value hashrocket:\n#{lines}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module PreCommit
+  module Checks
+    class Tabs
+      LEADING_TAB_PATTERN = '^ *\t'
+
+      def self.call(staged_files)
+        return if staged_files.empty?
+        errors = `#{PreCommit::Utils.grep} '#{LEADING_TAB_PATTERN}' #{staged_files.join(" ")}`.strip
+        return unless $?.success?
+        "detected tab before initial space:\n#{errors}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module PreCommit
+  module Checks
+    class Whitespace
+      def self.supports(name)
+        name == :white_space
+      end
+      def self.call(_)
+        errors = `git diff-index --check --cached HEAD -- 2>&1`
+        return if $?.success?
+
+        # Initial commit: diff against the empty tree object
+        if errors =~ /fatal: bad revision 'HEAD'/
+          errors = `git diff-index --check --cached 4b825dc642cb6eb9a060e54bf8d69288fbee4904 -- 2>&1`
+          return if $?.success?
+        end
+
+        errors
+      end
+    end
+  end
+end

data/lib/pre-commit/checks.rb

@@ -1,48 +1,14 @@
+require 'pluginator'
 require 'pre-commit/utils'
-require 'pre-commit/checks/merge_conflict_check'
-require 'pre-commit/checks/tabs_check'
-require 'pre-commit/checks/console_log_check'
-require 'pre-commit/checks/debugger_check'
-require 'pre-commit/checks/local_check'
-require 'pre-commit/checks/nb_space_check'
-require 'pre-commit/checks/jslint_check'
-require 'pre-commit/checks/jshint_check'
-require 'pre-commit/checks/migration_check'
-require 'pre-commit/checks/ci_check'
-require 'pre-commit/checks/php_check'
-require 'pre-commit/checks/pry_check'
-require 'pre-commit/checks/rspec_focus_check'
-require 'pre-commit/checks/ruby_symbol_hashrockets'
-require 'pre-commit/checks/whitespace_check'
-require 'pre-commit/checks/closure_check'
-require 'pre-commit/checks/gemfile_path_check'
-begin
-  require 'pre-commit/checks/rubocop_check'
-rescue LoadError # no rubocop
-end
 
 module PreCommit
-  CHECKS = {
-    :white_space             => WhiteSpaceCheck,
-    :console_log             => ConsoleLogCheck,
-    :js_lint                 => JslintCheck,
-    :jshint                  => JshintCheck,
-    :debugger                => DebuggerCheck,
-    :pry                     => PryCheck,
-    :local                   => LocalCheck,
-    :nb_space                => NbSpaceCheck,
-    :tabs                    => TabsCheck,
-    :closure_syntax_check    => ClosureCheck,
-    :merge_conflict          => MergeConflictCheck,
-    :migrations              => MigrationCheck,
-    :ci                      => CiCheck.new,
-    :php                     => PhpCheck.new,
-    :rspec_focus             => RSpecFocusCheck,
-    :ruby_symbol_hashrockets => RubySymbolHashrockets,
-    :gemfile_path            => GemfilePathCheck
-  }
-
-  CHECKS[:rubocop] = RubocopCheck if defined?(Rubocop)
+
+  DEFAULT_CHECKS = [
+    :white_space, :console_log, :debugger, :pry, :tabs, :jshint,
+    :migrations, :merge_conflict, :local, :nb_space
+  ]
+
+  DEFAULT_WARNINGS = []
 
   # Can not delete this method with out a deprecation strategy.
   # It is refered to in the generated pre-commit hook in versions 0.0-0.1.1
@@ -56,26 +22,68 @@ module PreCommit
   # logic in it. The we have freedom to change the gem implementation however
   # we want, and nobody is forced to update their pre-commit binary.
   def self.checks_to_run
-    checks_to_run = `git config pre-commit.checks`.chomp.split(/,\s*/).map(&:to_sym)
+    @checks_to_run ||= find_plugins(configured_checks)
+  end
 
-    if checks_to_run.empty?
-      CHECKS.values_at(:white_space, :console_log, :debugger, :pry, :tabs, :jshint,
-        :migrations, :merge_conflict, :local, :nb_space)
-    else
-      [:js_lint, :rubocop].each do |check|
-        if checks_to_run.delete("#{check}_all".to_sym) || checks_to_run.delete("#{check}_new".to_sym)
-          $stderr.puts "please use just '#{check}' as check name"
-          checks_to_run << check
-        end
-      end
-
-      CHECKS.values_at(*checks_to_run)
-    end.compact
+  def self.warnings_to_run
+    @warnings_to_run ||= find_plugins(configured_warnings)
+  end
+
+  def self.configured_checks
+    @configured_checks   ||= get_git_config('checks',   DEFAULT_CHECKS)
+  end
+
+  def self.configured_warnings
+    @configured_warnings ||= get_git_config('warnings', DEFAULT_WARNINGS)
+  end
+
+  def self.get_git_config(name, default)
+    array_or_default(
+      `git config pre-commit.#{name}`.chomp.split(/,\s*/).map(&:to_sym),
+      default
+    )
+  end
+
+  def self.array_or_default(list, default)
+    list = default if list.nil? || list.empty?
+    list
+  end
+
+  def self.find_plugins(names)
+    names.map{|name| find_plugin(name) }.compact
+  end
+
+  def self.find_plugin(name)
+    pluginator.first_class('checks', name) ||
+    pluginator.first_ask('checks', 'supports', name) ||
+    begin
+      $stderr.puts "Could not find plugin supporting #{name}."
+      nil
+    end
+  end
+
+  def self.pluginator
+    @pluginator ||= Pluginator.find('pre_commit', :extends => [:first_ask, :first_class] )
+  end
+
+  def self.execute_list(list)
+    list.map { |cmd| cmd.call(@staged_files.dup) }.compact
   end
 
   def self.run
-    staged_files = Utils.staged_files
-    errors = checks_to_run.map { |cmd| cmd.call(staged_files.dup) }.compact
+    @staged_files = Utils.staged_files
+    show_warnings( execute_list(warnings_to_run) )
+    show_errors(   execute_list(checks_to_run  ) )
+  end
+
+  def self.show_warnings(warnings)
+    if warnings.any?
+       $stderr.puts "pre-commit: Some warnings were raised. These will not stop commit:"
+       $stderr.puts warnings.join("\n")
+    end
+  end
+
+  def self.show_errors(errors)
     if errors.any?
       $stderr.puts "pre-commit: Stopping commit because of errors."
       $stderr.puts errors.join("\n")

data/lib/pre-commit/cli.rb

@@ -1,15 +1,42 @@
 require 'fileutils'
 
 module PreCommit
+
+  TemplateNotFound = Class.new(StandardError)
+
   class Cli
 
     PRE_COMMIT_HOOK_PATH = '.git/hooks/pre-commit'
+    TEMPLATE_DIR = File.expand_path("../support/templates/", __FILE__)
+
+    attr_reader :templates
+
+    def initialize
+      @templates = load_templates
+    end
+
+    def install(key = nil)
+      key ||= "default"
+      hook = templates[key.sub(/^--/, "")]
+
+      raise TemplateNotFound.new("Could not find template #{key}") unless hook
 
-    def install
-      hook = File.expand_path("../support/templates/pre-commit-hook", __FILE__)
       FileUtils.cp(hook, PRE_COMMIT_HOOK_PATH)
       FileUtils.chmod(0755, PRE_COMMIT_HOOK_PATH)
     end
 
+    private
+
+    def load_templates
+      pattern = File.join(TEMPLATE_DIR, "*_hook")
+
+      Dir.glob(pattern).inject({}) do |hash, file|
+        key = file.match(/\/([^\/]+?)_hook$/)[1]
+        hash[key] = file
+
+        hash
+      end
+    end
+
   end
 end

data/lib/pre-commit/support/templates/automatic_hook

@@ -0,0 +1,35 @@
+#!/usr/bin/env sh
+
+# This hook has a focus on portability.
+# This hook will attempt to setup your environment before running checks.
+#
+# If you would like `pre-commit` to get out of your way and you are comfortable
+# setting up your own environment, you can install the manual hook using:
+#
+#     pre-commit install --manual
+#
+
+cmd=`git config pre-commit.ruby 2>/dev/null`
+if   test -n "${cmd}"
+then true
+elif which rvm > /dev/null
+then cmd="rvm default do ruby"
+elif which rbenv > /dev/null
+then cmd="rbenv exec ruby"
+else cmd="ruby"
+fi
+
+export rvm_silence_path_mismatch_check_flag=1
+
+${cmd} -rrubygems -e '
+  begin
+    require "pre-commit"
+    true
+  rescue LoadError => e
+    $stderr.puts <<-MESSAGE
+pre-commit: WARNING: Skipping checks because: #{e}
+pre-commit: Did you set your Ruby version?
+MESSAGE
+    false
+  end and PreCommit.run
+'

data/lib/pre-commit/support/templates/default_hook

@@ -0,0 +1,35 @@
+#!/usr/bin/env sh
+
+# This hook has a focus on portability.
+# This hook will attempt to setup your environment before running checks.
+#
+# If you would like `pre-commit` to get out of your way and you are comfortable
+# setting up your own environment, you can install the manual hook using:
+#
+#     pre-commit install --manual
+#
+
+cmd=`git config pre-commit.ruby 2>/dev/null`
+if   test -n "${cmd}"
+then true
+elif which rvm > /dev/null
+then cmd="rvm default do ruby"
+elif which rbenv > /dev/null
+then cmd="rbenv exec ruby"
+else cmd="ruby"
+fi
+
+export rvm_silence_path_mismatch_check_flag=1
+
+${cmd} -rrubygems -e '
+  begin
+    require "pre-commit"
+    true
+  rescue LoadError => e
+    $stderr.puts <<-MESSAGE
+pre-commit: WARNING: Skipping checks because: #{e}
+pre-commit: Did you set your Ruby version?
+MESSAGE
+    false
+  end and PreCommit.run
+'

data/lib/pre-commit/support/templates/manual_hook

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# This hook has a focus on simplicity.
+# This hook puts the burden on you to set up your environment properly.
+#
+# If you would like `pre-commit` to attempt to setup your environment for you
+# before the checks run, you can install the automatic environment hook using:
+#
+#     pre-commit install --automatic
+#
+
+require 'pre-commit'
+
+PreCommit.run

metadata

@@ -1,24 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: pre-commit
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Shajith Chacko, Josh Lubaway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2013-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: execjs
+  name: pluginator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !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: guard
+  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: guard-minitest
+  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: minitest
+  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: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -32,38 +102,43 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- lib/pre-commit/checks/ci_check.rb
-- lib/pre-commit/checks/closure_check.rb
-- lib/pre-commit/checks/console_log_check.rb
-- lib/pre-commit/checks/debugger_check.rb
-- lib/pre-commit/checks/gemfile_path_check.rb
-- lib/pre-commit/checks/js_check.rb
-- lib/pre-commit/checks/jshint_check.rb
-- lib/pre-commit/checks/jslint_check.rb
-- lib/pre-commit/checks/local_check.rb
-- lib/pre-commit/checks/merge_conflict_check.rb
-- lib/pre-commit/checks/migration_check.rb
-- lib/pre-commit/checks/nb_space_check.rb
-- lib/pre-commit/checks/php_check.rb
-- lib/pre-commit/checks/pry_check.rb
-- lib/pre-commit/checks/rspec_focus_check.rb
-- lib/pre-commit/checks/rubocop_check.rb
-- lib/pre-commit/checks/ruby_symbol_hashrockets.rb
-- lib/pre-commit/checks/tabs_check.rb
-- lib/pre-commit/checks/whitespace_check.rb
+- lib/plugins/pre_commit/checks/before_all.rb
+- lib/plugins/pre_commit/checks/ci.rb
+- lib/plugins/pre_commit/checks/closure.rb
+- lib/plugins/pre_commit/checks/coffeelint.rb
+- lib/plugins/pre_commit/checks/console_log.rb
+- lib/plugins/pre_commit/checks/debugger.rb
+- lib/plugins/pre_commit/checks/gemfile_path.rb
+- lib/plugins/pre_commit/checks/js.rb
+- lib/plugins/pre_commit/checks/jshint.rb
+- lib/plugins/pre_commit/checks/jslint.rb
+- lib/plugins/pre_commit/checks/local.rb
+- lib/plugins/pre_commit/checks/merge_conflict.rb
+- lib/plugins/pre_commit/checks/migration.rb
+- lib/plugins/pre_commit/checks/nb_space.rb
+- lib/plugins/pre_commit/checks/php.rb
+- lib/plugins/pre_commit/checks/pry.rb
+- lib/plugins/pre_commit/checks/rspec_focus.rb
+- lib/plugins/pre_commit/checks/rubocop.rb
+- lib/plugins/pre_commit/checks/ruby_symbol_hashrockets.rb
+- lib/plugins/pre_commit/checks/tabs.rb
+- lib/plugins/pre_commit/checks/whitespace.rb
 - lib/pre-commit/checks.rb
 - lib/pre-commit/cli.rb
 - lib/pre-commit/runner.rb
 - lib/pre-commit/support/closure/compiler.jar
 - lib/pre-commit/support/jshint/jshint.js
 - lib/pre-commit/support/jslint/lint.js
-- lib/pre-commit/support/templates/pre-commit-hook
+- lib/pre-commit/support/templates/automatic_hook
+- lib/pre-commit/support/templates/default_hook
+- lib/pre-commit/support/templates/manual_hook
 - lib/pre-commit/utils.rb
 - lib/pre-commit.rb
 - README.md
 - bin/pre-commit
 homepage: http://github.com/jish/pre-commit
-licenses: []
+licenses:
+- Apache 2.0
 metadata: {}
 post_install_message: 
 rdoc_options:
@@ -83,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.1
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 3
 summary: A slightly better git pre-commit hook