vclog 1.8.2 → 1.9.0

data/lib/vclog/adapters/svn.rb

@@ -1,152 +1,155 @@
 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
-        raise LoadError, "VCLog requires xml-simple for SVN support."
-      end
-      super(root)
-    end
 
-    # Extract changes.
-    def extract_changes
-      log = []
+  module Adapters
+
+    # SVN Adapter.
+    #
+    # 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 two hits 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
 
-      xml = `svn log --xml`.strip
+      def initialize(root)
+        begin
+          require 'xmlsimple'
+        rescue LoadError
+          raise LoadError, "VCLog requires xml-simple for SVN support."
+        end
+        super(root)
+      end
 
-      commits = XmlSimple.xml_in(xml, {'KeyAttr' => 'rev'})
-      commits = commits['logentry']
+      # Extract changes.
+      def extract_changes
+        log = []
 
-      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
+        xml = `svn log -v --xml`.strip
 
-        next if msg.empty?
-        next if msg == "*** empty log message ***"
+        commits = XmlSimple.xml_in(xml, {'KeyAttr' => 'rev'})
+        commits = commits['logentry']
 
-        date = Time.parse(date)
+        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
 
-        log << Change.new(:id=>rev, :date=>date, :who=>who, :msg=>msg)
-      end
+          files = com['paths'].map{ |h| h['path'].map{ |y| y['content'] } }.flatten
 
-      log
-    end
+          next if msg.empty?
+          next if msg == "*** empty log message ***"
 
-    # Extract tags.
-    def extract_tags
-      list = []
-      tagdir = tag_directory
+          date = Time.parse(date)
 
-      if tagdir
-        tags = Dir.entries(tagdir).select{ |e| e.index('.') != 0 && e =~ /\d(.*)$/ }
-      else
-        tags = []
+          log << Change.new(:id=>rev, :date=>date, :who=>who, :msg=>msg, :files=>files)
+        end
+
+        log
       end
 
-      tags.each do |path|
-        dir = File.join(tagdir, path)
+      # Extract tags.
+      def extract_tags
+        list = []
+        tagdir = tag_directory
 
-        # 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']
+        if tagdir
+          tags = Dir.entries(tagdir).select{ |e| e.index('.') != 0 && e =~ /\d(.*)$/ }
+        else
+          tags = []
+        end
 
-        # get last commit
-        xml = `svn log -l1 --xml #{dir}`
-        commits = XmlSimple.xml_in(xml, {'KeyAttr' => 'rev'})
-        commit = commits['logentry'].first
+        tags.each do |path|
+          dir = File.join(tagdir, path)
 
-        msg  = [commit["msg"]].flatten.compact.join('').strip
-        date = [commit["date"]].flatten.compact.join('').strip
+          # 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']
 
-        list << Tag.new(:name=>name, :id=>rev, :date=>date, :who=>who, :msg=>msg)
+          # 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 << Tag.new(:name=>name, :id=>rev, :date=>date, :who=>who, :msg=>msg)
+        end
+        list
       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'))
+      # 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
-            entries = entries.reject{ |e| e.index('.') == 0 }
-            entries = entries.reject{ |e| e !~ /\d$/ }
-            break(fnd = dir) unless entries.empty?
+            break(fnd=nil)
           end
-        else
-          break(fnd=nil)
+          dir = File.dirname(dir)
         end
-        dir = File.dirname(dir)
+        fnd
       end
-      fnd
-    end
 
-    #
-    def user
-      @email ||= `svn propget svn:author`.strip
-    end
+      #
+      def user
+        @email ||= `svn propget svn:author`.strip
+      end
 
-    # TODO: Best solution to SVN email?
-    def email
-      @email ||= ENV['EMAIL']
-    end
+      # TODO: Best solution to SVN email?
+      def email
+        @email ||= ENV['EMAIL']
+      end
 
-    #
-    def repository
-      info['Repository Root']
-    end
+      #
+      def repository
+        info['Repository Root']
+      end
 
-    #
-    def uuid
-      info['Repository UUID']
-    end
+      #
+      def uuid
+        info['Repository UUID']
+      end
 
-    # TODO: Need to effect svn tag date. How?
-    def tag(ref, label, date, message)
-      file = tempfile("message", message)
+      # TODO: Need to effect svn tag date. How?
+      def tag(ref, label, date, message)
+        file = tempfile("message", message)
 
-      Dir.chdir(root) do
-        cmd = %[svn copy -r #{ref} -F "#{mfile.path}" . #{tag_directory}/#{label}]
-        puts cmd if $DEBUG
-        `#{cmd}` unless $DRYRUN
+        Dir.chdir(root) do
+          cmd = %[svn copy -r #{ref} -F "#{mfile.path}" . #{tag_directory}/#{label}]
+          puts cmd if $DEBUG
+          `#{cmd}` unless $DRYRUN
+        end
       end
-    end
 
-    private
+      private
+
+      #
+      def info
+        @info ||= YAML.load(`svn info`.strip)
+      end
 
-    #
-    def info
-      @info ||= YAML.load(`svn info`.strip)
     end
 
   end
 
 end
-end
-

data/lib/vclog/change.rb

@@ -1,4 +1,4 @@
-require 'vclog/kernel'
+require 'vclog/change_point'
 
 module VCLog
 
@@ -8,7 +8,7 @@ module VCLog
 
     include Comparable
 
-    # Commit reference id.
+    # Commit revision/reference id.
     attr_accessor :id
 
     # Date/time of commit.
@@ -23,45 +23,92 @@ module VCLog
     # List of files changed in the commit.
     attr_accessor :files
 
+    # Type of change, as assigned by hueristics.
     attr_accessor :type
+
+    # The priority level of this change, as assigned by hueristics.
+    # This can be `nil`, as Heuristics will always make sure a
+    # commit has an inteer level before going out to template.
     attr_accessor :level
+
+    # The descriptive label of this change, as assigned by hueristics.
     attr_accessor :label
 
-    #
+    # ANSI color to apply. Actually this can be a list
+    # of any support ansi gem terms, but usually it's 
+    # just the color term, such as `:red`.
+    attr_accessor :color
+
+    # Setup new Change instance.
     def initialize(data={})
+      @type  = :default
+      @level = nil
+      @label = nil
+      @color = []
+
       data.each do |k,v|
-        __send__("#{k}=", v)
+        __send__("#{k}=", v) if respond_to?("#{k}=")
       end
     end
 
+    #
+    # Set authors attributes, ensuring the value is stripped of white space.
     #
     def author=(author)
       @author = author.strip
     end
 
+    #
+    # Set date attribute, converting vale given to an instance of Time.
     #
     def date=(date)
       @date = parse_date(date)
     end
 
-    # Alternate name for id.
-    alias_method :ref,  :id
-    alias_method :ref=, :id=
-    alias_method :reference,  :id
-    alias_method :reference=, :id=
+    #
+    # Set the commit message.
+    #
+    def message=(msg)
+      @message = msg
+
+      lines = msg.lines.to_a
+      @summary = lines.first.strip
+      @details = lines[1..-1].join('').strip
+
+      msg
+    end
+
+    #
+    # Set the ANSI color terms.
+    #
+    # @param [Symbol,Array<Symbol>] code
+    #   An ANSI gem recognized term, or array of such.
+    #
+    def color=(code)
+      @color = [code].flatten
+    end
 
-    # Alternate name for id.
     #
-    # @deprecated
+    def type=(type)
+      @type = type.to_sym
+    end
+
+    # Alternate name for id.
     alias_method :rev,  :id
     alias_method :rev=, :id=
 
     # Alternate name for id.
-    #
-    # @deprecated
     alias_method :revision,  :id
     alias_method :revision=, :id=
 
+    # Alternate name for id.
+    alias_method :ref,  :id
+    alias_method :ref=, :id=
+
+    # Alternate name for id.
+    alias_method :reference,  :id
+    alias_method :reference=, :id=
+
     # Alternate name for message.
     alias_method :msg,  :message
     alias_method :msg=, :message=
@@ -70,100 +117,70 @@ module VCLog
     alias_method :who,  :author
     alias_method :who=, :author=
 
+    attr_reader :summary
 
-    #def clean_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
+    attr_reader :details
 
+    #
+    # Compare changes by date.
     #
     def <=>(other)
       other.date <=> date
     end
 
+    #
+    # Inspection string of change object.
+    #
     def inspect
       "#<Change:#{object_id} #{date}>"
     end
 
-    # TODO: Rename revision to `referece` or `ref`.
-
+    #
+    # Convert to Hash.
     #
     def to_h
-      { 'author'   => @author,
-        'date'     => @date,
-        'revision' => @revision,
-        'message'  => @message,
-        'type'     => @type
+      { 'author'   => self.author,
+        'date'     => self.date,
+        'id'       => self.id,
+        'message'  => self.message,
+        'type'     => self.type
       }
     end
 
-    #def to_json
-    #  to_h.to_json
-    #end
-
-    #def to_yaml(*args)
-    #  to_h.to_yaml(*args)
-    #end
-
+    #
+    # Apply heuristic rules to change.
+    #
     def apply_heuristics(heuristics)
-      type, level, label, msg = *heuristics.lookup(message)
-
-      self.type    = type
-      self.level   = level
-      self.label   = label
-      self.message = msg || @message
+      heuristics.apply(self)
     end
 
-=begin
-    #
-    def type_phrase
-      case type.to_s
-      when 'maj', 'major'
-        'Major Enhancements'
-      when 'min', 'minor'
-        'Minor Enhancements'
-      when 'bug'
-        'Bug Fixes'
-      when ''
-        'General Enhancements'
-      when '-'
-        'Administrative Changes'
-      else
-        "#{type.to_s.capitalize} Enhancements"
-      end
+    #
+    # Parse point entries from commit message. Point entries
+    # are outlined changes via line that start with an asterisk.
+    #
+    def points
+      @points ||= parse_points
     end
 
-    # 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]
+    #
+    # Output message with optional adjustments.
+    #
+    def to_s(opts={})
+      if opts[:summary]
+        summary
       else
-        n, t = note, nil
+        message.strip
       end
-      n.gsub!(/^\s*?\n/m,'') # remove blank lines
-      return n, t
     end
-=end
 
-    private
+   private
 
+    #
+    # Convert given +date+ into Time instance.
+    #
+    # @param [String,Data,Time] date
+    #   A valid data/time string or object.
+    #
     def parse_date(date)
       case date
       when Time
@@ -173,6 +190,18 @@ module VCLog
       end
     end
 
+    #
+    # Split message into individual points.
+    #
+    # @todo Improve the parsing of point messages.
+    #
+    def parse_points
+      point_messages = message.split(/^\*/)
+      point_messages.map do |msg|
+        ChangePoint.new(self, msg)
+      end
+    end
+
   end
 
 end