danger-angular_commit_lint 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46083aa58df72d5db5092ae3931c4d6bc24dd636
+  data.tar.gz: 63b89ddf9d205244bb827fd3090841c9cb76a1e7
+SHA512:
+  metadata.gz: d6db00e4c6d3dcd8d1f94ce79949694b89fa6dbdb0b487a98688b16d5de10ceb4d32e3cafbfe61b064aa55206963eb754fdf71d343408037d9e704d08865a4bf
+  data.tar.gz: 78c229490854e122f7cef0d77c8c59199af73353d0403da58a9e4ff6ba1d28f5751b2b6a07141658132537ea7cfd012199ace903a4df55c0ae34990e782f628e

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+pkg
+.idea/
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.yardoc/

data/.rubocop.yml

@@ -0,0 +1,9 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/For:
+  EnforcedStyle: for
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.2
+  - 2.3.3
+  - 2.4.0
+  - jruby-9
+
+script:
+  - bundle exec rake
+  - bundle exec danger

data/CHANGELOG.md

@@ -0,0 +1,86 @@
+# 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.6...master
+
+## [0.0.6] - 2017-04-27
+
+### Changed
+
+* Upgrade to newest Danger [480a4e6][480a4e6]
+
+[0.0.6]: https://github.com/jonallured/danger-commit_lint/compare/v0.0.5...v0.0.6
+[480a4e6]: https://github.com/jonallured/danger-commit_lint/commit/480a4e6
+
+## [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...v0.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 @@
+angular_commit_lint.check

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-angular_commit_lint.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Jon Allured <jon.allured@gmail.com>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# AngularJS Format Commit Lint for Danger
+
+[![Build Status](https://travis-ci.org/jonallured/danger-angular_commit_lint.svg?branch=master)](https://travis-ci.org/simeonc/danger-angular_commit_lint)
+
+This is a [Danger Plugin][danger] that ensures nice and tidy commit messages. It is based off [https://github.com/jnallured/danger-commit_lint].
+The checks performed on each commit message are inspired by [Angular Commit Format][angular] in use by [standard-version][standard].
+
+[danger]: http://danger.systems/plugins
+[angular]: https://gist.github.com/stephenparish/9941e89d80e2bc58a153#allowed-type
+[standard]: https://github.com/conventional-changelog/standard-version
+
+## Installation
+
+```
+$ gem install danger-angular_commit_lint
+```
+
+## Usage
+
+Simply add this to your Dangerfile:
+
+```ruby
+angular_commit_lint.check
+```
+
+That will check each commit in the PR to ensure the following is true:
+
+* Commit subject follows the angular pattern of `<type>(<scope>): <subject>`
+* 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`)
+
+By default, Commit Lint fails, but you can configure this behavior.
+
+## Configuration
+
+Configuring Commit Lint is done by passing a hash. The three keys that can be
+passed are:
+
+* `disable`
+* `fail`
+* `warn`
+
+To each of these keys you can pass either the symbol `:all` or an array of
+checks. Here are some ways you could configure Commit Lint:
+
+```ruby
+# configure how you want your commits to be formatted
+angular_commit_lint.check {
+  commit_types => ['fix', 'feat'], # an array of types that are accepted, all others give an error
+  use_scope => true, # whether you use `(<scope>)` or not
+  require_scope => false, # if use_scope is true then this makes the scope optional if true
+  min_scope => 1 # minimum length of the `<scope>`
+}
+```
+
+```ruby
+# warn on all checks (instead of failing)
+angular_commit_lint.check warn: :all
+
+# disable the `subject_period` check
+angular_commit_lint.check disable: [:subject_period]
+```
+
+Remember, by default all checks are run and they will fail. Think of this as the
+default:
+
+```ruby
+angular_commit_lint.check fail: :all
+```
+
+Also note that there is one more way that Commit Lint can behave:
+
+```ruby
+angular_commit_lint.check disable: :all
+```
+
+This will actually throw a warning that Commit Lint isn't doing anything.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec, :rubocop, :spec_docs]
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.options = ['--display-cop-names']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-angular_commit_lint.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'angular_commit_lint/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-angular_commit_lint'
+  spec.version       = AngularCommitLint::VERSION
+  spec.authors       = ['Jon Allured', 'Simeon Cheeseman']
+  spec.email         = ['jon.allured@gmail.com']
+  spec.description   = 'A Danger Plugin that ensures nice and tidy commit messages.'
+  spec.summary       = "A Danger Plugin that ensure commit messages follow the angular commit pattern, are not too long, don't end in a period and have a line between subject and body"
+  spec.homepage      = 'https://github.com/simeonc/danger-angular_commit_lint'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'danger', '~> 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency "rubocop", "~> 0.41"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency 'pry'
+end

data/lib/angular_commit_lint/commit_check.rb

@@ -0,0 +1,15 @@
+module Danger
+  class DangerAngularCommitLint < Plugin
+    class CommitCheck # :nodoc:
+      def self.fail?(message, config)
+        new(message, config).fail?
+      end
+
+      def initialize(message, config = {}); end
+
+      def fail?
+        raise 'implement in subclass'
+      end
+    end
+  end
+end

data/lib/angular_commit_lint/empty_line_check.rb

@@ -0,0 +1,21 @@
+module Danger
+  class DangerAngularCommitLint < Plugin
+    class EmptyLineCheck < CommitCheck # :nodoc:
+      def message
+        'Please separate subject from body with newline.'.freeze
+      end
+
+      def self.type
+        :empty_line
+      end
+
+      def initialize(message, _config = {})
+        @empty_line = message[:empty_line]
+      end
+
+      def fail?
+        @empty_line && !@empty_line.empty?
+      end
+    end
+  end
+end

data/lib/angular_commit_lint/gem_version.rb

@@ -0,0 +1,3 @@
+module AngularCommitLint
+  VERSION = '1.1.2'.freeze
+end

data/lib/angular_commit_lint/plugin.rb

@@ -0,0 +1,152 @@
+module Danger
+  # Run each commit in the PR through a message linting.
+  #
+  #  Commit lint 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`)
+  #
+  #  By default, Commit Lint fails, but you can configure this behavior.
+  #
+  #
+  # @example Lint all commits using defaults
+  #
+  #          angular_commit_lint.check
+  #
+  # @example Warn instead of fail
+  #
+  #          angular_commit_lint.check warn: :all
+  #
+  # @example Disable a particular check
+  #
+  #          angular_commit_lint.check disable: [:subject_period]
+  #
+  # @see danger/danger
+  # @tags commit linting
+  #
+  class DangerAngularCommitLint < Plugin
+    NOOP_MESSAGE = 'All checks were disabled, nothing to do.'.freeze
+
+    # Checks the commits with whatever config the user passes.
+    #
+    # Passing in a hash which contain the following keys:
+    #
+    #  * `disable` - array of checks to skip
+    #  * `fail` - array of checks to fail on
+    #  * `warn` - array of checks to warn on
+    #
+    #  The current check types are:
+    #
+    #  * `subject_cap`
+    #  * `subject_word`
+    #  * `subject_length`
+    #  * `subject_period`
+    #  * `empty_line`
+    #
+    #  Note: you can pass :all instead of an array to target all checks.
+    #
+    # @param [Hash] config
+    #
+    # @return [void]
+    #
+    def check(config = {})
+      @config = config
+
+      if all_checks_disabled?
+        messaging.warn NOOP_MESSAGE
+      else
+        check_messages
+      end
+    end
+
+    private
+
+    def check_messages
+      for message in messages
+        check_warnings message
+        check_fails message
+      end
+    end
+
+    def check_warnings(message)
+      for klass in warning_checkers
+        klass_instance = klass.new(message, @config)
+        if klass_instance.fail?
+          issue_warning(klass_instance.message, message[:sha])
+        end
+      end
+    end
+
+    def check_fails(message)
+      for klass in failing_checkers
+        klass_instance = klass.new(message, @config)
+        if klass_instance.fail?
+          issue_failure(klass_instance.message, message[:sha])
+        end
+      end
+    end
+
+    def checkers
+      [
+        SubjectPatternCheck,
+        SubjectCapCheck,
+        SubjectWordsCheck,
+        SubjectLengthCheck,
+        SubjectPeriodCheck,
+        EmptyLineCheck
+      ]
+    end
+
+    def checks
+      checkers.map(&:type)
+    end
+
+    def enabled_checkers
+      checkers.reject { |klass| disabled_checks.include? klass.type }
+    end
+
+    def warning_checkers
+      enabled_checkers.select { |klass| warning_checks.include? klass.type }
+    end
+
+    def failing_checkers
+      enabled_checkers - warning_checkers
+    end
+
+    def all_checks_disabled?
+      @config[:disable] == :all || disabled_checks.count == checkers.count
+    end
+
+    def disabled_checks
+      @config[:disable] || []
+    end
+
+    def warning_checks
+      return checks if @config[:warn] == :all
+      @config[:warn] || []
+    end
+
+    def messages
+      git.commits.map do |commit|
+        (subject, empty_line) = commit.message.split("\n")
+        {
+          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/angular_commit_lint/subject_cap_check.rb

@@ -0,0 +1,23 @@
+require 'angular_commit_lint/subject_pattern_check'
+
+module Danger
+  class DangerAngularCommitLint < Plugin
+    class SubjectCapCheck < CommitCheck # :nodoc:
+      def message
+        'Please start subject with capital letter.'.freeze
+      end
+
+      def self.type
+        :subject_cap
+      end
+
+      def initialize(message, _config = {})
+        @first_character = extract_subject(message).split('').first
+      end
+
+      def fail?
+        @first_character != @first_character.upcase
+      end
+    end
+  end
+end

data/lib/angular_commit_lint/subject_length_check.rb

@@ -0,0 +1,23 @@
+require 'angular_commit_lint/subject_pattern_check'
+
+module Danger
+  class DangerAngularCommitLint < Plugin
+    class SubjectLengthCheck < CommitCheck # :nodoc:
+      def message
+        'Please limit commit subject line to 50 characters.'.freeze
+      end
+
+      def self.type
+        :subject_length
+      end
+
+      def initialize(message, _config = {})
+        @subject = extract_subject(message)
+      end
+
+      def fail?
+        @subject.length > 50
+      end
+    end
+  end
+end

data/lib/angular_commit_lint/subject_pattern_check.rb

@@ -0,0 +1,45 @@
+def extract_subject(message)
+  message[:subject].split(': ')[1] ||= message[:subject]
+end
+
+# rubocop:disable Metrics/LineLength
+
+module Danger
+  class DangerAngularCommitLint < Plugin
+    class SubjectPatternCheck < CommitCheck # :nodoc:
+      DEFAULT_TYPES = %w[fix feat docs style refactor test chore].freeze
+
+      def message
+        scope_option = @use_scope ? '(<scope>)' : ''
+        scope_required = ''
+        if @use_scope
+          scope_required = "\n<scope> must be at least #{@min_scope} characters#{@scope_required ? 'or ommitted' : ''}"
+        end
+        "Please follow the commit format `<type>#{scope_option}: <subject>`.#{scope_required}\n`<type>` must be one of #{@commit_types.join ', '}".freeze
+      end
+
+      def self.type
+        :subject_pattern
+      end
+
+      def initialize(message, config = {})
+        @commit_types = config.fetch(:commit_types, DEFAULT_TYPES)
+        @use_scope = config.fetch(:use_scope, true)
+        @min_scope = config.fetch(:min_scope, 1)
+        @require_scope = config.fetch(:require_scope, false)
+        scope_regex = ''
+        if @use_scope
+          scope_regex = "(\\([a-zA-Z0-9-]{#{@min_scope},}\\)|\\(\\)#{@require_scope ? '' : '|'})"
+        end
+        @regex_string = "^(#{@commit_types.join '|'})#{scope_regex}: .+$"
+        @subject = message[:subject]
+      end
+
+      def fail?
+        (@subject =~ Regexp.new(@regex_string)).nil?
+      end
+    end
+  end
+end
+
+# rubocop:enable Metrics/LineLength

data/lib/angular_commit_lint/subject_period_check.rb

@@ -0,0 +1,23 @@
+require 'angular_commit_lint/subject_pattern_check'
+
+module Danger
+  class DangerAngularCommitLint < Plugin
+    class SubjectPeriodCheck < CommitCheck # :nodoc:
+      def message
+        'Please remove period from end of commit subject line.'.freeze
+      end
+
+      def self.type
+        :subject_period
+      end
+
+      def initialize(message, _config = {})
+        @subject = extract_subject(message)
+      end
+
+      def fail?
+        @subject.split('').last == '.'
+      end
+    end
+  end
+end

data/lib/angular_commit_lint/subject_words_check.rb

@@ -0,0 +1,23 @@
+require 'angular_commit_lint/subject_pattern_check'
+
+module Danger
+  class DangerAngularCommitLint < Plugin
+    class SubjectWordsCheck < CommitCheck # :nodoc:
+      def message
+        'Please use more than one word.'.freeze
+      end
+
+      def self.type
+        :subject_words
+      end
+
+      def initialize(message, _config = {})
+        @subject = extract_subject(message)
+      end
+
+      def fail?
+        @subject.split.count < 2
+      end
+    end
+  end
+end

data/lib/danger_angular_commit_lint.rb

@@ -0,0 +1 @@
+require 'angular_commit_lint/gem_version'

data/lib/danger_plugin.rb

@@ -0,0 +1,8 @@
+require 'angular_commit_lint/commit_check'
+require 'angular_commit_lint/subject_pattern_check'
+require 'angular_commit_lint/subject_cap_check'
+require 'angular_commit_lint/subject_words_check'
+require 'angular_commit_lint/subject_length_check'
+require 'angular_commit_lint/subject_period_check'
+require 'angular_commit_lint/empty_line_check'
+require 'angular_commit_lint/plugin'

data/spec/commit_lint_spec.rb

@@ -0,0 +1,457 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+# rubocop:disable Metrics/LineLength
+
+TEST_MESSAGES = {
+  subject_pattern: 'This subject is an incorrect pattern',
+  subject_cap: 'fix(scope): this subject needs a capital',
+  subject_words: 'fix: Fixed',
+  subject_length: 'fix: This is a really long subject line and should result in an error',
+  subject_period: 'fix: This subject line ends in a period.',
+  empty_line: "fix: 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!",
+  valid:  "fix: This is a valid message\n\nYou can tell because it meets all the criteria and the linter does not complain."
+}.freeze
+
+BLANK_MESSAGE = {
+  subject: '',
+  empty_line: '',
+  sha: ''
+}.freeze
+
+def report_counts(status_report)
+  status_report.values.flatten.count
+end
+
+# rubocop:disable Metrics/ClassLength
+
+module Danger
+  class DangerAngularCommitLint
+    describe 'DangerAngularCommitLint' do
+      it 'should be a plugin' do
+        expect(Danger::DangerAngularCommitLint.new(nil)).to be_a Danger::Plugin
+      end
+    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_pattern: SubjectPatternCheck,
+            subject_cap: SubjectCapCheck,
+            subject_words: SubjectWordsCheck,
+            subject_length: SubjectLengthCheck,
+            subject_period: SubjectPeriodCheck,
+            empty_line: EmptyLineCheck
+          }
+
+          for (check, warning_class) in checks
+            angular_commit_lint = testing_dangerfile.angular_commit_lint
+            commit = double(:commit, message: TEST_MESSAGES[check], sha: sha)
+            allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+            angular_commit_lint.check
+
+            status_report = angular_commit_lint.status_report
+
+            expect(report_counts(status_report)).to eq(1), "No error for #{check}"
+            expect(status_report[:errors]).to eq [
+              message_with_sha(warning_class.new(BLANK_MESSAGE).message)
+            ]
+          end
+        end
+      end
+
+      context 'with all errors' do
+        let(:message) { TEST_MESSAGES[:all_errors] }
+
+        it 'fails every check' do
+          angular_commit_lint = testing_dangerfile.angular_commit_lint
+          allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+          angular_commit_lint.check
+
+          status_report = angular_commit_lint.status_report
+          expect(report_counts(status_report)).to eq 5
+          expect(status_report[:errors]).to eq [
+            message_with_sha(SubjectPatternCheck.new(BLANK_MESSAGE).message),
+            message_with_sha(SubjectCapCheck.new(BLANK_MESSAGE).message),
+            message_with_sha(SubjectLengthCheck.new(BLANK_MESSAGE).message),
+            message_with_sha(SubjectPeriodCheck.new(BLANK_MESSAGE).message),
+            message_with_sha(EmptyLineCheck.new(BLANK_MESSAGE).message)
+          ]
+        end
+      end
+
+      context 'with valid messages' do
+        let(:message) { TEST_MESSAGES[:valid] }
+
+        it 'does nothing' do
+          checks = {
+            subject_length: SubjectLengthCheck,
+            subject_period: SubjectPeriodCheck,
+            empty_line: EmptyLineCheck
+          }
+
+          for _ in checks
+            angular_commit_lint = testing_dangerfile.angular_commit_lint
+            allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+            angular_commit_lint.check
+
+            status_report = angular_commit_lint.status_report
+            expect(report_counts(status_report)).to eq 0
+          end
+        end
+      end
+    end
+
+    describe 'pattern configuration' do
+      let(:sha) { '1234567' }
+      let(:commit) { double(:commit, message: message, sha: sha) }
+
+      def message_with_sha(message)
+        [message, sha].join "\n"
+      end
+
+      it 'requires scope' do
+        angular_commit_lint = testing_dangerfile.angular_commit_lint
+        commit = double(:commit, message: "fix: This is not fixed\n", sha: sha)
+        allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+        config = { require_scope: true }
+        angular_commit_lint.check config
+
+        status_report = angular_commit_lint.status_report
+
+        expect(report_counts(status_report)).to eq 1
+        expect(status_report[:errors]).to eq [
+          message_with_sha(SubjectPatternCheck.new(BLANK_MESSAGE, config).message)
+        ]
+      end
+
+      it 'does not use scope' do
+        angular_commit_lint = testing_dangerfile.angular_commit_lint
+        commit = double(:commit, message: "fix(scope): This is not fixed\n", sha: sha)
+        allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+        config = { use_scope: false }
+        angular_commit_lint.check config
+
+        status_report = angular_commit_lint.status_report
+
+        expect(report_counts(status_report)).to eq 1
+        expect(status_report[:errors]).to eq [
+          message_with_sha(SubjectPatternCheck.new(BLANK_MESSAGE, config).message)
+        ]
+      end
+
+      it 'has minimum length' do
+        angular_commit_lint = testing_dangerfile.angular_commit_lint
+        commit = double(:commit, message: "fix(scope): This is not fixed\n", sha: sha)
+        allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+        config = {
+          min_scope: 8,
+          require_scope: true
+        }
+        angular_commit_lint.check config
+
+        status_report = angular_commit_lint.status_report
+
+        expect(report_counts(status_report)).to eq 1
+        expect(status_report[:errors]).to eq [
+          message_with_sha(SubjectPatternCheck.new(BLANK_MESSAGE, config).message)
+        ]
+      end
+
+      it 'restricts types' do
+        angular_commit_lint = testing_dangerfile.angular_commit_lint
+        commit = double(:commit, message: "chore: This is not valid\n", sha: sha)
+        allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+        config = { commit_types: ['fix'] }
+        angular_commit_lint.check config
+
+        status_report = angular_commit_lint.status_report
+
+        expect(report_counts(status_report)).to eq 1
+        expect(status_report[:errors]).to eq [
+          message_with_sha(SubjectPatternCheck.new(BLANK_MESSAGE, config).message)
+        ]
+      end
+    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
+            checks = {
+              subject_length: SubjectLengthCheck,
+              subject_period: SubjectPeriodCheck,
+              empty_line: EmptyLineCheck
+            }
+
+            for (check, _) in checks
+              angular_commit_lint = testing_dangerfile.angular_commit_lint
+              commit = double(:commit, message: TEST_MESSAGES[check], sha: sha)
+              allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+              angular_commit_lint.check disable: [check]
+
+              status_report = angular_commit_lint.status_report
+              expect(report_counts(status_report)).to eq 0
+            end
+          end
+        end
+      end
+
+      context 'with all checks, implicitly' do
+        let(:message) { TEST_MESSAGES[:all_errors] }
+
+        it 'warns that nothing was checked' do
+          angular_commit_lint = testing_dangerfile.angular_commit_lint
+          allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+          all_checks = %i[
+            subject_pattern
+            subject_cap
+            subject_words
+            subject_length
+            subject_period
+            empty_line
+          ]
+          angular_commit_lint.check disable: all_checks
+
+          status_report = angular_commit_lint.status_report
+          expect(report_counts(status_report)).to eq 1
+          expect(status_report[:warnings]).to eq [NOOP_MESSAGE]
+        end
+      end
+
+      context 'with all checks, explicitly' do
+        let(:message) { TEST_MESSAGES[:all_errors] }
+
+        it 'warns that nothing was checked' do
+          angular_commit_lint = testing_dangerfile.angular_commit_lint
+          allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+          angular_commit_lint.check disable: :all
+
+          status_report = angular_commit_lint.status_report
+          expect(report_counts(status_report)).to eq 1
+          expect(status_report[:warnings]).to eq [NOOP_MESSAGE]
+        end
+      end
+    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
+            checks = {
+              subject_length: SubjectLengthCheck,
+              subject_period: SubjectPeriodCheck,
+              empty_line: EmptyLineCheck
+            }
+
+            for (check, warning_class) in checks
+              angular_commit_lint = testing_dangerfile.angular_commit_lint
+              commit = double(:commit, message: TEST_MESSAGES[check], sha: sha)
+              allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+              config = { warn: [check] }
+              angular_commit_lint.check config
+
+              status_report = angular_commit_lint.status_report
+              expect(report_counts(status_report)).to eq 1
+              expect(status_report[:warnings]).to eq [
+                message_with_sha(warning_class.new(BLANK_MESSAGE, warn: [check]).message)
+              ]
+            end
+          end
+        end
+
+        context 'with valid messages' do
+          let(:message) { TEST_MESSAGES[:valid] }
+
+          it 'does nothing' do
+            checks = {
+              subject_length: SubjectLengthCheck,
+              subject_period: SubjectPeriodCheck,
+              empty_line: EmptyLineCheck
+            }
+
+            for (check, _) in checks
+              angular_commit_lint = testing_dangerfile.angular_commit_lint
+              allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+              angular_commit_lint.check warn: [check]
+
+              status_report = angular_commit_lint.status_report
+              expect(report_counts(status_report)).to eq 0
+            end
+          end
+        end
+      end
+
+      context 'with all checks' do
+        context 'with all errors' do
+          let(:message) { TEST_MESSAGES[:all_errors] }
+
+          it 'warns instead of failing' do
+            angular_commit_lint = testing_dangerfile.angular_commit_lint
+            allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+            config = { warn: :all }
+            angular_commit_lint.check config
+
+            status_report = angular_commit_lint.status_report
+            expect(report_counts(status_report)).to eq 5
+            expect(status_report[:warnings]).to eq [
+              message_with_sha(SubjectPatternCheck.new(BLANK_MESSAGE, config).message),
+              message_with_sha(SubjectCapCheck.new(BLANK_MESSAGE, config).message),
+              message_with_sha(SubjectLengthCheck.new(BLANK_MESSAGE, config).message),
+              message_with_sha(SubjectPeriodCheck.new(BLANK_MESSAGE, config).message),
+              message_with_sha(EmptyLineCheck.new(BLANK_MESSAGE, config).message)
+            ]
+          end
+        end
+
+        context 'with a valid message' do
+          let(:message) { TEST_MESSAGES[:valid] }
+
+          it 'does nothing' do
+            angular_commit_lint = testing_dangerfile.angular_commit_lint
+            allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+            angular_commit_lint.check warn: :all
+
+            status_report = angular_commit_lint.status_report
+            expect(report_counts(status_report)).to eq 0
+          end
+        end
+      end
+    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
+            checks = {
+              subject_length: SubjectLengthCheck,
+              subject_period: SubjectPeriodCheck,
+              empty_line: EmptyLineCheck
+            }
+
+            for (check, warning_class) in checks
+              angular_commit_lint = testing_dangerfile.angular_commit_lint
+              commit = double(:commit, message: TEST_MESSAGES[check], sha: sha)
+              allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+              config = { fail: [check] }
+              angular_commit_lint.check config
+
+              status_report = angular_commit_lint.status_report
+              expect(report_counts(status_report)).to eq 1
+              expect(status_report[:errors]).to eq [
+                message_with_sha(warning_class.new(BLANK_MESSAGE, config).message)
+              ]
+            end
+          end
+        end
+
+        context 'with valid messages' do
+          let(:message) { TEST_MESSAGES[:valid] }
+
+          it 'does nothing' do
+            checks = {
+              subject_length: SubjectLengthCheck,
+              subject_period: SubjectPeriodCheck,
+              empty_line: EmptyLineCheck
+            }
+
+            for (check, _) in checks
+              angular_commit_lint = testing_dangerfile.angular_commit_lint
+              allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+              angular_commit_lint.check fail: [check]
+
+              status_report = angular_commit_lint.status_report
+              expect(report_counts(status_report)).to eq 0
+            end
+          end
+        end
+      end
+
+      context 'with all checks' do
+        context 'with all errors' do
+          let(:message) { TEST_MESSAGES[:all_errors] }
+
+          it 'fails those checks' do
+            angular_commit_lint = testing_dangerfile.angular_commit_lint
+            allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+            config = { fail: :all }
+            angular_commit_lint.check config
+
+            status_report = angular_commit_lint.status_report
+            expect(report_counts(status_report)).to eq 5
+            expect(status_report[:errors]).to eq [
+              message_with_sha(SubjectPatternCheck.new(BLANK_MESSAGE, config).message),
+              message_with_sha(SubjectCapCheck.new(BLANK_MESSAGE, config).message),
+              message_with_sha(SubjectLengthCheck.new(BLANK_MESSAGE, config).message),
+              message_with_sha(SubjectPeriodCheck.new(BLANK_MESSAGE, config).message),
+              message_with_sha(EmptyLineCheck.new(BLANK_MESSAGE, config).message)
+            ]
+          end
+        end
+
+        context 'with a valid message' do
+          let(:message) { TEST_MESSAGES[:valid] }
+
+          it 'does nothing' do
+            angular_commit_lint = testing_dangerfile.angular_commit_lint
+            allow(angular_commit_lint.git).to receive(:commits).and_return([commit])
+
+            angular_commit_lint.check fail: :all
+
+            status_report = angular_commit_lint.status_report
+            expect(report_counts(status_report)).to eq 0
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Metrics/LineLength
+# rubocop:enable Metrics/ClassLength

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$LOAD_PATH.unshift((ROOT + 'lib').to_s)
+$LOAD_PATH.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'pry'
+
+require 'rspec'
+require 'danger'
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace 'bundler'
+  config.color = true
+  config.tty = true
+end
+
+require 'danger_plugin'
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, '')
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'artsy/eigen',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: danger-angular_commit_lint
+version: !ruby/object:Gem::Version
+  version: 1.1.2
+platform: ruby
+authors:
+- Jon Allured
+- Simeon Cheeseman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !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: A Danger Plugin that ensures nice and tidy commit messages.
+email:
+- jon.allured@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Dangerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-angular_commit_lint.gemspec
+- lib/angular_commit_lint/commit_check.rb
+- lib/angular_commit_lint/empty_line_check.rb
+- lib/angular_commit_lint/gem_version.rb
+- lib/angular_commit_lint/plugin.rb
+- lib/angular_commit_lint/subject_cap_check.rb
+- lib/angular_commit_lint/subject_length_check.rb
+- lib/angular_commit_lint/subject_pattern_check.rb
+- lib/angular_commit_lint/subject_period_check.rb
+- lib/angular_commit_lint/subject_words_check.rb
+- lib/danger_angular_commit_lint.rb
+- lib/danger_plugin.rb
+- spec/commit_lint_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/simeonc/danger-angular_commit_lint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Danger Plugin that ensure commit messages follow the angular commit pattern,
+  are not too long, don't end in a period and have a line between subject and body
+test_files:
+- spec/commit_lint_spec.rb
+- spec/spec_helper.rb