vclog 1.4.0 → 1.5.0

data/lib/vclog/{vcs.rb → adapters/abstract.rb}

@@ -1,6 +1,8 @@
 module VCLog
+module Adapters
 
   require 'time'
+  require 'vclog/formatter'
   require 'vclog/changelog'
   require 'vclog/history'
   require 'vclog/change'
@@ -10,22 +12,7 @@ module VCLog
   #       LOG: entries in source files?
 
   # = Version Control System
-  class VCS
-
-    def self.factory(root=nil)
-      root = root || Dir.pwd
-      type = read_type(root)
-      raise ArgumentError, "Not a recognized version control system." unless type
-      VCS.const_get(type.upcase).new(root)
-    end
-
-    def self.read_type(root)
-      dir = nil
-      Dir.chdir(root) do
-        dir = Dir.glob("{.svn,.git,.hg,_darcs}").first
-      end
-      dir[1..-1] if dir
-    end
+  class Abstract
 
     attr :root
 
@@ -62,6 +49,12 @@ module VCLog
       @history ||= History.new(self, opts)
     end
 
+    #
+    def display(type, format, options={})
+      formatter = Formatter.new(self)
+      formatter.display(type, format, options)
+    end
+
     # Provides a bumped version number.
     def bump(part=nil)
       return part unless ['major', 'minor', 'patch', ''].include?(part.to_s)
@@ -97,6 +90,12 @@ module VCLog
 
   private
 
+    #
+    def version_tag?(tag_name)
+      /(v|\d)/i =~ tag_name
+    end
+
+=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:".
@@ -118,6 +117,7 @@ module VCLog
       n.gsub!(/^\s*?\n/m,'') # remove blank lines
       return n, t
     end
+=end
 
 =begin
     # Write the ChangeLog to file.
@@ -157,12 +157,30 @@ module VCLog
     end
 =end
 
-  end
+  public
 
-  require 'vclog/vcs/svn'
-  require 'vclog/vcs/git'
-  #require 'vclog/vcs/hg'
-  #require 'vclog/vcs/darcs'
+    #
+    def user
+      ENV['USER']
+    end
+
+    #
+    def email
+      ENV['EMAIL']
+    end
+
+    #
+    def repository
+      nil
+    end
+
+    #
+    def uuid
+      nil
+    end
 
+  end
+
+end
 end
 

data/lib/vclog/adapters/darcs.rb

@@ -0,0 +1,83 @@
+require 'vclog/adapters/abstract'
+
+module VCLog
+module Adapters
+
+  # = Darcs
+  #
+  # Provide Darcs SCM revision tools.
+  #
+  # TODO: This needs to be fixed.
+  #
+  class Darcs < Abstract
+
+    ### Is a darcs repository?
+    def repository?
+      File.directory?('_darcs')
+    end
+
+    ### This is also a module function.
+    module_function :repository?
+
+    ### Cached Changelog.
+    def changelog
+      @changelog ||= generate_changelog
+    end
+
+    ### Generate Changelog object.
+    def generate_changelog
+      raise "not a darcs repository" unless repository?
+
+      log = Changelog.new
+
+      txt = `darcs changes` #--repo=#{@repository}`
+
+      txt.each_line do |line|
+        case line
+        when /^\s*$/
+        when /^(Mon|Tue|Wed|Thu|Fri|Sat|Sun)/
+        when /^\s*tagged/
+          log << $'
+          log << "\n"
+        else
+          log << line
+          log << "\n"
+        end
+      end
+
+      return log
+    end
+
+    ### Retrieve the "revision number" from the darcs tree.
+    def calculate_version
+      raise "not a darcs repository" unless repository?
+
+      status = info.status
+
+      changes = `darcs changes`
+      count   = 0
+      tag     = "0.0"
+
+      changes.each("\n\n") do |change|
+        head, title, desc = change.split("\n", 3)
+        if title =~ /^  \*/
+          # Normal change.
+          count += 1
+        elsif title =~ /tagged (.*)/
+          # Tag.  We look for these.
+          tag = $1
+          break
+        else
+          warn "Unparsable change: #{change}"
+        end
+      end
+      ver = "#{tag}.#{count.to_s}"
+
+      return ver
+      #format_version_stamp(ver, status) # ,released)
+    end
+
+  end
+
+end
+end

data/lib/vclog/adapters/git.rb

@@ -0,0 +1,83 @@
+require 'vclog/adapters/abstract'
+
+module VCLog
+module Adapters
+
+  # = GIT Adapter
+  #
+  class Git < Abstract
+
+    # Collect changes.
+    #
+    def extract_changes
+      list = []
+      changelog = `git log --pretty=format:"---%ci|~|%aN|~|%H|~|%s"`.strip
+      changes = changelog.split("---")
+      #changes = changelog.split(/^commit/m)
+      changes.shift # throw the first (empty) entry away
+      changes.each do |entry|
+        date, who, rev, msg = entry.split('|~|')
+        date = Time.parse(date)
+        list << [rev, date, who, msg]
+      end
+      list
+    end
+
+    # Collect tags.
+    #
+    # `git show 1.0` produces:
+    #
+    #   tag 1.0
+    #   Tagger: 7rans <transfire@gmail.com>
+    #   Date:   Sun Oct 25 09:27:58 2009 -0400
+    #
+    #   version 1.0
+    #   commit
+    #   ...
+    #
+    def extract_tags
+      list = []
+      tags = `git tag -l`
+      tags.split(/\s+/).each do |tag|
+        next unless version_tag?(tag) # only version tags
+        info = `git show #{tag}`
+        md = /\Atag(.*?)\n(.*?)^commit/m.match(info)
+        who, date, *msg = *md[2].split(/\n/)
+        who  = who.split(':')[1].strip
+        date = date[date.index(':')+1..-1].strip
+        msg  = msg.join("\n")
+
+        info = `git show #{tag}^ --pretty=format:"%ci|~|%H|~|"`
+        date, rev, *_ = *info.split('|~|')
+
+        #md = /\Atag(.*?)\n(.*?)^commit/m.match(info)
+        #_who, _date, *_msg = *md[2].split(/\n/)
+        #_who  = _who.split(':')[1].strip
+        #_date = _date[_date.index(':')+1..-1].strip
+        #_msg  = _msg.join("\n")
+
+        list << [tag, rev, date, who, msg]
+      end
+      list
+    end
+
+    #
+    def user
+      @email ||= `git config user.name`.strip
+    end
+
+    #
+    def email
+      @email ||= `git config user.email`.strip
+    end
+
+    #
+    def repository
+      @repository ||= `git config remote.origin.url`.strip
+    end
+
+  end#class Git
+
+end
+end
+

data/lib/vclog/adapters/hg.rb

@@ -0,0 +1,82 @@
+require 'vclog/adapters/abstract'
+
+module VCLog
+module Adapters
+
+  # = Mercurial Adapter
+  #
+  class Hg < Abstract
+
+    # Collect changes.
+    #
+    def extract_changes
+      list = []
+      changelog = `hg log -v`.strip
+      changes = changelog.split("\n\n\n")
+      changes.each do |entry|
+        list << parse_entry(entry)
+      end
+      list
+    end
+
+    # Collect tags.
+    #
+    def extract_tags
+      list = []
+      if File.exist?('.hgtags')
+        File.readlines('.hgtags').each do |line|
+          rev, tag = line.strip.split(' ')
+          entry = `hg log -v -r #{rev}`.strip
+          rev, date, who, msg, type = parse_entry(entry)
+          list << [tag, rev, date, who, msg]
+        end
+      end
+      list
+    end
+
+    # TODO: check .hgrc
+    def user
+      ENV['HGUSER'] || ENV['USER']
+    end
+
+    #
+    def email
+      ENV['HGEMAIL'] || ENV['EMAIL']
+    end
+
+    # 
+    def repository
+      @repository ||= `hg showconfig paths.default`.strip
+    end
+
+    #
+    def uuid
+      nil
+    end
+
+    private
+
+      def parse_entry(entry)
+        rev, date, who, msg = nil, nil, nil, nil
+        entry.strip!
+        if md = /^changeset:(.*?)$/.match(entry)
+          rev = md[1].strip
+        end
+        if md = /^date:(.*?)$/.match(entry)
+          date = md[1].strip
+        end
+        if md = /^user:(.*?)$/.match(entry)
+          who = md[1].strip
+        end
+        if md = /^description:(.*?)\Z/m.match(entry)
+          msg = md[1].strip
+        end
+        date = Time.parse(date)
+        #msg, type = *split_type(msg)
+        return rev, date, who, msg
+      end
+
+  end
+
+end
+end

data/lib/vclog/adapters/svn.rb

@@ -0,0 +1,139 @@
+require 'vclog/adapters/abstract'
+
+module VCLog
+module Adapters
+
+  # = SVN
+  #
+  # NOTE: Unfortunately the SVN adapater is very slow. If hits the server
+  # every time the 'svn log' command is issued. When generating a History
+  # that's one hit for every tag. If anyone knows a better way please have
+  # at it --maybe future versions of SVN will improve the situation.
+  #
+  class Svn < Abstract
+
+    def initialize(root)
+      begin
+        require 'xmlsimple'
+      rescue LoadError
+        "VCLog requires xmlsimple for SVN support"
+      end
+      super(root)
+    end
+
+    #
+    def extract_changes
+      log = []
+
+      xml = `svn log --xml`.strip
+
+      commits = XmlSimple.xml_in(xml, {'KeyAttr' => 'rev'})
+      commits = commits['logentry']
+
+      commits.each do |com|
+        rev  = com["revision"]
+        msg  = [com["msg"]].flatten.compact.join('').strip
+        who  = [com["author"]].flatten.compact.join('').strip
+        date = [com["date"]].flatten.compact.join('').strip
+
+        next if msg.empty?
+        next if msg == "*** empty log message ***"
+
+        date = Time.parse(date)
+
+        log << [rev, date, who, msg]
+      end
+
+      log
+    end
+
+    #
+    def extract_tags
+      list = []
+      tagdir = tag_directory
+
+      if tagdir
+        tags = Dir.entries(tagdir).select{ |e| e.index('.') != 0 && e =~ /\d(.*)$/ }
+      else
+        tags = []
+      end
+
+      tags.each do |path|
+        dir = File.join(tagdir, path)
+
+        # using yaml, but maybe use xml instead?
+        info = `svn info #{dir}`
+        info = YAML.load(info)
+        md = /(\d.*)$/.match(info['Path'])
+        name = md ? md[1] : path
+        date = info['Last Changed Date']
+        who  = info['Last Changed Author']
+        rev  = info['Revision']
+
+        # get last commit
+        xml = `svn log -l1 --xml #{dir}`
+        commits = XmlSimple.xml_in(xml, {'KeyAttr' => 'rev'})
+        commit = commits['logentry'].first
+
+        msg  = [commit["msg"]].flatten.compact.join('').strip
+        date = [commit["date"]].flatten.compact.join('').strip
+
+        list << [name, rev, date, who, msg]
+      end
+      list
+    end
+
+    # This isn't perfect, but is there really anyway for it to be?
+    # It ascends up the current directory tree looking for the 
+    # best candidate for a tags directory.
+    def tag_directory
+      fnd = nil
+      dir = root
+      while dir != '/' do
+        entries = Dir.entries(dir)
+        if entries.include?('.svn')
+          if entries.include?('tags')
+            break(fnd = File.join(dir, 'tags'))
+          else
+            entries = entries.reject{ |e| e.index('.') == 0 }
+            entries = entries.reject{ |e| e !~ /\d$/ }
+            break(fnd = dir) unless entries.empty?
+          end
+        else
+          break(fnd=nil)
+        end
+        dir = File.dirname(dir)
+      end
+      fnd
+    end
+
+    #
+    def user
+      @email ||= `svn propget svn:author`.strip
+    end
+
+    # TODO: Best solution to SVN email?
+    def email
+      @email ||= ENV['EMAIL']
+    end
+
+    #
+    def repository
+      info['Repository Root']
+    end
+
+    #
+    def uuid
+      info['Repository UUID']
+    end
+
+    #
+    def info
+      @info ||= YAML.load(`svn info`.strip)
+    end
+
+  end
+
+end
+end
+

data/lib/vclog/adapters.rb

