overcommit 0.40.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae52de060fc3a851e75bd8933c88d554ef099b2c
-  data.tar.gz: d8c64f104d539cb9feff13df03aea820b61ede3b
+  metadata.gz: 27b302156918dca6c24185cf0cbb4c88ee1ff17a
+  data.tar.gz: c537a8ca33fbeaa4aeb0aa73cb47fa6a23beac80
 SHA512:
-  metadata.gz: 601925f353e7745b2461637f4a3d78483593e64e4c227601f0f1df5ff249ac903019fa47c90ec34521b0e416a7108d6bd7446b5aa56a48a1ab35e39359756aad
-  data.tar.gz: 8b6d27df807ce37e4eb94fddb105d22aa39f3b4cc9a233732f005792c8207ce914ddf40ddae87f5394eafda3aab97ff2d39b3951c69c8775147af58766c8cb57
+  metadata.gz: a1c4c0011bb62eea08e898950211af0fa16053067dca6e91c50f06193b889492c5f71c035015e321af3ad35b6b742f49324b205ce4db7de5f337a64cc1fca968
+  data.tar.gz: d550e63d8fc852da8503657c99041304d850dc45936044e16294f7ed72d05d793493059eaf0e357e51cfdf608ea43ecf4a2d435c322bc3e9efa1d1e2bbb1f4e9

data/config/default.yml

@@ -448,6 +448,21 @@ PreCommit:
     install_command: 'pip install pep8'
     include: '**/*.py'
 
+  PhpLint:
+    enabled: false
+    description: 'Testing with PHP lint'
+    required_executable: 'php'
+    command: 'php'
+    flags: ['-l']
+    include: '**/*.php'
+
+  PhpCs:
+    enabled: false
+    description: 'Analyze with PHP_CodeSniffer'
+    command: 'vendor/bin/phpcs'
+    flags: ['--standard=PSR2', '--report=csv']
+    include: '**/*.php'
+
   Pronto:
     enabled: false
     description: 'Analyzing with pronto'

data/lib/overcommit/hook/pre_commit/php_cs.rb

@@ -0,0 +1,48 @@
+module Overcommit::Hook::PreCommit
+  # Runs `phpcs` against any modified PHP files.
+  class PhpCs < Base
+    # Parse `phpcs` csv mode output
+    MESSAGE_REGEX = /^\"(?<file>.+)\",(?<line>\d+),\d+,(?<type>.+),\"(?<msg>.+)\"/
+    MESSAGE_TYPE_CATEGORIZER = lambda do |type|
+      'error'.include?(type) ? :error : :warning
+    end
+
+    def run
+      messages = []
+
+      applicable_files.each do |file|
+        result = execute(command, args: [file])
+        if result.status
+          rows = result.stdout.split("\n")
+
+          # Discard the csv header
+          rows.shift
+
+          # Push each of the errors in the particular file into the array
+          rows.map do |row|
+            messages << row
+          end
+        end
+      end
+
+      return :pass if messages.empty?
+
+      parse_messages(messages)
+    end
+
+    # Transform the CSV output into a tidy human readable message
+    def parse_messages(messages)
+      output = []
+
+      messages.map do |message|
+        message.scan(MESSAGE_REGEX).map do |file, line, type, msg|
+          type = MESSAGE_TYPE_CATEGORIZER.call(type)
+          text = " #{file}:#{line}\n  #{msg}"
+          output << Overcommit::Hook::Message.new(type, file, line.to_i, text)
+        end
+      end
+
+      output
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/php_lint.rb

@@ -0,0 +1,42 @@
+module Overcommit::Hook::PreCommit
+  # Runs `php -l` against any modified PHP files.
+  class PhpLint < Base
+    # Sample String
+    # rubocop:disable Metrics/LineLength
+    #   PHP Parse error:  syntax error, unexpected 'require_once' (T_REQUIRE_ONCE) in site/sumo.php on line 12
+    # rubocop:enable Metrics/LineLength
+    MESSAGE_REGEX = /^(?<type>.+)\:\s+(?<message>.+) in (?<file>.+) on line (?<line>\d+)/
+
+    def run
+      # A list of error messages
+      messages = []
+
+      # Exit status for all of the runs. Should be zero!
+      exit_status_sum = 0
+
+      # Run for each of our applicable files
+      applicable_files.each do |file|
+        result = execute(command, args: [file])
+        output = result.stdout.chomp
+        exit_status_sum += result.status
+        if result.status
+          # `php -l` returns with a leading newline, and we only need the first
+          # line, there is usually some redundancy
+          messages << output.lstrip.split("\n").first
+        end
+      end
+
+      # If the sum of all lint status is zero, then none had exit status
+      return :pass if exit_status_sum == 0
+
+      # No messages is great news for us
+      return :pass if messages.empty?
+
+      # Return the list of message objects
+      extract_messages(
+        messages,
+        MESSAGE_REGEX
+      )
+    end
+  end
+end

data/lib/overcommit/logger.rb

@@ -11,6 +11,12 @@ module Overcommit
     # @param out [IO]
     def initialize(out)
       @out = out
+      @colorize =
+        if ENV.key?('OVERCOMMIT_COLOR')
+          !%w[0 false no].include?(ENV['OVERCOMMIT_COLOR'])
+        else
+          @out.tty?
+        end
     end
 
     # Write output without a trailing newline.
@@ -78,7 +84,7 @@ module Overcommit
     # @param partial [true,false] whether to omit a newline
     def color(code, str, partial = false)
       send(partial ? :partial : :log,
-           @out.tty? ? "\033[#{code}m#{str}\033[0m" : str)
+           @colorize ? "\033[#{code}m#{str}\033[0m" : str)
     end
   end
 end

data/lib/overcommit/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module Overcommit
-  VERSION = '0.40.0'.freeze
+  VERSION = '0.41.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overcommit
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.41.0
 platform: ruby
 authors:
 - Brigade Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-29 00:00:00.000000000 Z
+date: 2017-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -150,6 +150,8 @@ files:
 - lib/overcommit/hook/pre_commit/nginx_test.rb
 - lib/overcommit/hook/pre_commit/pep257.rb
 - lib/overcommit/hook/pre_commit/pep8.rb
+- lib/overcommit/hook/pre_commit/php_cs.rb
+- lib/overcommit/hook/pre_commit/php_lint.rb
 - lib/overcommit/hook/pre_commit/pronto.rb
 - lib/overcommit/hook/pre_commit/puppet_lint.rb
 - lib/overcommit/hook/pre_commit/pycodestyle.rb