create_changelog 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd381224eb8e14e9bdbb5b5b58dedb315b2390ab
-  data.tar.gz: 3713419603968048a91c5bb5eb02f0df554b263e
+  metadata.gz: dbb6680237cbad0391a0726ceb5bcb78dc4a53c9
+  data.tar.gz: caf83089dd06505fcd8acb43f17f0b5e587f9829
 SHA512:
-  metadata.gz: 1a38fea06c029efe529b4defb5cab2a772df00a554ea5f27eef7250c278eb46e5e686fe06b5b8a33d9c7fd09d8e67b0b6d624e2993262d3fc7785b28801c0837
-  data.tar.gz: a9dc791d30ca360cbf964a8c303da4c9f44e152c858fc12c76c7732b6ddc747b87c7a87fdbb144e8fb1729e06296d0b5163501804f53a512dd17b20eebb8639e
+  metadata.gz: 22bc16e610025ba7d66e02552327c0e17e0271af8f550a7fd425dbf6e8b5fb914ddaf1b02c427aeca65f9354cdbd4fd85d2b860e317f4bb1e34bfb1b47f22efe
+  data.tar.gz: ce631d8ff2693ab82f0946a6d9662dd98b521bd1341e4d2a87a5fd94464e3180cd5f1dbc26d23ff280fd66432b929806b2b32c75978b5520eb13547dfd5d4dd1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+Version 1.2.0 (2015-01-18)
+========================================================================
+
+- FIX: Make "-r", "--recent" option actually work.
+- FIX: Prevent combining -n and -r switch irrespective of order.
+- NEW: Switch "-v", "--version" to print out the current version.
+
+* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
+
+
 Version 1.1.0 (2015-01-18)
 ========================================================================
 

data/README.md

@@ -112,6 +112,8 @@ Live example
 
 <http://xltoolbox.sf.net/changelog-ng>
 
+... or of course [CHANGELOG.md][] in this repository.
+
 
 Code
 ----
@@ -119,6 +121,9 @@ 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>.
+
 
 License
 -------
@@ -142,5 +147,6 @@ License
 [pandoc]: http://johnmacfarlane.net/pandoc
 [nanoc]: http://nanoc.ws
 [kacl]: http://keepachangelog.com
+[CHANGELOG.md]: CHANGELOG.md
 
 <!-- vim: set tw=72 : -->

data/bin/ccl

@@ -28,26 +28,32 @@ def main
 	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 = "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 
-			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
+		opts.on("-v", "--version", "Print version information and exit.") do
+			puts CreateChangelog::VERSION
+			exit
+		end
 	end
 	option_parser.parse!
 
+	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?
 

data/bin/ccl~

@@ -19,7 +19,7 @@
 # The filtered lines are sorted and written to standard out.
 
 require 'optparse'
-require_relative '../lib/changelog.rb'
+require_relative '../lib/create_changelog.rb'
 require_relative '../lib/git.rb'
 require_relative '../lib/version.rb'
 
@@ -28,7 +28,7 @@ def main
 	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 = "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",
@@ -38,16 +38,23 @@ def main
 		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
+		opts.on("-v", "--version", "Print version information and exit.") do
+			puts CreateChangelog::VERSION
+			exit
+		end
 	end
 	option_parser.parse!
 
+	if options[:no_recent] and options[:only_recent]
+			abort "FATAL: Cannot combine --recent and --no-recent" if options[:recent] 
+	end
+
 	Dir.chdir(working_dir) do
 		abort "FATAL: Not a git repository." unless Git.is_git_repository?
 

data/lib/create_changelog.rb

@@ -38,6 +38,9 @@ class Changelog
 	# 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

data/lib/create_changelog.rb~

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

data/lib/version.rb

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

data/lib/version.rb~

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: create_changelog
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Daniel Kraus
@@ -24,11 +24,10 @@ files:
 - bin/ccl~
 - lib/array.rb
 - lib/changelog_filter.rb
-- lib/changelog_filter.rb~
 - lib/commit_changelog.rb
 - lib/create_changelog.rb
+- lib/create_changelog.rb~
 - lib/git.rb
-- lib/git.rb~
 - lib/tag.rb
 - lib/tag_list.rb
 - lib/version.rb

data/lib/changelog_filter.rb~

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

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