@@ -0,0 +1,29 @@
+require 'vclog/adapters/svn'
+require 'vclog/adapters/git'
+require 'vclog/adapters/hg'
+#require 'vclog/vcs/darcs'
+
+module VCLog
+
+  module Adapters
+
+    #
+    def self.factory(root=nil)
+      root = root || Dir.pwd
+      type = read_type(root)
+      raise ArgumentError, "Not a recognized version control system." unless type
+      const_get(type.capitalize).new(root)
+    end
+
+    #
+    def self.read_type(root)
+      dir = nil
+      Dir.chdir(root) do
+        dir = Dir.glob("{.svn,.git,.hg,_darcs}").first
+      end
+      dir[1..-1] if dir
+    end
+
+  end
+
+end

data/lib/vclog/change.rb

@@ -13,12 +13,12 @@ module VCLog
     attr_accessor :type
 
     #
-    def initialize(rev, date, author, message, type=nil)
-      self.revision = rev      #opts[:revison] || opts[:rev]
-      self.date     = date     #opts[:date]    || opts[:when]
-      self.author   = author   #opts[:author]  || opts[:who]
-      self.type     = type     #opts[:type]
-      self.message  = message  #opts[:message] || opts[:msg]
+    def initialize(rev, date, author, message)
+      self.revision = rev
+      self.date     = date
+      self.author   = author
+      self.type     = type
+      self.message  = message
     end
 
     #
@@ -26,8 +26,9 @@ module VCLog
       @author = author.strip
     end
 
+    #
     def message=(note)
-      @message = note.strip
+      @message, @type = split_type(note)
     end
 
     #def clean_type(type)
@@ -89,18 +90,42 @@ module VCLog
     def to_h
       { 'author'   => @author,
         'date'     => @date,
-        'revision' => @revison,
+        'revision' => @revision,
         'message'  => @message,
         'type'     => @type
       }
     end
 
-    def to_json
-      to_h.to_json
-    end
+    #def to_json
+    #  to_h.to_json
+    #end
+
+    #def to_yaml(*args)
+    #  to_h.to_yaml(*args)
+    #end
 
-    def to_yaml(*args)
-      to_h.to_yaml(*args)
+    private
+
+    # 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:".
+    #
+    def split_type(note)
+      note = note.to_s.strip
+      if md = /\[(.*?)\]\Z/.match(note)
+        t = md[1].strip.downcase
+        n = note[0...(md.begin(0))]
+      elsif md = /\A\[(.*?)\]\:?/.match(note)
+        t = md[1].strip.downcase
+        n = note[md.end(0)..-1]
+      elsif md = /\A(\w+?)\:/.match(note)
+        t = md[1].strip.downcase
+        n = note[md.end(0)..-1]
+      else
+        n, t = note, nil
+      end
+      n.gsub!(/^\s*?\n/m,'') # remove blank lines
+      return n, t
     end
 
   end #class Entry

data/lib/vclog/changelog.rb

@@ -55,9 +55,20 @@ module VCLog
       @changes << Change.new(rev, date, who, note, type)
     end
 
-    def each(&block) ; changes.each(&block) ; end
-    def empty? ; changes.empty? ; end
-    def size ; changes.size ; end
+    #
+    def each(&block)
+      changes.each(&block)
+    end
+
+    #
+    def empty?
+      changes.empty?
+    end
+
+    #
+    def size
+      changes.size
+    end
 
     #
     def <<(entry)
@@ -126,6 +137,11 @@ module VCLog
     #  mapped
     #end
 
+    def to_h
+      map{ |change| change.to_h }
+    end
+
+
     # O U T P U T  F O R M A T S
 
     #
@@ -152,6 +168,7 @@ module VCLog
 #      return x.join("\n")
 #    end
 
+=begin
     #
 
     def to_gnu(rev=false)
@@ -173,7 +190,9 @@ module VCLog
       require 'json'
       changes.to_json
     end
+=end
 
+=begin
     #
     alias_method :to_s, :to_gnu
 
@@ -209,6 +228,7 @@ module VCLog
       erb = ERB.new(tmp)
       erb.result(binding)
     end
+=end
 
 =begin
     # Create an XML formated changelog.