create_changelog 1.3.0 → 1.3.1

data/lib/commit_changelog.rb~

@@ -38,7 +38,15 @@ class CommitChangelog
 		@changelog = filter.changelog
 	end
 
-	# Adds changelog information contained in a specific commit message.
+	# 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)

data/lib/git.rb

@@ -16,6 +16,16 @@ 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
@@ -36,6 +46,62 @@ class Git
 		$? != 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)

data/lib/git.rb~

@@ -16,7 +16,23 @@ 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")
@@ -24,18 +40,77 @@ class Git
 	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 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}`

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))

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/version.rb

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

data/lib/version.rb~

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

data/test/test_changelog_filter.rb

@@ -0,0 +1,21 @@
+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.')
+		assert(filter.other_text.size == 3,
+			'Other text should have 3 lines')
+	end
+end

data/test/test_changelog_filter.rb~

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

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

data/test/test_tag_list.rb~

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

metadata

@@ -1,29 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: create_changelog
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Daniel Kraus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-21 00:00:00.000000000 Z
+date: 2015-06-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem-man
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: ronn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.7
 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
@@ -36,10 +78,31 @@ files:
 - README.md
 - bin/ccl
 - bin/ccl~
+- features/changelog_only_recent_changes.feature
+- features/changelog_only_recent_changes.feature~
+- features/changelog_without_recent_changes.feature
+- features/changelog_without_recent_changes.feature~
+- features/commandline.feature~
+- features/complete_changelog.feature
+- features/complete_changelog.feature~
+- features/create_changelog.feature~
+- features/decorate_output.feature
+- features/decorate_output.feature~
+- features/prepare_release.feature~
+- features/step_definitions/git_steps.rb
+- features/step_definitions/git_steps.rb~
+- features/step_definitions/stdout_steps.rb
+- features/step_definitions/stdout_steps.rb~
+- features/support/assertions.rb
+- features/support/assertions.rb~
+- features/support/env.rb
+- features/support/env.rb~
 - lib/array.rb
+- lib/array.rb~
 - lib/changelog.rb
 - lib/changelog.rb~
 - lib/changelog_filter.rb
+- lib/changelog_filter.rb~
 - lib/commit_changelog.rb
 - lib/commit_changelog.rb~
 - lib/git.rb
@@ -50,12 +113,16 @@ files:
 - lib/tag_list.rb~
 - lib/version.rb
 - lib/version.rb~
+- test/test_changelog_filter.rb
+- test/test_changelog_filter.rb~
+- test/test_tag_list.rb
+- test/test_tag_list.rb~
 homepage: https://github.com/bovender/create-changelog
 licenses:
 - Apache License version 2
 metadata: {}
 post_install_message: |
-  create_changelog version 1.3.0 has been installed.
+  create_changelog version 1.3.1 has been installed.
   For usage information, type ccl -h
 rdoc_options: []
 require_paths: