vclog 1.2 → 1.4.0

data/lib/vclog/cli.rb

@@ -59,7 +59,7 @@ module VCLog
 
     optparse = OptionParser.new do |opt|
 
-      opt.banner = "Usage: vclog [TYPE] [FORMAT] [OPTIONS] [DIR]"
+      opt.banner = "Usage: vclog [--TYPE] [--FORMAT] [OPTIONS] [DIR]"
 
       opt.separator(" ")
       opt.separator("OUTPUT TYPE (choose one):")
@@ -73,11 +73,11 @@ module VCLog
       end
 
       opt.on('--bump', '-b', "display a bumped version number") do
-        doctype = :bump
+        type = :bump
       end
 
       opt.on('--current', '-c', "display current version number") do
-        doctype = :curr
+        type = :curr
       end
 
       opt.separator(" ")
@@ -122,7 +122,7 @@ module VCLog
         title = string
       end
 
-      opt.on('--extra', '-e', "provide extra output, used by some formats") do
+      opt.on('--extra', '-e', "provide extra output (used by some formats)") do
         extra = true
       end
 
@@ -130,8 +130,8 @@ module VCLog
         version = num
       end
 
-      opt.on('--style [FILE]', "provide a stylesheet name (css or xsl) for xml and html formats") do |val|
-        style = val
+      opt.on('--style <URI>', "provide a stylesheet URI (css or xsl) for HTML or XML format") do |uri|
+        style = uri
       end
 
       opt.on('--id', "include revision ids (in formats that normally do not)") do
@@ -139,7 +139,7 @@ module VCLog
       end
 
       # DEPRECATE
-      opt.on('--output', '-o [FILE]', "send output to a file instead of stdout") do |out|
+      opt.on('--output', '-o <FILE>', "send output to a file instead of stdout") do |out|
         output = out
       end
 
@@ -167,7 +167,11 @@ module VCLog
       puts vcs.bump(version)
       exit
     when :curr
-      puts vcs.tags.last.name #TODO: ensure latest
+      if vcs.tags.empty?
+        puts "0.0.0"
+      else
+        puts vcs.tags.last.name #TODO: ensure latest
+      end
       exit
     when :log
       log = vcs.changelog

data/lib/vclog/heuristics.rb

@@ -0,0 +1,15 @@
+module VCLog
+
+  # TODO: Develop heuristics for determining the nature
+  # of changes from the commit messages. Ultimately allow
+  # user to customize heuristics per project.
+  module Heuristics
+
+    def explicit_tag(message)
+      md = /^(\w+)\:/.match(message)
+      md ? {:tag => md[1]} : {}
+    end
+
+  end
+
+end

data/lib/vclog/history.rb

@@ -4,6 +4,7 @@ module VCLog
   require 'vclog/changelog'
   require 'vclog/tag'
   require 'vclog/release'
+  require 'erb'
 
   # = Release History Class
   #
@@ -24,24 +25,26 @@ module VCLog
   #
   class History
 
-    attr :vcs
+    # Location of this file in the file system.
+    DIR = File.dirname(__FILE__)
 
-    attr_accessor :marker
+    attr :vcs
 
+    # Alternate title.
     attr_accessor :title
 
     # Current working version.
     attr_accessor :version
 
+    # Provide extra information.
     attr_accessor :extra
 
     #
     def initialize(vcs, opts={})
-      @vcs = vcs
-      @marker    = opts[:marker]  || "#"
-      @title     = opts[:title]   || "RELEASE HISTORY"
-      @extra     = opts[:extra]
-      @version   = opts[:version]
+      @vcs     = vcs
+      @title   = opts[:title] || "RELEASE HISTORY"
+      @extra   = opts[:extra]
+      @version = opts[:version]
     end
 
     # Tag list from version control system.
@@ -50,27 +53,30 @@ module VCLog
     end
 
     # Change list from version control system.
+
     def changes
       @changes ||= vcs.changes
     end
 
     # Changelog object
+
     def changelog
       @changlog ||= vcs.changelog #ChangeLog.new(changes)
     end
 
     #
+
     def releases
       @releases ||= (
         rel = []
 
-        tags = tags()
+        tags = self.tags
 
         ver  = vcs.bump(version)
         time = ::Time.now
         user = ENV['USER']  # TODO: get user name from vcs
 
-        tags << Tag.new(ver, time, user, "FIXME")
+        tags << Tag.new(ver, time, user, "Current Development")
 
         # TODO: Do we need to add a Time.now tag?
         # add current verion to release list (if given)
@@ -82,7 +88,8 @@ module VCLog
         #rels = rels.uniq      # only uniq releases
 
         # sort by release date
-        tags = tags.sort{ |a,b| a.date <=> b.date }
+        #tags = tags.sort{ |a,b| b.name <=> a.name }
+        tags = tags.sort{ |a,b| b.date <=> a.date }
 
         # organize into deltas
         deltas, last = [], nil
@@ -111,129 +118,71 @@ module VCLog
       )
     end
 
-    #
+    # Group +changes+ by tag type.
+
+    def groups(changes)
+      @groups ||= changes.group_by{ |e| e.type_number }
+    end
+
+    # Same as to_gnu.
+
     def to_s(rev=false)
       to_gnu(rev)
     end
 
-    # TODO: What would GNU history be?
+    # TODO: What would GNU history look like?
+
     def to_gnu(rev=false)
       to_markdown(rev)
     end
 
-    # Translate history into an XML document.
-    def to_xml(xsl=nil)
-      require 'rexml/document'
-      xml = REXML::Document.new('<history></history>')
-      #xml << REXML::XMLDecl.default
-      root = xml.root
-      releases.each do |release|
-        rel = root.add_element('release')
-        tel = rel.add_element('tag')
-        tel.add_element('name').add_text(release.tag.name)
-        tel.add_element('date').add_text(release.tag.date.to_s)
-        tel.add_element('author').add_text(release.tag.author)
-        tel.add_element('message').add_text(release.tag.message)
-        cel = rel.add_element('changes')
-        release.changes.sort{|a,b| b.date <=> a.date}.each do |entry|
-          el = cel.add_element('entry')
-          el.add_element('date').add_text(entry.date.to_s)
-          el.add_element('author').add_text(entry.author)
-          el.add_element('type').add_text(entry.type)
-          el.add_element('revision').add_text(entry.revision)
-          el.add_element('message').add_text(entry.message)
-        end
-      end
-      out = String.new
-      fmt = REXML::Formatters::Pretty.new
-      fmt.compact = true
-      fmt.write(xml, out)
-      #
-      txt  = %[<?xml version="1.0"?>\n]
-      txt += %[<?xml-stylesheet href="#{xsl}" type="text/xsl" ?>\n] if xsl
-      txt += out
-      txt
-    end
-
-    # Translate history into a HTML document.
-    #
-    # TODO: Need to add some headers.
-    #
-    def to_html(css=nil)
-      require 'rexml/document'
-      xml = REXML::Document.new('<div class="history"></div>')
-      #xml << REXML::XMLDecl.default
-      root = xml.root
-      releases.each do |release|
-        rel = root.add_element('div')
-        rel.add_attribute('class', 'release')
-        tel = rel.add_element('div')
-        tel.add_attribute('class', 'tag')
-        tel.add_element('div').add_text(release.tag.name).add_attribute('class', 'name')
-        tel.add_element('div').add_text(release.tag.date.to_s).add_attribute('class', 'date')
-        tel.add_element('div').add_text(release.tag.author).add_attribute('class', 'author')
-        tel.add_element('div').add_text(release.tag.message).add_attribute('class', 'message')
-        cel = rel.add_element('ul')
-        cel.add_attribute('class', 'changes')
-        release.changes.sort{|a,b| b.date <=> a.date}.each do |entry|
-          el = cel.add_element('li')
-          el.add_attribute('class', 'entry')
-          el.add_element('div').add_text(entry.date.to_s).add_attribute('class', 'date')
-          el.add_element('div').add_text(entry.author).add_attribute('class', 'author')
-          el.add_element('div').add_text(entry.type).add_attribute('class', 'type')
-          el.add_element('div').add_text(entry.revision).add_attribute('class', 'revision')
-          el.add_element('div').add_text(entry.message).add_attribute('class', 'message')
-        end
-      end
-      out = String.new
-      fmt = REXML::Formatters::Pretty.new
-      fmt.compact = true
-      fmt.write(xml, out)
-      #
-      x = []
-      x << %[<html>]
-      x << %[<head>]
-      x << %[  <title>ChangeLog</title>]
-      x << %[  <style>]
-      x << %[    body{font-family: sans-serif;}]
-      x << %[    #changelog{width:800px;margin:0 auto;}]
-      x << %[    li{padding: 10px;}]
-      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 << %[    .revision{font-size: 0.8em;}]
-      x << %[  </style>]
-      x << %[  <link rel="stylesheet" href="#{css}" type="text/css">] if css
-      x << %[</head>]
-      x << %[<body>]
-      x << out
-      x << %[</body>]
-      x << %[</html>]
-      x.join("\n")
-    end
-
     # Translate history into a YAML document.
+
     def to_yaml(*args)
       require 'yaml'
       releases.to_yaml(*args)
     end
 
     # Translate history into a JSON document.
+
     def to_json
       require 'json'
       releases.to_json
     end
 
-    # Translate history into a Markdown formatted document.
-    def to_markdown(rev=false)
-      to_markup('#', rev)
+    # Translate history into a XML document.
+
+    def to_xml(xsl=nil)
+      tmp = File.read(File.join(DIR, 'templates', 'history.xml'))
+      erb = ERB.new(tmp)
+      erb.result(binding)
     end
 
-    # Translate history into a RDoc formatted document.
+    # Translate history into a HTML document.
+
+    def to_html(css=nil)
+      tmp = File.read(File.join(DIR, 'templates', 'history.html'))
+      erb = ERB.new(tmp)
+      erb.result(binding)
+    end
+
+    # Translate history into a RDoc document.
+
     def to_rdoc(rev=false)
-      to_markup('=', rev)
+      tmp = File.read(File.join(DIR, 'templates', 'history.rdoc'))
+      erb = ERB.new(tmp)
+      erb.result(binding)
+    end
+
+    # Translate history into a Markdown formatted document.
+
+    def to_markdown(rev=false)
+      tmp = File.read(File.join(DIR, 'templates', 'history.markdown'))
+      erb = ERB.new(tmp)
+      erb.result(binding)
     end
 
+=begin
     #
     def to_markup(marker, rev=false)
       entries = []
@@ -252,14 +201,16 @@ module VCLog
       # reverse entries order and make into document
       marker + " #{title}\n\n" +  entries.reverse.join("\n")
     end
+=end
 
   private
 
+=begin
     #
     def to_markup_changes(changes, rev=false)
       groups = changes.group_by{ |e| e.type_number }
       string = ""
-      5.times do |n|
+      groups.keys.sort.each do |n|
         entries = groups[n]
         next if !entries
         next if entries.empty?
@@ -283,6 +234,8 @@ module VCLog
       end
       string
     end
+=end
+
 
 =begin
     # Extract release tags from a release file.
@@ -308,6 +261,20 @@ module VCLog
     end
 =end
 
+  private
+
+    #
+    def h(input)
+       result = input.to_s.dup
+       result.gsub!("&", "&amp;")
+       result.gsub!("<", "&lt;")
+       result.gsub!(">", "&gt;")
+       result.gsub!("'", "&apos;")
+       #result.gsub!("@", "&at;")
+       result.gsub!("\"", "&quot;")
+       return result
+    end
+
   end
 
 end

data/lib/vclog/release.rb

@@ -17,6 +17,10 @@ module VCLog
     def to_json
       to_h.to_json
     end
+
+    def <=>(other)
+      @tag <=> other.tag
+    end
   end
 
 end

data/lib/vclog/tag.rb

@@ -49,6 +49,11 @@ module VCLog
         :message => message
       }
     end
