danger-commit_lint 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 187b30e375e27640a38f905a84fbe37f3728cbfa
-  data.tar.gz: 3b7c5065e11264bdc7d8a9bb4feb69b654bfbdb9
+  metadata.gz: 17d0cf1ee03d53740dba93d7473a038edef5004b
+  data.tar.gz: 62c86199bef076c8b1843ff6135cda719a489945
 SHA512:
-  metadata.gz: 036da88f891d79ff590a709c8d6bb9ab90918795981eb2ac44e4c97aa9c7d1fa808ab67b72f452f24629c17e19959416ce3b2a509ecfbea70ec9116eebe0248c
-  data.tar.gz: 09e074e74bd5ab2fb2e09a06e961ea732201be60d81d6ca8e2415fba0d93e3ea6368f29397369249891278f38d90f4457d654502dd67b57825d55acda86e2a9d
+  metadata.gz: 6ecc81d9d7a04407a91766f1461ef7084c7c5595f4582799f7b69803892c5f5c7e3dc96a482fad6de0c028d2bd6bd6fd860164f4612831e8a9870cec19338a85
+  data.tar.gz: 5978036983219fe4ab704ff39a25df63b32f78a09d943d00ecbf15e56f79402bd52e0e531e592d75c89591faec4078446445673f80276fd2f0a12deb28de85ac

data/README.md

@@ -4,6 +4,8 @@
 
 This is a [Danger Plugin][danger] that ensures nice and tidy commit messages.
 
+[danger]: https://github.com/danger/danger
+
 ## Installation
 
 ```
@@ -20,6 +22,7 @@ commit_lint.check
 
 That will check each commit in the PR to ensure the following is true:
 
+* Commit subject begins with a capital letter (`subject_cap`)
 * Commit subject is no longer than 50 characters (`subject_length`)
 * Commit subject does not end in a period (`subject_period`)
 * Commit subject and body are separated by an empty line (`empty_line`)
@@ -56,17 +59,7 @@ commit_lint.check fail: :all
 Also note that there is one more way that Commit Lint can behave:
 
 ```ruby
