vclog 1.8.2 → 1.9.0

data/lib/vclog/cli.rb

@@ -1,72 +1,8 @@
-module VCLog
+require 'vclog/repo'
 
-  #
-  def self.cli(*argv)
-    argv ||= ARGV.dup
-    begin
-      #opt = global_parser.order!(argv)
-      cmd = argv.shift unless argv.first =~ /^-/
-      cmd = cmd || 'changelog'
-      cli = CLI.factory(cmd)
-      cli.run(argv)
-    rescue => err
-      if $DEBUG
-        raise err
-      else
-        puts err.message
-        exit -1
-      end
-    end
-  end
+require 'vclog/cli/log'
+require 'vclog/cli/formats'
+require 'vclog/cli/bump'
+require 'vclog/cli/version'
+require 'vclog/cli/autotag'
 
-  # = Command Line Interface
-  #
-  # == SYNOPSIS
-  #
-  # VCLog provides cross-vcs ChangeLogs. It works by
-  # parsing the native changelog a VCS system produces
-  # into a common model, which then can be used to
-  # produce Changelogs in a variety of formats.
-  #
-  # VCLog currently support git, hg and svn, with cvs and darcs in the works.
-  #
-  # == EXAMPLES
-  #
-  # To produce a GNU-like changelog:
-  #
-  #  $ vclog
-  #
-  # For XML format:
-  #
-  #  $ vclog -f xml
-  #
-  # Or for a micorformat-ish HTML:
-  #
-  #  $ vclog -f html
-  #
-  # To use the library programmatically, please see the API documentation.
-
-  module CLI
-    require 'vclog/repo'
-
-    require 'vclog/cli/help'
-    require 'vclog/cli/changelog'
-    require 'vclog/cli/history'
-    require 'vclog/cli/formats'
-    require 'vclog/cli/bump'
-    require 'vclog/cli/version'
-    require 'vclog/cli/autotag'
-
-    #
-    def self.factory(name)
-      # find the closet matching term
-      terms = register.map{ |cli| cli.terms }.flatten
-      term = terms.select{ |term| /^#{name}/ =~ term }.first
-      # get the class that goes with the term
-      cmdclass = register.find{ |cli| cli.terms.include?(term) }
-      raise "Unknown command -- #{name}" unless cmdclass
-      cmdclass.new
-    end
-
-  end
-end

data/lib/vclog/cli/abstract.rb

@@ -1,109 +1,92 @@
+require 'vclog'
 require 'optparse'
 
 module VCLog
-module CLI
 
-  #
-  def self.register
-    @register ||= []
-  end
-
-  #
-  class Abstract
-
-    #
-    def self.inherited(subclass)
-      CLI.register << subclass
-    end
+  module CLI
 
     #
-    def self.terms
-      [name.split('::').last.downcase]
-    end
-
-    # TODO: change +extra+ to +summarize+ and reverse boolean value.
-    def initialize
-      @options = {}
-      @options[:extra] = true
+    def self.register
+      @register ||= []
     end
 
+    # Abstract base class for all command classes.
     #
-    def options
-      @options
-    end
-
-    #
-    def parser(&block)
-      parser = OptionParser.new(&block)
-
-      parser.separator " "
-      parser.separator "SYSTEM OPTIONS:"
-      parser.on('--debug', 'show debugging information') do
-        $DEBUG = true
-      end
-      parser.on('--help' , '-h', 'display this help information') do
-        puts parser
-        exit
+    class Abstract
+
+      #
+      def self.run(argv)
+        new.run(argv)
+      rescue => err
+        if $DEBUG
+          raise err
+        else
+          puts err.message
+          exit -1
+        end
       end
-      parser
-    end
 
-    # Setup options common to templating commands.
-    #
-    # parser - instance of options parser
-    #
-    # Returns a instance of OptionParser.
-    def template_options(parser)
-      parser.separator(" ")
-      parser.separator("OUTPUT OPTIONS: (use varies with format)")
-      parser.on('--format', '-f FORMAT', "output format") do |format|
-        options[:format] = format.to_sym
+      #
+      def self.inherited(subclass)
+        CLI.register << subclass
       end
-      parser.on('--style <URI>', "provide a stylesheet URI (css or xsl) for HTML or XML format") do |uri|
-        options[:stylesheet] = uri
-      end
-      parser.on('--title', '-t TITLE', "document title") do |string|
-        options[:title] = string
+
+      #
+      def self.terms
+        [name.split('::').last.downcase]
       end
-      parser.on('--summarize', '-s', "produce summary output") do
-        options[:extra] = false
+
+      #
+      def initialize
+        @options = {}
       end
-      parser.on('--id', "include revision id") do
-        options[:revision] = true
+
+      #
+      def options
+        @options
       end
-      parser.on('--level', '-l NUMBER', "lowest level of commit to display [0]") do |num|
-        options[:level] = num.to_i
+
+      #
+      def parser(&block)
+        parser = OptionParser.new(&block)
+
+        parser.separator " "
+        parser.separator "SYSTEM OPTIONS:"
+        parser.on('--debug', 'show debugging information') do
+          $DEBUG = true
+        end
+        parser.on('--help' , '-h', 'display this help information') do
+          puts parser
+          exit
+        end
+        parser
       end
-      #parser.on('--typed', "catagorize by commit type") do
-      #  typed = true
-      #end
-      parser
-    end
 
-    # Run the command.
-    def run(argv=nil)
-      argv ||= ARGV.dup
+      # Run the command.
+      def run(argv=nil)
+        argv ||= ARGV.dup
 
-      parser.parse!(argv)
+        parser.parse!(argv)
 
-      @arguments = argv
+        @arguments = argv
 
-      root  = Dir.pwd  # TODO: find root
+        root  = Dir.pwd  # TODO: find root
 
-      @repo = VCLog::Repo.new(root, options)
+        @repo = VCLog::Repo.new(root, options)
 
-      execute
-    end
+        execute
+      end
 
-    # Repo is set in #run.
-    def repo
-      @repo
-    end
+      # Repo is set in #run.
+      def repo
+        @repo
+      end
 
-    #
-    attr :arguments
+      #
+      attr :arguments
+
+    end
 
   end
 
 end
-end

data/lib/vclog/cli/autotag.rb

@@ -1,7 +1,6 @@
 require 'vclog/cli/abstract'
 
-module VCLog
-module CLI
+module VCLog::CLI
 
   #
   class Autotag < Abstract
@@ -35,4 +34,3 @@ module CLI
   end
 
 end
-end

data/lib/vclog/cli/bump.rb

@@ -1,8 +1,8 @@
 require 'vclog/cli/abstract'
 
-module VCLog
-module CLI
+module VCLog::CLI
 
+  #
   class Bump < Abstract
 
     #
@@ -13,7 +13,7 @@ module CLI
     #
     def parser
       super do |opt|
-        opt.banner = "Usage: vclog bump"
+        opt.banner = "Usage: vclog-bump"
         opt.separator(" ")
         opt.separator("Display a bumped version number.")
       end
@@ -27,4 +27,3 @@ module CLI
   end
 
 end
-end

data/lib/vclog/cli/formats.rb

@@ -1,8 +1,9 @@
 require 'vclog/cli/abstract'
 
-module VCLog
-module CLI
+module VCLog::CLI
 
+  # Command to display a list of available formats.
+  #
   class Formats < Abstract
 
     #
@@ -13,7 +14,7 @@ module CLI
     #
     def parser
       super do |opt|
-        opt.banner = "Usage: vclog formats"
+        opt.banner = "Usage: vclog-formats"
       end
     end
 
@@ -25,4 +26,3 @@ module CLI
   end
 
 end
-end

data/lib/vclog/cli/log.rb

@@ -0,0 +1,86 @@
+require 'vclog/cli/abstract'
+
+module VCLog::CLI
+
+  # VCLog provides cross-vcs ChangeLogs. It works by
+  # parsing the native changelog a VCS system produces
+  # into a common model, which then can be used to
+  # produce Changelogs in a variety of formats.
+  #
+  # VCLog currently support git, hg and svn, with cvs and
+  # darcs in the works.
+  #
+  # To produce a GNU-like changelog:
+  #
+  #   $ vclog
+  #
+  # For XML format:
+  #
+  #   $ vclog -f xml
+  #
+  # Or for a micorformat-ish HTML:
+  #
+  #   $ vclog -f html
+  #
+  # To use the library programmatically, please see the API documentation.
+  #
+  class Log < Abstract
+
+    # Setup options for log command.
+    #
+    # Returns a instance of OptionParser.
+    def parser
+      super do |parser|
+        parser.banner = 'Usage: vclog [options]'
+        parser.separator(' ')
+        parser.separator('Print a change log or release history.')
+        parser.separator(' ')
+        parser.separator('OPTIONS: (use varies with format)')
+        parser.on('-f', '--format FORMAT', 'output format (ansi,gnu,html,...)') do |format|
+          options[:format] = format.to_sym
+        end
+        parser.on('-r', '--release', '--history', 'show release history, instead of changelog') do
+          options[:type] = :history
+        end
+        parser.on('-t', '--title TITLE', 'document title') do |string|
+          options[:title] = string
+        end
+        parser.on('-v', '--version NUM', 'use as current version number') do |num|
+          options[:version] = num
+        end
+        parser.on('-l', '--level NUMBER', 'lowest level of commit to display (default: 0)') do |num|
+          options[:level] = num.to_i
+        end
+        parser.on('-p', '--point', 'split commit message into per-point entries') do
+          options[:point] = true
+        end
+        parser.separator(' ')
+        parser.separator('XML/HTML OPTIONS: (applies only to xml/html formats)')
+        parser.on('-S', '--style URI', 'provide a stylesheet URI (css or xsl)') do |uri|
+          options[:stylesheet] = uri
+        end
+        parser.separator(' ')
+        parser.separator('TEXT OPTIONS: (applies only to text formats)')
+        parser.on('-i', '--id', 'include reference/revision id in output') do
+          options[:reference] = true  # TODO: change to :id ?
+        end
+        parser.on('-d', '--detail', 'include commit message details (no effect if -p)') do
+          options[:detail] = true
+        end
+        parser.on('-s', '--summary', 'exclude commit messages from report') do
+          options[:summary] = true
+        end
+        #parser.on('--typed', "catagorize by commit type") do
+        #  typed = true
+        #end
+      end
+    end
+
+    #
+    def execute
+      puts repo.report(options)
+    end
+
+  end
+
+end

data/lib/vclog/cli/version.rb

@@ -1,8 +1,9 @@
 require 'vclog/cli/abstract'
 
-module VCLog
-module CLI
+module VCLog::CLI
 
+  # Display the current version.
+  #
   class Version < Abstract
 
     #
@@ -27,4 +28,3 @@ module CLI
   end
 
 end
-end

data/lib/vclog/heuristics.rb

@@ -1,24 +1,31 @@
-require 'vclog/heuristics/label'
+require 'vclog/heuristics/type'
 require 'vclog/heuristics/rule'
 
 module VCLog
 
+  # Heuristics stores a set of rules to be applied to commmits
+  # in order to assign them priority levels and report labels.
   #
   class Heuristics
 
     # Load heuristics from a designated file.
     #
-    # @param file [String] configuration file
+    # @param [String] file 
+    #   Configuration file.
     #
     def self.load(file)
       raise LoadError unless File.exist?(file)
       new{ instance_eval(File.read(file), file) }
     end
 
-    #
+    # Setup new heurtistics set.
     def initialize(&block)
-      @rules  = []
-      @labels = {}
+      @rules = []
+
+      @types = Hash.new{ |h,k| h[k] = h[:default] }
+      @types[:default] = Type.new(:default, -1, "Nominal Changes")
+
+      @colors = [:blue, :blue, :cyan, :green, :yellow, :red, :red]
 
       if block
         instance_eval(&block)
@@ -27,60 +34,127 @@ module VCLog
       end
     end
 
+    # Apply heuristics to a commit.
     #
-    def lookup(message)
-      type_msg = nil
-      @rules.find{|rule| type_msg = rule.call(message)}
-      type, msg = *type_msg
-      if type
-        type = type.to_sym
-        if @labels.key?(type)
-           @labels[type].to_a + [msg || message]
-        else
-          [type, 0, "#{type.to_s.capitalize} Enhancements", msg || message]
-        end
-      else
-        [nil, 0, 'General Enhancements', msg || message]
+    # @param [Change] commit
+    #   Instance of Change encapsulates an SCM commit.
+    #
+    def apply(commit)
+      # apply rules, breaking on first rule found that fits.
+      @rules.find{ |rule| rule.call(commit) }
+
+      unless commit.level
+        commit.level = types[commit.type].level
       end
+
+      unless commit.label
+        commit.label = types[commit.type].label
+      end
+
+      # apply color for commit level
+      color = @colors[commit.level + (@colors.size / 2)]
+      color ||= (commit.level > 0 ? @colors.first : @colors.last)
+      commit.color = color
     end
 
-    #
-    def on(pattern, &block)
+    # 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
+
+    # @deprecated
+    alias_method :set, :type
+
+    # Access to defined types.
     #
-    def set(type, level, label)
-      @labels[type.to_sym] = Label.new(type, level, label)
+    # @example
+    #   commit.type = :major
+    #
+    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.
+    #
+    # @example
+    #   colors :red, :yellow, :green, :cyan, :blue
+    #
+    def colors(*list)
+      @colors = list
     end
 
     # Default settings.
     def default
-      set :major,  1, "Major Enhancements"
-      set :bug,    0, "Bug Fixes"
-      set :minor, -1, "Minor Enhancements"
-      set :doc,   -1, "Documentation Changes"
-      set :admin, -2, "Administrative Changes"
-
-      on /^(\w+):/ do |msg, md|
-        word = md[1]
-        [word.to_sym, md.post_match]
+      type :major,    3, "Major Enhancements"
+      type :minor,    2, "Minor Enhancements"
+      type :bug,      1, "Bug Fixes"
+      type :default,  0, "Nominal Changes"
+      type :doc,     -1, "Documentation Changes"
+      type :test,    -2, "Test/Spec Adjustments"
+      type :admin,   -3, "Administrative Changes"
+
+      on /\A(\w+):/ do |commit, md|
+        type = md[1].to_sym
+        commit.type    = type
+        commit.message = commit.message.sub(md[0],'').strip
+        true
       end
 
-      on /\[(\w+)\]\s*$/ do |msg, md|
-        word = md[1]
-        [word.to_sym, md.pre_match]
+      on /\[(\w+)\]\s*$/ do |commit, md|
+        type = md[1].to_sym
+        commit.type    = type
+        commit.message = commit.message.sub(md[0],'').strip
+        true
       end
 
-      on /updated? (README|PROFILE|PACKAGE|VERSION|MANIFEST)/ do
-        :admin
+      on /updated? (README|PROFILE|PACKAGE|VERSION|MANIFEST)/ do |commit|
+        commit.type = :admin
       end
 
-      on /(bump|bumped|prepare) version/ do
-        :admin
+      on /(bump|bumped|prepare) version/ do |commit|
+        commit.type = :admin
       end
     end
 
+    # Work on next-gen default heuristics.
+    def default2
+      type :major,    3, "Major Enhancements"
+      type :minor,    2, "Minor Enhancements"
+      type :bug,      1, "Bug Fixes"
+      type :default,  0, "Nominal Changes"
+      type :doc,     -1, "Documentation Changes"
+      type :test,    -2, "Test/Spec Adjustments"
+      type :admin,   -3, "Administrative Changes"
+
+      # test/spec file only changes
+      on do |commit|
+        if commit.files.all?{ |f| f.start_with?('test') || f.start_with?('spec') }
+          commit.type = :test
+        end
+      end
+    end
+
+   private
+
+    # TODO: applies types that are "close", to help overlook typos.
+    #
+    #def close_type(type)
+    #  case type.to_s
+    #  when 'maj', 'major' then :major
+    #  when 'min', 'minor' then :minor
+    #  when 'bug'          then :bug
+    #  when ''             then :other
+    #  else
+    #    type.to_sym
+    #  end
+    #end
+
   end
 
 end