vclog 1.6.1 → 1.7.0

data/HISTORY.rdoc

@@ -1,5 +1,15 @@
 = RELEASE HISTORY
 
+== 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).

data/README.rdoc

@@ -12,17 +12,73 @@ It currently supports Git, Hg and (limited) Subversion.
 
 == SYNOPSIS
 
-The default format is a ANSI colored GNU-like text style.
+=== Creating Changelogs
+
+The default output is a ANSI colored GNU-like changelog.
 From a repository's root directory try:
 
   $ vclog
 
-To generate an XML formatted changelog use:
+The is the same as specifying 'changelog' or 'log'.
+
+  $ vclog log
+
+To generate an a different format use -f:
 
   $ vclog -f xml
 
+=== Creating Release Histories
+
+To get a release history specify 'history' or 'release' as the subcommand.
+
+  $ vclog history
+
+Again the default format is a 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.
+
 See 'vclog help' for more options.
 
+=== Bumping Versions
+
+VCLog can also be used to intelligently bump versions. To see the current
+tag version:
+
+  $ vclog version
+  1.1.0
+
+To see the next reasonable version based on current changes:
+
+  $ vclog bump
+  1.2.0
+
+VCLog can determine the appropriate version based on commit level. Any
+commit with a level greater than 1 will bump the major number, while any
+commit with a level of 0 or 1 will bump the minor number. All lower
+level only bump the patch level.
+
+=== Writing Heuristics
+
+In your projects .vclog/rules.rb or .config/vclog/rules.rb file, you
+can create rules for labeling commit messages bassed on commit message.
+
+  on /updated? (README|VERSION|MANIFEST)/ do
+    :admin
+  end
+
+These rules can a also "massage" the commit message for output.
+
+  on /^admin:/ do |matchdata|
+    [:admin, matchdate.post_match]
+  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.
+
+  set :admin, -2, "Administrative Adjustment"
+
 
 == NOTE ABOUT SUBVSERION
 

data/VERSION

@@ -1,5 +1,5 @@
 name : vclog
 major: 1
-minor: 6
-patch: 1
-date : 2010-06-23
+minor: 7
+patch: 0
+date : 2010-06-27

data/lib/vclog/adapters/abstract.rb

@@ -38,15 +38,16 @@ module Adapters
     end
 
     #
+    # TODO: possbile to move heuristics lookup into Change class?
     def changes
       @changes ||= (
         changes = []
         extract_changes.each do |c|
           raise "how did this happen?" if Change == c
           rev, date, who, msg = *c
-          type, level, label = *heuristics.lookup(msg)
+          type, level, label, nmsg = *heuristics.lookup(msg)
           next if level < self.level
-          changes << Change.new(rev, date, who, msg, type, level, label)
+          changes << Change.new(rev, date, who, nmsg||msg, type, level, label)
         end
         changes
       )

data/lib/vclog/adapters/git.rb

@@ -11,8 +11,8 @@ module Adapters
     #
     def extract_changes
       list = []
-      changelog = `git log --pretty=format:"---%ci|~|%aN|~|%H|~|%s"`.strip
-      changes = changelog.split("---")
+      changelog = `git log --pretty=format:"\036|||%ci|~|%aN|~|%H|~|%s"`.strip
+      changes = changelog.split("\036|||")
       #changes = changelog.split(/^commit/m)
       changes.shift # throw the first (empty) entry away
       changes.each do |entry|
@@ -40,21 +40,34 @@ module Adapters
       tags = `git tag -l`
       tags.split(/\s+/).each do |tag|
         next unless version_tag?(tag) # only version tags
+        who, date, rev, msg = nil, nil, nil, nil
         info = `git show #{tag}`
-        md = /\Atag(.*?)\n(.*?)^commit/m.match(info)
-        who, date, *msg = *md[2].split(/\n/)
-        who  = who.split(':')[1].strip
-        date = date[date.index(':')+1..-1].strip
-        msg  = msg.join("\n")
+        info, *_ = info.split(/^(commit|diff|----)/)
+        if /\Atag/ =~ info
+          msg = ''
+          info.lines.to_a[1..-1].each do |line|
+            case line
+            when /^Tagger:/
+              who  = $'
+            when /^Date:/
+              date = $'
+            else
+              msg << line
+            end
+          end
+          msg = msg.strip
+          info = `git show #{tag}^ --pretty=format:"%ci|~|%H|~|"`
+          date, rev, *_ = *info.split('|~|')
+        else
+          info = `git show #{tag} --pretty=format:"%cn|~|%ce|~|%ci|~|%H|~|%s|~|"`
+          who, email, date, rev, msg, *_ = *info.split('|~|')
+          who = who + ' ' + email
+        end          
 
-        info = `git show #{tag}^ --pretty=format:"%ci|~|%H|~|"`
-        date, rev, *_ = *info.split('|~|')
-
-        #md = /\Atag(.*?)\n(.*?)^commit/m.match(info)
-        #_who, _date, *_msg = *md[2].split(/\n/)
-        #_who  = _who.split(':')[1].strip
-        #_date = _date[_date.index(':')+1..-1].strip
-        #_msg  = _msg.join("\n")
+        #if $DEBUG
+        #  p who, date, rev, msg
+        #  puts
+        #end
 
         list << [tag, rev, date, who, msg]
       end

data/lib/vclog/cli/abstract.rb

@@ -22,9 +22,10 @@ module CLI
       [name.split('::').last.downcase]
     end
 
-    #
+    # TODO: change +extra+ to +summarize+ and reverse boolean value.
     def initialize
       @options = OpenStruct.new
+      @options.extra = true
     end
 
     #
@@ -65,8 +66,8 @@ module CLI
       parser.on('--title', '-t TITLE', "document title") do |string|
         options.title = string
       end
-      parser.on('--detail', '-d', "provide details") do
-        options.extra = true
+      parser.on('--summarize', '-s', "produce summary output") do
+        options.extra = false
       end
       parser.on('--id', "include revision id") do
         options.revision = true

data/lib/vclog/formatter.rb

@@ -85,7 +85,7 @@ module VCLog
 
       case File.extname(tmp_file)
       when '.rb'
-        eval(tmp, binding)
+        eval(tmp, binding, tmp_file)
       when '.erb'
         erb = ERB.new(tmp, nil, '<>')
         erb.result(binding)

data/lib/vclog/heuristics.rb

@@ -27,17 +27,18 @@ module VCLog
 
     #
     def lookup(message)
-      type = nil
-      @rules.find{ |rule| type = rule.call(message) }
+      type_msg = nil
+      @rules.find{|rule| type_msg = rule.call(message)}
+      type, msg = *type_msg
       if type
         type = type.to_sym
         if @labels.key?(type)
-           @labels[type].to_a
+           @labels[type].to_a + [msg || message]
         else
-          [type, 0, "#{type.to_s.capitalize} Enhancements"]
+          [type, 0, "#{type.to_s.capitalize} Enhancements", msg || message]
         end
       else
-        [nil, 0, 'General Enhancements']
+        [nil, 0, 'General Enhancements', msg || message]
       end
     end
 
@@ -74,14 +75,23 @@ module VCLog
 
     #
     class Rule
+      #
       def initialize(pattern, &block)
         @pattern = pattern
         @block   = block        
       end
 
+      # Process the rule.
       def call(message)
-        if md = @pattern.match(message)
-          @block.call(*md[1..-1])
+        if matchdata = @pattern.match(message)
+          case @block.arity
+          when 0
+            @block.call
+          when 1
+            @block.call(matchdata)
+          else
+            @block.call(message, matchdata)
+          end
         else
           nil
         end

data/lib/vclog/heuristics/default.rb

@@ -1,20 +1,24 @@
 set :major,  1, "Major Enhancements"
+set :bug,    0, "Bug Fixes"
 set :minor, -1, "Minor Enhancements"
+set :doc,   -1, "Documentation Changes"
 set :admin, -2, "Administrative Changes"
 
-on /updated? (README|PROFILE|PACKAGE|VERSION|MANIFEST)/ do
-  :admin
+on /^(\w+):/ do |msg, md|
+  word = md[1]
+  [word.to_sym, md.post_match]
 end
 
-on /bump(ed)? version/ do
-  :admin
+on /\[(\w+)\]\s*$/ do |msg, md|
+  word = md[1]
+  [word.to_sym, md.pre_match]
 end
 
-on /^(\w+):/ do |word|
-  word.to_sym
+on /updated? (README|PROFILE|PACKAGE|VERSION|MANIFEST)/ do
+  :admin
 end
 
-on /\[(\w+)\]\s*$/ do |word|
-  word.to_sym
+on /(bump|bumped|prepare) version/ do
+  :admin
 end
 

data/lib/vclog/history.rb

@@ -93,7 +93,6 @@ module VCLog
           delta << [tag, [last, tag.date]]
           last = tag.date
         end
-
         # gather changes for each delta
         delta.each do |tag, (started, ended)|
           if started

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vclog
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 1
-  - 6
-  - 1
-  version: 1.6.1
+  - 7
+  - 0
+  version: 1.7.0
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-23 00:00:00 -04:00
+date: 2010-06-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency