metior 0.1.1

data/lib/metior/commit.rb

@@ -0,0 +1,118 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+module Metior
+
+  # This class represents a commit in a source code repository
+  #
+  # Although not all VCSs distinguish authors from committers this
+  # implementation forces a differentiation between the both.
+  #
+  # @abstract It has to be subclassed to implement a commit representation for
+  #           a specific VCS.
+  # @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
+
+    # @return [Actor] This commit's author
+    attr_reader :author
+
+    # @return [Time] The date this commit has been authored
+    attr_reader :authored_date
+
+    # @return [Object] A unique identifier of the commit in the repository
+    attr_reader :id
+
+    # @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 [Repository] The repository this commit belongs to
+    attr_reader :repo
+
+    # Calculate some predefined activity statistics for the given set of
+    # commits
+    #
+    # @param [Array<Commit>] commits The commits to analyze
+    # @return [Hash<Symbol, Object>] The calculated statistics for the commits
+    def self.activity(commits)
+      activity = {}
+
+      commit_count = commits.size
+
+      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
+
+      most_active_day = active_days.sort_by { |day, count| count }.last.first
+
+      activity[:first_commit_date] = commits.last.committed_date
+      activity[:last_commit_date]  = commits.first.committed_date
+
+      age_in_days = (Time.now - activity[:first_commit_date]) / 86400.0
+
+      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
+
+      activity
+    end
+
+    # Creates a new commit instance linked to the given repository and branch
+    #
+    # @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
+    end
+
+    # Returns the total of changed lines in this commit
+    #
+    # @return [Fixnum] The total number of changed lines
+    def modifications
+      additions + deletions
+    end
+
+    # Returns the subject line of the commit message, i.e. the first line
+    #
+    # @return [String] The subject of the commit
+    def subject
+      @message.split(/$/).first
+    end
+
+  end
+
+end

data/lib/metior/errors.rb

@@ -0,0 +1,19 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+module Metior
+
+  # This error is raised when an operation is not supported by the currently
+  # used VCS (or its implementation)
+  class UnsupportedError < RuntimeError
+
+    # Creates a new instance of this error
+    def initialize
+      super 'Operation not supported by the current VCS.'
+    end
+
+  end
+
+end

data/lib/metior/git.rb

@@ -0,0 +1,25 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'metior/vcs'
+
+module Metior
+
+  # The Metior implementation for Git
+  #
+  # @author Sebastian Staudt
+  module Git
+
+    # Git will be registered as `:git`
+    NAME = :git
+
+    include Metior::VCS
+
+    # Git's default branch is _master_
+    DEFAULT_BRANCH = 'master'
+
+  end
+
+end

data/lib/metior/git/actor.rb

@@ -0,0 +1,43 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'metior/actor'
+
+module Metior
+
+  module Git
+
+    # Represents an actor in a Git source code repository, i.e. an author or
+    # committer.
+    #
+    # @author Sebastian Staudt
+    class Actor < Metior::Actor
+
+      alias_method :email, :id
+
+      # Returns the email address as an identifier for the given actor.
+      # Git uses email addresses as identifiers for its actors.
+      #
+      # @param [Grit::Actor] actor The actor object from Grit
+      # @return [String] The email address of the given actor
+      def self.id_for(actor)
+        actor.email
+      end
+
+      # Creates a new actor instance
+      #
+      # @param [Repository] repo The repository this actor belongs to
+      # @param [Grit::Actor] actor The actor object from Grit
+      def initialize(repo, actor)
+        super repo
+        @id   = actor.email
+        @name = actor.name
+      end
+
+    end
+
+  end
+
+end

data/lib/metior/git/commit.rb

@@ -0,0 +1,68 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'metior/commit'
+require 'metior/git'
+require 'metior/git/actor'
+
+module Metior
+
+  module Git
+
+    # Represents a commit in a Git source code repository
+    #
+    # @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
+
+        @additions      = commit.stats.additions
+        @authored_date  = commit.authored_date
+        @committed_date = commit.committed_date
+        @deletions      = commit.stats.deletions
+        @id             = commit.id
+        @message        = commit.message
+
+        authors = repo.authors range
+        @author = authors[Actor.id_for commit.author]
+        @author = Actor.new repo, commit.author if author.nil?
+        @author.add_commit self
+
+        committers = repo.committers range
+        @committer = committers[Actor.id_for commit.committer]
+        @committer = Actor.new repo, commit.committer if @committer.nil?
+        @committer.add_commit self
+
+        @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
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/metior/git/repository.rb

@@ -0,0 +1,72 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'grit'
+
+require 'metior/git'
+require 'metior/git/commit'
+require 'metior/repository'
+
+module Metior
+
+  module Git
+
+    # Represents a Git source code repository
+    #
+    # @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
+      # repository.
+      #
+      # @param [String] path The file system path of the repository
+      def initialize(path)
+        super path
+
+        @grit_repo = Grit::Repo.new(path)
+      end
+
+      private
+
+      # This method uses Grit to load all commits from the given commit range
+      #
+      # Because of some Grit internal limitations, the commits have to be
+      # loaded in batches of up to 500 commits.
+      #
+      # @note Grit will choke on huge repositories, like Homebrew or the Linux
+      #       kernel. You will have to raise the timeout limit using
+      #       `Grit.git_timeout=`.
+      # @param [String, Range] range The range of commits for which the commits
+      #        should be loaded. This may be given as a string
+      #        (`'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
+      # @see Grit::Repo#commits
+      def load_commits(range)
+        if range.first == ''
+          range = range.last
+        else
+          range = '%s..%s' % [range.first, range.last]
+        end
+
+        commits = []
+        skip = 0
+        begin
+          commits += @grit_repo.commits(range, 500, skip)
+          skip += 500
+        end while commits.size == skip
+        commits
+      end
+
+    end
+
+  end
+
+end

data/lib/metior/github.rb

@@ -0,0 +1,27 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'metior/vcs'
+
+module Metior
+
+  # The Metior implementation for GitHub's API
+  #
+  # @author Sebastian Staudt
+  module GitHub
+
+    # GitHub will be registered as `:github`
+    NAME = :github
+
+    include Metior::VCS
+
+    # Git's default branch is _master_
+    DEFAULT_BRANCH = 'master'
+
+    not_supported :file_stats, :line_stats
+
+  end
+
+end

data/lib/metior/github/actor.rb

@@ -0,0 +1,43 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'metior/actor'
+
+module Metior
+
+  module GitHub
+
+    # Represents an actor in a GitHub source code repository, i.e. an author or
+    # committer.
+    #
+    # @author Sebastian Staudt
+    class Actor < Metior::Actor
+
+      alias_method :login, :id
+
+      # Returns the GitHub login as an identifier for the given actor.
+      #
+      # @param [Hashie::Mash] actor The actor's data parsed from the JSON API
+      # @return [String] The GitHub login of the given actor
+      def self.id_for(actor)
+        actor.login
+      end
+
+      # Creates a new actor instance
+      #
+      # @param [Repository] repo The repository this actor belongs to
+      # @param [Hashie::Mash] actor The actor's data parsed from the JSON API
+      def initialize(repo, actor)
+        super repo
+        @email = actor.email
+        @id    = actor.login
+        @name  = actor.name
+      end
+
+    end
+
+  end
+
+end

data/lib/metior/github/commit.rb

@@ -0,0 +1,55 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'metior/commit'
+require 'metior/github'
+require 'metior/github/actor'
+
+module Metior
+
+  module GitHub
+
+    # Represents a commit in a GitHub source code repository
+    #
+    # @author Sebastian Staudt
+    class Commit < Metior::Commit
+
+      include Metior::GitHub
+
+      # Creates a new GitHub commit object linked to the repository and branch
+      # it belongs to and the data parsed from the corresponding JSON data
+      #
+      # @param [Repository] repo The GitHub repository this commit belongs to
+      # @param [String] range The commit range this commits belongs to
+      # @param [Hashie:Mash] commit The commit data parsed from the JSON API
+      def initialize(repo, range, commit)
+        super repo, range
+
+        @added_files    = []
+        @additions      = 0
+        @authored_date  = commit.authored_date
+        @committed_date = commit.committed_date
+        @deleted_files  = []
+        @deletions      = 0
+        @id             = commit.id
+        @message        = commit.message
+        @modified_files = []
+
+        authors = repo.authors(branch)
+        @author = authors[Actor.id_for commit.author]
+        @author = Actor.new repo, commit.author if author.nil?
+        @author.add_commit self
+
+        committers = repo.committers branch
+        @committer = committers[Actor.id_for commit.committer]
+        @committer = Actor.new repo, commit.committer if @committer.nil?
+        @committer.add_commit self
+      end
+
+    end
+
+  end
+
+end