vclog 1.8.2 → 1.9.0

data/lib/vclog/heuristics/rule.rb

@@ -2,32 +2,72 @@ module VCLog
 
   class Heuristics
 
+    # Defines a categorization rule for commits.
     #
     class Rule
+
+      # Initialize a new log rule.
+      #
+      # @param [Regexp] pattern
+      #   An optional regular expression to match agains the commit message.
+      #   If the pattern does not match the commit message than the rule 
+      #   does not apply.
+      #
+      # @yieldparam [Change]
+      #   An encapsulation of the commit.
       #
-      def initialize(pattern, &block)
+      # @yieldreturn [Boolean]
+      #   If the return value is +nil+ or +false+, the rule does not apply.
+      #   If a rule does not apply then be sure not to alter the commit!
+      #
+      def initialize(pattern=nil, &block)
         @pattern = pattern
         @block   = block        
       end
 
+      # Message pattern to match for the rule to apply.
+      attr :pattern
+
       # 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
+      #
+      # @since 1.9.0 
+      #   If using a message pattern and the block takes two arguments
+      #   then the first will be the commit object, not the message as
+      #   was the case in older versions.
+      #
+      def call(commit)
+        if pattern
+          call_pattern(commit)
+        else
+          call_commit(commit)
+        end
+      end
+
+     private
+
+      # 
+      def call_pattern(commit)
+        if matchdata = @pattern.match(commit.message)
+          #case @block.arity
+          #when 0
+          #  @block.call
+          #when 1
+          #  @block.call(matchdata)
+          #else
+            @block.call(commit, matchdata)
+          #end
         else
           nil
         end
       end
+
+      #
+      def call_commit(commit)
+        @block.call(commit)
+      end
+
     end
 
   end
 
 end
-

data/lib/vclog/heuristics/{label.rb → type.rb}

@@ -4,10 +4,10 @@ module VCLog
 
     #
     #
-    class Label
+    class Type
       #
       def initialize(type, level, label)
-        @type  = type
+        @type  = type.to_sym
         @level = level.to_i
         @label = label.to_s
       end

data/lib/vclog/history_file.rb

@@ -12,13 +12,13 @@ module VCLog
     VERS = /(\d+[._])+\d+/
     DATE = /(\d+[-])+\d+/
 
-    #
+    # Alias for `File::FNM_CASEFOLD`.
     CASEFOLD = File::FNM_CASEFOLD
 
     # Release tags.
     attr :tags
 
-    #
+    # Setup new HistoryFile instance.
     def initialize(source=nil)
       if File.file?(source)
         @file = source

data/lib/vclog/metadata.rb

@@ -1,4 +1,16 @@
 module VCLog
-  VERSION = "1.8.2"
+
+  def self.metadata
+    @metadata ||= (
+      require 'yaml'
+      YAML.load_file(File.dirname(__FILE__) + '/../vclog.yml')
+    )
+  end
+
+  def self.const_missing(name)
+    key = name.to_s.downcase
+    metadata.key?(key) ? metadata[key] : super(name)
+  end
+
 end
 

data/lib/vclog/release.rb

@@ -1,7 +1,8 @@
 module VCLog
 
-  # A Release encapsulate a collection of 
-  # Change objects associated to a Tag.
+  # A Release encapsulate a collection of {Change} objects
+  # associated with a {Tag}.
+  #
   class Release
 
     # Tag object this release represents.
@@ -10,44 +11,57 @@ module VCLog
     # Array of Change objects.
     attr :changes
 
+    #
     # New Release object.
     #
-    # tag    - Tag object
-    # change - Array of Change objects
+    # @param [Tag] tag
+    #   A Tag object.
+    #
+    # @param [Array<Change>] changes
+    #   An array of Change objects.
     #
     def initialize(tag, changes)
-      @tag = tag
+      @tag     = tag
       @changes = changes
     end
 
+    #
     # Group +changes+ by type and sort by level.
-    # Returns an associative array of [type, changes].
+    #
+    # @return [Array<Array>]
+    #   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 }
+        changes.group_by{ |e| e.label }.sort{ |a,b| b[1][0].level <=> a[1][0].level }
       )
     end
 
+    #
     # Compare release by tag.
+    #
+    # @param [Release] other
+    #   Another release instance.
+    #
     def <=>(other)
       @tag <=> other.tag
     end
 
+    #
     # Convert Release to Hash.
+    #
+    # @todo Should +version+ be +name+?
+    #
     def to_h
       { 'version'  => tag.name,
         'date'     => tag.date,
         'message'  => tag.message,
         'author'   => tag.author,
-        'revision' => tag.revision,
+        'id'       => tag.id,
         'changes'  => changes.map{|change| change.to_h}
       }
     end
 
-    #def to_json
-    #  to_h.to_json
-    #end
   end
 
 end
-

data/lib/vclog/repo.rb

@@ -1,64 +1,66 @@
 require 'confection'
 
+require 'vclog/core_ext'
 require 'vclog/adapters'
 require 'vclog/heuristics'
 require 'vclog/history_file'
+require 'vclog/changelog'
+require 'vclog/tag'
+require 'vclog/release'
+require 'vclog/report'
 
 module VCLog
 
   #
   class Repo
-    # Remove some undeeded methods to make way for delegation to scm adapter.
-    %w{display}.each{ |name| undef_method(name) }
 
+    #
     # File glob used to find project root directory.
+    #
     ROOT_GLOB = '{.git/,.hg/,_darcs/,.svn/}'
 
-    # File glob used to find the vclog configuration directory.
-    #CONFIG_GLOB = '{.,.config/,config/,task/,tasks/}vclog{,.rb}'
-
+    #
     # Project's root directory.
+    #
     attr :root
 
+    #
+    # Options hash.
     #
     attr :options
 
-    # Default change level.
-    # TODO: get from config file?
-    attr :level
-
+    #
+    # Setup new Repo instance.
     #
     def initialize(root, options={})
       @root    = root || lookup_root
       @options = options
 
-      #@config_directory = Dir[File.join(@root, CONFIG_GLOB)]
-
-      @level = (options[:level] || 0).to_i
+      vcs_type = read_vcs_type
 
-      type = read_type
-      raise ArgumentError, "Not a recognized version control system." unless type
+      raise ArgumentError, "Not a recognized version control system." unless vcs_type
 
-      @adapter = Adapters.const_get(type.capitalize).new(self)
+      @adapter = Adapters.const_get(vcs_type.capitalize).new(self)
     end
 
+    #
     # Returns instance of an Adapter subclass.
+    #
     def adapter
       @adapter
     end
 
     #
-    #def config_directory
-    #  @config_directory
-    #end
-
+    # Check force option.
     #
     def force?
       options[:force]
     end
 
     #
-    def read_type
+    #
+    #
+    def read_vcs_type
       dir = nil
       Dir.chdir(root) do
         dir = Dir.glob("{.git,.hg,.svn,_darcs}").first
@@ -66,6 +68,7 @@ module VCLog
       dir[1..-1] if dir
     end
 
+    #
     # Find project root. This searches up from the current working
     # directory for a Confection configuration file or source control 
     # manager directory.
@@ -77,6 +80,7 @@ module VCLog
     #   _darcs/
     #
     # If all else fails the current directory is returned.
+    #
     def lookup_root
       root = nil
       Dir.ascend(Dir.pwd) do |path|
@@ -89,24 +93,25 @@ module VCLog
       root || Dir.pwd
     end
 
+    #
     # Load heuristics script.
+    #
     def heuristics
       @heuristics ||= Heuristics.new(&Confection[:vclog])
     end
 
-    # Heurtistics script.
-    #def heuristics_file
-    #  @heuristics_file ||= Dir[File.join(root, CONFIG_GLOB)].first
-    #end
-
+    #
     # Access to Repo's HISTORY file.
+    #
     def history_file
       @history_file ||= HistoryFile.new(options[:history_file] || root)
     end
 
+    #
     # Read history file and make a commit tag for any release not already
     # tagged. Unless the force option is set the user will be prompted for
     # each new tag.
+    #
     def autotag(prefix=nil)
       history_file.tags.each do |tag|
         label = "#{prefix}#{tag.name}"
@@ -123,7 +128,162 @@ module VCLog
       end
     end
 
