vclog 1.1 → 1.2

data/HISTORY.md

@@ -1,10 +1,30 @@
 # RELEASE HISTORY
 
+## 1.2 / 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 / 2009-10-23
 
 This release adds yaml and json formats an improves
 the command.
 
+Changes:
+
 * 2 Major Enhancements
 
     * Added YAML format.

data/MANIFEST

@@ -5,9 +5,13 @@ README
 TODO
 bin/vclog
 lib/vclog
+lib/vclog/change.rb
 lib/vclog/changelog.rb
-lib/vclog/command.rb
+lib/vclog/cli.rb
 lib/vclog/facets.rb
+lib/vclog/history.rb
+lib/vclog/release.rb
+lib/vclog/tag.rb
 lib/vclog/vcs
 lib/vclog/vcs.rb
 lib/vclog/vcs/darcs.rb

data/TODO

@@ -1,5 +1,17 @@
 = TODO
 
+== Support Markdown and RDoc release output styles
+
+Right now its all RDoc.
+
+== Imporved parsing flexability
+
+In general parsing hueristics need to be imporved. Some specifics:
+
+* Need to support relase comments.
+* Need to recognize "Changes:" marker
+
+
 == Typed option needs work
 
 It produced no results sometimes. Fix or deprecate.

data/bin/vclog

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-load 'vclog/command'
+load 'vclog/cli'
 VCLog.run
 

data/lib/vclog/change.rb

@@ -0,0 +1,108 @@
+module VCLog
+
+  # = Change Log Entry class
+  #
+  class Change
+
+    include Comparable
+
+    attr_accessor :author
+    attr_accessor :date
+    attr_accessor :revision
+    attr_accessor :message
+    attr_accessor :type
+
+    #
+    def initialize(rev, date, author, message, type=nil)
+      self.revision = rev      #opts[:revison] || opts[:rev]
+      self.date     = date     #opts[:date]    || opts[:when]
+      self.author   = author   #opts[:author]  || opts[:who]
+      self.type     = type     #opts[:type]
+      self.message  = message  #opts[:message] || opts[:msg]
+    end
+
+    #
+    def author=(author)
+      @author = author.strip
+    end
+
+    def message=(note)
+      @message = note.strip
+    end
+
+    #def clean_type(type)
+    #  case type.to_s
+    #  when 'maj', 'major' then :major
+    #  when 'min', 'minor' then :minor
+    #  when 'bug'          then :bug
+    #  when ''             then :other
+    #  else
+    #    type.to_sym
+    #  end
+    #end
+
+    #
+    def type_phrase
+      case type.to_s
+      when 'maj', 'major'
+        'Major Enhancements'
+      when 'min', 'minor'
+        'Minor Enhancements'
+      when 'bug'
+        'Bug Fixes'
+      when ''
+        'General Enhancements'
+      when '-'
+        'Administrative Changes'
+      else
+        "#{type.capitalize} Enhancements"
+      end
+    end
+
+    #
+    def type_number
+      case type.to_s.downcase
+      when 'maj', 'major'
+        0
+      when 'min', 'minor'
+        1
+      when 'bug'
+        2
+      when ''
+        4
+      when '-'
+        5
+      else # other
+        3
+      end
+    end
+
+    #
+    def <=>(other)
+      other.date <=> date
+    end
+
+    def inspect
+      "#<Change:#{object_id} #{date}>"
+    end
+
+    def to_h
+      { 'author'   => @author,
+        'date'     => @date,
+        'revision' => @revison,
+        'message'  => @message,
+        'type'     => @type
+      }
+    end
+
+    def to_json
+      to_h.to_json
+    end
+
+    def to_yaml(*args)
+      to_h.to_yaml(*args)
+    end
+
+  end #class Entry
+
+end

data/lib/vclog/changelog.rb

@@ -1,6 +1,7 @@
 module VCLog
 
   require 'vclog/facets'
+  require 'vclog/change'
 
   # Supports output formats:
   #
@@ -10,7 +11,7 @@ module VCLog
   #   json
   #   text
   #
-  class Changelog
+  class ChangeLog
 
     include Enumerable
 
