vclog 1.5.0 → 1.6.0

data/lib/vclog/heuristics.rb

@@ -1,13 +1,91 @@
 module VCLog
 
-  # TODO: Develop heuristics for determining the nature
-  # of changes from the commit messages. Ultimately allow
-  # user to customize heuristics per project.
-  module Heuristics
-
-    def explicit_tag(message)
-      md = /^(\w+)\:/.match(message)
-      md ? {:tag => md[1]} : {}
+  #
+  class Heuristics
+
+    # Load heuristics from a configruation file.
+    #
+    # config - the configuration directory
+    #
+    def self.load(file)
+      if file
+        raise LoadError unless File.exist?(file)
+      else
+        file = File.dirname(__FILE__) + '/heuristics/default.rb'
+      end
+
+      h = new
+      h.instance_eval(File.read(file), file)
+      h
+    end
+
+    #
+    def initialize
+      @rules  = []
+      @labels = {}
+    end
+
+    #
+    def lookup(message)
+      type = nil
+      @rules.find{ |rule| type = rule.call(message) }
+      if type
+        type = type.to_sym
+        if @labels.key?(type)
+           @labels[type].to_a
+        else
+          [type, 0, "#{type.to_s.capitalize} Enhancements"]
+        end
+      else
+        [nil, 0, 'General Enhancements']
+      end
+    end
+
+    #
+    def on(pattern, &block)
+      @rules << Rule.new(pattern, &block)
+    end
+
+    #
+    def set(type, level, label)
+      @labels[type.to_sym] = Label.new(type, level, label)
+    end
+
+    #
+    class Label
+      #
+      def initialize(type, level, label)
+        @type  = type
+        @level = level.to_i
+        @label = label.to_s
+      end
+
+      attr :type
+
+      attr :level
+
+      attr :label
+
+      #
+      def to_a
+        [type, level, label]
+      end
+    end
+
+    #
+    class Rule
+      def initialize(pattern, &block)
+        @pattern = pattern
+        @block   = block        
+      end
+
+      def call(message)
+        if md = @pattern.match(message)
+          @block.call(*md[1..-1])
+        else
+          nil
+        end
+      end
     end
 
   end

data/lib/vclog/history.rb

@@ -15,13 +15,8 @@ module VCLog
   # The release version, date and release note can be
   # descerened from the underlying SCM by identifying
   # the hard tag commits.
-  # 
-  # But we can also extract the release information from a
-  # release history file, if provided. And it's release
-  # information should take precidence. ???
   #
-  #
-  # TODO: Extract output formating from delta parser.
+  # TODO: Extract output formating from delta parser. Later---Huh?
   #
   class History
 
@@ -40,11 +35,15 @@ module VCLog
     attr_accessor :extra
 
     #
-    def initialize(vcs, opts={})
+    def initialize(vcs)
       @vcs     = vcs
-      @title   = opts[:title] || "RELEASE HISTORY"
-      @extra   = opts[:extra]
-      @version = opts[:version]
+
+      #opts = OpenStruct.new(opts) if Hash === opts
+
+      #@title   = opts.title || "RELEASE HISTORY"
+      #@extra   = opts.extra
+      #@version = opts.version
+      #@level =  opts.level || 0
     end
 
     # Tag list from version control system.
@@ -52,31 +51,28 @@ module VCLog
       @tags ||= vcs.tags
     end
 
-    # Change list from version control system.
-
-    def changes
-      @changes ||= vcs.changes
-    end
-
     # Changelog object
-
     def changelog
       @changlog ||= vcs.changelog #ChangeLog.new(changes)
     end
 
-    #
+    # Change list from version control system filter for level setting.
+    def changes
+      @changes ||= vcs.changes
+    end
 
