fit-commit 3.2.2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a192b55fd47925dbae22610a7fc15811751d0b57
-  data.tar.gz: 58e5247361be7806cbf568b05ef5f10bb8a9a811
+  metadata.gz: 8c1962d7ad212ab2d64654448e4ec61fa069636f
+  data.tar.gz: c8942246016315fa610507e5e07ecb978caa4563
 SHA512:
-  metadata.gz: 3d09f8222037da2a6f794870762e7720e49f86afb45fdd233a16910ba2c14d1b73deae27179ff01cb7ec67a09d41691302d48ab38e3ee060a411982e7378b463
-  data.tar.gz: c4ecf05c835b1d2d4f0896e82c535f05737b386985520dfa4341cf0f98cf8ed455299ef983977b7971a6243a64097b0ebb19cce5d4bde0eb5a318e23c3c6b2fd
+  metadata.gz: 5fa212d38361178174a815e1c26f899d4691c71d7bbb01b42a01397bda93db1a574b66ef591bc01d61bf7e6954834d39349e52cd111c8c6a7905c42c1e55d4bb
+  data.tar.gz: 503e76de5b61998831d17a5d47c9da2166597c390f120fe8963b12fe94a9e840f5db25b891380a363bbc3f324ad2309bbcc7a59065c0b11579984938968dea1f

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### v3.3.0 (2015-10-10)
+- Add support for custom validators
+
 ### v3.2.0 (2015-10-03)
 - Add option to re-open text editor
 

data/README.md

@@ -82,6 +82,46 @@ Validators/Bar:
     - !ruby/regexp /\Afoo.+bar/
 ```
 
+## Adding custom validators
+
+Create your custom validator as a `FitCommit::Validators::Base` subclass:
+
+```ruby
+module FitCommit
+  module Validators
+    class MyCustomValidator < Base
+      def validate_line(lineno, text)
+        if text =~ /sneak peak/i
+          add_error(lineno, "I think you mean 'sneak peek'.")
+        end
+      end
+    end
+  end
+end
+```
+
+`Require` the file and enable the validator in your config:
+
+```yaml
+FitCommit:
+  Require:
+    - somedir/my_custom_validator.rb
+Validators/MyCustomValidator:
+  Enabled: true
+```
+
+You can also publish your validator as a gem, and require it that way:
+
+```yaml
+FitCommit:
+  Require:
+    - my-custom-validator-gem
+Validators/MyCustomValidator:
+  Enabled: true
+```
+
+If others might find your validator useful, submit it as a Pull Request. If it's not useful for everyone, it can be disabled by default.
+
 ## FAQ
 
 ### Can Fit Commit run in all my repos without having to install it each time?

data/lib/fit_commit/configuration_loader.rb

@@ -45,7 +45,7 @@ module FitCommit
 
     def read_config(path)
       load_yaml(path).each_with_object({}) do |(key, value), config|
-        translated_key = translate_class_name(key)
+        translated_key = translate_config_key(key)
         config[translated_key] = value
       end
     end
@@ -57,8 +57,9 @@ module FitCommit
       raise e, "Error parsing config file: #{e.message}"
     end
 
-    def translate_class_name(config_class_name)
-      "FitCommit::" + config_class_name.gsub("/", "::")
+    def translate_config_key(config_key)
+      return config_key unless config_key.include?("/")
+      "FitCommit::" + config_key.gsub("/", "::")
     end
   end
 end

data/lib/fit_commit/validator_loader.rb

@@ -19,12 +19,25 @@ module FitCommit
     end
 
     def all_validators
-      Dir[File.dirname(__FILE__) + "/validators/*.rb"].each { |file| require file }
+      require_all_validators
       FitCommit::Validators::Base.all.map do |validator_class|
         validator_class.new(branch_name, config_for(validator_class))
       end
     end
 
+    def require_all_validators
+      paths = Dir[File.dirname(__FILE__) + "/validators/*.rb"] + custom_requires
+      paths.each { |file| require file }
+    end
+
+    def custom_requires
+      Array(global_settings["Require"])
+    end
+
+    def global_settings
+      configuration["FitCommit"] || {}
+    end
+
     def config_for(validator_class)
       configuration[validator_class.name] || {}
     end

data/lib/fit_commit/version.rb

@@ -1,3 +1,3 @@
 module FitCommit
-  VERSION = "3.2.2"
+  VERSION = "3.3.0"
 end

data/templates/config/fit_commit.default.yml

@@ -16,3 +16,5 @@ Validators/Wip:
 Validators/Frathouse:
   Enabled:
     - master
+Validators/Foobar:
+  Enabled: true

data/test/integration/new_repo_test.rb

@@ -1,4 +1,4 @@
-require "minitest/autorun"
+require "test_helper"
 require "pty"
 require "expect"
 

data/test/test_helper.rb

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

data/test/unit/configuration_loader_test.rb

@@ -1,4 +1,4 @@
-require "minitest/autorun"
+require "test_helper"
 require "fit_commit/configuration_loader"
 
 describe FitCommit::ConfigurationLoader do
@@ -24,13 +24,6 @@ describe FitCommit::ConfigurationLoader do
     end
   end
 
-  def tempfile(filename, content)
-    Tempfile.new(filename).tap do |f|
-      f.write(content)
-      f.close
-    end
-  end
-
   describe "no configuration files present" do
     let(:system_file) { nil }
     let(:user_file) { nil }
@@ -41,7 +34,7 @@ describe FitCommit::ConfigurationLoader do
 
   describe "just one configuration file present" do
     let(:system_file) { nil }
-    let(:user_file) { tempfile("user_file", user_file_content) }
+    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
@@ -53,23 +46,35 @@ describe FitCommit::ConfigurationLoader do
       }
       assert_equal expected, global_configuration
     end
+
+    describe "has a non-validation key" do
+      let(:user_file_content) do
+        "FitCommit:\n  Require:\n    - foo/bar"
+      end
+      it "doesn't try to namespace the key" do
+        expected = {
+          "FitCommit" => { "Require" => ["foo/bar"] }
+        }
+        assert_equal expected, global_configuration
+      end
+    end
   end
 
   describe "multiple configuration files present" do
-    let(:system_file) { tempfile("system_file", system_file_content) }
-    let(:user_file) { tempfile("user_file", user_file_content) }
+    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\nBuz:\n  - hi"
+      "Qux/Norf/Blah:\n  Foobar: true\nAbc/Buz:\n  - hi"
     end
 
     it "is a merged configuration that takes precedence into account" do
       expected = {
         "FitCommit::Foo::Bar" => { "Baz" => false },
         "FitCommit::Qux::Norf::Blah" => { "Foobar" => true, "Booyah" => false },
-        "FitCommit::Buz" => ["hi"]
+        "FitCommit::Abc::Buz" => ["hi"]
       }
       assert_equal expected, global_configuration
     end

data/test/unit/message_parser_test.rb

@@ -1,4 +1,4 @@
-require "minitest/autorun"
+require "test_helper"
 require "fit_commit/message_parser"
 
 describe FitCommit::MessageParser do
@@ -6,16 +6,8 @@ describe FitCommit::MessageParser 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
+  let(:commit_msg_file) { create_tempfile("test-commit-msg", commit_msg) }
+  let(:lines) { FitCommit::MessageParser.new(commit_msg_file.path).lines }
 
   describe "empty commit msg" do
     let(:commit_msg) { "" }

data/test/unit/runner_test.rb

@@ -1,23 +1,11 @@
-require "minitest/autorun"
+require "test_helper"
 require "fit_commit/runner"
 
 describe FitCommit::Runner do
   after do
     commit_msg_file.unlink
   end
-
-  def call_runner
-    exit_code = runner.run
-    stderr.rewind
-    exit_code
-  end
-
-  let(:commit_msg_file) do
-    Tempfile.new("test-commit-msg").tap do |f|
-      f.write(commit_msg)
-      f.close
-    end
-  end
+  let(:commit_msg_file) { create_tempfile("test-commit-msg", commit_msg) }
   let(:stderr) { StringIO.new }
   let(:stdin) { StringIO.new }
   let(:branch_name) { "any" }
@@ -25,6 +13,12 @@ describe FitCommit::Runner do
     FitCommit::Runner.new(commit_msg_file.path, branch_name, stderr, stdin)
   end
 
+  def call_runner
+    exit_code = runner.run
+    stderr.rewind
+    exit_code
+  end
+
   describe "empty commit msg" do
     let(:commit_msg) { "" }
     it "allows commit without printing to stderr" do

data/test/unit/validator_loader_test.rb

@@ -1,4 +1,4 @@
-require "minitest/autorun"
+require "test_helper"
 require "fit_commit/validator_loader"
 Dir[File.dirname(__FILE__) + "/validators/*.rb"].each { |file| require file }
 
@@ -64,4 +64,47 @@ describe FitCommit::ValidatorLoader do
       assert validators.none? { |v| v.is_a? FitCommit::Validators::Frathouse }
     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
+        class MyCustomValidator
+          attr_accessor :config
+          def initialize(_branch_name, config)
+            self.config = config
+          end
+          def enabled?
+            config.fetch("Enabled")
+          end
+        end
+      EOF
+    end
+
+    let(:configuration) do
+      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)
+      end
+    end
+  end
 end

data/test/unit/validators/validator_helper.rb

@@ -1,4 +1,4 @@
-require "minitest/autorun"
+require "test_helper"
 require "yaml"
 
 def default_config_for(key)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fit-commit
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.3.0
 platform: ruby
 authors:
 - Michael Foley
@@ -91,6 +91,7 @@ files:
 - templates/config/fit_commit.default.yml
 - templates/hooks/commit-msg
 - test/integration/new_repo_test.rb
+- test/test_helper.rb
 - test/unit/configuration_loader_test.rb
 - test/unit/message_parser_test.rb
 - test/unit/runner_test.rb
@@ -136,6 +137,7 @@ specification_version: 4
 summary: A Git hook to validate your commit messages
 test_files:
 - test/integration/new_repo_test.rb
+- test/test_helper.rb
 - test/unit/configuration_loader_test.rb
 - test/unit/message_parser_test.rb
 - test/unit/runner_test.rb