@@ -18,31 +19,55 @@ module VCLog
 
     attr :changes
 
+    attr_accessor :marker
+
+    attr_accessor :title
+
+    # Include revision id?
+    attr_accessor :rev_id
+
+    #
     def initialize(changes=nil)
-      @changes = changes || []
+      @changes = []
+      @marker  = "#"
+      @title   = "CHANGE LOG"
+      @rev_id  = false
+
+      @changes = changes if changes
     end
 
-    def change(date, who, rev, note)
-      note, type = *split_note(note)
-      note = note.gsub(/^\s*?\n/m,'') # remove blank lines
-      @changes << Entry.new(:when=>date, :who=>who, :rev=>rev, :type=>type, :msg=>note)
+    #def changes=(changes)
+    #  @changes = []
+    #  changes.each do |change|
+    #    case change
+    #    when Change
+    #      @changes << change
+    #    else
+    #      @changes << Change.new(*change)
+    #    end
+    #  end
+    #end
+
+    # Add a change entry to the log.
+    def change(rev, date, who, note, type=nil)
+      @changes << Change.new(rev, date, who, note, type)
     end
 
-    def each(&block) ; @changes.each(&block) ; end
-    def empty? ; @changes.empty? ; end
-    def size ; @changes.size ; end
+    def each(&block) ; changes.each(&block) ; end
+    def empty? ; changes.empty? ; end
+    def size ; changes.size ; end
 
     #
     def <<(entry)
-      raise unless Entry===entry
+      raise unless Change===entry
       @changes << entry
     end
 
     # Return a new changelog with entries that have a specified type.
     # TODO: Be able to specify which types to include or omit.
-    def typed
-      self.class.new(changes.select{ |e| e.type })
-    end
+    #def typed
+    #  self.class.new(changes.select{ |e| e.type })
+    #end
 
     # Return a new changelog with entries occuring after the
     # given date limit.
@@ -58,8 +83,6 @@ module VCLog
       self.class.new(before)
     end
 
-    #
-
     #
     def by_type
       mapped = {}
@@ -105,18 +128,18 @@ module VCLog
     # Output Formats #
     ##################
 
-    def format_yaml
+    def to_yaml
       require 'yaml'
       changes.to_yaml
     end
 
-    def format_json
+    def to_json
       require 'json'
       changes.to_json
     end
 
     #
-    def format_gnu
+    def to_gnu(rev=false)
       x = []
       by_date.each do |date, date_changes|
         date_changes.by_author.each do |author, author_changes|
@@ -128,6 +151,7 @@ module VCLog
             else
               msg = "#{entry.message}".tabto(10)
             end
+            msg << " (#{entry.revision})" if rev
             msg[8] = '*'
             x << msg
           end
@@ -138,11 +162,11 @@ module VCLog
     end
 
     #
-    alias_method :to_s, :format_gnu
+    alias_method :to_s, :to_gnu
 
     # Create an XML formated changelog.
     # +xsl+ reference defaults to 'log.xsl'
-    def format_xml(xsl=nil)
+    def to_xml(xsl=nil)
       xsl = 'log.xsl' if xsl.nil?
       x = []
       x << %[<?xml version="1.0"?>]
