Merge pull request #231 from jish/marcosvm/separate_gofmt_and_go_build

Separate go build and gofmt checks.

Author: mpapis

README.md

@@ -52,7 +52,8 @@ These are the available checks:
 * 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))
-* go (Runs go fmt on a go source file and fail if formatting is incorrect, then runs go build and fails if can't compile)
+* gobuild (Runs go build and fails if can't compile)
+* gofmt (Runs go fmt on go source files and fail if formatting is incorrect)
 * scss_lint (Check your SCSS files using the [scss-lint gem](https://github.com/brigade/scss-lint))
 * yaml (Check that your YAML is parsable)
 * json (Checks if JSON is parsable)

lib/plugins/pre_commit/checks/go.rb

@@ -4,25 +4,13 @@ module PreCommit
   module Checks
     class Go < Plugin
 
-      def call(staged_files)
-        staged_files = staged_files.grep(/\.go$/)
-        return if staged_files.empty?
-
-        errors = staged_files.map { |file| run_check(file) }.compact
-        return if errors.empty?
-
-        errors.join("\n")
+      def self.includes
+        [:gobuild, :gofmt]
       end
 
-      def run_check(file)
-        cmd = "gofmt -l #{file} 2>&1"
-        result = %x[ #{cmd} ]
-        cmd = "go build -o /dev/null #{file} 2>&1"
-        result << %x[ #{cmd} ]
-      end
 
       def self.description
-        "Detects bad Go formatting and compiler errors"
+        "Plugins for Go code"
       end
     end
   end

lib/plugins/pre_commit/checks/go_build.rb

@@ -0,0 +1,27 @@
+require 'pre-commit/checks/plugin'
+
+module PreCommit
+  module Checks
+    class GoBuild < Plugin
+
+      def call(staged_files)
+        staged_files = staged_files.grep(/\.go$/)
+        return if staged_files.empty?
+
+        errors = staged_files.map { |file| run_check(file) }.compact
+        return if errors.empty?
+
+        errors.join("\n")
+      end
+
+      def run_check(file)
+        cmd = "go build -o /dev/null #{file} 2>&1"
+        %x[ #{cmd} ]
+      end
+
+      def self.description
+        "Detects Go compiler errors"
+      end
+    end
+  end
+end

lib/plugins/pre_commit/checks/go_fmt.rb

@@ -0,0 +1,25 @@
+module PreCommit
+  module Checks
+    class GoFmt < Plugin
+
+      def call(staged_files)
+        staged_files = staged_files.grep(/\.go$/)
+        return if staged_files.empty?
+
+        errors = staged_files.map { |file| run_check(file) }.compact
+        return if errors.empty?
+
+        errors.join("\n")
+      end
+
+      def run_check(file)
+        cmd = "gofmt -l #{file} 2>&1"
+        %x[ #{cmd} ]
+      end
+
+      def self.description
+        "Detects bad Go formatting"
+      end
+    end
+  end
+end

test/minitest_helper.rb

@@ -72,6 +72,13 @@ def sh(command, options={})
     result
   end
 
+  def available_checks
+    @available_checks ||=
+    Dir["#{project_dir}/lib/plugins/pre_commit/checks/*.rb"].map{|path|
+      path.gsub(/^.*\/([^\/]*)\.rb$/, "\\1")
+    }.sort.join(" ")
+  end
+
 end; end
 
 class MiniTest::Test

test/unit/plugins/pre_commit/checks/go_test.rb renamed to test/unit/plugins/pre_commit/checks/go_build_test.rb

@@ -1,8 +1,8 @@
 require 'minitest_helper'
-require 'plugins/pre_commit/checks/go'
+require 'plugins/pre_commit/checks/go_build'
 
-describe PreCommit::Checks::Go do
-  let(:check) {PreCommit::Checks::Go.new(nil, nil, [])}
+describe PreCommit::Checks::GoBuild do
+  let(:check) {PreCommit::Checks::GoBuild.new(nil, nil, [])}
 
   it "succeds if nothing changed" do
     check.call([]).must_equal nil
@@ -12,10 +12,6 @@
     check.call([fixture_file('good.go')]).must_equal ""
   end
 
-  it "fails for bad formatted code" do
-    check.call([fixture_file("bad_fmt.go")]).must_match(/bad_fmt.go/)
-  end
-
   it "fails for compiler errors" do
     check.call([fixture_file("dont_compile.go")]).must_match(/imported and not used/)
   end

test/unit/plugins/pre_commit/checks/go_fmt_test.rb

@@ -0,0 +1,19 @@
+require 'minitest_helper'
+require 'plugins/pre_commit/checks/go_fmt'
+
+describe PreCommit::Checks::GoFmt do
+  let(:check) {PreCommit::Checks::GoFmt.new(nil, nil, [])}
+
+  it "succeds if nothing changed" do
+    check.call([]).must_equal nil
+  end
+
+  it "succeeds for good code" do
+    check.call([fixture_file('good.go')]).must_equal ""
+  end
+
+  it "fails for bad formatted code" do
+    check.call([fixture_file("bad_fmt.go")]).must_match(/bad_fmt.go/)
+  end
+
+end unless `which go 2>/dev/null`.empty?

test/unit/pre-commit/cli_test.rb

@@ -46,7 +46,7 @@
     $stderr.string.must_equal('')
     $stdout.string.gsub(/\s+\n/,"\n").must_equal(<<-EXPECTED)
 Available providers: default(0) git(10) git_old(11) yaml(20) env(30)
-Available checks   : before_all ci coffeelint common console_log csslint debugger gemfile_path go jshint jslint json local merge_conflict migration nb_space pry rails rspec_focus rubocop ruby ruby_symbol_hashrockets scss_lint tabs whitespace yaml
+Available checks   : #{available_checks}
 Default   checks   : common rails
 Enabled   checks   : common rails
 Evaluated checks   : tabs nb_space whitespace merge_conflict debugger pry local jshint console_log migration
@@ -77,7 +77,7 @@
     $stderr.string.must_equal('')
     $stdout.string.gsub(/\s+\n/,"\n").must_equal(<<-EXPECTED)
 Available providers: default(0) git(10) git_old(11) yaml(20) env(30)
-Available checks   : before_all ci coffeelint common console_log csslint debugger gemfile_path go jshint jslint json local merge_conflict migration nb_space pry rails rspec_focus rubocop ruby ruby_symbol_hashrockets scss_lint tabs whitespace yaml
+Available checks   : #{available_checks}
 Default   checks   : common rails
 Enabled   checks   : common rails
 Evaluated checks   : tabs nb_space merge_conflict debugger pry local jshint console_log migration
@@ -99,7 +99,7 @@
     $stderr.string.must_equal('')
     $stdout.string.gsub(/\s+\n/,"\n").must_equal(<<-EXPECTED)
 Available providers: default(0) git(10) git_old(11) yaml(20) env(30)
-Available checks   : before_all ci coffeelint common console_log csslint debugger gemfile_path go jshint jslint json local merge_conflict migration nb_space pry rails rspec_focus rubocop ruby ruby_symbol_hashrockets scss_lint tabs whitespace yaml
+Available checks   : #{available_checks}
 Default   checks   : common rails
 Enabled   checks   : common rails
 Evaluated checks   : tabs nb_space merge_conflict debugger pry local jshint console_log migration
@@ -121,7 +121,7 @@
     $stderr.string.must_equal('')
     $stdout.string.gsub(/\s+\n/,"\n").must_equal(<<-EXPECTED)
 Available providers: default(0) git(10) git_old(11) yaml(20) env(30)
-Available checks   : before_all ci coffeelint common console_log csslint debugger gemfile_path go jshint jslint json local merge_conflict migration nb_space pry rails rspec_focus rubocop ruby ruby_symbol_hashrockets scss_lint tabs whitespace yaml
+Available checks   : #{available_checks}
 Default   checks   : common rails
 Enabled   checks   : common rails
 Evaluated checks   : tabs nb_space whitespace merge_conflict debugger pry local jshint console_log migration

test/unit/pre-commit/list_evaluator_test.rb

@@ -22,7 +22,7 @@
   it :list do
     subject.list.gsub(/\s+\n/,"\n").must_equal(<<-EXPECTED)
 Available providers: default(0)
-Available checks   : before_all ci coffeelint common console_log csslint debugger gemfile_path go jshint jslint json local merge_conflict migration nb_space pry rails rspec_focus rubocop ruby ruby_symbol_hashrockets scss_lint tabs whitespace yaml
+Available checks   : #{available_checks}
 Default   checks   :
 Enabled   checks   :
 Evaluated checks   :