fit-commit 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc18e42169af5f36c44a8a041cdbe3ce03f38052
-  data.tar.gz: 14de6fd71a86bc487f8a7e4433266317f787abc1
+  metadata.gz: b61a440527e95be121a746fd0e4b84746cce7c43
+  data.tar.gz: 3012b5cb04cdd7793709dab36150bd7af6802cb9
 SHA512:
-  metadata.gz: 4566013959f7022f744e99392616d2b20111fc1d69a283eb1eb0d75dadb78ba7135aadb039c623054b15e1dd33138d38f90dad4c153e7278e2dd2dc25d485c35
-  data.tar.gz: 1d764c8ace04ba170258b0dbdc3c2d74aebcd2d07089a9286deaa1efba8b6723473aa70e9f6167069431af58986b28b1c56155513a45fb43ed993c2449035f20
+  metadata.gz: 0507857c7b47a8695e2649b39bb6b4db45ff3e78945be33bf1061c846794fe846e0e380bc2360592560cdad8abc6fb8d98e48ed9f7c5940fa8c9c1df0305919c
+  data.tar.gz: 9bb562f150c27b9204dc893c9dc691cd479499ed841325d3428f8e09e9b91f69706b5562e4db32650680bb4ddfde83881aa662b0f409e7cc9dd82ba4e2bf301f

data/.gitignore

@@ -8,7 +8,6 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
-/bin/
 
 ## Environment normalisation:
 /.bundle/

data/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+Style/AlignArray:
+  Enabled: false
+
+Style/AlignParameters:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 ### master
 - N/A
 
+### v2.1.1 (2015-08-31)
+- Compatibility for all POSIX shells.
+
 ### v2.1.0 (2015-08-29)
 - Add `fit-commit uninstall` command
 

data/README.md

@@ -19,7 +19,7 @@ Force commit? [y/n] ▊
 
 ## Prerequisites
 
-* Ruby
+* Ruby >= 1.9
 
 ## Installation
 

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new do |test|
   test.verbose = false
 end
 
-task :default => :test
+task default: :test

data/bin/fit-commit

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

data/fit-commit.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path("../lib/fit-commit/version", __FILE__)
+require File.expand_path("../lib/fit_commit/version", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name               = "fit-commit"

data/lib/{fit-commit.rb → fit_commit.rb}

@@ -1,4 +1,4 @@
-require "fit-commit/runner"
+require "fit_commit/runner"
 
 module FitCommit
   def self.run

data/lib/fit_commit/cli.rb

@@ -0,0 +1,48 @@
+require "fit_commit/installer"
+require "fit_commit/version"
+
+module FitCommit
+  class Cli
+    EXIT_CODE_SUCCESS = 0
+    EXIT_CODE_FAILURE = 1
+
+    attr_accessor :args
+    def initialize(*args)
+      self.args = args
+    end
+
+    def execute
+      action_name = in_git_repo? ? args.shift : :fail_git_repo
+      action_name = :help unless respond_to?(action_name, :include_private)
+      send(action_name)
+    end
+
+    private
+
+    def help
+      $stderr.puts "fit-commit v#{FitCommit::VERSION}"
+      $stderr.puts "Usage: fit-commit install"
+      $stderr.puts "Usage: fit-commit uninstall"
+      EXIT_CODE_FAILURE
+    end
+
+    def install
+      FitCommit::Installer.new.install
+      EXIT_CODE_SUCCESS
+    end
+
+    def uninstall
+      FitCommit::Installer.new.uninstall
+      EXIT_CODE_SUCCESS
+    end
+
+    def in_git_repo?
+      File.exist?(".git")
+    end
+
+    def fail_git_repo
+      $stderr.puts "fit-commit: .git directory not found. Please run from your Git repository root."
+      EXIT_CODE_FAILURE
+    end
+  end
+end

data/lib/{fit-commit → fit_commit}/installer.rb

@@ -9,7 +9,6 @@ module FitCommit
       FileUtils.cp(HOOK_TEMPLATE_PATH, hook_path)
       FileUtils.chmod(0755, hook_path)
       $stdout.puts "Installed hook to #{hook_path}"
-      true
     end
 
     def uninstall
@@ -18,7 +17,6 @@ module FitCommit
       else
         $stdout.puts "Hook not found at #{hook_path}"
       end
-      true
     end
 
     private

data/lib/{fit-commit → fit_commit}/line.rb

@@ -15,7 +15,7 @@ module FitCommit
       text.empty?
     end
 
-    def self.from_array(text_array)
+    def self.from_text_array(text_array)
       text_array.map.with_index(1) { |text, lineno| new(lineno, text) }
     end
   end

data/lib/fit_commit/message_parser.rb

@@ -0,0 +1,32 @@
+require "fit_commit/line"
+
+module FitCommit
+  class MessageParser
+    attr_accessor :message_path
+    def initialize(message_path)
+      self.message_path = message_path
+    end
+
+    def lines
+      FitCommit::Line.from_text_array(relevant_lines)
+    end
+
+    private
+
+    GIT_VERBOSE_MARKER = "# ------------------------ >8 ------------------------"
+    COMMENT_REGEX = /\A#/
+
+    def relevant_lines
+      message_text.lines.each_with_object([]) do |line, relevant_lines|
+        line.chomp!
+        break relevant_lines if line == GIT_VERBOSE_MARKER
+        next if line =~ COMMENT_REGEX
+        relevant_lines << line.chomp
+      end
+    end
+
+    def message_text
+      File.read(message_path)
+    end
+  end
+end

data/lib/{fit-commit → fit_commit}/runner.rb

@@ -1,5 +1,5 @@
-require "fit-commit/has_errors"
-require "fit-commit/line"
+require "fit_commit/has_errors"
+require "fit_commit/message_parser"
 
 module FitCommit
   class Runner
@@ -38,8 +38,7 @@ module FitCommit
     private
 
     def run_validators
-      Dir[File.dirname(__FILE__) + "/validators/*.rb"].each { |file| require file }
-      FitCommit::Validators::Base.all.each do |validator_class|
+      validator_classes.each do |validator_class|
         validator = validator_class.new(lines, branch_name)
         validator.validate
         merge_errors(validator.errors)
@@ -47,6 +46,11 @@ module FitCommit
       end
     end
 
+    def validator_classes
+      Dir[File.dirname(__FILE__) + "/validators/*.rb"].each { |file| require file }
+      FitCommit::Validators::Base.all
+    end
+
     def print_results
       unless errors.empty?
         stdout.puts lines
@@ -64,23 +68,7 @@ module FitCommit
     end
 
     def lines
-      @lines ||= FitCommit::Line.from_array(relevant_message_lines)
-    end
-
-    GIT_VERBOSE_MARKER = "# ------------------------ >8 ------------------------"
-    COMMENT_REGEX = /\A#/
-
-    def relevant_message_lines
-      message_text.lines.each_with_object([]) do |line, relevant_lines|
-        line.chomp!
-        break relevant_lines if line == GIT_VERBOSE_MARKER
-        next if line =~ COMMENT_REGEX
-        relevant_lines << line.chomp
-      end
-    end
-
-    def message_text
-      File.read(message_path)
+      @lines ||= FitCommit::MessageParser.new(message_path).lines
     end
 
     def empty_commit?

data/lib/{fit-commit → fit_commit}/validators/base.rb

@@ -1,4 +1,4 @@
-require "fit-commit/has_errors"
+require "fit_commit/has_errors"
 
 module FitCommit
   module Validators

data/lib/{fit-commit → fit_commit}/validators/frathouse.rb

@@ -1,4 +1,4 @@
-require "fit-commit/validators/base"
+require "fit_commit/validators/base"
 require "swearjar"
 
 module FitCommit

data/lib/{fit-commit → fit_commit}/validators/line_length.rb

@@ -1,4 +1,4 @@
-require "fit-commit/validators/base"
+require "fit_commit/validators/base"
 
 module FitCommit
   module Validators

data/lib/{fit-commit → fit_commit}/validators/summary_period.rb

@@ -1,9 +1,9 @@
-require "fit-commit/validators/base"
+require "fit_commit/validators/base"
 
 module FitCommit
   module Validators
     class SummaryPeriod < Base
-      def validate_line(lineno, text, branch_name)
+      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

data/lib/{fit-commit → fit_commit}/validators/tense.rb

@@ -1,4 +1,4 @@
-require "fit-commit/validators/base"
+require "fit_commit/validators/base"
 
 module FitCommit
   module Validators

data/lib/{fit-commit → fit_commit}/validators/wip.rb

@@ -1,4 +1,4 @@
-require "fit-commit/validators/base"
+require "fit_commit/validators/base"
 
 module FitCommit
   module Validators

data/lib/{fit-commit → fit_commit}/version.rb

@@ -1,3 +1,3 @@
 module FitCommit
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

data/templates/hooks/commit-msg

@@ -2,32 +2,42 @@
 #
 # This hook will attempt to setup your environment before running checks.
 
-if which rvm >&/dev/null
+if which rvm > /dev/null 2>&1
 then cmd="rvm default do ruby"
-elif which rbenv >&/dev/null
+elif which rbenv > /dev/null 2>&1
 then cmd="rbenv exec ruby"
 else cmd="ruby"
 fi
 
 export COMMIT_MESSAGE_PATH=$1
-if (! [[ "$COMMIT_MESSAGE_PATH" ]] ); then
+if [ -z "$COMMIT_MESSAGE_PATH" ]; then
   >&2 echo "fit-commit: WARNING: Skipping checks because the Git hook was not passed the"
   >&2 echo "fit-commit: commit message file path. This is usually \`.git/COMMIT_EDITMSG\`."
   >&2 echo "fit-commit: This hook was called via: $0 $*"
-  >&2 echo "fit-commit: Please submit a bug report with the project."
+  >&2 echo "fit-commit: Please submit a bug report with the project:"
+  >&2 echo "fit-commit: https://github.com/m1foley/fit-commit/issues"
+  exit 0
+fi
+if [ ! -r "$COMMIT_MESSAGE_PATH" ]; then
+  >&2 echo "fit-commit: WARNING: Skipping checks because the commit message file cannot be read:"
+  >&2 echo "fit-commit: $COMMIT_MESSAGE_PATH"
+  >&2 echo "fit-commit: This hook was called via: $0 $*"
+  >&2 echo "fit-commit: Please submit a bug report with the project:"
+  >&2 echo "fit-commit: https://github.com/m1foley/fit-commit/issues"
   exit 0
 fi
 
 export GIT_BRANCH_NAME=`git name-rev --name-only HEAD`
-if (! [[ "$GIT_BRANCH_NAME" ]] ); then
+if [ -z "$GIT_BRANCH_NAME" ]; then
   >&2 echo "fit-commit: WARNING: Skipping checks because the Git branch cannot be determined."
-  >&2 echo "fit-commit: Please submit a bug report with the project."
+  >&2 echo "fit-commit: Please submit a bug report with the project:"
+  >&2 echo "fit-commit: https://github.com/m1foley/fit-commit/issues"
   exit 0
 fi
 
 ${cmd} -rrubygems -e '
   begin
-    require "fit-commit"
+    require "fit_commit"
     true
   rescue LoadError => e
     $stderr.puts <<-MESSAGE

data/test/message_parser_test.rb

@@ -0,0 +1,74 @@
+require "minitest/autorun"
+require "fit_commit/message_parser"
+
+describe FitCommit::MessageParser do
+  after do
+    commit_msg_file.unlink
+  end
+
+  let(:commit_msg_file) do
+    Tempfile.new("test-commit-msg").tap do |f|
+      f.write(commit_msg)
+      f.close
+    end
+  end
+
+  let(:lines) do
+    FitCommit::MessageParser.new(commit_msg_file.path).lines
+  end
+
+  describe "empty commit msg" do
+    let(:commit_msg) { "" }
+    it "returns empty array" do
+      assert_equal [], lines
+    end
+  end
+
+  describe "commit msg consists of all comments" do
+    let(:commit_msg) { "#\n#hi\n#yo\n#" }
+    it "returns empty array" do
+      assert_equal [], lines
+    end
+  end
+
+  describe "commit msg is one line" do
+    let(:commit_msg) { "foo" }
+    it "parses text" do
+      assert_equal 1, lines.size
+      assert_equal [1], lines.map(&:lineno)
+      assert_equal ["foo"], lines.map(&:text)
+    end
+  end
+
+  describe "commit msg is one line plus comments" do
+    let(:commit_msg) { "foo\n#hi\n#yo\n#" }
+    it "parses text and ignores comments" do
+      assert_equal 1, lines.size
+      assert_equal [1], lines.map(&:lineno)
+      assert_equal ["foo"], lines.map(&:text)
+    end
+  end
+
+  describe "multi-line commit msg" do
+    let(:commit_msg) { "a\n\nb\n#" }
+    it "parses text and ignores comments" do
+      assert_equal 3, lines.size
+      assert_equal [1, 2, 3], lines.map(&:lineno)
+      assert_equal ["a", "", "b"], lines.map(&:text)
+    end
+  end
+
+  describe "commit msg in verbose format" do
+    let(:commit_msg) do
+      ["foo", "", "#",
+        "# ------------------------ >8 ------------------------",
+        "this difftext should be ignored."
+      ].join("\n")
+    end
+    it "ignores text after verbose marker" do
+      assert_equal 2, lines.size
+      assert_equal [1, 2], lines.map(&:lineno)
+      assert_equal ["foo", ""], lines.map(&:text)
+    end
+  end
+end

data/test/runner_test.rb

@@ -1,5 +1,5 @@
 require "minitest/autorun"
-require "fit-commit/runner"
+require "fit_commit/runner"
 
 describe FitCommit::Runner do
   after do
@@ -27,7 +27,7 @@ describe FitCommit::Runner do
 
   describe "empty commit msg" do
     let(:commit_msg) { "" }
-    it "returns truthy value without printing to stdout" do
+    it "allows commit without printing to stdout" do
       assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
       assert stdout.read.empty?
     end
@@ -35,7 +35,7 @@ describe FitCommit::Runner do
 
   describe "commit msg consists of all comments" do
     let(:commit_msg) { "\n#hi\n#yo\n#" }
-    it "returns truthy value without printing to stdout" do
+    it "allows commit without printing to stdout" do
       assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
       assert stdout.read.empty?
     end
@@ -43,7 +43,7 @@ describe FitCommit::Runner do
 
   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
+    it "allows commit without printing to stdout" do
       assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
       assert stdout.read.empty?
     end
@@ -56,7 +56,7 @@ describe FitCommit::Runner do
         "this difftext should be ignored." * 3
       ].join("\n")
     end
-    it "returns truthy value without printing to stdout" do
+    it "allows commit without printing to stdout" do
       assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
       assert stdout.read.empty?
     end
@@ -78,14 +78,14 @@ describe FitCommit::Runner do
 
     describe "user does not force commit" do
       let(:stdin) { StringIO.new("n") }
-      it "prints errors to stdout and returns falsey value" do
+      it "prints errors to stdout 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 returns truthy value" do
+      it "prints errors to stdout and allows commit" do
         assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
         assert_error_output
       end

data/test/validators/frathouse_test.rb

@@ -1,9 +1,9 @@
 require "minitest/autorun"
-require "fit-commit/validators/frathouse"
+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")) }
+  let(:commit_lines) { FitCommit::Line.from_text_array(commit_msg.split("\n")) }
 
   describe "master branch" do
     let(:branch_name) { "master" }

data/test/validators/line_length_test.rb

@@ -1,9 +1,9 @@
 require "minitest/autorun"
-require "fit-commit/validators/line_length"
+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(:commit_lines) { FitCommit::Line.from_text_array(commit_msg.split("\n")) }
 
   let(:branch_name) { "any" }
 

data/test/validators/summary_period_test.rb

@@ -1,9 +1,9 @@
 require "minitest/autorun"
-require "fit-commit/validators/summary_period"
+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(:commit_lines) { FitCommit::Line.from_text_array(commit_msg.split("\n")) }
   let(:branch_name) { "any" }
 
   describe "summary ends with period" do

data/test/validators/tense_test.rb

@@ -1,9 +1,9 @@
 require "minitest/autorun"
-require "fit-commit/validators/tense"
+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(:commit_lines) { FitCommit::Line.from_text_array(commit_msg.split("\n")) }
 
   let(:branch_name) { "anybranch" }
 

data/test/validators/wip_test.rb

@@ -1,9 +1,9 @@
 require "minitest/autorun"
-require "fit-commit/validators/wip"
+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")) }
+  let(:commit_lines) { FitCommit::Line.from_text_array(commit_msg.split("\n")) }
 
   describe "master branch" do
     let(:branch_name) { "master" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fit-commit
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Michael Foley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-30 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: swearjar
@@ -63,6 +63,7 @@ extra_rdoc_files:
 - README.md
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -70,20 +71,22 @@ files:
 - Rakefile
 - 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
+- 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/message_parser.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/message_parser_test.rb
 - test/runner_test.rb
 - test/validators/frathouse_test.rb
 - test/validators/line_length_test.rb
@@ -123,6 +126,7 @@ signing_key:
 specification_version: 4
 summary: A Git hook to validate your commit messages
 test_files:
+- test/message_parser_test.rb
 - test/runner_test.rb
 - test/validators/frathouse_test.rb
 - test/validators/line_length_test.rb

data/lib/fit-commit/cli.rb

@@ -1,26 +0,0 @@
-require "fit-commit/installer"
-require "fit-commit/version"
-
-module FitCommit
-  class Cli
-    attr_accessor :args
-    def initialize(*args)
-      self.args = args
-    end
-
-    def execute
-      action_name = args.shift
-      case action_name
-      when "install"
-        FitCommit::Installer.new.install
-      when "uninstall"
-        FitCommit::Installer.new.uninstall
-      else
-        warn "fit-commit v#{FitCommit::VERSION}"
-        warn "Usage: fit-commit install"
-        warn "Usage: fit-commit uninstall"
-        false
-      end
-    end
-  end
-end