+    #
     def releases
       @releases ||= (
         rel = []
 
         tags = self.tags
 
-        ver  = vcs.bump(version)
+        #ver  = vcs.bump(version)
         user = vcs.user
         time = ::Time.now
 
-        tags << Tag.new(ver, 'current', time, user, "Current Development")
+        tags << Tag.new(nil, 'current', time, user, "Current Development")
 
         # TODO: Do we need to add a Time.now tag?
         # add current verion to release list (if given)
@@ -88,21 +84,20 @@ module VCLog
         #rels = rels.uniq      # only uniq releases
 
         # sort by release date
-        #tags = tags.sort{ |a,b| b.name <=> a.name }
-        tags = tags.sort{ |a,b| b.date <=> a.date }
+        tags = tags.sort{ |a,b| a.date <=> b.date }
 
         # organize into deltas
-        delta = {}
+        delta = []
         last  = nil
-        tags.sort.each do |tag|
-          delta[tag] = [last, tag.date]
+        tags.each do |tag|
+          delta << [tag, [last, tag.date]]
           last = tag.date
         end
 
-        # gather changes for each delta and build log
-        delta.each do |tag, (ended, started)|
-          if ended
-            set = changes.select{ |c| c.date < ended && c.date > started }
+        # gather changes for each delta
+        delta.each do |tag, (started, ended)|
+          if started
+            set = changes.select{ |c| c.date >= started && c.date < ended  }
             #gt_vers, gt_date = gt.name, gt.date
             #lt_vers, lt_date = lt.name, lt.date
             #gt_date = Time.parse(gt_date) unless Time===gt_date
@@ -112,7 +107,7 @@ module VCLog
             #lt_vers, lt_date = lt.name, lt.date
             #lt_date = Time.parse(lt_date) unless Time===lt_date
             #log = changelog.before(lt_date)
-            set = changes.select{ |c| c.date > started }
+            set = changes.select{ |c| c.date < ended }
           end
 
           rel << Release.new(tag, set)
@@ -122,9 +117,8 @@ module VCLog
     end
 
     # Group +changes+ by tag type.
-
     def groups(changes)
-      @groups ||= changes.group_by{ |e| e.type_number }
+      @groups ||= changes.group_by{ |e| e.type }
     end
 
     #
@@ -132,165 +126,6 @@ module VCLog
       releases.map{ |rel| rel.to_h }
     end
 
-
-
-    # Same as to_gnu.
-
-    #def to_s(rev=false)
-    #  to_gnu(rev)
-    #end
-
-=begin
-    # TODO: What would GNU history look like?
-
-    def to_gnu(rev=false)
-      to_markdown(rev)
-    end
-
-    # Translate history into a YAML document.
-
-    def to_yaml(*args)
-      require 'yaml'
-      releases.to_yaml(*args)
-    end
-
-    # Translate history into a JSON document.
-
-    def to_json
-      require 'json'
-      releases.to_json
-    end
-=end
-
-=begin
-    # Translate history into a XML document.
-
-    def to_xml(xsl=nil)
-      tmp = File.read(File.join(DIR, 'templates', 'history.xml'))
-      erb = ERB.new(tmp)
-      erb.result(binding)
-    end
-
-    # Translate history into a HTML document.
-
-    def to_html(css=nil)
-      tmp = File.read(File.join(DIR, 'templates', 'history.html'))
-      erb = ERB.new(tmp)
-      erb.result(binding)
-    end
-
-    # Translate history into a RDoc document.
-
-    def to_rdoc(rev=false)
-      tmp = File.read(File.join(DIR, 'templates', 'history.rdoc'))
-      erb = ERB.new(tmp)
-      erb.result(binding)
-    end
-
-    # Translate history into a Markdown formatted document.
-
-    def to_markdown(rev=false)
-      tmp = File.read(File.join(DIR, 'templates', 'history.markdown'))
-      erb = ERB.new(tmp)
-      erb.result(binding)
-    end
-=end
-
-=begin
-    #
-    def to_markup(marker, rev=false)
-      entries = []
-      releases.each do |release|
-        tag     = release.tag
-        changes = release.changes
-        change_text = to_markup_changes(changes, rev)
-        unless change_text.strip.empty?
-          if extra
-            entries << "#{marker*2} #{tag.name} / #{tag.date.strftime('%Y-%m-%d')}\n\n#{tag.message}\n\nChanges:\n\n#{change_text}"
-          else
-            entries << "#{marker*2} #{tag.name} / #{tag.date.strftime('%Y-%m-%d')}\n\n#{change_text}"
-          end
-        end
-      end
-      # reverse entries order and make into document
-      marker + " #{title}\n\n" +  entries.reverse.join("\n")
-    end
-=end
-
-  private
-
-=begin
-    #
-    def to_markup_changes(changes, rev=false)
-      groups = changes.group_by{ |e| e.type_number }
-      string = ""
-      groups.keys.sort.each do |n|
-        entries = groups[n]
-        next if !entries
-        next if entries.empty?
-        string << "* #{entries.size} #{entries[0].type_phrase}\n\n"
-        entries.sort!{|a,b| a.date <=> b.date }
-        entries.each do |entry|
-          #string << "== #{date}  #{who}\n\n"  # no email :(
-          if rev
-            text = "#{entry.message} (##{entry.revision})"
-          else
-            text = "#{entry.message}"
-          end
-          text = text.tabto(6)
-          text[4] = '*'
-          #entry = entry.join(' ').tabto(6)
-          #entry[4] = '*'
-          string << text
-          string << "\n"
-        end
-        string << "\n"
-      end
-      string
-    end
-=end
-
-
-=begin
-    # Extract release tags from a release file.
-    #
-    # TODO: need to extract message (?)
-    #
-    def releases_from_file(file)
-      return [] unless file
-      clog = File.read(file)
-      tags = clog.scan(/^(==|##)(.*?)$/)
-      rels = tags.collect do |t|
-        parse_version_tag(t[1])
-      end
-      @marker = tags[0][0]
-      return rels
-    end
-
-    #
-    def parse_version_tag(tag)
-      version, date = *tag.split('/')
-      version, date = version.strip, date.strip
-      return version, date
-    end
-=end
-
-=begin
-  private
-
-    #
-    def h(input)
-       result = input.to_s.dup
-       result.gsub!("&", "&amp;")
-       result.gsub!("<", "&lt;")
-       result.gsub!(">", "&gt;")
-       result.gsub!("'", "&apos;")
-       #result.gsub!("@", "&at;")
-       result.gsub!("\"", "&quot;")
-       return result
-    end
-=end
-
   end
 
 end

data/lib/vclog/kernel.rb

@@ -0,0 +1,12 @@
+module VCLog
+
+  module Kernel
+
+    #
+    def heuristics
+      @heuristics ||= Heuristics.new()
+    end
+
+  end
+
+end

data/lib/vclog/metadata.rb

@@ -1,5 +1,6 @@
 module VCLog
 
+  #
   class Metadata
 
     def initialize

data/lib/vclog/release.rb

@@ -1,15 +1,39 @@
 module VCLog
 
-  #
+  # A Release encapsulate a collection of 
+  # Change objects associated to a Tag.
   class Release
+
+    # Tag object this release represents.
     attr :tag
+
+    # Array of Change objects.
     attr :changes
+
+    # New Release object.
+    #
+    # tag    - Tag object
+    # change - Array of Change objects
     #
     def initialize(tag, changes)
       @tag = tag
       @changes = changes
     end
 
+    # Group +changes+ by type and sort by level.
+    # Returns an associative array of [type, changes].
+    def groups
+      @groups ||= (
+        changes.group_by{ |e| e.type }.sort{ |a,b| b[1][0].level <=> a[1][0].level }
+      )
+    end
+
+    # Compare release by tag.
+    def <=>(other)
+      @tag <=> other.tag
+    end
+
+    # Convert Release to Hash.
     def to_h
       { 'version'  => tag.name,
         'date'     => tag.date,
@@ -20,18 +44,9 @@ module VCLog
       }
     end
 
-    # Group +changes+ by tag type.
-    def groups
-      @groups ||= changes.group_by{ |e| e.type_number }
-    end
-
     #def to_json
     #  to_h.to_json
     #end
-
-    def <=>(other)
-      @tag <=> other.tag
-    end
   end
 
 end

data/lib/vclog/tag.rb

@@ -7,6 +7,7 @@ module VCLog
     attr_accessor :author
     attr_accessor :message
 
+    #
     def initialize(name, rev, date, author, message)
       self.revision = rev
       self.name     = name
@@ -15,15 +16,20 @@ module VCLog
       self.message  = message
     end
 
+    #
     def name=(name)
-      @name = name.strip
+      @name = (name || 'HEAD').strip
     end
+
+    #
     alias_method :label, :name
 
+    #
     def author=(author)
       @author = author.strip
     end
 
+    #
     def date=(date)
       case date
       when Time
@@ -33,6 +39,7 @@ module VCLog
       end
     end
 
+    #
     def message=(msg)
       @message = msg.strip
     end
@@ -40,15 +47,17 @@ module VCLog
     alias_method :tagger, :author
     alias_method :tagger=, :author=
 
+    #
     def to_json
       to_h.to_json
     end
 
+    #
     def to_h
       {
-        'name' => name,
-        'date' => date,
-        'author' => author,
+        'name'    => name,
+        'date'    => date,
+        'author'  => author,
         'message' => message
       }
     end
@@ -60,6 +69,7 @@ module VCLog
 
     # Normal tag order is the reverse typical sorts.
     def <=>(other)
+      return -1 if name == 'HEAD'
       other.name <=> name
     end
   end

data/lib/vclog/templates/changelog.ansi.rb

@@ -0,0 +1,52 @@
+require 'ansi'
+
+out = []
+
+out << "#{title}\n".ansi(:bold) if title
+
+changelog.by_date.each do |date, date_changes|
+
+  date_changes.by_author.each do |author, author_changes|
+
+    out << "#{ date }  #{ author }\n".ansi(:bold)
+
+    author_changes.sort!{|a,b| b.level <=> a.level}
+
+    author_changes.each do |entry|
+
+      line = "#{entry.message.strip}"
+
+      if options.extra && entry.type
+        line << " <#{ entry.type }>"
+      end
+
+      if options.revision
+        line << " (##{entry.revision})"
+      end
+
+      case entry.level
+      when 1
+        line = line.ansi(:yellow)
+      when 0
+        line = line.ansi(:green)
+      when -1
+        line = line.ansi(:cyan)
+      else
+        if entry.level > 1
+          line = line.ansi(:red) 
+        else
+          line = line.ansi(:blue)
+        end
+      end
+
+      out << "  * " + line
+
+    end
+
+    out << ""
+
+  end
+
+end
+
+out.join("\n") + "\n"

data/lib/vclog/templates/changelog.gnu.rb

@@ -0,0 +1,31 @@
+out = []
+
+out << "#{title}\n" if title
+
+changelog.by_date.each do |date, date_changes|
+
+  date_changes.by_author.each do |author, author_changes|
+
+    out << "#{ date }  #{ author }\n"
+
+    author_changes.each do |entry|
+
+      out << "        * #{entry.message.strip}"
+ 
+      if options.extra && entry.type
+        out.last << " <#{ entry.type }>"
+      end
+
+      if options.revision
+        out.last << "(##{entry.revision})"
+      end
+
+    end
+
+    out << ""
+
+  end
+
+end
+
+out.join("\n") + "\n"

data/lib/vclog/templates/changelog.json.rb

@@ -0,0 +1 @@
+changelog.to_h.to_json

data/lib/vclog/templates/changelog.markdown.rb

@@ -0,0 +1,30 @@
+out = []
+
+out << "# #{title}"
+
+changelog.by_date.each do |date, date_changes|
+
+  date_changes.by_author.each do |author, author_changes|
+
+    out << "\n## #{date} #{author}\n"
+
+    author_changes.each do |entry|
+
+      out << "* #{entry.message.strip}"
+
+      if entry.type
+        out.last << " [#{entry.type}]"
+      end
+
+      if options.revision
+        out.last << " (##{entry.revision})"
+      end
+
+    end
+
+  end
+
+end
+
+out.join("\n") + "\n\n"
+

data/lib/vclog/templates/changelog.rdoc.rb

@@ -0,0 +1,30 @@
+out = []
+
+out << "= #{title}"
+
+changelog.by_date.each do |date, date_changes|
+
+  date_changes.by_author.each do |author, author_changes|
+
+    out << "\n== #{date} #{author}\n"
+
+    author_changes.each do |entry|
+
+      out << "* #{entry.message.strip}"
+
+      if entry.type
+        out.last << " [#{entry.type}]"
+      end
+
+      if options.revision
+        out.last << " (##{entry.revision})"
+      end
+
+    end
+
+  end
+
+end
+
+out.join("\n") + "\n\n"
+

data/lib/vclog/templates/changelog.yaml.rb

@@ -0,0 +1 @@
+changelog.to_h.to_yaml