metior 0.1.4 → 0.2.0

data/lib/metior/commit.rb

@@ -3,6 +3,8 @@
 #
 # Copyright (c) 2011, Sebastian Staudt
 
+require 'metior/auto_include_vcs'
+
 module Metior
 
   # This class represents a commit in a source code repository
@@ -15,11 +17,7 @@ module Metior
   # @author Sebastian Staudt
   class Commit
 
-    # @return [Array<String>] A list of file paths added in this commit
-    attr_reader :added_files
-
-    # @return [Fixnum] The lines of code that have been added in this commit
-    attr_reader :additions
+    include AutoIncludeVCS
 
     # @return [Actor] This commit's author
     attr_reader :author
@@ -30,73 +28,116 @@ module Metior
     # @return [Object] A unique identifier of the commit in the repository
     attr_reader :id
 
+    # @return [Array<Object>] The unique identifiers of the children of this
+    #         commit
+    attr_reader :children
+
     # @return [Time] The date this commit has been committed
     attr_reader :committed_date
 
     # @return [Actor] This commit's committer
     attr_reader :committer
 
-    # @return [Array<String>] A list of file paths deleted in this commit
-    attr_reader :deleted_files
-
-    # @return [Fixnum] The lines of code that have been deleted in this commit
-    attr_reader :deletions
-
     # @return [String] The commit message of this commit
     attr_reader :message
 
-    # @return [Array<String>] A list of file paths modified in this commit
-    attr_reader :modified_files
-
-    # @return [Range] The commit range this commit belongs to
-    attr_reader :range
+    # @return [Array<Object>] The unique identifiers of one or more more
+    #         parents of this commit
+    attr_reader :parents
 
     # @return [Repository] The repository this commit belongs to
     attr_reader :repo
 
-    # Calculate some predefined activity statistics for the given set of
-    # commits
+    # Creates a new commit instance linked to the given repository and branch
     #
-    # @param [Array<Commit>] commits The commits to analyze
-    # @return [Hash<Symbol, Object>] The calculated statistics for the commits
-    def self.activity(commits)
-      activity = {}
+    # @param [Repository] repo The repository this commit belongs to
+    def initialize(repo)
+      @additions      = nil
+      @added_files    = nil
+      @children       = []
+      @deletions      = nil
+      @deleted_files  = nil
+      @modified_files = nil
+      @repo           = repo
+    end
 
-      commit_count = commits.size
+    # Sets the author of this commit
+    #
+    # This also adds the commit to the commits this actor has authored.
+    #
+    # @param [Object] author The data of the author of this commit
+    # @see Actor#authored_commits
+    # @see Repository#actor
+    def author=(author)
+      @author = @repo.actor author
+      @author.authored_commits << self
+    end
 
-      active_days = {}
-      commits.each do |commit|
-        date = commit.committed_date.utc
-        day  = Time.utc(date.year, date.month, date.day)
-        if active_days.key? day
-          active_days[day] += 1
-        else
-          active_days[day] = 1
-        end
-      end
+    # Adds the unique identifier of a child of this commit to the list of child
+    # commits
+    #
+    # @param [Object] child The unique identifier of the child commit to add
+    def add_child(child)
+      @children << child
+    end
 
-      most_active_day = active_days.sort_by { |day, count| count }.last.first
+    # Returns the paths of all files that have been modified in this commit
+    #
+    # This will load the file stats from the repository if not done yet.
+    #
+    # @return [Array<String>] A list of file paths added in this commit
+    # @see #load_file_stats
+    def added_files
+      load_file_stats if @added_files.nil?
+      @added_files
+    end
 
-      activity[:first_commit_date] = commits.last.committed_date
-      activity[:last_commit_date]  = commits.first.committed_date
+    # Returnes the number of lines of code added in this commit
+    #
+    # @return [Fixnum] The lines of code that have been added
+    # @see #load_line_stats
+    def additions
+      load_line_stats if @additions.nil?
+      @additions
+    end
 
-      age_in_days = (Time.now - activity[:first_commit_date]) / 86400.0
+    # Sets the comitter of this commit
+    #
+    # This also adds the commit to the commits this actor has comitted.
+    #
+    # @param [Object] committer The data of the comitter of this commit
+    # @see Actor#committed_commits
+    # @see Repository#actor
+    def committer=(committer)
+      @committer = @repo.actor committer
+      @committer.committed_commits << self
+    end
 
-      activity[:active_days]            = active_days
-      activity[:most_active_day]        = most_active_day
-      activity[:commits_per_day]        = commit_count / age_in_days
-      activity[:commits_per_active_day] = commit_count.to_f / active_days.size
+    # Returns the paths of all files that have been modified in this commit
+    #
+    # This will load the file stats from the repository if not done yet.
+    #
+    # @return [Array<String>] A list of file paths deleted in this commit
+    # @see #load_file_stats
+    def deleted_files
+      load_file_stats if @deleted_files.nil?
+      @deleted_files
+    end
 
-      activity
+    # Returnes the number of lines of code deleted in this commit
+    #
+    # @return [Fixnum] The lines of code that have been deleted
+    # @see #load_line_stats
+    def deletions
+      load_line_stats if @deletions.nil?
+      @deletions
     end
 
-    # Creates a new commit instance linked to the given repository and branch
+    # Returns whether this commits is a merge commit
     #
-    # @param [Repository] repo The repository this commit belongs to
-    # @param [String] range The commit range this commit belongs to
-    def initialize(repo, range)
-      @repo  = repo
-      @range = range
+    # @return [Boolean] `true` if this commit is a merge commit
+    def merge?
+      @parents.size > 1
     end
 
     # Returns the total of changed lines in this commit
@@ -106,6 +147,17 @@ module Metior
       additions + deletions
     end
 
+    # Returns the paths of all files that have been modified in this commit
+    #
+    # This will load the file stats from the repository if not done yet.
+    #
+    # @return [Array<String>] A list of file paths modified in this commit
+    # @see #load_file_stats
+    def modified_files
+      load_file_stats if @modified_files.nil?
+      @modified_files
+    end
+
     # Returns the subject line of the commit message, i.e. the first line
     #
     # @return [String] The subject of the commit
@@ -113,6 +165,34 @@ module Metior
       @message.split(/$/).first
     end
 
+    # Creates a string representation for this commit without recursing into
+    # actor and repository details
+    #
+    # @return [String] A minimal string representation for this commit
+    def inspect
+      '#<%s:0x%x: @author="%s" @committer="%s" @id="%s" @repo="%s" @subject="%s">' %
+        [
+          self.class.name, __id__ * 2, @author.id, @committer.id, @id,
+          @repo.path, subject
+        ]
+    end
+
+    protected
+
+    # Loads the file stats for this commit from the repository
+    #
+    # @abstract Has to be implemented by VCS specific subclasses
+    def load_file_stats
+      raise NotImplementedError
+    end
+
+    # Loads the line stats for this commit from the repository
+    #
+    # @abstract Has to be implemented by VCS specific subclasses
+    def load_line_stats
+      raise NotImplementedError
+    end
+
   end
 
 end

data/lib/metior/errors.rb

@@ -10,8 +10,8 @@ module Metior
   class UnsupportedError < RuntimeError
 
     # Creates a new instance of this error
-    def initialize
-      super 'Operation not supported by the current VCS.'
+    def initialize(vcs)
+      super 'Operation not supported by the current VCS (:%s).' % vcs::NAME
     end
 
   end

data/lib/metior/git/commit.rb

@@ -4,8 +4,6 @@
 # Copyright (c) 2011, Sebastian Staudt
 
 require 'metior/commit'
-require 'metior/git'
-require 'metior/git/actor'
 
 module Metior
 
@@ -16,51 +14,54 @@ module Metior
     # @author Sebastian Staudt
     class Commit < Metior::Commit
 
-      include Metior::Git
-
       # Creates a new Git commit object linked to the repository and branch it
       # belongs to and the data from the corresponding `Grit::Commit` object
       #
       # @param [Repository] repo The Git repository this commit belongs to
-      # @param [String] range The commit range this commits belongs to
       # @param [Grit::Commit] commit The commit object from Grit
-      def initialize(repo, range, commit)
-        super repo, range
+      def initialize(repo, commit)
+        super repo
 
-        @additions      = commit.stats.additions
         @authored_date  = commit.authored_date
         @committed_date = commit.committed_date
-        @deletions      = commit.stats.deletions
         @id             = commit.id
         @message        = commit.message
+        @parents        = commit.parents.map { |parent| parent.id }
 
-        authors = repo.authors range
-        @author = authors[Actor.id_for commit.author]
-        @author = Actor.new repo, commit.author if author.nil?
-        @author.add_commit self
+        self.author    = commit.author
+        self.committer = commit.committer
+      end
 
-        committers = repo.committers range
-        @committer = committers[Actor.id_for commit.committer]
-        @committer = Actor.new repo, commit.committer if @committer.nil?
-        @committer.add_commit self
+    end
 
-        @added_files    = []
-        @modified_files = []
-        @deleted_files  = []
-        commit.diffs.each do |diff|
-          if diff.new_file
-            @added_files    << diff.b_path
-          elsif diff.deleted_file
-            @deleted_files  << diff.b_path
-          elsif diff.renamed_file
-            @added_files    << diff.b_path
-            @deleted_files  << diff.a_path
-          else
-            @modified_files << diff.b_path
-          end
+    # Loads the file stats for this commit from the repository
+    #
+    # @see Repository#raw_commit
+    def load_file_stats
+      @added_files    = []
+      @modified_files = []
+      @deleted_files  = []
+      @repo.raw_commit(@id).diffs.each do |diff|
+        if diff.new_file
+          @added_files    << diff.b_path
+        elsif diff.deleted_file
+          @deleted_files  << diff.b_path
+        elsif diff.renamed_file
+          @added_files    << diff.b_path
+          @deleted_files  << diff.a_path
+        else
+          @modified_files << diff.b_path
         end
       end
+    end
 
+    # Loads the line stats for this commit from the repository
+    #
+    # @see Repository#raw_commit
+    def load_line_stats
+      commit = @repo.raw_commit @id
+      @additions = commit.stats.additions
+      @deletions = commit.stats.deletions
     end
 
   end

data/lib/metior/git/repository.rb

@@ -5,8 +5,6 @@
 
 require 'grit'
 
-require 'metior/git'
-require 'metior/git/commit'
 require 'metior/repository'
 
 module Metior
@@ -18,8 +16,6 @@ module Metior
     # @author Sebastian Staudt
     class Repository < Metior::Repository
 
-      include Metior::Git
-
       # Creates a new Git repository based on the given path
       #
       # This creates a new `Grit::Repo` instance to interface with the
@@ -32,8 +28,41 @@ module Metior
         @grit_repo = Grit::Repo.new(path)
       end
 
+      # Retrieves a raw commit object for the given commit ID
+      #
+      # @param [String] id The ID of the commit
+      # @return [Grit::Commit] The commit object
+      # @see Grit::Repo#commit
+      def raw_commit(id)
+        @grit_repo.commit(id)
+      end
+
       private
 
+      # Returns the unique identifier for the commit the given reference – like
+      # a branch name – is pointing to
+      #
+      # Returns the given ref name immediately if it is a full SHA1 commit ID.
+      #
+      # @param [String] ref A symbolic reference name
+      # @return [String] The SHA1 ID of the commit the reference is pointing to
+      def id_for_ref(ref)
+        return ref if ref.match(/[0-9a-f]{40}/)
+        unless @refs.key? ref
+          @refs[ref] = @grit_repo.git.rev_parse({}, "#{ref}^{}")
+        end
+        @refs[ref]
+      end
+
+      # Loads all branches and the corresponding commit IDs of this repository
+      #
+      # @return [Hash<String, String>] The names of all branches and the
+      #         corresponding commit IDs
+      # @see Grit::Repo#branches
+      def load_branches
+        Hash[@grit_repo.branches.map { |b| [b.name, b.commit.id] }]
+      end
+
       # This method uses Grit to load all commits from the given commit range
       #
       # Because of some Grit internal limitations, the commits have to be
@@ -47,12 +76,16 @@ module Metior
       #        (`'master..development'`), a range (`'master'..'development'`)
       #        or as a single ref (`'master'`). A single ref name means all
       #        commits reachable from that ref.
-      # @return [Array<Commit>] All commits in the given commit range
+      # @return [Grit::Commit, nil] The base commit of the requested range or
+      #         `nil` if the the range starts at the beginning of the history
+      # @return [Array<Grit::Commit>] All commits in the given commit range
       # @see Grit::Repo#commits
       def load_commits(range)
         if range.first == ''
+          base_commit = nil
           range = range.last
         else
+          base_commit = @grit_repo.commit(range.first)
           range = '%s..%s' % [range.first, range.last]
         end
 
@@ -62,7 +95,39 @@ module Metior
           commits += @grit_repo.commits(range, 500, skip)
           skip += 500
         end while commits.size == skip
-        commits
+
+        [base_commit, commits]
+      end
+
+      # Loads both the name and description of the project contained in the
+      # repository from the description file in `GIT_DIR`. The first line of
+      # that file is used as the project's name, the remaining text is used as
+      # a description of the project.
+      #
+      # @see #description
+      # @see #name
+      # @see Grit::Repo#name
+      def load_name_and_description
+        description = @grit_repo.description
+        if description.start_with? 'Unnamed repository'
+          @name        = ''
+          @description = ''
+        else
+          description  = description.lines.to_a
+          @name        = description.shift.strip
+          @description = description.join("\n").strip
+        end
+      end
+      alias_method :load_description, :load_name_and_description
+      alias_method :load_name, :load_name_and_description
+
+      # Loads all tags and the corresponding commit IDs of this repository
+      #
+      # @return [Hash<String, String>] The names of all tags and the
+      #         corresponding commit IDs
+      # @see Grit::Repo#tags
+      def load_tags
+        Hash[@grit_repo.tags.map { |b| [b.name, b.commit.id] }]
       end
 
     end