conventional-changelog 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2071ea87d3cc1351bb5af23371ce7ccf983095d0
-  data.tar.gz: 6c997b3a58da55c0ef8772a7432a7e476eb33a2a
+  metadata.gz: 470a4542202d03873d709b99b17756870ea1212b
+  data.tar.gz: f973c13c72acf9924f91744cc14bf45b587d2570
 SHA512:
-  metadata.gz: 8fc529d5b97c661e9bd46c87d656fe37924773990ae1237d0609537d00de1e884df01416932c46f4f18ab5e310c4c054df9fabd8fe685af2f607e4c8a3db4815
-  data.tar.gz: 666eed3f55e4d2f1933084913f198c0403a3727ba209909075d8a52231a2b107839b0079004321a65f34319203e67ba0560b2c4219340cdeb5cf20380cea9fce
+  metadata.gz: c182521b6cac8bc178533abf433e8a3865defeea93eea428c0aa4846ff1530a330b1b75e1f14e875a1bc58e0dd6aa9c12b85af0be1d02a0ecd39c680baefa2cb
+  data.tar.gz: bf95c198fe4ffaa162293ff636a56d688e834a4c149bbcd5f66da2b9c265b764ff649602f8cfb5210e982f1ec03d92d4e27c024bd87ed5898422e19d5c3a6e5b

data/conventional-changelog.gemspec

@@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", ">= 3.2"
   spec.add_development_dependency "fakefs"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.1"
 end

data/lib/conventional_changelog/by_date_writer.rb

@@ -6,7 +6,7 @@ module ConventionalChangelog
       :since_date
     end
 
-    def write_new_lines(options)
+    def build_new_lines(options)
       commits.group_by { |commit| commit[:date] }.sort.reverse_each do |date, commits|
         write_section commits, date
       end

data/lib/conventional_changelog/by_version_writer.rb

@@ -6,7 +6,7 @@ module ConventionalChangelog
       :since_version
     end
 
-    def write_new_lines(options)
+    def build_new_lines(options)
       write_section commits, options[:version]
     end
 

data/lib/conventional_changelog/git.rb

@@ -1,3 +1,5 @@
+require 'open3'
+
 module ConventionalChangelog
   class Git
     DELIMITER = "/////"
@@ -11,7 +13,18 @@ module ConventionalChangelog
     end
 
     def self.log(options)
-      `git log --pretty=format:"%h#{DELIMITER}%ad#{DELIMITER}%s%x09" --date=short --grep="^(feat|fix)(\\(.*\\))?:" -E #{version_filter(options)}`
+      output, status = Open3.capture2(%Q{
+        git log \
+          --pretty=format:"%h#{DELIMITER}%ad#{DELIMITER}%s%x09" --date=short \
+          --grep="^(feat|fix)(\\(.*\\))?:" -E \
+          #{version_filter(options)}
+      })
+
+      if status.success?
+        output
+      else
+        raise "Can't load Git commits, check your arguments"
+      end
     end
 
     def self.version_filter(options)

data/lib/conventional_changelog/version.rb

@@ -1,3 +1,3 @@
 module ConventionalChangelog
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/conventional_changelog/writer.rb

@@ -1,13 +1,34 @@
+require 'stringio'
+
 module ConventionalChangelog
+
+  class LastReleaseNotFound < StandardError
+    MESSAGE = <<-EOM
+Could not determine last tag or release date from existing CHANGELOG.md.
+Please specify the last tag (eg. v1.2.3) or release date (eg. 2016-02-14)
+manually by setting the environment variable CONVENTIONAL_CHANGELOG_LAST_RELEASE
+and running the generate command again.
+    EOM
+
+    def initialize message = MESSAGE
+      super(message)
+    end
+  end
+
   class Writer < File
     def initialize(file_name)
-      @previous_body = File.open(file_name, "a+").read
-      super file_name, "w"
+      FileUtils.touch file_name
+      super file_name, 'r+'
+
+      @new_body = StringIO.new
+      @previous_body = read
     end
 
     def write!(options)
-      write_new_lines options
-      self.puts @previous_body
+      build_new_lines options
+      seek 0
+      write @new_body.string
+      write @previous_body
     end
 
     private
@@ -27,28 +48,39 @@ module ConventionalChangelog
 
     def append_changes(commits, type, title)
       unless (type_commits = commits.select { |commit| commit[:type] == type }).empty?
-        puts "#### #{title}", ""
+        @new_body.puts "#### #{title}", ""
         type_commits.group_by { |commit| commit[:component] }.each do |component, component_commits|
-          puts "* **#{component}**" if component
+          @new_body.puts "* **#{component}**" if component
           component_commits.each { |commit| write_commit commit, component }
-          puts ""
+          @new_body.puts ""
         end
-        puts ""
+        @new_body.puts ""
       end
     end
 
     def write_commit(commit, componentized)
-      puts "#{componentized ? '  ' : ''}* #{commit[:change]} ([#{commit[:id]}](/../../commit/#{commit[:id]}))"
+      @new_body.puts "#{componentized ? '  ' : ''}* #{commit[:change]} ([#{commit[:id]}](/../../commit/#{commit[:id]}))"
     end
 
     def write_section(commits, id)
-      puts version_header(id)
+      return if commits.empty?
+
+      @new_body.puts version_header(id)
       append_changes commits, "feat", "Features"
       append_changes commits, "fix", "Bug Fixes"
     end
 
     def last_id
-      @previous_body.to_s == "" ? nil : @previous_body.split("\n")[0].to_s.match(/"(.*)"/)[1]
+      return nil if @previous_body.to_s.length == 0
+      matches = @previous_body.split("\n")[0].to_s.match(/"(.*)"/)
+
+      if matches
+        matches[1]
+      elsif manually_set_id = ENV['CONVENTIONAL_CHANGELOG_LAST_RELEASE']
+        manually_set_id
+      else
+        raise LastReleaseNotFound.new
+      end
     end
   end
 end

data/spec/generator_spec.rb

@@ -21,7 +21,7 @@ describe ConventionalChangelog::Generator do
 
       it 'creates an empty changelog when no commits' do
         subject.generate!
-        expect(changelog).to eql "\n"
+        expect(changelog).to eql ""
       end
     end
 
@@ -50,7 +50,6 @@ describe ConventionalChangelog::Generator do
   * increase reports ranges ([4303fd4](/../../commit/4303fd4))
 
 
-
           BODY
           expect(changelog).to eql body
         end
@@ -106,7 +105,6 @@ describe ConventionalChangelog::Generator do
   * add page to manage users ([4303fd8](/../../commit/4303fd8))
 
 
-
           BODY
           expect(changelog).to eql body
         end
@@ -222,12 +220,47 @@ describe ConventionalChangelog::Generator do
 * fix annoying bug ([4303fd5](/../../commit/4303fd5))
 
 
-
           BODY
           expect(changelog).to eql body
         end
       end
 
     end
+
+    context "when the tag or date of the previous release cannot be determined from the existing CHANGELOG" do
+      context "when the CONVENTIONAL_CHANGELOG_LAST_RELEASE environment variable is not set" do
+        it "raises a helpful error" do
+          File.write("CHANGELOG.md", "original")
+          expect { subject.generate! version: "v2.0.0" }.to raise_error(ConventionalChangelog::LastReleaseNotFound, /Could not determine last tag or release date/)
+        end
+      end
+
+      context "when the CONVENTIONAL_CHANGELOG_LAST_RELEASE environment variable is set" do
+        before do
+          allow(ENV).to receive(:[]).with('CONVENTIONAL_CHANGELOG_LAST_RELEASE').and_return('v1.2.3')
+          allow(ConventionalChangelog::Git).to receive(:log).and_return log
+        end
+
+        let(:log) { "4303fd4/////2015-03-30/////feat: increase reports ranges" }
+
+        it "uses the value of CONVENTIONAL_CHANGELOG_LAST_RELEASE as the last release id" do
+          File.write("CHANGELOG.md", "original")
+          expect(ConventionalChangelog::Git).to receive(:commits).with(since_version: 'v1.2.3').and_call_original
+          subject.generate! version: "v2.0.0"
+        end
+      end
+    end
+
+    context "when an error occurs generating the commit log" do
+      before do
+        allow_any_instance_of(ConventionalChangelog::Writer).to receive(:append_changes).and_raise("an error")
+      end
+
+      it "maintains the original content" do
+        File.write("CHANGELOG.md", '<a name="v1.0.0"></a>')
+        expect { subject.generate! version: "v2.0.0" }.to raise_error(RuntimeError)
+        expect(File.read("CHANGELOG.md")).to eq '<a name="v1.0.0"></a>'
+      end
+    end
   end
 end

data/spec/git_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe ConventionalChangelog::Git do
+  subject { ConventionalChangelog::Git }
+
+  describe ".log" do
+    it "returns a log with default options" do
+      log = subject.log({})
+
+      expect(log).to include "feat(bin): add a conventional-changelog binary"
+    end
+
+    it "raises an exception if Git returns an error" do
+      expect do
+        subject.log({ since_version: 'invalid-branch' })
+      end.to raise_exception RuntimeError, "Can't load Git commits, check your arguments"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conventional-changelog
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Diego Carrion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2017-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 description: ''
 email:
 - dc.rec1@gmail.com
@@ -107,6 +107,7 @@ files:
 - lib/conventional_changelog/writer.rb
 - spec/cli_spec.rb
 - spec/generator_spec.rb
+- spec/git_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/dcrec1/conventional-changelog-ruby
 licenses:
@@ -128,11 +129,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Ruby binary to generate a conventional changelog — Edit
 test_files:
 - spec/cli_spec.rb
 - spec/generator_spec.rb
+- spec/git_spec.rb
 - spec/spec_helper.rb
+has_rdoc: