vclog 1.8.0 → 1.8.1

data/HISTORY.rdoc

@@ -1,6 +1,17 @@
 = RELEASE HISTORY
 
-== 1.8.0 / 2010-11-20
+== 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.
 

data/README.rdoc

@@ -1,7 +1,8 @@
 = VCLog
 
-* home: http://proutils.github.com/vclog
-* work: http://github.com/proutils/vclog
+* home: http://rubyworks.github.com/vclog
+* code: http://github.com/rubyworks/vclog
+* talk: http://googlegroups.com/group/rubyworks-mailinglist
 
 
 == DESCRIPTION

data/lib/vclog/adapters/abstract.rb

@@ -3,6 +3,7 @@ module Adapters
 
   require 'time'
   require 'pathname'
+  require 'tempfile'
 
   require 'vclog/formatter'
   require 'vclog/changelog'
@@ -56,7 +57,7 @@ module Adapters
 
     #
     def tags
-      @tags ||= extract_tags.map{ |t| Tag===t ? t : Tag.new(*t) }
+      @tags ||= extract_tags
     end  
 
     #
@@ -71,11 +72,13 @@ module Adapters
     def all_changes
       @all_changes ||= (
         changes = []
-        extract_changes.each do |c|
-          raise "how did this happen?" if Change == c
-          rev, date, who, msg = *c
-          type, level, label, nmsg = *heuristics.lookup(msg)
-          changes << Change.new(rev, date, who, nmsg||msg, type, level, label)
+        extract_changes.each do |change|
+          #raise "how did this happen?" if Change == c
+          #rev, date, who, msg = *c
+          #type, level, label, nmsg = *heuristics.lookup(msg)
+          #Change.new(rev, date, who, nmsg||msg, type, level, label)
+          change.apply_heuristics(heuristics)
+          changes << change 
         end
         changes
       )     
@@ -175,6 +178,13 @@ module Adapters
       /(v|\d)/i =~ tag_name
     end
 
+    #
+    def tempfile(name, content)
+      mfile = Tempfile.new(name)
+      File.open(mfile.path, 'w'){ |f| f << content }
+      mfile.path
+    end
+
 =begin
     # Looks for a "[type]" indicator at the end of the commit message.
     # If that is not found, it looks at front of message for

data/lib/vclog/adapters/git.rb

@@ -1,5 +1,4 @@
 require 'vclog/adapters/abstract'
-require 'tempfile'
 
 module VCLog
 module Adapters
@@ -27,9 +26,9 @@ module Adapters
       #changes = changelog.split(/^commit/m)
       changes.shift # throw the first (empty) entry away
       changes.each do |entry|
-        date, who, rev, msg = entry.split('|~|')
+        date, who, id, msg = entry.split('|~|')
         date = Time.parse(date)
-        list << [rev, date, who, msg]
+        list << Change.new(:id=>id, :date=>date, :who=>who, :msg=>msg)
       end
       list
     end
@@ -66,20 +65,21 @@ module Adapters
           info.lines.to_a[1..-1].each do |line|
             case line
             when /^Tagger:/
-              who  = $'
+              who  = $'.strip
             when /^Date:/
-              date = $'
+              date = $'.strip
             else
               msg << line
             end
           end
           msg = msg.strip
           info = `git show #{tag}^ --pretty=format:"%ci|~|%H|~|"`
-          date, rev, *_ = *info.split('|~|')
+          cdate, id, *_ = *info.split('|~|')
         else
           info = `git show #{tag} --pretty=format:"%cn|~|%ce|~|%ci|~|%H|~|%s|~|"`
-          who, email, date, rev, msg, *_ = *info.split('|~|')
-          who = who + ' ' + email
+          who, email, cdate, id, msg, *_ = *info.split('|~|')
+          who  = who + ' ' + email
+          date = cdate
         end          
 
         #if $DEBUG
@@ -87,7 +87,7 @@ module Adapters
         #  puts
         #end
 
-        list << [tag, rev, date, who, msg]
+        list << Tag.new(:name=>tag, :date=>date, :who=>who, :msg=>msg, :commit_id=>id, :commit_date=>cdate)
       end
       list
     end
@@ -120,12 +120,10 @@ module Adapters
 
     # Create a tag for the given commit reference.
     def tag(ref, label, date, message)
-      mfile = Tempfile.new("message")
-      mfile.open{ |f| f << message }
+      file = tempfile("message", message)
+      date = date.strftime('%Y-%m-%d 23:59') unless String===date
 
-      date  = date.strftime('%Y-%m-%d 23:59') unless String===date
-
-      cmd = %[GIT_AUTHOR_DATE='#{date}' GIT_COMMITTER_DATE='#{date}' git tag -a -F '#{mfile.path}' #{label} #{ref}]
+      cmd = %[GIT_AUTHOR_DATE='#{date}' GIT_COMMITTER_DATE='#{date}' git tag -a -F '#{file}' #{label} #{ref}]
       puts cmd if $DEBUG
       `#{cmd}` unless $DRYRUN
     end

data/lib/vclog/adapters/hg.rb

@@ -9,19 +9,18 @@ module Adapters
   class Hg < Abstract
 
     # Collect changes.
-    #
     def extract_changes
       list = []
       changelog = `hg log -v`.strip
       changes = changelog.split("\n\n\n")
       changes.each do |entry|
-        list << parse_entry(entry)
+        id, date, who, msg = *parse_entry(entry)
+        list << Change.new(:id=>id, :date=>date, :who=>who, :msg=>msg)
       end
       list
     end
 
     # Collect tags.
-    #
     def extract_tags
       list = []
       if File.exist?('.hgtags')
@@ -29,7 +28,7 @@ module Adapters
           rev, tag = line.strip.split(' ')
           entry = `hg log -v -r #{rev}`.strip
           rev, date, who, msg, type = parse_entry(entry)
-          list << [tag, rev, date, who, msg]
+          list << Tag.new(:name=>tag, :id=>rev, :date=>date, :who=>who, :msg=>msg)
         end
       end
       list
@@ -57,12 +56,10 @@ module Adapters
 
     # TODO: Will multi-line messages work okay this way?
     def tag(ref, label, date, msg)
-      mfile = Tempfile.new("message")
-      mfile.open{ |f| f << msg }
-
+      file = tempfile("message", msg)
       date = date.strftime('%Y-%m-%d') unless String===date
 
-      cmd  = %[hg tag -r #{ref} -d #{date} -m "$(cat #{mfile.path})" #{label}]
+      cmd  = %[hg tag -r #{ref} -d #{date} -m "$(cat #{file})" #{label}]
 
       puts cmd if $DEBUG
       `#{cmd}` unless $DRYRUN

data/lib/vclog/adapters/svn.rb

@@ -21,7 +21,7 @@ module Adapters
       super(root)
     end
 
-    #
+    # Extract changes.
     def extract_changes
       log = []
 
@@ -41,13 +41,13 @@ module Adapters
 
         date = Time.parse(date)
 
-        log << [rev, date, who, msg]
+        log << Change.new(:id=>rev, :date=>date, :who=>who, :msg=>msg)
       end
 
       log
     end
 
-    #
+    # Extract tags.
     def extract_tags
       list = []
       tagdir = tag_directory
@@ -78,7 +78,7 @@ module Adapters
         msg  = [commit["msg"]].flatten.compact.join('').strip
         date = [commit["date"]].flatten.compact.join('').strip
 
-        list << [name, rev, date, who, msg]
+        list << Tag.new(:name=>name, :id=>rev, :date=>date, :who=>who, :msg=>msg)
       end
       list
     end
@@ -127,10 +127,9 @@ module Adapters
       info['Repository UUID']
     end
 
-    #
+    # TODO: Need to effect svn tag date. How?
     def tag(ref, label, date, message)
-      mfile = Tempfile.new("message")
-      mfile.open{ |f| f << message }
+      file = tempfile("message", message)
 
       Dir.chdir(root) do
         cmd = %[svn copy -r #{ref} -F "#{mfile.path}" . #{tag_directory}/#{label}]

data/lib/vclog/change.rb

@@ -2,15 +2,15 @@ require 'vclog/kernel'
 
 module VCLog
 
-  # = Change Log Entry class
+  # The Change class models an extry in a change log.
   #
   class Change
 
     include Comparable
 
-    attr_accessor :author
+    attr_accessor :id
     attr_accessor :date
-    attr_accessor :revision
+    attr_accessor :author
     attr_accessor :message
 
     attr_accessor :type
@@ -18,14 +18,10 @@ module VCLog
     attr_accessor :label
 
     #
-    def initialize(rev, date, author, message, type, level, label)
-      self.revision = rev
-      self.date     = date
-      self.author   = author
-      self.message  = message
-      self.type     = type
-      self.level    = level
-      self.label    = label
+    def initialize(data={}) #rev, date, author, message, type, level, label
+      data.each do |k,v|
+        __send__("#{k}=", v)
+      end
     end
 
     #
@@ -33,9 +29,28 @@ module VCLog
       @author = author.strip
     end
 
-    # Alternate name for revision.
-    alias_method :rev,  :revision
-    alias_method :rev=, :revision=
+    #
+    def date=(date)
+      @date = parse_date(date)
+    end
+
+    # Alternate name for id.
+    alias_method :rev,  :id
+    alias_method :rev=, :id=
+
+    # Alternate name for id.
+    alias_method :revision,  :id
+    alias_method :revision=, :id=
+
+    # Alternate name for message.
+    alias_method :msg,  :message
+    alias_method :msg=, :message=
+
+
+    # Alias for author.
+    alias_method :who,  :author
+    alias_method :who=, :author=
+
 
     #def clean_type(type)
     #  case type.to_s
@@ -94,6 +109,15 @@ module VCLog
     #  to_h.to_yaml(*args)
     #end
 
+    def apply_heuristics(heuristics)
+      type, level, label, msg = *heuristics.lookup(message)
+
+      self.type    = type
+      self.level   = level
+      self.label   = label
+      self.message = msg || @message
+    end
+
 =begin
     # Looks for a "[type]" indicator at the end of the commit message.
     # If that is not found, it looks at front of message for
@@ -118,6 +142,17 @@ module VCLog
     end
 =end
 
-  end #class Entry
+    private
+
+    def parse_date(date)
+      case date
+      when Time
+        date
+      else
+        Time.parse(date.to_s)
+      end
+    end
+
+  end
 
 end

data/lib/vclog/cli/autotag.rb

@@ -21,7 +21,8 @@ module CLI
         opt.separator(" ")
         opt.separator("SPECIAL OPTIONS:")
         opt.on('--prefix', '-p', 'tag label prefix'){ options[:prefix] = true }
-        opt.on('--force', '-f', 'perform tagging without confirmation'){ options[:force] = true }
+        opt.on('--file'  , '-f FILE', 'specify history file'){ options[:history_file] = file }
+        opt.on('--force' , '-y', 'perform tagging without confirmation'){ options[:force] = true }
         opt.on('--dryrun', '-n', 'run in dryrun mode'){ $DRYRUN = true }
       end
     end

data/lib/vclog/history.rb

@@ -71,9 +71,9 @@ module VCLog
 
         #ver  = vcs.bump(version)
         user = vcs.user
-        time = ::Time.now
+        time = ::Time.now + (3600 * 24) # one day ahead
 
-        tags << Tag.new(nil, 'current', time, user, "Current Development")
+        tags << Tag.new(:name=>'HEAD', :id=>'HEAD', :date=>time, :who=>user, :msg=>"Current Development")
 
         # TODO: Do we need to add a Time.now tag?
         # add current verion to release list (if given)
@@ -91,8 +91,8 @@ module VCLog
         delta = []
         last  = nil
         tags.each do |tag|
-          delta << [tag, [last, tag.date]]
-          last = tag.date
+          delta << [tag, [last, tag.commit_date]]
+          last = tag.commit_date
         end
         # gather changes for each delta
         delta.each do |tag, (started, ended)|

data/lib/vclog/history_file.rb

@@ -9,8 +9,8 @@ module VCLog
     FILE = '{HISTORY,HISTORY.*}'
 
     LINE = /^[=#]/
-    VERS = /(\d+\.)+\d+/
-    DATE = /(\d+\-)+\d+/
+    VERS = /(\d+[._])+\d+/
+    DATE = /(\d+[-])+\d+/
 
     #
     CASEFOLD = File::FNM_CASEFOLD
@@ -55,7 +55,7 @@ module VCLog
         index = desc.index(/^Changes:/) || desc.index(/^\*/) || desc.size
         desc = desc[0...index].strip.fold
         #[vers, date, desc]
-        Tag.new(vers, nil, date, nil, desc)
+        Tag.new(:name=>vers, :date=>date, :msg=>desc)
       end
     end
 

data/lib/vclog/meta/package

@@ -1,6 +1,6 @@
 name    : vclog
-date    : 2010-11-19
-version : 1.8.0
+date    : 2010-11-22
+version : 1.8.1
 
 requires:
   - facets 2.4+

data/lib/vclog/repo.rb

@@ -97,7 +97,7 @@ module VCLog
 
     # Access to Repo's HISTORY file.
     def history_file
-      @history_file ||= HistoryFile.new(root)
+      @history_file ||= HistoryFile.new(options[:history_file] || root)
     end
 
     # Read history file and make a commit tag for any release not already

data/lib/vclog/tag.rb

@@ -1,19 +1,19 @@
 module VCLog
 
   class Tag
-    attr_accessor :revision
     attr_accessor :name
     attr_accessor :date
     attr_accessor :author
     attr_accessor :message
 
+    attr_accessor :commit
+
     #
-    def initialize(name, rev, date, author, message)
-      self.name     = name
-      self.revision = rev
-      self.date     = date
-      self.author   = author
-      self.message  = message
+    def initialize(data={})
+      @commit = Change.new
+      data.each do |k,v|
+        __send__("#{k}=", v)
+      end
     end
 
     #
@@ -22,21 +22,27 @@ module VCLog
     end
 
     #
-    alias_method :label, :name
+    alias_method :label,  :name
+    alias_method :label=, :name=
+
+    #
+    alias_method :tag,  :name
+    alias_method :tag=, :name=
 
     #
     def author=(author)
       @author = author.to_s.strip
     end
 
+    alias_method :tagger,  :author
+    alias_method :tagger=, :author=
+
+    alias_method :who,  :author
+    alias_method :who=, :author=
+
     #
     def date=(date)
-      case date
-      when Time
-        @date = date
-      else
-        @date = Time.parse(date.to_s)
-      end
+      @date = parse_date(date)
     end
 
     #
@@ -44,8 +50,37 @@ module VCLog
       @message = msg.strip
     end
 
-    alias_method :tagger, :author
-    alias_method :tagger=, :author=
+    alias_method :msg,  :message
+    alias_method :msg=, :message=
+
+
+    #
+    def commit_id
+      @commit.id
+    end
+
+    #
+    def commit_id=(id)
+      @commit.id = id
+    end
+
+    #
+    alias_method :id,  :commit_id
+    alias_method :id=, :commit_id=
+
+    #
+    alias_method :revision,  :commit_id
+    alias_method :revision=, :commit_id=
+
+    #
+    def commit_date
+      @commit.date ||= date
+    end
+
+    #
+    def commit_date=(date)
+      @commit.date = date
+    end
 
     #
     def to_json
@@ -72,6 +107,18 @@ module VCLog
       return -1 if name == 'HEAD'
       other.name <=> name
     end
+
+    private
+
+    def parse_date(date)
+      case date
+      when Time
+        date
+      else
+        Time.parse(date.to_s)
+      end
+    end
+
   end
 
 end

data/lib/vclog/templates/history.ansi.rb

@@ -8,7 +8,12 @@ history.releases.sort.each do |release|
 
   tag = release.tag
 
-  out << "\n#{tag.name} / #{tag.date.strftime('%Y-%m-%d')}".ansi(:bold)
+  # TODO: support verbose option
+  #if verbose?
+  #  out << "\n#{tag.name} / #{tag.date.strftime('%Y-%m-%d %H:%M')}".ansi(:bold)
+  #else
+    out << "\n#{tag.name} / #{tag.date.strftime('%Y-%m-%d')}".ansi(:bold)
+  #end
 
   out << "\n#{tag.message.strip} (#{tag.author})"
 

data/man/man1/vclog-autotag.1

@@ -15,7 +15,13 @@ Ensure all HISTORY file entries have corresponding commit tags in the version co
 .SH "OPTIONS"
 .
 .IP "\(bu" 4
-\fB\-\-force\fR, \fB\-f\fR Creatie tags without asking for confirmation\.
+\fB\-\-force\fR, \fB\-y\fR Create tags without asking for confirmation\.
+.
+.IP "\(bu" 4
+\fB\-\-prefix\fR, \fB\-p PREFIX\fR Specify a prefix to add to version tags\. Typically this will be the letter \'v\'\.
+.
+.IP "\(bu" 4
+\fB\-\-file\fR, \fB\-f FILE\fR Specify a specific history file to use\. This is useful is the history file does not conform to the usual naming convention of \fBHISTORY\.*\fR\.
 .
 .IP "" 0
 .

data/meta/package

@@ -1,6 +1,6 @@
 name    : vclog
-date    : 2010-11-19
-version : 1.8.0
+date    : 2010-11-22
+version : 1.8.1
 
 requires:
   - facets 2.4+

data/ronn/vclog-autotag.ronn

@@ -12,8 +12,17 @@ the version control system.
 
 ## OPTIONS
 
-  * `--force`, `-f`
-    Creatie tags without asking for confirmation.
+  * `--force`, `-y`
+    Create tags without asking for confirmation.
+
+  * `--prefix`, `-p PREFIX`
+    Specify a prefix to add to version tags. Typically
+    this will be the letter 'v'.
+
+  * `--file`, `-f FILE`
+    Specify a specific history file to use. This is useful
+    is the history file does not conform to the usual naming
+    convention of `HISTORY.*`.
 
 ## SEE ALSO
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vclog
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 53
   prerelease: false
   segments: 
   - 1
   - 8
-  - 0
-  version: 1.8.0
+  - 1
+  version: 1.8.1
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-20 00:00:00 -05:00
+date: 2010-11-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency