fit-commit 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ad77d4fef04820ea606a791e318dfd42b296b76
-  data.tar.gz: 636584b83de8821f587846dd5be38acc2867fdc4
+  metadata.gz: 8699deb0617713906feec2843b053835d4eff93a
+  data.tar.gz: f7131e71ae0921ce4aaf1f6873331b008d769d1f
 SHA512:
-  metadata.gz: d1a1af025a01e22528921a00201e9e6706d8d3c09eec51e51d6b5e55400cb92cbed7e3b87082c069bea2ffc9ce470bf10548e3ed095fd9b96e766d159834f13a
-  data.tar.gz: 2decbff9cb0fb3aa3e88170a962776d9384ed0b54efbfa30fb4db314eb0a739c9cc5baf422133f9d92e786bce9f7bd5a45ac95b658710eeba675452453ad1ae1
+  metadata.gz: f4878977c4b1aa0aadc837053ffb3afddb63c9aeb46d6bd6bf24f78c86dab3da74cf61c41ca4e3cb3de78b8bd3d2737e19cec5e75406e5edf9c234eb2ee36c40
+  data.tar.gz: cac7ba464d93602fb88462dc96de993feb35ca9c5b6b0d10c69f7e4fbede134d2d35b50c81987155125d4bd1a29513687351338080d83e6a87bb258f67791cbf

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### v3.1.0 (2015-09-27)
+- Allow execution from scripts and GUI clients
+
 ### v3.0.1 (2015-09-21)
 - Allow granular configuration overrides
 

data/fit-commit.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.email              = ["foley3@gmail.com"]
   gem.homepage           = "https://github.com/m1foley/fit-commit"
   gem.summary            = "A Git hook to validate your commit messages"
-  gem.description        = "A Git hook to validate your commit messages, based largely on Tim Pope's authoritative guide."
+  gem.description        = "A Git hook to validate your commit messages based on community standards."
   gem.files              = `git ls-files`.split("\n")
   gem.executables        = ["fit-commit"]
   gem.default_executable = "fit-commit"

data/lib/fit_commit/runner.rb

@@ -22,22 +22,30 @@ module FitCommit
       run_validators
       return EXIT_CODE_ALLOW_COMMIT if [errors, warnings].all?(&:empty?)
       print_results
+      allow_commit = errors.empty? || ask_force_commit
 
-      allow_commit = errors.empty?
-      unless allow_commit
-        stderr.print "\nForce commit? [y/n] "
-        return EXIT_CODE_REJECT_COMMIT unless stdin.gets =~ /y/i
-        allow_commit = true
+      if allow_commit
+        stderr.print "\n"
+        EXIT_CODE_ALLOW_COMMIT
+      else
+        EXIT_CODE_REJECT_COMMIT
       end
-
-      stderr.print "\n"
-      allow_commit ? EXIT_CODE_ALLOW_COMMIT : EXIT_CODE_REJECT_COMMIT
     rescue Interrupt # Ctrl-c
       EXIT_CODE_REJECT_COMMIT
     end
 
     private
 
+    def ask_force_commit
+      return unless interactive?
+      stderr.print "\nForce commit? [y/n] "
+      stdin.gets =~ /y/i
+    end
+
+    def interactive?
+      stdin.tty?
+    end
+
     def run_validators
       validators.each do |validator|
         validator.validate(lines)

data/lib/fit_commit/version.rb

@@ -1,3 +1,3 @@
 module FitCommit
-  VERSION = "3.0.1"
+  VERSION = "3.1.0"
 end

data/templates/hooks/commit-msg

@@ -1,13 +1,4 @@
 #!/usr/bin/env sh
-#
-# This hook will attempt to setup your environment before running checks.
-
-if which rvm > /dev/null 2>&1
-then cmd="rvm default do ruby"
-elif which rbenv > /dev/null 2>&1
-then cmd="rbenv exec ruby"
-else cmd="ruby"
-fi
 
 export COMMIT_MESSAGE_PATH=$1
 if [ -z "$COMMIT_MESSAGE_PATH" ]; then
@@ -35,7 +26,19 @@ if [ -z "$GIT_BRANCH_NAME" ]; then
   exit 0
 fi
 
-${cmd} -rrubygems -e '
+if which rvm > /dev/null 2>&1
+then cmd="rvm default do ruby"
+elif which rbenv > /dev/null 2>&1
+then cmd="rbenv exec ruby"
+else cmd="ruby"
+fi
+
+# allow user input if running in a terminal
+if [ -t 1 ]; then
+  exec < /dev/tty
+fi
+
+$cmd -rrubygems -e '
   begin
     require "fit_commit"
     true
@@ -46,4 +49,4 @@ fit-commit: Did you set your Ruby version?
 MESSAGE
     false
   end and FitCommit.run
-' < /dev/tty
+'

data/test/integration/new_repo_test.rb

@@ -5,18 +5,57 @@ require "expect"
 describe "Install and run in a fresh Git repo" do
   BINARY_PATH = File.expand_path("../../../bin/fit-commit", __FILE__)
 
-  it "installs with no errors" do
+  def shell_commands(gitdir)
+    "cd #{gitdir} && git init && #{BINARY_PATH} install && git commit --allow-empty -m '#{commit_message}'"
+  end
+
+  let(:results) do
+    output = ""
     Dir.mktmpdir do |gitdir|
-      results = ""
-      commands = "cd #{gitdir} && git init && #{BINARY_PATH} install && git commit --allow-empty -m fixing"
-      PTY.spawn(commands) do |pty_out, _pty_in, _pty_pid|
-        pty_out.expect(/Force commit\?/, 3) do |expect_out|
-          results << Array(expect_out).join
-          "n"
+      PTY.spawn(shell_commands(gitdir)) do |pty_out, _pty_in, _pty_pid|
+        if user_input
+          pty_out.expect(/Force commit\?/, 3) do |expect_out|
+            output << Array(expect_out).join
+            user_input
+          end
+        else
+          output << pty_out.read
         end
       end
-      assert_match(/^fixing/, results)
-      assert_match(/^1: Error: Message must use imperative present tense/, results)
+    end
+    output
+  end
+
+  describe "invalid commit message" do
+    let(:commit_message) { "fixing foo" }
+    let(:user_input) { "n" }
+    it "disallows commit" do
+      assert_match(/^#{commit_message}/, results)
+      assert_match(/^1: Error: /, results)
+      refute_match(/Warning:/, results)
+      refute_match(/^\[master .+\]/, results)
+    end
+  end
+
+  describe "valid commit message" do
+    let(:commit_message) { "Fix foo" }
+    let(:user_input) { nil }
+    it "allows commit" do
+      refute_match(/^#{commit_message}/, results)
+      refute_match(/Error:/, results)
+      refute_match(/Warning:/, results)
+      assert_match(/^\[master .+\] #{commit_message}/, results)
+    end
+  end
+
+  describe "commit message with warning only" do
+    let(:commit_message) { "X" * 51 }
+    let(:user_input) { nil }
+    it "allows commit" do
+      refute_match(/^#{commit_message}/, results)
+      refute_match(/Error/, results)
+      assert_match(/^1: Warning: /, results)
+      assert_match(/^\[master .+\] #{commit_message}/, results)
     end
   end
 end

data/test/unit/runner_test.rb

@@ -65,31 +65,49 @@ describe FitCommit::Runner do
   describe "commit msg contains errors" do
     let(:commit_msg) { "foo.\nbar" }
 
-    def assert_error_output
+    def assert_error_output(interactive: true)
       stderr_lines = stderr.read.lines.map(&:chomp)
-      assert_equal 8, stderr_lines.size
+      expected_lines = interactive ? 8 : 6
+      assert_equal expected_lines, stderr_lines.size
       assert_equal commit_msg, stderr_lines[0..1].join("\n")
       assert_empty stderr_lines[2]
       assert_match(/\A1: Error: /, stderr_lines[3])
       assert_match(/\A1: Error: /, stderr_lines[4])
       assert_match(/\A2: Error: /, stderr_lines[5])
-      assert_empty stderr_lines[6]
-      assert_equal "Force commit? [y/n] ", stderr_lines[7]
+      if interactive
+        assert_empty stderr_lines[6]
+        assert_equal "Force commit? [y/n] ", stderr_lines[7]
+      end
+    end
+
+    def fake_tty(text)
+      StringIO.new(text).tap do |stringio|
+        def stringio.tty?
+          true
+        end
+      end
     end
 
     describe "user does not force commit" do
-      let(:stdin) { StringIO.new("n") }
+      let(:stdin) { fake_tty("n") }
       it "prints errors to stderr and rejects commit" do
         assert_equal FitCommit::Runner::EXIT_CODE_REJECT_COMMIT, call_runner
         assert_error_output
       end
     end
     describe "user forces commit" do
-      let(:stdin) { StringIO.new("y") }
+      let(:stdin) { fake_tty("y") }
       it "prints errors to stderr and allows commit" do
         assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
         assert_error_output
       end
     end
+    describe "TTY not available" do
+      let(:stdin) { StringIO.new("") }
+      it "prints errors to stderr and rejects commit" do
+        assert_equal FitCommit::Runner::EXIT_CODE_REJECT_COMMIT, call_runner
+        assert_error_output(interactive: false)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fit-commit
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Michael Foley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: swearjar
@@ -52,8 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
-description: A Git hook to validate your commit messages, based largely on Tim Pope's
-  authoritative guide.
+description: A Git hook to validate your commit messages based on community standards.
 email:
 - foley3@gmail.com
 executables: