danger-changelog 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d4fe77b8ef69e2c21ec85e896c0fcdb147360ee
-  data.tar.gz: 3fb652c91f7e792e0c5b9c66386ced70052fd9d5
+  metadata.gz: 62a09a0c16544a38bdb2f23068ddb753f1a24703
+  data.tar.gz: 077e72cdb5c66ce5d29643b032e06ba438547a16
 SHA512:
-  metadata.gz: e6d4bdd5279313f49fd325e74995e0dc38495685cd71fb39bdfe4b70de98a25a7c0038ea37d1ca4737c8ee6818551f1d8bca06069f5d092e7405afaf30d99227
-  data.tar.gz: 429d0875a41ad68e6dfcc289ac9c98031f6c0104f49ac1e2238798e9e554284641a2d4b9f31cc35c480f6af133c81edf6bdf28686dba378b7ac11c7b81d704f2
+  metadata.gz: 414bd4bb565ccf6600026349257d196535085eaa323720684c829096a1ee212bb4ca85c929f7260ddf040154dc5535aee90a9da9399b8a66cde9d4bd14d333f6
+  data.tar.gz: 434139ee0112b04ff2696113f71750f116010a7d29b70b72ae0217399fb063b659f2f2156300e2cd1c8abf8170bd7becaa3c97bf2919e993d2a301fa0a717085

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Changelog
 
