create_changelog 1.3.2 → 1.4.1

data/lib/changelog_filter.rb~

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

data/lib/commit_changelog.rb~

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

@@ -1,147 +0,0 @@
-# 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 Git is installed
-	#
-	# @return [bool]
-	#   True if Git is installed, false if not.
-	#
-	def self.is_installed?
-		`git --version`
-		$? == 0
-	end
-
-	# 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 name of the current branch.
-	#
-	# @return [String]
-	#   Current branch.
-	def self.current_branch
-		`git branch`.rstrip
-	end
-
-	# Launches the text editor that Git uses for commit messages,
-	# and passes file as a command line argument to it.
-	#
-	# @see https://github.com/git/git/blob/master/editor.c
-	#   Git's editor.c on GitHub
-	#
-	# @param [String] file
-	#   Filename to pass to the editor.
-	#
-	# @return [int]
-	#		Exit code of the editor process, or false if no editor found.
-	#
-	def self.launch_editor(file)
-		# const char *editor = getenv("GIT_EDITOR");
-		editor = ENV['GIT_EDITOR']
-
-		# const char *terminal = getenv("TERM");
-		terminal = ENV['TERM'];
-
-		# int terminal_is_dumb = !terminal || !strcmp(terminal, "dumb");
-		terminal_is_dumb = !terminal || terminal == 'dumb'
-
-		# if (!editor && editor_program)
-		editor = `git config --get core.editor`.rstrip if editor.nil? || editor.empty?
-
-		# if (!editor && !terminal_is_dumb)
-		#		editor = getenv("VISUAL");
-		editor = ENV['VISUAL'] if (editor.nil? || editor.empty?) && !terminal_is_dumb
-
-		# if (!editor)
-		# 	editor = getenv("EDITOR");
-		editor = ENV['EDITOR'] if (editor.nil? || editor.empty?)
-
-		# if (!editor && terminal_is_dumb)
-		# 	return NULL;
-		# if (!editor)
-		# 	editor = DEFAULT_EDITOR;
-		# Use vi, Git's hard-coded default
-		editor = 'vi' if (editor.nil? || editor.empty?) && !terminal_is_dumb
-
-		if editor && !editor.empty?
-			system "#{editor} '#{file}'"
-			$?
-		else
-			false
-		end
-	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 author 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~

@@ -1,50 +0,0 @@
-# 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.
-	#
-	# @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))
-		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~

@@ -1,73 +0,0 @@
-# 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.
-	#
-	# @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
-	end
-
-	# 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
-		@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
-
-	# 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
-		tags += `git tag | sort -V`.split("\n").map { |s| s.rstrip }
-		tags << "HEAD" if @include_head
-		tags.reverse
-	end
-end
-
-# vim: nospell

data/test/test_changelog_filter.rb~

@@ -1,19 +0,0 @@
-require 'test/unit'
-require_relative '../lib/changelog_filter'
-
-class TestChangelogFilter < Test::Unit::TestCase
-	def test_filter_from_string
-		log_entry = "- TEST: This is a test log entry"
-		string = <<-EOF
-			This is a multiline
-			test string
-			#{log_entry}
-			and more text
-			EOF
-		filter = ChangelogFilter.FromString(string)
-		assert(filter.changelog.length == 1,
-			'Filter should contain one changelog entry.')
-		assert(filter.changelog[0].lstrip == log_entry,
-			'Filtered changelog did not contain test entry.')
-	end
-end

data/test/test_tag_list.rb~

@@ -1,12 +0,0 @@
-require 'test/unit'
-require_relative '../lib/tag_list'
-
-class TestTagList < Test::Unit::TestCase
-	def test_list_is_enclosed
-		tags = TagList.new
-		assert(tags.list[0] == 'HEAd',
-			'First element in list should be HEAD')
-		assert(tags.list[-1].length == 40,
-			'Last element in list should be Sha-1 hash')
-	end
-end