vclog 1.9.1 → 1.9.2

data/lib/vclog/heuristics.rb

@@ -8,6 +8,7 @@ module VCLog
   #
   class Heuristics
 
+    #
     # Load heuristics from a designated file.
     #
     # @param [String] file 
@@ -18,7 +19,19 @@ module VCLog
       new{ instance_eval(File.read(file), file) }
     end
 
-    # Setup new heurtistics set.
+    #
+    # Load heuristics given a script.
+    #
+    # @param [String] script
+    #   Configuration script.
+    #
+    def self.eval(script, file='(eval)', line=0)
+      new{ instance_eval(text, file, line) }
+    end
+
+    #
+    # Initialize new heurtistics set.
+    #
     def initialize(&block)
       @rules = []
 
@@ -34,6 +47,7 @@ module VCLog
       end
     end
 
+    #
     # Apply heuristics to a commit.
     #
     # @param [Change] commit
@@ -57,13 +71,17 @@ module VCLog
       commit.color = color
     end
 
+    #
     # Define a new rule.
+    #
     def on(pattern=nil, &block)
       @rules << Rule.new(pattern, &block)
     end
 
+    #
     # Convenience method for setting-up commit types, which can
     # be easily assigned, setting both label and level in one go.
+    #
     def type(type, level, label)
       @types[type.to_sym] = Type.new(type, level, label)
     end
@@ -71,6 +89,7 @@ module VCLog
     # @deprecated
     alias_method :set, :type
 
+    #
     # Access to defined types.
     #
     # @example
@@ -78,6 +97,7 @@ module VCLog
     #
     attr :types
 
+    #
     # Set color list. The center element cooresponds to `level=0`.
     # Elements before the center are incrementally higher levels
     # and those after are lower.
@@ -89,7 +109,17 @@ module VCLog
       @colors = list
     end
 
+    #
+    # Set default level.
+    #
+    def level(integer=nil)
+      @level = integer.to_i is integer
+      @level
+    end
+
+    #
     # Default settings.
+    #
     def default
       type :major,    3, "Major Enhancements"
       type :minor,    2, "Minor Enhancements"
@@ -122,7 +152,9 @@ module VCLog
       end
     end
 
+    #
     # Work on next-gen default heuristics.
+    #
     def default2
       type :major,    3, "Major Enhancements"
       type :minor,    2, "Minor Enhancements"

data/lib/vclog/history_file.rb

@@ -59,6 +59,11 @@ module VCLog
       end
     end
 
+    #
+    def news
+      tags.first.message
+    end
+
   end
 
 end

data/lib/vclog/repo.rb

@@ -1,7 +1,6 @@
-require 'confection'
-
 require 'vclog/core_ext'
 require 'vclog/adapters'
+require 'vclog/config'
 require 'vclog/heuristics'
 require 'vclog/history_file'
 require 'vclog/changelog'
@@ -11,13 +10,14 @@ require 'vclog/report'
 
 module VCLog
 
+  # Encapsulate representaiton of the repository.
   #
   class Repo
 
     #
     # File glob used to find project root directory.
     #
-    ROOT_GLOB = '{.git/,.hg/,_darcs/,.svn/}'
+    ROOT_GLOB = '{.ruby,.map/,.git/,.hg/,_darcs/,.svn/}'
 
     #
     # Project's root directory.
@@ -33,10 +33,12 @@ module VCLog
     # Setup new Repo instance.
     #
     def initialize(root, options={})
-      @root    = root || lookup_root
+      options[:root] = root if root
+
+      @config  = Config.new(options)
       @options = options
 
-      vcs_type = read_vcs_type
+      vcs_type = @config.vcs_type
 
       raise ArgumentError, "Not a recognized version control system." unless vcs_type
 
@@ -51,53 +53,31 @@ module VCLog
     end
 
     #
-    # Check force option.
+    # Configuration.
     #
-    def force?
-      options[:force]
+    def config
+      @config
     end
 
     #
+    # Project root directory.
     #
-    #
-    def read_vcs_type
-      dir = nil
-      Dir.chdir(root) do
-        dir = Dir.glob("{.git,.hg,.svn,_darcs}").first
-      end
-      dir[1..-1] if dir
+    def root
+      config.root
     end
 
     #
-    # Find project root. This searches up from the current working
-    # directory for a Confection configuration file or source control 
-    # manager directory.
-    #
-    #   .co
-    #   .git/
-    #   .hg/
-    #   .svn/
-    #   _darcs/
-    #
-    # If all else fails the current directory is returned.
+    # Load heuristics script.
     #
-    def lookup_root
-      root = nil
-      Dir.ascend(Dir.pwd) do |path|
-        check = Dir[ROOT_GLOB].first
-        if check
-          root = path 
-          break
-        end
-      end
-      root || Dir.pwd
+    def heuristics
+      config.heuristics
     end
 
     #
-    # Load heuristics script.
+    # Check force option.
     #
-    def heuristics
-      @heuristics ||= Heuristics.new(&Confection[:vclog])
+    def force?
+      config.force?
     end
 
     #
@@ -169,7 +149,7 @@ module VCLog
 
       #ver  = repo.bump(version)
 
-      name = options[:version] || 'HEAD'
+      name = config.version || 'HEAD'
       user = adapter.user
       date = ::Time.now + (3600 * 24) # one day ahead
 

data/lib/vclog/report.rb

@@ -1,6 +1,6 @@
 require 'ostruct'
-#require 'ansi'
 require 'erb'
+#require 'ansi'
 
 module VCLog
 
@@ -32,12 +32,11 @@ module VCLog
     #
     def initialize(repo, options)
       @repo    = repo
-      @options = case options 
-                 when Hash
-                   OpenStruct.new(options)
-                 else
-                   options
-                 end
+
+      options[:type]   ||= 'changelog'
+      options[:format] ||= 'ansi'
+
+      @options = OpenStruct.new(options)
 
       @options.level ||= 0
     end
@@ -57,6 +56,20 @@ module VCLog
       repo.releases(changelog.changes)
     end
 
+    #
+    # Report type.
+    #
+    def type
+      options.type
+    end
+
+    #
+    # Report format.
+    #
+    def format
+      options.format
+    end
+
     #
     # User as given by the command line or from the repo.
     #
@@ -99,7 +112,7 @@ module VCLog
     #
     def title
       return options.title if options.title
-      case options.type
+      case type
       when :history
         "RELEASE HISTORY"
       else
@@ -114,23 +127,23 @@ module VCLog
     # Print report.
     #
     def print
-      options.type   ||= 'changelog'
-      options.format ||= 'ansi'
+      require_formatter(format)
 
-      require_formatter(options.format)
+      tmpl_glob = File.join(DIR, 'templates', "#{type}.#{format}.{erb,rb}")
+      tmpl_file = Dir[tmpl_glob].first
 
-      tmp_file = Dir[File.join(DIR, 'templates', "#{options.type}.#{options.format}.{erb,rb}")].first
+      raise "could not find template -- #{tmp_glob}" unless tmpl_file
 
-      tmp = File.read(tmp_file)
+      tmpl = File.read(tmpl_file)
 
-      case File.extname(tmp_file)
+      case File.extname(tmpl_file)
       when '.rb'
-        eval(tmp, binding, tmp_file)
+        eval(tmpl, binding, tmpl_file)
       when '.erb'
-        erb = ERB.new(tmp, nil, '<>')
+        erb = ERB.new(tmpl, nil, '<>')
         erb.result(binding)
       else
-        raise "unrecognized template - #{tmp_file}"
+        raise "unrecognized template type -- #{tmpl_file}"
       end
     end
 

data/man/man1/index.txt

@@ -3,6 +3,7 @@ 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-news(1)        vclog-news.1.ronn
 vclog-bump(1)        vclog-bump.1.ronn
 vclog-autotag(1)     vclog-autotag.1.ronn
 

data/man/man1/vclog-autotag.1.html

@@ -64,7 +64,7 @@
     <a href="#DESCRIPTION">DESCRIPTION</a>
     <a href="#OPTIONS">OPTIONS</a>
     <a href="#SEE-ALSO">SEE ALSO</a>
-    </div>
+  </div>
 
   <ol class='man-decor man-head man head'>
     <li class='tl'>vclog-autotag(1)</li>
@@ -103,7 +103,7 @@ convention of <code>HISTORY.*</code>.</p></li>
 
 <h2 id="SEE-ALSO">SEE ALSO</h2>
 
-<p><a href="vclog.1.html" class="man-ref">vclog<span class="s">(1)</span></a></p>
+<p><a class="man-ref" href="vclog.1.html">vclog<span class="s">(1)</span></a></p>
 
 
   <ol class='man-decor man-foot man foot'>

data/man/man1/vclog-bump.1.html

@@ -64,7 +64,7 @@
     <a href="#DESCRIPTION">DESCRIPTION</a>
     <a href="#OPTIONS">OPTIONS</a>
     <a href="#SEE-ALSO">SEE ALSO</a>
-    </div>
+  </div>
 
   <ol class='man-decor man-head man head'>
     <li class='tl'>vclog-bump(1)</li>
@@ -97,7 +97,7 @@ Assume this version number is current.</li>
 
 <h2 id="SEE-ALSO">SEE ALSO</h2>
 
-<p><a href="vclog.1.html" class="man-ref">vclog<span class="s">(1)</span></a></p>
+<p><a class="man-ref" href="vclog.1.html">vclog<span class="s">(1)</span></a></p>
 
 
   <ol class='man-decor man-foot man foot'>

data/man/man1/vclog-news.1

@@ -0,0 +1,25 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "VCLOG\-NEWS" "1" "March 2012" "RubyWorks" "VCLog"
+.
+.SH "NAME"
+\fBvclog\-news\fR \- output latest release notice
+.
+.SH "SYNOPSIS"
+\fBvclog news\fR
+.
+.SH "DESCRIPTION"
+Display the most recent entry in a project\'s history file\. This command does NOT show the latest tag message, rather it is useful for making a new tag\. For instnace:
+.
+.P
+\fBvclog news | git tag \-a \-F \- v1\.0\.0\fR
+.
+.P
+This command will create a new git tag using the most recent message in the history file\.
+.
+.SH "OPTIONS"
+No options yet\.
+.
+.SH "SEE ALSO"
+vclog(1)

data/man/man1/vclog-news.1.html

@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>vclog-news(1) - output latest release notice</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+  <style type='text/css' media='all'>
+  /* style: toc */
+  .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
+  .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
+  .man-navigation a:hover {color:#111;text-decoration:underline}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>vclog-news(1)</li>
+    <li class='tc'>VCLog</li>
+    <li class='tr'>vclog-news(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>vclog-news</code> - <span class="man-whatis">output latest release notice</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>vclog news</code></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>Display the most recent entry in a project's history file. This command
+does NOT show the latest tag message, rather it is useful for making
+a new tag. For instnace:</p>
+
+<p>  <code>vclog news | git tag -a -F - v1.0.0</code></p>
+
+<p>This command will create a new git tag using the most recent message in
+the history file.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<p>No options yet.</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p><a class="man-ref" href="vclog.1.html">vclog<span class="s">(1)</span></a></p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'>RubyWorks</li>
+    <li class='tc'>March 2012</li>
+    <li class='tr'>vclog-news(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>