commit-meat 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+_0.0.5_
+* Added warnings which do not fail the commit.
+* Changed bad words test to be warning.
+* Added white list to bad words (currently including commonly used words such as `class` or `asset`).
+
 _0.0.4_
 * Fixed installation error.
 

data/TODO.md

@@ -0,0 +1,2 @@
+* Move each test to a separate module.
+* Allow users to config which tests are included, and whether they should fail or warn.

data/lib/commit-meat.rb

@@ -8,22 +8,26 @@ require 'yaml'
 module CommitMeat
 
   def self.run
-    message_file = ARGV[0]
-    message = File.read(message_file).strip
-
-    tester = Tester.new(message)
-
+    tester = Tester.new(commit_message)
     tester.test
-    if tester.failed?
-      fail_with_message(tester.failure_messages)
+
+    if tester.has_failures? || tester.has_warnings?
+      puts "There's NO MEAT - did not commit.".magenta.bold
+      tester.warning_messages.each { |message| puts message.yellow }
+      tester.failure_messages.each { |message| puts message.red }
     end
+
+    stop_commit if tester.has_failures?
   end
 
   private
 
-  def self.fail_with_message(messages)
-    puts "There's NO MEAT - did not commit.".red
-    messages.each { |message| puts message.yellow }
+  def self.commit_message
+    message_file = ARGV[0]
+    File.read(message_file).strip
+  end
+
+  def self.stop_commit
     exit 1
   end
 

data/lib/commit-meat/config/bad_words_whitelist.yml

@@ -0,0 +1,4 @@
+---
+- class
+- klass
+- asset

data/lib/commit-meat/tester.rb

@@ -2,28 +2,48 @@ module CommitMeat
 
   class Tester
 
-    attr_reader :failure_messages
+    attr_reader :failure_messages, :warning_messages
 
     def initialize(message)
       @message = message
       @failure_messages = []
+      @warning_messages = []
     end
 
-    def failed?
+    def has_messages?
+      has_warnings? || has_failures?
+    end
+
+    def has_warnings?
+      @warning_messages.any?
+    end
+
+    def has_failures?
       @failure_messages.any?
     end
 
     def test
-      check_if :has_only_one_word,  "Single word commit messages are not allowed."
-      check_if :includes_bad_words, "Bad words are not allowed in commit messages."
+      fail_if :has_only_one_word,  "A single word commit message? really?"
+      warn_if :includes_bad_words, "$@#! - [gets shocked by a V-chip]"
+    end
+
+    private
+
+    def fail_if(test, failure_message)
+      test_if(test, failure_message, @failure_messages)
+    end
+
+    def warn_if(test, warning_message)
+      test_if(test, warning_message, @warning_messages)
     end
 
-    def check_if(bad_commit_test, failure_message)
-      if send(bad_commit_test)
-        @failure_messages << failure_message
+    def test_if(test, message, message_box)
+      if send(test)
+        message_box << message
       end
     end
 
+
     ## tests
 
     def has_only_one_word
@@ -32,15 +52,19 @@ module CommitMeat
 
     def includes_bad_words
       bad_words = YAML::load_file(File.join(File.dirname(File.expand_path(__FILE__)), 'config/bad_words.yml'))
-      bad_words_found = []
+      bad_words_whitelist = YAML::load_file(File.join(File.dirname(File.expand_path(__FILE__)), 'config/bad_words_whitelist.yml'))
+
+      words_in_message = @message.split
 
-      bad_words.each do |word|
-        bad_words_found << word if @message.include?(word)
+      bad_words.any? do |bad_word|
+        words_in_message.any? do |word|
+          if word.include?(bad_word)
+            !bad_words_whitelist.any? { |whitelist_word| word.include?(whitelist_word) }
+          end
+        end
       end
 
-      bad_words_found.any?
     end
 
   end
-
 end

data/lib/commit-meat/version.rb

@@ -1,5 +1,5 @@
 module CommitMeat
 
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commit-meat
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -56,11 +56,13 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- TODO.md
 - bin/commit-meat
 - commit-meat.gemspec
 - gemfile
 - lib/commit-meat.rb
 - lib/commit-meat/config/bad_words.yml
+- lib/commit-meat/config/bad_words_whitelist.yml
 - lib/commit-meat/installation.rb
 - lib/commit-meat/tester.rb
 - lib/commit-meat/version.rb