vclog 1.0.0 → 1.1

data/HISTORY.md

@@ -0,0 +1,35 @@
+# RELEASE HISTORY
+
+## 1.1 / 2009-10-23
+
+This release adds yaml and json formats an improves
+the command.
+
+* 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/LICENSE

@@ -0,0 +1,23 @@
+The MIT License
+
+Copyright (c) 2009 Thomas Sawyer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+

data/MANIFEST

@@ -1,32 +1,32 @@
-test
-RELEASE
+HISTORY.md
+LICENSE
+MANIFEST
 README
-HISTORY
-meta
-meta/created
-meta/repository
-meta/homepage
-meta/summary
-meta/package
-meta/title
-meta/version
-meta/license
-meta/sitemap
-meta/mailinglist
-meta/authors
-meta/requires
-meta/project
-meta/description
-lib
+TODO
+bin/vclog
 lib/vclog
 lib/vclog/changelog.rb
-lib/vclog/core_ext.rb
+lib/vclog/command.rb
+lib/vclog/facets.rb
 lib/vclog/vcs
+lib/vclog/vcs.rb
 lib/vclog/vcs/darcs.rb
 lib/vclog/vcs/git.rb
-lib/vclog/vcs/svn.rb
 lib/vclog/vcs/hg.rb
-lib/vclog/vcs.rb
-bin
-bin/vclog
-COPYING
+lib/vclog/vcs/svn.rb
+meta/authors
+meta/contact
+meta/created
+meta/description
+meta/homepage
+meta/license
+meta/loadpath
+meta/parent
+meta/project
+meta/repository
+meta/requires
+meta/ruby
+meta/sitemap
+meta/summary
+meta/title
+meta/version

data/README

@@ -6,13 +6,14 @@
 
 == DESCRIPTION
 
-VClog is an cross-VCS/SCM changelog generator.
+VCLog is a versitle cross-VCS/SCM changelog generator.
+It currently supports Git and Subversion.
 
 
 == SYNOPSIS
 
-VCLog generates changelogs. It supports a few different formats. The default
-format is standard GNU text style. From a repository's root directory try:
+By default the format is a standard GNU text style. From a
+repository's root directory try:
 
   $ vclog
 
@@ -25,14 +26,20 @@ See 'vclog --help' for more options.
 
 == RELEASE NOTES
 
-Please see RELEASE file.
+Please see HISTORY file.
 
 
-== LICENSE & COPYRIGHT
+== COPYRIGHTS
 
-VCLog
+Copyright (c) 2009 Thomas Sawyer
 
-Copyright (c) 2008,2009 TigerOps.org
+MIT License. See LICENSE or COPYING file for more details.
 
-VCLog is distributed under the terms of the GPLv3 license.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
 

data/TODO

@@ -0,0 +1,32 @@
+= TODO
+
+== 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.
+
+=== For Git
+
+We started off by looking at what git can tell us about the current release:
+
+    * git-rev-parse <id> tells up what the ID of the <id> is, we can find out the current commit's ID by using HEAD (or nothing at all)
+    * git-rev-list <id>..HEAD tells us what the commits were between the <id> and the current commit
+    * git-describe <id> shows us, in a nice format, a unique description of the commit.
+
+Using all of this together Patrick came up with:
+
+    BRANCH=`git-describe | awk -F'-g[0-9a-fA-F]+' '{print $1}'`
+    COMMIT=`git-rev-parse HEAD | awk '{print substr($1,0,8)}'`
+    INCREMENT=`git-rev-list $BRANCH..HEAD | wc -l | awk '{print $1}'` 
+    TGZ="openswan-$BRANCH-($INCREMENT)-g$COMMIT.tgz"
+
+What this attempts to achieve is create a tar ball name that describes the release using the last tag, the number of builds since the tag was made, and the short commit ID. Here is the breakdown of the bits:
+
+    * BRANCH will tell us what major release this is a part of,
+    * INCREMENT is a pseudo build number (it's really the number of commits since the last release), and
+    * g*COMMIT* is the short ID of the commit that generated the build.
+

data/bin/vclog

@@ -1,131 +1,4 @@
 #!/usr/bin/env ruby
+load 'vclog/command'
+VCLog.run
 
-# vclog
-#
-# SYNOPSIS
-#
-# VCLog provides cross-vcs ChangeLogs. It works by
-# parsing the native changelog a VCS system produces
-# into a common model, which then can be used to
-# produce Changelogs in a variety of formats.
-#
-# VCLog currently support SVN and Git. CVS, Darcs and
-# Mercurial/Hg are in the works.
-#
-# EXAMPLES
-#
-# To produce a GNU-like changelog:
-#
-#  $ vclog
-#
-# For XML format:
-#
-#  $ vclog --xml
-#
-# Or for a micorformat-ish HTML:
-#
-#  $ vclog --html
-#
-#To use the library programmatically, please see the API documentation.
-#
-# LICENSE
-#
-#   VCLog Copyright (c) 2008 Tiger Ops
-#   VCLog is distributed under the terms of the GPLv3.
-
-require 'vclog/vcs'
-require 'getoptlong'
-
-# TODO: rev option.
-#
-def vclog
-
-  opts = GetoptLong.new(
-    [ '--help' , '-h',  GetoptLong::NO_ARGUMENT ],
-    [ '--debug',        GetoptLong::NO_ARGUMENT ],
-    [ '--typed',        GetoptLong::NO_ARGUMENT ],
-    [ '--rev'  ,        GetoptLong::NO_ARGUMENT ],
-    [ '--gnu'  ,        GetoptLong::NO_ARGUMENT ],
-    [ '--xml'  ,        GetoptLong::NO_ARGUMENT ],
-    [ '--html' ,        GetoptLong::NO_ARGUMENT ],
-    [ '--rel'  ,        GetoptLong::REQUIRED_ARGUMENT ],
-    [ '--style',        GetoptLong::REQUIRED_ARGUMENT ],
-    [ '--output', '-o', GetoptLong::REQUIRED_ARGUMENT ]
-  )
-
-  format = :gnu
-  typed  = false
-  rev    = false
-  vers   = nil
-  style  = nil
-  output = nil
-
-  opts.each do |opt, arg|
-    case opt
-    when '--help'
-      puts "vclog [--gnu|--html|--xml|--rel] [--typed]"
-      exit
-    when '--debug'
-      $DEBUG = true
-    when '--typed'
-      typed = true
-    when '--rev'
-      rev = true
-    when '--xml'
-      format = :xml
-    when '--html'
-      format = :html
-    when '--rel'
-      format = :rel
-      vers = arg
-    when '--style'
-      style = arg
-    when '--output'
-      output = arg
-    end
-  end
-
-  vcs = VCLog::VCS.new
-
-  changelog = vcs.changelog
-
-  if typed
-    changelog = changelog.typed
-  end
-
-  case format
-  when :xml
-    log = changelog.format_xml(style)   # xsl stylesheet url
-  when :html
-    log = changelog.format_html(style)  # css stylesheet url
-  when :rel
-    if output && File.file?(output)
-      file = output
-    else
-      file = Dir.glob('change{s,log}{,.txt}', File::FNM_CASEFOLD).first
-    end
-    log = changelog.format_rel(file, vers)
-  else #:gnu
-    log = changelog.to_s
-  end
-
-  if output
-    File.open(output, 'w') do |f|
-      f << log
-    end
-  else
-    puts log
-  end
-
-end
-
-begin
-  vclog
-rescue => err
-  if $DEBUG
-    raise err
-  else
-    puts err.message
-    exit -1
-  end
-end

data/lib/vclog/changelog.rb

@@ -1,6 +1,6 @@
 module VCLog
 
-  require 'vclog/core_ext'
+  require 'vclog/facets'
 
   # Supports output formats:
   #
@@ -11,6 +11,7 @@ module VCLog
   #   text
   #
   class Changelog
+
     include Enumerable
 
     DAY = 24*60*60
@@ -200,7 +201,7 @@ module VCLog
     end
 
     #
-    def format_rel(file, current_version=nil, current_release=nil)
+    def format_rel(file, current_version=nil, current_release=nil, rev=false)
       log = []
       # collect releases already listed in changelog file
       rels = releases(file)
@@ -246,7 +247,7 @@ module VCLog
           #lt_date = Time.parse(lt_date) unless Time===lt_date
           changes = before(lt_date)
         end
-        reltext = changes.format_rel_types
+        reltext = changes.format_rel_types(rev)
         unless reltext.strip.empty?
           log << "== #{lt_vers} / #{lt_date.strftime('%Y-%m-%d')}\n\n#{reltext}"
         end
@@ -256,7 +257,7 @@ module VCLog
     end
 
     #
-    def format_rel_types
+    def format_rel_types(rev=false)
       groups = changes.group_by{ |e| e.type_number }
       string = ""
       5.times do |n|
@@ -267,7 +268,11 @@ module VCLog
         entries.sort!{|a,b| a.date <=> b.date }
         entries.each do |entry|
           #string << "== #{date}  #{who}\n\n"  # no email :(
-          text = "#{entry.message} (##{entry.revison})"
+          if rev
+            text = "#{entry.message} (##{entry.revison})"
+          else
+            text = "#{entry.message}"
+          end
           text = text.tabto(6)
           text[4] = '*'
           #entry = entry.join(' ').tabto(6)
@@ -358,7 +363,7 @@ 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)
@@ -381,7 +386,7 @@ module VCLog
       attr_accessor :type
 
       def initialize(opts={})
-        @author  = opts[:author]  || opts[:who]
+        @author  = (opts[:author]  || opts[:who]).strip
         @date    = opts[:date]    || opts[:when]
         @revison = opts[:revison] || opts[:rev]
         @message = opts[:message] || opts[:msg]
@@ -409,7 +414,9 @@ module VCLog
         when 'bug'
           'Bug Fixes'
         when ''
-          'Further Enhancements'
+          'General Enhancements'
+        when '-'
+          'Administrative Changes'
         else
           "#{type.capitalize} Enhancements"
         end
@@ -426,6 +433,8 @@ module VCLog
           2
         when ''
           4
+        when '-'
+          5
         else # other
           3
         end
@@ -440,6 +449,23 @@ module VCLog
         "#<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

data/lib/vclog/command.rb

@@ -0,0 +1,168 @@
+module VCLog
+
+  require 'vclog/vcs'
+  require 'optparse'
+
+  # = vclog Command
+  #
+  # == SYNOPSIS
+  #
+  # VCLog provides cross-vcs ChangeLogs. It works by
+  # parsing the native changelog a VCS system produces
+  # into a common model, which then can be used to
+  # produce Changelogs in a variety of formats.
+  #
+  # VCLog currently support SVN and Git. CVS, Darcs and
+  # Mercurial/Hg are in the works.
+  #
+  # == EXAMPLES
+  #
+  # To produce a GNU-like changelog:
+  #
+  #  $ vclog
+  #
+  # For XML format:
+  #
+  #  $ vclog --xml
+  #
+  # Or for a micorformat-ish HTML:
+  #
+  #  $ vclog --html
+  #
+  # To use the library programmatically, please see the API documentation.
+
+  def self.run
+    begin
+      vclog
+    rescue => err
+      if $DEBUG
+        raise err
+      else
+        puts err.message
+        exit -1
+      end
+    end
+  end
+
+  #
+  def self.vclog
+    format = :gnu
+    typed  = false
+    rev    = false
+    vers   = nil
+    style  = nil
+    output = nil
+
+    optparse = OptionParser.new do |opt|
+      opt.separator("FORMAT (choose one):")
+
+      opt.on('--gnu', "GNU standard format") do
+        format = :gnu
+      end
+
+      opt.on('--xml [XSL]', "XML format") do |file|
+        format = :xml
+        style  = file
+      end
+
+      opt.on('--yaml', "YAML format") do
+        format = :yaml
+      end
+
+      opt.on('--json', "JSON format") do
+        format = :json
+      end
+
+      opt.on('--html [CSS]', "HTML micro-like format") do |file|
+        format = :html
+        style  = file
+      end
+
+      opt.on('--rel <VER>', "release format") do |version|
+        format = :rel
+        vers = version
+      end
+
+      opt.on('--rev <VER>', "release format w/ revison ids") do |version|
+        format = :rev
+        vers = version
+      end
+
+      opt.separator("OTHER OPTIONS:")
+
+      opt.on('--typed', "catagorize by commit type") do
+        typed = true
+      end
+
+      #opt.on('--style [FILE]', "provide a stylesheet (css or xsl)") do |val|
+      #  style = val
+      #end
+
+      opt.on('--output', '-o [FILE]', "send output to a file instead of stdout") do |out|
+        output = out
+      end
+
+      opt.separator("STANDARD OPTIONS:")
+
+      opt.on('--debug', "show debugging infromation") do
+        $DEBUG = true
+      end
+
+      opt.on_tail('--help' , '-h', 'display this help information') do
+        puts opt
+        exit
+      end
+    end
+
+    optparse.parse!(ARGV)
+
+    vcs = VCLog::VCS.new
+
+    changelog = vcs.changelog
+
+    if typed
+      changelog = changelog.typed
+    end
+
+    case format
+    when :xml
+      log = changelog.format_xml(style)   # xsl stylesheet url
+    when :html
+      log = changelog.format_html(style)  # css stylesheet url
+    when :yaml
+      log = changelog.format_yaml
+    when :json
+      log = changelog.format_json
+    when :rel
+      file = changelog_file(output)
+      raise "no previous log to go by" unless file
+      log = changelog.format_rel(file, vers, nil, false)
+    when :rev
+      file = changelog_file(output)
+      raise "no previous log to go by" unless file
+      log = changelog.format_rel(file, vers, nil, true)
+    else #:gnu
+      log = changelog.to_s
+    end
+
+    if output
+      File.open(output, 'w') do |f|
+        f << log
+      end
+    else
+      puts log
+    end
+  end
+
+  def self.changelog_file(file)
+    if file && File.file?(file)
+      file
+    else
+      Dir.glob('{history,changes,changelog}{,.*}', File::FNM_CASEFOLD).first
+    end
+  end
+
+end
+
+# VCLog Copyright (c) 2008 Thomas Sawyer
+