danger-commit_lint 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d442fcfa2a61091d899fdf10fcf7cc53c5cc18f1
-  data.tar.gz: 8b086d19febc9709455e524d77e66aa146446e45
+  metadata.gz: 6f4dbf495b8baeb61eb02cd6966df4da7c2a0a58
+  data.tar.gz: a2042652a29ce9ac46e469fc5a4e31dbdee03b2f
 SHA512:
-  metadata.gz: 83edf5f94fa20ba3c0242358f279639959b66ddafa20fe475e07dbce375cc81b1e1b7eb6526b2eb1f664896ba93fa17b88edda8350e6d1db3058d5820765a245
-  data.tar.gz: 49a3c4be039a1d0b3ea6cd856065addf745f5ab3da6bd4f83486943184137642b80baafa3982a6c448c944dc02f8a636d6b310d20c48b6db73c61427c7523f86
+  metadata.gz: b72e792a4cbea18e5678b7cd348d8cf5315bcad18f1b7a29844f00376e7441b93c1b7c8f30feda43922c5bca815c8b96036d9009bfb581fbc4112ba0c484d6e2
+  data.tar.gz: 05c59322a26736290fc1eda2e06afdf300ea1d782d7afd15b24ba8815de0bb6a622b08afcd3a52a33ea44bfe2dc90199fb2365fdb790bfe8699ebf4082013cd8

data/.travis.yml

@@ -3,16 +3,17 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 2.1
   - 2.2
-  - 2.3.1
+  - 2.3.3
+  - 2.4.0
   - jruby-9
 
 script:
   - bundle exec rake
+  - bundle exec danger
 
 notifications:
   email: false
   webhooks:
     urls:
-      - https://uplink-app.herokuapp.com/travis_hooks
+      secure: F8ECoiEAmcEvw3rC/BtacmqhCfc+uAn8WhwH0ockorPdWIbOihnxGz8C3QIz+Cl8QTAuG9hY5lp/VG5UfpX0XirhuJ1FH9AmIUYnIWkWois6UKyjmBV4VitQDtGAkFzK7hCLZjrAT9PBpeJKkljltRgGQaeMDLpasxzgGO8MlcKe6hoZP6AoUdesOu10kePl6eQN4jXkg0Cr9BrYq93tZuCKvKkkVbTgeyni5RjxfMVyARGsu5+OWcMjMmaTYzs1+FNb+d7odvzMaIpJywS/MKAyE3QmXi2QFTb6ij/A77Z7Cj3MzWSD8MvVQdRfOBNfUhWYQzvaD79JR2ijYajxvcrZN/3gpi8CemKrMrqlPmDtRn/mcY3+37U/wfZfJIfhEYnQDkxR+OszaE2abbI0yYC4xQGySnHMltFkALxIdoPixir/OsO/KgDPMtuuQ2zG9d9xHp0rgeW6MEF99pOHNvCSxdny/p57GyFwKtAf+y37RwegTw6V3SU4hyfiofnndDGWX9F19TrFWwNFd9c2oPOkGdNqUahitEzmkQBFZQ76UPNLX9k1k/dzm0RLW8l1Ypa7J2B/aW6WNOT6Ucz0LvNCIte8svtyRgi60emy1r7uL1ltZ7lafP4eLQnWzyBClW7yTkU4F5AcrQFVuGuaq6up5wYfbIK9RU7ocbsOo10=

data/CHANGELOG.md

