poper 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8da7afdab8cf5bd3b4863dc8b878528151949106
-  data.tar.gz: ec9facfa5e460305810bfc8814f4d86e90c81297
+  metadata.gz: 91ce853722b93b72d992dc75390b80c5f79d8ba2
+  data.tar.gz: 9627c465d6d4e6526f40a676a1ae77516adfbea2
 SHA512:
-  metadata.gz: f7cc62e3892c703814d541a73fcb7fc2acaac8d07af97246f60ef6bebef1f078749c22f898f09ff576a3c6a91304a0b39d264399da6a8260db7790c6abc421b4
-  data.tar.gz: c4e797630e44d6c1852fc7c7cdf087445320d8a3a2522f9c07fe42f751c2fe85737ecef8ae041fcca943463011f55200f2f40788ae3ac4139d450e4e172a61a9
+  metadata.gz: 42a89ba0bc33f310933dc3010f8fe325aa4f38b88c6a8af132e6401468f64d616867121957e21598c3264c3eed4168fc1e5cd69419e2f9e9cb2b68ef9bfebf27
+  data.tar.gz: 54c9061775f67d4a5c5faebb60ec1401d653f40dabf11952d55fea4b82d3283308d76a7275d36109defdf50f72878012f7788eacf78fcd0acd7672bc8fc7dee2

data/README.md

@@ -1,8 +1,8 @@
 # Poper
 
-
-[![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)
++[![Coverage Status](https://img.shields.io/codeclimate/coverage/github/mmozuras/poper.svg)](https://codeclimate.com/github/mmozuras/poper)
++[![Code Climate](https://codeclimate.com/github/mmozuras/poper.svg)](https://codeclimate.com/github/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)
 
@@ -32,3 +32,49 @@ Every commit between current HEAD and specified commit will be checked.
 [tpope]: https://twitter.com/tpope
 [Poper rules]: https://github.com/mmozuras/poper/tree/master/lib/poper/rule
 [Pronto]: https://github.com/mmozuras/pronto
+
+## Configuration
+
+The behavior of Poper can be controlled via the `.poper.yml` configuration
+file. It must be placed in your project directory. A sample file, `.poper.sample.yml`, is included for easy setup.
+
+The file has the following format:
+
+```yaml
+disallow_single_word:
+  enabled: true
+
+character_limit:
+  enabled: true
+  number: 72
+
+summary_character_limit:
+  enabled: true
+  number: 50
+
+disallow_generic:
+  enabled: true
+  words:
+    - fix
+    - fixed
+    - fixes
+    - oops
+    - todo
+    - fixme
+    - commit
+    - changes
+    - hm
+    - hmm
+    - hmmm
+    - test
+    - tests
+    - quickfix
+
+enforce_capitalized:
+  enabled: true
+```
+
+All properties that can be specified via `.poper.yml`, can also be specified
+via environment variables. Their names will be the upcased path to the property.
+For example: `POPER_ENFORCE_CAPITALIZED_ENABLED` or `POPER_DISALLOW_GENERIC_WORDS`. (In the case of the latter, since environment variables don't support arrays, use a comma-separated list of words and poper will parse them appropriately.) Environment variables
+will always take precedence over values in configuration file.

data/lib/poper.rb

@@ -1,8 +1,12 @@
 require 'rugged'
+require 'yaml'
 require 'poper/runner'
 require 'poper/rule/rule'
 require 'poper/rule/capitalization'
 require 'poper/rule/single_word'
-require 'poper/rule/fifty_char_summary'
-require 'poper/rule/seventy_two_char_limit'
+require 'poper/rule/summary_character_limit'
+require 'poper/rule/character_limit'
 require 'poper/rule/generic'
+
+require 'poper/config_file'
+require 'poper/config'

data/lib/poper/config.rb

@@ -0,0 +1,20 @@
+module Poper
+  class Config
+    def initialize(config_hash = ConfigFile.new.to_h)
+      @config_hash = config_hash
+    end
+
+    %w(
+      disallow_single_word
+      character_limit
+      summary_character_limit
+      disallow_generic
+      enforce_capitalized
+    ).each do |rule|
+      ConfigFile::EMPTY[rule].each do |key, _|
+        name = "#{rule}_#{key}"
+        define_method(name) { ENV["POPER_#{name.upcase}"] || @config_hash[rule][key] }
+      end
+    end
+  end
+end

data/lib/poper/config_file.rb

@@ -0,0 +1,48 @@
+module Poper
+  class ConfigFile
+    EMPTY = {
+      'disallow_single_word' => {
+        'enabled' => true
+      },
+      'character_limit' => {
+        'enabled' => true,
+        'number' => 72
+      },
+      'summary_character_limit' => {
+        'enabled' => true,
+        'number' => 50
+      },
+      'disallow_generic' => {
+        'enabled' => true,
+        'words' => %w(fix fixed fixes oops todo fixme commit changes hm hmm hmmm
+        test tests quickfix)
+      },
+      'enforce_capitalized' => {
+        'enabled' => true
+      },
+    }.freeze
+
+    def initialize(path = '.poper.yml')
+      @path = path
+    end
+
+    def to_h
+      hash = File.exist?(@path) ? YAML.load_file(@path) : {}
+      deep_merge(hash)
+    end
+
+    private
+
+    def deep_merge(hash)
+      merger = proc do |_, oldval, newval|
+        if oldval.is_a?(Hash) && newval.is_a?(Hash)
+          oldval.merge(newval, &merger)
+        else
+          oldval || newval
+        end
+      end
+
+      hash.merge(EMPTY, &merger)
+    end
+  end
+end

data/lib/poper/rule/capitalization.rb

@@ -1,10 +1,18 @@
 module Poper
   module Rule
     class Capitalization < Rule
-      MSG = 'Git commit message should start with a capital letter'
-
       def check(message)
-        MSG unless message[0] == message[0].capitalize
+        error_message unless message[0] == message[0].capitalize
+      end
+
+      def enabled?
+        @config.enforce_capitalized_enabled.to_s == 'true'
+      end
+
+      private
+
+      def error_message
+        'Git commit message should start with a capital letter'
       end
     end
   end

data/lib/poper/rule/character_limit.rb

@@ -0,0 +1,25 @@
+module Poper
+  module Rule
+    class CharacterLimit < Rule
+      def check(message)
+        error_message if message.lines.any? do |line|
+          line.length > character_limit
+        end
+      end
+
+      def enabled?
+        @config.character_limit_enabled.to_s == 'true'
+      end
+
+      private
+
+      def character_limit
+        @config.character_limit_number.to_i
+      end
+
+      def error_message
+        "Every line of git commit message should be #{character_limit} chars or less"
+      end
+    end
+  end
+end

data/lib/poper/rule/generic.rb

@@ -1,19 +1,31 @@
 module Poper
   module Rule
     class Generic < Rule
-      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?(word) }
+        error_message if words.all? { |word| generic?(word) }
+      end
+
+      def enabled?
+        @config.disallow_generic_enabled.to_s == 'true'
       end
 
       private
 
       def generic?(word)
-        GENERIC.include?(word.downcase)
+        disallowed_words.include?(word.downcase)
+      end
+
+      def disallowed_words
+        if @config.disallow_generic_words.is_a? Array
+          @config.disallow_generic_words
+        else
+          @config.disallow_generic_words.split(',').map(&:strip)
+        end
+      end
+
+      def error_message
+        'Consider writing a more detailed, not as generic, commit message'
       end
     end
   end

data/lib/poper/rule/rule.rb

@@ -10,6 +10,10 @@ module Poper
       def self.inherited(subclass)
         @all << subclass
       end
+
+      def initialize(config = Config.new)
+        @config = config
+      end
     end
   end
 end

data/lib/poper/rule/single_word.rb

@@ -1,10 +1,18 @@
 module Poper
   module Rule
     class SingleWord < Rule
-      MSG = 'Git commit message should consist of more than a single word'
-
       def check(message)
-        MSG if message.split.count < 2
+        error_message if message.split.count < 2
+      end
+
+      def enabled?
+        @config.disallow_single_word_enabled.to_s == 'true'
+      end
+
+      private
+
+      def error_message
+        'Git commit message should consist of more than a single word'
       end
     end
   end

data/lib/poper/rule/summary_character_limit.rb

@@ -0,0 +1,23 @@
+module Poper
+  module Rule
+    class SummaryCharacterLimit < Rule
+      def check(message)
+        error_message if message.lines.first.chomp.length > character_limit
+      end
+
+      def enabled?
+        @config.summary_character_limit_enabled.to_s == 'true'
+      end
+
+      private
+
+      def character_limit
+        @config.summary_character_limit_number.to_i
+      end
+
+      def error_message
+        "Git commit message summary (first line) should be #{character_limit} chars or less"
+      end
+    end
+  end
+end

data/lib/poper/runner.rb

@@ -22,7 +22,11 @@ module Poper
     end
 
     def rules
-      Rule::Rule.all.map(&:new)
+      Rule::Rule.all.map do |rule_klass|
+        rule = rule_klass.new
+
+        rule if rule.enabled?
+      end.compact
     end
 
     def commits

data/lib/poper/version.rb

@@ -1,3 +1,3 @@
 module Poper
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poper
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Mindaugas Mozūras
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: mindaugas.mozuras@gmail.com
 executables:
@@ -126,12 +154,14 @@ files:
 - bin/poper
 - lib/poper.rb
 - lib/poper/cli.rb
+- lib/poper/config.rb
+- lib/poper/config_file.rb
 - lib/poper/rule/capitalization.rb
-- lib/poper/rule/fifty_char_summary.rb
+- lib/poper/rule/character_limit.rb
 - lib/poper/rule/generic.rb
 - lib/poper/rule/rule.rb
-- lib/poper/rule/seventy_two_char_limit.rb
 - lib/poper/rule/single_word.rb
+- lib/poper/rule/summary_character_limit.rb
 - lib/poper/runner.rb
 - lib/poper/version.rb
 homepage: http://github.org/mmozuras/poper

data/lib/poper/rule/fifty_char_summary.rb

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

data/lib/poper/rule/seventy_two_char_limit.rb

@@ -1,11 +0,0 @@
-module Poper
-  module Rule
-    class SeventyTwoCharLimit < Rule
-      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 }
-      end
-    end
-  end
-end