vclog 1.5.0 → 1.6.0

data/lib/vclog/cli/abstract.rb

@@ -0,0 +1,99 @@
+require 'ostruct'
+require 'optparse'
+
+module VCLog
+module CLI
+
+  #
+  def self.register
+    @register ||= []
+  end
+
+  #
+  class Abstract
+
+    #
+    def self.inherited(subclass)
+      CLI.register << subclass
+    end
+
+    #
+    def self.terms
+      [name.split('::').last.downcase]
+    end
+
+    #
+    def initialize
+      @options = OpenStruct.new
+    end
+
+    #
+    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
+      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
+      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
+      end
+      parser.on('--detail', '-d', "provide details") do
+        options.extra = true
+      end
+      parser.on('--id', "include revision id") do
+        options.revision = true
+      end
+      parser.on('--level', '-l NUMBER', "lowest level of commit to display [0]") do |num|
+        options.level = num.to_i
+      end
+      parser
+    end
+
+    # Run the command.
+    def run(argv=nil)
+      argv ||= ARGV.dup
+
+      parser.parse!(argv)
+
+      @root = Dir.pwd  # TODO: find root
+
+      @conf = VCLog::Config.new(@root)
+      @conf.level = options.level if options.level
+
+      @vcs  = VCLog::Adapters.factory(@conf)
+
+      execute
+    end
+
+  end
+
+end
+end

data/lib/vclog/cli/bump.rb

@@ -0,0 +1,30 @@
+require 'vclog/cli/abstract'
+
+module VCLog
+module CLI
+
+  class Bump < Abstract
+
+    #
+    def self.terms
+      ['bump']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog bump"
+        opt.separator(" ")
+        opt.separator("Display a bumped version number.")
+      end
+    end
+
+    #
+    def execute
+      puts @vcs.bump #(version)
+    end
+
+  end
+
+end
+end

data/lib/vclog/cli/changelog.rb

@@ -0,0 +1,33 @@
+require 'vclog/cli/abstract'
+
+module VCLog
+module CLI
+
+  class Changelog < Abstract
+
+    #
+    def self.terms
+      ['log', 'changelog']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog [changelog | log] [options]"
+        opt.separator(" ")
+        opt.separator("Print a Change Log.")
+        template_options(opt)
+      end
+    end
+
+    #
+    def execute
+      format = options.format || 'ansi'
+      output = @vcs.display(:changelog, format, options)
+      puts output
+    end
+
+  end
+
+end
+end

data/lib/vclog/cli/help.rb

@@ -0,0 +1,37 @@
+require 'vclog/cli/abstract'
+
+module VCLog
+module CLI
+
+  class Help < Abstract
+
+    #
+    def self.terms
+      ['help']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog help"
+      end
+    end
+
+    #
+    def execute
+      puts "Usage: vclog [command] [options]"
+      puts
+      puts "COMMANDS:"
+      puts "  changelog      display a Change Log"
+      puts "  history        display a Release History"
+      puts "  version        display the current tag version"
+      puts "  bump           display next reasonable version"
+      puts "  list           display format options"
+      puts "  help           show help information"
+      puts
+    end
+
+  end
+
+end
+end

data/lib/vclog/cli/history.rb

@@ -0,0 +1,40 @@
+require 'vclog/cli/abstract'
+
+module VCLog
+module CLI
+
+  class History < Abstract
+
+    #
+    def self.terms
+      ['history', 'release']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog history [options]\n" +
+                     "       vclog release [options]"
+        opt.separator " "
+        opt.separator("Print a Release History.")
+        opt.separator(" ")
+        opt.separator "SPECIAL OPTIONS:"
+        opt.on('--version', '-v NUM', "use as if current version number") do |num|
+          options.version = num
+        end
+
+        template_options(opt)
+      end
+    end
+
+    #
+    def execute
+      format = options.format || 'ansi'
+      output = @vcs.display(:history, format, options)
+      puts output
+    end
+
+  end
+
+end
+end

data/lib/vclog/cli/list.rb

@@ -0,0 +1,28 @@
+require 'vclog/cli/abstract'
+
+module VCLog
+module CLI
+
+  class List < Abstract
+
+    #
+    def self.terms
+      ['list', 'templates']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog list"
+      end
+    end
+
+    #
+    def execute
+      puts "  ansi  gnu  rdoc  markdown  xml  html  atom  rss  json  yaml"
+    end
+
+  end
+
+end
+end

data/lib/vclog/cli/version.rb

