create_changelog 1.3.0 → 1.3.1

data/features/complete_changelog.feature~

@@ -0,0 +1,51 @@
+@announce
+Feature: Creating a complete, decorated changelog.
+
+Scenario: Repository with identical changelog lines only in commit messages
+	Given an empty Git repository
+	When 2 commits with standard changelog line are added
+	And I successfully run `ccl`
+	Then the stdout should contain 1 line starting with "- "
+
+Scenario: Repository with multiple changelog lines only in commit messages
+	Given an empty Git repository
+	When 3 commits with unique changelog line are added
+	And I successfully run `ccl`
+	Then the stdout should contain 3 lines starting with "- "
+
+Scenario: Changelog lines in commit messages and tag without changelog line
+	Given an empty Git repository
+	When 3 commits with unique changelog line are added
+	And a tag without changelog line is added
+	And I successfully run `ccl`
+	Then the stdout should contain 3 lines starting with "- "
+
+Scenario: Changelog lines in commit messages and tag with different changelog line
+	Given an empty Git repository
+	When 3 commits with unique changelog line are added
+	And a tag with unique changelog line is added
+	And I successfully run `ccl`
+	Then the stdout should contain 4 lines starting with "- "
+
+Scenario: Changelog lines in commit messages and tag with same changelog line
+	Given an empty Git repository
+	When 3 commits with standard changelog line are added
+	And a tag with standard changelog line is added
+	And I successfully run `ccl`
+	Then the stdout should contain 1 line starting with "- "
+
+Scenario: Unique changelog lines in commit messages, tag, and recent commits
+	Given an empty Git repository
+	When 3 commits with unique changelog line are added
+	And a tag with unique changelog line is added
+	And 2 commits with unique changelog line are added
+	And I successfully run `ccl`
+	Then the stdout should contain 6 lines starting with "- "
+
+Scenario: Same changelog lines in commit messages, tag, and recent commits
+	Given an empty Git repository
+	When 3 commits with standard changelog line are added
+	And a tag with standard changelog line is added
+	And 2 commits with standard changelog line are added
+	And I successfully run `ccl`
+	Then the stdout should contain 2 lines starting with "- "

data/features/create_changelog.feature~

@@ -0,0 +1,19 @@
+Feature: Creating a complete, decorated changelog
+
+Scenario: Repository with identical changelog lines only in commit messages
+	Given an empty Git repository
+	When 2 commits with identical changelog lines are added
+	And I successfully run `ccl`
+	Then the stdout should contain 1 line starting with "- "
+
+Scenario: Log lines only in commit messages, generate without recent
+	Given an empty Git repository
+	When 2 commits with identical changelog lines are added
+	When I successfully run `ccl --no-recent`
+	Then the stdout should not contain anything
+
+Scenario: Repository with multiple changelog lines only in commit messages
+	Given an empty Git repository
+	When 3 commits with unique changelog lines are added
+	And I successfully run `ccl`
+	Then the stdout should contain 3 line starting with "- "

data/features/decorate_output.feature

@@ -0,0 +1,30 @@
+@announce
+Feature: Output may be decorated
+
+Scenario: Creating complete changelog
+	Given an empty Git repository
+	When 2 commits with standard changelog line are added
+	And I successfully run `ccl`
+	Then the stdout should contain "====="
+	And the stdout should contain "* * *"
+
+Scenario: Creating changelog without recent changes
+	Given an empty Git repository
+	When 2 commits with standard changelog line are added
+	And I successfully run `ccl --no-recent`
+	Then the stdout should not contain anything
+
+Scenario: Creating changelog with recent changes only
+	Given an empty Git repository
+	When 2 commits with standard changelog line are added
+	And I successfully run `ccl --recent`
+	Then the stdout should not contain "====="
+	And the stdout should not contain "* * *"
+
+Scenario: Creating changelog with custom 'recent' heading
+	Given an empty Git repository
+	When 2 commits with standard changelog line are added
+	And I successfully run `ccl TEST_VERSION`
+	Then the stdout should contain "TEST_VERSION"
+	And the stdout should contain "====="
+	And the stdout should contain "* * *"

data/features/decorate_output.feature~

@@ -0,0 +1,30 @@
+@announce
+Feature: Output may be decorated
+
+Scenario: Creating complete changelog
+	Given an empty Git repository
+	When 2 commits with standard changelog line are added
+	And I successfully run `ccl`
+	Then the stdout should contain "====="
+	And the stdout should contain "* * *
+
+Scenario: Creating changelog without recent changes
+	Given an empty Git repository
+	When 2 commits with standard changelog line are added
+	And I successfully run `ccl --no-recent`
+	Then the stdout should not contain anything
+
+Scenario: Creating changelog with recent changes only
+	Given an empty Git repository
+	When 2 commits with standard changelog line are added
+	And I successfully run `ccl --recent`
+	Then the stdout should not contain "====="
+	And the stdout should not contain "* * *"
+
+Scenario: Creating changelog with custom 'recent' heading
+	Given an empty Git repository
+	When 2 commits with standard changelog line are added
+	And I successfully run `ccl TEST_VERSION`
+	Then the stdout should contain "TEST_VERSION"
+	And the stdout should contain "====="
+	And the stdout should contain "* * *"

data/features/prepare_release.feature~

@@ -0,0 +1,26 @@
+Feature: Prepare-release workflow
+
+        Scenario: Prepare-release fails if current branch is not release branch
+                Given an empty Git repository
+                When I run `ccl --prepare-release 1.0.0`
+                Then the exit status should not be 0
+
+        Scenario: Prepare-release requires tag name on the command line
+                Given an empty Git repository
+                And a new branch "release-1.0.0"
+                When I run `ccl --prepare-release`
+                Then the exit status should not be 0
+                And the stderr should contain "FATAL: Missing argument: TAG"
+
+        Scenario: Prepare-release aborts if annotation is empty
+                Given an empty Git repository
+                And a new branch "release-1.0.0"
+                When I run `ccl --prepare-release`
+                Then the stdout should contain "aborted"
+                And the current branch should be "release-1.0.0"
+
+        Scenario: Prepare-release checks out master branch and tags it
+                Given an empty Git repository
+                And a new branch "release-1.0.0"
+                When I run `ccl --prepare-release 1.0.0`
+

data/features/step_definitions/git_steps.rb

@@ -0,0 +1,61 @@
+require 'fileutils'
+require 'securerandom'
+
+Given /^an empty Git repository$/ do
+	in_current_dir do
+		`git init`
+	end
+end
+
+When(/^(\d+) commits with standard changelog line are added$/) do |n|
+	in_current_dir do
+		n.to_i.times do
+			alter_dummy_file
+			`git add -A`
+			`git commit -m 'heading' -m '#{standard_log_entry}'`
+		end
+	end
+end
+
+When(/^(\d+) commits with unique changelog line are added$/) do |n|
+	in_current_dir do
+		n.to_i.times do
+			alter_dummy_file
+			`git add -A`
+			`git commit -m 'heading' -m '#{random_log_entry}'`
+		end
+	end
+end
+
+When(/a tag without changelog line is added/) do
+	in_current_dir do
+		`git tag -a some-tag -m "Some tag"`
+	end
+end	
+
+When(/a tag with unique changelog line is added/) do
+	in_current_dir do
+		`git tag -a some-tag -m "Some tag" -m '#{random_log_entry}'`
+	end
+end
+
+When(/a tag with standard changelog line is added/) do
+	in_current_dir do
+		`git tag -a some-tag -m "Some tag" -m '#{standard_log_entry}'`
+	end
+end
+
+def alter_dummy_file
+	open 'dummy_file_for_commits.txt', 'a' do |f|
+		f.puts 'some text'
+	end
+end
+
+def standard_log_entry
+	"- INFO: This is a standard log entry for testing"
+end
+
+def random_log_entry
+	# ('a'..'z').to_a.shuffle[0,8].join
+	"- INFO: This is a unique log entry for testing - #{SecureRandom.hex}"
+end

data/features/step_definitions/git_steps.rb~