@@ -0,0 +1,77 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog][keep] and this project adheres to
+[Semantic Versioning][semver].
+
+[keep]: http://keepachangelog.com/
+[semver]: http://semver.org/
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/jonallured/danger-commit_lint/compare/v0.0.5...master
+
+## [0.0.5] - 2016-12-28
+
+### Added
+
+* Add Ruby 2.4 to Travis [1aa9cff][1aa9cff]
+* Add a Dangerfile [51c597a][51c597a]
+* Add SHA to feedback [35044ae][35044ae]
+* Add check for one-word commit messages [c2dce9c][c2dce9c]
+* Add this very CHANGELOG
+
+### Removed
+
+* Drop Ruby 2.2 from Travis [1aa9cff][1aa9cff]
+
+[0.0.5]: https://github.com/jonallured/danger-commit_lint/compare/v0.0.4...0.0.5
+[1aa9cff]: https://github.com/jonallured/danger-commit_lint/commit/1aa9cff
+[51c597a]: https://github.com/jonallured/danger-commit_lint/commit/51c597a
+[35044ae]: https://github.com/jonallured/danger-commit_lint/commit/35044ae
+[c2dce9c]: https://github.com/jonallured/danger-commit_lint/commit/c2dce9c
+
+## [0.0.4] - 2016-11-03
+
+### Changed
+
+* Upgrade to newest Danger [6fbbdd3][6fbbdd3]
+
+[0.0.4]: https://github.com/jonallured/danger-commit_lint/compare/v0.0.3...v0.0.4
+[6fbbdd3]: https://github.com/jonallured/danger-commit_lint/commit/6fbbdd3
+
+## [0.0.3] - 2016-10-07
+
+### Added
+
+* Added JRuby to Travis [2266134][2266134]
+
+### Changed
+
+* Improved the inline docs [c5f7408][c5f7408]
+* Improved README [71ce9f9][71ce9f9] [c58e34c][c58e34c]
+
+[0.0.3]: https://github.com/jonallured/danger-commit_lint/compare/v0.0.2...v0.0.3
+[2266134]: https://github.com/jonallured/danger-commit_lint/commit/2266134
+[c5f7408]: https://github.com/jonallured/danger-commit_lint/commit/c5f7408
+[71ce9f9]: https://github.com/jonallured/danger-commit_lint/commit/71ce9f9
+[c58e34c]: https://github.com/jonallured/danger-commit_lint/commit/c58e34c
+
+## [0.0.2] - 2016-09-01
+
+### Added
+
+* Added a check to ensure first letter is capitalized [4a691ef][4a691ef]
+
+### Changed
+
+* Switched to using the internal API for warn/error [9ca11d6][9ca11d6]
+
+[0.0.2]: https://github.com/jonallured/danger-commit_lint/compare/v0.0.1...v0.0.2
+[4a691ef]: https://github.com/jonallured/danger-commit_lint/commit/4a691ef
+[9ca11d6]: https://github.com/jonallured/danger-commit_lint/commit/9ca11d6
+
+## 0.0.1 - 2016-08-26
+
+Initial release

data/Dangerfile

@@ -0,0 +1 @@
+commit_lint.check

data/README.md

@@ -28,6 +28,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 more than one word (`subject_word`)
 * 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`)

data/lib/commit_lint/gem_version.rb

@@ -1,3 +1,3 @@
 module CommitLint
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.0.5'.freeze
 end

data/lib/commit_lint/plugin.rb

@@ -5,6 +5,7 @@ module Danger
   #  true:
   #
   #  * Commit subject begins with a capital letter (`subject_cap`)
+  #  * Commit subject is more than one word (`subject_word`)
   #  * 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`)
@@ -41,6 +42,7 @@ module Danger
     #  The current check types are:
     #
     #  * `subject_cap`
+    #  * `subject_word`
     #  * `subject_length`
     #  * `subject_period`
     #  * `empty_line`
@@ -66,17 +68,23 @@ module Danger
     def check_messages
       for message in messages
         for klass in warning_checkers
-          messaging.warn klass::MESSAGE if klass.fail? message
+          issue_warning(klass::MESSAGE, message[:sha]) if klass.fail? message
         end
 
         for klass in failing_checkers
-          messaging.fail klass::MESSAGE if klass.fail? message
+          issue_failure(klass::MESSAGE, message[:sha]) if klass.fail? message
         end
       end
     end
 
     def checkers
-      [SubjectCapCheck, SubjectLengthCheck, SubjectPeriodCheck, EmptyLineCheck]
+      [
+        SubjectCapCheck,
+        SubjectWordsCheck,
+        SubjectLengthCheck,
+        SubjectPeriodCheck,
+        EmptyLineCheck
+      ]
     end
 
     def checks
@@ -111,8 +119,20 @@ module Danger
     def messages
       git.commits.map do |commit|
         (subject, empty_line) = commit.message.split("\n")
-        { subject: subject, empty_line: empty_line }
+        {
+          subject: subject,
+          empty_line: empty_line,
+          sha: commit.sha
+        }
       end
     end
+
+    def issue_warning(message, sha)
+      messaging.warn [message, sha].join("\n")
+    end
+
+    def issue_failure(message, sha)
+      messaging.fail [message, sha].join("\n")
+    end
   end
 end

data/lib/commit_lint/subject_words_check.rb

@@ -0,0 +1,19 @@
+module Danger
+  class DangerCommitLint < Plugin
+    class SubjectWordsCheck < CommitCheck # :nodoc:
+      MESSAGE = 'Please use more than one word.'.freeze
+
+      def self.type
+        :subject_words
+      end
+
+      def initialize(message)
+        @subject = message[:subject]
+      end
+
+      def fail?
+        @subject.split.count < 2
+      end
+    end
+  end
+end

data/lib/danger_plugin.rb

@@ -1,5 +1,6 @@
 require 'commit_lint/commit_check'
 require 'commit_lint/subject_cap_check'
+require 'commit_lint/subject_words_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

@@ -4,6 +4,7 @@ require File.expand_path('../spec_helper', __FILE__)
 
 TEST_MESSAGES = {
   subject_cap: 'this subject needs a capital',
+  subject_words: 'Fixed',
   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.",
@@ -28,10 +29,18 @@ module Danger
     end
 
     describe 'check without configuration' do
+      let(:sha) { '1234567' }
+      let(:commit) { double(:commit, message: message, sha: sha) }
+
+      def message_with_sha(message)
+        [message, sha].join "\n"
+      end
+
       context 'with invalid messages' do
         it 'fails those checks' do
           checks = {
             subject_cap: SubjectCapCheck::MESSAGE,
+            subject_words: SubjectWordsCheck::MESSAGE,
             subject_length: SubjectLengthCheck::MESSAGE,
             subject_period: SubjectPeriodCheck::MESSAGE,
             empty_line: EmptyLineCheck::MESSAGE
@@ -39,22 +48,25 @@ module Danger
 
           for (check, warning) in checks
             commit_lint = testing_dangerfile.commit_lint
-            commit = double(:commit, message: TEST_MESSAGES[check])
+            commit = double(:commit, message: TEST_MESSAGES[check], sha: sha)
             allow(commit_lint.git).to receive(:commits).and_return([commit])
 
             commit_lint.check
 
             status_report = commit_lint.status_report
             expect(report_counts(status_report)).to eq 1
-            expect(status_report[:errors]).to eq [warning]
+            expect(status_report[:errors]).to eq [
+              message_with_sha(warning)
+            ]
           end
         end
       end
 
       context 'with all errors' do
+        let(:message) { TEST_MESSAGES[:all_errors] }
+
         it 'fails every check' do
           commit_lint = testing_dangerfile.commit_lint
-          commit = double(:commit, message: TEST_MESSAGES[:all_errors])
           allow(commit_lint.git).to receive(:commits).and_return([commit])
 
           commit_lint.check
@@ -62,15 +74,17 @@ module Danger
           status_report = commit_lint.status_report
           expect(report_counts(status_report)).to eq 4
           expect(status_report[:errors]).to eq [
-            SubjectCapCheck::MESSAGE,
-            SubjectLengthCheck::MESSAGE,
-            SubjectPeriodCheck::MESSAGE,
-            EmptyLineCheck::MESSAGE
+            message_with_sha(SubjectCapCheck::MESSAGE),
+            message_with_sha(SubjectLengthCheck::MESSAGE),
+            message_with_sha(SubjectPeriodCheck::MESSAGE),
+            message_with_sha(EmptyLineCheck::MESSAGE)
           ]
         end
       end
 
       context 'with valid messages' do
+        let(:message) { TEST_MESSAGES[:valid] }
+
         it 'does nothing' do
           checks = {
             subject_length: SubjectLengthCheck::MESSAGE,
@@ -80,7 +94,6 @@ module Danger
 
           for _ in checks
             commit_lint = testing_dangerfile.commit_lint
-            commit = double(:commit, message: TEST_MESSAGES[:valid])
             allow(commit_lint.git).to receive(:commits).and_return([commit])
 
             commit_lint.check
@@ -93,6 +106,13 @@ module Danger
     end
 
     describe 'disable configuration' do
+      let(:sha) { '1234567' }
+      let(:commit) { double(:commit, message: message, sha: sha) }
+
+      def message_with_sha(message)
+        [message, sha].join "\n"
+      end
+
       context 'with individual checks' do
         context 'with invalid messages' do
           it 'does nothing' do
@@ -104,7 +124,7 @@ module Danger
 
             for (check, _) in checks
               commit_lint = testing_dangerfile.commit_lint
-              commit = double(:commit, message: TEST_MESSAGES[check])
+              commit = double(:commit, message: TEST_MESSAGES[check], sha: sha)
               allow(commit_lint.git).to receive(:commits).and_return([commit])
 
               commit_lint.check disable: [check]
@@ -117,13 +137,18 @@ module Danger
       end
 
       context 'with all checks, implicitly' do
+        let(:message) { TEST_MESSAGES[:all_errors] }
+
         it 'warns that nothing was checked' do
           commit_lint = testing_dangerfile.commit_lint
-          commit = double(:commit, message: TEST_MESSAGES[:all_errors])
           allow(commit_lint.git).to receive(:commits).and_return([commit])
 
           all_checks = [
-            :subject_cap, :subject_length, :subject_period, :empty_line
+            :subject_cap,
+            :subject_words,
+            :subject_length,
+            :subject_period,
+            :empty_line
           ]
           commit_lint.check disable: all_checks
 
@@ -134,9 +159,10 @@ module Danger
       end
 
       context 'with all checks, explicitly' do
+        let(:message) { TEST_MESSAGES[:all_errors] }
+
         it 'warns that nothing was checked' do
           commit_lint = testing_dangerfile.commit_lint
-          commit = double(:commit, message: TEST_MESSAGES[:all_errors])
           allow(commit_lint.git).to receive(:commits).and_return([commit])
 
           commit_lint.check disable: :all
@@ -149,6 +175,13 @@ module Danger
     end
 
     describe 'warn configuration' do
+      let(:sha) { '1234567' }
+      let(:commit) { double(:commit, message: message, sha: sha) }
+
+      def message_with_sha(message)
+        [message, sha].join "\n"
+      end
+
       context 'with individual checks' do
         context 'with invalid messages' do
           it 'warns instead of failing' do
@@ -160,19 +193,23 @@ module Danger
 
             for (check, warning) in checks
               commit_lint = testing_dangerfile.commit_lint
-              commit = double(:commit, message: TEST_MESSAGES[check])
+              commit = double(:commit, message: TEST_MESSAGES[check], sha: sha)
               allow(commit_lint.git).to receive(:commits).and_return([commit])
 
               commit_lint.check warn: [check]
 
               status_report = commit_lint.status_report
               expect(report_counts(status_report)).to eq 1
-              expect(status_report[:warnings]).to eq [warning]
+              expect(status_report[:warnings]).to eq [
+                message_with_sha(warning)
+              ]
             end
           end
         end
 
         context 'with valid messages' do
+          let(:message) { TEST_MESSAGES[:valid] }
+
           it 'does nothing' do
             checks = {
               subject_length: SubjectLengthCheck::MESSAGE,
@@ -182,7 +219,6 @@ module Danger
 
             for (check, _) in checks
               commit_lint = testing_dangerfile.commit_lint
-              commit = double(:commit, message: TEST_MESSAGES[:valid])
               allow(commit_lint.git).to receive(:commits).and_return([commit])
 
               commit_lint.check warn: [check]
@@ -196,9 +232,10 @@ module Danger
 
       context 'with all checks' do
         context 'with all errors' do
+          let(:message) { TEST_MESSAGES[:all_errors] }
+
           it 'warns instead of failing' do
             commit_lint = testing_dangerfile.commit_lint
-            commit = double(:commit, message: TEST_MESSAGES[:all_errors])
             allow(commit_lint.git).to receive(:commits).and_return([commit])
 
             commit_lint.check warn: :all
@@ -206,18 +243,19 @@ module Danger
             status_report = commit_lint.status_report
             expect(report_counts(status_report)).to eq 4
             expect(status_report[:warnings]).to eq [
-              SubjectCapCheck::MESSAGE,
-              SubjectLengthCheck::MESSAGE,
-              SubjectPeriodCheck::MESSAGE,
-              EmptyLineCheck::MESSAGE
+              message_with_sha(SubjectCapCheck::MESSAGE),
+              message_with_sha(SubjectLengthCheck::MESSAGE),
+              message_with_sha(SubjectPeriodCheck::MESSAGE),
+              message_with_sha(EmptyLineCheck::MESSAGE)
             ]
           end
         end
 
         context 'with a valid message' do
+          let(:message) { TEST_MESSAGES[:valid] }
+
           it 'does nothing' do
             commit_lint = testing_dangerfile.commit_lint
-            commit = double(:commit, message: TEST_MESSAGES[:valid])
             allow(commit_lint.git).to receive(:commits).and_return([commit])
 
             commit_lint.check warn: :all
@@ -230,6 +268,13 @@ module Danger
     end
 
     describe 'fail configuration' do
+      let(:sha) { '1234567' }
+      let(:commit) { double(:commit, message: message, sha: sha) }
+
+      def message_with_sha(message)
+        [message, sha].join "\n"
+      end
+
       context 'with individual checks' do
         context 'with invalid messages' do
           it 'fails those checks' do
@@ -241,19 +286,23 @@ module Danger
 
             for (check, warning) in checks
               commit_lint = testing_dangerfile.commit_lint
-              commit = double(:commit, message: TEST_MESSAGES[check])
+              commit = double(:commit, message: TEST_MESSAGES[check], sha: sha)
               allow(commit_lint.git).to receive(:commits).and_return([commit])
 
               commit_lint.check fail: [check]
 
               status_report = commit_lint.status_report
               expect(report_counts(status_report)).to eq 1
-              expect(status_report[:errors]).to eq [warning]
+              expect(status_report[:errors]).to eq [
+                message_with_sha(warning)
+              ]
             end
           end
         end
 
         context 'with valid messages' do
+          let(:message) { TEST_MESSAGES[:valid] }
+
           it 'does nothing' do
             checks = {
               subject_length: SubjectLengthCheck::MESSAGE,
@@ -263,7 +312,6 @@ module Danger
 
             for (check, _) in checks
               commit_lint = testing_dangerfile.commit_lint
-              commit = double(:commit, message: TEST_MESSAGES[:valid])
               allow(commit_lint.git).to receive(:commits).and_return([commit])
 
               commit_lint.check fail: [check]
@@ -277,9 +325,10 @@ module Danger
 
       context 'with all checks' do
         context 'with all errors' do
+          let(:message) { TEST_MESSAGES[:all_errors] }
+
           it 'fails those checks' do
             commit_lint = testing_dangerfile.commit_lint
-            commit = double(:commit, message: TEST_MESSAGES[:all_errors])
             allow(commit_lint.git).to receive(:commits).and_return([commit])
 
             commit_lint.check fail: :all
@@ -287,18 +336,19 @@ module Danger
             status_report = commit_lint.status_report
             expect(report_counts(status_report)).to eq 4
             expect(status_report[:errors]).to eq [
-              SubjectCapCheck::MESSAGE,
-              SubjectLengthCheck::MESSAGE,
-              SubjectPeriodCheck::MESSAGE,
-              EmptyLineCheck::MESSAGE
+              message_with_sha(SubjectCapCheck::MESSAGE),
+              message_with_sha(SubjectLengthCheck::MESSAGE),
+              message_with_sha(SubjectPeriodCheck::MESSAGE),
+              message_with_sha(EmptyLineCheck::MESSAGE)
             ]
           end
         end
 
         context 'with a valid message' do
+          let(:message) { TEST_MESSAGES[:valid] }
+
           it 'does nothing' do
             commit_lint = testing_dangerfile.commit_lint
-            commit = double(:commit, message: TEST_MESSAGES[:valid])
             allow(commit_lint.git).to receive(:commits).and_return([commit])
 
             commit_lint.check fail: :all

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-commit_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jon Allured
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-04 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -118,6 +118,8 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
+- Dangerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -130,6 +132,7 @@ files:
 - lib/commit_lint/subject_cap_check.rb
 - lib/commit_lint/subject_length_check.rb
 - lib/commit_lint/subject_period_check.rb
+- lib/commit_lint/subject_words_check.rb
 - lib/danger_commit_lint.rb
 - lib/danger_plugin.rb
 - spec/commit_lint_spec.rb
@@ -154,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Danger Plugin that ensure commit messages are not too long, don't end in