vclog 1.8.1 → 1.8.2

data/lib/vclog.rb

@@ -1,5 +1,5 @@
 module VCLog
-  require 'vclog/meta/data'
+  require 'vclog/metadata'
   require 'vclog/repo'
 end
 

data/lib/vclog/adapters/abstract.rb

@@ -247,25 +247,6 @@ module Adapters
     end
 =end
 
-    # Find vclog config directory. This searches up from the current
-    # working directory for the following paths (in order):
-    #
-    #   .vclog/
-    #   .config/vclog/
-    #    config/vclog/
-    #
-    def lookup_config
-      conf = nil
-      Dir.ascend(Dir.pwd) do |path|
-        check = Dir['{.vclog/,.config/vclog/,config/vclog/}/'].first
-        if check
-          conf = path 
-          break
-        end
-      end
-      conf
-    end
-
   public
 
     #

data/lib/vclog/adapters/git.rb

@@ -7,6 +7,12 @@ module Adapters
   #
   class Git < Abstract
 
+    GIT_COMMIT_MARKER = '=====%n'
+    GIT_FIELD_MARKER  = '-----%n'
+
+    RUBY_COMMIT_MARKER = "=====\n"
+    RUBY_FIELD_MARKER  = "-----\n"
+
     # TODO: in the future we might use grit, if it improves enough.
     def initialize_framework
       #require 'grit'
@@ -22,16 +28,38 @@ module Adapters
     def extract_changes
       list = []
       changelog = `git log --pretty=format:"\036|||%ci|~|%aN|~|%H|~|%s"`.strip
-      changes = changelog.split("\036|||")
-      #changes = changelog.split(/^commit/m)
+
+      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 = entry.split('|~|')
-        date = Time.parse(date)
-        list << Change.new(:id=>id, :date=>date, :who=>who, :msg=>msg)
+        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
       list
-    end
+    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

data/lib/vclog/adapters/svn.rb

@@ -16,7 +16,7 @@ module Adapters
       begin
         require 'xmlsimple'
       rescue LoadError
-        "VCLog requires xmlsimple for SVN support"
+        raise LoadError, "VCLog requires xml-simple for SVN support."
       end
       super(root)
     end

data/lib/vclog/change.rb

@@ -2,23 +2,33 @@ require 'vclog/kernel'
 
 module VCLog
 
-  # The Change class models an extry in a change log.
+  # The Change class models an entry in a change log.
   #
   class Change
 
     include Comparable
 
+    # Commit reference id.
     attr_accessor :id
+
+    # Date/time of commit.
     attr_accessor :date
+
+    # Committer.
     attr_accessor :author
+
+    # Commit message.
     attr_accessor :message
 
+    # List of files changed in the commit.
+    attr_accessor :files
+
     attr_accessor :type
     attr_accessor :level
     attr_accessor :label
 
     #
-    def initialize(data={}) #rev, date, author, message, type, level, label
+    def initialize(data={})
       data.each do |k,v|
         __send__("#{k}=", v)
       end
@@ -35,10 +45,20 @@ module VCLog
     end
 
     # Alternate name for id.
+    alias_method :ref,  :id
+    alias_method :ref=, :id=
+    alias_method :reference,  :id
+    alias_method :reference=, :id=
+
+    # Alternate name for id.
+    #
+    # @deprecated
     alias_method :rev,  :id
     alias_method :rev=, :id=
 
     # Alternate name for id.
+    #
+    # @deprecated
     alias_method :revision,  :id
     alias_method :revision=, :id=
 
@@ -46,7 +66,6 @@ module VCLog
     alias_method :msg,  :message
     alias_method :msg=, :message=
 
-
     # Alias for author.
     alias_method :who,  :author
     alias_method :who=, :author=
@@ -63,26 +82,6 @@ module VCLog
     #  end
     #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
-    end
-=end
-
     #
     def <=>(other)
       other.date <=> date
@@ -92,6 +91,9 @@ module VCLog
       "#<Change:#{object_id} #{date}>"
     end
 