@@ -0,0 +1,74 @@
+require 'fileutils'
+require 'securerandom'
+require '../lib/git.rb'
+
+Given(/^an empty Git repository$/) do
+	in_current_dir do
+		`git init`
+	end
+end
+
+When(/^(\d+) commits with standard changelog line are added$/) do |n|
+	in_current_dir do
+		n.to_i.times do
+			alter_dummy_file
+			`git add -A`
+			`git commit -m 'heading' -m '#{standard_log_entry}'`
+		end
+	end
+end
+
+When(/^(\d+) commits with unique changelog line are added$/) do |n|
+	in_current_dir do
+		n.to_i.times do
+			alter_dummy_file
+			`git add -A`
+			`git commit -m 'heading' -m '#{random_log_entry}'`
+		end
+	end
+end
+
+When(/a tag without changelog line is added/) do
+	in_current_dir do
+		`git tag -a some-tag -m "Some tag"`
+	end
+end	
+
+When(/a tag with unique changelog line is added/) do
+	in_current_dir do
+		`git tag -a some-tag -m "Some tag" -m '#{random_log_entry}'`
+	end
+end
+
+When(/a tag with standard changelog line is added/) do
+	in_current_dir do
+		`git tag -a some-tag -m "Some tag" -m '#{standard_log_entry}'`
+	end
+end
+
+Given(/a new branch "([^"]+)"/) do |branch|
+  in_current_dir do
+    Git.new_branch branch
+  end
+end
+
+Then(/the current branch should be "([^"]+)"/) do |branch|
+  in_current_dir do
+    Git.current_branch == branch
+  end
+end
+
+def alter_dummy_file
+	open 'dummy_file_for_commits.txt', 'a' do |f|
+		f.puts 'some text'
+	end
+end
+
+def standard_log_entry
+	"- INFO: This is a standard log entry for testing"
+end
+
+def random_log_entry
+	# ('a'..'z').to_a.shuffle[0,8].join
+	"- INFO: This is a unique log entry for testing - #{SecureRandom.hex}"
+end

data/features/step_definitions/stdout_steps.rb

@@ -0,0 +1,7 @@
+Then(/^the stdout should contain 1 line starting with "([^"]*)"$/) do |s|
+	assert_lines_starting_with all_stdout, 1, s
+end
+
+Then(/^the stdout should contain (\d+) lines starting with "([^"]*)"$/) do |n, s|
+	assert_lines_starting_with all_stdout, n, s
+end

data/features/step_definitions/stdout_steps.rb~

@@ -0,0 +1,10 @@
+Then(/^the stdout should contain 1 line starting with "([^"]*)"$/) do |s|
+	expected = "(^#{s}.*\n){1}"
+	assert_matching_output(expected, all_output)
+end
+
+Then(/^the stdout should contain (\d+) lines starting with "([^"]*)"$/) do |n, s|
+	# expected = "(^#{s}.*\n){#{n}}"
+	# assert_matching_output(expected, all_output)
+	assert_lines_starting_with all_stdout, n, s
+end

data/features/support/assertions.rb

@@ -0,0 +1,7 @@
+# Checks whether a mult-line text contains a specific number
+# of lines that start with a given sequence.
+def assert_lines_starting_with(text, number, start_with)
+	number = number.to_i if number.is_a? String
+	count = text.split("\n").count { |line| line.start_with? start_with }
+	expect(count).to eq number
+end

data/features/support/assertions.rb~

@@ -0,0 +1,7 @@
+# Checks whether a mult-line text contains a specific number
+# of lines that start with a given sequence.
+def assert_lines_starting_with(text, number, start_with)
+	number = number.to_i if number.is_a(String)
+	count = text.split("\n").count { |line| line.start_with? start_with }
+	expect(count).to eq number
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/features/support/env.rb~

@@ -0,0 +1,6 @@
+require 'aruba/cucumber'
+
+Before do
+  set_env 'GIT_WORK_TREE', File.expand_path(current_dir)
+  set_env 'GIT_DIR', ".git"
+end

data/lib/array.rb~

@@ -0,0 +1,18 @@
+# Removes common indentation from an array of strings
+class Array
+	def remove_indent
+		lines_with_indent = self.select do |line|
+			line.size > 0
+		end
+		indents = lines_with_indent.map do |line|
+			match = line.match(/^( +)([^ ]|$)+/)
+			match ? match[1].size : 0
+		end
+		indent = indents.min
+		self.map do |line|
+			line[indent..-1]
+		end
+	end
+end
+
+# vim: nospell

