vclog 1.2 → 1.4.0

data/HISTORY.rdoc

@@ -0,0 +1,87 @@
+= RELEASE HISTORY
+
+== 1.4.0 / 2010-05-26
+
+This release includes some basic improvments and a few bug fixes. The primary change you might encounter is the need to use -e or --extra in order to see the detailed Changes list in the Release History. Also changed 'git-log' to 'git log', as it seems the latest versions of git does not support the many executables any longer. SVN support requires xmlsimple library. Note also that SVN support is lack luster at this time becuase it hits the server every time an 'svn log' command is issued which is done once for each tag when a history is generated (any one know a better way?).
+
+Changes:
+
+* 1 Minor Enhancement
+
+  * Use -e or --extra to see Changes list in release history.
+  * Use xmlsimple for parsing SVN log output.
+  * Improve git log parsing with --pretty option.
+
+* 2 Bug Fixes
+
+  * Sort release tags in correct order.
+  * Change 'git-log' to 'git log'.
+
+
+== 1.3.0 / 2010-02-08
+
+For the an end-user the only significant change is the support of 'label:' notation for commit labels. I have found that I am much more apt to use them if they come first in the commit message and that some developers already use the 'label:' notation to specify 'system module' effected --a useful system of labeling.
+
+Changes:
+
+* 1 Major Enhancement
+
+  * Support 'label:' fromat commit types
+
+* 2 Implementation Enhancements
+
+  * Adjust location of plugins for latest version of Plugin gem.
+  * Use Erb as template system for all formats.
+
+* 1 Bug Fix
+
+  * Corrected error for --current and --bump commands.
+
+
+== 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.
+    * Added JSON format.
+
+* 1 Minor Enhancements
+
+    * Use OptionParser instead of GetoptLong.
+
+
+== 1.0.0 / 2009-10-13
+
+This is the first "production" release of VCLog.
+
+* 2 Major Enhancements
+
+    * Improved command line interface.
+    * Added output option to save changelog.
+
+
+== 0.1.0 / 2009-08-17
+
+This is the initial version of vclog.
+
+* 1 Major Enhancement
+
+    * Happy Birthday
+

data/PROFILE

@@ -0,0 +1,17 @@
+--- 
+title    : VCLog
+summary  : Cross-VCS/SCM ChangeLog Generator
+copyright: Copyright (c) 2009 Thomas Sawyer
+license  : GPL3
+suite    : proutils
+authors  : Thomas Sawyer
+created  : 2006-05-09
+contact  : http://googlegroups.com/group/proutils
+
+description:
+  VCLog is a cross-VCS/SCM ChangeLog generator.
+
+resources:
+  homepage: http://proutils.rubyforge.org/vclog
+  repository: git://github.com/proutils/vclog.git
+

data/REQUIRE

@@ -0,0 +1,9 @@
+runtime:
+- facets >2.4
+
+development:
+- syckle
+
+development/test:
+- cucumber
+

data/{TODO → ROADMAP.rdoc}

@@ -1,22 +1,5 @@
 = 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.
-
-
 == Automagical Version
 
 Would be cool if it could also generate an automagical version number.

data/VERSION

@@ -0,0 +1,5 @@
+name : vclog
+major: 1
+minor: 4
+patch: 0
+date : 2010-05-26

data/bin/vclog

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

data/features/history.feature

@@ -0,0 +1,16 @@
+Feature: Release History
+  As a SCM user
+  I want to generate a nicely formatted Release History
+
+  Scenario: SVN History
+    Given a SVN repository
+    When I generate a History
+    Then it should include all tags
+    And the list of releases should be in order from newest to oldest
+
+  Scenario: Git History
+    Given a Git repository
+    When I generate a History
+    Then it should include all tags
+    And the list of releases should be in order from newest to oldest
+

data/features/step_definitions/history_steps.rb

@@ -0,0 +1,29 @@
+Given /^a SVN repository/ do
+  @directory = File.dirname(__FILE__) + '/../../test/fixtures/tzinfo'
+  @tag_numbers = Dir["@directory/tags/*"].map{ |d| File.basename(d) }
+end
+
+# For git we will have to use the VCLog project itself, I guess.
+Given /^a Git repository/ do
+  @directory = File.dirname(__FILE__) + '/../..' #/fixtures/git-repo'
+  tags1 = `cd #{@directory}; git tag -l "[0-9]*"`
+  tags2 = `cd #{@directory}; git tag -l "v[0-9]*"`
+  @tag_numbers = tags1.split("\n") + tags2.split("\n")
+end
+
+When /I generate a History/ do
+  @system  = VCLog::VCS.factory(@directory)
+  @history = VCLog::History.new(@system)
+end
+
+Then /it should include all tags/ do
+  tags = @history.tags.map{ |t| t.name }
+  tags.sort.assert == @tag_numbers.sort
+end
+
+And /^the list of releases should be in order from newest to oldest/ do
+  rels_names = @history.releases.map{ |r| r.tag.name }
+  rels_names.shift # remove imaginary current tag
+  rels_names.assert == @tag_numbers.sort.reverse
+end
+

