rubycut-vclog 1.9.5 → 1.9.5.1

data/.ruby

@@ -0,0 +1,55 @@
+---
+source:
+- meta
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2009'
+  license: BSD-2-Clause
+requirements:
+- name: facets
+  version: 2.4+
+- name: ansi
+  version: 1.2+
+- name: rdoc
+- name: xml-simple
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: citron
+  groups:
+  - test
+  development: true
+- name: lime
+  groups:
+  - test
+  development: true
+- name: ae
+  groups:
+  - test
+  development: true
+dependencies: []
+alternatives: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/vclog.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/vclog
+  code: http://github.com/rubyworks/vclog
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2006-05-09'
+summary: Cross-VCS/SCM ChangeLog Generator
+title: VCLog
+version: 1.9.5.1
+name: rubycut-vclog
+description: VCLog is a cross-VCS/SCM ChangeLog generator.
+organization: Rubyworks
+date: '2012-03-22'

data/History.md

@@ -1,16 +1,5 @@
 # RELEASE HISTORY
 
-## 1.9.3 / 2012-04-09
-
-This release should finally fix issue #14. If also adds support
-for RC based configuration.
-
-Changes:
-
-* Fix issue #14.
-* Add support for RC.
-
-
 ## 1.9.2 / 2012-03-03
 
 Adds `vclog-news` command to output the lastest release entry in a project History file.

data/License.txt

@@ -1,4 +1,9 @@
-BSD-2-Clause License
+(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:

data/README.md

@@ -1,46 +1,41 @@
 # VCLog
 
 [Website](http://rubyworks.github.com/vclog) /
+[Source Code](http://github.com/rubyworks/vclog) /
 [Report Issue](http://github.com/rubyworks/vclog/issues) /
-[Source Code](http://github.com/rubyworks/vclog)    
-[![Build Status](https://secure.travis-ci.org/rubyworks/vclog.png)](http://travis-ci.org/rubyworks/vclog)
-
-**VCLog is a versatile and customizable cross-VCS/SCM changelog and release history generator.**
+[Mailing List](http://googlegroups.com/group/rubyworks-mailinglist)
 
-## Supported Systems
+[![Build Status](https://secure.travis-ci.org/rubyworks/vclog.png)](http://travis-ci.org/rubyworks/vclog)
 
-VCLog is a multi-platform VCS logging tool.
-It currently supports the following Version Control Systems:
 
-* <a href="http://git-scm.com/">Git</a>
-* <a href="http://mercurial.selenic.com/">Mercurial</a>
-* <a href="http://subversion.apache.org/">Subversion</a>
+## Description
 
-Subversion support is limited however. See Limitations noted below.
+VCLog is a versatile cross-VCS/SCM changelog generator.
+It currently supports Git, Hg and (limited) Subversion.
 
 
-## Instructions
+## Instruction
 
 ### Creating Changelogs
 
 The default output is an ANSI colored GNU-like changelog.
 From a repository's root directory try:
 
-    $ vclog
+  $ vclog
 
 The is the same as specifying 'changelog' or 'log'.
 
-    $ vclog log
+  $ vclog log
 
 To generate an a different format use -f:
 
-    $ vclog -f xml
+  $ vclog -f xml
 
 ### Creating Release Histories
 
 To get a release history specify `-r`, `--release` or `--history` option.
 
-    $ vclog -r
+  $ vclog -r
 
 Again the default format is an ANSI colored GNU-like text style.
 
@@ -56,13 +51,13 @@ See 'vclog help' for more options.
 VCLog can also be used to intelligently bump versions. To see the current
 tag version:
 
-    $ vclog-version
-    1.1.0
+  $ vclog-version
+  1.1.0
 
 To see the next reasonable version based on current changes:
 
-    $ vclog-bump
-    1.2.0
+  $ vclog-bump
+  1.2.0
 
 VCLog can determine the appropriate version based on commit level. Any
 commit with a level greater than 1 will bump the major number, while any
@@ -71,12 +66,16 @@ level only bump the patch level.
 
 ### Writing Heuristics
 
-VCLog can be configured to support custom log heuristics to suite the work flow
-of any project. It is recommended that configurations be placed in a project's
-`etc/vclog.rb` file. But `config/vclog.rb` and simply `.vclog` or `vclog.rb`
-also work.
+You can configure custom log heuristics for your project. VCLog uses
+the {confection gem}[http://rubyworks.github.com/confection] to
+handle configuration, and will look for a `.confile` or `Confile` in
+which to find a `vclog` section.
+
+  vclog do
+    ...
+  end
 
-Within this file rules are defined via the #on method. For example,
+Within this block we can define rules via the #on method.
 
     on /updated? (README|VERSION|MANIFEST)/ do |commit|
       commit.label = "Adminstrative Changes"
@@ -98,7 +97,7 @@ These rules can also "massage" the commit message.
 
     on /\Aadmin:/ do |commit, matchdata|
       commit.type    = :admin
-      commit.message = matchdata.post_match
+      commit.message = matchdate.post_match
     end
 
 Lastly, we can customize the colorization of the certain formats via #colors
@@ -106,8 +105,6 @@ method.
 
     colors :blue, :cyan, :green, :yellow, :red
 
-The colors are taken in order from least importance to greatest importance.
-
 
 ## Limitations
 
@@ -121,13 +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.
 
 
-## Copyrights
-
-VCLog (http://rubyworks.github.com/vclog)
+## License
 
-Copyright &copy; 2008 Rubyworks. All rights reserved.
+Copyright (c) 2008 Rubyworks
 
-VCLog is modifiable and redistributable in accordance with the terms of
-the *BSD-2-Clause* license.
+VCLog is distributable in accordance with the terms of the *FreeBSD* license.
 
 See License.txt for details.
+

data/lib/vclog.yml

@@ -1,68 +1,55 @@
 ---
-revision: 2013
-type: ruby
-sources:
-- index
+source:
+- meta
 authors:
 - name: Trans
   email: transfire@gmail.com
-organizations: []
+copyrights:
+- holder: Rubyworks
+  year: '2009'
+  license: BSD-2-Clause
 requirements:
-- version: ! '>= 2.4'
-  name: facets
-- version: ! '>= 1.2'
-  name: ansi
+- name: facets
+  version: 2.4+
+- name: ansi
+  version: 1.2+
+- name: rdoc
 - name: xml-simple
-#- groups:
-#  - build
-#  development: true
-#  name: detroit
-- groups:
+- name: detroit
+  groups:
   - build
   development: true
-  name: ergo
-- groups:
+- name: citron
+  groups:
   - test
   development: true
-  name: citron
-- groups:
+- name: lime
+  groups:
   - test
   development: true
-  name: lime
-- groups:
+- name: ae
+  groups:
   - test
   development: true
-  name: ae
-- groups:
-  - test
-  development: true
-  name: rubytest-cli
-conflicts: []
+dependencies: []
 alternatives: []
-resources:
-- type: home
-  uri: http://rubyworks.github.com/vclog
-  label: Homepage
-- type: code
-  uri: http://github.com/rubyworks/vclog
-  label: Source Code
+conflicts: []
 repositories:
-- name: upstream
+- uri: git://github.com/rubyworks/vclog.git
   scm: git
-  uri: git://github.com/rubyworks/vclog.git
-categories: []
-copyrights:
-- holder: Rubyworks
-  year: '2009'
-  license: BSD-2-Clause
-customs: []
-paths:
-  lib:
-  - lib
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/vclog
+  code: http://github.com/rubyworks/vclog
+extra: {}
+load_path:
+- lib
+revision: 0
 created: '2006-05-09'
 summary: Cross-VCS/SCM ChangeLog Generator
 title: VCLog
-version: 1.9.5
+version: 1.9.5.1
 name: rubycut-vclog
 description: VCLog is a cross-VCS/SCM ChangeLog generator.
-date: '2013-03-22'
+organization: Rubyworks
+date: '2012-03-22'

data/lib/vclog/config.rb

@@ -1,46 +1,33 @@
 require 'vclog/heuristics'
-#require 'vclog/rc'
 
 module VCLog
 
-  # Get/set master configruation(s).
-  def self.configure(&block)
-    @config ||= []
-    @config << block if block
-    @config
-  end
-
   # Encapsulates configuration settings for running vclog.
   #
-  # We recommend putting vclog configuration in a project's `etc/vclog.rb`
-  # file. For Rails projects, however, `config/vclog.rb` can be used. If
-  # usig a subdirectory is not suitable to a project then simply using
-  # the more traditional `.vclog` file works too.
-  #
   class Config
 
-    # File glob for identifying the project's root directory.
     #
-    # NOTE: SVN support is limited to repos with a trunk directory.
-    ROOT_GLOB = "{.git,.hg,_darcs,.svn/trunk}"
-
+    # If not in a default location a `.map` entry can be used to
+    # tell vclog where the config file it located.
     #
-    # Default vclog config file glob looks for these possible matches:
+    # @example
+    #   ---
+    #   vclog: task/vclog.rb
     #
-    # * vclog.rb
-    # * etc/vclog.rb
-    # * config/vclog.rb
+    MAP_FILE = ".map"
+
     #
-    # The configuration file can also be a hidden dot file if preferred:
+    # Default vclog config file glob looks for these possible matches in order:
     #
     # * .vclog
-    # * .etc/vclog.rb
-    # * .config/vclog.rb
+    # * .config/vclog
+    # * config/vclog
+    # * .dot/vclog
+    # * dot/vclog
     #
-    # Root files have precedence over files in subdirectories, and the `.rb`
-    # file extension is optional in all cases.
+    # File may have optional `.rb` extension.
     #
-    FILE_GLOBS = [ '{,.}vclog{,.rb}', '{.,}{etc/,config/}vclog{,.rb}' ]
+    DEFAULT_GLOB = '{.,.config/,config/.dot/,dot/}vclog{,.rb}'
 
     #
     #
@@ -86,11 +73,7 @@ module VCLog
         if file
           Heuristics.load(file)
         else
-          h = Heuristics.new
-          if config = VCLog.configure
-            config.each{ |c| c.call(h) }
-          end
-          h
+          Heuristics.new
         end
       )
     end
@@ -112,17 +95,42 @@ module VCLog
     # The vclog config file.
     #
     def file
-      DEFAULT_GLOBS.find{ |g| Dir.glob(g).first }
+      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 source control manager directory.
+    # directory for a .map configuration file or source control 
+    # manager directory.
     #
-    # * `.git/`
-    # * `.hg/`
-    # * `_darcs/`
-    # * `.svn/trunk`
+    #   .ruby/
+    #   .map
+    #   .git/
+    #   .hg/
+    #   .svn/
+    #   _darcs/
     #
     # If all else fails the current directory is returned.
     #
@@ -131,7 +139,7 @@ module VCLog
       Dir.ascend(Dir.pwd) do |path|
         check = Dir[ROOT_GLOB].first
         if check
-          root = path
+          root = path 
           break
         end
       end

data/lib/vclog/core_ext.rb

@@ -5,7 +5,104 @@ require 'facets/string/margin'
 require 'facets/enumerable/group_by'
 require 'facets/kernel/ask'
 
-class OpenStruct
-  method_undef(:type) if method_defined?(:type)
+=begin
+
+module VCLog
+
+  # Extensions for String class.
+  # Taken from Facets.
+  module String
+
+    # Provides a margin controlled string.
+    #
+    #   x = %Q{
+    #         | This
+    #         |   is
+    #         |     margin controlled!
+    #         }.margin
+    #
+    #
+    #   NOTE: This may still need a bit of tweaking.
+    #
+    #  CREDIT: Trans
+
+    def margin(n=0)
+      #d = /\A.*\n\s*(.)/.match( self )[1]
+      #d = /\A\s*(.)/.match( self)[1] unless d
+      d = ((/\A.*\n\s*(.)/.match(self)) ||
+          (/\A\s*(.)/.match(self)))[1]
+      return '' unless d
+      if n == 0
+        gsub(/\n\s*\Z/,'').gsub(/^\s*[#{d}]/, '')
+      else
+        gsub(/\n\s*\Z/,'').gsub(/^\s*[#{d}]/, ' ' * n)
+      end
+    end
+
+    # Preserves relative tabbing.
+    # The first non-empty line ends up with n spaces before nonspace.
+    #
+    #  CREDIT: Gavin Sinclair
+
+    def tabto(n)
+      if self =~ /^( *)\S/
+        indent(n - $1.length)
+      else
+        self
+      end
+    end
+
+    # Indent left or right by n spaces.
+    # (This used to be called #tab and aliased as #indent.)
+    #
+    #  CREDIT: Gavin Sinclair
+    #  CREDIT: Trans
+
+    def indent(n)
+      if n >= 0
+        gsub(/^/, ' ' * n)
+      else
+        gsub(/^ {0,#{-n}}/, "")
+      end
+    end
+
+  end
+
+end
+
+class String #:nodoc:
+  include VCLog::String
 end
 
+
+# Core extension
+
+module Enumerable
+
+  unless defined?(group_by) or defined?(::ActiveSupport)  # 1.9 or ActiveSupport
+
+    # #group_by is used to group items in a collection by something they
+    # have in common.  The common factor is the key in the resulting hash, the
+    # array of like elements is the value.
+    #
+    #   (1..5).group_by { |n| n % 3 }
+    #        #=> { 0 => [3], 1 => [1, 4], 2 => [2,5] }
+    #
+    #   ["I had", 1, "dollar and", 50, "cents"].group_by { |e| e.class }
+    #        #=> { String => ["I had","dollar and","cents"], Fixnum => [1,50] }
+    #
+    # CREDIT: Erik Veenstra
+
+    def group_by #:yield:
+      #h = k = e = nil
+      r = Hash.new
+      each{ |e| (r[yield(e)] ||= []) << e }
+      r
+    end
+
+  end
+
+end
+
+=end
+

data/lib/vclog/report.rb

@@ -31,7 +31,7 @@ module VCLog
     #   An instance of VCLog::Repo.
     #
     def initialize(repo, options)
-      @repo = repo
+      @repo    = repo
 
       options[:type]   ||= 'changelog'
       options[:format] ||= 'ansi'
@@ -132,7 +132,7 @@ module VCLog
       tmpl_glob = File.join(DIR, 'templates', "#{type}.#{format}.{erb,rb}")
       tmpl_file = Dir[tmpl_glob].first
 
-      raise "could not find template -- #{type}.#{format}" unless tmpl_file
+      raise "could not find template -- #{tmp_glob}" unless tmpl_file
 
       tmpl = File.read(tmpl_file)
 

data/test/case_metadata.rb

@@ -3,7 +3,7 @@ require 'vclog/metadata'
 testcase "VCLog" do
 
   test "VERSION is set" do
-    ::VCLog::VERSION.assert == File.read('index/version').strip
+    ::VCLog::VERSION.assert == File.read('meta/version').strip
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubycut-vclog
 version: !ruby/object:Gem::Version
-  version: 1.9.5
+  version: 1.9.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -44,7 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: xml-simple
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -60,14 +60,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ergo
+  name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -76,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: citron
+  name: detroit
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -92,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: lime
+  name: citron
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -108,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ae
+  name: lime
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -124,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubytest-cli
+  name: ae
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -155,6 +155,7 @@ extra_rdoc_files:
 - History.md
 - README.md
 files:
+- .ruby
 - .yardopts
 - bin/vclog
 - bin/vclog-autotag
@@ -186,7 +187,6 @@ files:
 - lib/vclog/heuristics.rb
 - lib/vclog/history_file.rb
 - lib/vclog/metadata.rb
-- lib/vclog/rc.rb
 - lib/vclog/release.rb
 - lib/vclog/repo.rb
 - lib/vclog/report.rb
@@ -255,11 +255,4 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Cross-VCS/SCM ChangeLog Generator
-test_files:
-- test/case_metadata.rb
-- spec/feature_hg_history.rb
-- spec/feature_git_changes.rb
-- spec/feature_hg_changes.rb
-- spec/featurettes/repo_creation.rb
-- spec/featurettes/shellout.rb
-- spec/feature_git_history.rb
+test_files: []

data/lib/vclog/rc.rb

@@ -1,9 +0,0 @@
-begin
-  require 'rc/api'
-
-  configure 'vclog' do |config|
-    VCLog.configure(&config) if config.profile?
-  end
-rescue LoadError
-end
-