vclog 1.6.0 → 1.6.1

data/HISTORY.rdoc

@@ -1,5 +1,17 @@
 = RELEASE HISTORY
 
+== 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).
+
+Changes:
+
+* Repair and improve Atom feed format.
+* Add RSS feed format.
+* Fix Git email address value.
+* Add title to HTML Change Log format.
+
+
 == 1.6.0 / 2010-06-22
 
 Previous versions utilized a system of "commit tagging" to identify types of commits. This proved less than optimal --it was unconventional, but worse it was easy to forget to put the proper label in the message. The new version of VClog uses a customizable heuristics systems instead. Rather than be limited to a strict syntax structure, you can write matching rules in .config/vclog/rules.rb that determine the commit type, and set descriptive labels for each type. This makes it very easy to get excellent History output. Also in this release the command-line interface has changed to use subcommands. And the default output format is now an ANSI-color GNU-like format. Use `-f gnu` to get the old default format.

data/README.rdoc

@@ -7,7 +7,7 @@
 == DESCRIPTION
 
 VCLog is a versitle cross-VCS/SCM changelog generator.
-It currently supports Git and Subversion.
+It currently supports Git, Hg and (limited) Subversion.
 
 
 == SYNOPSIS

data/REQUIRE

@@ -1,6 +1,6 @@
 runtime:
-- facets >2.4
-- ansi
+- facets 2.4+
+- ansi 1.2+
 
 development:
 - syckle

data/VERSION

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

data/lib/plugins/syckle/vclog.rb

@@ -24,11 +24,10 @@ module Syckle::Plugins
     # Supports +html+, +xml+, +json+, +yaml+, +rdoc+, +markdown+, and +gnu+.
     attr_accessor :formats
 
-    # Changelog layout type (+log+ or +rel+). Default is +log+.
+    # Changelog layout type (+changelog+ or +history+). Default is +changelog+.
     attr_accessor :type
 
-    # Output file to store changelog.
-    # The defualt is 'log/vclog/changelog.{format}'.
+    # Output directory store results.
     attr_accessor :output
 
     # Show revision numbers (true/false)?
@@ -40,9 +39,12 @@ module Syckle::Plugins
     # Some formats can reference an optional stylesheet (namely +xml+ and +html+).
     attr_accessor :style
 
-    # Minimu change level to include.
+    # Minimum change level to include.
     attr_accessor :level
 
+    # Reduced detail
+    attr_accessor :summary
+
     #
     def initialize_defaults
       require 'vclog'
@@ -52,11 +54,12 @@ module Syckle::Plugins
       @formats    = ['atom']
       @type       = 'log'
       @level      = 0
+      @summary    = false
     end
 
     #
     def valid?
-      return false unless format =~ /^(html|yaml|json|xml|rdoc|markdown|gnu|txt|atom|ansi)$/
+      return false unless format =~ /^(html|yaml|json|xml|rdoc|markdown|gnu|txt|atom|rss|ansi)$/
       return false unless type   =~ /^(log|rel|history|changelog)$/
       return true
     end
@@ -82,9 +85,11 @@ module Syckle::Plugins
       formats.each do |format|
         case type
         when 'rel', 'history'
-          file = output || (project.log + "vclog/history.#{format}").to_s
+          ext  = format_extension(format)
+          file = File.join(output || project.log, "vclog/history#{ext}")
         else
-          file = output || (project.log + "vclog/changelog.#{format}").to_s
+          ext  = format_extension(format)
+          file = File.join(output || project.log, "vclog/changelog#{ext}")
         end
         #apply_naming_policy('changelog', log_format.downcase)
         if dryrun?
@@ -155,13 +160,26 @@ module Syckle::Plugins
         :stylesheet => style,
         :revision   => rev,
         :version    => version,
-        :title      => title
+        :title      => title,
+        :extra      => !summary
       }
 
       vcs.display(doctype, format, options)
     end
 
 
+    #
+    def format_extension(format)
+      #case format.to_s
+      #when 'rss'
+      #  '-rss.xml'
+      #when 'atom'
+      #  '-atom.xml'
+      #else
+        ".#{format}"
+      #end
+    end
+
 =begin
     #
     def document_public_changelog

data/lib/vclog/adapters/git.rb

@@ -63,7 +63,7 @@ module Adapters
 
     #
     def user
-      @email ||= `git config user.name`.strip
+      @user ||= `git config user.name`.strip
     end
 
     #

data/lib/vclog/cli.rb

@@ -20,11 +20,11 @@ module VCLog
   #
   # For XML format:
   #
-  #  $ vclog --xml
+  #  $ vclog -f xml
   #
   # Or for a micorformat-ish HTML:
   #
-  #  $ vclog --html
+  #  $ vclog -f html
   #
   # To use the library programmatically, please see the API documentation.
 

data/lib/vclog/formatter.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+#require 'ansi'
 
 module VCLog
 
@@ -35,7 +36,7 @@ module VCLog
 
     #
     def email
-      @options.email || @vcs.user
+      @options.email || @vcs.email
     end
 
     #
@@ -45,7 +46,7 @@ module VCLog
 
     # TODO
     def url
-      @options.url || '/'
+      @options.url || @vcs.repository
     end
 
     # TODO

data/lib/vclog/templates/changelog.atom.erb

@@ -1,26 +1,52 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
 
 <feed xmlns="http://www.w3.org/2005/Atom">
 
-  <title><%= title %> Feed</title>
-  <% if url %><link href="<%= url %>" rel="self" /><% end %>
+  <title><%= title %></title>
+
+  <% if url %><link href="<%= url %>" /><% end %>
+
   <% if homepage %><link href="<%= homepage %>" /><% end %>
+
   <id><% if vcs.uuid %>urn:uuid:<%= vcs.uuid %><% else %><%= vcs.repository %><% end %></id>
-  <updated><%= Time.now %></updated>
+
+  <updated><%= Time.now.xmlschema %></updated>
+
   <author>
+
     <name><%= user %></name>
+
     <email><%= email %></email>
+
   </author>
 
-  <% changelog.changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+<% changelog.changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+
   <entry>
-    <title><%= h entry.message.lines.first %></title>
-    <id><%= entry.revision %></id>
+
+    <title><%= h entry.message.lines.first.rstrip %></title>
+
+    <id><%= url %>#<%= entry.revision %></id>
+
     <author><%= entry.author %></author>
-    <updated><%= entry.date %></updated>
-    <summary type="html"><%= h entry.message %></summary>
+
+    <updated><%= entry.date.xmlschema %></updated>
+
+    <content type="xhtml">
+
+      <div xmlns="http://www.w3.org/1999/xhtml">
+
+        <%= entry.message %><br/>
+
+        <%= entry.author %> <%= entry.date.strftime('%Y-%m-%d %H:%M:%S') %>
+
+      </div>
+
+    </content>
+
   </entry>
-  <% end %>
+
+<% end %>
 
 </feed>
 

data/lib/vclog/templates/changelog.html.erb

@@ -18,6 +18,7 @@
   <% end %>
 </head>
 <body>
+<h1><%= title %></h1>
 <div class="changelog">
   <% changelog.changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
   <div class="commit">

data/lib/vclog/templates/changelog.rss.erb

@@ -0,0 +1,58 @@
+<?xml version="1.0"?>
+
+<rss version="2.0">
+
+  <channel>
+
+    <title><%= h title %></title>
+
+    <% if url %><link><%= url %></link><% end %>
+
+    <% if homepage %><link><%= homepage %></link><% end %>
+
+    <description>Release History</description>
+
+    <language>en-us</language>
+
+    <pubDate><%= Time.now.rfc822 %></pubDate>
+
+    <lastBuildDate><%= Time.now.rfc822 %></lastBuildDate>
+
+    <docs>http://blogs.law.harvard.edu/tech/rss</docs>
+
+    <generator>VCLog</generator>
+
+    <managingEditor><%= email %> (<%= user %>)</managingEditor>
+
+    <webMaster><%= email %> (<%= user %></webMaster>
+
+<% changelog.changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+
+    <item>
+
+      <title><%= h entry.message.lines.first.rstrip %></title>
+
+      <author><%= entry.author %></author>
+
+      <link></link>
+
+      <pubDate><%= entry.date.rfc822 %></pubDate>
+
+      <guid><%= url %>#<%= entry.revision %></guid>
+
+      <description><![CDATA[
+
+        <%= entry.message %><br/>
+
+        <%= entry.author %> <%= entry.date.strftime('%Y-%m-%d %H:%M:%S') %>
+
+      ]]></description>
+
+    </item>
+
+<% end %>
+
+  </channel>
+
+</rss>
+

data/lib/vclog/templates/history.atom.erb

@@ -1,46 +1,84 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
 
 <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 url %><link href="<%= url %>" /><% end %>
+ 
   <% if homepage %><link href="<%= homepage %>" /><% end %>
+
   <id><% if vcs.uuid %>urn:uuid:<%= vcs.uuid %><% else %><%= vcs.repository %><% end %></id>
-  <updated><%= Time.now %></updated>
+
+  <updated><%= Time.now.xmlschema %></updated>
+
   <author>
+
     <name><%= user %></name>
+
     <email><%= email %></email>
+
   </author>
 
-  <% history.releases.sort.each do |release| %>
-  <% tag = release.tag %>
+<% 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].label %></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>
+
+    <title><%= h tag.name %></title>
+
+    <id><%= url %>#<%= tag.revision %></id>
+
+    <author><name><%= h tag.author %><name></author>
+
+    <updated><%= tag.date.xmlschema %></updated>
+
+    <summary><%= h tag.message %></summary>
+
+    <content type="xhtml">
+
+      <div xmlns="http://www.w3.org/1999/xhtml">
+
+        <p><%= tag.message %></p>
+
+<% if options.extra %>
+
+<% release.groups.each do |number, changes| %>
+
+        <h2><%= changes.size %> <%= changes[0].label %></h2>
+
+        <ul class="log">
+
+<% changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+
+          <li class="entry">
+
+            <%= entry.message.rstrip %><br/>
+
+            <%= entry.author %> <%= entry.date.strftime('%Y-%m-%d %H:%M:%S') %>
+
+            <% if options.revision %>(#<%= entry.revision %>)<% end %>
+
+          </li>
+
+<% end %>
+
+        </ul>
+
+<% end %>
+
+<% end %>
+
+      </div>
+
+    </content>
+
   </entry>
-  <% end %>
+
+<% end %>
 
 </feed>
 

data/lib/vclog/templates/history.rss.erb

@@ -0,0 +1,86 @@
+<?xml version="1.0"?>
+
+<rss version="2.0">
+
+  <channel>
+
+    <title><%= title %></title>
+
+    <% if url %><link><%= url %></link><% end %>
+
+    <% if homepage %><link><%= homepage %></link><% end %>
+
+    <description>Release History</description>
+
+    <language>en-us</language>
+
+    <pubDate><%= Time.now.rfc822 %></pubDate>
+
+    <lastBuildDate><%= Time.now.rfc822 %></lastBuildDate>
+
+    <docs>http://blogs.law.harvard.edu/tech/rss</docs>
+
+    <generator>VCLog</generator>
+
+    <managingEditor><%= email %> (<%= user %>)</managingEditor>
+
+    <webMaster><%= email %> (<%= user %>)</webMaster>
+
+<% history.releases.sort.each do |release| %>
+
+<% tag = release.tag %>
+
+    <item>
+
+      <title><%= tag.name %></title>
+
+      <author><%= tag.author %></author>
+
+      <link><%= url %>#<%= tag.revision %></link>
+
+      <pubDate><%= tag.date.rfc822 %></pubDate>
+
+      <guid isPermaLink="false"><%= url %>#<%= tag.revision %></guid>
+
+      <description><![CDATA[
+
+        <p><%= tag.message %></p>
+
+<% if options.extra %>
+
+<% release.groups.each do |number, changes| %>
+
+        <h2><%= changes.size %> <%= changes[0].label %></h2>
+
+        <ul class="log">
+
+<% changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+
+          <li class="entry">
+
+            <%= entry.message.rstrip %><br/>
+
+            <%= entry.author %> <%= entry.date.strftime('%Y-%m-%d %H:%M:%S') %>
+
+            <% if options.revision %>(#<%= h entry.revision %>)<% end %>           
+
+          </li>
+
+<% end %>
+
+        </ul>
+
+<% end %>
+
+<% end %>
+
+      ]]></description>
+
+    </item>
+
+<% end %>
+
+  </channel>
+
+</rss>
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vclog
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 1
   - 6
-  - 0
-  version: 1.6.0
+  - 1
+  version: 1.6.1
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-21 00:00:00 -04:00
+date: 2010-06-23 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 11
         segments: 
@@ -41,10 +41,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 11
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 2
+        version: "1.2"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -133,6 +134,7 @@ files:
 - lib/vclog/templates/changelog.json.rb
 - lib/vclog/templates/changelog.markdown.rb
 - lib/vclog/templates/changelog.rdoc.rb
+- lib/vclog/templates/changelog.rss.erb
 - lib/vclog/templates/changelog.xml.erb
 - lib/vclog/templates/changelog.xsl
 - lib/vclog/templates/changelog.yaml.rb
@@ -143,6 +145,7 @@ files:
 - lib/vclog/templates/history.json.rb
 - lib/vclog/templates/history.markdown.rb
 - lib/vclog/templates/history.rdoc.rb
+- lib/vclog/templates/history.rss.erb
 - lib/vclog/templates/history.xml.erb
 - lib/vclog/templates/history.yaml.rb
 - lib/vclog.rb