data/features/support/ae.rb

@@ -0,0 +1 @@
+require 'ae'

data/features/support/loadpath.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift( File.dirname(__FILE__) + '/../../lib' )
+require 'vclog'

data/lib/plugins/syckle/vclog.rb

@@ -0,0 +1,194 @@
+module Syckle::Plugins
+
+  # VClog service generates changelogs from
+  # SCM commit messages.
+  #
+  class VClog < Service
+
+    cycle :main, :document
+
+    #available do |project|
+    #  begin
+    #    require 'vclog/vcs'
+    #    true
+    #  rescue LoadError
+    #    false
+    #  end
+    #end
+
+    # Current version of project.
+    attr_accessor :version
+
+    # Changelog format. Default is +html+.
+    # Supports +html+, +xml+, +json+, +yaml+, +rdoc+, +markdown+, and +gnu+.
+    attr_accessor :format
+
+    # Changelog layout type (+log+ or +rel+). Default is +log+.
+    attr_accessor :type
+
+    # Output file to store changelog.
+    # The defualt is 'log/vclog/changelog.{format}'.
+    attr_accessor :output
+
+    # Show revision numbers (true/false)?
+    attr_accessor :rev
+
+    # Some formats, such as +rdoc+, use a title field. Defaults to project title.
+    attr_accessor :title
+
+    # Some formats can reference an optional stylesheet (namely +xml+ and +html+).
+    attr_accessor :style
+
+    #
+    def initialize_defaults
+      require 'vclog/vcs'
+      @version    = metadata.version
+      @title      = metadata.title
+      @format     = 'html'
+      @type       = 'log'
+    end
+
+    #
+    def valid?
+      return false unless format =~ /^(html|yaml|json|xml|rdoc|markdown|gnu|txt)$/
+      return false unless type   =~ /^(log|rel|history|changelog)$/
+      return true
+    end
+
+    #
+    def format=(f)
+      @format = f.to_s.downcase
+    end
+
+    #
+    def type=(f)
+      @type = f.to_s.downcase
+    end
+
+    # Generate changelog.
+    def document
+      document_changelog
+    end
+
+    #++
+    # TODO: apply_naming_policy ?
+    #--
+
+    def document_changelog
+      case type
+      when 'rel', 'history'
+        file = output || (project.log + "vclog/history.#{format}").to_s
+      else
+        file = output || (project.log + "vclog/changelog.#{format}").to_s
+      end
+      #apply_naming_policy('changelog', log_format.downcase)
+      if dryrun?
+        report "# vclog --#{type} --#{format} -o #{file}"
+      else
+        changed = save(file)
+        if changed
+          report "Updated #{relative_from_root(file)}"
+        else
+          report "#{relative_from_root(file)} is current"
+        end
+      end
+    end
+
+    # Save changelog/history to +output+ file.
+    def save(output)
+      text = render
+      if File.exist?(output)
+        if File.read(output) != text
+          File.open(output, 'w'){ |f| f << text }
+          true
+        else
+          false
+        end
+      else
+        dir = File.dirname(output)
+        mkdir_p(dir) unless File.exist?(dir)
+        File.open(output, 'w'){ |f| f << text }
+      end
+    end
+
+    # Returns changelog or history depending on type selection.
+    def log
+      @log ||= (
+        case type
+        when 'log', 'changelog'
+          log = vcs.changelog
+        when 'rel', 'history'
+          log = vcs.history(:title=>title, :version=>version)
+        else
+          log = vcs.changelog
+        end
+      )
+    end
+
+    # Access to version control system.
+    def vcs
+      #@vcs ||= VCLog::VCS.new #(self)
+      @vcs ||= VCLog::VCS.factory #(root)
+    end
+
+    # Convert log to desiered format.
+    def render
+      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
+      txt
+    end
+
+
+=begin
+    #
+    def document_public_changelog
+      if output
+        file = project.root + output
+      else
+        file = project.root.glob_first("{CHANGES,CHANGELOG}{.txt,}", :casefold)
+      end
+
+      if file
+        #file = (project.root + file).to_s
+        if dryrun?
+          report "vclog > #{file}"
+        else
+          public_changelog = typed ? changelog.typed : changelog
+          if layout == 'rel'
+            changed = public_changelog.save(file.to_s, :rel, metadata.version, metadata.release)
+          else
+            changed = public_changelog.save(file.to_s, :gnu)
+          end
+          if changed
+            report "Updated #{relative_from_root(file)}"
+          else
+            report "#{relative_from_root(file)} is current"
+          end
+        end
+      end
+    end
+=end
+
+    #
+    def relative_from_root(path)
+      Pathname.new(path).relative_path_from(project.root)
+    end
+
+  end
+
+end
+

data/lib/vclog/changelog.rb

@@ -15,6 +15,8 @@ module VCLog
 
     include Enumerable
 
+    DIR = File.dirname(__FILE__)
+
     DAY = 24*60*60
 
     attr :changes
@@ -124,46 +126,91 @@ module VCLog
     #  mapped
     #end
 
-    ##################
-    # Output Formats #
-    ##################
+    # O U T P U T  F O R M A T S
+
+    #
+
+#    def to_gnu(rev=false)
+#      x = []
+#      by_date.each do |date, date_changes|
+#        date_changes.by_author.each do |author, author_changes|
+#          x << %[#{date}  #{author}\n]
+#          #author_changes = author_changes.sort{|a,b| b.date <=> a.date}
+#          author_changes.each do |entry|
+#            if entry.type
+#              msg = "#{entry.message} [#{entry.type}]".tabto(10)
+#            else
+#              msg = "#{entry.message}".tabto(10)
+#            end
+#            msg << " (#{entry.revision})" if rev
+#            msg[8] = '*'
+#            x << msg
+#          end
+#        end
+#        x << "\n"
+#      end
+#      return x.join("\n")
+#    end
+
+    #
+
+    def to_gnu(rev=false)
+      tmp = File.read(File.join(DIR, 'templates', 'changelog.gnu'))
+      erb = ERB.new(tmp)
+      erb.result(binding)
+    end
+
+    #
 
     def to_yaml
       require 'yaml'
       changes.to_yaml
     end
 
+    #
+
     def to_json
       require 'json'
       changes.to_json
     end
 
     #
-    def to_gnu(rev=false)
-      x = []
-      by_date.each do |date, date_changes|
-        date_changes.by_author.each do |author, author_changes|
-          x << %[#{date}  #{author}\n]
-          #author_changes = author_changes.sort{|a,b| b.date <=> a.date}
-          author_changes.each do |entry|
-            if entry.type
-              msg = "#{entry.message} [#{entry.type}]".tabto(10)
-            else
-              msg = "#{entry.message}".tabto(10)
-            end
-            msg << " (#{entry.revision})" if rev
-            msg[8] = '*'
-            x << msg
-          end
-        end
-        x << "\n"
-      end
-      return x.join("\n")
+    alias_method :to_s, :to_gnu
+
+    # Translate changelog into a XML document.
+
+    def to_xml(xsl=nil)
+      tmp = File.read(File.join(DIR, 'templates', 'changelog.xml'))
+      erb = ERB.new(tmp)
+      erb.result(binding)
     end
 
-    #
-    alias_method :to_s, :to_gnu
+    # Create an HTML formated changelog.
+    # +css+ reference defaults to 'log.css'
 
+    def to_html(css=nil)
+      tmp = File.read(File.join(DIR, 'templates', 'changelog.html'))
+      erb = ERB.new(tmp)
+      erb.result(binding)
+    end
+
+    # Translate history into a RDoc formatted document.
+
+    def to_rdoc(rev=false)
+      tmp = File.read(File.join(DIR, 'templates', 'changelog.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', 'changelog.markdown'))
+      erb = ERB.new(tmp)
+      erb.result(binding)
+    end
+
+=begin
     # Create an XML formated changelog.
     # +xsl+ reference defaults to 'log.xsl'
     def to_xml(xsl=nil)
@@ -184,9 +231,9 @@ module VCLog
       x << %[</log>]
       return x.join("\n")
     end
+=end
 
-    # Create an HTML formated changelog.
-    # +css+ reference defaults to 'log.css'
+=begin
     def to_html(css=nil)
       css = 'log.css' if css.nil?
       x = []
@@ -195,7 +242,7 @@ module VCLog
       x << %[  <title>ChangeLog</title>]
       x << %[  <style>]
       x << %[    body{font-family: sans-serif;}]
-      x << %[    #changelog{width:800px;margin:0 auto;}]
+      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;}]
@@ -205,7 +252,7 @@ module VCLog
       x << %[  <link rel="stylesheet" href="#{css}" type="text/css">] if css
       x << %[</head>]
       x << %[<body>]
-      x << %[  <div id="changelog">]
+      x << %[  <div class="changelog">]
       x << %[    <h1>ChangeLog</h1>]
       x << %[    <ul class="log">]
       changes.sort{|a,b| b.date <=> a.date}.each do |entry|
@@ -223,61 +270,20 @@ module VCLog
       x << %[</html>]
       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
+=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")
+    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
@@ -434,20 +440,6 @@ end
       end if different
     end
 
-  private
-
-    #
-    def escxml(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
-
     #
     def save_xsl(file)
       #xslfile = file.chomp(File.extname(file)) + '.xsl'
@@ -459,42 +451,5 @@ end
         end
       end
     end
-
-
-  DEFAULT_LOG_XSL = <<-END.tabto(0)
-    <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>
-  END
 =end