danger-changelog 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8593deb38bfbe15247c55c9b28f149248f7c4d7
-  data.tar.gz: 8905154e4f917190f212f83b312394905024cabc
+  metadata.gz: 9d4fe77b8ef69e2c21ec85e896c0fcdb147360ee
+  data.tar.gz: 3fb652c91f7e792e0c5b9c66386ced70052fd9d5
 SHA512:
-  metadata.gz: e94967c180e24f33d89c908633d67de0df70e433696a3856a9c4c93b8e79b9a59a5c90ef33a3c64cc727a0184b179d782db16d6a01fd65295f29670f929393af
-  data.tar.gz: a2ea235027bc568fc141ddd6e0e391688d96437ed090f4164c7211bedfa334c6eacb2d73da7bd0e554fad2d8dd009b9bda29e2990e8df5ee1fecc23ef83ca059
+  metadata.gz: e6d4bdd5279313f49fd325e74995e0dc38495685cd71fb39bdfe4b70de98a25a7c0038ea37d1ca4737c8ee6818551f1d8bca06069f5d092e7405afaf30d99227
+  data.tar.gz: 429d0875a41ad68e6dfcc289ac9c98031f6c0104f49ac1e2238798e9e554284641a2d4b9f31cc35c480f6af133c81edf6bdf28686dba378b7ac11c7b81d704f2

data/.gitignore

@@ -2,3 +2,4 @@
 pkg
 .idea/
 Gemfile.lock
+.yardoc

data/.rubocop_todo.yml

@@ -1,20 +1,20 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-08-26 16:59:39 -0400 using RuboCop version 0.42.0.
+# on 2016-11-21 18:59:46 -0500 using RuboCop version 0.43.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
+# Offense count: 1
 Metrics/AbcSize:
-  Max: 18
+  Max: 19
 
-# Offense count: 26
+# Offense count: 40
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 240
+  Max: 254
 
 # Offense count: 3
 # Configuration parameters: CountComments.

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 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).
+* [#18](https://github.com/dblock/danger-changelog/pull/18): Fix: incorrect CHANGELOG filename reported when file doesn't exist - [@dblock](https://github.com/dblock).
+
 ### 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).

data/README.md

@@ -1,7 +1,9 @@
 # danger-changelog
 
-A PR linter plugin to [danger.systems](http://danger.systems) that is OCD about your CHANGELOG format.
+A pull request linter plugin to [danger.systems](http://danger.systems) that enforces CHANGELOG.md O.C.D. in your projects.
+This plugin can, for example, make sure the changes are attributes properly and that they are always terminated with a period.
 
+[![Gem Version](https://badge.fury.io/rb/danger-changelog.svg)](https://badge.fury.io/rb/danger-changelog)
 [![Build Status](https://travis-ci.org/dblock/danger-changelog.svg?branch=master)](https://travis-ci.org/dblock/danger-changelog)
 
 ## Installation

data/lib/changelog/changelog_file.rb

@@ -45,17 +45,10 @@ module Danger
             @your_contribution_here = true
             next
           end
-          next if valid_line?(line)
+          next if Danger::Changelog::ChangelogLine.valid?(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/changelog_line.rb

@@ -0,0 +1,25 @@
+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/lib/changelog/gem_version.rb

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

data/lib/changelog/plugin.rb

@@ -1,17 +1,22 @@
 module Danger
-  # CHANGELOG OCD in your projects.
+  # Enforce CHANGELOG.md O.C.D. in your projects.
   #
-  # @example Checking for everuthing
+  # This plugin can, for example, make sure the changes are attributes properly and that they are always terminated with a period.
+  #
+  # @example Run all checks on the default CHANGELOG.md.
   #
   #          changelog.check
   #
+  # @example Customize the CHANGELOG file name and remind the requester to update it when necessary.
+  #
+  #          changelog.filename = 'CHANGES.md'
+  #          changelog.have_you_updated_changelog?
+  #
   # @see  dblock/danger-changelog
   # @tags changelog
 
   class DangerChangelog < Plugin
-    # Sets the CHANGELOG file name.
-    # defaults to `CHANGELOG.md`.
-    #
+    # The changelog file name, defaults to `CHANGELOG.md`.
     # @return   [String]
     attr_accessor :filename
 
@@ -20,19 +25,19 @@ module Danger
       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.
+    # Run all checks.
     # @return [void]
     def check
       have_you_updated_changelog?
       is_changelog_format_correct?
     end
 
+    # Has the CHANGELOG file been modified?
+    # @return [boolean]
+    def changelog_changes?
+      git.modified_files.include?(filename) || git.added_files.include?(filename)
+    end
+
     # Have you updated CHANGELOG.md?
     # @return [boolean]
     def have_you_updated_changelog?
@@ -43,7 +48,7 @@ module Danger
 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}).
+#{Danger::Changelog::ChangelogLine.example(github)}
 ```
 MARKDOWN
         warn "Unless you're refactoring existing code, please update #{filename}.", sticky: false
@@ -65,7 +70,7 @@ MARKDOWN
         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)
+        messaging.fail("The #{filename} file does not exist.", sticky: false)
         false
       end
     end

data/lib/danger_plugin.rb

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

data/spec/changelog_file_spec.rb

@@ -14,19 +14,6 @@ describe Danger::Changelog::ChangelogFile 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

data/spec/changelog_line_spec.rb

@@ -0,0 +1,45 @@
+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

data/spec/changelog_spec.rb

@@ -18,11 +18,11 @@ describe Danger::Changelog 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'
+          'number' => 123,
+          'title' => 'being dangerous',
+          'html_url' => 'https://github.com/dblock/danger-changelog/pull/123',
+          'user' => {
+            'login' => 'dblock'
           }
         }
       end
@@ -42,7 +42,7 @@ describe Danger::Changelog 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"]
+            expect(status_report[:markdowns].map(&:message)).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
 
@@ -80,6 +80,14 @@ describe Danger::Changelog do
           changelog.is_changelog_format_correct?
         end
 
+        context 'without a CHANGELOG file' do
+          let(:filename) { 'does-not-exist' }
+          it 'complains' do
+            expect(subject).to be false
+            expect(status_report[:errors]).to eq ['The does-not-exist file does not exist.']
+          end
+        end
+
         context 'with CHANGELOG changes' do
           before do
             allow(changelog.git).to receive(:modified_files).and_return([filename])
@@ -119,7 +127,7 @@ describe Danger::Changelog 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 [
+              expect(status_report[:markdowns].map(&:message)).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"
               ]

data/spec/spec_helper.rb

@@ -9,7 +9,6 @@ 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
@@ -18,30 +17,10 @@ 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
+  Cork::Board.new(silent: true)
 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',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-changelog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - dblock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-26 00:00:00.000000000 Z
+date: 2016-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -174,11 +174,13 @@ files:
 - images/have_you_updated_changelog.png
 - images/is_changelog_format_correct.png
 - lib/changelog/changelog_file.rb
+- lib/changelog/changelog_line.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_line_spec.rb
 - spec/changelog_spec.rb
 - spec/fixtures/changelogs/minimal.md
 - spec/fixtures/changelogs/missing_your_contribution_here.md
@@ -204,12 +206,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.7
 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_line_spec.rb
 - spec/changelog_spec.rb
 - spec/fixtures/changelogs/minimal.md
 - spec/fixtures/changelogs/missing_your_contribution_here.md