fit-commit 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81b67790de7d999eae5047a8acb714c14257f91d
+  data.tar.gz: 57e990996a4c9e9d704d483730cbc85ce2b46e65
+SHA512:
+  metadata.gz: 621591bb43cd64e82dd41161c3375bf6bdabc1a3487899151e52837bbee44cbf149a030529d3a1129632c88609e75e9e5cd4ec01fa054b21e3240efbcf096e50
+  data.tar.gz: abb255557aa5b523d4ee9fa21eb1a46dd48362013536f3d93dc54d850032589bcf56fbf76311d1a7c4db3287f1324ef1532e9d6dead1496eef718add794615ec

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/bin/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    fit-commit (1.0.0)
+      swearjar (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    fuzzyhash (0.0.11)
+    minitest (5.8.0)
+    rake (10.4.2)
+    swearjar (1.0.0)
+      fuzzyhash (~> 0.0.11)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fit-commit!
+  minitest (~> 5.8)
+  rake (~> 10.4)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mike Foley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,48 @@
+# Fit Commit
+
+A Git hook to validate your commit messages, based largely on Tim Pope's [authoritative guide](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Example
+
+```
+$ git commit
+Adding a cool feature
+foobar foobar foobar,
+foobar foobar foobar foobar foobar foobar foobar foobar foobar foobar foobar
+
+1: Error: Message must use present imperative tense.
+2: Error: Second line must be blank.
+3: Error: Lines should be <= 72 chars. (76)
+
+Force commit? [y/n] ▊
+```
+
+## Prerequisites
+
+* Ruby
+
+## Installation
+
+Install the gem:
+
+    $ gem install fit-commit
+
+Install the hook in your Git repo:
+
+    $ fit-commit install
+
+This creates a `.git/hooks/commit-msg` script which will automatically check your Git commit messages.
+
+## Validations
+
+* **Line Length**: All lines must be <= 72 chars (URLs excluded). First line should be <= 50 chars. Second line must be blank.
+* **Tense**: Message must use present imperative tense.
+* **Summary Period**: Do not end your summary with a period.
+* **WIP**: Do not commit WIPs to master.
+* **Frat House**: No frat house commit messages in master.
+
+## Credits
+
+Author: [Mike Foley](https://github.com/m1foley)
+
+Inspiration taken from: [Tim Pope](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), [Jason Fox](https://gist.github.com/jasonrobertfox/8057124), [Addam Hardy](http://addamhardy.com/blog/2013/06/05/good-commit-messages-and-enforcing-them-with-git-hooks/), [pre-commit](https://github.com/jish/pre-commit)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = false
+end
+
+task :default => :test

data/TODO.txt

@@ -0,0 +1 @@
+- Configuration to disable validations.

data/bin/fit-commit

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'fit-commit/cli'
+
+if !File.exists?(".git")
+  abort "No .git directory found."
+end
+
+FitCommit::Cli.new(*ARGV).execute or exit 1

data/fit-commit.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/fit-commit/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name               = "fit-commit"
+  gem.version            = FitCommit::VERSION
+  gem.license            = "MIT"
+  gem.authors            = ["Michael Foley"]
+  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.files              = `git ls-files`.split("\n")
+  gem.executables        = ["fit-commit"]
+  gem.default_executable = "fit-commit"
+  gem.test_files         = `git ls-files -- test/*`.split("\n")
+  gem.require_paths      = ["lib"]
+  gem.extra_rdoc_files   = ["README.md"]
+  gem.rdoc_options       = ["--main", "README.md"]
+
+  gem.post_install_message == <<-EOF
+    Thank you for installing fit-commit!
+    Install the hook in each git repo you want to scan using:
+
+    > fit-commit install
+
+    Read more: https://github.com/m1foley/fit-commit#readme
+  EOF
+
+  gem.add_dependency("swearjar", "~> 1.0")
+  gem.add_development_dependency("minitest", "~> 5.8")
+  gem.add_development_dependency("rake", "~> 10.4")
+end

data/lib/fit-commit/cli.rb

@@ -0,0 +1,20 @@
+require "fit-commit/installer"
+
+module FitCommit
+  class Cli
+    attr_accessor :args
+    def initialize(*args)
+      self.args = args
+    end
+
+    def execute
+      action_name = args.shift
+      if action_name == "install"
+        FitCommit::Installer.new.install
+      else
+        warn "Usage: fit-commit install"
+        false
+      end
+    end
+  end
+end

data/lib/fit-commit/has_errors.rb

@@ -0,0 +1,36 @@
+# Mixin for adding errors & warnings
+module FitCommit
+  module HasErrors
+    def errors
+      @errors ||= Hash.new([])
+    end
+
+    def warnings
+      @warnings ||= Hash.new([])
+    end
+
+    def add_error(lineno, message)
+      errors[lineno] += [message]
+    end
+
+    def add_warning(lineno, message)
+      warnings[lineno] += [message]
+    end
+
+    def merge_errors(other_errors)
+      merge_hashes(errors, other_errors)
+    end
+
+    def merge_warnings(other_warnings)
+      merge_hashes(warnings, other_warnings)
+    end
+
+    private
+
+    def merge_hashes(error_hash, other_hash)
+      error_hash.merge!(other_hash) do |_lineno, messages, other_messages|
+        messages + other_messages
+      end
+    end
+  end
+end

data/lib/fit-commit/installer.rb

@@ -0,0 +1,29 @@
+require "fileutils"
+
+module FitCommit
+  class Installer
+    HOOK_TEMPLATE_PATH = File.expand_path("../../../templates/hooks/commit-msg", __FILE__)
+
+    def install
+      FileUtils.mkdir_p(File.dirname(hook_path))
+      FileUtils.cp(HOOK_TEMPLATE_PATH, hook_path)
+      FileUtils.chmod(0755, hook_path)
+      puts "Installed hook to #{hook_path}"
+      true
+    end
+
+    private
+
+    def hook_path
+      @hook_path ||= File.join(gitdir, "hooks/commit-msg")
+    end
+
+    def gitdir
+      if File.directory?(".git")
+        ".git"
+      else
+        File.readlines(".git").first.match(/gitdir: (.*)$/)[1]
+      end
+    end
+  end
+end

data/lib/fit-commit/line.rb

@@ -0,0 +1,22 @@
+# Represents a line from the commit
+module FitCommit
+  class Line
+    attr_accessor :lineno, :text
+    def initialize(lineno, text)
+      self.lineno = lineno
+      self.text = text
+    end
+
+    def to_s
+      text
+    end
+
+    def empty?
+      text.empty?
+    end
+
+    def self.from_array(text_array)
+      text_array.map.with_index(1) { |text, lineno| new(lineno, text) }
+    end
+  end
+end

data/lib/fit-commit/runner.rb

@@ -0,0 +1,83 @@
+require "fit-commit/has_errors"
+require "fit-commit/line"
+
+module FitCommit
+  class Runner
+    include FitCommit::HasErrors
+
+    attr_accessor :message_path, :branch_name, :stdout, :stdin
+    def initialize(message_path, branch_name, stdout = $stdout, stdin = $stdin)
+      self.message_path = message_path
+      self.branch_name = branch_name
+      self.stdout = stdout
+      self.stdin = stdin
+    end
+
+    def run
+      return true if empty_commit?
+      run_validators
+      return true if [errors, warnings].all?(&:empty?)
+      print_results
+
+      allow_commit = errors.empty?
+      unless allow_commit
+        stdout.print "\nForce commit? [y/n] "
+        return false unless stdin.gets =~ /y/i
+        allow_commit = true
+      end
+
+      stdout.print "\n"
+      allow_commit
+    rescue Interrupt # Ctrl-c
+      false
+    end
+
+    private
+
+    def run_validators
+      Dir[File.dirname(__FILE__) + "/validators/*.rb"].each { |file| require file }
+      FitCommit::Validators::Base.all.each do |validator_class|
+        validator = validator_class.new(lines, branch_name)
+        validator.validate
+        merge_errors(validator.errors)
+        merge_warnings(validator.warnings)
+      end
+    end
+
+    def print_results
+      unless errors.empty?
+        stdout.puts lines
+        stdout.print "\n"
+      end
+
+      (errors.keys | warnings.keys).sort.each do |lineno|
+        errors[lineno].each do |error|
+          stdout.puts "#{lineno}: Error: #{error}"
+        end
+        warnings[lineno].each do |warning|
+          stdout.puts "#{lineno}: Warning: #{warning}"
+        end
+      end
+    end
+
+    def lines
+      @lines ||= FitCommit::Line.from_array(relevant_message_lines)
+    end
+
+    def relevant_message_lines
+      message_text.lines.map(&:chomp).reject(&method(:comment?))
+    end
+
+    def message_text
+      File.open(message_path, "r").read
+    end
+
+    def comment?(text)
+      text =~ /\A#/
+    end
+
+    def empty_commit?
+      lines.all?(&:empty?)
+    end
+  end
+end

data/lib/fit-commit/validators/base.rb

@@ -0,0 +1,33 @@
+require "fit-commit/has_errors"
+
+module FitCommit
+  module Validators
+    class Base
+      include FitCommit::HasErrors
+
+      attr_accessor :lines, :branch_name
+      def initialize(lines, branch_name)
+        self.lines = lines
+        self.branch_name = branch_name
+      end
+
+      @all = []
+      class << self
+        attr_accessor :all
+        def inherited(subclass)
+          all << subclass
+        end
+      end
+
+      def validate
+        lines.each do |line|
+          validate_line(line.lineno, line.text, branch_name)
+        end
+      end
+
+      def validate_line(*)
+        fail NotImplementedError, "Implement in subclass"
+      end
+    end
+  end
+end

data/lib/fit-commit/validators/frathouse.rb

@@ -0,0 +1,14 @@
+require "fit-commit/validators/base"
+require "swearjar"
+
+module FitCommit
+  module Validators
+    class Frathouse < Base
+      def validate_line(lineno, text, branch_name)
+        if branch_name == "master" && Swearjar.default.profane?(text)
+          add_error(lineno, "No frat house commit messages in master.")
+        end
+      end
+    end
+  end
+end

data/lib/fit-commit/validators/line_length.rb

@@ -0,0 +1,32 @@
+require "fit-commit/validators/base"
+
+module FitCommit
+  module Validators
+    class LineLength < Base
+      FIRST_LINE_MAX_LENGTH = 50
+      LINE_MAX_LENGTH = 72
+
+      def validate_line(lineno, text, _branch_name)
+        if lineno == 1 && text.empty?
+          add_error(lineno, "First line cannot be blank.")
+        elsif lineno == 2 && !text.empty?
+          add_error(lineno, "Second line must be blank.")
+        elsif line_too_long?(text)
+          add_error(lineno, format("Lines should be <= %i chars. (%i)",
+            LINE_MAX_LENGTH, text.length))
+        elsif lineno == 1 && text.length > FIRST_LINE_MAX_LENGTH
+          add_warning(lineno, format("First line should be <= %i chars. (%i)",
+            FIRST_LINE_MAX_LENGTH, text.length))
+        end
+      end
+
+      def line_too_long?(text)
+        text.length > 72 && !contains_url?(text)
+      end
+
+      def contains_url?(text)
+        text =~ %r{[a-z]+://}
+      end
+    end
+  end
+end

data/lib/fit-commit/validators/summary_period.rb

@@ -0,0 +1,13 @@
+require "fit-commit/validators/base"
+
+module FitCommit
+  module Validators
+    class SummaryPeriod < Base
+      def validate_line(lineno, text, branch_name)
+        if lineno == 1 && text.end_with?(".")
+          add_error(lineno, "Do not end your summary with a period.")
+        end
+      end
+    end
+  end
+end

data/lib/fit-commit/validators/tense.rb

@@ -0,0 +1,78 @@
+require "fit-commit/validators/base"
+
+module FitCommit
+  module Validators
+    class Tense < Base
+      VERB_BLACKLIST = %w(
+        adds       adding       added
+        allows     allowing     allowed
+        amends     amending     amended
+        bumps      bumping      bumped
+        calculates calculating  calculated
+        changes    changing     changed
+        cleans     cleaning     cleaned
+        commits    committing   committed
+        corrects   correcting   corrected
+        creates    creating     created
+        darkens    darkening    darkened
+        disables   disabling    disabled
+        displays   displaying   displayed
+        drys       drying       dryed
+        ends       ending       ended
+        enforces   enforcing    enforced
+        enqueues   enqueuing    enqueued
+        extracts   extracting   extracted
+        finishes   finishing    finished
+        fixes      fixing       fixed
+        formats    formatting   formatted
+        guards     guarding     guarded
+        handles    handling     handled
+        hides      hiding       hid
+        increases  increasing   increased
+        ignores    ignoring     ignored
+        implements implementing implemented
+        improves   improving    improved
+        keeps      keeping      kept
+        kills      killing      killed
+        makes      making       made
+        merges     merging      merged
+        moves      moving       moved
+        permits    permitting   permitted
+        prevents   preventing   prevented
+        pushes     pushing      pushed
+        rebases    rebasing     rebased
+        refactors  refactoring  refactored
+        removes    removing     removed
+        renames    renaming     renamed
+        reorders   reordering   reordered
+        requires   requiring    required
+        restores   restoring    restored
+        sends      sending      sent
+        sets       setting
+        separates  separating   separated
+        shows      showing      showed
+        skips      skipping     skipped
+        sorts      sorting
+        speeds     speeding     sped
+        starts     starting     started
+        supports   supporting   supported
+        takes      taking       took
+        tests      testing      tested
+        truncates  truncating   truncated
+        updates    updating     updated
+        uses       using        used
+      )
+
+      def validate_line(lineno, text, _branch_name)
+        if lineno == 1 && wrong_tense?(text)
+          add_error(lineno, "Message must use present imperative tense.")
+        end
+      end
+
+      def wrong_tense?(text)
+        first_word = text.split.first(2).detect { |w| w =~ /\A\w/ }
+        first_word && VERB_BLACKLIST.include?(first_word.downcase)
+      end
+    end
+  end
+end

data/lib/fit-commit/validators/wip.rb

@@ -0,0 +1,14 @@
+require "fit-commit/validators/base"
+
+module FitCommit
+  module Validators
+    class Wip < Base
+      def validate_line(lineno, text, branch_name)
+        if lineno == 1 && branch_name == "master" &&
+            text.split.any? { |word| word == "WIP" }
+          add_error(lineno, "Do not commit WIPs to master.")
+        end
+      end
+    end
+  end
+end

data/lib/fit-commit/version.rb

@@ -0,0 +1,3 @@
+module FitCommit
+  VERSION = "1.0.1"
+end

data/lib/fit-commit.rb

@@ -0,0 +1,21 @@
+require "fit-commit/runner"
+
+module FitCommit
+  def self.run
+    runner.run || exit(1)
+  end
+
+  private
+
+  def self.runner
+    FitCommit::Runner.new(message_path, branch_name)
+  end
+
+  def self.message_path
+    ENV.fetch("COMMIT_MESSAGE_PATH")
+  end
+
+  def self.branch_name
+    `git branch | grep '^\*' | cut -b3-`.strip
+  end
+end

data/templates/hooks/commit-msg

@@ -0,0 +1,25 @@
+#!/usr/bin/env sh
+#
+# This hook will attempt to setup your environment before running checks.
+
+if which rvm   >/dev/null 2>/dev/null
+then cmd="rvm default do ruby"
+elif which rbenv >/dev/null 2>/dev/null
+then cmd="rbenv exec ruby"
+else cmd="ruby"
+fi
+
+export COMMIT_MESSAGE_PATH=$1
+
+${cmd} -rrubygems -e '
+  begin
+    require "fit-commit"
+    true
+  rescue LoadError => e
+    $stderr.puts <<-MESSAGE
+fit-commit: WARNING: Skipping checks because: #{e}
+fit-commit: Did you set your Ruby version?
+MESSAGE
+    false
+  end and FitCommit.run
+' < /dev/tty

data/test/runner_test.rb

@@ -0,0 +1,81 @@
+require "minitest/autorun"
+require "fit-commit/runner"
+
+describe FitCommit::Runner do
+  after do
+    commit_msg_file.unlink
+  end
+
+  def call_runner
+    allow_commit = runner.run
+    stdout.rewind
+    allow_commit
+  end
+
+  let(:commit_msg_file) do
+    Tempfile.new("test-commit-msg").tap do |f|
+      f.write(commit_msg)
+      f.close
+    end
+  end
+  let(:stdout) { StringIO.new }
+  let(:stdin) { StringIO.new }
+  let(:branch_name) { "any" }
+  let(:runner) do
+    FitCommit::Runner.new(commit_msg_file.path, branch_name, stdout, stdin)
+  end
+
+  describe "empty commit msg" do
+    let(:commit_msg) { "" }
+    it "returns truthy value without printing to stdout" do
+      assert call_runner
+      assert stdout.read.empty?
+    end
+  end
+
+  describe "commit msg consists of all comments" do
+    let(:commit_msg) { "\n#hi\n#yo" }
+    it "returns truthy value without printing to stdout" do
+      assert call_runner
+      assert stdout.read.empty?
+    end
+  end
+
+  describe "commit msg is present but no errors" do
+    let(:commit_msg) { "hello\n\nhi\n#" }
+    it "returns truthy value without printing to stdout" do
+      assert call_runner
+      assert stdout.read.empty?
+    end
+  end
+
+  describe "commit msg contains errors" 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]
+    end
+
+    describe "user does not force commit" do
+      let(:stdin) { StringIO.new("n") }
+      it "prints errors to stdout and returns falsey value" do
+        assert !call_runner
+        assert_error_output
+      end
+    end
+    describe "user forces commit" do
+      let(:stdin) { StringIO.new("y") }
+      it "prints errors to stdout and returns truthy value" do
+        assert call_runner
+        assert_error_output
+      end
+    end
+  end
+end

data/test/validators/frathouse_test.rb

@@ -0,0 +1,47 @@
+require "minitest/autorun"
+require "fit-commit/validators/frathouse"
+
+describe FitCommit::Validators::Frathouse do
+  let(:validator) { FitCommit::Validators::Frathouse.new(commit_lines, branch_name) }
+  let(:commit_lines) { FitCommit::Line.from_array(commit_msg.split("\n")) }
+
+  describe "master branch" do
+    let(:branch_name) { "master" }
+    describe "contains swear word" do
+      let(:commit_msg) { "fucking foobar" }
+      it "has error" do
+        validator.validate
+        assert_equal 1, validator.errors[1].size
+        assert_empty validator.warnings
+      end
+    end
+    describe "contains swear words on multiple lines" do
+      let(:commit_msg) { "damn\n\nIE7 is fucking bullshit!" }
+      it "has 1 error per line" do
+        validator.validate
+        assert_equal 1, validator.errors[1].size
+        assert_equal 1, validator.errors[3].size
+        assert_empty validator.warnings
+      end
+    end
+    describe "does not contain swear words" do
+      let(:commit_msg) { "foo" }
+      it "does not have errors/warnings" do
+        validator.validate
+        assert_empty validator.errors
+        assert_empty validator.warnings
+      end
+    end
+  end
+  describe "not master branch" do
+    let(:branch_name) { "notmaster" }
+    describe "contains swear word" do
+      let(:commit_msg) { "fucking foo" }
+      it "does not have errors/warnings" do
+        validator.validate
+        assert_empty validator.errors
+        assert_empty validator.warnings
+      end
+    end
+  end
+end

data/test/validators/line_length_test.rb

@@ -0,0 +1,107 @@
+require "minitest/autorun"
+require "fit-commit/validators/line_length"
+
+describe FitCommit::Validators::LineLength do
+  let(:validator) { FitCommit::Validators::LineLength.new(commit_lines, branch_name) }
+  let(:commit_lines) { FitCommit::Line.from_array(commit_msg.split("\n")) }
+
+  let(:branch_name) { "any" }
+
+  describe "first line" do
+    describe "first line is empty" do
+      let(:commit_msg) { "\n\nbar" }
+      it "has error" do
+        validator.validate
+        assert_equal 1, validator.errors[1].size
+        assert_empty validator.warnings
+      end
+    end
+    describe "first line is not empty" do
+      let(:commit_msg) { "foo\n\nbar" }
+      it "does not have error" do
+        validator.validate
+        assert_empty validator.errors
+        assert_empty validator.warnings
+      end
+    end
+    describe "first line is over warning limit" do
+      let(:commit_msg) do
+        "x" * (FitCommit::Validators::LineLength::FIRST_LINE_MAX_LENGTH + 1)
+      end
+      it "has a warning" do
+        validator.validate
+        assert_empty validator.errors
+        assert_equal 1, validator.warnings[1].size
+      end
+    end
+    describe "first line is over error limit" do
+      let(:commit_msg) do
+        "x" * (FitCommit::Validators::LineLength::LINE_MAX_LENGTH + 1)
+      end
+      it "has an error and no warning" do
+        validator.validate
+        assert_equal 1, validator.errors[1].size
+        assert_empty validator.warnings
+      end
+    end
+  end
+  describe "second line" do
+    describe "second line is not empty" do
+      let(:commit_msg) { "foo\nbar" }
+      it "has error" do
+        validator.validate
+        assert_equal 1, validator.errors[2].size
+        assert_empty validator.warnings
+      end
+    end
+    describe "second line is not empty and too long" do
+      let(:commit_msg) do
+        "foo\n" + ("x" * (FitCommit::Validators::LineLength::LINE_MAX_LENGTH + 1))
+      end
+      it "only mentions blank error" do
+        validator.validate
+        assert_equal 1, validator.errors[2].size
+        assert_match(/must be blank/, validator.errors[2][0])
+        assert_empty validator.warnings
+      end
+    end
+    describe "second line is empty" do
+      let(:commit_msg) { "foo\n\nbar" }
+      it "does not have error" do
+        validator.validate
+        assert_empty validator.errors
+        assert_empty validator.warnings
+      end
+    end
+    describe "does not have a second line" do
+      let(:commit_msg) { "foo" }
+      it "does not have error" do
+        validator.validate
+        assert_empty validator.errors
+        assert_empty validator.warnings
+      end
+    end
+  end
+  describe "body text" do
+    describe "line is over length limit" do
+      let(:commit_msg) do
+        "foo\n\n" + ("x" * (FitCommit::Validators::LineLength::LINE_MAX_LENGTH + 1))
+      end
+      it "has error" do
+        validator.validate
+        assert_equal 1, validator.errors[3].size
+        assert_empty validator.warnings
+      end
+    end
+    describe "line is equal to length limit" do
+      let(:commit_msg) do
+        "foo\n\n" + ("x" * FitCommit::Validators::LineLength::LINE_MAX_LENGTH)
+      end
+      it "does not have error" do
+        validator.validate
+        assert_empty validator.errors
+        assert_empty validator.warnings
+      end
+    end
+  end
+end

data/test/validators/summary_period_test.rb

@@ -0,0 +1,25 @@
+require "minitest/autorun"
+require "fit-commit/validators/summary_period"
+
+describe FitCommit::Validators::SummaryPeriod do
+  let(:validator) { FitCommit::Validators::SummaryPeriod.new(commit_lines, branch_name) }
+  let(:commit_lines) { FitCommit::Line.from_array(commit_msg.split("\n")) }
+  let(:branch_name) { "any" }
+
+  describe "summary ends with period" do
+    let(:commit_msg) { "foo bar." }
+    it "has error" do
+      validator.validate
+      assert_equal 1, validator.errors[1].size
+      assert_empty validator.warnings
+    end
+  end
+  describe "summary does not end with period" do
+    let(:commit_msg) { "foo bar\n\nhi." }
+    it "does not have errors/warnings" do
+      validator.validate
+      assert_empty validator.errors
+      assert_empty validator.warnings
+    end
+  end
+end

data/test/validators/tense_test.rb

@@ -0,0 +1,27 @@
+require "minitest/autorun"
+require "fit-commit/validators/tense"
+
+describe FitCommit::Validators::Tense do
+  let(:validator) { FitCommit::Validators::Tense.new(commit_lines, branch_name) }
+  let(:commit_lines) { FitCommit::Line.from_array(commit_msg.split("\n")) }
+
+  let(:branch_name) { "anybranch" }
+
+  describe "uses incorrect tense on first line" do
+    let(:commit_msg) { "Changed something\nhi" }
+    it "has error" do
+      validator.validate
+      assert_equal 1, validator.errors[1].size
+      assert_empty validator.warnings
+    end
+  end
+
+  describe "uses incorrect tense on a line other than first line" do
+    let(:commit_msg) { "hi\nChanged something" }
+    it "does not have errors/warnings" do
+      validator.validate
+      assert_empty validator.errors
+      assert_empty validator.warnings
+    end
+  end
+end

data/test/validators/wip_test.rb

@@ -0,0 +1,38 @@
+require "minitest/autorun"
+require "fit-commit/validators/wip"
+
+describe FitCommit::Validators::Wip do
+  let(:validator) { FitCommit::Validators::Wip.new(commit_lines, branch_name) }
+  let(:commit_lines) { FitCommit::Line.from_array(commit_msg.split("\n")) }
+
+  describe "master branch" do
+    let(:branch_name) { "master" }
+    describe "contains WIP" do
+      let(:commit_msg) { "WIP foo" }
+      it "has error" do
+        validator.validate
+        assert_equal 1, validator.errors[1].size
+        assert_empty validator.warnings
+      end
+    end
+    describe "does not contain WIP" do
+      let(:commit_msg) { "foo" }
+      it "does not have errors/warnings" do
+        validator.validate
+        assert_empty validator.errors
+        assert_empty validator.warnings
+      end
+    end
+  end
+  describe "not master branch" do
+    let(:branch_name) { "notmaster" }
+    describe "contains WIP" do
+      let(:commit_msg) { "WIP foo" }
+      it "does not have errors/warnings" do
+        validator.validate
+        assert_empty validator.errors
+        assert_empty validator.warnings
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: fit-commit
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Michael Foley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: swearjar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: A Git hook to validate your commit messages, based largely on Tim Pope's
+  authoritative guide.
+email:
+- foley3@gmail.com
+executables:
+- fit-commit
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- TODO.txt
+- bin/fit-commit
+- fit-commit.gemspec
+- lib/fit-commit.rb
+- lib/fit-commit/cli.rb
+- lib/fit-commit/has_errors.rb
+- lib/fit-commit/installer.rb
+- lib/fit-commit/line.rb
+- lib/fit-commit/runner.rb
+- lib/fit-commit/validators/base.rb
+- lib/fit-commit/validators/frathouse.rb
+- lib/fit-commit/validators/line_length.rb
+- lib/fit-commit/validators/summary_period.rb
+- lib/fit-commit/validators/tense.rb
+- lib/fit-commit/validators/wip.rb
+- lib/fit-commit/version.rb
+- templates/hooks/commit-msg
+- test/runner_test.rb
+- test/validators/frathouse_test.rb
+- test/validators/line_length_test.rb
+- test/validators/summary_period_test.rb
+- test/validators/tense_test.rb
+- test/validators/wip_test.rb
+homepage: https://github.com/m1foley/fit-commit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: A Git hook to validate your commit messages
+test_files:
+- test/runner_test.rb
+- test/validators/frathouse_test.rb
+- test/validators/line_length_test.rb
+- test/validators/summary_period_test.rb
+- test/validators/tense_test.rb
+- test/validators/wip_test.rb
+has_rdoc: