vclog 1.5.0 → 1.6.0

data/HISTORY.rdoc

@@ -1,5 +1,17 @@
 = RELEASE HISTORY
 
+== 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.
+
+Changes:
+
+* 2 Major Enhancements
+
+  * Heuristics system for categorizing commits
+  * Command-line interface uses subcommands
+
+
 == 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.

data/README.rdoc

@@ -1,7 +1,7 @@
 = VCLog
 
-* http://proutils.rubyforge.org
-* http://proutils.rubyforge.org/vclog
+* home: http://proutils.github.com/vclog
+* work: http://github.com/proutils/vclog
 
 
 == DESCRIPTION
@@ -12,8 +12,8 @@ It currently supports Git and Subversion.
 
 == SYNOPSIS
 
-By default the format is a standard GNU text style. From a
-repository's root directory try:
+The default format is a ANSI colored GNU-like text style.
+From a repository's root directory try:
 
   $ vclog
 
@@ -21,7 +21,7 @@ To generate an XML formatted changelog use:
 
   $ vclog -f xml
 
-See 'vclog --help' for more options.
+See 'vclog help' for more options.
 
 
 == NOTE ABOUT SUBVSERION

data/REQUIRE

@@ -1,5 +1,6 @@
 runtime:
 - facets >2.4
+- ansi
 
 development:
 - syckle

data/VERSION

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

data/bin/vclog

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 require 'vclog/cli'
-VCLog.run
+VCLog::CLI.main(*ARGV)
 

data/features/git.feature

@@ -46,41 +46,41 @@ Feature: Git Support
 
   Scenario: Git Release History
     Given a suitable Git repository
-    When I run "vclog -r"
+    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"
+    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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -f json"
     Then the exit status should be 0
 

data/features/hg.feature

@@ -46,41 +46,41 @@ Feature: Mercurial Support
 
   Scenario: Mercurial Release History
     Given a suitable Mercurial repository
-    When I run "vclog -r"
+    When I run "vclog rel"
     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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -f json"
     Then the exit status should be 0
 

data/features/svn.feature

@@ -46,41 +46,41 @@ Feature: Subversion Support
 
   Scenario: Subversion Release History
     Given a suitable Subversion repository
-    When I run "vclog -r"
+    When I run "vclog rel"
     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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -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"
+    When I run "vclog rel -f json"
     Then the exit status should be 0
 

data/lib/plugins/syckle/vclog.rb

@@ -40,18 +40,23 @@ module Syckle::Plugins
     # Some formats can reference an optional stylesheet (namely +xml+ and +html+).
     attr_accessor :style
 
+    # Minimu change level to include.
+    attr_accessor :level
+
     #
     def initialize_defaults
       require 'vclog'
+
       @version    = metadata.version
       @title      = metadata.title
       @formats    = ['atom']
       @type       = 'log'
+      @level      = 0
     end
 
     #
     def valid?
-      return false unless format =~ /^(html|yaml|json|xml|rdoc|markdown|gnu|txt|atom)$/
+      return false unless format =~ /^(html|yaml|json|xml|rdoc|markdown|gnu|txt|atom|ansi)$/
       return false unless type   =~ /^(log|rel|history|changelog)$/
       return true
     end
@@ -68,16 +73,12 @@ module Syckle::Plugins
       @type = f.to_s.downcase
     end
 
-    # Generate changelog.
-    def document
-      document_changelog
-    end
-
     #++
     # TODO: apply_naming_policy ?
     #--
 
-    def document_changelog
+    #
+    def document
       formats.each do |format|
         case type
         when 'rel', 'history'
@@ -87,7 +88,7 @@ module Syckle::Plugins
         end
         #apply_naming_policy('changelog', log_format.downcase)
         if dryrun?
-          report "# vclog --#{type} -f #{format} -o #{file}"
+          report "# vclog --#{type} -f #{format} >> #{file}"
         else
           changed = save(format, file)
           if changed
@@ -130,10 +131,18 @@ module Syckle::Plugins
     #  )
     #end
 
+    def vclog_config
+      @vclog_config ||= (
+        vcf = VCLog::Config.new(project.root.to_s)
+        vcf.level = level
+        vcf
+      )
+    end
+
     # Access to version control system.
     def vcs
       #@vcs ||= VCLog::VCS.new #(self)
-      @vcs ||= VCLog::Adapters.factory #(root)
+      @vcs ||= VCLog::Adapters.factory(vclog_config)
     end
 
     # Convert log to desired format.
@@ -148,6 +157,7 @@ module Syckle::Plugins
         :version    => version,
         :title      => title
       }
+
       vcs.display(doctype, format, options)
     end
 

data/lib/vclog/adapters/abstract.rb

@@ -2,6 +2,8 @@ module VCLog
 module Adapters
 
   require 'time'
+  require 'pathname'
+
   require 'vclog/formatter'
   require 'vclog/changelog'
   require 'vclog/history'
@@ -14,19 +16,40 @@ module Adapters
   # = Version Control System
   class Abstract
 
+    # Root location.
     attr :root
 
+    # Heuristics object.
+    attr :heuristics
+
+    # Minimu change level.
+    attr :level
+
     #
-    def initialize(root)
-      @root = File.expand_path(root)
+    def initialize(config)
+      @root       = config.root  # File.expand_path(config.root)
+      @heuristics = config.heuristics
+      @level      = config.level.to_i
     end
 
+    #
     def tags
       @tags ||= extract_tags.map{ |t| Tag===t ? t : Tag.new(*t) }
     end
 
+    #
     def changes
-      @changes ||= extract_changes.map{ |c| Change===c ? c : Change.new(*c) }
+      @changes ||= (
+        changes = []
+        extract_changes.each do |c|
+          raise "how did this happen?" if Change == c
+          rev, date, who, msg = *c
+          type, level, label = *heuristics.lookup(msg)
+          next if level < self.level
+          changes << Change.new(rev, date, who, msg, type, level, label)
+        end
+        changes
+      )
     end
 
     #
@@ -45,26 +68,42 @@ module Adapters
     end
 
     #
-    def history(opts={})
-      @history ||= History.new(self, opts)
+    def history
+      @history ||= History.new(self)
     end
 
     #
-    def display(type, format, options={})
+    def display(type, format, options)
+      @options = options
       formatter = Formatter.new(self)
       formatter.display(type, format, options)
     end
 
+    # TODO: allow config of these levels thresholds ?
+    def bump
+      max = history.releases[0].changes.map{ |c| c.level }.max
+      if max > 1
+        bump_part('major')
+      elsif max >= 0
+        bump_part('minor')
+      else
+        bump_part('patch')
+      end
+    end
+
     # Provides a bumped version number.
-    def bump(part=nil)
-      return part unless ['major', 'minor', 'patch', ''].include?(part.to_s)
+    def bump_part(part=nil)
+      raise "bad version part - #{part}" unless ['major', 'minor', 'patch', 'build', ''].include?(part.to_s)
 
       if tags.last
-        v = tags.last.name   # TODO: ensure the latest version
+        v = tags[-1].name # TODO: ensure the latest version
+        v = tags[-2].name if v == 'HEAD'
       else
         v = '0.0.0'
       end
+
       v = v.split(/\W/)    # TODO: preserve split chars
+
       case part.to_s
       when 'major'
         v[0] = v[0].succ
@@ -88,6 +127,17 @@ module Adapters
       end
     end
 
+    # Returns the current verion string.
+    def version
+      if tags.last
+        v = tags[-1].name # TODO: ensure the latest version
+        v = tags[-2].name if v == 'HEAD'
+      else
+        v = '0.0.0'
+      end
+      return v
+    end
+
   private
 
     #
@@ -157,6 +207,25 @@ module Adapters
     end
 =end
 
+    # Find vclog config directory. This searches up from the current
+    # working directory for the following paths (in order):
+    #
+    #   .vclog/
+    #   .config/vclog/
+    #    config/vclog/
+    #
+    def lookup_config
+      conf = nil
+      Dir.ascend(Dir.pwd) do |path|
+        check = Dir['{.vclog/,.config/vclog/,config/vclog/}/'].first
+        if check
+          conf = path 
+          break
+        end
+      end
+      conf
+    end
+
   public
 
     #

data/lib/vclog/adapters/darcs.rb

@@ -11,20 +11,20 @@ module Adapters
   #
   class Darcs < Abstract
 
-    ### Is a darcs repository?
+    # Is a darcs repository?
     def repository?
       File.directory?('_darcs')
     end
 
-    ### This is also a module function.
+    # This is also a module function.
     module_function :repository?
 
-    ### Cached Changelog.
+    # Cached Changelog.
     def changelog
       @changelog ||= generate_changelog
     end
 
-    ### Generate Changelog object.
+    # Generate Changelog object.
     def generate_changelog
       raise "not a darcs repository" unless repository?
 
@@ -48,7 +48,7 @@ module Adapters
       return log
     end
 
-    ### Retrieve the "revision number" from the darcs tree.
+    # Retrieve the "revision number" from the darcs tree.
     def calculate_version
       raise "not a darcs repository" unless repository?
 

data/lib/vclog/adapters.rb

@@ -8,11 +8,10 @@ module VCLog
   module Adapters
 
     #
-    def self.factory(root=nil)
-      root = root || Dir.pwd
-      type = read_type(root)
+    def self.factory(config) #, options={})
+      type = read_type(config.root)
       raise ArgumentError, "Not a recognized version control system." unless type
-      const_get(type.capitalize).new(root)
+      const_get(type.capitalize).new(config) #, options)
     end
 
     #

data/lib/vclog/change.rb

@@ -1,3 +1,5 @@
+require 'vclog/kernel'
+
 module VCLog
 
   # = Change Log Entry class
@@ -10,15 +12,20 @@ module VCLog
     attr_accessor :date
     attr_accessor :revision
     attr_accessor :message
+
     attr_accessor :type
+    attr_accessor :level
+    attr_accessor :label
 
     #
-    def initialize(rev, date, author, message)
+    def initialize(rev, date, author, message, type, level, label)
       self.revision = rev
       self.date     = date
       self.author   = author
-      self.type     = type
       self.message  = message
+      self.type     = type
+      self.level    = level
+      self.label    = label
     end
 
     #
@@ -26,11 +33,6 @@ module VCLog
       @author = author.strip
     end
 
-    #
-    def message=(note)
-      @message, @type = split_type(note)
-    end
-
     #def clean_type(type)
     #  case type.to_s
     #  when 'maj', 'major' then :major
@@ -42,6 +44,7 @@ module VCLog
     #  end
     #end
 
+=begin
     #
     def type_phrase
       case type.to_s
@@ -56,27 +59,10 @@ module VCLog
       when '-'
         'Administrative Changes'
       else
-        "#{type.capitalize} Enhancements"
-      end
-    end
-
-    #
-    def type_number
-      case type.to_s.downcase
-      when 'maj', 'major'
-        0
-      when 'min', 'minor'
-        1
-      when 'bug'
-        2
-      when ''
-        4
-      when '-'
-        5
-      else # other
-        3
+        "#{type.to_s.capitalize} Enhancements"
       end
     end
+=end
 
     #
     def <=>(other)
@@ -104,8 +90,7 @@ module VCLog
     #  to_h.to_yaml(*args)
     #end
 
-    private
-
+=begin
     # Looks for a "[type]" indicator at the end of the commit message.
     # If that is not found, it looks at front of message for
     # "[type]" or "[type]:". Failing that it tries just "type:".
@@ -127,6 +112,7 @@ module VCLog
       n.gsub!(/^\s*?\n/m,'') # remove blank lines
       return n, t
     end
+=end
 
   end #class Entry
 

data/lib/vclog/changelog.rb

@@ -17,24 +17,15 @@ module VCLog
 
     DIR = File.dirname(__FILE__)
 
+    # Seconds in a day.
     DAY = 24*60*60
 
+    #
     attr :changes
 
-    attr_accessor :marker
-
-    attr_accessor :title
-
-    # Include revision id?
-    attr_accessor :rev_id
-
     #
     def initialize(changes=nil)
       @changes = []
-      @marker  = "#"
-      @title   = "CHANGE LOG"
-      @rev_id  = false
-
       @changes = changes if changes
     end
 
@@ -55,6 +46,11 @@ module VCLog
       @changes << Change.new(rev, date, who, note, type)
     end
 
+    #
+    def sort!(&block)
+      changes.sort!(&block)
+    end
+
     #
     def each(&block)
       changes.each(&block)
@@ -384,7 +380,7 @@ end
         entries = groups[n]
         next if !entries
         next if entries.empty?
-        string << "* #{entries.size} #{entries[0].type_phrase}\n\n"
+        string << "* #{entries.size} #{entries[0].label}\n\n"
         entries.sort!{|a,b| a.date <=> b.date }
         entries.each do |entry|
           #string << "== #{date}  #{who}\n\n"  # no email :(