-commit_lint.check diable: :all
+commit_lint.check disable: :all
 ```
 
 This will actually throw a warning that Commit Lint isn't doing anything.
-
-## Development
-
-1. Clone this repo
-2. Run `bundle install` to setup dependencies.
-3. Run `bundle exec rake spec` to run the tests.
-4. Use `bundle exec guard` to automatically have tests run as you make changes.
-5. Make your changes.
-
-[danger]: https://github.com/danger/danger

data/lib/commit_lint/gem_version.rb

@@ -1,3 +1,3 @@
 module CommitLint
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

data/lib/commit_lint/plugin.rb

@@ -30,6 +30,7 @@ module Danger
     #
     #        The current check types are:
     #
+    #        * `subject_cap`
     #        * `subject_length`
     #        * `subject_period`
     #        * `empty_line`
@@ -42,7 +43,7 @@ module Danger
       @config = config
 
       if all_checks_disabled?
-        warn NOOP_MESSAGE
+        messaging.warn NOOP_MESSAGE
       else
         check_messages
       end
@@ -53,19 +54,17 @@ module Danger
     def check_messages
       for message in messages
         for klass in warning_checkers
-          warn klass::MESSAGE if klass.fail? message
+          messaging.warn klass::MESSAGE if klass.fail? message
         end
 
         for klass in failing_checkers
-          # rubocop:disable Style/SignalException
-          fail klass::MESSAGE if klass.fail? message
-          # rubocop:enable Style/SignalException
+          messaging.fail klass::MESSAGE if klass.fail? message
         end
       end
     end
 
     def checkers
-      [SubjectLengthCheck, SubjectPeriodCheck, EmptyLineCheck]
+      [SubjectCapCheck, SubjectLengthCheck, SubjectPeriodCheck, EmptyLineCheck]
     end
 
     def checks

data/lib/commit_lint/subject_cap_check.rb

@@ -0,0 +1,19 @@
+module Danger
+  class DangerCommitLint < Plugin
+    class SubjectCapCheck < CommitCheck # :nodoc:
+      MESSAGE = 'Please start subject with capital letter.'.freeze
+
+      def self.type
+        :subject_cap
+      end
+
+      def initialize(message)
+        @first_character = message[:subject].split('').first
+      end
+
+      def fail?
+        @first_character != @first_character.upcase
+      end
+    end
+  end
+end

data/lib/danger_plugin.rb

@@ -1,4 +1,5 @@
 require 'commit_lint/commit_check'
+require 'commit_lint/subject_cap_check'
 require 'commit_lint/subject_length_check'
 require 'commit_lint/subject_period_check'
 require 'commit_lint/empty_line_check'

data/spec/commit_lint_spec.rb

@@ -3,10 +3,11 @@ require File.expand_path('../spec_helper', __FILE__)
 # rubocop:disable Metrics/LineLength
 
 TEST_MESSAGES = {
+  subject_cap: 'this subject needs a capital',
   subject_length: 'This is a really long subject line and should result in an error',
   subject_period: 'This subject line ends in a period.',
   empty_line: "This subject line is fine\nBut then I forgot the empty line separating the subject and the body.",
-  all_errors: "This is a really long subject and it even ends in a period.\nNot to mention the missing empty line!",
+  all_errors: "this is a really long subject and it even ends in a period.\nNot to mention the missing empty line!",
   valid:  "This is a valid message\n\nYou can tell because it meets all the criteria and the linter does not complain."
 }.freeze
 
@@ -30,6 +31,7 @@ module Danger
       context 'with invalid messages' do
         it 'fails those checks' do
           checks = {
+            subject_cap: SubjectCapCheck::MESSAGE,
             subject_length: SubjectLengthCheck::MESSAGE,
             subject_period: SubjectPeriodCheck::MESSAGE,
             empty_line: EmptyLineCheck::MESSAGE
@@ -58,8 +60,9 @@ module Danger
           commit_lint.check
 
           status_report = commit_lint.status_report
-          expect(report_counts(status_report)).to eq 3
+          expect(report_counts(status_report)).to eq 4
           expect(status_report[:errors]).to eq [
+            SubjectCapCheck::MESSAGE,
             SubjectLengthCheck::MESSAGE,
             SubjectPeriodCheck::MESSAGE,
             EmptyLineCheck::MESSAGE
@@ -119,7 +122,9 @@ module Danger
           commit = double(:commit, message: TEST_MESSAGES[:all_errors])
           allow(commit_lint.git).to receive(:commits).and_return([commit])
 
-          all_checks = [:subject_length, :subject_period, :empty_line]
+          all_checks = [
+            :subject_cap, :subject_length, :subject_period, :empty_line
+          ]
           commit_lint.check disable: all_checks
 
           status_report = commit_lint.status_report
@@ -199,8 +204,9 @@ module Danger
             commit_lint.check warn: :all
 
             status_report = commit_lint.status_report
-            expect(report_counts(status_report)).to eq 3
+            expect(report_counts(status_report)).to eq 4
             expect(status_report[:warnings]).to eq [
+              SubjectCapCheck::MESSAGE,
               SubjectLengthCheck::MESSAGE,
               SubjectPeriodCheck::MESSAGE,
               EmptyLineCheck::MESSAGE
@@ -279,8 +285,9 @@ module Danger
             commit_lint.check fail: :all
 
             status_report = commit_lint.status_report
-            expect(report_counts(status_report)).to eq 3
+            expect(report_counts(status_report)).to eq 4
             expect(status_report[:errors]).to eq [
+              SubjectCapCheck::MESSAGE,
               SubjectLengthCheck::MESSAGE,
               SubjectPeriodCheck::MESSAGE,
               EmptyLineCheck::MESSAGE

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-commit_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jon Allured
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-26 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -127,6 +127,7 @@ files:
 - lib/commit_lint/empty_line_check.rb
 - lib/commit_lint/gem_version.rb
 - lib/commit_lint/plugin.rb
+- lib/commit_lint/subject_cap_check.rb
 - lib/commit_lint/subject_length_check.rb
 - lib/commit_lint/subject_period_check.rb
 - lib/danger_commit_lint.rb