vclog 1.4.0 → 1.5.0

data/lib/vclog/cli.rb

@@ -1,6 +1,6 @@
 module VCLog
 
-  require 'vclog/vcs'
+  require 'vclog/adapters'
   require 'optparse'
 
   # = vclog Command
@@ -59,7 +59,7 @@ module VCLog
 
     optparse = OptionParser.new do |opt|
 
-      opt.banner = "Usage: vclog [--TYPE] [--FORMAT] [OPTIONS] [DIR]"
+      opt.banner = "Usage: vclog [--TYPE] [-f FORMAT] [OPTIONS] [DIR]"
 
       opt.separator(" ")
       opt.separator("OUTPUT TYPE (choose one):")
@@ -72,46 +72,27 @@ module VCLog
         type = :rel
       end
 
-      opt.on('--bump', '-b', "display a bumped version number") do
-        type = :bump
-      end
-
       opt.on('--current', '-c', "display current version number") do
         type = :curr
       end
 
-      opt.separator(" ")
-      opt.separator("FORMAT (choose one):")
-
-      opt.on('--gnu', "GNU standard format (default)") do
-        format = :gnu
-      end
-
-      opt.on('--xml', "XML format") do
-        format = :xml
-      end
-
-      opt.on('--yaml', "YAML format") do
-        format = :yaml
-      end
-
-      opt.on('--json', "JSON format") do
-        format = :json
+      opt.on('--bump', '-b', "display a bumped version number") do
+        type = :bump
       end
 
-      opt.on('--html', "HTML micro-like format") do
-        format = :html
+      opt.on('--formats', '-F', "list supported formats") do
+        puts "gnu rdoc markdown xml html atom rss json yaml"
+        exit
       end
 
-      opt.on('--rdoc', "RDoc format") do
-        format = :rdoc
-      end
+      opt.separator(" ")
+      opt.separator("FORMAT OPTION:")
 
-      opt.on('--markdown', '-m', "Markdown format") do
-        format = :markdown
+      opt.on('--format', '-f <FORMAT>', "Output format") do |format|
+        format = format.to_sym
       end
 
-      opt.separator(" ")    
+      opt.separator(" ")
       opt.separator("OTHER OPTIONS:")
 
       #opt.on('--typed', "catagorize by commit type") do
@@ -160,7 +141,7 @@ module VCLog
 
     root = ARGV.shift || Dir.pwd
 
-    vcs = VCLog::VCS.factory #(root)
+    vcs = VCLog::Adapters.factory #(root)
 
     case type
     when :bump
@@ -174,32 +155,44 @@ module VCLog
       end
       exit
     when :log
-      log = vcs.changelog
+      doctype = :changelog
+      #log = vcs.changelog
       #log = log.typed if typed  #TODO: ability to select types?
     when :rel
-      log = vcs.history(:title=>title, :extra=>extra, :version=>version)
+      doctype = :history
+      #log = vcs.history(:title=>title, :extra=>extra, :version=>version)
     else
       raise "huh?"
       #log = vcs.changelog
       #log = log.typed if typed  #TODO: ability to select types?
     end
 
-    case format
-    when :xml
-      txt = log.to_xml(style)   # xsl stylesheet url
-    when :html
-      txt = log.to_html(style)  # css stylesheet url
-    when :yaml
-      txt = log.to_yaml
-    when :json
-      txt = log.to_json
-    when :markdown
-      txt = log.to_markdown(rev)
-    when :rdoc
-      txt = log.to_rdoc(rev)
-    else #:gnu
-      txt = log.to_gnu(rev)
-    end
+    options = { 
+      :title      => title,
+      :extra      => extra,
+      :version    => version,
+      :revision   => rev,
+      :stylesheet => style 
+    }
+
+    txt = vcs.display(doctype, format, options)
+
+    #case format
+    #when :xml
+    #  txt = log.to_xml(style)   # xsl stylesheet url
+    #when :html
+    #  txt = log.to_html(style)  # css stylesheet url
+    #when :yaml
+    #  txt = log.to_yaml
+    #when :json
+    #  txt = log.to_json
+    #when :markdown
+    #  txt = log.to_markdown(rev)
+    #when :rdoc
+    #  txt = log.to_rdoc(rev)
+    #else #:gnu
+    #  txt = log.to_gnu(rev)
+    #end
 
     if output
       File.open(output, 'w') do |f|

data/lib/vclog/formatter.rb

@@ -0,0 +1,105 @@
+require 'ostruct'
+
+module VCLog
+
+  #
+  class Formatter
+
+    DIR = File.dirname(__FILE__)
+
+    #
+    attr :vcs
+
+    #
+    def initialize(vcs)
+      @vcs = vcs
+    end
+
+    #
+    def changelog
+      @vcs.changelog
+    end
+
+    #
+    def history
+      @vcs.history
+    end
+
+    #
+    def user
+      @options.user || @vcs.user
+    end
+
+    #
+    def email
+      @options.email || @vcs.user
+    end
+
+    #
+    def repository
+      @vcs.repository
+    end
+
+    # TODO
+    def url
+      @options.url || '/'
+    end
+
+    # TODO
+    def homepage
+      @options.homepage
+    end
+
+    #
+    def title
+      return @options.title if @options.title
+      case @doctype
+      when :history
+        "Release History"
+      else
+        "Change Log"
+      end
+    end
+
+    #
+    def display(doctype, format, options={})
+      options = OpenStruct.new(options)
+
+      @doctype = doctype
+      @format  = format
+      @options = options
+
+      require_formatter(format)
+
+      tmp = File.read(File.join(DIR, 'templates', "#{@doctype}.#{@format}"))
+      erb = ERB.new(tmp)
+      erb.result(binding)
+    end
+
+    private
+
+      #
+      def require_formatter(format)
+        case format.to_s
+        when 'yaml'
+          require 'yaml'
+        when 'json'
+          require 'json'
+        end
+      end
+
+      #
+      def h(input)
+         result = input.to_s.dup
+         result.gsub!("&", "&")
+         result.gsub!("<", "&lt;")
+         result.gsub!(">", "&gt;")
+         result.gsub!("'", "&apos;")
+         #result.gsub!("@", "&at;")
+         result.gsub!("\"", "&quot;")
+         return result
+      end
+
+  end
+
+end

data/lib/vclog/history.rb

@@ -73,10 +73,10 @@ module VCLog
         tags = self.tags
 
         ver  = vcs.bump(version)
+        user = vcs.user
         time = ::Time.now
-        user = ENV['USER']  # TODO: get user name from vcs
 
-        tags << Tag.new(ver, time, user, "Current Development")
+        tags << Tag.new(ver, 'current', time, user, "Current Development")
 
         # TODO: Do we need to add a Time.now tag?
         # add current verion to release list (if given)
@@ -92,27 +92,30 @@ module VCLog
         tags = tags.sort{ |a,b| b.date <=> a.date }
 
         # organize into deltas
-        deltas, last = [], nil
-        tags.each do |tag|
-          deltas << [last, tag]
-          last = tag
+        delta = {}
+        last  = nil
+        tags.sort.each do |tag|
+          delta[tag] = [last, tag.date]
+          last = tag.date
         end
 
         # gather changes for each delta and build log
-        deltas.each do |gt, lt|
-          if gt
-            gt_vers, gt_date = gt.name, gt.date
-            lt_vers, lt_date = lt.name, lt.date
+        delta.each do |tag, (ended, started)|
+          if ended
+            set = changes.select{ |c| c.date < ended && c.date > started }
+            #gt_vers, gt_date = gt.name, gt.date
+            #lt_vers, lt_date = lt.name, lt.date
             #gt_date = Time.parse(gt_date) unless Time===gt_date
             #lt_date = Time.parse(lt_date) unless Time===lt_date
-            log = changelog.after(gt_date).before(lt_date)
+            #log = changelog.after(gt).before(lt)
           else
-            lt_vers, lt_date = lt.name, lt.date
+            #lt_vers, lt_date = lt.name, lt.date
             #lt_date = Time.parse(lt_date) unless Time===lt_date
-            log = changelog.before(lt_date)
+            #log = changelog.before(lt_date)
+            set = changes.select{ |c| c.date > started }
           end
 
-          rel << Release.new(lt, log.changes)
+          rel << Release.new(tag, set)
         end
         rel
       )
@@ -124,12 +127,20 @@ module VCLog
       @groups ||= changes.group_by{ |e| e.type_number }
     end
 
+    #
+    def to_h
+      releases.map{ |rel| rel.to_h }
+    end
+
+
+
     # Same as to_gnu.
 
-    def to_s(rev=false)
-      to_gnu(rev)
-    end
+    #def to_s(rev=false)
+    #  to_gnu(rev)
+    #end
 
+=begin
     # TODO: What would GNU history look like?
 
     def to_gnu(rev=false)
@@ -149,7 +160,9 @@ module VCLog
       require 'json'
       releases.to_json
     end
+=end
 
+=begin
     # Translate history into a XML document.
 
     def to_xml(xsl=nil)
@@ -181,6 +194,7 @@ module VCLog
       erb = ERB.new(tmp)
       erb.result(binding)
     end
+=end
 
 =begin
     #
@@ -261,6 +275,7 @@ module VCLog
     end
 =end
 
+=begin
   private
 
     #
@@ -274,6 +289,7 @@ module VCLog
        result.gsub!("\"", "&quot;")
        return result
     end
+=end
 
   end
 

data/lib/vclog/metadata.rb

@@ -0,0 +1,13 @@
+module VCLog
+
+  class Metadata
+
+    def initialize
+      if file = Dir['PROFILE{,.yml}'].first
+        @profile = YAML.load(File.new(file))
+      end
+    end
+
+  end
+
+end

data/lib/vclog/release.rb

@@ -11,13 +11,24 @@ module VCLog
     end
 
     def to_h
-      { :tag => tag.to_h, :changes => changes }
+      { 'version'  => tag.name,
+        'date'     => tag.date,
+        'message'  => tag.message,
+        'author'   => tag.author,
+        'revision' => tag.revision,
+        'changes'  => changes.map{|change| change.to_h}
+      }
     end
 
-    def to_json
-      to_h.to_json
+    # Group +changes+ by tag type.
+    def groups
+      @groups ||= changes.group_by{ |e| e.type_number }
     end
 
+    #def to_json
+    #  to_h.to_json
+    #end
+
     def <=>(other)
       @tag <=> other.tag
     end

data/lib/vclog/tag.rb

@@ -1,21 +1,24 @@
 module VCLog
 
   class Tag
+    attr_accessor :revision
     attr_accessor :name
     attr_accessor :date
     attr_accessor :author
     attr_accessor :message
 
-    def initialize(name, date, author, message)
-      self.name    = name
-      self.date    = date
-      self.author  = author
-      self.message = message
+    def initialize(name, rev, date, author, message)
+      self.revision = rev
+      self.name     = name
+      self.date     = date
+      self.author   = author
+      self.message  = message
     end
 
     def name=(name)
       @name = name.strip
     end
+    alias_method :label, :name
 
     def author=(author)
       @author = author.strip
@@ -43,13 +46,18 @@ module VCLog
 
     def to_h
       {
-        :name => name,
-        :date => date,
-        :author => author,
-        :message => message
+        'name' => name,
+        'date' => date,
+        'author' => author,
+        'message' => message
       }
     end
 
+    #
+    def inspect
+      "<Tag #{name} #{date.strftime('%Y-%m-%d %H:%M:%S')}>"
+    end
+
     # Normal tag order is the reverse typical sorts.
     def <=>(other)
       other.name <=> name

data/lib/vclog/templates/changelog.atom

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<feed xmlns="http://www.w3.org/2005/Atom">
+
+  <title><%= title %> Feed</title>
+  <% if url %><link href="<%= url %>" rel="self" /><% end %>
+  <% if homepage %><link href="<%= homepage %>" /><% end %>
+  <id><% if vcs.uuid %>urn:uuid:<%= vcs.uuid %><% else %><%= vcs.repository %><% end %></id>
+  <updated><%= Time.now %></updated>
+  <author>
+    <name><%= user %></name>
+    <email><%= email %></email>
+  </author>
+
+  <% changelog.changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+  <entry>
+    <title><%= h entry.message.lines.first %></title>
+    <id><%= entry.revision %></id>
+    <author><%= entry.author %></author>
+    <updated><%= entry.date %></updated>
+    <summary type="html"><%= h entry.message %></summary>
+  </entry>
+  <% end %>
+
+</feed>
+

data/lib/vclog/templates/changelog.gnu

@@ -1,6 +1,6 @@
-<% by_date.each do |date, date_changes| %><% date_changes.by_author.each do |author, author_changes| %>
+<% changelog.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 %>
+        * <%= entry.message %> <% if entry.type %><<%= entry.type %>><% end %><% if options.revision %>(#<%= entry.revision %>)<% end %><% end %>
 <% end %>
 <% end %>

data/lib/vclog/templates/changelog.html

@@ -13,13 +13,13 @@
     .message{padding: 5 0; font-weight: bold;}
     .revision{font-size: 0.8em;}
   </style>
-  <% if css %>
-    <link rel="stylesheet" href="#{css}" type="text/css">
+  <% if options.stylesheet %>
+    <link rel="stylesheet" href="#{options.stylesheet}" type="text/css">
   <% end %>
 </head>
 <body>
 <div class="changelog">
-  <% changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+  <% 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>

data/lib/vclog/templates/changelog.json

@@ -0,0 +1 @@
+<%= changelog.to_h.to_json %>

data/lib/vclog/templates/changelog.markdown

@@ -1,6 +1,6 @@
 # <%= title %>
-<% by_date.each do |date, date_changes| %><% date_changes.by_author.each do |author, author_changes| %>
+<% changelog.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 %>
+* <%= entry.message %> <% if entry.type %><<%= entry.type %>><% end %><% if options.revision %>(#<%= entry.revision %>)<% end %><% end %>
 <% end %><% end %>

data/lib/vclog/templates/changelog.rdoc

@@ -1,6 +1,6 @@
 = <%= title %>
-<% by_date.each do |date, date_changes| %><% date_changes.by_author.each do |author, author_changes| %>
+<% changelog.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 %>
+* <%= entry.message %> <% if entry.type %><<%= entry.type %>><% end %><% if options.revision %>(#<%= entry.revision %>)<% end %><% end %>
 <% end %><% end %>

data/lib/vclog/templates/changelog.xml

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

data/lib/vclog/templates/changelog.yaml

@@ -0,0 +1 @@
+<%= changelog.to_h.to_yaml %>

data/lib/vclog/templates/history.atom

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<feed xmlns="http://www.w3.org/2005/Atom">
+
+  <title><%= title %> Feed</title>
+  <subtitle>Release History</subtitle>
+  <% if url %><link href="<%= url %>" rel="self" /><% end %>
+  <% if homepage %><link href="<%= homepage %>" /><% end %>
+  <id><% if vcs.uuid %>urn:uuid:<%= vcs.uuid %><% else %><%= vcs.repository %><% end %></id>
+  <updated><%= Time.now %></updated>
+  <author>
+    <name><%= user %></name>
+    <email><%= email %></email>
+  </author>
+
+  <% history.releases.sort.each do |release| %>
+  <% tag = release.tag %>
+  <entry>
+    <title><%= tag.name %></title>
+    <id><%= tag.revision %></id>
+    <author><%= tag.author %></author>
+    <updated><%= tag.date.strftime('%Y-%m-%d') %></updated>
+    <summary type="html">
+      <p><%= tag.message %></p>
+      <% if options.extra %>
+        <% release.groups.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 %>
+    </summary>
+  </entry>
+  <% end %>
+
+</feed>
+

data/lib/vclog/templates/history.gnu

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

data/lib/vclog/templates/history.html

@@ -13,19 +13,19 @@
     .message{padding: 5 0; font-weight: bold;}
     .revision{font-size: 0.8em;}
   </style>
-  <% if css %>
-    <link rel="stylesheet" href="#{css}" type="text/css">
+  <% if options.stylesheet %>
+    <link rel="stylesheet" href="#{options.stylesheet}" type="text/css">
   <% end %>
 </head>
 <body>
 <div class="history">
   <div class="title"><%= title %></div>
-  <% releases.each do |release| %>
+  <% history.releases.sort.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| %>
+    <% if options.extra %>
+      <% release.groups.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| %>

data/lib/vclog/templates/history.json

@@ -0,0 +1 @@
+<%= history.to_h.to_json %>

data/lib/vclog/templates/history.markdown

@@ -1,12 +1,12 @@
 # <%= title %>
-<% releases.each do |release| %><% tag = release.tag %>
+<% history.releases.sort.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| %>
+<% if options.extra %>Changes:
+<% release.groups.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 %>
+    * <%= entry.message %> <% if options.revision %>(#<%= entry.revision %>)<% end %><% end %>
 <% end %><% end %><% end %>