vclog 1.8.2 → 1.9.0

data/lib/vclog/adapters/git.rb

@@ -1,162 +1,188 @@
 require 'vclog/adapters/abstract'
 
 module VCLog
-module Adapters
 
-  # The GIT Adapter utilizes the +grit+ gem.
-  #
-  class Git < Abstract
+  module Adapters
 
-    GIT_COMMIT_MARKER = '=====%n'
-    GIT_FIELD_MARKER  = '-----%n'
+    # GIT Adapter.
+    #
+    class Git < Abstract
+
+      GIT_COMMIT_MARKER = '=====%n'
+      GIT_FIELD_MARKER  = '-----%n'
+
+      RUBY_COMMIT_MARKER = "=====\n"
+      RUBY_FIELD_MARKER  = "-----\n"
+
+      # Collect changes, i.e. commits.
+      def extract_changes
+        list = []
+
+        command = 'git log --name-only --pretty=format:"' +
+                    GIT_COMMIT_MARKER +
+                    '%ci' +
+                    GIT_FIELD_MARKER +
+                    '%aN' +
+                    GIT_FIELD_MARKER +
+                    '%H' +
+                    GIT_FIELD_MARKER +
+                    '%s%n%n%b' +
+                    GIT_FIELD_MARKER +
+                    '"'
+
+        changes = `#{command}`.split(RUBY_COMMIT_MARKER)
+
+        changes.shift # throw the first (empty) entry away
+
+        changes.each do |entry|
+          date, who, id, msg, files = entry.split(RUBY_FIELD_MARKER)
+          date  = Time.parse(date)
+          files = files.split("\n")
+          list << Change.new(:id=>id, :date=>date, :who=>who, :msg=>msg, :files=>files)
+        end
+
+        return list
+      end  
+
+      #
+      #def extract_files(change_list)
+      #  change_list.each do |change|
+      #    files = `git show --pretty="format:" --name-only #{c.id}`
+      #    files = files.split("\n")
+      #    change.files = files
+      #  end
+      #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
+      #   ...
+      #
+      # @todo This code is pretty poor, but it suffices for now.
+      #       And we need not worry about it the future b/c eventually
+      #       we will replace it by using the `amp` or `scm` gem.
+      def extract_tags
+        list = []
+        tags = `git tag -l`
+        tags.split(/\s+/).each do |tag|
+          next unless version_tag?(tag) # only version tags
+          who, date, rev, msg = nil, nil, nil, nil
+          info = `git show #{tag}`
+          info, *_ = info.split(/^(commit|diff|----)/)
+          if /\Atag/ =~ info
+            msg = ''
+            info.lines.to_a[1..-1].each do |line|
+              case line
+              when /^Tagger:/
+                who  = $'.strip
+              when /^Date:/
+                date = $'.strip
+              else
+                msg << line
+              end
+            end
+            msg = msg.strip
 
-    RUBY_COMMIT_MARKER = "=====\n"
-    RUBY_FIELD_MARKER  = "-----\n"
+            #info = `git show #{tag}^ --pretty=format:"%ci|~|%H|~|"`
+            #cdate, id, *_ = *info.split('|~|')
 
-    # TODO: in the future we might use grit, if it improves enough.
-    def initialize_framework
-      #require 'grit'
-    end
+            info = git_show("#{tag}^")
 
-    #
-    def grit_repo
-      @grit_repo ||= Grit::Repo.new(root)
-    end
+            change = Change.new(info)
 
-    # Collect changes.
-    #
-    def extract_changes
-      list = []
-      changelog = `git log --pretty=format:"\036|||%ci|~|%aN|~|%H|~|%s"`.strip
-
-      command = 'git log --name-only --pretty=format:"' +
-                  GIT_COMMIT_MARKER +
-                  '%ci' +
-                  GIT_FIELD_MARKER +
-                  '%aN' +
-                  GIT_FIELD_MARKER +
-                  '%H' +
-                  GIT_FIELD_MARKER +
-                  '%s' +
-                  GIT_FIELD_MARKER +
-                  '"'
-
-      changes = `#{command}`.split(RUBY_COMMIT_MARKER)
-      changes.shift # throw the first (empty) entry away
-      changes.each do |entry|
-        date, who, id, msg, files = entry.split(RUBY_FIELD_MARKER)
-        date  = Time.parse(date)
-        files = files.split("\n")
-        list << Change.new(:id=>id, :date=>date, :who=>who, :msg=>msg, :files=>files)
+            list << Tag.new(:name=>tag, :date=>date, :who=>who, :msg=>msg, :commit=>change)
+          else
+            #info = `git show #{tag} --pretty=format:"%cn|~|%ce|~|%ci|~|%H|~|%s|~|"`
+            info   = git_show(tag)
+            change = Change.new(info)
+
+            tag_info = {
+              :name   => tag,
+              :who    => info[:who],
+              :date   => info[:date],
+              :msg    => info[:message],
+              :commit => change
+            }
+            list << Tag.new(tag_info)
+          end          
+
+          #if $DEBUG
+          #  p who, date, rev, msg
+          #  puts
+          #end
+
+          #list << tag
+        end
+
+        return list
       end
-      list
-    end  
 
-    #
-    #def extract_files(change_list)
-    #  change_list.each do |change|
-    #    files = `git show --pretty="format:" --name-only #{c.id}`
-    #    files = files.split("\n")
-    #    change.files = files
-    #  end
-    #end
-
-    # TODO
-    #def extract_changes
-    #  repo.commit.map do |commit|
-    #    [commit.id, commit.date, commit.author.to_s, commit.message]
-    #  end
-    #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
-        who, date, rev, msg = nil, nil, nil, nil
-        info = `git show #{tag}`
-        info, *_ = info.split(/^(commit|diff|----)/)
-        if /\Atag/ =~ info
-          msg = ''
-          info.lines.to_a[1..-1].each do |line|
-            case line
-            when /^Tagger:/
-              who  = $'.strip
-            when /^Date:/
-              date = $'.strip
-            else
-              msg << line
-            end
-          end
-          msg = msg.strip
-          info = `git show #{tag}^ --pretty=format:"%ci|~|%H|~|"`
-          cdate, id, *_ = *info.split('|~|')
-        else
-          info = `git show #{tag} --pretty=format:"%cn|~|%ce|~|%ci|~|%H|~|%s|~|"`
-          who, email, cdate, id, msg, *_ = *info.split('|~|')
-          who  = who + ' ' + email
-          date = cdate
-        end          
-
-        #if $DEBUG
-        #  p who, date, rev, msg
-        #  puts
-        #end
-
-        list << Tag.new(:name=>tag, :date=>date, :who=>who, :msg=>msg, :commit_id=>id, :commit_date=>cdate)
+      # User name of developer.
+      def user
+        @user ||= `git config user.name`.strip
       end
-      list
-    end
 
-    # TODO: grit doesn't provide the tag information.
-    #def extract_tags
-    #  list = grit_repo.tags.map do |tag|
-    #    [tag.name, tag.commit.id, tag.commit.committed_date, tag.commit.author.to_s, tag.commit.message]
-    #  end
-    #  list
-    #end
+      # Email address of developer.
+      def email
+        @email ||= `git config user.email`.strip
+      end
 
-    #
-    def user
-      #@user ||= grit_repo.config['user.name']
-      @user ||= `git config user.name`.strip
-    end
+      #
+      def repository
+        @repository ||= `git config remote.origin.url`.strip
+      end
 
-    #
-    def email
-      #@email ||= grit_repo.config['user.email']
-      @email ||= `git config user.email`.strip
-    end
+      #
+      # Create a tag for the given commit reference.
+      #
+      def tag(ref, label, date, message)
+        file = tempfile("message", message)
+        date = date.strftime('%Y-%m-%d 23:59') unless String===date
 
-    #
-    def repository
-      #@repository ||= grit_repo.config['remote.origin.url']
-      @repository ||= `git config remote.origin.url`.strip
-    end
+        cmd = %[GIT_AUTHOR_DATE='#{date}' GIT_COMMITTER_DATE='#{date}' git tag -a -F '#{file}' #{label} #{ref}]
+        puts cmd if $DEBUG
+        `#{cmd}` unless $DRYRUN
+      end
+
+    private
+
+      #
+      #
+      #
+      def git_show(ref)
+        command = 'git show ' + ref.to_s + ' --name-only --pretty=format:"' +
+                    '%ci' +
+                    GIT_FIELD_MARKER +
+                    '%cn' +
+                    GIT_FIELD_MARKER +
+                    '%ce' +
+                    GIT_FIELD_MARKER +
+                    '%H' +
+                    GIT_FIELD_MARKER +
+                    '%s%n%n%b' +
+                    GIT_FIELD_MARKER +
+                    '"'
+
+        entry = `#{command}`
+
+        date, who, email, id, msg, files = entry.split(RUBY_FIELD_MARKER)
+
+        who = who + ' ' + email
+        date  = Time.parse(date)
+        files = files.split("\n")
 
-    # Create a tag for the given commit reference.
-    def tag(ref, label, date, message)
-      file = tempfile("message", message)
-      date = date.strftime('%Y-%m-%d 23:59') unless String===date
+        return { :date=>date, :who=>who, :id=>id, :message=>msg, :files=>files }
+      end
 
-      cmd = %[GIT_AUTHOR_DATE='#{date}' GIT_COMMITTER_DATE='#{date}' git tag -a -F '#{file}' #{label} #{ref}]
-      puts cmd if $DEBUG
-      `#{cmd}` unless $DRYRUN
     end
 
-  end#class Git
+  end
 
 end
-end

data/lib/vclog/adapters/hg.rb

@@ -1,93 +1,129 @@
 require 'vclog/adapters/abstract'
 
 module VCLog
-module Adapters
-
-  # = Mercurial Adapter
-  #
-  # TODO: maybe use Amp gem for future version.
-  class Hg < Abstract
-
-    # Collect changes.
-    def extract_changes
-      list = []
-      changelog = `hg log -v`.strip
-      changes = changelog.split("\n\n\n")
-      changes.each do |entry|
-        id, date, who, msg = *parse_entry(entry)
-        list << Change.new(:id=>id, :date=>date, :who=>who, :msg=>msg)
+
+  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|
+          settings = parse_entry(entry)
+          list << Change.new(settings)
+        end
+        list
       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.new(:name=>tag, :id=>rev, :date=>date, :who=>who, :msg=>msg)
+      #
+      # Collect tags.
+      #
+      # @todo Extract first commit prior to tag and provide it with Tag object.
+      #
+      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
+            settings = parse_entry(entry)
+            settings[:name] = tag
+            list << Tag.new(settings)
+          end
         end
+        list
       end
-      list
-    end
 
-    # TODO: check .hgrc
-    def user
-      ENV['HGUSER'] || ENV['USER']
-    end
+      #
+      # Username.
+      #
+      # @todo check .hgrc for user.
+      #
+      def user
+        ENV['HGUSER'] || ENV['USER']
+      end
 
-    #
-    def email
-      ENV['HGEMAIL'] || ENV['EMAIL']
-    end
+      #
+      # User's email address.
+      #
+      # @todo check .hgrc for email.
+      #
+      def email
+        ENV['HGEMAIL'] || ENV['EMAIL']
+      end
 
-    #
-    def repository
-      @repository ||= `hg showconfig paths.default`.strip
-    end
+      #
+      # URI of repository.
+      #
+      def uri
+        @uri ||= `hg showconfig paths.default`.strip
+      end
 
-    #
-    def uuid
-      nil
-    end
+      # @deprecated
+      alias_method :repository, :uri
+
+      #
+      #
+      #
+      def uuid
+        nil
+      end
 
-    # TODO: Will multi-line messages work okay this way?
-    def tag(ref, label, date, msg)
-      file = tempfile("message", msg)
-      date = date.strftime('%Y-%m-%d') unless String===date
+      #
+      # TODO: Will multi-line messages work okay this way?
+      #
+      def tag(ref, label, date, msg)
+        file = tempfile("message", msg)
+        date = date.strftime('%Y-%m-%d') unless String===date
 
-      cmd  = %[hg tag -r #{ref} -d #{date} -m "$(cat #{file})" #{label}]
+        cmd  = %[hg tag -r #{ref} -d #{date} -m "$(cat #{file})" #{label}]
 
-      puts cmd if $DEBUG
-      `#{cmd}` unless $DRYRUN
-    end
+        puts cmd if $DEBUG
+        `#{cmd}` unless $DRYRUN
+      end
 
-    private
+     private
 
+      #
+      # Parse log entry.
+      #
       def parse_entry(entry)
-        rev, date, who, msg = nil, nil, nil, nil
+        settings = {}
+
         entry.strip!
+
         if md = /^changeset:(.*?)$/.match(entry)
-          rev = md[1].strip
+          settings[:id] = md[1].strip
         end
+
         if md = /^date:(.*?)$/.match(entry)
-          date = md[1].strip
+          settings[:date] = Time.parse(md[1].strip)
         end
+
         if md = /^user:(.*?)$/.match(entry)
-          who = md[1].strip
+          settings[:who] = md[1].strip
+        end
+
+        if md = /^files:(.*?)$/.match(entry)
+          settings[:files] = md[1].strip.split(' ')
         end
+
         if md = /^description:(.*?)\Z/m.match(entry)
-          msg = md[1].strip
+          settings[:msg] = md[1].strip
         end
-        date = Time.parse(date)
-        #msg, type = *split_type(msg)
-        return rev, date, who, msg
+
+        return settings
       end
 
+    end
+
   end
 
 end
-end