pre-commit 0.12.0 → 0.13.0

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

@@ -1,13 +1,14 @@
-require 'plugins/pre_commit/checks/js'
+require '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)
+
+      def self.aliases
+        [ :js_lint, :js_lint_all, :js_lint_new ]
       end
 
-      def self.run_check(file)
+      def run_check(file)
         context = ExecJS.compile(File.read(linter_src))
         if !(context.call('JSLINT', File.read(file)))
           context.exec('return JSLINT.errors;')
@@ -16,9 +17,14 @@ module PreCommit
         end
       end
 
-      def self.linter_src
+      def linter_src
         File.expand_path("../../../../pre-commit/support/jslint/lint.js", __FILE__)
       end
+
+      def self.description
+        "Checks javascript files with JSLint."
+      end
+
     end
   end
 end

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

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

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

@@ -1,12 +1,21 @@
+require 'pre-commit/checks/grep'
+
 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}"
+    class MergeConflict < Grep
+
+      def message
+        "detected a merge conflict\n"
       end
+
+      def pattern
+        "'<<<<<<<'"
+      end
+
+      def self.description
+        "Finds files with unresolved merge conflicts."
+      end
+
     end
   end
 end

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

@@ -1,38 +1,44 @@
+require 'pre-commit/checks/plugin'
+
 module PreCommit
   module Checks
-    class Migration
-      def self.supports(name)
-        name == :migrations
+    class Migration < Plugin
+      def self.aliases
+        [: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
+
+      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
+      private
 
-        def migration_files(staged_files)
-          staged_files.grep(/db\/migrate\/.*\.rb/)
-        end
+      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
+      def schema_files(staged_files)
+        staged_files.select { |f| File.basename(f) =~ /schema\.rb|structure.*\.sql/ }
       end
+
+      def self.description
+        "Detects rails database migrations and schema incompatibilities."
+      end
+
     end
   end
 end

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

@@ -1,8 +1,11 @@
 # encoding: utf-8
+require 'pre-commit/checks/plugin'
+
 module PreCommit
   module Checks
-    class NbSpace
-      def self.call(staged_files)
+    class NbSpace < Plugin
+
+      def call(staged_files)
         nb_space = " "
         raise "you messed that up" unless nb_space.bytes.to_a == [194, 160]
 
@@ -18,6 +21,11 @@ module PreCommit
         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
+
+      def self.description
+        "Detected non-breaking spaces 194, 160."
+      end
+
     end
   end
 end

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

@@ -1,9 +1,10 @@
-require 'pre-commit/utils'
+require 'pre-commit/checks/plugin'
 
 module PreCommit
   module Checks
-    class Php
-      def self.call(staged_files)
+    class Php < Plugin
+
+      def call(staged_files)
         staged_files = staged_files.grep /\.(php|engine|theme|install|inc|module|test)$/
         return if staged_files.empty?
 
@@ -13,7 +14,7 @@ module PreCommit
         errors.join("\n")
       end
 
-      def self.run_check(file)
+      def 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`
@@ -22,6 +23,11 @@ module PreCommit
         # If PHP exited non-zero then there was a parse error.
         result.strip unless $? == 0
       end
+
+      def self.description
+        "Detects PHP errors."
+      end
+
     end
   end
 end

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

@@ -1,12 +1,21 @@
+require 'pre-commit/checks/grep'
+
 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}"
+    class Pry < Grep
+
+      def message
+        "binding.pry found:\n"
       end
+
+      def pattern
+        "binding\.pry"
+      end
+
+      def self.description
+        "Finds files with 'binding.pry'."
+      end
+
     end
   end
 end

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

@@ -0,0 +1,17 @@
+require 'pre-commit/checks/plugin'
+
+module PreCommit
+  module Checks
+    class Rails < Plugin
+
+      def self.includes
+        [:ruby, :jshint, :console_log, :migration]
+      end
+
+      def self.description
+        "Plugins common for ruby on rails."
+      end
+
+    end
+  end
+end

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

@@ -1,13 +1,25 @@
+require 'pre-commit/checks/grep'
+
 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}"
+    class RspecFocus < Grep
+
+      def files_filter(staged_files)
+        staged_files.grep(/_spec\.rb$/)
       end
+
+      def message
+        ":focus found in specs:\n"
+      end
+
+      def pattern
+        "':focus'"
+      end
+
+      def self.description
+        "Finds ruby specs with ':focus'."
+      end
+
     end
   end
 end

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

@@ -1,20 +1,26 @@
-require 'pre-commit/utils'
 require 'stringio'
+require 'pre-commit/checks/plugin'
 
 module PreCommit
   module Checks
-    class Rubocop
-      def self.supports(name)
-        [ :rubocop_all, :rubocop_new ].include?(name)
+    class Rubocop < Plugin
+
+      def self.aliases
+        [ :rubocop_all, :rubocop_new ]
+      end
+
+      def self.excludes
+        [ :ruby_symbol_hashrocket ]
       end
-      def self.call(staged_files)
+
+      def 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
+        config_file = config.get_combined('rubocop.config')
 
         args = staged_files
         if !config_file.empty?
@@ -22,17 +28,19 @@ module PreCommit
             $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 "Or in 'config/pre-commit.yml':"
+            $stderr.puts "\trubocop.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 }
+        success, captured = capture { ::Rubocop::CLI.new.run(args) == 0 }
         captured unless success
       end
 
-      def self.capture
+      def capture
         $stdout, stdout = StringIO.new, $stdout
         $stderr, stderr = StringIO.new, $stderr
         result = yield
@@ -41,6 +49,10 @@ module PreCommit
         $stdout = stdout
         $stderr = stderr
       end
+
+      def self.description
+        "Runs rubocop to detect errors."
+      end
     end
   end
 end

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

@@ -0,0 +1,17 @@
+require 'pre-commit/checks/plugin'
+
+module PreCommit
+  module Checks
+    class Ruby < Plugin
+
+      def self.includes
+        [:pry, :local]
+      end
+
+      def self.description
+        "Plugins common for ruby."
+      end
+
+    end
+  end
+end

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

@@ -1,16 +1,25 @@
-require 'pre-commit/utils'
+require 'pre-commit/checks/grep'
 
 module PreCommit
   module Checks
-    class RubySymbolHashrockets
-      HASHROCKET_PATTERN = '[^:](:{1}(?:\$|@|@@|[_A-Za-z])?\w*[=!?]?\s*=>\s*)'
+    class RubySymbolHashrockets < Grep
 
-      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}"
+      def files_filter(staged_files)
+        staged_files.grep(/\.rb$/)
       end
+
+      def message
+        "detected :symbol => value hashrocket:\n"
+      end
+
+      def pattern
+        '\'[^:](:{1}(?:\$|@|@@|[_A-Za-z])?\w*[=!?]?\s*=>\s*)\''
+      end
+
+      def self.description
+        "Finds ruby 1.8 '=>' hash definitions."
+      end
+
     end
   end
 end

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

@@ -1,14 +1,21 @@
+require 'pre-commit/checks/grep'
+
 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}"
+    class Tabs < Grep
+
+      def message
+        "detected tab before initial space:\n"
+      end
+
+      def pattern
+        "'^ *\t'"
       end
+
+      def self.description
+        "Finds ruby files with tabulation character before text in line."
+      end
+
     end
   end
 end