danger-changelog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8593deb38bfbe15247c55c9b28f149248f7c4d7
+  data.tar.gz: 8905154e4f917190f212f83b312394905024cabc
+SHA512:
+  metadata.gz: e94967c180e24f33d89c908633d67de0df70e433696a3856a9c4c93b8e79b9a59a5c90ef33a3c64cc727a0184b179d782db16d6a01fd65295f29670f929393af
+  data.tar.gz: a2ea235027bc568fc141ddd6e0e391688d96437ed090f4164c7211bedfa334c6eacb2d73da7bd0e554fad2d8dd009b9bda29e2990e8df5ee1fecc23ef83ca059

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+.idea/
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  Include:
+    - Rakefile
+  Exclude:
+    - vendor/**/*
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,44 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-08-26 16:59:39 -0400 using RuboCop version 0.42.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 18
+
+# Offense count: 26
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 240
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/changelog/plugin.rb'
+
+# Offense count: 3
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/changelog/changelog_file.rb'
+
+# Offense count: 2
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+Style/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/changelog/plugin.rb'

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.3.1
+
+before_script:
+    - bundle exec danger
+
+script:
+    - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## Changelog
+
+### 0.1.0 (8/26/2016)
+
+* [#2](https://github.com/dblock/danger-changelog/pull/2): Added `is_changelog_format_correct?` - [@dblock](https://github.com/dblock).
+* [#1](https://github.com/dblock/danger-changelog/pull/1): Added `have_you_updated_changelog?`, have you updated CHANGELOG.md? - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to Danger-Changelog
+
+This project is work of [many contributors](https://github.com/dblock/danger-changelog/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/dblock/danger-changelog/pulls), [propose features and discuss issues](https://github.com/dblock/danger-changelog/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+### Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/danger-changelog) and check out your copy.
+
+```
+git clone https://github.com/contributor/danger-changelog.git
+cd danger-changelog
+git remote add upstream https://github.com/dblock/danger-changelog.git
+```
+
+### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Contribute Code
+
+### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+
+Make sure that `bundle exec rake` completes without errors.
+
+### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
+
+Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
+
+### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+### Push
+
+```
+git push origin my-feature-branch
+```
+
+### Make a Pull Request
+
+Go to https://github.com/contributor/danger-changelog and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/danger-changelog/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Dangerfile

@@ -0,0 +1,3 @@
+# danger.systems
+
+changelog.check

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Daniel Doubrovkine <dblock@dblock.org>
+
+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,49 @@
+# danger-changelog
+
+A PR linter plugin to [danger.systems](http://danger.systems) that is OCD about your CHANGELOG format.
+
+[![Build Status](https://travis-ci.org/dblock/danger-changelog.svg?branch=master)](https://travis-ci.org/dblock/danger-changelog)
+
+## Installation
+
+Add `danger-changelog` to your Gemfile.
+
+```
+gem 'danger-changelog', '~> 0.1'
+```
+
+Add `changelog.check` to your Dangerfile. Make a pull request and see this plugin in action.
+
+## Usage
+
+Methods and attributes from this plugin are available in your `Dangerfile` under the `changelog` namespace.
+
+### changelog.filename
+
+Set the CHANGELOG file name, defaults to `CHANGELOG.md`.
+
+### changelog.check
+
+Run all checks with defaults.
+
+#### changelog.have_you_updated_changelog?
+
+Checks whether you have updated CHANGELOG.md.
+
+![](images/have_you_updated_changelog.png)
+
+#### changelog.is_changelog_format_correct?
+
+Checks whether the CHANGELOG format is correct.
+
+![](images/is_changelog_format_correct.png)
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## Copyright
+
+Copyright (c) Daniel Doubrovkine, 2016
+
+MIT License, see [LICENSE](LICENSE.txt) for details.

data/Rakefile

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

data/danger-changelog.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'changelog/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-changelog'
+  spec.version       = Changelog::VERSION
+  spec.authors       = ['dblock']
+  spec.email         = ['dblock@dblock.org']
+  spec.description   = 'A danger.systems plugin that is OCD about your CHANGELOG.'
+  spec.summary       = 'A danger.systems plugin that is OCD about your CHANGELOG.'
+  spec.homepage      = 'https://github.com/dblock/danger-changelog'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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-plugin-api', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  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 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'listen', '3.0.7'
+  spec.add_development_dependency 'pry'
+end

data/lib/changelog/changelog_file.rb

@@ -0,0 +1,61 @@
+module Danger
+  module Changelog
+    # A CHANGELOG.md file reader.
+    class ChangelogFile
+      attr_reader :filename, :bad_lines, :exists
+
+      def initialize(filename = 'CHANGELOG.md')
+        @filename = filename
+        @exists = File.exist?(filename)
+        parse if @exists
+      end
+
+      # Any bad_lines?
+      def bad_lines?
+        !!bad_lines && bad_lines.any?
+      end
+
+      def exists?
+        !!@exists
+      end
+
+      def your_contribution_here?
+        !!@your_contribution_here
+      end
+
+      def bad?
+        bad_lines? || !your_contribution_here?
+      end
+
+      def good?
+        !bad?
+      end
+
+      private
+
+      # Parse CHANGELOG file.
+      def parse
+        @your_contribution_here = false
+        @bad_lines = []
+        File.open(filename).each_line do |line|
+          # ignore lines that aren't changes
+          next unless line[0] == '*'
+          # notice your contribution here
+          if line == "* Your contribution here.\n"
+            @your_contribution_here = true
+            next
+          end
+          next if valid_line?(line)
+          @bad_lines << line
+        end
+      end
+
+      # match the PR format, with or without PR number
+      def valid_line?(line)
+        return true if line =~ %r{^\*\s[\`[:upper:]].* \- \[\@[\w\d\-\_]+\]\(https:\/\/github\.com\/.*[\w\d\-\_]+\)\.$}
+        return true if line =~ %r{^\*\s\[\#\d+\]\(https:\/\/github\.com\/.*\d+\)\: [\`[:upper:]].* \- \[\@[\w\d\-\_]+\]\(https:\/\/github\.com\/.*[\w\d\-\_]+\)\.$}
+        false
+      end
+    end
+  end
+end

data/lib/changelog/gem_version.rb

@@ -0,0 +1,3 @@
+module Changelog
+  VERSION = '0.1.0'.freeze
+end

data/lib/changelog/plugin.rb

@@ -0,0 +1,73 @@
+module Danger
+  # CHANGELOG OCD in your projects.
+  #
+  # @example Checking for everuthing
+  #
+  #          changelog.check
+  #
+  # @see  dblock/danger-changelog
+  # @tags changelog
+
+  class DangerChangelog < Plugin
+    # Sets the CHANGELOG file name.
+    # defaults to `CHANGELOG.md`.
+    #
+    # @return   [String]
+    attr_accessor :filename
+
+    def initialize(dangerfile)
+      @filename = 'CHANGELOG.md'
+      super
+    end
+
+    # Has the CHANGELOG file been modified?
+    # @return [boolean]
+    def changelog_changes?
+      git.modified_files.include?(filename) || git.added_files.include?(filename)
+    end
+
+    # Runs all checks.
+    # @return [void]
+    def check
+      have_you_updated_changelog?
+      is_changelog_format_correct?
+    end
+
+    # Have you updated CHANGELOG.md?
+    # @return [boolean]
+    def have_you_updated_changelog?
+      if changelog_changes?
+        true
+      else
+        markdown <<-MARKDOWN
+Here's an example of a #{filename} entry:
+
+```markdown
+* [##{github.pr_json[:number]}](#{github.pr_json[:html_url]}): #{github.pr_title} - [@#{github.pr_author}](https://github.com/#{github.pr_author}).
+```
+MARKDOWN
+        warn "Unless you're refactoring existing code, please update #{filename}.", sticky: false
+        false
+      end
+    end
+
+    # Is the CHANGELOG.md format correct?
+    def is_changelog_format_correct?
+      changelog_file = Danger::Changelog::ChangelogFile.new(filename)
+      if changelog_file.exists?
+        changelog_file.bad_lines.each do |line|
+          markdown <<-MARKDOWN
+```markdown
+#{line}```
+MARKDOWN
+        end
+        messaging.fail("One of the lines below found in #{filename} doesn't match the expected format. Please make it look like the other lines, pay attention to periods and spaces.", sticky: false) if changelog_file.bad_lines?
+        messaging.fail("Please put back the `* Your contribution here.` line into #{filename}.", sticky: false) unless changelog_file.your_contribution_here?
+        changelog_file.good?
+      else
+        messaging.fail('The #{filename} file does not exist.', sticky: false)
+        false
+      end
+    end
+  end
+end

data/lib/danger_changelog.rb

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

data/lib/danger_plugin.rb

@@ -0,0 +1,2 @@
+require 'changelog/changelog_file'
+require 'changelog/plugin'

data/spec/changelog_file_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Danger::Changelog::ChangelogFile do
+  let(:filename) { 'CHANGELOG.md' }
+  subject do
+    Danger::Changelog::ChangelogFile.new(filename)
+  end
+  context 'minimal example' do
+    let(:filename) { File.expand_path('../fixtures/changelogs/minimal.md', __FILE__) }
+    it 'exists?' do
+      expect(subject.exists?).to be true
+    end
+    it 'bad_lines?' do
+      expect(subject.bad_lines).to eq []
+      expect(subject.bad_lines?).to be false
+    end
+    it 'valid lines' do
+      expect(subject.send(:valid_line?, '* Reticluated spline - [@dblock](https://github.com/dblock).')).to be true
+      expect(subject.send(:valid_line?, '* [#1](https://github.com/dblock/danger-changelog/pull/1): Reticluated spline - [@dblock](https://github.com/dblock).')).to be true
+    end
+    it 'invalid lines' do
+      expect(subject.send(:valid_line?, 'Missing star - [@dblock](https://github.com/dblock).')).to be false
+      expect(subject.send(:valid_line?, '* [#1](https://github.com/dblock/danger-changelog/pull/1) - Not a colon - [@dblock](https://github.com/dblock).')).to be false
+      expect(subject.send(:valid_line?, '* [#1](https://github.com/dblock/danger-changelog/pull/1): No dash [@dblock](https://github.com/dblock).')).to be false
+      expect(subject.send(:valid_line?, '* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)')).to be false
+      expect(subject.send(:valid_line?, '* [#1](https://github.com/dblock/danger-changelog/pull/1): No name.')).to be false
+      expect(subject.send(:valid_line?, '* [#1](https://github.com/dblock/danger-changelog/pull/1): No https in github - [@dblock](http://github.com/dblock).')).to be false
+      expect(subject.send(:valid_line?, '* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra trailing slash - [@dblock](https://github.com/dblock/).')).to be false
+    end
+    it 'is valid' do
+      expect(subject.bad_lines?).to be false
+    end
+    it 'has your contribution here' do
+      expect(subject.your_contribution_here?).to be true
+    end
+  end
+  context 'missing your contribution here' do
+    let(:filename) { File.expand_path('../fixtures/changelogs/missing_your_contribution_here.md', __FILE__) }
+    it 'is valid' do
+      expect(subject.bad_lines?).to be false
+    end
+    it 'is missing your contribution here' do
+      expect(subject.your_contribution_here?).to be false
+    end
+  end
+  context 'does not exist' do
+    let(:filename) { 'whatever.md' }
+    it 'exists?' do
+      expect(subject.exists?).to be false
+    end
+    it 'bad_lines?' do
+      expect(subject.bad_lines).to be nil
+      expect(subject.bad_lines?).to be false
+    end
+  end
+  context 'with bad lines' do
+    let(:filename) { File.expand_path('../fixtures/changelogs/with_bad_lines.md', __FILE__) }
+    it 'is not valid' do
+      expect(subject.bad_lines?).to be true
+    end
+    it 'reports all bad lines' do
+      expect(subject.bad_lines).to eq [
+        "* [#1](https://github.com/dblock/danger-changelog/pull/1) - Not a colon - [@dblock](https://github.com/dblock).\n",
+        "* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)\n"
+      ]
+    end
+    it 'has your contribution here' do
+      expect(subject.your_contribution_here?).to be true
+    end
+  end
+end

data/spec/changelog_spec.rb

@@ -0,0 +1,132 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Danger::Changelog do
+  it 'is a Danger plugin' do
+    expect(Danger::DangerChangelog.new(nil)).to be_a Danger::Plugin
+  end
+
+  describe 'with Dangerfile' do
+    let(:filename) { File.expand_path('../fixtures/changelogs/minimal.md', __FILE__) }
+    let(:dangerfile) { testing_dangerfile }
+    let(:changelog) do
+      dangerfile.changelog.filename = filename
+      dangerfile.changelog
+    end
+    let(:status_report) { changelog.status_report }
+
+    describe 'in a PR' do
+      before do
+        # typical PR JSON looks like https://raw.githubusercontent.com/danger/danger/bffc246a11dac883d76fc6636319bd6c2acd58a3/spec/fixtures/pr_response.json
+        changelog.env.request_source.pr_json = {
+          number: 123,
+          title: 'being dangerous',
+          html_url: 'https://github.com/dblock/danger-changelog/pull/123',
+          user: {
+            login: 'dblock'
+          }
+        }
+      end
+
+      context 'have_you_updated_changelog?' do
+        subject do
+          changelog.have_you_updated_changelog?
+        end
+
+        context 'without CHANGELOG changes' do
+          before do
+            allow(changelog.git).to receive(:modified_files).and_return([])
+            allow(changelog.git).to receive(:added_files).and_return([])
+          end
+
+          it 'complains when no CHANGELOG can be found' do
+            expect(subject).to be false
+            expect(status_report[:errors]).to eq []
+            expect(status_report[:warnings]).to eq ["Unless you're refactoring existing code, please update #{filename}."]
+            expect(status_report[:markdowns]).to eq ["Here's an example of a #{filename} entry:\n\n```markdown\n* [#123](https://github.com/dblock/danger-changelog/pull/123): being dangerous - [@dblock](https://github.com/dblock).\n```\n"]
+          end
+        end
+
+        context 'with a new CHANGELOG' do
+          before do
+            allow(changelog.git).to receive(:modified_files).and_return([])
+            allow(changelog.git).to receive(:added_files).and_return([filename])
+          end
+
+          it 'has no complaints' do
+            expect(subject).to be true
+            expect(status_report[:errors]).to eq []
+            expect(status_report[:warnings]).to eq []
+            expect(status_report[:markdowns]).to eq []
+          end
+        end
+
+        context 'with CHANGELOG changes' do
+          before do
+            allow(changelog.git).to receive(:modified_files).and_return([filename])
+            allow(changelog.git).to receive(:added_files).and_return([])
+          end
+
+          it 'has no complaints' do
+            expect(subject).to be true
+            expect(status_report[:errors]).to eq []
+            expect(status_report[:warnings]).to eq []
+            expect(status_report[:markdowns]).to eq []
+          end
+        end
+      end
+
+      context 'is_changelog_format_correct?' do
+        subject do
+          changelog.is_changelog_format_correct?
+        end
+
+        context 'with CHANGELOG changes' do
+          before do
+            allow(changelog.git).to receive(:modified_files).and_return([filename])
+            allow(changelog.git).to receive(:added_files).and_return([])
+          end
+
+          it 'has no complaints' do
+            expect(subject).to be true
+            expect(status_report[:errors]).to eq []
+            expect(status_report[:warnings]).to eq []
+            expect(status_report[:markdowns]).to eq []
+          end
+
+          context 'missing your contribution here' do
+            let(:filename) { File.expand_path('../fixtures/changelogs/missing_your_contribution_here.md', __FILE__) }
+            it 'complains' do
+              expect(subject).to be false
+              expect(status_report[:errors]).to eq ["Please put back the `* Your contribution here.` line into #{filename}."]
+              expect(status_report[:warnings]).to eq []
+              expect(status_report[:markdowns]).to eq []
+            end
+          end
+
+          context 'minimal example' do
+            let(:filename) { File.expand_path('../fixtures/changelogs/minimal.md', __FILE__) }
+            it 'is ok' do
+              expect(subject).to be true
+              expect(status_report[:errors]).to eq []
+              expect(status_report[:warnings]).to eq []
+              expect(status_report[:markdowns]).to eq []
+            end
+          end
+
+          context 'with bad lines' do
+            let(:filename) { File.expand_path('../fixtures/changelogs/with_bad_lines.md', __FILE__) }
+            it 'complains' do
+              expect(subject).to be false
+              expect(status_report[:errors]).to eq ["One of the lines below found in #{filename} doesn't match the expected format. Please make it look like the other lines, pay attention to periods and spaces."]
+              expect(status_report[:warnings]).to eq []
+              expect(status_report[:markdowns]).to eq [
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1) - Not a colon - [@dblock](https://github.com/dblock).\n```\n",
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)\n```\n"
+              ]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/changelogs/minimal.md

@@ -0,0 +1,3 @@
+### Changelog
+
+* Your contribution here.

data/spec/fixtures/changelogs/missing_your_contribution_here.md

@@ -0,0 +1,2 @@
+### Changelog
+

data/spec/fixtures/changelogs/with_bad_lines.md

@@ -0,0 +1,6 @@
+### Changelog
+
+Missing star - [@dblock](https://github.com/dblock).
+* [#1](https://github.com/dblock/danger-changelog/pull/1) - Not a colon - [@dblock](https://github.com/dblock).
+* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)
+* Your contribution here.

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' => 'dblock/danger-changelog',
+    '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,217 @@
+--- !ruby/object:Gem::Specification
+name: danger-changelog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dblock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !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.systems plugin that is OCD about your CHANGELOG.
+email:
+- dblock@dblock.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Dangerfile
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-changelog.gemspec
+- images/have_you_updated_changelog.png
+- images/is_changelog_format_correct.png
+- lib/changelog/changelog_file.rb
+- lib/changelog/gem_version.rb
+- lib/changelog/plugin.rb
+- lib/danger_changelog.rb
+- lib/danger_plugin.rb
+- spec/changelog_file_spec.rb
+- spec/changelog_spec.rb
+- spec/fixtures/changelogs/minimal.md
+- spec/fixtures/changelogs/missing_your_contribution_here.md
+- spec/fixtures/changelogs/with_bad_lines.md
+- spec/spec_helper.rb
+homepage: https://github.com/dblock/danger-changelog
+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.4
+signing_key: 
+specification_version: 4
+summary: A danger.systems plugin that is OCD about your CHANGELOG.
+test_files:
+- spec/changelog_file_spec.rb
+- spec/changelog_spec.rb
+- spec/fixtures/changelogs/minimal.md
+- spec/fixtures/changelogs/missing_your_contribution_here.md
+- spec/fixtures/changelogs/with_bad_lines.md
+- spec/spec_helper.rb