create_changelog 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbb6680237cbad0391a0726ceb5bcb78dc4a53c9
-  data.tar.gz: caf83089dd06505fcd8acb43f17f0b5e587f9829
+  metadata.gz: 24eaf0e197456ddc73ee36dbe5c4befa32d7a8fb
+  data.tar.gz: ac2e4abb1a874e0c8d98f3bc404273c733bf48ea
 SHA512:
-  metadata.gz: 22bc16e610025ba7d66e02552327c0e17e0271af8f550a7fd425dbf6e8b5fb914ddaf1b02c427aeca65f9354cdbd4fd85d2b860e317f4bb1e34bfb1b47f22efe
-  data.tar.gz: ce631d8ff2693ab82f0946a6d9662dd98b521bd1341e4d2a87a5fd94464e3180cd5f1dbc26d23ff280fd66432b929806b2b32c75978b5520eb13547dfd5d4dd1
+  metadata.gz: 56de42ae4ca9ccf353baacf98df9729a9c90287871e30af061fc46d2f7087ed99a8ba1ee3f04a47707eb977c98c9f8f6c73417e419a7fb4ff28531df03b8d90b
+  data.tar.gz: 40ca54406f53d1f2a7106cbe393e127a7f07f0b781a5276ecec945cb3a213669c0d9807fc286805dad29b543adbf1be049abc5712e9d5cfcc4de99eae91dac96

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+Version 1.3.0 (2015-01-21)
+========================================================================
+
+- CHANGE: Omit empty lines at end of changelog.
+- FIX: Do not crash if Git repository is empty.
+- FIX: Do not produce any output if no changelog information found.
+- FIX: Ensure unique lines if initial commit is included.
+- FIX: Include the very first commit's message in the changelog.
+- FIX: Omit recent changes section if there are no recent changes.
+
+* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
+
+
 Version 1.2.0 (2015-01-18)
 ========================================================================
 
@@ -21,6 +34,5 @@ Version 1.0.0 (2015-01-18)
 ========================================================================
 
 
-* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
-
 
+* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

data/README.md

@@ -1,4 +1,6 @@
-create-changelog
+[![Gem Version](https://badge.fury.io/rb/create_changelog.svg)](http://badge.fury.io/rb/create_changelog)
+
+create_changelog
 ================
 
 Ruby program with command-line interface that creates a changelog from
@@ -27,19 +29,25 @@ The reason why I chose to have special changelog lines rather than
 commit subjects is that commits are rather technical, but I want to have
 a changelog that can be read by 'normal' end users.
 
+create_changelog assumes that each tag in the repository represents a
+release version. The changelog for a version consists of the tag's name,
+the tag's annotation, and the unique combined, filtered changelog lines
+of the tag annotation and all commits since the previous tag.
+
 
 Usage
 -----
 
 ### Creating log entries
-When committing, add a line that fits the above definition to the commit
-message, e.g.
+
+When committing, add a line to the commit message that fits the above
+definition, e.g.
 
 	Implement Backup class.
 
 	- NEW: Ability to back up the files.
 
-Create annotated tags to identify new versions:
+When releasing a new version, create an annotated tag:
 
 	Version 7.0.0-alpha.3
 
@@ -63,38 +71,41 @@ changelog entries.
 To generate a complete change log, simply run the tool in the directory
 of the git repository, or indicate a working directory:
 
-	ccl.rb -d /home/me/my/repository
+	ccl -d /home/me/my/repository
 
 The output will be in markdown format. If you wish, you can further
 process it using tools like [pandoc][] for example. Of course, it is
 also possible to incorporate the command in the content files for a
 static site generator such as [nanoc][].
 
-If you want to track your log in the git repository, you probably will
-not yet have an annotated tag for the version you are preparing. In this
-case, the tool will use "Unpublished changes" as the heading for the
-latest changes. To use the version number that you are about to use in
-the tag, call the tool with an optional argument:
+If you want to track your log in the git repository, you will not yet
+have an annotated tag for the version you are preparing at the time when
+you generate the changelog. In this case, the tool will use "Unpublished
+changes" as the heading for the latest changes. To rather use the
+version number that you are about to use in the tag, execute the tool
+with an optional argument:
 
-	ccl.rb 7.0.0-alpha.4
+	ccl "Version 7.0.0-alpha.4"
+
+You then use this same version number for your release tag.
 
 Be aware that currently, the date of the most recent commit (that HEAD
 points to) will be appended to the heading.
 
 To exclude recent changes that were logged since the last tag:
 
-	ccl.rb --no-recent
-	ccl.rb -n
+	ccl --no-recent
+	ccl -n
 
 To just see the (undecorated) changelog entries since the last tag, use:
 
-	ccl.rb --recent
-	ccl.rb -r
+	ccl --recent
+	ccl -r
 
 This can be handy if you want to add a log of recent changes to your tag
 annotation. For example, using the Vim text editor, issue:
 
-	:r!ccl.rb -r
+	:r!ccl -r
 
 The tool will make sure that no changelog lines are duplicated.
 
@@ -103,8 +114,17 @@ Changelog format
 ----------------
 
 The changelog format resembles the [suggestions][kacl] made by Olivier
-Lacan. I have not yet have the time to implement automatic generation of
-subheadings. Maybe I'll add the feature in the future.
+Lacan, but it does not fully comply with Olivier's specification. I have
+not yet have the time to implement automatic generation of subheadings.
+Maybe I'll add the feature in the future.
+
+
+To do
+-----
+
+- Add automatic subheadings
+- Add ability to handle multi-line change log entries
+- Add to-do list feature
 
 
 Live example
@@ -118,11 +138,8 @@ Live example
 Code
 ----
 
-To understand the code, you can run `rdoc` in the repository's
-directory. The resulting `doc` subdirectory will be ignored by Git.
-
-Alternatively, you may browse
-<http://www.rubydoc.info/github/bovender/create-changelog>.
+The code is documented in [Yard][] style. The `doc` subdirectory is
+git-ignored so you can safely generate the docs.
 
 
 License
@@ -148,5 +165,6 @@ License
 [nanoc]: http://nanoc.ws
 [kacl]: http://keepachangelog.com
 [CHANGELOG.md]: CHANGELOG.md
+[Yard]: http://www.rubydoc.info/gems/yard
 
 <!-- vim: set tw=72 : -->

data/bin/ccl

@@ -19,54 +19,54 @@
 # The filtered lines are sorted and written to standard out.
 
 require 'optparse'
-require_relative '../lib/create_changelog.rb'
+require_relative '../lib/changelog.rb'
 require_relative '../lib/git.rb'
 require_relative '../lib/version.rb'
 
-def main
-	options = {}
-	working_dir = Dir.pwd
-	option_parser = OptionParser.new do |opts|
-		exe_name = File.basename($PROGRAM_NAME)
-		opts.banner = "create_changelog version #{CreateChangelog::VERSION}\n"
-		opts.banner += "Creates changelog from log entries in git log\n"
-		opts.banner += "Usage: #{exe_name} [options] [current_version]"
-		opts.on("-r", "--recent",
-						"Include only most recent changes") do 
-			options[:only_recent] = true
-		end
-		opts.on("-n", "--no-recent",
-						"Exclude the most recent changes (from untagged commits)") do 
-			options[:no_recent] = true
-		end
-		opts.on("-d WORKING_DIR", "--dir WORKING_DIR",
-					 "Use alternate working directory") do |dir|
-			working_dir = dir
-		end
-		opts.on("-v", "--version", "Print version information and exit.") do
-			puts CreateChangelog::VERSION
-			exit
-		end
+options = {}
+working_dir = Dir.pwd
+option_parser = OptionParser.new do |opts|
+	exe_name = File.basename($PROGRAM_NAME)
+	opts.banner = "create_changelog version #{CreateChangelog::VERSION}\n"
+	opts.banner += "Creates changelog from log entries in git log\n"
+	opts.banner += "Usage: #{exe_name} [options] [current_version]"
+	opts.on("-r", "--recent",
+					"Include only most recent changes") do 
+		options[:only_recent] = true
 	end
-	option_parser.parse!
-
-	if options[:no_recent] and options[:only_recent]
-			abort "FATAL: Cannot combine --recent and --no-recent"
+	opts.on("-n", "--no-recent",
+					"Exclude the most recent changes (from untagged commits)") do 
+		options[:no_recent] = true
+	end
+	opts.on("-d WORKING_DIR", "--dir WORKING_DIR",
+				 "Use alternate working directory") do |dir|
+		working_dir = dir
 	end
+	opts.on("-v", "--version", "Print version information and exit.") do
+		puts CreateChangelog::VERSION
+		exit
+	end
+end
+option_parser.parse!
 
-	Dir.chdir(working_dir) do
-		abort "FATAL: Not a git repository." unless Git.is_git_repository?
+if options[:no_recent] and options[:only_recent]
+		abort "FATAL: Cannot combine --recent and --no-recent"
+end
 
+Dir.chdir(working_dir) do
+	abort "FATAL: Not a git repository." unless Git.is_git_repository?
+
+	unless Git.is_empty_repository?
 		change_log = Changelog.new
 		change_log.recent_changes_heading = ARGV[0] unless ARGV.empty?
 		if options[:only_recent]
-			puts change_log.generate_recent
+			output = change_log.generate_recent
+			puts output if output
 		else
-			puts change_log.generate(options[:no_recent])
+			output = change_log.generate(options[:no_recent])
+			puts output.rstrip if output
 		end
 	end
 end
 
-main
-
 # vim: nospell

data/bin/ccl~

@@ -19,7 +19,7 @@
 # The filtered lines are sorted and written to standard out.
 
 require 'optparse'
-require_relative '../lib/create_changelog.rb'
+require_relative '../lib/changelog.rb'
 require_relative '../lib/git.rb'
 require_relative '../lib/version.rb'
 
@@ -33,7 +33,6 @@ def main
 		opts.banner += "Usage: #{exe_name} [options] [current_version]"
 		opts.on("-r", "--recent",
 						"Include only most recent changes") do 
-			abort "FATAL: Cannot combine --recent and --no-recent" if options[:no_recent] 
 			options[:only_recent] = true
 		end
 		opts.on("-n", "--no-recent",
@@ -52,18 +51,22 @@ def main
 	option_parser.parse!
 
 	if options[:no_recent] and options[:only_recent]
-			abort "FATAL: Cannot combine --recent and --no-recent" if options[:recent] 
+			abort "FATAL: Cannot combine --recent and --no-recent"
 	end
 
 	Dir.chdir(working_dir) do
 		abort "FATAL: Not a git repository." unless Git.is_git_repository?
 
-		change_log = Changelog.new
-		change_log.recent_changes_heading = ARGV[0] unless ARGV.empty?
-		if options[:only_recent]
-			puts change_log.generate_recent
-		else
-			puts change_log.generate(options[:no_recent])
+		unless Git.is_empty_repository?
+			change_log = Changelog.new
+			change_log.recent_changes_heading = ARGV[0] unless ARGV.empty?
+			if options[:only_recent]
+				output = change_log.generate_recent
+				puts output if output
+			else
+				output = change_log.generate(options[:no_recent])
+				puts output.rstrip if output
+			end
 		end
 	end
 end

data/lib/changelog.rb

@@ -0,0 +1,124 @@
+# changelog.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 './commit_changelog.rb'
+require_relative './tag_list.rb'
+require_relative './tag.rb'
+
+# Central class that puts together the changelog.
+class Changelog
+
+	# Heading for the most recent changes.
+	attr_writer :recent_changes_heading
+
+	def initialize
+		@recent_changes_heading = "Unpublished changes"
+	end
+
+	@@tags = nil
+
+	# 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.
+	#
+	#	@return [String]
+	#   Decorated changelog, or nil if no lines were found.
+	#   
+	def generate(exclude_recent = false)
+		# Traverse tags
+		@@tags = TagList.new(!exclude_recent)
+		output = String.new
+		@@tags.list.each_cons(2) do |current_tag, previous_tag|
+			output << generate_for(current_tag, previous_tag)
+		end
+		output.length > 0 ? output : nil
+	end
+
+	# Generates a simple, undecorated list of changelog entries
+	# since the most recent tag.
+	#
+	# @return [Array]
+	#   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])
+		# Explicitly add initial commit if there is no tag yet
+		# This is necessary because HEAD..OTHER_COMMIT does not include
+		# OTHER_COMMIT's message, which is the desired behavior if
+		# OTHER_COMMIT is a tag for a previous version, but undesired
+		# if OTHER_COMMIT is the initial commit of the repository.
+		log.add_commit @@tags.list[1] if @@tags.list.length == 2
+		log.changelog
+	end
+
+	private
+
+	# Generates decorated changelog information including the current_tag's
+	# annotation and all changelog lines written in commit messages since the
+	# previous_tag.  Note that this will exclude previous_tag's annotation,
+	# except if previous_tag is not a tag, but the initial commit in the
+	# repository. 
+	#
+	# @param [String] current_tag
+	#   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.
+	#
+	#	@return [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)
+
+		# If previous_tag is the initial commit, make sure to include its message
+		commit_changelog.add_commit previous_tag if previous_tag == @@tags.list[-1]
+
+		# Combine changelog entries from tag annotation and commit messages
+		if tag.changelog
+			combined_changelog = tag.changelog.concat(commit_changelog.changelog)
+		else
+			combined_changelog = commit_changelog.changelog
+		end
+		combined_changelog.uniq! if combined_changelog
+
+		output = String.new
+		tag.heading = @recent_changes_heading unless tag.heading
+		if tag.heading and (tag.text or combined_changelog)
+			output << tag.heading + " (#{tag.date})\n"
+			output << "=" * 72 + "\n"
+		end
+		output << tag.text.join("\n") if tag.text
+		output << "\n" if tag.heading or tag.text
+		output << combined_changelog.join("\n") + "\n" if combined_changelog
+		output << end_separator if tag.text or combined_changelog
+		output
+	end
+
+	# Markdown-compatible horizontal 'ruler'.
+	#
+	# @return [String]
+	#
+	def end_separator
+		"\n" + ("* " * 36) +"\n\n\n"
+	end
+end
+
+# vim: nospell

data/lib/changelog.rb~

@@ -0,0 +1,124 @@
+# changelog.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 './commit_changelog.rb'
+require_relative './tag_list.rb'
+require_relative './tag.rb'
+
+# Central class that puts together the changelog.
+class Changelog
+
+	# Heading for the most recent changes.
+	attr_writer :recent_changes_heading
+
+	def initialize
+		@recent_changes_heading = "Unpublished changes"
+	end
+
+	@@tags = nil
+
+	# 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.
+	#
+	#	@return [String]
+	#		Decorated changelog, or nil if no lines were found.
+	#
+	def generate(exclude_recent = false)
+		# Traverse tags
+		@@tags = TagList.new(!exclude_recent)
+		output = String.new
+		@@tags.list.each_cons(2) do |current_tag, previous_tag|
+			output << generate_for(current_tag, previous_tag)
+		end
+		output.length > 0 ? output : nil
+	end
+
+	# Generates a simple, undecorated list of changelog entries
+	# since the most recent tag.
+	#
+	# @return [Array]
+	#		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])
+		# Explicitly add initial commit if there is no tag yet
+		# This is necessary because HEAD..OTHER_COMMIT does not include
+		# OTHER_COMMIT's message, which is the desired behavior if
+		# OTHER_COMMIT is a tag for a previous version, but undesired
+		# if OTHER_COMMIT is the initial commit of the repository.
+		log.add_commit @@tags.list[1] if @@tags.list.length == 2
+		log.changelog
+	end
+
+	private
+
+	# Generates decorated changelog information including the current_tag's
+	# annotation and all changelog lines written in commit messages since the
+	# previous_tag.  Note that this will exclude previous_tag's annotation,
+	# except if previous_tag is not a tag, but the initial commit in the
+	# repository. 
+	#
+	# @param [String] current_tag
+	#		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.
+	#
+	#	@return [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)
+
+		# If previous_tag is the initial commit, make sure to include its message
+		commit_changelog.add_commit previous_tag if previous_tag == @@tags.list[-1]
+
+		# Combine changelog entries from tag annotation and commit messages
+		if tag.changelog
+			combined_changelog = tag.changelog.concat(commit_changelog.changelog)
+		else
+			combined_changelog = commit_changelog.changelog
+		end
+		combined_changelog.uniq! if combined_changelog
+
+		output = String.new
+		tag.heading = @recent_changes_heading unless tag.heading
+		if tag.heading and (tag.text or combined_changelog)
+			output << tag.heading + " (#{tag.date})\n"
+			output << "=" * 72 + "\n"
+		end
+		output << tag.text.join("\n") if tag.text
+		output << "\n" if tag.heading or tag.text
+		output << combined_changelog.join("\n") + "\n" if combined_changelog
+		output << end_separator if tag.text or combined_changelog
+		output
+	end
+
+	# Markdown-compatible horizontal 'ruler'.
+	#
+	# @return [String]
+	#
+	def end_separator
+		"\n" + ("* " * 36) +"\n\n\n"
+	end
+end
+
+# vim: nospell

data/lib/changelog_filter.rb

@@ -30,10 +30,11 @@ class ChangelogFilter
 			fail "Must call this factory with Array, not " + ary.class.to_s
 		end
 		filter = ChangelogFilter.new
-		log, filter.other_text = ary.partition do |line|
+		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
 

data/lib/commit_changelog.rb

@@ -15,17 +15,50 @@ require_relative 'changelog_filter'
 
 # Filters commit messages for changelog entries.
 class CommitChangelog
+
 	# Contains changelog entries of the commits.
 	attr_reader :changelog
 
 	# Instantiates an object containing changelog entries between
 	# two git commits.
+	#
+	# @param [String] to_commit
+	#	  Most recent commit whose changelog lines to include.
+	#
+	#	@param [String] from_commit
+	#	  Earlier commit whose changelog lines will _not_ be included.
+	#
+	#	@return [Array]
+	#	  Array of changelog lines, or nil if none were found.
+	#
 	def initialize(to_commit, from_commit)
 		pattern = ChangelogFilter.pattern
 		messages = Git.get_filtered_messages(from_commit, to_commit, pattern)
 		filter = ChangelogFilter.FromString(messages)
 		@changelog = filter.changelog
 	end
+
+	# Adds changelog information contained in a specific commit message. This
+	# method is typically used to parse the initial commit's commit message.
+	#
+	# @param [String] commit
+	#   Sha-1 of the commit whose commit message to filter for changelog lines.
+	#
+	# @return
+	#   Undefined
+	#
+	def add_commit(commit)
+		pattern = ChangelogFilter.pattern
+		filtered_text = Git.get_filtered_message(commit, pattern)
+		if filtered_text
+			filtered_lines = filtered_text.split("\n").uniq
+			if @changelog
+				@changelog = @changelog.concat(filtered_lines).uniq
+			else
+				@changelog = filtered_lines
+			end
+		end
+	end
 end
 
 # vim: nospell

data/lib/commit_changelog.rb~

@@ -0,0 +1,56 @@
+# commit_changelog.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 'changelog_filter'
+
+# Filters commit messages for changelog entries.
+class CommitChangelog
+
+	# Contains changelog entries of the commits.
+	attr_reader :changelog
+
+	# Instantiates an object containing changelog entries between
+	# two git commits.
+	#
+	# @param [String] to_commit
+	#	  Most recent commit whose changelog lines to include.
+	#
+	#	@param [String] from_commit
+	#	  Earlier commit whose changelog lines will _not_ be included.
+	#
+	#	@return [Array]
+	#	  Array of changelog lines, or nil if none were found.
+	#
+	def initialize(to_commit, from_commit)
+		pattern = ChangelogFilter.pattern
+		messages = Git.get_filtered_messages(from_commit, to_commit, pattern)
+		filter = ChangelogFilter.FromString(messages)
+		@changelog = filter.changelog
+	end
+
+	# Adds changelog information contained in a specific commit message.
+	def add_commit(commit)
+		pattern = ChangelogFilter.pattern
+		filtered_text = Git.get_filtered_message(commit, pattern)
+		if filtered_text
+			filtered_lines = filtered_text.split("\n").uniq
+			if @changelog
+				@changelog = @changelog.concat(filtered_lines).uniq
+			else
+				@changelog = filtered_lines
+			end
+		end
+	end
+end
+
+# vim: nospell

data/lib/git.rb

@@ -17,19 +17,34 @@ require_relative 'tag_list'
 class Git
 
 	# Determines whether the (current) directory is a git repository
+	#
+	# @param [String] dir
+	#   Directory to check; if nil, uses the current directory.
+	#
+	# @return [bool]
+	#   True if the directory is a Git repository, false if not.
 	def self.is_git_repository?(dir = nil)
 		dir = Dir.pwd if dir.nil?
 		system("git status > /dev/null 2>&1")
 		$? == 0
 	end
 
+	# Determines if the repository in the current directory is empty.
+	#
+	def self.is_empty_repository?
+		`git show HEAD > /dev/null 2>&1`
+		$? != 0
+	end
+
 	# Retrieves the first 99 lines of the annotation of a tag.
+	#
 	def self.get_tag_annotation(tag)
 		test_tag tag
 		`git tag -l -n99 #{tag}`.rstrip
 	end
 
-	# Retrieves the date of a tag
+	# Retrieves the author date of a tag
+	#
 	def self.get_tag_date(tag)
 		test_tag tag
 		`git log -1 --format=format:%ai #{tag}`
@@ -41,6 +56,12 @@ class Git
 		`git log #{from_commit}..#{to_commit} -E --grep='#{filter}' --format=%b`
 	end
 
+	# Retrieves one commit message and filters it
+	# Todo: Armor this against code injection!
+	def self.get_filtered_message(commit, filter)
+		`git log #{commit} -E --grep='#{filter}' --format=%b`
+	end
+
 	@@tags = nil
 
 	# Ensures lazy loading of the tag list to enable calling code

data/lib/git.rb~

@@ -0,0 +1,72 @@
+# git.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 'tag_list'
+
+# A static wrapper class for git
+class Git
+
+	# Determines whether the (current) directory is a git repository
+	def self.is_git_repository?(dir = nil)
+		dir = Dir.pwd if dir.nil?
+		system("git status > /dev/null 2>&1")
+		$? == 0
+	end
+
+	# Determines if the repository in the current directory is empty.
+	def self.is_empty_repository?
+		`git show HEAD > /dev/null 2>&1`
+		$? != 0
+	end
+
+	# Retrieves the first 99 lines of the annotation of a tag.
+	def self.get_tag_annotation(tag)
+		test_tag tag
+		`git tag -l -n99 #{tag}`.rstrip
+	end
+
+	# Retrieves the date of a tag
+	def self.get_tag_date(tag)
+		test_tag tag
+		`git log -1 --format=format:%ai #{tag}`
+	end
+
+	# Retrieves commit messages and filters them
+	# Todo: Armor this against code injection!
+	def self.get_filtered_messages(from_commit, to_commit, filter)
+		`git log #{from_commit}..#{to_commit} -E --grep='#{filter}' --format=%b`
+	end
+
+	# Retrieves one commit message and filters it
+	# Todo: Armor this against code injection!
+	def self.get_filtered_message(commit, filter)
+		`git log #{commit} -E --grep='#{filter}' --format=%b`
+	end
+
+	@@tags = nil
+
+	# Ensures lazy loading of the tag list to enable calling code
+	# to change the working directory first.
+	def self.tags
+		@@tags = TagList.new unless @@tags
+		@@tags
+	end
+
+	# Tests if the given tag exists and fails if it doesn't
+	def self.test_tag(tag)
+		fail "Invalid tag: #{tag}" unless tags.list.include?(tag)
+	end
+	private_class_method :test_tag, :tags
+end
+
+# vim: nospell

data/lib/tag.rb

@@ -15,7 +15,7 @@ require 'date'
 require_relative 'git'
 require_relative 'changelog_filter'
 
-# Represents a git tag and its annotation.
+# Represents a Git tag and its annotation.
 class Tag
 	# The heading of the tag annotation.
 	attr_accessor :heading
@@ -30,10 +30,9 @@ class Tag
 	attr_reader :date
 
 	# Gets change information for a specific tagged version.
-	# This will prepend the summary for the annotated tag before
-	# the list of changes. If the tag annotation contains changelog
-	# entries, they are merged with the changelog entries filtered
-	# from the commit messages, and only unique entries are used.
+	#
+	# @param [String] tag
+	#   Tag for which to instantiate the class.
 	def initialize(tag)
 		annotation = Git.get_tag_annotation(tag)
 		@date = Date.parse(Git.get_tag_date(tag))
@@ -42,7 +41,7 @@ class Tag
 			@heading = annotation.shift
 			@heading = @heading.split(' ')[1..-1].join(' ') if @heading
 			filter = ChangelogFilter.FromArray(annotation)
-			@text = filter.other_text.remove_indent
+			@text = filter.other_text.remove_indent if filter.other_text
 			@changelog = filter.changelog
 		end
 	end

data/lib/tag.rb~

@@ -0,0 +1,51 @@
+# tag.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 'date'
+require_relative 'git'
+require_relative 'changelog_filter'
+
+# Represents a git tag and its annotation.
+class Tag
+	# The heading of the tag annotation.
+	attr_accessor :heading
+	
+	# Array of lines in the tag annotation that are not changelog entries.
+	attr_reader :text
+
+	# Array of lines in the tag annotation that are changelog entries.
+	attr_reader :changelog
+
+	# Author commit date of the tag
+	attr_reader :date
+
+	# Gets change information for a specific tagged version.
+	# This will prepend the summary for the annotated tag before
+	# the list of changes. If the tag annotation contains changelog
+	# entries, they are merged with the changelog entries filtered
+	# from the commit messages, and only unique entries are used.
+	def initialize(tag)
+		annotation = Git.get_tag_annotation(tag)
+		@date = Date.parse(Git.get_tag_date(tag))
+		if annotation
+			annotation = annotation.split("\n")
+			@heading = annotation.shift
+			@heading = @heading.split(' ')[1..-1].join(' ') if @heading
+			filter = ChangelogFilter.FromArray(annotation)
+			@text = filter.other_text.remove_indent if filter.other_text
+			@changelog = filter.changelog
+		end
+	end
+end
+
+# vim: nospell

data/lib/tag_list.rb

@@ -24,8 +24,10 @@ class TagList
 	attr_reader :list
 
 	# Instantiates the tag list.
-	# include_head indicates whether or not to include
-	# the most recent changes
+	#
+	# @param [bool] include_head
+	#   Indicates whether or not to include the most recent changes.
+	#
 	def initialize(include_head = true)
 		@include_head = include_head
 		@list = build_list
@@ -33,6 +35,9 @@ class TagList
 
 	# Returns the most recent tag in the git repository,
 	# or the sha1 of the initial commit if there is no tag.
+	#
+	# @return [String]
+	#
 	def latest_tag
 		# Index 0 is HEAD
 		# Index 1 is most recent tag or first commit
@@ -46,10 +51,16 @@ class TagList
 	# of the repository. Usually there should be not more than
 	# one such commit.
 	# See http://stackoverflow.com/a/1007545/270712
+	#
 	def get_initial_commit
 		`git rev-list --max-parents=0 HEAD`.chomp
 	end
 
+	# Builds a list of Git tags and encloses it with HEAD and the
+	# Sha-1 of the initial commit.
+	#
+	# @return [Array]
+	#   Array of tags, surrounded by HEAD and the Sha-1 of the initial commit.
 	def build_list
 		tags = []
 		tags <<  get_initial_commit

data/lib/tag_list.rb~

@@ -0,0 +1,62 @@
+# TagList, 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.
+
+# Builds a list of tags in the current git repository.
+# The tags are enclosed by the sha1 of the first commit
+# and optionally "HEAD" to allow traversing the list
+# with each_con to obtain start and end points of
+# developmental epochs.
+class TagList
+	# Returns an array of tag names surrounded by HEAD
+	# at the top and the sha1 of the first commit at the
+	# bottom.
+	attr_reader :list
+
+	# Instantiates the tag list.
+	# include_head indicates whether or not to include
+	# the most recent changes
+	def initialize(include_head = true)
+		@include_head = include_head
+		@list = build_list
+	end
+
+	# Returns the most recent tag in the git repository,
+	# or the sha1 of the initial commit if there is no tag.
+	def latest_tag
+		# Index 0 is HEAD
+		# Index 1 is most recent tag or first commit
+		@list[1]
+	end
+
+	private
+
+	# Returns the sha1 of the initial commit.
+	# In fact, this function returns all parentless commits
+	# of the repository. Usually there should be not more than
+	# one such commit.
+	# See http://stackoverflow.com/a/1007545/270712
+	def get_initial_commit
+		`git rev-list --max-parents=0 HEAD`.chomp
+	end
+
+	def build_list
+		tags = []
+		tags <<  get_initial_commit
+		tags += `git tag`.split("\n").map { |s| s.rstrip }
+		tags << "HEAD" if @include_head
+		tags.reverse
+	end
+end
+
+# vim: nospell

data/lib/version.rb

@@ -1,3 +1,3 @@
 module CreateChangelog
-	VERSION = '1.2.0'
+	VERSION = '1.3.0'
 end

data/lib/version.rb~

@@ -1,3 +1,3 @@
 module CreateChangelog
-	VERSION = '1.1.0'
+	VERSION = '1.2.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: create_changelog
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Daniel Kraus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-18 00:00:00.000000000 Z
-dependencies: []
+date: 2015-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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: "\t\tRuby program with command-line interface that creates a changelog
   from log\n\t\tlines in a git repository that can be read and understood by end users.\n"
 email: krada@gmx.net
@@ -23,20 +37,26 @@ files:
 - bin/ccl
 - bin/ccl~
 - lib/array.rb
+- lib/changelog.rb
+- lib/changelog.rb~
 - lib/changelog_filter.rb
 - lib/commit_changelog.rb
-- lib/create_changelog.rb
-- lib/create_changelog.rb~
+- lib/commit_changelog.rb~
 - lib/git.rb
+- lib/git.rb~
 - lib/tag.rb
+- lib/tag.rb~
 - lib/tag_list.rb
+- lib/tag_list.rb~
 - lib/version.rb
 - lib/version.rb~
 homepage: https://github.com/bovender/create-changelog
 licenses:
 - Apache License version 2
 metadata: {}
-post_install_message: 
+post_install_message: |
+  create_changelog version 1.3.0 has been installed.
+  For usage information, type ccl -h
 rdoc_options: []
 require_paths:
 - lib
@@ -52,8 +72,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Creates end-user-friendly changelog from git messages.
 test_files: []
+has_rdoc: 

data/lib/create_changelog.rb

@@ -1,77 +0,0 @@
-# changelog.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 './commit_changelog.rb'
-require_relative './tag_list.rb'
-require_relative './tag.rb'
-
-# Central class that puts together the changelog.
-class Changelog
-	# Heading for the most recent changes.
-	attr_writer :recent_changes_heading
-
-	def initialize
-		@recent_changes_heading = "Unpublished changes"
-	end
-
-	# Generates a decorated changelog.
-	def generate(exclude_recent = false)
-		# Traverse tags
-		tags = TagList.new(!exclude_recent)
-		output = String.new
-		tags.list.each_cons(2) do |current_tag, previous_tag|
-			output << generate_for(current_tag, previous_tag)
-		end
-		output
-	end
-
-	# Returns a simple, undecorated list of changelog entries
-	# since the most recent tag.
-	def generate_recent
-		tags = TagList.new
-		log = CommitChangelog.new(tags.list[0], tags.list[1])
-		log.changelog
-	end
-
-	private
-
-	def generate_for(current_tag, previous_tag)
-		tag = Tag.new(current_tag)
-		commit_changelog = CommitChangelog.new(current_tag, previous_tag)
-
-		# Combine changelog entries from tag annotation and commit messages
-		if tag.changelog
-			combined_changelog = tag.changelog.concat(commit_changelog.changelog)
-		else
-			combined_changelog = commit_changelog.changelog
-		end
-		combined_changelog.uniq! if combined_changelog
-
-		output = String.new
-		tag.heading = @recent_changes_heading unless tag.heading
-		if tag.heading
-			output << tag.heading + " (#{tag.date})\n"
-			output << "=" * 72 + "\n"
-		end
-		output << tag.text.join("\n") + "\n" if tag.text
-		output << combined_changelog.join("\n") + "\n" if combined_changelog
-		output << end_separator if tag.heading or tag.text or combined_changelog
-		output
-	end
-
-	def end_separator
-		"\n" + ("* " * 36) +"\n\n\n"
-	end
-end
-
-# vim: nospell

data/lib/create_changelog.rb~

@@ -1,77 +0,0 @@
-# changelog.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 './commit_changelog.rb'
-require_relative './tag_list.rb'
-require_relative './tag.rb'
-
-# Central class that puts together the changelog.
-class Changelog
-	# Heading for the most recent changes.
-	attr_writer :recent_changes_heading
-
-	def initialize
-		@recent_changes_heading = "Unpublished changes"
-	end
-
-	# Generates a decorated changelog.
-	def generate(exclude_recent = false)
-		# Traverse tags
-		tags = TagList.new(!exclude_recent)
-		output = String.new
-		tags.list.each_cons(2) do |current_tag, previous_tag|
-			output << generate_for(current_tag, previous_tag)
-		end
-		output
-	end
-
-	# Returns a simple, undecorated list of changelog entries
-	# since the most recent tag.
-	def generate_recent
-		tags = TagList.new
-		log = CommitChangelog.new(tags.list[0], tags.list[1])
-		log.changelog.inspect
-	end
-
-	private
-
-	def generate_for(current_tag, previous_tag)
-		tag = Tag.new(current_tag)
-		commit_changelog = CommitChangelog.new(current_tag, previous_tag)
-
-		# Combine changelog entries from tag annotation and commit messages
-		if tag.changelog
-			combined_changelog = tag.changelog.concat(commit_changelog.changelog)
-		else
-			combined_changelog = commit_changelog.changelog
-		end
-		combined_changelog.uniq! if combined_changelog
-
-		output = String.new
-		tag.heading = @recent_changes_heading unless tag.heading
-		if tag.heading
-			output << tag.heading + " (#{tag.date})\n"
-			output << "=" * 72 + "\n"
-		end
-		output << tag.text.join("\n") + "\n" if tag.text
-		output << combined_changelog.join("\n") + "\n" if combined_changelog
-		output << end_separator if tag.heading or tag.text or combined_changelog
-		output
-	end
-
-	def end_separator
-		"\n" + ("* " * 36) +"\n\n\n"
-	end
-end
-
-# vim: nospell