vclog 1.7.0 → 1.8.0

data/lib/vclog/cli/abstract.rb

@@ -1,4 +1,3 @@
-require 'ostruct'
 require 'optparse'
 
 module VCLog
@@ -24,8 +23,8 @@ module CLI
 
     # TODO: change +extra+ to +summarize+ and reverse boolean value.
     def initialize
-      @options = OpenStruct.new
-      @options.extra = true
+      @options = {}
+      @options[:extra] = true
     end
 
     #
@@ -58,23 +57,26 @@ module CLI
       parser.separator(" ")
       parser.separator("OUTPUT OPTIONS: (use varies with format)")
       parser.on('--format', '-f FORMAT', "output format") do |format|
-        options.format = format.to_sym
+        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
+        options[:stylesheet] = uri
       end
       parser.on('--title', '-t TITLE', "document title") do |string|
-        options.title = string
+        options[:title] = string
       end
       parser.on('--summarize', '-s', "produce summary output") do
-        options.extra = false
+        options[:extra] = false
       end
       parser.on('--id', "include revision id") do
-        options.revision = true
+        options[:revision] = true
       end
       parser.on('--level', '-l NUMBER', "lowest level of commit to display [0]") do |num|
-        options.level = num.to_i
+        options[:level] = num.to_i
       end
+      #parser.on('--typed', "catagorize by commit type") do
+      #  typed = true
+      #end
       parser
     end
 
@@ -84,16 +86,23 @@ module CLI
 
       parser.parse!(argv)
 
-      @root = Dir.pwd  # TODO: find root
+      @arguments = argv
 
-      @conf = VCLog::Config.new(@root)
-      @conf.level = options.level if options.level
+      root  = Dir.pwd  # TODO: find root
 
-      @vcs  = VCLog::Adapters.factory(@conf)
+      @repo = VCLog::Repo.new(root, options)
 
       execute
     end
 
+    # Repo is set in #run.
+    def repo
+      @repo
+    end
+
+    #
+    attr :arguments
+
   end
 
 end

data/lib/vclog/cli/autotag.rb

@@ -0,0 +1,37 @@
+require 'vclog/cli/abstract'
+
+module VCLog
+module CLI
+
+  #
+  class Autotag < Abstract
+
+    #
+    def self.terms
+      ['autotag']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog autotag"
+        opt.separator(" ")
+        opt.separator("DESCRIPTION:")
+        opt.separator("  Ensure each entry in History has been tagged.")
+        opt.separator(" ")
+        opt.separator("SPECIAL OPTIONS:")
+        opt.on('--prefix', '-p', 'tag label prefix'){ options[:prefix] = true }
+        opt.on('--force', '-f', 'perform tagging without confirmation'){ options[:force] = true }
+        opt.on('--dryrun', '-n', 'run in dryrun mode'){ $DRYRUN = true }
+      end
+    end
+
+    #
+    def execute
+      repo.autotag(options[:prefix])
+    end
+
+  end
+
+end
+end

data/lib/vclog/cli/bump.rb

@@ -21,7 +21,7 @@ module CLI
 
     #
     def execute
-      puts @vcs.bump #(version)
+      puts repo.bump #(version)
     end
 
   end

data/lib/vclog/cli/changelog.rb

@@ -22,8 +22,8 @@ module CLI
 
     #
     def execute
-      format = options.format || 'ansi'
-      output = @vcs.display(:changelog, format, options)
+      format = options[:format] || 'ansi'
+      output = repo.display(:changelog, format, options)
       puts output
     end
 

data/lib/vclog/cli/{list.rb → formats.rb}

@@ -3,17 +3,17 @@ require 'vclog/cli/abstract'
 module VCLog
 module CLI
 
-  class List < Abstract
+  class Formats < Abstract
 
     #
     def self.terms
-      ['list', 'templates']
+      ['formats', 'templates']
     end
 
     #
     def parser
       super do |opt|
-        opt.banner = "Usage: vclog list"
+        opt.banner = "Usage: vclog formats"
       end
     end
 

data/lib/vclog/cli/help.rb

@@ -19,16 +19,21 @@ module CLI
 
     #
     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
+      if cmd = arguments.first
+        VCLog::CLI.cli(cmd, '--help')
+      else
+        puts "Usage: vclog [command] [options]"
+        puts
+        puts "COMMANDS:"
+        puts "  changelog      produce a Change Log"
+        puts "  history        produce a Release History"
+        puts "  formats        list available formats"
+        puts "  version        display the current version"
+        puts "  bump           display next reasonable version"
+        puts "  autotag        create tags for history file entries"
+        puts "  help           show help information"
+        puts
+      end
     end
 
   end

data/lib/vclog/cli/history.rb

@@ -20,17 +20,16 @@ module CLI
         opt.separator(" ")
         opt.separator "SPECIAL OPTIONS:"
         opt.on('--version', '-v NUM', "use as if current version number") do |num|
-          options.version = num
+          options[:version] = num
         end
-
         template_options(opt)
       end
     end
 
     #
     def execute
-      format = options.format || 'ansi'
-      output = @vcs.display(:history, format, options)
+      format = options[:format] || 'ansi'
+      output = repo.display(:history, format, options)
       puts output
     end
 

data/lib/vclog/cli/version.rb

@@ -21,7 +21,7 @@ module CLI
 
     #
     def execute
-      puts @vcs.version
+      puts repo.version
     end
 
   end

data/lib/vclog/cli.rb

@@ -1,6 +1,25 @@
 module VCLog
 
-  # = vclog Command
+  #
+  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
+
+  # = Command Line Interface
   #
   # == SYNOPSIS
   #
@@ -9,8 +28,7 @@ module VCLog
   # into a common model, which then can be used to
   # produce Changelogs in a variety of formats.
   #
-  # VCLog currently support SVN and Git. CVS, Darcs and
-  # Mercurial/Hg are in the works.
+  # VCLog currently support git, hg and svn, with cvs and darcs in the works.
   #
   # == EXAMPLES
   #
@@ -29,34 +47,15 @@ module VCLog
   # To use the library programmatically, please see the API documentation.
 
   module CLI
-
-    require 'vclog/config'
-    require 'vclog/adapters'
+    require 'vclog/repo'
 
     require 'vclog/cli/help'
     require 'vclog/cli/changelog'
     require 'vclog/cli/history'
-    require 'vclog/cli/list'
+    require 'vclog/cli/formats'
     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
+    require 'vclog/cli/autotag'
 
     #
     def self.factory(name)
@@ -71,166 +70,3 @@ module VCLog
 
   end
 end
-
-# VCLog Copyright (c) 2008 Thomas Sawyer
-
-=begin
-  #
-  def self.vclog
-    type    = :log
-    format  = :gnu
-    vers    = nil
-    style   = nil
-    output  = nil
-    title   = nil
-    version = nil
-    extra   = false  require 'vclog/cli/help'
-    rev     = false
-    typed   = false
-
-    optparse = OptionParser.new do |opt|
-
-      opt.banner = "Usage: vclog [--TYPE] [-f FORMAT] [OPTIONS] [DIR]"
-
-      opt.on('--current', '-c', "display current version number") do
-        type = :curr
-      end
-
-      opt.on('--bump', '-b', "display a bumped version number") do
-        type = :bump
-      end
-
-      opt.on('--formats', '-F', "list supported formats") do
-        puts "gnu rdoc markdown xml html atom rss json yaml"
-        exit
-      end
-
-      opt.on('--help' , '-h', 'display this help information') do
-        puts opt
-        exit
-      end
-
-      opt.separator(" ")
-      opt.separator("FORMAT OPTIONS: (use varies with format)")
-
-      opt.on('--format', '-f FORMAT', "output format") do |format|
-        format = format.to_sym
-      end
-
-      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', '-t TITLE', "document title") do |string|
-        title = string
-      end
-
-      opt.on('--detail', '-d', "provide details") do
-        extra = true
-      end
-
-      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|
-        style = uri
-      end
-
-      # DEPRECATE
-      opt.on('--output', '-o FILE', "send output to a file instead of stdout") do |out|
-        output = out
-      end
-
-      opt.separator(" ")
-      opt.separator("SYSTEM OPTIONS:")
-
-      opt.on('--debug', "show debugging information") do
-        $DEBUG = true
-      end
-    end
-
-    optparse.parse!(ARGV)
-
-    root = ARGV.shift || Dir.pwd
-    conf = VCLog::Config.new(root)
-    vcs  = VCLog::Adapters.factory(conf)
-
-    case type
-    when :bump
-      puts vcs.bump(version)
-      exit
-    when :curr
-      if vcs.tags.empty?
-        puts "0.0.0"
-      else
-        puts vcs.tags.last.name #TODO: ensure latest
-      end
-      exit
-    when :log
-      doctype = :changelog
-      #log = vcs.changelog
-      #log = log.typed if typed  #TODO: ability to select types?
-    when :rel
-      doctype = :history
-      #log = vcs.history(:title=>title, :extra=>extra, :version=>version)
-    else
-      raise "huh?"
-      #log = vcs.changelog
-      #log = log.typed if typed  #TODO: ability to select types?
-    end
-
-    options = { 
-      :title      => title,
-      :extra      => extra,
-      :version    => version,
-      :revision   => rev,
-      :stylesheet => style 
-    }
-
-    txt = vcs.display(doctype, format, options)
-
-    #case format
-    #when :xml
-    #  txt = log.to_xml(style)   # xsl stylesheet url
-    #when :html
-    #  txt = log.to_html(style)  # css stylesheet url
-    #when :yaml
-    #  txt = log.to_yaml
-    #when :json
-    #  txt = log.to_json
-    #when :markdown
-    #  txt = log.to_markdown(rev)
-    #when :rdoc
-    #  txt = log.to_rdoc(rev)
-    #else #:gnu
-    #  txt = log.to_gnu(rev)
-    #end
-
-    if output
-      File.open(output, 'w') do |f|
-        f << txt
-      end
-    else
-      puts txt
-    end
-  end
-
-  #def self.changelog_file(file)
-  #  if file && File.file?(file)
-  #    file
-  #  else
-  #    Dir.glob('{history,changes,changelog}{,.*}', File::FNM_CASEFOLD).first
-  #  end
-  #end
-=end
-

data/lib/vclog/facets.rb

@@ -1,7 +1,9 @@
+require 'facets/string/fold'
 require 'facets/string/indent'
 require 'facets/string/tabto'
 require 'facets/string/margin'
 require 'facets/enumerable/group_by'
+require 'facets/kernel/ask'
 
 =begin
 

data/lib/vclog/history.rb

@@ -23,6 +23,7 @@ module VCLog
     # Location of this file in the file system.
     DIR = File.dirname(__FILE__)
 
+    #
     attr :vcs
 
     # Alternate title.
@@ -128,4 +129,3 @@ module VCLog
   end
 
 end
-

data/lib/vclog/history_file.rb

@@ -0,0 +1,64 @@
+module VCLog
+
+  # The HistoryFile class will parse a history into an array
+  # of release tags. Of course to do this, it assumes a specific
+  # file format.
+  #
+  class HistoryFile
+
+    FILE = '{HISTORY,HISTORY.*}'
+
+    LINE = /^[=#]/
+    VERS = /(\d+\.)+\d+/
+    DATE = /(\d+\-)+\d+/
+
+    #
+    CASEFOLD = File::FNM_CASEFOLD
+
+    # Release tags.
+    attr :tags
+
+    #
+    def initialize(source=nil)
+      if File.file?(source)
+        @file = source
+        @root = File.dirname(source)
+      elsif File.directory?(source)
+        @file = Dir.glob(File.join(source,FILE), CASEFOLD).first
+        @root = source
+      else
+        @file = Dir.glob(FILE).first
+        @root = Dir.pwd
+      end
+      raise "no history file" unless @file
+
+      @tags = extract_tags
+    end
+
+    # Parse history file.
+    def extract_tags
+      tags = []
+      desc = ''
+      text = File.read(@file)
+      text.lines.each do |line|
+        if LINE =~ line
+          vers = (VERS.match(line) || [])[0]
+          date = (DATE.match(line) || [])[0]
+          next unless vers
+          tags << [vers, date, desc = '']
+        else
+          desc << line
+        end
+      end
+
+      tags.map do |vers, date, desc|
+        index = desc.index(/^Changes:/) || desc.index(/^\*/) || desc.size
+        desc = desc[0...index].strip.fold
+        #[vers, date, desc]
+        Tag.new(vers, nil, date, nil, desc)
+      end
+    end
+
+  end
+
+end

data/lib/vclog/meta/data.rb

@@ -0,0 +1,25 @@
+module VCLog
+
+  def self.package
+    @package ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/package'))
+    )
+  end
+
+  def self.profile
+    @profile ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/profile'))
+    )
+  end
+
+  def self.const_missing(name)
+    key = name.to_s.downcase
+    package[key] || profile[key] || super(name)
+  end
+
+  # Prime version.
+  VERSION = package['version']
+end
+

data/lib/vclog/meta/package

@@ -0,0 +1,11 @@
+name    : vclog
+date    : 2010-11-19
+version : 1.8.0
+
+requires:
+  - facets 2.4+
+  - ansi 1.2+
+  - syckle   (build)
+  - cucumber (test)
+  - aruba    (test)
+

data/{PROFILE → lib/vclog/meta/profile}

@@ -1,9 +1,8 @@
 --- 
 title    : VCLog
-suite    : proutils
+suite    : rubyworks
 summary  : Cross-VCS/SCM ChangeLog Generator
-copyright: Copyright (c) 2009 Thomas Sawyer
-license  : MIT
+license  : Apache 2.0
 contact  : trans <transfire@gmail.com>
 created  : 2006-05-09
 authors  : Thomas Sawyer
@@ -12,6 +11,8 @@ description:
   VCLog is a cross-VCS/SCM ChangeLog generator.
 
 resources:
-  homepage: http://proutils.github.com/vclog
-  repository: git://github.com/proutils/vclog.git
+  home: http://rubyworks.github.com/vclog
+  code: http://github.com/rubyworks/vclog
+  repo: git://github.com/proutils/vclog.git
 
+copyright: Copyright (c) 2009 Thomas Sawyer