fit-commit 2.2.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d21bb9cb6c25372a6a849a323d359560e7124d6e
-  data.tar.gz: e12f6bbacefa30b78bdb4164b887f9b0dd984402
+  metadata.gz: 993eadcd7440c4c9d90a439b33fe1267130b588e
+  data.tar.gz: 288bd8d1af9bcd4ad34b868019ef25e59d6c0005
 SHA512:
-  metadata.gz: 4fb51830aeae8aef4eb048de4267777fd2652c4c0a1bf6325cbe2104e636fd08a9927c40f03aa0f827af295a7a695994ba95f1071afc34b9c69f396aeb736d0d
-  data.tar.gz: 7e83385db30baf7bafb7606fe0bd1c358955baacc19f7486ccd1ffb347caf034064c5c3b9d0315577f3b165fb66b44f95e8cc4b143f0300a2a1a511ebbea5830
+  metadata.gz: 8657be275a9f8e7f1649b174fa01fc38e3f621eb546c138848f1269635b455e7f760dbfc38c653f2ea31feeb482ef40d0d1d4eb563a42afa976c9a1a04451509
+  data.tar.gz: 58084b2d2fb38dd72784ae8e44558c1b18f6b21caf51e190d1644a86fc0abe696c7cc7a583015a03cdf93d44d54ad6709e92821698b480f6aadc421903d42363

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 ### master
 - N/A
 
+### v3.0.0 (2015-09-18)
+- Rename SummaryPeriod validator to SubjectPeriod (can break existing config files)
+- Add CapitalizeSubject validator
+
+### v2.2.2 (2015-09-11)
+- Fix bug where it wasn't working on the first commit of a repo.
+
 ### v2.2.0 (2015-09-09)
 - Configuration files to customize behavior.
 

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing
+
+## Reporting issues
+
+We would love to help if you are having a problem. Feel free to open an issue. We ask that you please provide as much detail as possible.
+
+## Contributing code
+
+Contributions are encouraged through GitHub Pull Requests.
+
+Guidelines when adding new code:
+
+* Create tests when possible.
+* Ensure the entire test suite still passes by running `rake`.
+* Ensure code conventions are maintained by running `rubocop`.
+
+### Adding validations
+
+To submit your own validation:
+
+* Create your new validation class in `lib/fit_commit/validators/`.
+* Add an entry to the default config settings in `fit_commit.default.yml`. If it's a feature not everyone will want by default, set `Enabled: false`.
+* Create a unit test in `test/unit/validators/`.
+* Update the config defaults & validation descriptions in the README.

data/README.md

@@ -1,6 +1,6 @@
 # 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).
+A Git hook to validate your commit messages based on [community standards](#who-decided-these-rules).
 
 ## Example
 
@@ -37,7 +37,8 @@ This creates a `.git/hooks/commit-msg` script which will automatically check you
 
 * **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 imperative present tense: "Fix bug" and not "Fixed bug" or "Fixes bug."
-* **Summary Period**: Do not end your summary with a period.
+* **Subject Period**: Do not end your subject line with a period.
+* **Capitalize Subject**: Begin all subject lines with a capital letter.
 * **WIP**: Do not commit WIPs to shared branches.
 * **Frat House**: No frat house commit messages in shared branches.
 
@@ -52,11 +53,13 @@ These are the default settings that can be overridden:
 Validators/LineLength:
   Enabled: true
   MaxLineLength: 72
-  SummaryWarnLength: 50
+  SubjectWarnLength: 50
   AllowLongUrls: true
 Validators/Tense:
   Enabled: true
-Validators/SummaryPeriod:
+Validators/SubjectPeriod:
+  Enabled: true
+Validators/CapitalizeSubject:
   Enabled: true
 Validators/Wip:
   Enabled:
@@ -103,15 +106,15 @@ $ git init
 ```
 
 ### Who decided these rules?
-Fit Commit aims to enforce *community standards*. The two influential guides on the subject are:
+Fit Commit aims to enforce *community standards*. The two influential guides are:
 
 - [Tim Pope's blog](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
 - [The official Git documentation](http://git.kernel.org/cgit/git/git.git/tree/Documentation/SubmittingPatches?id=HEAD)
 
 The Git community has largely (but not completely) coalesced around these standards. [Chris Beams](http://chris.beams.io/posts/git-commit/) and the [Pro Git book](https://git-scm.com/book) also provide good summaries on why we have them.
 
-### Fit Commit is too opinionated for me. What can I do?
-Fit Commit aims to be useful to everyone. If you can suggest an improvement to make it useful to more people, please open a GitHub Issue or Pull Request.
+### How can I improve Fit Commit?
+Fit Commit aims to be useful to everyone. If you can suggest an improvement to make it useful to more people, please open a GitHub Issue or Pull Request. See [CONTRIBUTING.md](CONTRIBUTING.md) for more info.
 
 
 ## Credits

data/fit-commit.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.rdoc_options       = ["--main", "README.md"]
 
   gem.post_install_message = <<-EOF
-    Thank you for installing fit-commit!
+    Thank you for installing Fit Commit!
     Install the hook in each git repo you want to scan using:
 
     > fit-commit install

data/lib/fit_commit/validators/capitalize_subject.rb

@@ -0,0 +1,13 @@
+require "fit_commit/validators/base"
+
+module FitCommit
+  module Validators
+    class CapitalizeSubject < Base
+      def validate_line(lineno, text)
+        if lineno == 1 && text[0] =~ /[[:lower:]]/
+          add_error(lineno, "Begin all subject lines with a capital letter.")
+        end
+      end
+    end
+  end
+end

data/lib/fit_commit/validators/line_length.rb

@@ -5,15 +5,15 @@ module FitCommit
     class LineLength < Base
       def validate_line(lineno, text)
         if lineno == 1 && text.empty?
-          add_error(lineno, "First line cannot be blank.")
+          add_error(lineno, "Subject 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)",
             max_line_length, text.length))
-        elsif lineno == 1 && text.length > summary_warn_length
-          add_warning(lineno, format("First line should be <= %i chars. (%i)",
-            summary_warn_length, text.length))
+        elsif lineno == 1 && text.length > subject_warn_length
+          add_warning(lineno, format("Subject line should be <= %i chars. (%i)",
+            subject_warn_length, text.length))
         end
       end
 
@@ -29,8 +29,8 @@ module FitCommit
         config.fetch("MaxLineLength")
       end
 
-      def summary_warn_length
-        config.fetch("SummaryWarnLength")
+      def subject_warn_length
+        config.fetch("SubjectWarnLength")
       end
 
       def allow_long_urls?

data/lib/fit_commit/validators/{summary_period.rb → subject_period.rb}

@@ -2,10 +2,10 @@ require "fit_commit/validators/base"
 
 module FitCommit
   module Validators
-    class SummaryPeriod < Base
+    class SubjectPeriod < Base
       def validate_line(lineno, text)
         if lineno == 1 && text.end_with?(".")
-          add_error(lineno, "Do not end your summary with a period.")
+          add_error(lineno, "Do not end your subject line with a period.")
         end
       end
     end

data/lib/fit_commit/version.rb

@@ -1,3 +1,3 @@
 module FitCommit
-  VERSION = "2.2.2"
+  VERSION = "3.0.0"
 end

data/templates/config/fit_commit.default.yml

@@ -2,11 +2,13 @@
 Validators/LineLength:
   Enabled: true
   MaxLineLength: 72
-  SummaryWarnLength: 50
+  SubjectWarnLength: 50
   AllowLongUrls: true
 Validators/Tense:
   Enabled: true
-Validators/SummaryPeriod:
+Validators/SubjectPeriod:
+  Enabled: true
+Validators/CapitalizeSubject:
   Enabled: true
 Validators/Wip:
   Enabled:

data/test/unit/runner_test.rb

@@ -42,7 +42,7 @@ describe FitCommit::Runner do
   end
 
   describe "commit msg is present but no errors" do
-    let(:commit_msg) { "hello\n\nhi\n#" }
+    let(:commit_msg) { "Hello\n\nhi\n#" }
     it "allows commit without printing to stderr" do
       assert_equal FitCommit::Runner::EXIT_CODE_ALLOW_COMMIT, call_runner
       assert stderr.read.empty?
@@ -51,7 +51,7 @@ describe FitCommit::Runner do
 
   describe "commit msg in verbose format" do
     let(:commit_msg) do
-      ["foo", "", "#",
+      ["Foo", "", "#",
         "# ------------------------ >8 ------------------------",
         "this difftext should be ignored." * 3
       ].join("\n")
@@ -67,13 +67,14 @@ describe FitCommit::Runner do
 
     def assert_error_output
       stderr_lines = stderr.read.lines.map(&:chomp)
-      assert_equal 7, stderr_lines.size
+      assert_equal 8, 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]
+      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]
     end
 
     describe "user does not force commit" do

data/test/unit/validator_loader_test.rb

@@ -7,23 +7,27 @@ describe FitCommit::ValidatorLoader do
   let(:loader) { FitCommit::ValidatorLoader.new(branch_name, configuration) }
   let(:branch_name) { "foo" }
   let(:configuration) do
-    {
-      "FitCommit::Validators::LineLength" => { "Enabled" => false },
-      "FitCommit::Validators::Tense" => { "Enabled" => false },
-      "FitCommit::Validators::SummaryPeriod" => { "Enabled" => true },
-      "FitCommit::Validators::Wip" => { "Enabled" => true },
-      "FitCommit::Validators::Frathouse" => { "Enabled" => ["bar", /\Abaz+/] }
-    }
+    # Starting with all disabled because every validator needs at least a
+    # default entry.
+    # The ones specified here are the ones we care about testing.
+    all_disabled_configuration.merge(
+      FitCommit::Validators::LineLength.name => { "Enabled" => false },
+      FitCommit::Validators::Wip.name => { "Enabled" => true },
+      FitCommit::Validators::Frathouse.name => { "Enabled" => ["bar", /\Abaz+/] }
+    )
+  end
+  let(:all_disabled_configuration) do
+    FitCommit::Validators::Base.all.each_with_object({}) do |v, config|
+      config[v.name] = { "Enabled" => false }
+    end
   end
 
   it "loads enabled validators" do
-    assert validators.any? { |v| v.is_a? FitCommit::Validators::SummaryPeriod }
     assert validators.any? { |v| v.is_a? FitCommit::Validators::Wip }
   end
 
   it "doesn't load disabled validators" do
     assert validators.none? { |v| v.is_a? FitCommit::Validators::LineLength }
-    assert validators.none? { |v| v.is_a? FitCommit::Validators::Tense }
   end
 
   describe "non-boolean options for Enabled" do

data/test/unit/validators/capitalize_subject_test.rb

@@ -0,0 +1,36 @@
+require File.expand_path "../validator_helper.rb", __FILE__
+require "fit_commit/validators/capitalize_subject"
+require "fit_commit/line"
+
+describe FitCommit::Validators::CapitalizeSubject do
+  let(:validator) { FitCommit::Validators::CapitalizeSubject.new(branch_name, config) }
+  let(:commit_lines) { FitCommit::Line.from_text_array(commit_msg.split("\n")) }
+  let(:default_config) { default_config_for("Validators/CapitalizeSubject") }
+  let(:config) { default_config }
+  let(:branch_name) { "any" }
+
+  describe "subject is not capitalized" do
+    let(:commit_msg) { "foo bar" }
+    it "has error" do
+      validator.validate(commit_lines)
+      assert_equal 1, validator.errors[1].size
+      assert_empty validator.warnings
+    end
+  end
+  describe "subject is capitalized" do
+    let(:commit_msg) { "Foo bar" }
+    it "does not have errors/warnings" do
+      validator.validate(commit_lines)
+      assert_empty validator.errors
+      assert_empty validator.warnings
+    end
+  end
+  describe "subject is capitalized but body is not" do
+    let(:commit_msg) { "Foo bar\n\nbaz" }
+    it "does not have errors/warnings" do
+      validator.validate(commit_lines)
+      assert_empty validator.errors
+      assert_empty validator.warnings
+    end
+  end
+end

data/test/unit/validators/line_length_test.rb

@@ -42,8 +42,8 @@ describe FitCommit::Validators::LineLength do
         assert_empty validator.warnings
       end
     end
-    describe "SummaryWarnLength modified in config" do
-      let(:config) { default_config.merge("SummaryWarnLength" => 5) }
+    describe "SubjectWarnLength modified in config" do
+      let(:config) { default_config.merge("SubjectWarnLength" => 5) }
       describe "first line is over modified warning limit" do
         let(:commit_msg) { "x" * 6 }
         it "has a warning" do

data/test/unit/validators/{summary_period_test.rb → subject_period_test.rb}

@@ -1,15 +1,15 @@
 require File.expand_path "../validator_helper.rb", __FILE__
-require "fit_commit/validators/summary_period"
+require "fit_commit/validators/subject_period"
 require "fit_commit/line"
 
-describe FitCommit::Validators::SummaryPeriod do
-  let(:validator) { FitCommit::Validators::SummaryPeriod.new(branch_name, config) }
+describe FitCommit::Validators::SubjectPeriod do
+  let(:validator) { FitCommit::Validators::SubjectPeriod.new(branch_name, config) }
   let(:commit_lines) { FitCommit::Line.from_text_array(commit_msg.split("\n")) }
-  let(:default_config) { default_config_for("Validators/SummaryPeriod") }
+  let(:default_config) { default_config_for("Validators/SubjectPeriod") }
   let(:config) { default_config }
   let(:branch_name) { "any" }
 
-  describe "summary ends with period" do
+  describe "subject ends with period" do
     let(:commit_msg) { "foo bar." }
     it "has error" do
       validator.validate(commit_lines)
@@ -17,7 +17,7 @@ describe FitCommit::Validators::SummaryPeriod do
       assert_empty validator.warnings
     end
   end
-  describe "summary does not end with period" do
+  describe "subject does not end with period" do
     let(:commit_msg) { "foo bar\n\nhi." }
     it "does not have errors/warnings" do
       validator.validate(commit_lines)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fit-commit
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Michael Foley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-12 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: swearjar
@@ -65,6 +65,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -81,9 +82,10 @@ files:
 - lib/fit_commit/runner.rb
 - lib/fit_commit/validator_loader.rb
 - lib/fit_commit/validators/base.rb
+- lib/fit_commit/validators/capitalize_subject.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/subject_period.rb
 - lib/fit_commit/validators/tense.rb
 - lib/fit_commit/validators/wip.rb
 - lib/fit_commit/version.rb
@@ -94,9 +96,10 @@ files:
 - test/unit/message_parser_test.rb
 - test/unit/runner_test.rb
 - test/unit/validator_loader_test.rb
+- test/unit/validators/capitalize_subject_test.rb
 - test/unit/validators/frathouse_test.rb
 - test/unit/validators/line_length_test.rb
-- test/unit/validators/summary_period_test.rb
+- test/unit/validators/subject_period_test.rb
 - test/unit/validators/tense_test.rb
 - test/unit/validators/validator_helper.rb
 - test/unit/validators/wip_test.rb
@@ -105,7 +108,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: |2
-      Thank you for installing fit-commit!
+      Thank you for installing Fit Commit!
       Install the hook in each git repo you want to scan using:
 
       > fit-commit install
@@ -138,9 +141,10 @@ test_files:
 - test/unit/message_parser_test.rb
 - test/unit/runner_test.rb
 - test/unit/validator_loader_test.rb
+- test/unit/validators/capitalize_subject_test.rb
 - test/unit/validators/frathouse_test.rb
 - test/unit/validators/line_length_test.rb
-- test/unit/validators/summary_period_test.rb
+- test/unit/validators/subject_period_test.rb
 - test/unit/validators/tense_test.rb
 - test/unit/validators/validator_helper.rb
 - test/unit/validators/wip_test.rb