-    # Delegate to SCM adapter.
+    #
+    # List of all changes.
+    #
+    def changes
+      @changes ||= apply_heuristics(adapter.changes)
+    end
+
+    #
+    # List of all change points.
+    #
+    def change_points
+      @change_points ||= apply_heuristics(adapter.change_points)
+    end
+
+    #
+    # Apply heuristics to changes.
+    #
+    def apply_heuristics(changes)
+      changes.each do |change|
+        change.apply_heuristics(heuristics)
+      end
+    end
+
+    #
+    # Collect releases for the given set of +changes+.
+    #
+    # Releases are groups of changes segregated by tags. The release version,
+    # release date and release note are defined by hard tag commits.
+    #
+    # @param [Array<Change>] changes
+    #   List of Change objects.
+    #
+    # @return [Array<Release>]
+    #   List of Release objects.
+    #
+    def releases(changes)
+      rel  = []
+      tags = self.tags.dup
+
+      #ver  = repo.bump(version)
+
+      name = options[:version] || 'HEAD'
+      user = adapter.user
+      date = ::Time.now + (3600 * 24) # one day ahead
+
+      change = Change.new(:id=>'HEAD', :date=>date, :who=>user)
+
+      tags << Tag.new(:name=>name, :date=>date, :who=>user, :msg=>"Current Development", :commit=>change)
+
+      # TODO: Do we need to add a Time.now tag?
+      # add current verion to release list (if given)
+      #previous_version = tags[0].name
+      #if current_version < previous_version  # TODO: need to use natural comparision
+      #  raise ArgumentError, "Release version is less than previous version (#{previous_version})."
+      #end
+
+      # sort by release date
+      tags = tags.sort{ |a,b| a.date <=> b.date }
+
+      # organize into deltas
+      delta = []
+      last  = nil
+      tags.each do |tag|
+        delta << [tag, [last, tag.commit.date]]
+        last = tag.commit.date
+      end
+
+      # 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
+          #lt_date = Time.parse(lt_date) unless Time===lt_date
+          #log = changelog.after(gt).before(lt)
+        else
+          #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 < ended }
+        end
+        rel << Release.new(tag, set)
+      end
+      rel.sort
+    end
+
+    #
+    # Print a report with given options. 
+    #
+    def report(options)
+      report = Report.new(self, options)
+      report.print
+    end
+
+    #
+    # Make an educated guess as to the next version number based on
+    # changes made since previous release.
+    #
+    # @return [String] version number
+    #
+    # @todo Allow configuration of version bump thresholds
+    #
+    def bump
+      last_release = releases(changes).first
+      max = last_release.changes.map{ |c| c.level }.max
+      if max > 1
+        bump_part('major')
+      elsif max >= 0
+        bump_part('minor')
+      else
+        bump_part('patch')
+      end
+    end
+
+    #
+    # Provides a bumped version number.
+    #
+    def bump_part(part=nil)
+      raise "bad version part - #{part}" unless ['major', 'minor', 'patch', 'build', ''].include?(part.to_s)
+
+      if tags.last
+        v = tags[-1].name # TODO: ensure the latest version
+        v = tags[-2].name if v == 'HEAD'
+      else
+        v = '0.0.0'
+      end
+
+      v = v.split(/\W/)    # TODO: preserve split chars
+
+      case part.to_s
+      when 'major'
+        v[0] = v[0].succ
+        (1..(v.size-1)).each{ |i| v[i] = '0' }
+        v.join('.')
+      when 'minor'
+        v[1] = '0' unless v[1]
+        v[1] = v[1].succ
+        (2..(v.size-1)).each{ |i| v[i] = '0' }
+        v.join('.')
+      when 'patch'
+        v[1] = '0' unless v[1]
+        v[2] = '0' unless v[2]
+        v[2] = v[2].succ
+        (3..(v.size-1)).each{ |i| v[i] = '0' }
+        v.join('.')
+      else
+        v[-1] = '0' unless v[-1]
+        v[-1] = v[-1].succ
+        v.join('.')
+      end
+    end
+
+    #
+    # Delegate missing methods to SCM adapter.
+    #
     def method_missing(s, *a, &b)
       if adapter.respond_to?(s)
         adapter.send(s, *a, &b)
@@ -132,9 +292,11 @@ module VCLog
       end
     end
 
-    private
+  private
 
+    #
     # Ask yes/no question.
+    #
     def ask_yn(message)
       case ask(message)
       when 'y', 'Y', 'yes'
@@ -144,7 +306,9 @@ module VCLog
       end
     end
 
+    #
     # Returns a String.
+    #
     def new_tag_message(label, tag)
       "#{label} / #{tag.date.strftime('%Y-%m-%d')}\n#{tag.message}"
     end