vclog 1.7.0 → 1.8.0

data/lib/vclog/repo.rb

@@ -0,0 +1,150 @@
+require 'vclog/adapters'
+require 'vclog/heuristics'
+require 'vclog/history_file'
+
+module VCLog
+
+  #
+  class Repo
+    # Remove some undeeded methods to make way for delegation to scm adapter.
+    %w{display}.each{ |name| undef_method(name) }
+
+    # File glob used to find project root directory.
+    ROOT_GLOB = '{.vclog/,.config/vclog/,config/vclog/,.git/,.hg/,_darcs/,README*}/'
+
+    # File glob used to find the vclog configuration directory.
+    CONFIG_GLOB = '{.vclog,.config/vclog,config/vclog}/'
+
+    # Project's root directory.
+    attr :root
+
+    #
+    attr :options
+
+    # Default change level.
+    # TODO: get from config file?
+    attr :level
+
+    #
+    def initialize(root, options={})
+      @root    = root || lookup_root
+      @options = options
+
+      @config_directory = Dir[File.join(@root, CONFIG_GLOB)]
+
+      @level = (options[:level] || 0).to_i
+
+      type = read_type
+      raise ArgumentError, "Not a recognized version control system." unless type
+
+      @adapter = Adapters.const_get(type.capitalize).new(self)
+    end
+
+    # Returns instance of an Adapter subclass.
+    def adapter
+      @adapter
+    end
+
+    #
+    def config_directory
+      @config_directory
+    end
+
+    #
+    def force?
+      options[:force]
+    end
+
+    #
+    def read_type
+      dir = nil
+      Dir.chdir(root) do
+        dir = Dir.glob("{.svn,.git,.hg,_darcs}").first
+      end
+      dir[1..-1] if dir
+    end
+
+    # Find project root. This searches up from the current working
+    # directory for the following paths (in order):
+    #
+    #   .vclog/
+    #   .config/vclog/
+    #   config/vclog/
+    #   .git/|.hg/|_darcs/
+    #   README*
+    #
+    def lookup_root(dir)
+      root = nil
+      Dir.ascend(dir || Dir.pwd) do |path|
+        check = Dir[ROOT_GLOB].first
+        if check
+          root = path 
+          break
+        end
+      end
+      root || Dir.pwd
+    end
+
+    # Load heuristics script.
+    def heuristics
+      @heuristics ||= Heuristics.load(heuristics_file)
+    end
+
+    # Heurtistics script.
+    def heuristics_file
+      @heuristics_file ||= Dir[File.join(config_directory, 'rules.rb')].first
+    end
+
+    # Access to Repo's HISTORY file.
+    def history_file
+      @history_file ||= HistoryFile.new(root)
+    end
+
+    # Read history file and make a commit tag for any release not already
+    # tagged. Unless the force option is set the user will be prompted for
+    # each new tag.
+    def autotag(prefix=nil)
+      history_file.tags.each do |tag|
+        label = "#{prefix}#{tag.name}"
+        if not adapter.tag?(label)
+          chg = adapter.change_by_date(tag.date)
+          if chg
+            if force? or ask_yn(new_tag_message(label, tag) + "\nCreate tag? [yN] ")
+              adapter.tag(chg.rev, label, tag.date, tag.message)
+            end
+          else
+            puts "No commit found for #{label} #{tag.date.strftime('%Y-%m-%d')}."
+          end
+        end
+      end
+    end
+
+    # Delegate to SCM adapter.
+    def method_missing(s, *a, &b)
+      if adapter.respond_to?(s)
+        adapter.send(s, *a, &b)
+      else
+        super(s,*a,&b)
+      end
+    end
+
+    private
+
+    # Ask yes/no question.
+    def ask_yn(message)
+      case ask(message)
+      when 'y', 'Y', 'yes'
+        true
+      else
+        false
+      end
+    end
+
+    # Returns a String.
+    def new_tag_message(label, tag)
+      "#{label} / #{tag.date.strftime('%Y-%m-%d')}\n#{tag.message}"
+    end
+
+  end
+
+end

data/lib/vclog/tag.rb

@@ -9,8 +9,8 @@ module VCLog
 
     #
     def initialize(name, rev, date, author, message)
-      self.revision = rev
       self.name     = name
+      self.revision = rev
       self.date     = date
       self.author   = author
       self.message  = message
@@ -26,7 +26,7 @@ module VCLog
 
     #
     def author=(author)
-      @author = author.strip
+      @author = author.to_s.strip
     end
 
     #

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

@@ -3,32 +3,37 @@
   <title><%= title %></title>
   <style>
     body{font-family: sans-serif;}
-    h1{ }
+    h1{ font-weight: normal; font-size: 4em; margin: 0 0; }
     h2{ color: #555; }
     li{padding: 10px;}
-    .changelog{width:800px; margin:0 auto;}
-    .title{font-size: 64px;}
-    .date{font-weight: bold; color: green; float: left; padding-right: 15px;}
-    .author{font-weight: bold; color: blue;}
-    .message{padding: 5 0; font-weight: bold;}
-    .revision{font-size: 0.8em;}
+    .main{width:800px; margin:0 auto;}
+    .commit{ padding: 10px 0px; }
+    .date{font-weight: normal; color: green; float: left; padding-right: 15px; font-size: 0.9em;}
+    .author{font-weight: normal; color: blue;}
+    .message{ padding: 5px 0; font-weight: normal; font-size: 1.1em; }
+    .revision{font-size: 0.7em; color: #aaa; }
   </style>
   <% if options.stylesheet %>
     <link rel="stylesheet" href="#{options.stylesheet}" type="text/css">
   <% end %>
 </head>
 <body>
-<h1><%= title %></h1>
-<div class="changelog">
-  <% 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>
-    <div class="author"><%= h entry.author %></div>
-    <div class="type"><%= h entry.type %></div>
-    <div class="message"><%= h entry.message %></div>
-  </commit>
-  <% end %>
+<div class="main">
+  <h1><%= title %></h1>
+  <h2>&nbsp;Timeline</h2>
+  <div class="changelog">
+    <ul>
+    <% changelog.changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+    <li class="commit">
+      <div class="date"><%= entry.date %></div>
+      <div class="author"><%= h entry.author %></div>
+      <div class="type"><%= h entry.type %></div>
+      <div class="message"><%= h entry.message %></div>
+      <div class="revision">#<%= h entry.revision %></div>
+    </li>
+    <% end %>
+    </ul>
+  </div>
 </div>
 </body>
 </html>

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

@@ -6,7 +6,7 @@
     h1{ }
     h2{ color: #555; }
     li{padding: 10px;}
-    .changelog{width:800px; margin:0 auto;}
+    .main{width:800px; margin:0 auto;}
     .title{font-size: 64px;}
     .date{font-weight: bold; color: green; float: left; padding-right: 15px;}
     .author{font-weight: bold; color: blue;}
@@ -18,9 +18,9 @@
 <% end %>
 </head>
 <body>
-<div class="history">
+<div class="main">
   <div class="title"><%= title %></div>
-
+  <div class="history">
 <% history.releases.sort.each do |release| %>
 <%   tag = release.tag %>
 
@@ -47,6 +47,7 @@
 <%   end %>
 <% end %>
   </div>
+</div>
 </body>
 </html>
 

data/lib/vclog.rb

@@ -1,6 +1,6 @@
 module VCLog
-  require 'vclog/config'
-  require 'vclog/adapters'
+  require 'vclog/meta/data'
+  require 'vclog/repo'
 end
 
-
+# VCLog Copyright (c) 2008 Thomas Sawyer

data/man/man1/vclog-autotag.1

@@ -0,0 +1,23 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "VCLOG\-AUTOTAG" "1" "November 2010" "RubyWorks" "VCLog"
+.
+.SH "NAME"
+\fBvclog\-autotag\fR \- tag history entries
+.
+.SH "SYNOPSIS"
+\fBvclog autotag\fR
+.
+.SH "DESCRIPTION"
+Ensure all HISTORY file entries have corresponding commit tags in the version control system\.
+.
+.SH "OPTIONS"
+.
+.IP "\(bu" 4
+\fB\-\-force\fR, \fB\-f\fR Creatie tags without asking for confirmation\.
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+vclog(1)

data/man/man1/vclog-bump.1

@@ -0,0 +1,23 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "VCLOG\-BUMP" "1" "November 2010" "RubyWorks" "VCLog"
+.
+.SH "NAME"
+\fBvclog\-bump\fR \- suggest next version
+.
+.SH "SYNOPSIS"
+\fBvclog bump\fR
+.
+.SH "DESCRIPTION"
+Display the next most suitable version number, based on the current version number\. The bump command considers the commit levels in determining if the next version should be a major or minor bump\.
+.
+.SH "OPTIONS"
+.
+.IP "\(bu" 4
+\fB\-\-version\fR, \fB\-v NUM\fR Assume this version number is current\.
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+vclog(1)

data/man/man1/vclog-changelog.1

@@ -0,0 +1,47 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "VCLOG\-CHANGELOG" "1" "November 2010" "RubyWorks" "VCLog"
+.
+.SH "NAME"
+\fBvclog\-changelog\fR \- change log
+.
+.SH "SYNOPSIS"
+\fBvclog\fR
+.
+.br
+\fBvclog log\fR
+.
+.br
+\fBvclog changelog\fR
+.
+.SH "DESCRIPTION"
+Produce a Change Log\.
+.
+.SH "OPTIONS"
+.
+.IP "\(bu" 4
+\fB\-\-version\fR, \fB\-v <VERSION>\fR Set current version number\.
+.
+.IP "\(bu" 4
+\fB\-f\fR, \fB\-\-format <FORMAT>\fR Output format\.
+.
+.IP "\(bu" 4
+\fB\-\-style <URI>\fR Provide a stylesheet URI (css or xsl) for HTML or XML format\.
+.
+.IP "\(bu" 4
+\fB\-t\fR, \fB\-\-title TITLE\fR Document title\.
+.
+.IP "\(bu" 4
+\fB\-s\fR, \fB\-\-summarize\fR Produce summary output\.
+.
+.IP "\(bu" 4
+\fB\-\-id\fR Include revision id in output\.
+.
+.IP "\(bu" 4
+\fB\-l\fR, \fB\-\-level <NUMBER>\fR Lowest level of commit to display [0]\.
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+vclog(1), vclog\-history(1)

data/man/man1/vclog-history.1

@@ -0,0 +1,44 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "VCLOG\-HISTORY" "1" "November 2010" "RubyWorks" "VCLog"
+.
+.SH "NAME"
+\fBvclog\-history\fR \- release history
+.
+.SH "SYNOPSIS"
+\fBvclog history\fR
+.
+.br
+\fBvclog release\fR
+.
+.SH "DESCRIPTION"
+Produce a Release History\.
+.
+.SH "OPTIONS"
+.
+.IP "\(bu" 4
+\fB\-\-version\fR, \fB\-v <VERSION>\fR Set current version number\.
+.
+.IP "\(bu" 4
+\fB\-f\fR, \fB\-\-format <FORMAT>\fR Output format\.
+.
+.IP "\(bu" 4
+\fB\-\-style <URI>\fR Provide a stylesheet URI (css or xsl) for HTML or XML format\.
+.
+.IP "\(bu" 4
+\fB\-t\fR, \fB\-\-title TITLE\fR Document title\.
+.
+.IP "\(bu" 4
+\fB\-s\fR, \fB\-\-summarize\fR Produce summary output\.
+.
+.IP "\(bu" 4
+\fB\-\-id\fR Include revision id in output\.
+.
+.IP "\(bu" 4
+\fB\-l\fR, \fB\-\-level <NUMBER>\fR Lowest level of commit to display [0]\.
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+vclog(1)

data/man/man1/vclog-version.1

@@ -0,0 +1,16 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "VCLOG\-VERSION" "1" "November 2010" "RubyWorks" "VCLog"
+.
+.SH "NAME"
+\fBvclog\-version\fR \- display current version
+.
+.SH "SYNOPSIS"
+\fBvclog version\fR
+.
+.SH "DESCRIPTION"
+Display current version number according to source control system\.
+.
+.SH "SEE ALSO"
+vclog(1)

data/man/man1/vclog.1

@@ -0,0 +1,39 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "VCLOG" "1" "November 2010" "RubyWorks" "VCLog"
+.
+.SH "NAME"
+\fBvclog\fR \- version control logging utility
+.
+.SH "SYNOPSIS"
+\fBvclog [command]\fR
+.
+.SH "DESCRIPTION"
+VCLog is a versitle cross\-VCS/SCM changelog generator\. It currently supports Git, Hg and (limited) Subversion\.
+.
+.SH "COMMANDS"
+VCLog provides a number of useful functions:
+.
+.IP "\(bu" 4
+\fBchangelog\fR Produce a Change Log\.
+.
+.IP "\(bu" 4
+\fBhistory\fR Produce a Release History\.
+.
+.IP "\(bu" 4
+\fBversion\fR Show current tag version\.
+.
+.IP "\(bu" 4
+\fBbump\fR Suggest next tag version\.
+.
+.IP "\(bu" 4
+\fBautotag\fR Ensure a tag exists for each History entry\.
+.
+.IP "" 0
+.
+.P
+Both \fBchangelog\fR and \fBhistory\fR can be produced in a variety of formats\.
+.
+.SH "SEE ALSO"
+vclog\-changelog(1), vclog\-history(1), vclog\-version(1), vclog\-bump(1), vclog\-autotag(1)

data/meta/data.rb

@@ -0,0 +1,25 @@
+module VCLog
+
+  def self.package
+    @package ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/package'))
+    )
+  end
+
+  def self.profile
+    @profile ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/profile'))
+    )
+  end
+
+  def self.const_missing(name)
+    key = name.to_s.downcase
+    package[key] || profile[key] || super(name)
+  end
+
+  # Prime version.
+  VERSION = package['version']
+end
+

data/meta/package

@@ -0,0 +1,11 @@
+name    : vclog
+date    : 2010-11-19
+version : 1.8.0
+
+requires:
+  - facets 2.4+
+  - ansi 1.2+
+  - syckle   (build)
+  - cucumber (test)
+  - aruba    (test)
+

data/meta/profile

@@ -0,0 +1,18 @@
+--- 
+title    : VCLog
+suite    : rubyworks
+summary  : Cross-VCS/SCM ChangeLog Generator
+license  : Apache 2.0
+contact  : trans <transfire@gmail.com>
+created  : 2006-05-09
+authors  : Thomas Sawyer
+
+description:
+  VCLog is a cross-VCS/SCM ChangeLog generator.
+
+resources:
+  home: http://rubyworks.github.com/vclog
+  code: http://github.com/rubyworks/vclog
+  repo: git://github.com/proutils/vclog.git
+
+copyright: Copyright (c) 2009 Thomas Sawyer

data/ronn/index.txt

@@ -0,0 +1,8 @@
+# manuals
+vclog(1)             vclog.1.ronn
+vclog-changelog(1)   vclog-changelog.1.ronn
+vclog-history(1)     vclog-history.1.ronn
+vclog-version(1)     vclog-version.1.ronn
+vclog-bump(1)        vclog-bump.1.ronn
+vclog-autotag(1)     vclog-autotag.1.ronn
+

data/ronn/vclog-autotag.ronn

@@ -0,0 +1,20 @@
+vclog-autotag(1) - tag history entries
+======================================
+
+## SYNOPSIS
+
+`vclog autotag`
+
+## DESCRIPTION
+
+Ensure all HISTORY file entries have corresponding commit tags in
+the version control system.
+
+## OPTIONS
+
+  * `--force`, `-f`
+    Creatie tags without asking for confirmation.
+
+## SEE ALSO
+
+vclog(1)

data/ronn/vclog-bump.ronn

@@ -0,0 +1,21 @@
+vclog-bump(1) - suggest next version
+====================================
+
+## SYNOPSIS
+
+`vclog bump`
+
+## DESCRIPTION
+
+Display the next most suitable version number, based on the current
+version number. The bump command considers the commit levels in
+determining if the next version should be a major or minor bump.
+
+## OPTIONS
+
+  * `--version`, `-v NUM`
+    Assume this version number is current.
+
+## SEE ALSO
+
+vclog(1)

data/ronn/vclog-changelog.ronn

@@ -0,0 +1,39 @@
+vclog-changelog(1) - change log
+===============================
+
+## SYNOPSIS
+
+`vclog`<br>
+`vclog log`<br>
+`vclog changelog`
+
+## DESCRIPTION
+
+Produce a Change Log.
+
+## OPTIONS
+
+  * `--version`, `-v <VERSION>`
+    Set current version number.
+
+  * `-f`, `--format <FORMAT>`
+    Output format.
+
+  * `--style <URI>`
+    Provide a stylesheet URI (css or xsl) for HTML or XML format.
+
+  * `-t`, `--title TITLE`
+    Document title.
+
+  * `-s`, `--summarize`
+    Produce summary output.
+
+  * `--id`
+    Include revision id in output.
+
+  * `-l`, `--level <NUMBER>`
+    Lowest level of commit to display [0].
+
+## SEE ALSO
+
+vclog(1), vclog-history(1)

data/ronn/vclog-history.ronn

@@ -0,0 +1,38 @@
+vclog-history(1) - release history
+==================================
+
+## SYNOPSIS
+
+`vclog history`<br>
+`vclog release`
+
+## DESCRIPTION
+
+Produce a Release History.
+
+## OPTIONS
+
+  * `--version`, `-v <VERSION>`
+    Set current version number.
+
+  * `-f`, `--format <FORMAT>`
+    Output format.
+
+  * `--style <URI>`
+    Provide a stylesheet URI (css or xsl) for HTML or XML format.
+
+  * `-t`, `--title TITLE`
+    Document title.
+
+  * `-s`, `--summarize`
+    Produce summary output.
+
+  * `--id`
+    Include revision id in output.
+
+  * `-l`, `--level <NUMBER>`
+    Lowest level of commit to display [0].
+
+## SEE ALSO
+
+vclog(1)

data/ronn/vclog-version.ronn

@@ -0,0 +1,14 @@
+vclog-version(1) - display current version
+==========================================
+
+## SYNOPSIS
+
+`vclog version`
+
+## DESCRIPTION
+
+Display current version number according to source control system.
+
+## SEE ALSO
+
+vclog(1)