+    # TODO: Rename revision to `referece` or `ref`.
+
+    #
     def to_h
       { 'author'   => @author,
         'date'     => @date,
@@ -119,6 +121,24 @@ module VCLog
     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
+    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:".

data/lib/vclog/heuristics.rb

@@ -1,28 +1,30 @@
+require 'vclog/heuristics/label'
+require 'vclog/heuristics/rule'
+
 module VCLog
 
   #
   class Heuristics
 
-    # Load heuristics from a configruation file.
+    # Load heuristics from a designated file.
     #
-    # config - the configuration directory
+    # @param file [String] configuration file
     #
     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
+      raise LoadError unless File.exist?(file)
+      new{ instance_eval(File.read(file), file) }
     end
 
     #
-    def initialize
+    def initialize(&block)
       @rules  = []
       @labels = {}
+
+      if block
+        instance_eval(&block)
+      else
+        default
+      end
     end
 
     #
@@ -52,49 +54,30 @@ module VCLog
       @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
+    # Default settings.
+    def default
+      set :major,  1, "Major Enhancements"
+      set :bug,    0, "Bug Fixes"
+      set :minor, -1, "Minor Enhancements"
+      set :doc,   -1, "Documentation Changes"
+      set :admin, -2, "Administrative Changes"
+
+      on /^(\w+):/ do |msg, md|
+        word = md[1]
+        [word.to_sym, md.post_match]
       end
 
-      attr :type
-
-      attr :level
-
-      attr :label
-
-      #
-      def to_a
-        [type, level, label]
+      on /\[(\w+)\]\s*$/ do |msg, md|
+        word = md[1]
+        [word.to_sym, md.pre_match]
       end
-    end
 
-    #
-    class Rule
-      #
-      def initialize(pattern, &block)
-        @pattern = pattern
-        @block   = block        
+      on /updated? (README|PROFILE|PACKAGE|VERSION|MANIFEST)/ do
+        :admin
       end
 
-      # Process the rule.
-      def call(message)
-        if matchdata = @pattern.match(message)
-          case @block.arity
-          when 0
-            @block.call
-          when 1
-            @block.call(matchdata)
-          else
-            @block.call(message, matchdata)
-          end
-        else
-          nil
-        end
+      on /(bump|bumped|prepare) version/ do
+        :admin
       end
     end
 

data/lib/vclog/heuristics/label.rb

@@ -0,0 +1,29 @@
+module VCLog
+
+  class Heuristics
+
+    #
+    #
+    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
+
+  end
+
+end

data/lib/vclog/heuristics/rule.rb

@@ -0,0 +1,33 @@
+module VCLog
+
+  class Heuristics
+
+    #
+    class Rule
+      #
+      def initialize(pattern, &block)
+        @pattern = pattern
+        @block   = block        
+      end
+
+      # Process the rule.
+      def call(message)
+        if matchdata = @pattern.match(message)
+          case @block.arity
+          when 0
+            @block.call
+          when 1
+            @block.call(matchdata)
+          else
+            @block.call(message, matchdata)
+          end
+        else
+          nil
+        end
+      end
+    end
+
+  end
+
+end
+

data/lib/vclog/metadata.rb

@@ -1,14 +1,4 @@
 module VCLog
-
-  #
-  class Metadata
-
-    def initialize
-      if file = Dir['PROFILE{,.yml}'].first
-        @profile = YAML.load(File.new(file))
-      end
-    end
-
-  end
-
+  VERSION = "1.8.2"
 end
+

data/lib/vclog/repo.rb

@@ -1,3 +1,5 @@
+require 'confection'
+
 require 'vclog/adapters'
 require 'vclog/heuristics'
 require 'vclog/history_file'
@@ -10,10 +12,10 @@ module VCLog
     %w{display}.each{ |name| undef_method(name) }
 
     # File glob used to find project root directory.
-    ROOT_GLOB = '{.vclog/,.config/vclog/,config/vclog/,.git/,.hg/,_darcs/,README*}/'
+    ROOT_GLOB = '{.git/,.hg/,_darcs/,.svn/}'
 
     # File glob used to find the vclog configuration directory.
-    CONFIG_GLOB = '{.vclog,.config/vclog,config/vclog}/'
+    #CONFIG_GLOB = '{.,.config/,config/,task/,tasks/}vclog{,.rb}'
 
     # Project's root directory.
     attr :root
@@ -30,7 +32,7 @@ module VCLog
       @root    = root || lookup_root
       @options = options
 
-      @config_directory = Dir[File.join(@root, CONFIG_GLOB)]
+      #@config_directory = Dir[File.join(@root, CONFIG_GLOB)]
 
       @level = (options[:level] || 0).to_i
 
@@ -46,9 +48,9 @@ module VCLog
     end
 
     #
-    def config_directory
-      @config_directory
-    end
+    #def config_directory
+    #  @config_directory
+    #end
 
     #
     def force?
@@ -59,23 +61,25 @@ module VCLog
     def read_type
       dir = nil
       Dir.chdir(root) do
-        dir = Dir.glob("{.svn,.git,.hg,_darcs}").first
+        dir = Dir.glob("{.git,.hg,.svn,_darcs}").first
       end
       dir[1..-1] if dir
     end
 
     # Find project root. This searches up from the current working
-    # directory for the following paths (in order):
+    # directory for a Confection configuration file or source control 
+    # manager directory.
     #
-    #   .vclog/
-    #   .config/vclog/
-    #   config/vclog/
-    #   .git/|.hg/|_darcs/
-    #   README*
+    #   .co
+    #   .git/
+    #   .hg/
+    #   .svn/
+    #   _darcs/
     #
-    def lookup_root(dir)
+    # If all else fails the current directory is returned.
+    def lookup_root
       root = nil
-      Dir.ascend(dir || Dir.pwd) do |path|
+      Dir.ascend(Dir.pwd) do |path|
         check = Dir[ROOT_GLOB].first
         if check
           root = path 
@@ -87,13 +91,13 @@ module VCLog
 
     # Load heuristics script.
     def heuristics
-      @heuristics ||= Heuristics.load(heuristics_file)
+      @heuristics ||= Heuristics.new(&Confection[:vclog])
     end
 
     # Heurtistics script.
-    def heuristics_file
-      @heuristics_file ||= Dir[File.join(config_directory, 'rules.rb')].first
-    end
+    #def heuristics_file
+    #  @heuristics_file ||= Dir[File.join(root, CONFIG_GLOB)].first
+    #end
 
     # Access to Repo's HISTORY file.
     def history_file