+
+    # Normal tag order is the reverse typical sorts.
+    def <=>(other)
+      other.name <=> name
+    end
   end
 
 end

data/lib/vclog/templates/changelog.gnu

@@ -0,0 +1,6 @@
+<% by_date.each do |date, date_changes| %><% date_changes.by_author.each do |author, author_changes| %>
+<%= date %>  <%= author %>
+    <% author_changes.each do |entry| %>
+        * <%= entry.message %> <% if entry.type %><<%= entry.type %>><% end %><% if rev %>(#<%= entry.revision %>)<% end %><% end %>
+<% end %>
+<% end %>

data/lib/vclog/templates/changelog.html

@@ -0,0 +1,34 @@
+<html>
+<head>
+  <title><%= title %></title>
+  <style>
+    body{font-family: sans-serif;}
+    h1{ }
+    h2{ color: #555; }
+    li{padding: 10px;}
+    .changelog{width:800px; margin:0 auto;}
+    .title{font-size: 64px;}
+    .date{font-weight: bold; color: green; float: left; padding-right: 15px;}
+    .author{font-weight: bold; color: blue;}
+    .message{padding: 5 0; font-weight: bold;}
+    .revision{font-size: 0.8em;}
+  </style>
+  <% if css %>
+    <link rel="stylesheet" href="#{css}" type="text/css">
+  <% end %>
+</head>
+<body>
+<div class="changelog">
+  <% changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+  <div class="commit">
+    <div class="revision">#<%= h entry.revision %></div>
+    <div class="date"><%= entry.date %></div>
+    <div class="author"><%= h entry.author %></div>
+    <div class="type"><%= h entry.type %></div>
+    <div class="message"><%= h entry.message %></div>
+  </commit>
+  <% end %>
+</div>
+</body>
+</html>
+

data/lib/vclog/templates/changelog.markdown

@@ -0,0 +1,6 @@
+# <%= title %>
+<% by_date.each do |date, date_changes| %><% date_changes.by_author.each do |author, author_changes| %>
+## <%= date %> <%= author %>
+    <% author_changes.each do |entry| %>
+* <%= entry.message %> <% if entry.type %><<%= entry.type %>><% end %><% if rev %>(#<%= entry.revision %>)<% end %><% end %>
+<% end %><% end %>

data/lib/vclog/templates/changelog.rdoc

@@ -0,0 +1,6 @@
+= <%= title %>
+<% by_date.each do |date, date_changes| %><% date_changes.by_author.each do |author, author_changes| %>
+== <%= date %> <%= author %>
+    <% author_changes.each do |entry| %>
+* <%= entry.message %> <% if entry.type %><<%= entry.type %>><% end %><% if rev %>(#<%= entry.revision %>)<% end %><% end %>
+<% end %><% end %>

data/lib/vclog/templates/changelog.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<% if xsl %>
+<?xml-stylesheet href="#{xsl}" type="text/xsl" ?>
+<% end %>
+<changelog title="<%= title %>">
+  <% changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+  <commit>
+    <revision>#<%= h entry.revision %></revision>
+    <date><%= entry.date %></date>
+    <author><%= h entry.author %></author>
+    <type><%= h entry.type %></type>
+    <message><%= h entry.message %></message>
+  </commit>
+  <% end %>
+</changelog>
+

data/lib/vclog/templates/changelog.xsl

@@ -0,0 +1,34 @@
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+
+  <xsl:output cdata-section-elements="script"/>
+
+  <xsl:template match="/">
+    <html>
+      <head>
+        <title>Changelog</title>
+        <link REL='SHORTCUT ICON' HREF="../img/ruby-sm.png" />
+        <style>
+          td { font-family: sans-serif;  padding: 0px 10px; }
+        </style>
+      </head>
+      <body>
+      <div class="container">
+        <h1>Changelog</h1>
+        <table style="width: 100%;">
+          <xsl:apply-templates />
+        </table>
+      </div>
+      </body>
+    </html>
+  </xsl:template>
+
+  <xsl:template match="entry">
+      <tr>
+        <td><b><pre><xsl:value-of select="message"/></pre></b></td>
+        <td><xsl:value-of select="author"/></td>
+        <td><xsl:value-of select="date"/></td>
+      </tr>
+  </xsl:template>
+
+</xsl:stylesheet>
+

data/lib/vclog/templates/history.html

@@ -0,0 +1,47 @@
+<html>
+<head>
+  <title><%= title %> History</title>
+  <style>
+    body{font-family: sans-serif;}
+    h1{ }
+    h2{ color: #555; }
+    li{padding: 10px;}
+    .changelog{width:800px; margin:0 auto;}
+    .title{font-size: 64px;}
+    .date{font-weight: bold; color: green; float: left; padding-right: 15px;}
+    .author{font-weight: bold; color: blue;}
+    .message{padding: 5 0; font-weight: bold;}
+    .revision{font-size: 0.8em;}
+  </style>
+  <% if css %>
+    <link rel="stylesheet" href="#{css}" type="text/css">
+  <% end %>
+</head>
+<body>
+<div class="history">
+  <div class="title"><%= title %></div>
+  <% releases.each do |release| %>
+    <% tag = release.tag %>
+    <h1><%= tag.name %> / <%= tag.date.strftime('%Y-%m-%d') %></h1>
+    <p><%= tag.message %></p>
+    <% if extra %>
+      <% groups(release.changes).each do |number, changes| %>
+        <h2><%= changes.size %> <%= changes[0].type_phrase %></h2>
+        <ul class="log">
+        <% changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+          <li class="entry">
+          <div class="message"><%= h entry.message %></div>
+          <!-- <div class="type"><%= h entry.type %></div> -->
+          <div class="revision">#<%= h entry.revision %></div>
+          <div class="date"><%= entry.date %></div>
+          <div class="author"><%= h entry.author %></div>
+          </li>
+        <% end %>
+        </ul>
+      <% end %>
+    <% end %>
+  <% end %>
+</div>
+</body>
+</html>
+

data/lib/vclog/templates/history.markdown

@@ -0,0 +1,12 @@
+# <%= title %>
+<% releases.each do |release| %><% tag = release.tag %>
+## <%= tag.name %> / <%= tag.date.strftime('%Y-%m-%d') %>
+
+<%= h tag.message.strip %> (<%= tag.author %>)
+
+<% if extra %>Changes:
+<% groups(release.changes).each do |number, changes| %>
+* <%= changes.size %> <%= changes[0].type_phrase %>
+<% changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+    * <%= entry.message %> <% if rev %>(#<%= entry.revision %>)<% end %><% end %>
+<% end %><% end %><% end %>

data/lib/vclog/templates/history.rdoc

@@ -0,0 +1,12 @@
+= <%= title %>
+<% releases.each do |release| %><% tag = release.tag %>
+== <%= tag.name %> / <%= tag.date.strftime('%Y-%m-%d') %>
+
+<%= h tag.message.strip %> (<%= tag.author %>)
+
+<% if extra %>Changes:
+<% groups(release.changes).each do |number, changes| %>
+* <%= changes.size %> <%= changes[0].type_phrase %>
+<% changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+    * <%= entry.message %> <% if rev %>(#<%= entry.revision %>)<% end %><% end %>
+<% end %><% end %><% end %>

data/lib/vclog/templates/history.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<% if xsl %>
+<?xml-stylesheet href="#{xsl}" type="text/xsl" ?>
+<% end %>
+<history>
+  <title><%= title %></title>
+  <% releases.each do |release| %>
+  <tag>
+    <% tag = release.tag %>
+    <name><%= h tag.name %></name>
+    <date><%= tag.date.strftime('%Y-%m-%d') %></date>
+    <author><%= h tag.author %></author>
+    <message><%= h tag.message %></message>
+    <% groups(release.changes).each do |number, changes| %>
+    <commit-group type="<%= changes[0].type %>" label="<%= changes[0].type_phrase %>">
+      <% changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+      <commit>
+        <revision>#<%= h entry.revision %></revision>
+        <date><%= entry.date %></date>
+        <author><%= h entry.author %></author>
+        <type><%= h entry.type %></type>
+        <message><%= h entry.message %></message>
+      </commit>
+      <% end %>
+    </commit-group>
+    <% end %>
+  </tag>
+  <% end %>
+</history>
+

data/lib/vclog/vcs/git.rb

@@ -25,25 +25,13 @@ module VCLog
       #
       def extract_changes
         list = []
-        changelog = `git-log`.strip
-        changes = changelog.split(/^commit/m)
+        changelog = `git log --pretty=format:"---%ci|~|%aN|~|%H|~|%s"`.strip
+        changes = changelog.split("---")
+        #changes = changelog.split(/^commit/m)
         changes.shift # throw the first (empty) entry away
-        changes.each do |text|
-          date, who, rev, msg = nil, nil, nil, []
-          text.each_line do |line|
-            unless rev
-              rev = line.strip
-              next
-            end
-            if md = /^Author:(.*?)$/.match(line)
-              who = md[1]
-            elsif md = /^Date:(.*?)$/m.match(line)
-              date = Time.parse(md[1])
-            else
-              msg << line.strip
-            end
-          end
-          msg = msg.join("\n")
+        changes.each do |entry|
+          date, who, rev, msg = entry.split('|~|')
+          date = Time.parse(date)
           msg, type = *split_type(msg)
           list << [rev, date, who, msg, type]
         end
@@ -72,6 +60,16 @@ module VCLog
           who  = who.split(':')[1].strip
           date = date[date.index(':')+1..-1].strip
           msg  = msg.join("\n")
+
+          info = `git show #{tag}^ --pretty=format:"%ci|-|"`
+          date, *_ = *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")
+
           list << [tag, date, who, msg]
         end
         list