@@ -152,7 +176,7 @@ module VCLog
         x << %[<entry>]
         x << %[  <date>#{entry.date}</date>]
         x << %[  <author>#{escxml(entry.author)}</author>]
-        x << %[  <revison>#{escxml(entry.revison)}</revison>]
+        x << %[  <revision>#{escxml(entry.revision)}</revision>]
         x << %[  <type>#{escxml(entry.type)}</type>]
         x << %[  <message>#{escxml(entry.message)}</message>]
         x << %[</entry>]
@@ -163,12 +187,12 @@ module VCLog
 
     # Create an HTML formated changelog.
     # +css+ reference defaults to 'log.css'
-    def format_html(css=nil)
+    def to_html(css=nil)
       css = 'log.css' if css.nil?
       x = []
       x << %[<html>]
       x << %[<head>]
-      x << %[  <title>Changelog</title>]
+      x << %[  <title>ChangeLog</title>]
       x << %[  <style>]
       x << %[    body{font-family: sans-serif;}]
       x << %[    #changelog{width:800px;margin:0 auto;}]
@@ -176,7 +200,7 @@ module VCLog
       x << %[    .date{font-weight: bold; color: gray; float: left; padding: 0 5px;}]
       x << %[    .author{color: red;}]
       x << %[    .message{padding: 5 0; font-weight: bold;}]
-      x << %[    .revison{font-size: 0.8em;}]
+      x << %[    .revision{font-size: 0.8em;}]
       x << %[  </style>]
       x << %[  <link rel="stylesheet" href="#{css}" type="text/css">] if css
       x << %[</head>]
@@ -190,7 +214,7 @@ module VCLog
         x << %[    <div class="author">#{escxml(entry.author)}</div>]
         x << %[    <div class="type">#{escxml(entry.type)}</div>]
         x << %[    <div class="message">#{escxml(entry.message)}</div>]
-        x << %[    <div class="revison">##{escxml(entry.revison)}</div>]
+        x << %[    <div class="revision">##{escxml(entry.revision)}</div>]
         x << %[  </li>]
       end
       x << %[    </ul>]
@@ -200,6 +224,76 @@ module VCLog
       return x.join("\n")
     end
 
+
+    # Translate history into a Markdown formatted document.
+    def to_markdown(rev=false)
+      to_markup('#', rev)
+    end
+
+    # Translate history into a RDoc formatted document.
+    def to_rdoc(rev=false)
+      to_markup('=', rev)
+    end
+
+    #
+    def to_markup(marker, rev=false)
+
+      x = []
+      by_date.each do |date, date_changes|
+        date_changes.by_author.each do |author, author_changes|
+          x << "#{marker}#{marker} #{date} #{author}\n"
+          x << to_markup_changes(author_changes, rev)
+        end
+        x << ""
+      end
+      marker + " #{title}\n\n" +  x.join("\n")
+    end
+
+  private
+
+    #
+    def to_markup_changes(changes, rev=false)
+      groups = changes.group_by{ |e| e.type_number }
+      string = ""
+      5.times do |n|
+        entries = groups[n]
+        next if !entries
+        next if entries.empty?
+        string << "* #{entries.size} #{entries[0].type_phrase}\n\n"
+        entries.sort!{|a,b| a.date <=> b.date }
+        entries.each do |entry|
+          #string << "#{marker}#{marker} #{entry.date} #{entry.author}\n\n"  # no email :(
+          if rev
+            text = "#{entry.message} (##{entry.revision})"
+          else
+            text = "#{entry.message}"
+          end
+          text = text.tabto(6)
+          text[4] = '*'
+          #entry = entry.join(' ').tabto(6)
+          #entry[4] = '*'
+          string << text
+          string << "\n"
+        end
+        string << "\n"
+      end
+      string.chomp("\n")
+    end
+
+  end
+
+end
+
+
+
+
+
+
+
+
+
+
+=begin
     #
     def format_rel(file, current_version=nil, current_release=nil, rev=false)
       log = []
@@ -249,11 +343,11 @@ module VCLog
         end
         reltext = changes.format_rel_types(rev)
         unless reltext.strip.empty?
-          log << "== #{lt_vers} / #{lt_date.strftime('%Y-%m-%d')}\n\n#{reltext}"
+          log << "#{marker} #{lt_vers} / #{lt_date.strftime('%Y-%m-%d')}\n\n#{reltext}"
         end
       end
       # reverse log order and make into document
-      log.reverse.join("\n")
+      marker[0,1] + " #{title}\n\n" +  log.reverse.join("\n")
     end
 
     #
@@ -269,7 +363,7 @@ module VCLog
         entries.each do |entry|
           #string << "== #{date}  #{who}\n\n"  # no email :(
           if rev
-            text = "#{entry.message} (##{entry.revison})"
+            text = "#{entry.message} (##{entry.revision})"
           else
             text = "#{entry.message}"
           end
@@ -289,20 +383,23 @@ module VCLog
     def releases(file)
       return [] unless file
       clog = File.read(file)
-      tags = clog.scan(/^==(.*?)$/)
+      tags = clog.scan(/^(==|##)(.*?)$/)
       rels = tags.collect do |t|
-        parse_version_tag(t[0])
+        parse_version_tag(t[1])
       end
+      @marker = tags[0][0]
       return rels
     end
 
     #
     def parse_version_tag(tag)
       version, date = *tag.split('/')
-      version, date = version.sub(/^\=+\s*/,'').strip, date.strip
+      version, date = version.strip, date.strip
       return version, date
     end
+=end
 
+=begin
     ###################
     # Save Chaqngelog #
     ###################
@@ -311,18 +408,18 @@ module VCLog
     def save(file, format=:gnu, *args)
       case format.to_sym
       when :xml
-        text = format_xml
-        save_xsl(file)
+        text = to_xml
+#save_xsl(file)
       when :html
-        text = format_html(*args)
+        text = to_html(*args)
       when :rel
-        text = format_rel(file, *args)
+        text = to_rel(file, *args)
       when :yaml
-        text = format_yaml(file)
+        text = to_yaml(file)
       when :json
-        text = format_json(file)
+        text = to_json(file)
       else
-        text = format_gnu
+        text = to_gnu
       end
 
       FileUtils.mkdir_p(File.dirname(file))
@@ -363,112 +460,6 @@ module VCLog
       end
     end
 
-    # Looks for a "[type]" indicator at the end of the message.
-    def split_note(note)
-      note = note.strip
-      if md = /\A.*?\[(.*?)\]\s*$/.match(note)
-        t = md[1].strip.downcase
-        n = note.sub(/\[#{md[1]}\]\s*$/, "")
-      else
-        n, t = note, nil
-      end
-      return n, t
-    end
-
-    # = Change Log Entry class
-    class Entry
-      include Comparable
-
-      attr_accessor :author
-      attr_accessor :date
-      attr_accessor :revison
-      attr_accessor :message
-      attr_accessor :type
-
-      def initialize(opts={})
-        @author  = (opts[:author]  || opts[:who]).strip
-        @date    = opts[:date]    || opts[:when]
-        @revison = opts[:revison] || opts[:rev]
-        @message = opts[:message] || opts[:msg]
-        @type    = opts[:type]
-      end
-
-      #def clean_type(type)
-      #  case type.to_s
-      #  when 'maj', 'major' then :major
-      #  when 'min', 'minor' then :minor
-      #  when 'bug'          then :bug
-      #  when ''             then :other
-      #  else
-      #    type.to_sym
-      #  end
-      #end
-
-      #
-      def type_phrase
-        case type.to_s
-        when 'maj', 'major'
-          'Major Enhancements'
-        when 'min', 'minor'
-          'Minor Enhancements'
-        when 'bug'
-          'Bug Fixes'
-        when ''
-          'General Enhancements'
-        when '-'
-          'Administrative Changes'
-        else
-          "#{type.capitalize} Enhancements"
-        end
-      end
-
-      #
-      def type_number
-        case type.to_s.downcase
-        when 'maj', 'major'
-          0
-        when 'min', 'minor'
-          1
-        when 'bug'
-          2
-        when ''
-          4
-        when '-'
-          5
-        else # other
-          3
-        end
-      end
-
-      #
-      def <=>(other)
-        other.date <=> date
-      end
-
-      def inspect
-        "#<Entry:#{object_id} #{date}>"
-      end
-
-      def to_h
-        { 'author'   => @author,
-          'date'     => @date,
-          'revision' => @revison,
-          'message'  => @message,
-          'type'     => @type
-        }
-      end
-
-      def to_json
-        to_h.to_json
-      end
-
-      def to_yaml(*args)
-        to_h.to_yaml(*args)
-      end
-
-    end #class Entry
-
-  end
 
   DEFAULT_LOG_XSL = <<-END.tabto(0)
     <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
@@ -505,6 +496,5 @@ module VCLog
 
     </xsl:stylesheet>
   END
-
-end
+=end