fit-commit 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8699deb0617713906feec2843b053835d4eff93a
-  data.tar.gz: f7131e71ae0921ce4aaf1f6873331b008d769d1f
+  metadata.gz: bb59c8dd8e5d52763773a9a53ccc33a1b4986ed7
+  data.tar.gz: 246cb45ef47a4f77e4dc24ef18c3adc824075bf9
 SHA512:
-  metadata.gz: f4878977c4b1aa0aadc837053ffb3afddb63c9aeb46d6bd6bf24f78c86dab3da74cf61c41ca4e3cb3de78b8bd3d2737e19cec5e75406e5edf9c234eb2ee36c40
-  data.tar.gz: cac7ba464d93602fb88462dc96de993feb35ca9c5b6b0d10c69f7e4fbede134d2d35b50c81987155125d4bd1a29513687351338080d83e6a87bb258f67791cbf
+  metadata.gz: 5cd0c0d67d1eebfbe38ace9b7d7f769af567d6becd2c981489413fa2e66ceb12b4338abe5379951d67a120575af0bb86a42762176d14cebb655c5f20e9c7a64d
+  data.tar.gz: 7a7c003885b3dff14836482a71b065be8cfb6c36687cb9327204898132847b1ca19ab9a58f9505f07338ac0122fc41d620af7876adaab0e797cced33c68746d9

data/.rubocop.yml

@@ -43,3 +43,12 @@ Style/FileName:
 
 Style/DotPosition:
   EnforcedStyle: trailing
+
+Style/IndentationWidth:
+  Enabled: false
+
+Style/ElseAlignment:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/README.md

@@ -14,7 +14,7 @@ foobar foobar foobar foobar foobar foobar foobar foobar foobar foobar foobar
 2: Error: Second line must be blank.
 3: Error: Lines should be <= 72 chars. (76)
 
-Force commit? [y/n] ▊
+Force commit? [y/n/e] ▊
 ```
 
 ## Prerequisites

data/lib/fit_commit/has_errors.rb

@@ -25,6 +25,14 @@ module FitCommit
       merge_hashes(warnings, other_warnings)
     end
 
+    def clear_errors
+      @errors = Hash.new([])
+    end
+
+    def clear_warnings
+      @warnings = Hash.new([])
+    end
+
     private
 
     def merge_hashes(error_hash, other_hash)

data/lib/fit_commit/runner.rb

@@ -18,11 +18,13 @@ module FitCommit
     end
 
     def run
-      return EXIT_CODE_ALLOW_COMMIT if empty_commit?
-      run_validators
-      return EXIT_CODE_ALLOW_COMMIT if [errors, warnings].all?(&:empty?)
-      print_results
-      allow_commit = errors.empty? || ask_force_commit
+      allow_commit = retry_on_user_edit do
+        return EXIT_CODE_ALLOW_COMMIT if empty_commit?
+        run_validators
+        return EXIT_CODE_ALLOW_COMMIT if [errors, warnings].all?(&:empty?)
+        print_results
+        errors.empty? || ask_force_commit
+      end
 
       if allow_commit
         stderr.print "\n"
@@ -36,10 +38,23 @@ module FitCommit
 
     private
 
+    StartOverOnEditException = Class.new(StandardError)
+
+    def retry_on_user_edit
+      yield
+    rescue StartOverOnEditException
+      clear_lines
+      clear_errors
+      clear_warnings
+      edit_message && retry
+    end
+
     def ask_force_commit
       return unless interactive?
-      stderr.print "\nForce commit? [y/n] "
-      stdin.gets =~ /y/i
+      stderr.print "\nForce commit? [y/n/e] "
+      input = stdin.gets
+      fail StartOverOnEditException if input =~ /e/i
+      input =~ /y/i
     end
 
     def interactive?
@@ -78,8 +93,24 @@ module FitCommit
       @lines ||= FitCommit::MessageParser.new(message_path).lines
     end
 
+    def clear_lines
+      @lines = nil
+    end
+
     def empty_commit?
       lines.all?(&:empty?)
     end
+
+    def edit_message
+      system(editor, message_path)
+    end
+
+    DEFAULT_EDITOR = "vim"
+
+    def editor
+      editor = ENV["EDITOR"]
+      editor = DEFAULT_EDITOR unless editor && editor != "none"
+      editor
+    end
   end
 end

data/lib/fit_commit/version.rb

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

data/test/unit/runner_test.rb

@@ -65,10 +65,17 @@ describe FitCommit::Runner do
   describe "commit msg contains errors" do
     let(:commit_msg) { "foo.\nbar" }
 
-    def assert_error_output(interactive: true)
+    def assert_error_output(interactive: true, includes_edit: false)
       stderr_lines = stderr.read.lines.map(&:chomp)
-      expected_lines = interactive ? 8 : 6
-      assert_equal expected_lines, stderr_lines.size
+      if interactive
+        if includes_edit
+          assert_equal 13, stderr_lines.size
+        else
+          assert_equal 8, stderr_lines.size
+        end
+      else
+        assert_equal 6, stderr_lines.size
+      end
       assert_equal commit_msg, stderr_lines[0..1].join("\n")
       assert_empty stderr_lines[2]
       assert_match(/\A1: Error: /, stderr_lines[3])
@@ -76,7 +83,7 @@ describe FitCommit::Runner do
       assert_match(/\A2: Error: /, stderr_lines[5])
       if interactive
         assert_empty stderr_lines[6]
-        assert_equal "Force commit? [y/n] ", stderr_lines[7]
+        assert_match(/\AForce commit\? \[y\/n\/e\] /, stderr_lines[7])
       end
     end
 
@@ -102,6 +109,56 @@ describe FitCommit::Runner do
         assert_error_output
       end
     end
+    describe "user edits commit" do
+      let(:stdin) { fake_tty("e") }
+      describe "editor fails to save" do
+        it "rejects commit" do
+          def runner.edit_message
+            nil # fail code
+          end
+          assert_equal FitCommit::Runner::EXIT_CODE_REJECT_COMMIT, call_runner
+          assert_error_output
+        end
+      end
+      describe "edited message is valid" do
+        before do
+          def runner.edit_message
+            File.open(message_path, "w") do |f|
+              f.print "Valid message"
+            end
+            :success_code
+          end
+        end
+        it "allows commit" do
+          assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
+          assert_error_output
+        end
+      end
+      describe "edited message is invalid" do
+        before do
+          def runner.edit_message
+            File.open(message_path, "w") do |f|
+              f.print "invalid message."
+            end
+            :success_code
+          end
+        end
+        describe "user forces second commit" do
+          let(:stdin) { fake_tty("e\ny") }
+          it "asks again and accepts commit" do
+            assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
+            assert_error_output(includes_edit: true)
+          end
+        end
+        describe "user doesn't force second commit" do
+          let(:stdin) { fake_tty("e\nn") }
+          it "asks again and rejects commit" do
+            assert_equal FitCommit::Runner::EXIT_CODE_REJECT_COMMIT, call_runner
+            assert_error_output(includes_edit: true)
+          end
+        end
+      end
+    end
     describe "TTY not available" do
       let(:stdin) { StringIO.new("") }
       it "prints errors to stderr and rejects commit" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fit-commit
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Michael Foley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2015-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: swearjar