fit-commit 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d0e5940862e5d3bb79d5e2fd77eab59035ecb41
-  data.tar.gz: 2fa241ffb6eae0aa6cfbfda5d12f8cba52bf4823
+  metadata.gz: c77c51765ec627e156a600d56c8b1482177a5c5c
+  data.tar.gz: caa7c6910ee5dace99a7f0e803c8e06695a7f91b
 SHA512:
-  metadata.gz: 3024e9600be177394c86f8037f08d2ee8b0253008b22352da8b36378b9557511db17e9dd88c5f6efa03f37d68acc6a7b39b26bf1584fe63bfde58902bf8a590f
-  data.tar.gz: e6ce9e0c4df171f734ad6dd613662e8d35fe31d7de4dc361a2f9546666b90cabce6709497d0b844aa670546cffdbca0347efc5feffcf3ac9484f3c6303a2701a
+  metadata.gz: 1a2d08fbaf7df3343c3cec005bd5bde68d3837775c3c3659e7aea47aca5f48315abfc45c9e237f609016d6f876196bc640f417717b3b2a0df82c90ddf208ab90
+  data.tar.gz: 76b7092a38bed2ca405ffc9bf000a004689939b6aa9caa6c370a313747c6f5aae965683d4afd8d93e417cfe8d14cbec5168f01483e47a3a865bc5a6f048fa029

data/README.md

@@ -43,9 +43,9 @@ This creates a `.git/hooks/commit-msg` script which will automatically check you
 
 ## Configuration
 
-Settings are read from these files, in increasing precedence: `/etc/fit_commit.yml`, `$HOME/.fit_commit.yml`, `config/fit_commit.yml`, `./.fit_commit.yml`.
+Settings are read from these files in increasing precedence: `/etc/fit_commit.yml`, `$HOME/.fit_commit.yml`, `config/fit_commit.yml`, `./.fit_commit.yml`.
 
-The default settings are:
+These are the default settings that can be overridden:
 
 ```yaml
 ---
@@ -69,7 +69,7 @@ Validators/Frathouse:
 The `Enabled` property accepts multiple formats:
 
 ```yaml
-# true/false are branch agnostic
+# true/false to enable/disable the validation (branch agnostic)
 Validators/Foo:
   Enabled: false
 # Array of String/Regex matching each branch for which it's enabled
@@ -86,13 +86,14 @@ First set your global Git template directory:
 
 ```
 $ git config --global init.templatedir '~/.git_template'
+$ mkdir -p ~/.git_template/hooks
 ```
 
 Now you can copy the hooks you want installed in new repos by default:
 
 ```
 # From a repo where Fit Commit is already installed
-$ cp .git/hooks/commit-msg ~/.git_templates/hooks/commit-msg
+$ cp .git/hooks/commit-msg ~/.git_template/hooks/commit-msg
 ```
 
 To copy your default hooks into existing repos:

data/lib/fit_commit/runner.rb

@@ -9,11 +9,11 @@ module FitCommit
     EXIT_CODE_ALLOW_COMMIT  = 0
     EXIT_CODE_REJECT_COMMIT = 1
 
-    attr_accessor :message_path, :branch_name, :stdout, :stdin
-    def initialize(message_path, branch_name, stdout = $stdout, stdin = $stdin)
+    attr_accessor :message_path, :branch_name, :stderr, :stdin
+    def initialize(message_path, branch_name, stderr = $stderr, stdin = $stdin)
       self.message_path = message_path
       self.branch_name = branch_name
-      self.stdout = stdout
+      self.stderr = stderr
       self.stdin = stdin
     end
 
@@ -25,12 +25,12 @@ module FitCommit
 
       allow_commit = errors.empty?
       unless allow_commit
-        stdout.print "\nForce commit? [y/n] "
+        stderr.print "\nForce commit? [y/n] "
         return EXIT_CODE_REJECT_COMMIT unless stdin.gets =~ /y/i
         allow_commit = true
       end
 
-      stdout.print "\n"
+      stderr.print "\n"
       allow_commit ? EXIT_CODE_ALLOW_COMMIT : EXIT_CODE_REJECT_COMMIT
     rescue Interrupt # Ctrl-c
       EXIT_CODE_REJECT_COMMIT
@@ -52,16 +52,16 @@ module FitCommit
 
     def print_results
       unless errors.empty?
-        stdout.puts lines
-        stdout.print "\n"
+        stderr.puts lines
+        stderr.print "\n"
       end
 
       (errors.keys | warnings.keys).sort.each do |lineno|
         errors[lineno].each do |error|
-          stdout.puts "#{lineno}: Error: #{error}"
+          stderr.puts "#{lineno}: Error: #{error}"
         end
         warnings[lineno].each do |warning|
-          stdout.puts "#{lineno}: Warning: #{warning}"
+          stderr.puts "#{lineno}: Warning: #{warning}"
         end
       end
     end

data/lib/fit_commit/version.rb

@@ -1,3 +1,3 @@
 module FitCommit
-  VERSION = "2.2.0"
+  VERSION = "2.2.1"
 end

data/test/runner_test.rb

@@ -8,7 +8,7 @@ describe FitCommit::Runner do
 
   def call_runner
     exit_code = runner.run
-    stdout.rewind
+    stderr.rewind
     exit_code
   end
 
@@ -18,34 +18,34 @@ describe FitCommit::Runner do
       f.close
     end
   end
-  let(:stdout) { StringIO.new }
+  let(:stderr) { StringIO.new }
   let(:stdin) { StringIO.new }
   let(:branch_name) { "any" }
   let(:runner) do
-    FitCommit::Runner.new(commit_msg_file.path, branch_name, stdout, stdin)
+    FitCommit::Runner.new(commit_msg_file.path, branch_name, stderr, stdin)
   end
 
   describe "empty commit msg" do
     let(:commit_msg) { "" }
-    it "allows commit without printing to stdout" do
+    it "allows commit without printing to stderr" do
       assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
-      assert stdout.read.empty?
+      assert stderr.read.empty?
     end
   end
 
   describe "commit msg consists of all comments" do
     let(:commit_msg) { "\n#hi\n#yo\n#" }
-    it "allows commit without printing to stdout" do
+    it "allows commit without printing to stderr" do
       assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
-      assert stdout.read.empty?
+      assert stderr.read.empty?
     end
   end
 
   describe "commit msg is present but no errors" do
     let(:commit_msg) { "hello\n\nhi\n#" }
-    it "allows commit without printing to stdout" do
+    it "allows commit without printing to stderr" do
       assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
-      assert stdout.read.empty?
+      assert stderr.read.empty?
     end
   end
 
@@ -56,9 +56,9 @@ describe FitCommit::Runner do
         "this difftext should be ignored." * 3
       ].join("\n")
     end
-    it "allows commit without printing to stdout" do
+    it "allows commit without printing to stderr" do
       assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
-      assert stdout.read.empty?
+      assert stderr.read.empty?
     end
   end
 
@@ -66,26 +66,26 @@ describe FitCommit::Runner do
     let(:commit_msg) { "foo.\nbar" }
 
     def assert_error_output
-      stdout_lines = stdout.read.lines.map(&:chomp)
-      assert_equal 7, stdout_lines.size
-      assert_equal commit_msg, stdout_lines[0..1].join("\n")
-      assert_empty stdout_lines[2]
-      assert_match(/\A1: Error: /, stdout_lines[3])
-      assert_match(/\A2: Error: /, stdout_lines[4])
-      assert_empty stdout_lines[5]
-      assert_equal "Force commit? [y/n] ", stdout_lines[6]
+      stderr_lines = stderr.read.lines.map(&:chomp)
+      assert_equal 7, 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(/\A2: Error: /, stderr_lines[4])
+      assert_empty stderr_lines[5]
+      assert_equal "Force commit? [y/n] ", stderr_lines[6]
     end
 
     describe "user does not force commit" do
       let(:stdin) { StringIO.new("n") }
-      it "prints errors to stdout and rejects commit" do
+      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") }
-      it "prints errors to stdout and allows commit" do
+      it "prints errors to stderr and allows commit" do
         assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
         assert_error_output
       end

metadata

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