fit-commit 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0b95d59622579ff58ddc0443293c4be66ae71b9
-  data.tar.gz: 9a8d5cca328a035aa802c9e5514ed5c0c1e07c11
+  metadata.gz: 5f18c1fdd99e92a81ce99b52089165e3b789551b
+  data.tar.gz: 73268b23af0112f5640f4f1ddcc39ea6f24a0349
 SHA512:
-  metadata.gz: 271657b39d8a59e5f9c8e537a8cd6c972f5e73e68cf289bfdebd9860585b4ef344e9a8b517c80615ac6791d0fe843f72cd32ed5a56491d09e6cd079e95f80b6a
-  data.tar.gz: a38474d9139609b5672926e3c8e05069c1c655707fed2eaca6a2223cd01aa51067ceca1719247582498c2c37c6e8556fb50bb68623954e040c76db651106ac55
+  metadata.gz: bba6727a6122f9a3b3c2d0ecd40ee527492b65b104b2f55e169077f6d93f0ac03c7e52aee53f7f22676cf895a2e219147d473b8a7a78112f041d73d9d0fcf2fb
+  data.tar.gz: 3c4b885485f5f1abde6772d5f6eb0d953f0891f104c4d96a89683f14d69b908a834da93d1baa337bbe1cbc7dfc92b1a13e4aced522045c45bd46b7a5e63b8d0a

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+### v3.8.0 (2018-08-06)
+- Add CapitalizeSubject config option to warn on WIPlikes
+
+### v3.7.0 (2017-01-07)
+- Run via Bundler if available
+
+### v3.6.0 (2016-11-18)
+- Disable WIP check by default
+
 ### v3.5.0 (2016-04-05)
 - All validations are enabled on all branches by default
 

data/README.md

@@ -61,6 +61,7 @@ Validators/SubjectPeriod:
   Enabled: true
 Validators/CapitalizeSubject:
   Enabled: true
+  WarnOnWiplikes: true
 Validators/Frathouse:
   Enabled: true
 Validators/Wip:
@@ -161,10 +162,15 @@ $ git init
 Fit Commit can be run outside of a Git hook context with a simple shell script:
 
 ```sh
-$ GIT_BRANCH_NAME=branch_name COMMIT_MESSAGE_PATH=path/to/message rbenv exec ruby -rrubygems -e 'require "fit_commit"; FitCommit.run'
+$ export GIT_BRANCH_NAME=branch_name
+$ export COMMIT_MESSAGE_PATH=path/to/message
+# Using Bundler
+$ bundle exec ruby -e 'require "fit_commit"; FitCommit.run'
+# Not using Bundler
+$ rbenv exec ruby -rrubygems -e 'require "fit_commit"; FitCommit.run'
 ```
 
-It exits with an error code if any errors are present, which will fail a build if it's part of a CI run. The configuration should be modified for CI to be more lenient, otherwise false positives will break the build too often.
+It exits with an error code if any errors are present, which will fail a build if it's part of a CI run.
 
 ### Who decided these rules?
 Fit Commit aims to enforce *community standards*. The two influential guides are:

data/TODO.md

@@ -0,0 +1,3 @@
+# TODO
+
+- Ideas from: https://github.com/bkuhlmann/git-cop

data/lib/fit_commit/configuration_loader.rb

@@ -2,47 +2,58 @@ require "yaml"
 
 module FitCommit
   class ConfigurationLoader
-    def global_configuration
-      all_filepaths.each_with_object({}) do |filepath, config|
+    SYSTEM_FILEPATH = "/etc/fit_commit.yml"
+    LOCAL_FILEPATH = ".fit_commit.yml"
+
+    def initialize(filepaths)
+      self.filepaths = filepaths
+    end
+
+    def self.default_configuration
+      new(default_filepaths).configuration
+    end
+
+    def configuration
+      filepaths.each_with_object({}) do |filepath, config|
         config.merge!(read_config(filepath)) do |_key, oldval, newval|
           oldval.merge(newval)
         end
       end
     end
 
-    private
-
-    def all_filepaths
-      # sorted by increasing precedence
-      [default_filepath, system_filepath, user_filepath, config_filepath, local_filepath]
+    def self.default_filepaths
+      [
+        gem_default_filepath,
+        SYSTEM_FILEPATH,
+        user_filepath,
+        config_filepath,
+        LOCAL_FILEPATH
+      ]
     end
 
-    def default_filepath
+    def self.gem_default_filepath
       File.expand_path("../../../templates/config/fit_commit.default.yml", __FILE__)
     end
 
-    def system_filepath
-      "/etc/fit_commit.yml"
-    end
-
-    def user_filepath
+    def self.user_filepath
       File.join(ENV["HOME"], ".fit_commit.yml")
     end
 
-    def config_filepath
+    def self.config_filepath
       File.join(git_top_level, "config", "fit_commit.yml")
     end
 
-    def local_filepath
-      ".fit_commit.yml"
-    end
-
-    def git_top_level
+    def self.git_top_level
       top_level = `git rev-parse --show-toplevel`.chomp.strip
       fail "Git repo not found! Please submit a bug report." if top_level == ""
       top_level
     end
 
+    private
+
+    # sorted by increasing precedence
+    attr_accessor :filepaths
+
     def read_config(path)
       load_yaml(path).each_with_object({}) do |(key, value), config|
         translated_key = translate_config_key(key)

data/lib/fit_commit/validator_loader.rb

@@ -2,7 +2,6 @@ require "fit_commit/configuration_loader"
 
 module FitCommit
   class ValidatorLoader
-    attr_accessor :branch_name, :configuration
     def initialize(branch_name, configuration = load_configuration)
       self.branch_name = branch_name
       self.configuration = configuration
@@ -14,8 +13,10 @@ module FitCommit
 
     private
 
+    attr_accessor :branch_name, :configuration
+
     def load_configuration
-      FitCommit::ConfigurationLoader.new.global_configuration
+      FitCommit::ConfigurationLoader.default_configuration
     end
 
     def all_validators

data/lib/fit_commit/validators/capitalize_subject.rb

@@ -3,13 +3,29 @@ require "fit_commit/validators/base"
 module FitCommit
   module Validators
     class CapitalizeSubject < Base
+      MESSAGE = "Begin all subject lines with a capital letter."
+      SINGLE_WORD = /\A\w+\z/
       AUTOSQUASH = /\A(fixup|squash)! /
 
-      def validate_line(lineno, text)
-        if lineno == 1 && text[0] =~ /[[:lower:]]/ && text !~ AUTOSQUASH
-          add_error(lineno, "Begin all subject lines with a capital letter.")
+      def validate(lines)
+        if lines[0].text =~ /\A[[:lower:]]/ && lines[0].text !~ AUTOSQUASH
+          if ignore_on_wiplikes? && wiplike?(lines)
+            add_warning(1, MESSAGE)
+          else
+            add_error(1, MESSAGE)
+          end
         end
       end
+
+      private
+
+      def wiplike?(lines)
+        lines[0].text =~ SINGLE_WORD && lines[1..-1].all?(&:empty?)
+      end
+
+      def ignore_on_wiplikes?
+        config.fetch("WarnOnWiplikes")
+      end
     end
   end
 end

data/lib/fit_commit/validators/tense.rb

@@ -45,6 +45,7 @@ module FitCommit
         removes    removing     removed
         renames    renaming     renamed
         reorders   reordering   reordered
+        replaces   replacing    replaced
         requires   requiring    required
         restores   restoring    restored
         sends      sending      sent

data/lib/fit_commit/version.rb

@@ -1,3 +1,3 @@
 module FitCommit
-  VERSION = "3.7.0"
+  VERSION = "3.8.0"
 end

data/templates/config/fit_commit.default.yml

@@ -10,6 +10,7 @@ Validators/SubjectPeriod:
   Enabled: true
 Validators/CapitalizeSubject:
   Enabled: true
+  WarnOnWiplikes: true
 Validators/Frathouse:
   Enabled: true
 Validators/Wip:

data/test/test_helper.rb

@@ -1,6 +1,6 @@
 require "minitest/autorun"
 
-def create_tempfile(filename, content)
+def create_tempfile(content, filename="")
   Tempfile.new(filename).tap do |f|
     f.write(content)
     f.close

data/test/unit/configuration_loader_test.rb

@@ -2,81 +2,109 @@ require "test_helper"
 require "fit_commit/configuration_loader"
 
 describe FitCommit::ConfigurationLoader do
-  subject { FitCommit::ConfigurationLoader.new }
-
-  after do
-    [system_file, user_file].compact.each(&:unlink)
-  end
-
-  let(:global_configuration) do
-    subject.stub :default_filepath, "/dev/null" do
-      subject.stub :system_filepath, (system_file ? system_file.path : "/dev/null") do
-        subject.stub :user_filepath, (user_file ? user_file.path : "/dev/null") do
-          subject.stub :config_filepath, "/dev/null" do
-            subject.stub :local_filepath, "/dev/null" do
-              subject.stub :git_top_level, "." do
-                subject.global_configuration
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-
   describe "no configuration files present" do
-    let(:system_file) { nil }
-    let(:user_file) { nil }
     it "is empty" do
-      assert_equal({}, global_configuration)
+      config = FitCommit::ConfigurationLoader.new(["/dev/null"]).configuration
+      assert_equal({}, config)
     end
   end
 
   describe "just one configuration file present" do
-    let(:system_file) { nil }
-    let(:user_file) { create_tempfile("user_file", user_file_content) }
-    let(:user_file_content) do
-      "Foo/Bar:\n  Baz: false\nQux/Norf/Blah:\n  - !ruby/regexp /\\Afoo/"
-    end
-
     it "is a configuration equal to that file" do
-      expected = {
+      config_content = <<~EOF
+        Foo/Bar:
+          Baz: false
+        Qux/Norf/Blah:
+          - !ruby/regexp /\\Afoo/
+      EOF
+      config_file_path = create_tempfile(config_content).path
+
+      expected_config = {
         "FitCommit::Foo::Bar" => { "Baz" => false },
         "FitCommit::Qux::Norf::Blah" => [/\Afoo/]
       }
-      assert_equal expected, global_configuration
+
+      config = FitCommit::ConfigurationLoader.new([config_file_path]).configuration
+      assert_equal expected_config, config
     end
 
-    describe "has a non-validation key" do
-      let(:user_file_content) do
-        "FitCommit:\n  Require:\n    - foo/bar"
-      end
+    describe "has a key without a slash" do
       it "doesn't try to namespace the key" do
-        expected = {
+        config_content = <<~EOF
+        FitCommit:
+          Require:
+            - foo/bar
+        EOF
+        config_file_path = create_tempfile(config_content).path
+
+        expected_config = {
           "FitCommit" => { "Require" => ["foo/bar"] }
         }
-        assert_equal expected, global_configuration
+
+        config = FitCommit::ConfigurationLoader.new([config_file_path]).configuration
+        assert_equal expected_config, config
       end
     end
   end
 
   describe "multiple configuration files present" do
-    let(:system_file) { create_tempfile("system_file", system_file_content) }
-    let(:user_file) { create_tempfile("user_file", user_file_content) }
-    let(:system_file_content) do
-      "Foo/Bar:\n  Baz: false\nQux/Norf/Blah:\n  Foobar:\n    - !ruby/regexp /\\Afoo/\n  Booyah: false"
-    end
-    let(:user_file_content) do
-      "Qux/Norf/Blah:\n  Foobar: true\nAbc/Buz:\n  - hi"
-    end
-
     it "is a merged configuration that takes precedence into account" do
-      expected = {
+      config1_content = <<~EOF
+        Foo/Bar:
+          Baz: false
+        Qux/Norf/Blah:
+          Foobar:
+            - !ruby/regexp /\\Afoo/
+          Booyah: false
+      EOF
+
+      config2_content = <<~EOF
+        Qux/Norf/Blah:
+          Foobar: true
+        Abc/Buz:
+          - hi
+      EOF
+
+      config_file_paths = [
+        create_tempfile(config1_content).path,
+        create_tempfile(config2_content).path
+      ]
+
+      expected_config = {
         "FitCommit::Foo::Bar" => { "Baz" => false },
         "FitCommit::Qux::Norf::Blah" => { "Foobar" => true, "Booyah" => false },
         "FitCommit::Abc::Buz" => ["hi"]
       }
-      assert_equal expected, global_configuration
+
+      config = FitCommit::ConfigurationLoader.new(config_file_paths).configuration
+      assert_equal expected_config, config
+    end
+  end
+
+  describe "default_configuration" do
+    it "loads configuration from default filepaths" do
+      config_content = <<~EOF
+        FitCommit:
+          Require:
+            - foo/bar
+      EOF
+      config_file_path = create_tempfile(config_content).path
+
+      expected_config = {
+        "FitCommit" => { "Require" => ["foo/bar"] }
+      }
+
+      config = FitCommit::ConfigurationLoader.stub(:default_filepaths, [config_file_path]) do
+        FitCommit::ConfigurationLoader.default_configuration
+      end
+      assert_equal expected_config, config
+    end
+  end
+
+  describe "gem_default_filepath" do
+    it "returns a valid filepath" do
+      gem_default_filepath = FitCommit::ConfigurationLoader.gem_default_filepath
+      assert File.exist?(gem_default_filepath)
     end
   end
 end

data/test/unit/message_parser_test.rb

@@ -2,12 +2,8 @@ require "test_helper"
 require "fit_commit/message_parser"
 
 describe FitCommit::MessageParser do
-  after do
-    commit_msg_file.unlink
-  end
-
-  let(:commit_msg_file) { create_tempfile("test-commit-msg", commit_msg) }
-  let(:lines) { FitCommit::MessageParser.new(commit_msg_file.path).lines }
+  let(:commit_msg_file_path) { create_tempfile(commit_msg).path }
+  let(:lines) { FitCommit::MessageParser.new(commit_msg_file_path).lines }
 
   describe "empty commit msg" do
     let(:commit_msg) { "" }

data/test/unit/runner_test.rb

@@ -2,15 +2,12 @@ require "test_helper"
 require "fit_commit/runner"
 
 describe FitCommit::Runner do
-  after do
-    commit_msg_file.unlink
-  end
-  let(:commit_msg_file) { create_tempfile("test-commit-msg", commit_msg) }
+  let(:commit_msg_file_path) { create_tempfile(commit_msg).path }
   let(:stderr) { StringIO.new }
   let(:stdin) { StringIO.new }
   let(:branch_name) { "any" }
   let(:runner) do
-    FitCommit::Runner.new(commit_msg_file.path, branch_name, stderr, stdin)
+    FitCommit::Runner.new(commit_msg_file_path, branch_name, stderr, stdin)
   end
 
   def call_runner

data/test/unit/validator_loader_test.rb

@@ -3,81 +3,71 @@ require "fit_commit/validator_loader"
 Dir[File.dirname(__FILE__) + "/validators/*.rb"].each { |file| require file }
 
 describe FitCommit::ValidatorLoader do
-  let(:validators) { loader.validators }
-  let(:loader) { FitCommit::ValidatorLoader.new(branch_name, configuration) }
-  let(:branch_name) { "foo" }
-  let(:configuration) do
+  def simple_validators(branch_name: "mybranch")
     # 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(
+    configuration = all_disabled_configuration.merge(
       FitCommit::Validators::LineLength.name => { "Enabled" => false },
       FitCommit::Validators::Wip.name => { "Enabled" => true },
       FitCommit::Validators::Frathouse.name => { "Enabled" => ["bar", /\Abaz+/] }
     )
+    FitCommit::ValidatorLoader.new(branch_name, configuration).validators
   end
-  let(:all_disabled_configuration) do
+
+  def all_disabled_configuration
     FitCommit::Validators::Base.all.each_with_object({}) do |v, config|
       config[v.name] = { "Enabled" => false }
     end
   end
 
   it "loads enabled validators" do
-    assert validators.one? { |v| v.is_a? FitCommit::Validators::Wip }
+    assert simple_validators.grep(FitCommit::Validators::Wip).one?
   end
 
   it "doesn't load disabled validators" do
-    assert validators.none? { |v| v.is_a? FitCommit::Validators::LineLength }
+    assert simple_validators.grep(FitCommit::Validators::LineLength).none?
   end
 
   describe "non-boolean options for Enabled" do
     describe "branch_name does not match validator" do
       it "doesn't load validator" do
-        assert validators.none? { |v| v.is_a? FitCommit::Validators::Frathouse }
+        assert simple_validators.grep(FitCommit::Validators::Frathouse).none?
       end
     end
 
     describe "branch_name matches validator via String" do
-      let(:branch_name) { "bar" }
       it "loads validator" do
-        assert validators.one? { |v| v.is_a? FitCommit::Validators::Frathouse }
+        assert simple_validators(branch_name: "bar").
+          grep(FitCommit::Validators::Frathouse).one?
       end
     end
 
     describe "branch_name matches validator via regex" do
-      let(:branch_name) { "bazzz" }
       it "loads validator" do
-        assert validators.one? { |v| v.is_a? FitCommit::Validators::Frathouse }
+        assert simple_validators(branch_name: "bazzz").
+          grep(FitCommit::Validators::Frathouse).one?
       end
     end
   end
 
   describe "branch_name is blank" do
-    let(:branch_name) { "" }
     it "loads enabled validators" do
-      assert validators.one? { |v| v.is_a? FitCommit::Validators::Wip }
+      assert simple_validators(branch_name: "").grep(FitCommit::Validators::Wip).one?
     end
     it "doesn't load disabled validators" do
-      assert validators.none? { |v| v.is_a? FitCommit::Validators::LineLength }
+      assert simple_validators(branch_name: "").grep(FitCommit::Validators::LineLength).none?
     end
     it "doesn't load validators that have non-boolean options for Enabled" do
-      assert validators.none? { |v| v.is_a? FitCommit::Validators::Frathouse }
+      assert simple_validators(branch_name: "").grep(FitCommit::Validators::Frathouse).none?
     end
   end
 
   describe "custom validators required" do
-    after do
-      custom_validator_file.unlink
-    end
-
-    let(:custom_validator_file) do
-      create_tempfile(["my_custom_validator", ".rb"], custom_validator_code)
-    end
-
-    # Not actually subclassing FitCommit::Validators::Base because
-    # that affects the loaded validators for other tests.
-    let(:custom_validator_code) do
-      <<-EOF
+    it "loads enabled custom validator" do
+      # Not actually subclassing FitCommit::Validators::Base because
+      # that affects the loaded validators for other tests.
+      custom_validator_code = <<~EOF
         class MyCustomValidator
           attr_accessor :config
           def initialize(_branch_name, config)
@@ -88,23 +78,24 @@ describe FitCommit::ValidatorLoader do
           end
         end
       EOF
-    end
 
-    let(:configuration) do
-      all_disabled_configuration.merge(
+      # rb extension is necessary to `require` it
+      custom_validator_file = create_tempfile(
+        custom_validator_code, ["custom_validator", ".rb"])
+
+      configuration = all_disabled_configuration.merge(
         "FitCommit" => { "Require" => [custom_validator_file.path] },
         "MyCustomValidator" => { "Enabled" => true }
       )
-    end
 
-    it "loads enabled custom validator" do
       # stub which will be overridden when the custom validator file is loaded
       MyCustomValidator = Class.new
 
-      FitCommit::Validators::Base.stub(:all, [MyCustomValidator]) do
-        assert_equal 1, validators.size
-        assert validators.first.is_a?(MyCustomValidator)
+      validators = FitCommit::Validators::Base.stub(:all, [MyCustomValidator]) do
+        FitCommit::ValidatorLoader.new("mybranch", configuration).validators
       end
+      assert_equal 1, validators.size
+      assert validators.first.is_a?(MyCustomValidator)
     end
   end
 end

data/test/unit/validators/capitalize_subject_test.rb

@@ -9,7 +9,7 @@ describe FitCommit::Validators::CapitalizeSubject do
   let(:config) { default_config }
   let(:branch_name) { "any" }
 
-  describe "subject is not capitalized" do
+  describe "subject is uncapitalized" do
     let(:commit_msg) { "foo bar" }
     it "has error" do
       validator.validate(commit_lines)
@@ -17,6 +17,42 @@ describe FitCommit::Validators::CapitalizeSubject do
       assert_empty validator.warnings
     end
   end
+  describe "subject is WIPlike (single uncapitalized word with no body)" do
+    let(:commit_msg) { "foo" }
+
+    describe "WarnOnWiplikes is true" do
+      it "has a warning" do
+        validator.validate(commit_lines)
+        assert_empty validator.errors
+        assert_equal 1, validator.warnings[1].size
+      end
+    end
+
+    describe "WarnOnWiplikes is false" do
+      let(:config) { default_config.merge("WarnOnWiplikes" => false) }
+      it "has an error" do
+        validator.validate(commit_lines)
+        assert_equal 1, validator.errors[1].size
+        assert_empty validator.warnings
+      end
+    end
+  end
+  describe "test " do
+    let(:commit_msg) { "\nsdf" }
+    it "has a warning" do
+      validator.validate(commit_lines)
+      assert_empty validator.errors
+      assert_empty validator.warnings
+    end
+  end
+  describe "subject is a single uncapitalized word with a body" do
+    let(:commit_msg) { "foo\n\nbaz" }
+    it "has error" do
+      validator.validate(commit_lines)
+      assert_equal 1, validator.errors[1].size
+      assert_empty validator.warnings
+    end
+  end
   describe "subject is fixup commit" do
     let(:commit_msg) { "fixup! foo bar" }
     it "does not have errors/warnings" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fit-commit
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Michael Foley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-08 00:00:00.000000000 Z
+date: 2018-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: swearjar
@@ -69,6 +69,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- TODO.md
 - bin/fit-commit
 - fit-commit.gemspec
 - lib/fit_commit.rb
@@ -131,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A Git hook to validate your commit messages