vclog 1.8.2 → 1.9.0

data/.ruby

@@ -1,6 +1,6 @@
 ---
 source:
-- profile
+- var
 authors:
 - name: Trans
   email: transfire@gmail.com
@@ -16,6 +16,7 @@ requirements:
 - name: ansi
   version: 1.2+
 - name: confection
+- name: rdoc
 - name: xml-simple
 - name: detroit
   groups:
@@ -50,8 +51,8 @@ revision: 0
 created: '2006-05-09'
 summary: Cross-VCS/SCM ChangeLog Generator
 title: VCLog
-version: 1.8.2
+version: 1.9.0
 name: vclog
 description: VCLog is a cross-VCS/SCM ChangeLog generator.
 organization: Rubyworks
-date: '2011-11-07'
+date: '2011-12-12'

data/.yardopts

@@ -0,0 +1,7 @@
+--title VCLog
+--protected
+--private
+lib/
+-
+[A-Z]*.*
+

data/HISTORY.rdoc

@@ -0,0 +1,207 @@
+= RELEASE HISTORY
+
+== 1.9.0 / 2011-12-12
+
+This is a BIG release and much has changed, so be sure to read the following
+carefully if you've used VClog before.
+
+First of all, the command line interface no longer uses the subcommand pattern.
+Instead independent commands have been created for each use, e.g. `vclog-version`
+instead of `vclog version`. In addition the plain `vclog` command now handles
+both changelog and release history reports. To get a release history insead of
+a changelog, use the `-r` option.
+
+Next up, this release also adds in full commit message support via the `-d`/`--detail`
+option, where as previously some formats were limited to one-line message summaries.
+Also, the `-p`/`--point` option has been added which will split a commit message
+into separate points (points are recognized by astrisks flush to the left margin).
+
+Custom hueristics configuration blocks no longer receive the commit message,
+but the commit object instead, which can be manipulated directly, rather then
+return a limited set of possible changes. This allows for rules to be much more
+flexible.
+
+Since the last release wasn't widely publisized, I also want to mention again that
+configuration is now handled by the `confection` gem, meaning custom heuristics
+must be place in a projects `.confile` or `Confile`. See the latest README for more
+details.
+
+Changes:
+
+* Separate commands and new cli interface.
+* Support for full commit messages.
+* Point option splits commit messages into point messages.
+* Heuristic rules receive commit object instead of message.
+
+
+== 1.8.2 / 2011-12-08
+
+This release changes the way in which vclog is configured to use the Confection
+gem. This means VCLog custom configuration for a project must go in a `vclog do`
+block in the `Confile` or `.confile` project file. In addtion this release
+brings the build config up to date and switches the project over to the
+BSD-2-Clause license.
+
+Changes:
+
+* Use Confection gem for cusomt configs.
+* Modernize build config for latest tools.
+* Switch to BSD-2-Clause license.
+
+
+== 1.8.1 / 2010-11-22
+
+This release corrects the tag dates on Histories. Where possible the tag date is used rather than the commit date (of the most recent commit made relative to the tag). Primarily this effects git repositories --a separate tag date is not supported by all SCMs. This release also fixes a bug in the hg adapter that prevented auto-tagging.
+
+Changes:
+
+* Use tag date instead of commit date in history.
+* Fix typo in hg adapter's autotag method.
+* Add history file option to autotag command.
+
+
+== 1.8.0 / 2010-11-21
+
+Under the hood, VCLog now has a Repo class that acts as a central controller. This has improved the code base substantially and should could to do so as this new design is further embraced. This release also introdces a new `autotag` feature, which makes it possible to "reverse engineer" a Release History file. It will parse the entries from a HISTORY.* file and ensure that corresponding tags exists in the version control system.
+
+Changes:
+
+* Add Repo class which acts as central control.
+* Add autotag feature to ensure release history tags exits.
+
+
+== 1.7.0 / 2010-06-27
+
+In this release the heuristics interface has changed such that the block is passed the commit message and the matchdata, instead of  the previous matchdata splat. The rule can alos return either the sybolic label or a two element array of label and new message, which allows the rule to "massage" the message as needed. This release also improves the git log parser to be much more robust. 
+
+Changes:
+
+* Pass message and matchadata to heuristics rule interface.
+* Improve git log parser, which should handle all possible cases now.
+
+
+== 1.6.1 / 2010-06-23
+
+This release repairs the Atom feed format and adds an RSS feed format. Both formats are nearly conformant with strict validations --only a couple minor issues remain to iron out (such as embedded feed url). Ragardless, they should work fine with feed readers (which are not as strict).
+
+Changes:
+
+* Repair and improve Atom feed format.
+* Add RSS feed format.
+* Fix Git email address value.
+* Add title to HTML Change Log format.
+
+
+== 1.6.0 / 2010-06-22
+
+Previous versions utilized a system of "commit tagging" to identify types of commits. This proved less than optimal --it was unconventional, but worse it was easy to forget to put the proper label in the message. The new version of VClog uses a customizable heuristics systems instead. Rather than be limited to a strict syntax structure, you can write matching rules in .config/vclog/rules.rb that determine the commit type, and set descriptive labels for each type. This makes it very easy to get excellent History output. Also in this release the command-line interface has changed to use subcommands. And the default output format is now an ANSI-color GNU-like format. Use `-f gnu` to get the old default format.
+
+Changes:
+
+* 2 Major Enhancements
+
+  * Heuristics system for categorizing commits
+  * Command-line interface uses subcommands
+
+
+== 1.5.0 / 2010-05-29
+
+This release adds support for Mercurial repositories and Atom newsfeed output format. The commandline inteface has change such that <code>--foramt</code>/<code>-f</code> is used to select the format instead of using the previous per-format options, e.g. use <code>-f xml</code> instead of <code>--xml</code>. This release also includes some subtantial changes under-the-hood --the first of a two part code refactoring process.
+
+Changes:
+
+* 2 Major Enhancements
+
+  * Add Mercurial support
+  * Add Atom feed format
+
+* 1 Minor Enhancement
+
+  * Select format using -f option.
+
+
+== 1.4.0 / 2010-05-26
+
+This release includes some basic improvments and a few bug fixes. The primary change you might encounter is the need to use -e or --extra in order to see the detailed Changes list in the Release History. Also changed 'git-log' to 'git log', as it seems the latest versions of git does not support the many executables any longer. SVN support requires xmlsimple library. Note also that SVN support is lack luster at this time becuase it hits the server every time an 'svn log' command is issued which is done once for each tag when a history is generated (any one know a better way?).
+
+Changes:
+
+* 1 Minor Enhancement
+
+  * Use -e or --extra to see Changes list in release history.
+  * Use xmlsimple for parsing SVN log output.
+  * Improve git log parsing with --pretty option.
+
+* 2 Bug Fixes
+
+  * Sort release tags in correct order.
+  * Change 'git-log' to 'git log'.
+
+
+== 1.3.0 / 2010-02-08
+
+For the an end-user the only significant change is the support of 'label:' notation for commit labels. I have found that I am much more apt to use them if they come first in the commit message and that some developers already use the 'label:' notation to specify 'system module' effected --a useful system of labeling.
+
+Changes:
+
+* 1 Major Enhancement
+
+  * Support 'label:' fromat commit types
+
+* 2 Implementation Enhancements
+
+  * Adjust location of plugins for latest version of Plugin gem.
+  * Use Erb as template system for all formats.
+
+* 1 Bug Fix
+
+  * Corrected error for --current and --bump commands.
+
+
+== 1.2.0 / 2009-10-26
+
+Version 1.2 overhuals the internals so that History output is based on scm tags, not on a pre-existing history file. This is really the proper way to go about it and those who use it will, I think, be happily surprised at how it promotes good practices for the maintenance of History files. This overhaul led to substantial changes in the command-line interface.
+
+Changes:
+
+* 2 Major Enhancements
+
+  * Rewrote History class.
+  * Changed command-line interface.
+
+
+== 1.1.0 / 2009-10-23
+
+This release adds yaml and json formats an improves
+the command.
+
+Changes:
+
+* 2 Major Enhancements
+
+    * Added YAML format.
+    * Added JSON format.
+
+* 1 Minor Enhancements
+
+    * Use OptionParser instead of GetoptLong.
+
+
+== 1.0.0 / 2009-10-13
+
+This is the first "production" release of VCLog.
+
+* 2 Major Enhancements
+
+    * Improved command line interface.
+    * Added output option to save changelog.
+
+
+== 0.1.0 / 2009-08-17
+
+This is the initial version of vclog.
+
+* 1 Major Enhancement
+
+    * Happy Birthday
+

data/README.rdoc

@@ -1,7 +1,8 @@
 = VCLog
 
-{Homepage}[http://rubyworks.github.com/vclog] |
+{Website}[http://rubyworks.github.com/vclog] |
 {Source Code}[http://github.com/rubyworks/vclog] |
+{Report Issue}[http://github.com/rubyworks/vclog/issues] |
 {Mailing List}[http://googlegroups.com/group/rubyworks-mailinglist]
 
 {<img src="http://travis-ci.org/rubyworks/vclog.png" />}[http://travis-ci.org/rubyworks/vclog]
@@ -32,15 +33,16 @@ To generate an a different format use -f:
 
 === Creating Release Histories
 
-To get a release history specify 'history' or 'release' as the subcommand.
+To get a release history specify `-r`, `--release` or `--history` option.
 
-  $ vclog history
+  $ vclog -r
 
 Again the default format is an ANSI colored GNU-like text style.
 
-Unlike Changelogs, Histories group changes by tags. The tag message is
-used as the release note. If the underlying SCM doesn't support 
-tag messages that the last commit message before the tag is used.
+Unlike change logs, release histories group changes by tags. The tag
+message is used as the release note. If the underlying SCM doesn't
+support tag messages than the message of the first commit prior to
+the tag is used.
 
 See 'vclog help' for more options.
 
@@ -49,12 +51,12 @@ See 'vclog help' for more options.
 VCLog can also be used to intelligently bump versions. To see the current
 tag version:
 
-  $ vclog version
+  $ vclog-version
   1.1.0
 
 To see the next reasonable version based on current changes:
 
-  $ vclog bump
+  $ vclog-bump
   1.2.0
 
 VCLog can determine the appropriate version based on commit level. Any
@@ -64,30 +66,47 @@ level only bump the patch level.
 
 === Writing Heuristics
 
-You can create custom heuristics for your project in a vclog configuration
-file. VCLog will look for a `.vclog` file or a `vclog` file in `.config/`,
-`config/`, `task/` or tasks/` directory (the file can optionally end in `.rb`).
+You can configure custom log heuristics for your project. VCLog uses
+the {confection gem}[http://rubyworks.github.com/confection] to
+handle configuration, and will look for a `.confile` or `Confile` in
+which to find a `vclog` section.
 
-In the file you define rules in Ruby script for labeling commits based
-on the commit message.
-
-  on /updated? (README|VERSION|MANIFEST)/ do
-    :admin
+  vclog do
+    ...
   end
 
-These rules can also "massage" the commit message for output.
+Within this block we can define rules via the #on method.
 
-  on /^admin:/ do |matchdata|
-    [:admin, matchdate.post_match]
-  end
+    on /updated? (README|VERSION|MANIFEST)/ do |commit|
+      commit.label = "Adminstrative Changes"
+      commit.level = -3
+    end
+
+To make things easier we can setup commit types. Types make it easier
+to categorize commits, assigning them labels and levels base on the 
+type name. Use #type in the rules to specify the level and label of 
+a commit type.
+
+    type :admin,  -2, "Administrave Changes"
+
+    on /updated? (README|VERSION|MANIFEST)/ do |commit|
+      commit.type = :admin
+    end
 
-Labels are used to categorize and assign levels to commits. Use #set in
-the rules.rb to specify the level and description of a commit label.
+These rules can also "massage" the commit message.
 
-  set :admin, -2, "Administrative Adjustment"
+    on /\Aadmin:/ do |commit, matchdata|
+      commit.type    = :admin
+      commit.message = matchdate.post_match
+    end
 
+Lastly, we can customize the colorization of the certain formats via #colors
+method.
 
-== NOTE ABOUT SUBVERSION
+    colors :blue, :cyan, :green, :yellow, :red
+
+
+== SUBVERSION ISSUES
 
 Because Subversion is a centralized version control system, it contacts
 the server every time 'svn log' is run. For this reason, having vclog
@@ -106,8 +125,6 @@ Please see HISTORY file.
 
 Copyright (c) 2008 Rubyworks
 
-VCLog is distributable in accordance with the terms of the BSD-2-Clause license.
+VCLog is distributable in accordance with the terms of the *FreeBSD* license.
 
 See COPYING.rdoc for details.
-
-

data/bin/vclog

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
-require 'vclog/cli'
-VCLog.cli(*ARGV)
+
+require 'vclog/cli/log'
+
+VCLog::CLI::Log.run(ARGV)
 

data/bin/vclog-autotag

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'vclog/cli/autotag'
+
+VCLog::CLI::Autotag.run(ARGV)
+

data/bin/vclog-bump

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'vclog/cli/bump'
+
+VCLog::CLI::Bump.run(ARGV)
+

data/bin/vclog-formats

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'vclog/cli/formats'
+
+VCLog::CLI::Formats.run(ARGV)
+

data/bin/vclog-version

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'vclog/cli/version'
+
+VCLog::CLI::Version.run(ARGV)
+

data/lib/vclog.rb

@@ -1,6 +1,6 @@
 module VCLog
   require 'vclog/metadata'
   require 'vclog/repo'
+  #require 'vclog/cli'
 end
 
-# VCLog Copyright (c) 2008 Thomas Sawyer

data/lib/vclog.yml

@@ -0,0 +1,58 @@
+---
+source:
+- var
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2009'
+  license: BSD-2-Clause
+replacements: []
+alternatives: []
+requirements:
+- name: facets
+  version: 2.4+
+- name: ansi
+  version: 1.2+
+- name: confection
+- name: rdoc
+- name: xml-simple
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: citron
+  groups:
+  - test
+  development: true
+- name: ae
+  groups:
+  - test
+  development: true
+- name: cucumber
+  groups:
+  - test
+  development: true
+- name: aruba
+  groups:
+  - test
+  development: true
+dependencies: []
+conflicts: []
+repositories: []
+resources:
+  home: http://rubyworks.github.com/vclog
+  code: http://github.com/rubyworks/vclog
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2006-05-09'
+summary: Cross-VCS/SCM ChangeLog Generator
+title: VCLog
+version: 1.9.0
+name: vclog
+description: VCLog is a cross-VCS/SCM ChangeLog generator.
+organization: Rubyworks
+date: '2011-12-12'