vclog 1.4.0 → 1.5.0

data/HISTORY.rdoc

@@ -1,5 +1,21 @@
 = RELEASE HISTORY
 
+== 1.5.0 / 2010-05-29
+
+This release adds support for Mercurial repositories and Atom newsfeed output format. The commandline inteface has change such that <code>--foramt</code>/<code>-f</code> is used to select the format instead of using the previous per-format options, e.g. use <code>-f xml</code> instead of <code>--xml</code>. This release also includes some subtantial changes under-the-hood --the first of a two part code refactoring process.
+
+Changes:
+
+* 2 Major Enhancements
+
+  * Add Mercurial support
+  * Add Atom feed format
+
+* 1 Minor Enhancement
+
+  * Select format using -f option.
+
+
 == 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?).

data/PROFILE

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

data/README.rdoc

@@ -19,11 +19,21 @@ repository's root directory try:
 
 To generate an XML formatted changelog use:
 
-  $ vclog --xml
+  $ vclog -f xml
 
 See 'vclog --help' for more options.
 
 
+== NOTE ABOUT SUBVSERION
+
+Because Subversion is a centralized version control system, it contacts
+the server every time 'svn log' is run. For this reason, having vclog
+generate a release history is likely to fail since it must run 'svn log'
+for each tag. Any repository with more than a few tags may be denied
+access by the server for making too many rapid requests. I have no
+idea how to remedy this issue. If you have any ideas please let me know.
+
+
 == RELEASE NOTES
 
 Please see HISTORY file.

data/REQUIRE

@@ -6,4 +6,5 @@ development:
 
 development/test:
 - cucumber
+- aruba
 

data/ROADMAP.rdoc

@@ -1,6 +1,10 @@
-= TODO
+= ROADMAP
 
-== Automagical Version
+== Subversion History Support
+
+Generating a Relase History for a svn repo is painfully slow and will likely fail due to hitting the server too many times in rapid succession. Is there another way?
+
+== Automagical Version Numbers
 
 Would be cool if it could also generate an automagical version number.
 

data/VERSION

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

data/features/git.feature

@@ -0,0 +1,86 @@
+Feature: Git Support
+  As a Git user
+  I want to generate a nicely formatted Changelog
+  And I want to generate a nicely formatted Release History
+
+  Scenario: Git Changelog
+    Given a suitable Git repository
+    When I run "vclog"
+    Then the exit status should be 0
+
+  Scenario: Git Changelog in RDoc
+    Given a suitable Git repository
+    When I run "vclog -f rdoc"
+    Then the exit status should be 0
+
+  Scenario: Git Changelog in Markdown
+    Given a suitable Git repository
+    When I run "vclog -f markdown"
+    Then the exit status should be 0
+
+  Scenario: Git Changelog in HTML
+    Given a suitable Git repository
+    When I run "vclog -f html"
+    Then the exit status should be 0
+
+  Scenario: Git Changelog in XML
+    Given a suitable Git repository
+    When I run "vclog -f xml"
+    Then the exit status should be 0
+
+  Scenario: Git Changelog in Atom
+    Given a suitable Git repository
+    When I run "vclog -f atom"
+    Then the exit status should be 0
+
+  Scenario: Git Changelog in YAML
+    Given a suitable Git repository
+    When I run "vclog -f yaml"
+    Then the exit status should be 0
+
+  Scenario: Git Changelog in JSON
+    Given a suitable Git repository
+    When I run "vclog -f json"
+    Then the exit status should be 0
+
+
+  Scenario: Git Release History
+    Given a suitable Git repository
+    When I run "vclog -r"
+    Then the exit status should be 0
+
+  Scenario: Git Release History in RDoc
+    Given a suitable Git repository
+    When I run "vclog -r -f rdoc"
+    Then the exit status should be 0
+
+  Scenario: Git Release History in Markdown
+    Given a suitable Git repository
+    When I run "vclog -r -f markdown"
+    Then the exit status should be 0
+
+  Scenario: Git Release History in HTML
+    Given a suitable Git repository
+    When I run "vclog -r -f html"
+    Then the exit status should be 0
+
+  Scenario: Git Release History in XML
+    Given a suitable Git repository
+    When I run "vclog -r -f xml"
+    Then the exit status should be 0
+
+  Scenario: Git Release History in Atom
+    Given a suitable Git repository
+    When I run "vclog -r -f atom"
+    Then the exit status should be 0
+
+  Scenario: Git Release History in YAML
+    Given a suitable Git repository
+    When I run "vclog -r -f yaml"
+    Then the exit status should be 0
+
+  Scenario: Git Release History in JSON
+    Given a suitable Git repository
+    When I run "vclog -r -f json"
+    Then the exit status should be 0
+

data/features/hg.feature

@@ -0,0 +1,86 @@
+Feature: Mercurial Support
+  As a Mercurial user
+  I want to generate a nicely formatted Changelog
+  And I want to generate a nicely formatted Release History
+
+  Scenario: Mercurial Changelog
+    Given a suitable Mercurial repository
+    When I run "vclog"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Changelog in RDoc
+    Given a suitable Mercurial repository
+    When I run "vclog -f rdoc"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Changelog in Markdown
+    Given a suitable Mercurial repository
+    When I run "vclog -f markdown"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Changelog in HTML
+    Given a suitable Mercurial repository
+    When I run "vclog -f html"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Changelog in XML
+    Given a suitable Mercurial repository
+    When I run "vclog -f xml"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Changelog in Atom
+    Given a suitable Mercurial repository
+    When I run "vclog -f atom"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Changelog in YAML
+    Given a suitable Mercurial repository
+    When I run "vclog -f yaml"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Changelog in JSON
+    Given a suitable Mercurial repository
+    When I run "vclog -f json"
+    Then the exit status should be 0
+
+
+  Scenario: Mercurial Release History
+    Given a suitable Mercurial repository
+    When I run "vclog -r"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Release History in RDoc
+    Given a suitable Mercurial repository
+    When I run "vclog -r -f rdoc"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Release History in Markdown
+    Given a suitable Mercurial repository
+    When I run "vclog -r -f markdown"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Release History in HTML
+    Given a suitable Mercurial repository
+    When I run "vclog -r -f html"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Release History in XML
+    Given a suitable Mercurial repository
+    When I run "vclog -r -f xml"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Release History in Atom
+    Given a suitable Mercurial repository
+    When I run "vclog -r -f atom"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Release History in YAML
+    Given a suitable Mercurial repository
+    When I run "vclog -r -f yaml"
+    Then the exit status should be 0
+
+  Scenario: Mercurial Release History in JSON
+    Given a suitable Mercurial repository
+    When I run "vclog -r -f json"
+    Then the exit status should be 0
+

data/features/step_definitions/repo_steps.rb

@@ -0,0 +1,71 @@
+Given /a suitable Subversion repository/ do
+  url    = "svn://rubyforge.org/var/svn/rubygems"
+  name   = "rubygems"
+  type   = "svn"
+  marker = ".svn"
+  clone  = "svn checkout #{url} #{name}"
+
+  setup_repo(name, type, marker, clone)
+
+  #dir = File.expand_path("tmp/hold/#{type}")
+  #unless File.exist?("#{dir}/#{name}/.svn")
+  #  `mkdir -p #{dir}; cd #{dir}; svn checkout #{url} #{name}`
+  #end
+  #create_dir(type)
+  #cd(type)
+  #run "cp -r #{dir} #{name}"
+  #cd(name)
+end
+
+Given /a suitable Git repository/ do
+  url    = "git://github.com/proutils/vclog.git"
+  name   = "vclog"
+  type   = "git"
+  marker = ".git"
+  clone  = "git clone #{url} #{name}"
+
+  setup_repo(name, type, marker, clone)
+
+  #create_dir('git')
+  #cd('git')
+  #unless File.exist?("#{name}/.git")
+  #  cmd = "git clone #{url} #{name}"
+  #  run cmd
+  #end
+  #cd(name)
+end
+
+Given /a suitable Mercurial repository/ do
+  url    = "http://bitbucket.org/birkenfeld/sphinx"
+  name   = "sphinx"
+  type   = "hg"
+  marker = ".hg"
+  clone  = "hg clone #{url} #{name}"
+
+  setup_repo(name, type, marker, clone)
+
+  #create_dir('hg')
+  #cd('hg')
+  #unless File.exist?("#{name}/.hg")
+  #  cmd = "hg clone #{url} #{name}"
+  #  run cmd
+  #end
+  #cd(name)
+end
+
+Given /a suitable Darcs repository/ do
+  url  = 
+  name = 
+  type   = "darcs"
+  marker = "_darcs"
+  clone  = ""
+
+  #create_dir('darcs')
+  #cd('darcs')
+  #unless File.exist?("#{name}/_darcs")
+  #  cmd = "darcs clone "
+  #  #run cmd
+  #end
+  #cd(name)
+end
+

data/features/support/aruba.rb

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

data/features/support/repo.rb

@@ -0,0 +1,15 @@
+#
+def setup_repo(name, type, marker, clone_command)
+  dir = File.expand_path("tmp/hold/#{type}")
+
+  unless File.exist?("#{dir}/#{name}/#{marker}")
+    $stderr.puts("    #{clone_command}")
+    `mkdir -p #{dir}` unless File.directory?(dir)
+    `cd #{dir}; #{clone_command}`
+  end
+
+  run "cp -r #{dir} #{type}"
+  cd(type)
+  cd(name)
+end
+

data/features/svn.feature

@@ -0,0 +1,86 @@
+Feature: Subversion Support
+  As a Subversion user
+  I want to generate a nicely formatted Changelog
+  And I want to generate a nicely formatted Release History
+
+  Scenario: Subversion Changelog
+    Given a suitable Subversion repository
+    When I run "vclog"
+    Then the exit status should be 0
+
+  Scenario: Subversion Changelog in RDoc
+    Given a suitable Subversion repository
+    When I run "vclog -f rdoc"
+    Then the exit status should be 0
+
+  Scenario: Subversion Changelog in Markdown
+    Given a suitable Subversion repository
+    When I run "vclog -f markdown"
+    Then the exit status should be 0
+
+  Scenario: Subversion Changelog in HTML
+    Given a suitable Subversion repository
+    When I run "vclog -f html"
+    Then the exit status should be 0
+
+  Scenario: Subversion Changelog in XML
+    Given a suitable Subversion repository
+    When I run "vclog -f xml"
+    Then the exit status should be 0
+
+  Scenario: Subversion Changelog in Atom
+    Given a suitable Subversion repository
+    When I run "vclog -f atom"
+    Then the exit status should be 0
+
+  Scenario: Subversion Changelog in YAML
+    Given a suitable Subversion repository
+    When I run "vclog -f yaml"
+    Then the exit status should be 0
+
+  Scenario: Subversion Changelog in JSON
+    Given a suitable Subversion repository
+    When I run "vclog -f json"
+    Then the exit status should be 0
+
+
+  Scenario: Subversion Release History
+    Given a suitable Subversion repository
+    When I run "vclog -r"
+    Then the exit status should be 0
+
+  Scenario: Subversion Release History in RDoc
+    Given a suitable Subversion repository
+    When I run "vclog -r -f rdoc"
+    Then the exit status should be 0
+
+  Scenario: Subversion Release History in Markdown
+    Given a suitable Subversion repository
+    When I run "vclog -r -f markdown"
+    Then the exit status should be 0
+
+  Scenario: Subversion Release History in HTML
+    Given a suitable Subversion repository
+    When I run "vclog -r -f html"
+    Then the exit status should be 0
+
+  Scenario: Subversion Release History in XML
+    Given a suitable Subversion repository
+    When I run "vclog -r -f xml"
+    Then the exit status should be 0
+
+  Scenario: Subversion Release History in Atom
+    Given a suitable Subversion repository
+    When I run "vclog -r -f atom"
+    Then the exit status should be 0
+
+  Scenario: Subversion Release History in YAML
+    Given a suitable Subversion repository
+    When I run "vclog -r -f yaml"
+    Then the exit status should be 0
+
+  Scenario: Subversion Release History in JSON
+    Given a suitable Subversion repository
+    When I run "vclog -r -f json"
+    Then the exit status should be 0
+

data/lib/plugins/syckle/vclog.rb

@@ -3,6 +3,7 @@ module Syckle::Plugins
   # VClog service generates changelogs from
   # SCM commit messages.
   #
+  # TODO: Support multiple formats in one pass.
   class VClog < Service
 
     cycle :main, :document
@@ -21,7 +22,7 @@ module Syckle::Plugins
 
     # Changelog format. Default is +html+.
     # Supports +html+, +xml+, +json+, +yaml+, +rdoc+, +markdown+, and +gnu+.
-    attr_accessor :format
+    attr_accessor :formats
 
     # Changelog layout type (+log+ or +rel+). Default is +log+.
     attr_accessor :type
@@ -41,25 +42,27 @@ module Syckle::Plugins
 
     #
     def initialize_defaults
-      require 'vclog/vcs'
+      require 'vclog'
       @version    = metadata.version
       @title      = metadata.title
-      @format     = 'html'
+      @formats    = ['atom']
       @type       = 'log'
     end
 
     #
     def valid?
-      return false unless format =~ /^(html|yaml|json|xml|rdoc|markdown|gnu|txt)$/
+      return false unless format =~ /^(html|yaml|json|xml|rdoc|markdown|gnu|txt|atom)$/
       return false unless type   =~ /^(log|rel|history|changelog)$/
       return true
     end
 
     #
-    def format=(f)
-      @format = f.to_s.downcase
+    def formats=(f)
+      @formats = f.to_list
     end
 
+    alias_method :format=, :formats=
+
     #
     def type=(f)
       @type = f.to_s.downcase
@@ -75,28 +78,30 @@ module Syckle::Plugins
     #--
 
     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)}"
+      formats.each do |format|
+        case type
+        when 'rel', 'history'
+          file = output || (project.log + "vclog/history.#{format}").to_s
         else
-          report "#{relative_from_root(file)} is current"
+          file = output || (project.log + "vclog/changelog.#{format}").to_s
+        end
+        #apply_naming_policy('changelog', log_format.downcase)
+        if dryrun?
+          report "# vclog --#{type} -f #{format} -o #{file}"
+        else
+          changed = save(format, file)
+          if changed
+            report "Updated #{relative_from_root(file)}"
+          else
+            report "Current #{relative_from_root(file)}"
+          end
         end
       end
     end
 
     # Save changelog/history to +output+ file.
-    def save(output)
-      text = render
+    def save(format, output)
+      text = render(format)
       if File.exist?(output)
         if File.read(output) != text
           File.open(output, 'w'){ |f| f << text }
@@ -111,45 +116,39 @@ module Syckle::Plugins
       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
+    ## 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)
+      @vcs ||= VCLog::Adapters.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
+    # Convert log to desired format.
+    def render(format)
+      doctype = type
+      doctype = 'history'   if doctype == 'rel'
+      doctype = 'changelog' if doctype == 'log'
+
+      options = {
+        :stylesheet => style,
+        :revision   => rev,
+        :version    => version,
+        :title      => title
+      }
+      vcs.display(doctype, format, options)
     end