create_changelog 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd381224eb8e14e9bdbb5b5b58dedb315b2390ab
+  data.tar.gz: 3713419603968048a91c5bb5eb02f0df554b263e
+SHA512:
+  metadata.gz: 1a38fea06c029efe529b4defb5cab2a772df00a554ea5f27eef7250c278eb46e5e686fe06b5b8a33d9c7fd09d8e67b0b6d624e2993262d3fc7785b28801c0837
+  data.tar.gz: a9dc791d30ca360cbf964a8c303da4c9f44e152c858fc12c76c7732b6ddc747b87c7a87fdbb144e8fb1729e06296d0b5163501804f53a512dd17b20eebb8639e

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+Version 1.1.0 (2015-01-18)
+========================================================================
+
+- CHANGED: Accept dashes in addition to asterisks in changelog lines.
+- NEW: Create gem.
+
+* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
+
+
+Version 1.0.0 (2015-01-18)
+========================================================================
+
+
+* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
+
+

data/README.md

@@ -0,0 +1,146 @@
+create-changelog
+================
+
+Ruby program with command-line interface that creates a changelog from
+log lines in a git repository that can be read and understood by end
+users.
+
+There are several approaches to creating changelog files from git
+commits (e.g., [gitchangelog][], [gitlog-to-changelog][gl2cl] and many
+more). None of these quite fit my needs, so I decided to create my own
+tool.
+
+What's special about my approach is that the changelog information is
+not taken from every commit, but from specially marked lines in the
+commit messages and tag annotations. Changelog lines must comply with
+the format:
+
+	- [KEYWORD]: [TEXT]
+
+Where `[KEYWORD]` may be any keyword of your liking, such as "NEW",
+"FIX", and so on. (I am planning to predefine these keywords in a later
+version.) `[TEXT]` is an explanation of the change. _Note that the
+program currently operates on single lines, so it is not possible to
+have `[TEXT]` span several lines._
+
+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.
+
+
+Usage
+-----
+
+### Creating log entries
+When committing, add a line that fits the above definition to the commit
+message, e.g.
+
+	Implement Backup class.
+
+	- NEW: Ability to back up the files.
+
+Create annotated tags to identify new versions:
+
+	Version 7.0.0-alpha.3
+
+	This version adds a new backup feature and fixes several bugs.
+
+If you wish, you can include additional changelog entries in the tag
+annotation. These may even be the same that you used for the commit
+messages (and this tool provides a way to filter the commit messages for
+just these lines). The tool ensures that there are no duplicate
+changelog entries.
+
+	Version 7.0.0-alpha.3
+
+	This version adds a new backup feature and fixes several bugs.
+
+	- NEW: Ability to back up the files.
+
+
+### Generating the log
+
+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
+
+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:
+
+	ccl.rb 7.0.0-alpha.4
+
+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
+
+To just see the (undecorated) changelog entries since the last tag, use:
+
+	ccl.rb --recent
+	ccl.rb -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
+
+The tool will make sure that no changelog lines are duplicated.
+
+
+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.
+
+
+Live example
+------------
+
+<http://xltoolbox.sf.net/changelog-ng>
+
+
+Code
+----
+
+To understand the code, you can run `rdoc` in the repository's
+directory. The resulting `doc` subdirectory will be ignored by Git.
+
+
+License
+-------
+
+	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.
+
+[gitchangelog]: https://pypi.python.org/pypi/gitchangelog
+[gl2cl]: https://github.com/manuelbua/gitver/blob/master/gitlog-to-changelog
+[gnu-changelog]: http://www.gnu.org/prep/standards/html_node/Change-Logs.html
+[pandoc]: http://johnmacfarlane.net/pandoc
+[nanoc]: http://nanoc.ws
+[kacl]: http://keepachangelog.com
+
+<!-- vim: set tw=72 : -->

data/bin/ccl

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+# 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.
+
+# Filters the git log of the repository in the current directory
+# for unique lines that match the pattern
+#   * [KEYWORD]: [DESCRIPTION]
+# The filtered lines are sorted and written to standard out.
+
+require 'optparse'
+require_relative '../lib/create_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 = "#{exe_name} 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 
+			abort "FATAL: Cannot combine --recent and --no-recent" if options[:no_recent] 
+			options[:only_recent] = true
+		end
+		opts.on("-n", "--no-recent",
+						"Exclude the most recent changes (from untagged commits)") do 
+			abort "FATAL: Cannot combine --recent and --no-recent" if options[:recent] 
+			options[:no_recent] = true
+		end
+		opts.on("-d WORKING_DIR", "--dir WORKING_DIR",
+					 "Use alternate working directory") do |dir|
+			working_dir = dir
+		end
+	end
+	option_parser.parse!
+
+	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])
+		end
+	end
+end
+
+main
+
+# vim: nospell

data/bin/ccl~

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+# 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.
+
+# Filters the git log of the repository in the current directory
+# for unique lines that match the pattern
+#   * [KEYWORD]: [DESCRIPTION]
+# The filtered lines are sorted and written to standard out.
+
+require 'optparse'
+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 = "#{exe_name} 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 
+			abort "FATAL: Cannot combine --recent and --no-recent" if options[:no_recent] 
+			options[:only_recent] = true
+		end
+		opts.on("-n", "--no-recent",
+						"Exclude the most recent changes (from untagged commits)") do 
+			abort "FATAL: Cannot combine --recent and --no-recent" if options[:recent] 
+			options[:no_recent] = true
+		end
+		opts.on("-d WORKING_DIR", "--dir WORKING_DIR",
+					 "Use alternate working directory") do |dir|
+			working_dir = dir
+		end
+	end
+	option_parser.parse!
+
+	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])
+		end
+	end
+end
+
+main
+
+# vim: nospell

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_filter.rb

@@ -0,0 +1,57 @@
+# 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, filter.other_text = ary.partition do |line|
+			line.match(pattern)
+		end
+		filter.changelog = log.uniq.sort.remove_indent if log.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

data/lib/changelog_filter.rb~

@@ -0,0 +1,57 @@
+# 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, filter.other_text = ary.partition do |line|
+			line.match(pattern)
+		end
+		filter.changelog = log.uniq.sort.remove_indent if log.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

data/lib/commit_changelog.rb

@@ -0,0 +1,31 @@
+# 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.
+	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
+end
+
+# vim: nospell

data/lib/create_changelog.rb

@@ -0,0 +1,74 @@
+# 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
+	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/git.rb

@@ -0,0 +1,60 @@
+# 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
+
+	# 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
+
+	@@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/git.rb~

@@ -0,0 +1,58 @@
+# 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
+
+	# 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
+
+	@@tags = nil
+
+	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

@@ -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
+			@changelog = filter.changelog
+		end
+	end
+end
+
+# vim: nospell

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

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

data/lib/version.rb~

@@ -0,0 +1,3 @@
+module CreateChangelog
+	VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: create_changelog
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Daniel Kraus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-18 00:00:00.000000000 Z
+dependencies: []
+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
+executables:
+- ccl
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- bin/ccl
+- bin/ccl~
+- lib/array.rb
+- lib/changelog_filter.rb
+- lib/changelog_filter.rb~
+- lib/commit_changelog.rb
+- lib/create_changelog.rb
+- lib/git.rb
+- lib/git.rb~
+- lib/tag.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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Creates end-user-friendly changelog from git messages.
+test_files: []