+### 0.2.1 (12/04/2016)
+
+* [#17](https://github.com/dblock/danger-changelog/pull/17): Fix: handle CHANGELOG lines that mistakenly start with a symbol other than * - [@antondomashnev](https://github.com/antondomashnev).
+* [#19](https://github.com/dblock/danger-changelog/pull/19): Added: RELEASING.md document to formalize the process - [@antondomashnev](https://github.com/antondomashnev).
+* [#20](https://github.com/dblock/danger-changelog/pull/20): Fix: flag extra period and column in CHANGELOG - [@antondomashnev](https://github.com/antondomashnev).
+
 ### 0.2.0 (11/21/2016)
 
 * [#13](https://github.com/dblock/danger-changelog/pull/13): Fix: suggested CHANGELOG entry may not be of correct format - [@dblock](https://github.com/dblock).

data/RELEASING.md

@@ -0,0 +1,67 @@
+# Releasing Danger-Changelog
+
+There're no hard rules about when to release danger-changelog. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Install bundle, run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/danger-changelog) for all supported platforms.
+
+Increment the version, modify [lib/changelog/gem_version.rb](lib/changelog/gem_version.rb).
+
+Following the [Semantic Versioning](http://semver.org/):
+*  Increment the third number if the release has bug fixes and/or very minor features with backward compatibility, only (eg. change `0.2.1` to `0.2.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.2.1` to `0.3.0`).
+
+Create a new version and mark it as Next in [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.2.2 (12/03/2016)
+```
+
+Remove the line with "* Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/changelog/gem_version.rb
+git commit -m "Preparing for release 0.2.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+danger-changelog 0.2.2 built to pkg/danger-changelog-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed danger-changelog 0.2.2 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.2.3 (Next)
+
+* Your contribution here.
+```
+
+Increment the third version number in [lib/changelog/gem_version.rb](lib/changelog/gem_version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/slack/version.rb
+git commit -m "Preparing for next development iteration, 0.2.3."
+git push origin master
+```

data/lib/changelog/changelog_file.rb

@@ -38,15 +38,20 @@ module Danger
         @your_contribution_here = false
         @bad_lines = []
         File.open(filename).each_line do |line|
-          # ignore lines that aren't changes
-          next unless line[0] == '*'
+          next if line.strip.empty?
+
+          changelog_line = ChangelogLineParser.parse(line)
+
+          if changelog_line.nil? || changelog_line.invalid?
+            @bad_lines << line
+            next
+          end
+
           # notice your contribution here
-          if line == "* Your contribution here.\n"
+          if changelog_line.is_a?(ChangelogPlaceholderLine)
             @your_contribution_here = true
             next
           end
-          next if Danger::Changelog::ChangelogLine.valid?(line)
-          @bad_lines << line
         end
       end
     end

data/lib/changelog/changelog_line/changelog_entry_line.rb

@@ -0,0 +1,59 @@
+require 'changelog/changelog_line/changelog_line'
+
+module Danger
+  module Changelog
+    # A CHANGELOG.md line represents the change entry.
+    class ChangelogEntryLine < ChangelogLine
+      def valid?
+        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
+
+      def self.validates_as_changelog_line?(line)
+        matched_rules_count = 0
+        matched_rules_count += 1 if starts_with_star?(line)
+        matched_rules_count += 1 if with_pr_link?(line)
+        matched_rules_count += 1 if with_changelog_description?(line)
+        matched_rules_count += 1 if with_author_link?(line)
+        matched_rules_count >= 2
+      end
+
+      # provide an example of a CHANGELOG line based on a commit message
+      def self.example(github)
+        pr_number = github.pr_json['number']
+        pr_url = github.pr_json['html_url']
+        pr_title = github.pr_title
+                         .sub(/[?.!,;]?$/, '')
+                         .capitalize
+        pr_author = github.pr_author
+        pr_author_url = "https://github.com/#{github.pr_author}"
+        "* [##{pr_number}](#{pr_url}): #{pr_title} - [@#{pr_author}](#{pr_author_url})."
+      end
+
+      # checks whether line starts with *
+      def self.starts_with_star?(line)
+        return true if line =~ /^\*\s/
+        false
+      end
+
+      # checks whether line contains a MARKDOWN  link to a PR
+      def self.with_pr_link?(line)
+        return true if line =~ %r{\[\#\d+\]\(http[s]?:\/\/github\.com\/.*\d+[\/]?\)}
+        false
+      end
+
+      # checks whether line contains a capitalized Text, treated as a description
+      def self.with_changelog_description?(line)
+        return true if line =~ /[\`[:upper:]].*/
+        false
+      end
+
+      # checks whether line contains a MARKDOWN  link to an author
+      def self.with_author_link?(line)
+        return true if line =~ %r{\[\@[\w\d\-\_]+\]\(http[s]?:\/\/github\.com\/.*[\w\d\-\_]+[\/]?\)}
+        false
+      end
+    end
+  end
+end

data/lib/changelog/changelog_line/changelog_header_line.rb

@@ -0,0 +1,15 @@
+module Danger
+  module Changelog
+    # A CHANGELOG.md line represents the version header.
+    class ChangelogHeaderLine < ChangelogLine
+      def valid?
+        ChangelogHeaderLine.validates_as_changelog_line?(line)
+      end
+
+      def self.validates_as_changelog_line?(line)
+        return true if line =~ /^\#{1,4}\s.+/
+        false
+      end
+    end
+  end
+end

data/lib/changelog/changelog_line/changelog_line.rb

@@ -0,0 +1,27 @@
+module Danger
+  module Changelog
+    # An abstract CHANGELOG.md line.
+    class ChangelogLine
+      attr_accessor :line
+
+      def initialize(line)
+        self.line = line
+      end
+
+      # Match the line with the validation rules
+      def valid?
+        raise 'ChangelogLine subclass must implement the valid? method'
+      end
+
+      # Match the line with the validation rules opposite to valid?
+      def invalid?
+        !valid?
+      end
+
+      # Match the given line if it potentially represents the specific changelog line
+      def self.validates_as_changelog_line?(_line)
+        abort "You need to include a function for #{self} for validates_as_changelog_line?"
+      end
+    end
+  end
+end

data/lib/changelog/changelog_line/changelog_line_parser.rb

@@ -0,0 +1,26 @@
+require 'changelog/changelog_line/changelog_entry_line'
+require 'changelog/changelog_line/changelog_header_line'
+require 'changelog/changelog_line/changelog_placeholder_line'
+
+module Danger
+  module Changelog
+    # A parser of the CHANGELOG.md lines
+    class ChangelogLineParser
+      # Returns an instance of Changelog::ChangelogLine class based on the given line
+      def self.parse(line)
+        changelog_line_class = available_changelog_lines.find do |changelog_line|
+          changelog_line.validates_as_changelog_line?(line)
+        end
+        return nil unless changelog_line_class
+        changelog_line_class.new(line)
+      end
+
+      private_class_method
+
+      def self.available_changelog_lines
+        # Order is important
+        [ChangelogPlaceholderLine, ChangelogEntryLine, ChangelogHeaderLine]
+      end
+    end
+  end
+end

data/lib/changelog/changelog_line/changelog_placeholder_line.rb

@@ -0,0 +1,15 @@
+module Danger
+  module Changelog
+    # A CHANGELOG.md line represents the "Your contribution here".
+    class ChangelogPlaceholderLine < ChangelogLine
+      def valid?
+        ChangelogPlaceholderLine.validates_as_changelog_line?(line)
+      end
+
+      def self.validates_as_changelog_line?(line)
+        return true if line == "* Your contribution here.\n"
+        false
+      end
+    end
+  end
+end

data/lib/changelog/gem_version.rb

@@ -1,3 +1,3 @@
 module Changelog
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/lib/changelog/plugin.rb

@@ -48,7 +48,7 @@ module Danger
 Here's an example of a #{filename} entry:
 
 ```markdown
-#{Danger::Changelog::ChangelogLine.example(github)}
+#{Danger::Changelog::ChangelogEntryLine.example(github)}
 ```
 MARKDOWN
         warn "Unless you're refactoring existing code, please update #{filename}.", sticky: false

data/lib/danger_plugin.rb

@@ -1,3 +1,7 @@
-require 'changelog/changelog_line'
+require 'changelog/changelog_line/changelog_entry_line'
+require 'changelog/changelog_line/changelog_header_line'
+require 'changelog/changelog_line/changelog_line_parser'
+require 'changelog/changelog_line/changelog_placeholder_line'
+require 'changelog/changelog_line/changelog_line'
 require 'changelog/changelog_file'
 require 'changelog/plugin'

data/spec/changelog_entry_line_spec.rb

@@ -0,0 +1,168 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Danger::Changelog::ChangelogEntryLine do
+  context 'changelog line' do
+    it 'validates as changelog line' do
+      expect(described_class.validates_as_changelog_line?('* Valid without PR link - [@dblock](https://github.com/dblock).')).to be true
+      expect(described_class.validates_as_changelog_line?('* [#1](https://github.com/dblock/danger-changelog/pull/1): Valid with PR link - [@dblock](https://github.com/dblock).')).to be true
+      expect(described_class.validates_as_changelog_line?('Missing star - [@dblock](https://github.com/dblock).')).to be true
+      expect(described_class.validates_as_changelog_line?('* [#1](https://github.com/dblock/danger-changelog/pull/1) - Not a colon - [@dblock](https://github.com/dblock).')).to be true
+      expect(described_class.validates_as_changelog_line?('* [#1](https://github.com/dblock/danger-changelog/pull/1): No dash [@dblock](https://github.com/dblock).')).to be true
+      expect(described_class.validates_as_changelog_line?('* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)')).to be true
+      expect(described_class.validates_as_changelog_line?('* [#1](https://github.com/dblock/danger-changelog/pull/1): No name.')).to be true
+      expect(described_class.validates_as_changelog_line?('* [#1](https://github.com/dblock/danger-changelog/pull/1): No https in github - [@dblock](http://github.com/dblock).')).to be true
+      expect(described_class.validates_as_changelog_line?('* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra trailing slash - [@dblock](https://github.com/dblock/).')).to be true
+      expect(described_class.validates_as_changelog_line?('# [#1](https://github.com/dblock/danger-changelog/pull/1): Hash instead of star - [@dblock](https://github.com/dblock).')).to be true
+    end
+
+    it 'doesnt validate as changelog line' do
+      expect(described_class.validates_as_changelog_line?('Missing star, PR and author link.')).to be false
+      expect(described_class.validates_as_changelog_line?('* ')).to be false
+      expect(described_class.validates_as_changelog_line?('[@dblock](https://github.com/dblock).')).to be false
+      expect(described_class.validates_as_changelog_line?(' - [@dblock](https://github.com/dblock).')).to be false
+      expect(described_class.validates_as_changelog_line?('[#1](https://github.com/dblock/danger-changelog/pull/1).')).to be false
+      expect(described_class.validates_as_changelog_line?('[#1](https://github.com/dblock/danger-changelog/pull/1):  ')).to be false
+    end
+  end
+
+  context 'changelog entry line' do
+    context 'when without PR link' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* Valid without PR link - [@antondomashnev](https://github.com/antondomashnev).') }
+
+      it 'is valid' do
+        expect(subject.valid?).to be true
+      end
+    end
+
+    context 'when with PR link' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* [#1](https://github.com/dblock/danger-changelog/pull/1): Valid with PR link - [@dblock](https://github.com/dblock).') }
+
+      it 'is valid' do
+        expect(subject.valid?).to be true
+      end
+    end
+
+    context 'when missing star' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('Missing star - [@dblock](https://github.com/dblock).') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when not a colon' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* [#1](https://github.com/dblock/danger-changelog/pull/1) - Not a colon - [@dblock](https://github.com/dblock).') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when no dash' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* [#1](https://github.com/dblock/danger-changelog/pull/1): No dash [@dblock](https://github.com/dblock).') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when no final period' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when no name' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* [#1](https://github.com/dblock/danger-changelog/pull/1): No name.') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when no https in GitHub' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* [#1](https://github.com/dblock/danger-changelog/pull/1): No https in github - [@dblock](http://github.com/dblock).') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when extra trailing slash' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra trailing slash - [@dblock](https://github.com/dblock/).') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when extra period' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra period. - [@dblock](https://github.com/dblock).') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when extra colon' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra colon, - [@dblock](https://github.com/dblock).') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when extra hash' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* [#1](https://github.com/dblock/danger-changelog/pull/1): With # - [@dblock](https://github.com/dblock).') }
+
+      it 'is valid' do
+        expect(subject.valid?).to be true
+      end
+    end
+
+    context 'when with question mark' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('* [#1](https://github.com/dblock/danger-changelog/pull/1): With ? - [@dblock](https://github.com/dblock).') }
+
+      it 'is valid' do
+        expect(subject.valid?).to be true
+      end
+    end
+
+    context 'when hash instead of star' do
+      subject { Danger::Changelog::ChangelogEntryLine.new('# [#1](https://github.com/dblock/danger-changelog/pull/1): Hash instead of star - [@dblock](https://github.com/dblock).') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+  end
+
+  context 'example' do
+    let(:github) do
+      double(Danger::RequestSources::GitHub,
+             pr_json: { 'number' => 123, 'html_url' => 'https://github.com/dblock/danger-changelog/pull/123' },
+             pr_author: 'dblock',
+             pr_title: pr_title)
+    end
+    context 'no transformation required' do
+      let(:pr_title) { 'Test' }
+      it 'uses title as is' do
+        expect(described_class.example(github)).to eq '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).'
+      end
+    end
+    context 'with lowercase title' do
+      let(:pr_title) { 'test' }
+      it 'capitalizes it' do
+        expect(described_class.example(github)).to eq '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).'
+      end
+    end
+    context 'with a trailing period' do
+      let(:pr_title) { 'Test.' }
+      it 'removes it' do
+        expect(described_class.example(github)).to eq '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).'
+      end
+    end
+  end
+end

data/spec/changelog_file_spec.rb

@@ -42,13 +42,16 @@ describe Danger::Changelog::ChangelogFile do
   end
   context 'with bad lines' do
     let(:filename) { File.expand_path('../fixtures/changelogs/with_bad_lines.md', __FILE__) }
-    it 'is not valid' do
+    it 'is invalid' do
       expect(subject.bad_lines?).to be true
     end
     it 'reports all bad lines' do
       expect(subject.bad_lines).to eq [
+        "Missing star - [@dblock](https://github.com/dblock).\n",
         "* [#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"
+        "* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)\n",
+        "# [#1](https://github.com/dblock/danger-changelog/pull/1): Hash instead of star - [@dblock](https://github.com/dblock).\n",
+        "* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra period. - [@dblock](https://github.com/dblock).\n"
       ]
     end
     it 'has your contribution here' do

data/spec/changelog_header_line_spec.rb

@@ -0,0 +1,104 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Danger::Changelog::ChangelogHeaderLine do
+  context 'changelog line' do
+    it 'validates as changelog line' do
+      expect(described_class.validates_as_changelog_line?('# 1.0.1')).to be true
+      expect(described_class.validates_as_changelog_line?('## Version 1.0.1')).to be true
+      expect(described_class.validates_as_changelog_line?('### Lollypop')).to be true
+      expect(described_class.validates_as_changelog_line?('#### Four hashes is too much')).to be true
+    end
+
+    it 'doesnt validate as changelog line' do
+      expect(described_class.validates_as_changelog_line?('* Star is invalid.')).to be false
+      expect(described_class.validates_as_changelog_line?('It requires a hash symbol')).to be false
+      expect(described_class.validates_as_changelog_line?('1.1.1')).to be false
+      expect(described_class.validates_as_changelog_line?('Version 2.0.1')).to be false
+      expect(described_class.validates_as_changelog_line?('#')).to be false
+      expect(described_class.validates_as_changelog_line?('## ')).to be false
+      expect(described_class.validates_as_changelog_line?('##### I can not validate five')).to be false
+    end
+  end
+
+  context 'changelog header line' do
+    context 'when one hash symbol' do
+      subject { Danger::Changelog::ChangelogHeaderLine.new('# 1.0.1') }
+
+      it 'is valid' do
+        expect(subject.valid?).to be true
+      end
+    end
+
+    context 'when two hash symbols' do
+      subject { Danger::Changelog::ChangelogHeaderLine.new('## Version 1.0.1') }
+
+      it 'is valid' do
+        expect(subject.valid?).to be true
+      end
+    end
+
+    context 'when three hash symbols' do
+      subject { Danger::Changelog::ChangelogHeaderLine.new('### Lollypop') }
+
+      it 'is valid' do
+        expect(subject.valid?).to be true
+      end
+    end
+
+    context 'when four hash symbols' do
+      subject { Danger::Changelog::ChangelogHeaderLine.new('#### Four hashes is too much') }
+
+      it 'is valid' do
+        expect(subject.valid?).to be true
+      end
+    end
+
+    context 'when no hash symbol' do
+      subject { Danger::Changelog::ChangelogHeaderLine.new('* Star is invalid.') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when star instead of hash symbol' do
+      subject { Danger::Changelog::ChangelogHeaderLine.new('* Star is invalid.') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when no hash symbol' do
+      subject { Danger::Changelog::ChangelogHeaderLine.new('It requires hash symbol.') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when hash symbol without space' do
+      subject { Danger::Changelog::ChangelogHeaderLine.new('###Lollypop') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when hash symbol without header title' do
+      subject { Danger::Changelog::ChangelogHeaderLine.new('### ') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context 'when five hash symbols' do
+      subject { Danger::Changelog::ChangelogHeaderLine.new('##### Tooooo much') }
+
+      it 'is invalid' do
+        expect(subject.invalid?).to be true
+      end
+    end
+  end
+end

data/spec/changelog_line_parser_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Danger::Changelog::ChangelogLineParser do
+  context 'parse' do
+    context 'changelog entry line' do
+      context 'when valid' do
+        let(:line) { '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).' }
+        it 'returns ChangelogEntryLine' do
+          expect(described_class.parse(line)).to be_a(Danger::Changelog::ChangelogEntryLine)
+        end
+      end
+
+      context 'when invalid' do
+        it 'returns ChangelogEntryLine' do
+          expect(described_class.parse('Missing star - [@dblock](https://github.com/dblock).')).to be_a(Danger::Changelog::ChangelogEntryLine)
+          expect(described_class.parse('* [#1](https://github.com/dblock/danger-changelog/pull/1) - Not a colon - [@dblock](https://github.com/dblock).')).to be_a(Danger::Changelog::ChangelogEntryLine)
+          expect(described_class.parse('* [#1](https://github.com/dblock/danger-changelog/pull/1): No dash [@dblock](https://github.com/dblock).')).to be_a(Danger::Changelog::ChangelogEntryLine)
+          expect(described_class.parse('* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)')).to be_a(Danger::Changelog::ChangelogEntryLine)
+          expect(described_class.parse('* [#1](https://github.com/dblock/danger-changelog/pull/1): No name.')).to be_a(Danger::Changelog::ChangelogEntryLine)
+          expect(described_class.parse('* [#1](https://github.com/dblock/danger-changelog/pull/1): No https in github - [@dblock](http://github.com/dblock).')).to be_a(Danger::Changelog::ChangelogEntryLine)
+          expect(described_class.parse('* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra trailing slash - [@dblock](https://github.com/dblock/).')).to be_a(Danger::Changelog::ChangelogEntryLine)
+          expect(described_class.parse('# [#1](https://github.com/dblock/danger-changelog/pull/1): Hash instead of star - [@dblock](https://github.com/dblock).')).to be_a(Danger::Changelog::ChangelogEntryLine)
+        end
+      end
+    end
+
+    context 'changelog your contribution here line' do
+      let(:line) { "* Your contribution here.\n" }
+      it 'returns ChangelogPlaceholderLine' do
+        expect(described_class.parse(line)).to be_a(Danger::Changelog::ChangelogPlaceholderLine)
+      end
+    end
+
+    context 'changelog header line' do
+      context 'when one hash' do
+        let(:line) { '# Version 1.1.1' }
+        it 'returns ChangelogHeaderLine' do
+          expect(described_class.parse(line)).to be_a(Danger::Changelog::ChangelogHeaderLine)
+        end
+      end
+
+      context 'when two hashes' do
+        let(:line) { '## Version 1.1.1' }
+        it 'returns ChangelogHeaderLine' do
+          expect(described_class.parse(line)).to be_a(Danger::Changelog::ChangelogHeaderLine)
+        end
+      end
+
+      context 'when three hashes' do
+        let(:line) { '### Version 1.1.1' }
+        it 'returns ChangelogHeaderLine' do
+          expect(described_class.parse(line)).to be_a(Danger::Changelog::ChangelogHeaderLine)
+        end
+      end
+    end
+  end
+end

data/spec/changelog_placeholder_line_spec.rb

@@ -0,0 +1,58 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Danger::Changelog::ChangelogPlaceholderLine do
+  context 'changelog line' do
+    it 'validates as changelog line' do
+      expect(described_class.validates_as_changelog_line?("* Your contribution here.\n")).to be true
+    end
+
+    it 'doesnt validate as changelog line' do
+      expect(described_class.validates_as_changelog_line?('* Your contribution here.')).to be false
+      expect(described_class.validates_as_changelog_line?("* Your contribution here\n")).to be false
+      expect(described_class.validates_as_changelog_line?("* Put your contribution here.\n")).to be false
+      expect(described_class.validates_as_changelog_line?("Your contribution here.\n")).to be false
+    end
+
+    context 'changelog placeholder line' do
+      context 'when exactly expected string' do
+        subject { Danger::Changelog::ChangelogPlaceholderLine.new("* Your contribution here.\n") }
+
+        it 'is valid' do
+          expect(subject.valid?).to be true
+        end
+      end
+
+      context 'when without new line' do
+        subject { Danger::Changelog::ChangelogPlaceholderLine.new('* Your contribution here.') }
+
+        it 'is invalid' do
+          expect(subject.invalid?).to be true
+        end
+      end
+
+      context 'when no final period' do
+        subject { Danger::Changelog::ChangelogPlaceholderLine.new("* Your contribution here\n") }
+
+        it 'is invalid' do
+          expect(subject.invalid?).to be true
+        end
+      end
+
+      context 'when text doesnt match' do
+        subject { Danger::Changelog::ChangelogPlaceholderLine.new("* Put your contribution here.\n") }
+
+        it 'is invalid' do
+          expect(subject.invalid?).to be true
+        end
+      end
+
+      context 'when there is not star' do
+        subject { Danger::Changelog::ChangelogPlaceholderLine.new("Your contribution here.\n") }
+
+        it 'is invalid' do
+          expect(subject.invalid?).to be true
+        end
+      end
+    end
+  end
+end

data/spec/changelog_spec.rb

@@ -128,8 +128,11 @@ describe Danger::Changelog do
               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].map(&:message)).to eq [
+                "```markdown\nMissing star - [@dblock](https://github.com/dblock).\n```\n",
                 "```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"
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)\n```\n",
+                "```markdown\n# [#1](https://github.com/dblock/danger-changelog/pull/1): Hash instead of star - [@dblock](https://github.com/dblock).\n```\n",
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra period. - [@dblock](https://github.com/dblock).\n```\n"
               ]
             end
           end

data/spec/fixtures/changelogs/with_bad_lines.md

@@ -3,4 +3,6 @@
 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)
+# [#1](https://github.com/dblock/danger-changelog/pull/1): Hash instead of star - [@dblock](https://github.com/dblock).
+* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra period. - [@dblock](https://github.com/dblock).
 * Your contribution here.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-changelog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - dblock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-22 00:00:00.000000000 Z
+date: 2016-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -169,18 +169,26 @@ files:
 - Guardfile
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - Rakefile
 - danger-changelog.gemspec
 - images/have_you_updated_changelog.png
 - images/is_changelog_format_correct.png
 - lib/changelog/changelog_file.rb
-- lib/changelog/changelog_line.rb
+- lib/changelog/changelog_line/changelog_entry_line.rb
+- lib/changelog/changelog_line/changelog_header_line.rb
+- lib/changelog/changelog_line/changelog_line.rb
+- lib/changelog/changelog_line/changelog_line_parser.rb
+- lib/changelog/changelog_line/changelog_placeholder_line.rb
 - lib/changelog/gem_version.rb
 - lib/changelog/plugin.rb
 - lib/danger_changelog.rb
 - lib/danger_plugin.rb
+- spec/changelog_entry_line_spec.rb
 - spec/changelog_file_spec.rb
-- spec/changelog_line_spec.rb
+- spec/changelog_header_line_spec.rb
+- spec/changelog_line_parser_spec.rb
+- spec/changelog_placeholder_line_spec.rb
 - spec/changelog_spec.rb
 - spec/fixtures/changelogs/minimal.md
 - spec/fixtures/changelogs/missing_your_contribution_here.md
@@ -206,13 +214,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A danger.systems plugin that is OCD about your CHANGELOG.
 test_files:
+- spec/changelog_entry_line_spec.rb
 - spec/changelog_file_spec.rb
-- spec/changelog_line_spec.rb
+- spec/changelog_header_line_spec.rb
+- spec/changelog_line_parser_spec.rb
+- spec/changelog_placeholder_line_spec.rb
 - spec/changelog_spec.rb
 - spec/fixtures/changelogs/minimal.md
 - spec/fixtures/changelogs/missing_your_contribution_here.md

data/lib/changelog/changelog_line.rb

@@ -1,25 +0,0 @@
-module Danger
-  module Changelog
-    # A CHANGELOG.md file reader.
-    module ChangelogLine
-      # match the PR format, with or without PR number
-      def self.valid?(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
-
-      # provide an example of a CHANGELOG line based on a commit message
-      def self.example(github)
-        pr_number = github.pr_json['number']
-        pr_url = github.pr_json['html_url']
-        pr_title = github.pr_title
-                         .sub(/[?.!,;]?$/, '')
-                         .capitalize
-        pr_author = github.pr_author
-        pr_author_url = "https://github.com/#{github.pr_author}"
-        "* [##{pr_number}](#{pr_url}): #{pr_title} - [@#{pr_author}](#{pr_author_url})."
-      end
-    end
-  end
-end

data/spec/changelog_line_spec.rb

@@ -1,45 +0,0 @@
-require File.expand_path('../spec_helper', __FILE__)
-
-describe Danger::Changelog::ChangelogLine do
-  context 'lines' do
-    it 'valid lines' do
-      expect(subject.valid?('* Reticluated spline - [@dblock](https://github.com/dblock).')).to be true
-      expect(subject.valid?('* [#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.valid?('Missing star - [@dblock](https://github.com/dblock).')).to be false
-      expect(subject.valid?('* [#1](https://github.com/dblock/danger-changelog/pull/1) - Not a colon - [@dblock](https://github.com/dblock).')).to be false
-      expect(subject.valid?('* [#1](https://github.com/dblock/danger-changelog/pull/1): No dash [@dblock](https://github.com/dblock).')).to be false
-      expect(subject.valid?('* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)')).to be false
-      expect(subject.valid?('* [#1](https://github.com/dblock/danger-changelog/pull/1): No name.')).to be false
-      expect(subject.valid?('* [#1](https://github.com/dblock/danger-changelog/pull/1): No https in github - [@dblock](http://github.com/dblock).')).to be false
-      expect(subject.valid?('* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra trailing slash - [@dblock](https://github.com/dblock/).')).to be false
-    end
-  end
-  context 'example' do
-    let(:github) do
-      double(Danger::RequestSources::GitHub,
-             pr_json: { 'number' => 123, 'html_url' => 'https://github.com/dblock/danger-changelog/pull/123' },
-             pr_author: 'dblock',
-             pr_title: pr_title)
-    end
-    context 'no transformation required' do
-      let(:pr_title) { 'Test' }
-      it 'uses title as is' do
-        expect(subject.example(github)).to eq '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).'
-      end
-    end
-    context 'with lowercase title' do
-      let(:pr_title) { 'test' }
-      it 'capitalizes it' do
-        expect(subject.example(github)).to eq '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).'
-      end
-    end
-    context 'with a trailing period' do
-      let(:pr_title) { 'Test.' }
-      it 'removes it' do
-        expect(subject.example(github)).to eq '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).'
-      end
-    end
-  end
-end