poper 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9abd695f0fb3e1824c45c4979a2a9d3d72021e9
-  data.tar.gz: 6e2891f64e04be17af1e4ed5eb1a1ec53dbefb49
+  metadata.gz: 8f86545c610029866d99bad4fcbf3745ab6736bb
+  data.tar.gz: 78c5ac4bb93b7c86afd212c0ec2ccf0d617e7db7
 SHA512:
-  metadata.gz: 29155d2fb248dc20e7f907aeb9586699d1c1486fc6043f690e0bde1e98493cc0be5565d5a2cb9f99be1406a54fd5f323a53a6aeeecc57256546153a5491cd477
-  data.tar.gz: 0307cd1f8cc2c319d83704aba0ffdbc4eab30db81d251fccd4bed29da5f643925c8abb44b75eac5082382bab38489b6d66b5fd9929a7729b17414046b46c315b
+  metadata.gz: 5437729ed76b22d257201c43431ddcfd4436fc13ea649ac1373ac86ae60f5247557fd607fce7580af22062cf75b68f0105bc2b9d1c10f20a33f712bbb91a1d55
+  data.tar.gz: 4db630bcb63d3d1e797c049a6fa72c8a0c4db2363048f657a22050409d1718c85f9485322d0689820e532f812ae541c88ac0ae16b384fa1d15a935a577b5bfaa

data/README.md

@@ -1,15 +1,19 @@
 # Poper
 
-Poper makes sure that your git commit messages are well-formed
 
 [![Code Climate](https://codeclimate.com/github/mmozuras/poper.png)](https://codeclimate.com/github/mmozuras/poper)
 [![Build Status](https://travis-ci.org/mmozuras/poper.png)](https://travis-ci.org/mmozuras/poper)
 [![Gem Version](https://badge.fury.io/rb/poper.png)](http://badge.fury.io/rb/poper)
 [![Dependency Status](https://gemnasium.com/mmozuras/poper.png)](https://gemnasium.com/mmozuras/poper)
 
-## Usage
+Poper makes sure that your git commit messages are well-formed. It's partly
+inspired by [this article][] written by [tpope][]. Rules specified there form
+the basis of [Poper rules][]. But Poper doesn't stop there. It also doesn't
+like generic commit messages like 'oops, fix tests'. Poper was created to be
+used by [Pronto][], but will work perfectly well in whatever scenario you'll
+come up for it!
 
-Poper is partly inspired by an [article](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) written by [tpope](https://twitter.com/tpope). That's where the name comes from actually. Rules from the article form the basis of [Poper rules](https://github.com/mmozuras/poper/tree/master/lib/poper/rule).
+## Usage
 
 ![Poper demo](poper.gif "")
 
@@ -19,7 +23,12 @@ a commit:
 ```bash
   gem install poper
   cd /repo/which/commits/you/want/to/check
-  poper run 86ae550
+  poper run HEAD~3
 ```
 
 Every commit between current HEAD and specified commit will be checked.
+
+[this article]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[tpope]: https://twitter.com/tpope
+[Poper rules]: https://github.com/mmozuras/poper/tree/master/lib/poper/rule
+[Pronto]: https://github.com/mmozuras/pronto

data/lib/poper/rule/capitalization.rb

@@ -1,7 +1,7 @@
 module Poper
   module Rule
     class Capitalization < Rule
-      MSG = 'Commit message should start with a capital letter'
+      MSG = 'Git commit message should start with a capital letter'
 
       def check(message)
         MSG unless message[0] == message[0].capitalize

data/lib/poper/rule/fifty_char_summary.rb

@@ -1,7 +1,7 @@
 module Poper
   module Rule
     class FiftyCharSummary < Rule
-      MSG = 'Summary should be 50 chars or less'
+      MSG = 'Git commit message summary (first line) should be 50 chars or less'
 
       def check(message)
         MSG if message.lines.first.length > 50

data/lib/poper/rule/generic.rb

@@ -1,13 +1,19 @@
 module Poper
   module Rule
     class Generic < Rule
-      MSG = 'Consider writing a more detailed, not as generic, commit summary'
+      MSG = "Consider writing a more detailed, not as generic, commit message"
       GENERIC = %w(fix fixed fixes oops todo fixme commit changes hm hmm hmmm
                    test tests quickfix)
 
       def check(message)
         words = message.scan(/[\w-]+/).compact
-        MSG if words.all? { |word| GENERIC.include?(word.downcase) }
+        MSG if words.all? { |word| generic?(word) }
+      end
+
+      private
+
+      def generic?(word)
+        GENERIC.include?(word.downcase)
       end
     end
   end

data/lib/poper/rule/seventy_two_char_limit.rb

@@ -1,7 +1,7 @@
 module Poper
   module Rule
     class SeventyTwoCharLimit < Rule
-      MSG = 'Every line should be 72 chars or less'
+      MSG = 'Every line of git commit message should be 72 chars or less'
 
       def check(message)
         MSG if message.lines.any? { |line| line.length > 72 }

data/lib/poper/rule/single_word.rb

@@ -1,7 +1,7 @@
 module Poper
   module Rule
     class SingleWord < Rule
-      MSG = 'Commit message should consist of more than a single word'
+      MSG = 'Git commit message should consist of more than a single word'
 
       def check(message)
         MSG if message.split.count < 2

data/lib/poper/version.rb

@@ -1,3 +1,3 @@
 module Poper
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mindaugas Mozūras
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-20 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged