vclog 1.9.1 → 1.9.2

data/.ruby

@@ -1,6 +1,6 @@
 ---
 source:
-- var
+- meta
 authors:
 - name: Trans
   email: transfire@gmail.com
@@ -8,14 +8,11 @@ copyrights:
 - holder: Rubyworks
   year: '2009'
   license: BSD-2-Clause
-replacements: []
-alternatives: []
 requirements:
 - name: facets
   version: 2.4+
 - name: ansi
   version: 1.2+
-- name: confection
 - name: rdoc
 - name: xml-simple
 - name: detroit
@@ -26,19 +23,16 @@ requirements:
   groups:
   - test
   development: true
-- name: ae
+- name: lime
   groups:
   - test
   development: true
-- name: cucumber
-  groups:
-  - test
-  development: true
-- name: aruba
+- name: ae
   groups:
   - test
   development: true
 dependencies: []
+alternatives: []
 conflicts: []
 repositories:
 - uri: git://github.com/rubyworks/vclog.git
@@ -54,8 +48,8 @@ revision: 0
 created: '2006-05-09'
 summary: Cross-VCS/SCM ChangeLog Generator
 title: VCLog
-version: 1.9.1
+version: 1.9.2
 name: vclog
 description: VCLog is a cross-VCS/SCM ChangeLog generator.
 organization: Rubyworks
-date: '2011-12-13'
+date: '2012-03-03'

data/{HISTORY.rdoc → History.md}

@@ -1,6 +1,23 @@
-= RELEASE HISTORY
+# RELEASE HISTORY
 
-== 1.9.1 / 2011-12-13
+## 1.9.2 / 2012-03-03
+
+Adds `vclog-news` command to output the lastest release entry in a project History file.
+Also attempts to fix issue #14 in which template is not being found --will at least
+report more useful error message if it happens in the future. Also, improved handling
+of configuration. You can now use `.vclog`, `config/vclog` or `.config/vclog`
+by defatult, or add `vclog: path/to/config/file` entry to `.map` file is you wish
+to use unconventional location.
+
+Changes:
+
+* Add news command to get latest release history.
+* Improve configuration file handling.
+* Improve Report code to avoid missing templates.
+* Switch to Lime for spec testing, instead of Cucumber.
+
+
+## 1.9.1 / 2011-12-13
 
 Fixes a couple of issues found with the last release.
 
@@ -10,7 +27,7 @@ Changes:
 * Fix tag id in git tag parser.
 
 
-== 1.9.0 / 2011-12-12
+## 1.9.0 / 2011-12-12
 
 This is a BIG release and much has changed, so be sure to read the following
 carefully if you've used VClog before.
@@ -80,7 +97,7 @@ Changes:
 * Add autotag feature to ensure release history tags exits.
 
 
-== 1.7.0 / 2010-06-27
+## 1.7.0 / 2010-06-27
 
 In this release the heuristics interface has changed such that the block is passed the commit message and the matchdata, instead of  the previous matchdata splat. The rule can alos return either the sybolic label or a two element array of label and new message, which allows the rule to "massage" the message as needed. This release also improves the git log parser to be much more robust. 
 
@@ -90,7 +107,7 @@ Changes:
 * Improve git log parser, which should handle all possible cases now.
 
 
-== 1.6.1 / 2010-06-23
+## 1.6.1 / 2010-06-23
 
 This release repairs the Atom feed format and adds an RSS feed format. Both formats are nearly conformant with strict validations --only a couple minor issues remain to iron out (such as embedded feed url). Ragardless, they should work fine with feed readers (which are not as strict).
 
@@ -102,7 +119,7 @@ Changes:
 * Add title to HTML Change Log format.
 
 
-== 1.6.0 / 2010-06-22
+## 1.6.0 / 2010-06-22
 
 Previous versions utilized a system of "commit tagging" to identify types of commits. This proved less than optimal --it was unconventional, but worse it was easy to forget to put the proper label in the message. The new version of VClog uses a customizable heuristics systems instead. Rather than be limited to a strict syntax structure, you can write matching rules in .config/vclog/rules.rb that determine the commit type, and set descriptive labels for each type. This makes it very easy to get excellent History output. Also in this release the command-line interface has changed to use subcommands. And the default output format is now an ANSI-color GNU-like format. Use `-f gnu` to get the old default format.
 
@@ -114,7 +131,7 @@ Changes:
   * Command-line interface uses subcommands
 
 
-== 1.5.0 / 2010-05-29
+## 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.
 
@@ -130,7 +147,7 @@ Changes:
   * Select format using -f option.
 
 
-== 1.4.0 / 2010-05-26
+## 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?).
 
@@ -148,7 +165,7 @@ Changes:
   * Change 'git-log' to 'git log'.
 
 
-== 1.3.0 / 2010-02-08
+## 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.
 
@@ -168,7 +185,7 @@ Changes:
   * Corrected error for --current and --bump commands.
 
 
-== 1.2.0 / 2009-10-26
+## 1.2.0 / 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.
 
@@ -180,7 +197,7 @@ Changes:
   * Changed command-line interface.
 
 
-== 1.1.0 / 2009-10-23
+## 1.1.0 / 2009-10-23
 
 This release adds yaml and json formats an improves
 the command.
@@ -197,20 +214,24 @@ Changes:
     * Use OptionParser instead of GetoptLong.
 
 
-== 1.0.0 / 2009-10-13
+## 1.0.0 / 2009-10-13
 
 This is the first "production" release of VCLog.
 
+Changes:
+
 * 2 Major Enhancements
 
     * Improved command line interface.
     * Added output option to save changelog.
 
 
-== 0.1.0 / 2009-08-17
+## 0.1.0 / 2009-08-17
 
 This is the initial version of vclog.
 
+Changes:
+
 * 1 Major Enhancement
 
     * Happy Birthday

data/License.txt

@@ -0,0 +1,28 @@
+(BSD-2-Clause License)
+
+VCLog - Mult-platform VCS Logging Tool
+http://rubyworks.github.com/vclog
+
+Copyright (c) 2008 Rubyworks. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/{README.rdoc → README.md}

@@ -1,22 +1,22 @@
-= VCLog
+# VCLog
 
-{Website}[http://rubyworks.github.com/vclog] |
-{Source Code}[http://github.com/rubyworks/vclog] |
-{Report Issue}[http://github.com/rubyworks/vclog/issues] |
-{Mailing List}[http://googlegroups.com/group/rubyworks-mailinglist]
+[Website](http://rubyworks.github.com/vclog) /
+[Source Code](http://github.com/rubyworks/vclog) /
+[Report Issue](http://github.com/rubyworks/vclog/issues) /
+[Mailing List](http://googlegroups.com/group/rubyworks-mailinglist)
 
-{<img src="http://travis-ci.org/rubyworks/vclog.png" />}[http://travis-ci.org/rubyworks/vclog]
+[![Build Status](https://secure.travis-ci.org/rubyworks/vclog.png)](http://travis-ci.org/rubyworks/vclog)
 
 
-== DESCRIPTION
+## Description
 
 VCLog is a versatile cross-VCS/SCM changelog generator.
 It currently supports Git, Hg and (limited) Subversion.
 
 
-== SYNOPSIS
+## Instruction
 
-=== Creating Changelogs
+### Creating Changelogs
 
 The default output is an ANSI colored GNU-like changelog.
 From a repository's root directory try:
@@ -31,7 +31,7 @@ To generate an a different format use -f:
 
   $ vclog -f xml
 
-=== Creating Release Histories
+### Creating Release Histories
 
 To get a release history specify `-r`, `--release` or `--history` option.
 
@@ -46,7 +46,7 @@ the tag is used.
 
 See 'vclog help' for more options.
 
-=== Bumping Versions
+### Bumping Versions
 
 VCLog can also be used to intelligently bump versions. To see the current
 tag version:
@@ -64,7 +64,7 @@ commit with a level greater than 1 will bump the major number, while any
 commit with a level of 0 or 1 will bump the minor number. All lower
 level only bump the patch level.
 
-=== Writing Heuristics
+### Writing Heuristics
 
 You can configure custom log heuristics for your project. VCLog uses
 the {confection gem}[http://rubyworks.github.com/confection] to
@@ -106,7 +106,9 @@ method.
     colors :blue, :cyan, :green, :yellow, :red
 
 
-== SUBVERSION ISSUES
+## Limitations
+
+### Subversion
 
 Because Subversion is a centralized version control system, it contacts
 the server every time 'svn log' is run. For this reason, having vclog
@@ -116,15 +118,11 @@ 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.
-
-
-== COPYRIGHTS
+## License
 
 Copyright (c) 2008 Rubyworks
 
 VCLog is distributable in accordance with the terms of the *FreeBSD* license.
 
-See COPYING.rdoc for details.
+See License.txt for details.
+

data/bin/vclog-news

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'vclog/cli/news'
+
+VCLog::CLI::News.run(ARGV)
+

data/lib/vclog.yml

@@ -1,6 +1,6 @@
 ---
 source:
-- var
+- meta
 authors:
 - name: Trans
   email: transfire@gmail.com
@@ -8,14 +8,11 @@ copyrights:
 - holder: Rubyworks
   year: '2009'
   license: BSD-2-Clause
-replacements: []
-alternatives: []
 requirements:
 - name: facets
   version: 2.4+
 - name: ansi
   version: 1.2+
-- name: confection
 - name: rdoc
 - name: xml-simple
 - name: detroit
@@ -26,19 +23,16 @@ requirements:
   groups:
   - test
   development: true
-- name: ae
+- name: lime
   groups:
   - test
   development: true
-- name: cucumber
-  groups:
-  - test
-  development: true
-- name: aruba
+- name: ae
   groups:
   - test
   development: true
 dependencies: []
+alternatives: []
 conflicts: []
 repositories:
 - uri: git://github.com/rubyworks/vclog.git
@@ -54,8 +48,8 @@ revision: 0
 created: '2006-05-09'
 summary: Cross-VCS/SCM ChangeLog Generator
 title: VCLog
-version: 1.9.1
+version: 1.9.2
 name: vclog
 description: VCLog is a cross-VCS/SCM ChangeLog generator.
 organization: Rubyworks
-date: '2011-12-13'
+date: '2012-03-03'

data/lib/vclog/cli/news.rb

@@ -0,0 +1,29 @@
+require 'vclog/cli/abstract'
+
+module VCLog::CLI
+
+  #
+  class News < Abstract
+
+    #
+    def self.terms
+      ['news']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog-news"
+        opt.separator(" ")
+        opt.separator("Display first release note from history file.")
+      end
+    end
+
+    #
+    def execute
+      puts repo.history_file.news #(version)
+    end
+
+  end
+
+end

data/lib/vclog/config.rb

@@ -0,0 +1,151 @@
+require 'vclog/heuristics'
+
+module VCLog
+
+  # Encapsulates configuration settings for running vclog.
+  #
+  class Config
+
+    #
+    # If not in a default location a `.map` entry can be used to
+    # tell vclog where the config file it located.
+    #
+    # @example
+    #   ---
+    #   vclog: task/vclog.rb
+    #
+    MAP_FILE = ".map"
+
+    #
+    # Default vclog config file glob looks for these possible matches in order:
+    #
+    # * .vclog
+    # * .config/vclog
+    # * config/vclog
+    # * .dot/vclog
+    # * dot/vclog
+    #
+    # File may have optional `.rb` extension.
+    #
+    DEFAULT_GLOB = '{.,.config/,config/.dot/,dot/}vclog{,.rb}'
+
+    #
+    #
+    #
+    def initialize(options={})
+      @root    = options[:root]  || lookup_root
+      @level   = options[:level] || 0
+      @force   = options[:force] || false
+      @version = options[:version]
+    end
+
+    #
+    # Project's root directory.
+    #
+    attr :root
+
+    #
+    # Default change level.
+    #
+    def level
+      heuristics.level
+    end
+
+    #
+    # Force mode active?
+    #
+    def force?
+      @force
+    end
+
+    #
+    # Indicates the version of HEAD.
+    #
+    def version
+      @version
+    end
+
+    #
+    # Load heuristics.
+    #
+    def heuristics
+      @heuristics ||= (
+        if file
+          Heuristics.load(file)
+        else
+          Heuristics.new
+        end
+      )
+    end
+
+    #
+    # Which version control system?
+    #
+    def vcs_type
+      @vcs_type ||= (
+        dir = nil
+        Dir.chdir(root) do
+          dir = Dir.glob("{.git,.hg,.svn,_darcs}").first
+        end
+        dir[1..-1] if dir
+      )
+    end
+
+    #
+    # The vclog config file.
+    #
+    def file
+      if glob = file_map['vclog']
+        Dir.glob(glob).first
+      else
+        Dir.glob(DEFAULT_GLOB).first
+      end
+    end
+
+    # 
+    # Project's map file, if present.
+    #
+    def map_file
+      file = File.join(root, MAP_FILE)
+      return file if File.exist?(file)
+      return nil
+    end
+
+    #
+    # Load the map file.
+    #
+    def file_map
+      @file_map ||= (
+        map_file ? YAML.load_file(map_file) : {}
+      )
+    end
+
+    #
+    # Find project root. This searches up from the current working
+    # directory for a .map configuration file or source control 
+    # manager directory.
+    #
+    #   .ruby/
+    #   .map
+    #   .git/
+    #   .hg/
+    #   .svn/
+    #   _darcs/
+    #
+    # If all else fails the current directory is returned.
+    #
+    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
+    end
+
+  end
+
+end