@@ -0,0 +1,30 @@
+require 'vclog/cli/abstract'
+
+module VCLog
+module CLI
+
+  class Version < Abstract
+
+    #
+    def self.terms
+      ['version']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog version"
+        opt.separator(" ")
+        opt.separator("Display the current version number.")
+      end
+    end
+
+    #
+    def execute
+      puts @vcs.version
+    end
+
+  end
+
+end
+end

data/lib/vclog/cli.rb

@@ -1,8 +1,5 @@
 module VCLog
 
-  require 'vclog/adapters'
-  require 'optparse'
-
   # = vclog Command
   #
   # == SYNOPSIS
@@ -31,19 +28,53 @@ module VCLog
   #
   # To use the library programmatically, please see the API documentation.
 
-  def self.run
-    begin
-      vclog
-    rescue => err
-      if $DEBUG
-        raise err
-      else
-        puts err.message
-        exit -1
+  module CLI
+
+    require 'vclog/config'
+    require 'vclog/adapters'
+
+    require 'vclog/cli/help'
+    require 'vclog/cli/changelog'
+    require 'vclog/cli/history'
+    require 'vclog/cli/list'
+    require 'vclog/cli/bump'
+    require 'vclog/cli/version'
+
+    def self.main(*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
+
+    #
+    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
 
+# VCLog Copyright (c) 2008 Thomas Sawyer
+
+=begin
   #
   def self.vclog
     type    = :log
@@ -53,7 +84,7 @@ module VCLog
     output  = nil
     title   = nil
     version = nil
-    extra   = false
+    extra   = false  require 'vclog/cli/help'
     rev     = false
     typed   = false
 
@@ -61,17 +92,6 @@ module VCLog
 
       opt.banner = "Usage: vclog [--TYPE] [-f FORMAT] [OPTIONS] [DIR]"
 
-      opt.separator(" ")
-      opt.separator("OUTPUT TYPE (choose one):")
-
-      opt.on('--log', '--changelog', '-l', "changelog (default)") do
-        type = :log
-      end
-
-      opt.on('--rel', '--history', '-r', "release history") do
-        type = :rel
-      end
-
       opt.on('--current', '-c', "display current version number") do
         type = :curr
       end
@@ -85,63 +105,65 @@ module VCLog
         exit
       end
 
+      opt.on('--help' , '-h', 'display this help information') do
+        puts opt
+        exit
+      end
+
       opt.separator(" ")
-      opt.separator("FORMAT OPTION:")
+      opt.separator("FORMAT OPTIONS: (use varies with format)")
 
-      opt.on('--format', '-f <FORMAT>', "Output format") do |format|
+      opt.on('--format', '-f FORMAT', "output format") do |format|
         format = format.to_sym
       end
 
-      opt.separator(" ")
-      opt.separator("OTHER OPTIONS:")
+      opt.on('--style <URI>', "provide a stylesheet URI (css or xsl) for HTML or XML format") do |uri|
+        style = uri
+      end
+
+      opt.on('--version', '-v NUM', "current version number") do |num|
+        version = num
+      end
+
 
       #opt.on('--typed', "catagorize by commit type") do
       #  typed = true
       #end
 
-      opt.on('--title <TITLE>', "document title, used by some formats") do |string|
+      opt.on('--title', '-t TITLE', "document title") do |string|
         title = string
       end
 
-      opt.on('--extra', '-e', "provide extra output (used by some formats)") do
+      opt.on('--detail', '-d', "provide details") do
         extra = true
       end
 
-      opt.on('--version', '-v <NUM>', "current version to use for release history") do |num|
-        version = num
+      opt.on('--id', "include revision id") do
+        rev = true
       end
 
-      opt.on('--style <URI>', "provide a stylesheet URI (css or xsl) for HTML or XML format") do |uri|
+      opt.on('--style URI', "provide a stylesheet URI (css or xsl) for HTML or XML format") do |uri|
         style = uri
       end
 
-      opt.on('--id', "include revision ids (in formats that normally do not)") do
-        rev = true
-      end
-
       # DEPRECATE
-      opt.on('--output', '-o <FILE>', "send output to a file instead of stdout") do |out|
+      opt.on('--output', '-o FILE', "send output to a file instead of stdout") do |out|
         output = out
       end
 
       opt.separator(" ")
-      opt.separator("STANDARD OPTIONS:")
+      opt.separator("SYSTEM OPTIONS:")
 
-      opt.on('--debug', "show debugging infromation") do
+      opt.on('--debug', "show debugging information") do
         $DEBUG = true
       end
-
-      opt.on_tail('--help' , '-h', 'display this help information') do
-        puts opt
-        exit
-      end
     end
 
     optparse.parse!(ARGV)
 
     root = ARGV.shift || Dir.pwd
-
-    vcs = VCLog::Adapters.factory #(root)
+    conf = VCLog::Config.new(root)
+    vcs  = VCLog::Adapters.factory(conf)
 
     case type
     when :bump
@@ -210,8 +232,5 @@ module VCLog
   #    Dir.glob('{history,changes,changelog}{,.*}', File::FNM_CASEFOLD).first
   #  end
   #end
-
-end
-
-# VCLog Copyright (c) 2008 Thomas Sawyer
+=end
 

data/lib/vclog/config.rb

@@ -0,0 +1,65 @@
+require 'vclog/heuristics'
+
+module VCLog
+
+  #
+  class Config
+
+    # File glob used to find the vclog configuration directory.
+    CONFIG_GLOB = '{.vclog,.config/vclog,config/vclog}/'
+
+    # File glob used to find project root directory.
+    ROOT_GLOB = '{.vclog/,.config/vclog/,config/vclog/,.git/,README*}/'
+
+    #
+    def initialize(root=nil)
+      @root  = root || lookup_root || Dir.pwd
+      @dir   = Dir[File.join(root, CONFIG_GLOB)]
+      @level = 0
+    end
+
+    # Project's root directory.
+    attr :root
+
+    # Configuration directory.
+    attr :dir
+
+    # Default change level.
+    #
+    # TODO: get from config file.
+    attr_accessor :level
+
+    #
+    def heuristics
+      @heuristics ||= Heuristics.load(heuristics_file)
+    end
+
+    #
+    def heuristics_file
+      @heuristics_file ||= Dir[File.join(dir, 'rules.rb')].first
+    end
+
+    # Find project root. This searches up from the current working
+    # directory for the following paths (in order):
+    #
+    #   .vclog/
+    #   .config/vclog/
+    #   config/vclog/
+    #   .git/
+    #   README*
+    #
+    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

data/lib/vclog/formatter.rb

@@ -10,17 +10,20 @@ module VCLog
     #
     attr :vcs
 
+    # New Formmater.
+    #
+    # vcs - an instance of a subclass of VCS::Abstract
     #
     def initialize(vcs)
       @vcs = vcs
     end
 
-    #
+    # Returns a Changelog object taken from the VCS.
     def changelog
       @vcs.changelog
     end
 
-    #
+    # Returns a History object garnered form the VCS.
     def history
       @vcs.history
     end
@@ -50,20 +53,24 @@ module VCLog
       @options.homepage
     end
 
-    #
+    # TODO: let be nil and let template make a default if wanted
     def title
       return @options.title if @options.title
       case @doctype
       when :history
-        "Release History"
+        "RELEASE HISTORY"
       else
-        "Change Log"
+        "CHANGELOG"
       end
     end
 
     #
-    def display(doctype, format, options={})
-      options = OpenStruct.new(options)
+    #--
+    # NOTE: ERBs trim_mode is broken --it removes an extra space. 
+    # So we can't use it for plain text templates.
+    #++
+    def display(doctype, format, options)
+      options = OpenStruct.new(options) if Hash === options
 
       @doctype = doctype
       @format  = format
@@ -71,9 +78,19 @@ module VCLog
 
       require_formatter(format)
 
-      tmp = File.read(File.join(DIR, 'templates', "#{@doctype}.#{@format}"))
-      erb = ERB.new(tmp)
-      erb.result(binding)
+      tmp_file = Dir[File.join(DIR, 'templates', "#{@doctype}.#{@format}.{erb,rb}")].first
+
+      tmp = File.read(tmp_file)
+
+      case File.extname(tmp_file)
+      when '.rb'
+        eval(tmp, binding)
+      when '.erb'
+        erb = ERB.new(tmp, nil, '<>')
+        erb.result(binding)
+      else
+        raise "unrecognized template - #{tmp_file}"
+      end
     end
 
     private

data/lib/vclog/heuristics/default.rb

@@ -0,0 +1,20 @@
+set :major,  1, "Major Enhancements"
+set :minor, -1, "Minor Enhancements"
+set :admin, -2, "Administrative Changes"
+
+on /updated? (README|PROFILE|PACKAGE|VERSION|MANIFEST)/ do
+  :admin
+end
+
+on /bump(ed)? version/ do
+  :admin
+end
+
+on /^(\w+):/ do |word|
+  word.to_sym
+end
+
+on /\[(\w+)\]\s*$/ do |word|
+  word.to_sym
+end
+