data/lib/changelog.rb

@@ -93,7 +93,11 @@ class Changelog
 
 		# Combine changelog entries from tag annotation and commit messages
 		if tag.changelog
-			combined_changelog = tag.changelog.concat(commit_changelog.changelog)
+      if commit_changelog.changelog
+        combined_changelog = tag.changelog.concat(commit_changelog.changelog)
+      else
+        combined_changelog = tag.changelog
+      end
 		else
 			combined_changelog = commit_changelog.changelog
 		end

data/lib/changelog.rb~

@@ -30,12 +30,12 @@ class Changelog
 	# Generates a decorated changelog for the entire commit history.
 	#
 	# @param [bool] exclude_recent
-	#		Indicates whether to exclude recent changelog lines that were
-	#		added since the last tag.
+	#   Indicates whether to exclude recent changelog lines that were
+	#   added since the last tag.
 	#
 	#	@return [String]
-	#		Decorated changelog, or nil if no lines were found.
-	#
+	#   Decorated changelog, or nil if no lines were found.
+	#   
 	def generate(exclude_recent = false)
 		# Traverse tags
 		@@tags = TagList.new(!exclude_recent)
@@ -50,8 +50,8 @@ class Changelog
 	# since the most recent tag.
 	#
 	# @return [Array]
-	#		Array of changelog lines, or nil if no lines were found.
-	#
+	#   Array of changelog lines, or nil if no lines were found.
+	#   
 	def generate_recent
 		@@tags = TagList.new
 		log = CommitChangelog.new(@@tags.list[0], @@tags.list[1])
@@ -73,17 +73,17 @@ class Changelog
 	# repository. 
 	#
 	# @param [String] current_tag
-	#		Version tag for which to collect changelog information.
-	#
+	#   Version tag for which to collect changelog information.
+	#   
 	#	@param [String] previous_tag
-	#		Previous version tag whose changelog information does not belong to
-	#		the current version's changelog information. However, if previous_tag
-	#		is the Sha-1 hash of the initial commit, its changelog lines _will_ be
-	#		included.
+	#   Previous version tag whose changelog information does not belong to
+	#   the current version's changelog information. However, if previous_tag
+	#   is the Sha-1 hash of the initial commit, its changelog lines _will_ be
+	#   included.
 	#
 	#	@return [String]
-	#		Changelog decorated with markdown formatting, or empty string.
-	#
+	#   Changelog decorated with markdown formatting, or empty string.
+	#   
 	def generate_for(current_tag, previous_tag)
 		tag = Tag.new(current_tag)
 		commit_changelog = CommitChangelog.new(current_tag, previous_tag)

data/lib/changelog_filter.rb~

@@ -0,0 +1,58 @@
+# changelog_filter.rb, part of Create-changelog
+# Copyright 2015 Daniel Kraus
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative 'array'
+
+# Filters a text or array for changelog entries.
+class ChangelogFilter
+	# Factory method that creates an instance given a text string
+	def self.FromString(string)
+		unless string.is_a?(String)
+			fail "Must call this factory with String, not " + string.class.to_s
+		end
+		self.FromArray(string.chomp.split("\n"))
+	end
+
+	# Factory method that creates an instance given an array of strings
+	def self.FromArray(ary)
+		unless ary.is_a?(Array)
+			fail "Must call this factory with Array, not " + ary.class.to_s
+		end
+		filter = ChangelogFilter.new
+		log, text = ary.partition do |line|
+			line.match(pattern)
+		end
+		filter.changelog = log.uniq.sort.remove_indent if log.length > 0
+		filter.other_text = text if text.length > 0
+		filter
+	end
+
+	# Returns the grep string that matches changelog entries.
+	def self.pattern
+		'\s*[*-]\s+[^:]+:\s'
+	end
+
+	# An array of changelog entries.
+	attr_accessor :changelog
+
+	# An array of text lines that are not changelog entries.
+	attr_accessor :other_text
+
+	private
+
+	def initialize
+	end
+end
+
+# vim: nospell